Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

tageditor.cpp 18.2 KB
Newer Older
1 2 3 4 5
/***************************************************************************
                          tageditor.cpp  -  description
                             -------------------
    begin                : Sat Sep 7 2002
    copyright            : (C) 2002 by Scott Wheeler
6
    email                : wheeler@kde.org
7 8 9 10 11 12 13 14 15 16 17
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

18 19 20 21
#include <kcombobox.h>
#include <klineedit.h>
#include <knuminput.h>
#include <keditcl.h>
22
#include <kmessagebox.h>
23
#include <kconfig.h>
24 25 26 27
#include <klocale.h>
#include <kdebug.h>

#include <qlabel.h>
28
#include <qcheckbox.h>
29 30 31 32
#include <qlayout.h>
#include <qdir.h>

#include "tageditor.h"
33
#include "collectionlist.h"
34
#include "genrelistlist.h"
Scott Wheeler's avatar
Scott Wheeler committed
35
#include "playlistitem.h"
36 37 38 39 40 41 42 43 44

////////////////////////////////////////////////////////////////////////////////
// public members
////////////////////////////////////////////////////////////////////////////////

TagEditor::TagEditor(QWidget *parent, const char *name) : QWidget(parent, name) 
{
    setupLayout();
    readConfig();
45
    m_dataChanged = false;
46 47 48 49 50 51 52
}

TagEditor::~TagEditor()
{
    saveConfig();
}

53
void TagEditor::setGenreList(const GenreList &list)
54
{
55
    m_genreList = list;
56 57 58 59 60 61
}

////////////////////////////////////////////////////////////////////////////////
// public slots
////////////////////////////////////////////////////////////////////////////////

62
void TagEditor::slotSetItems(const PlaylistItemList &list)
63 64
{
    saveChangesPrompt();
65
    m_items = list;
66
    if(isVisible())
67
	slotRefresh();
68 69
}

70
void TagEditor::slotRefresh()
71
{
72
    // This method takes the list of currently selected m_items and tries to 
73 74
    // figure out how to show that in the tag editor.  The current strategy --
    // the most common case -- is to just process the first item.  Then we
75
    // check after that to see if there are other m_items and adjust accordingly.
76

77 78 79 80 81
    if(m_items.isEmpty()) {
	slotClear();
	return;
    }
    
82
    PlaylistItem *item = m_items.first();
83

84
    Tag *tag = item->tag();
85
	
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    m_artistNameBox->setEditText(tag->artist());
    m_trackNameBox->setText(tag->track());
    m_albumNameBox->setEditText(tag->album());
    
    if(m_genreList.findIndex(tag->genre()) >= 0)
	m_genreBox->setCurrentItem(m_genreList.findIndex(tag->genre()) + 1);
    else {
	m_genreBox->setCurrentItem(0);
	m_genreBox->setEditText(tag->genre());
    }
    
    m_trackSpin->setValue(tag->trackNumber());
    m_yearSpin->setValue(tag->year());
    
    m_commentBox->setText(tag->comment());
    
    // Start at the second item, since we've already processed the first.
    
    PlaylistItemList::Iterator it = m_items.begin();
    ++it;

    // If there is more than one item in the m_items that we're dealing with...
    
    if(it != m_items.end()) {
	m_fileNameBox->clear();
	m_fileNameBox->setEnabled(false);
112
	
113 114 115 116 117
	m_lengthBox->clear();
	m_lengthBox->setEnabled(false);
	
	m_bitrateBox->clear();
	m_bitrateBox->setEnabled(false);
Scott Wheeler's avatar
Scott Wheeler committed
118 119 120

	BoxMap::Iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
121 122
	    (*boxIt)->setChecked(true);
	    (*boxIt)->show();
123 124
	}
	
125 126 127
	// Yep, this is ugly.  Loop through all of the files checking to see
	// if their fields are the same.  If so, by default, enable their 
	// checkbox.
128
	
129
	// Also, if there are more than 50 m_items, don't scan all of them.
130
	
131 132 133 134 135 136 137 138
	if(m_items.count() > 50) {
	    m_enableBoxes[m_artistNameBox]->setChecked(false);
	    m_enableBoxes[m_trackNameBox]->setChecked(false);
	    m_enableBoxes[m_albumNameBox]->setChecked(false);
	    m_enableBoxes[m_genreBox]->setChecked(false);
	    m_enableBoxes[m_trackSpin]->setChecked(false);
	    m_enableBoxes[m_yearSpin]->setChecked(false);
	    m_enableBoxes[m_commentBox]->setChecked(false);
139 140
	}
	else {
141 142
	    for(; it != m_items.end(); ++it) {
		tag = (*it)->tag();
Scott Wheeler's avatar
Scott Wheeler committed
143 144 145
		if(m_artistNameBox->currentText() != tag->artist() &&
		   m_enableBoxes.contains(m_artistNameBox))
		{
146 147 148
		    m_artistNameBox->lineEdit()->clear();
		    m_enableBoxes[m_artistNameBox]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
149 150 151
		if(m_trackNameBox->text() != tag->track() &&
		   m_enableBoxes.contains(m_trackNameBox))
		{
152 153 154
		    m_trackNameBox->clear();
		    m_enableBoxes[m_trackNameBox]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
155 156 157
		if(m_albumNameBox->currentText() != tag->album() &&
		   m_enableBoxes.contains(m_albumNameBox))
		{
158 159 160
		    m_albumNameBox->lineEdit()->clear();
		    m_enableBoxes[m_albumNameBox]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
161 162 163
		if(m_genreBox->currentText() != tag->genre() &&
		   m_enableBoxes.contains(m_genreBox))
		{
164 165 166
		    m_genreBox->lineEdit()->clear();
		    m_enableBoxes[m_genreBox]->setChecked(false);
		}		
Scott Wheeler's avatar
Scott Wheeler committed
167 168 169
		if(m_trackSpin->value() != tag->trackNumber() &&
		   m_enableBoxes.contains(m_trackSpin))
		{
170 171 172
		    m_trackSpin->setValue(0);
		    m_enableBoxes[m_trackSpin]->setChecked(false);
		}		
Scott Wheeler's avatar
Scott Wheeler committed
173 174 175
		if(m_yearSpin->value() != tag->year() &&
		   m_enableBoxes.contains(m_yearSpin))
		{
176 177 178
		    m_yearSpin->setValue(0);
		    m_enableBoxes[m_yearSpin]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
179 180 181
		if(m_commentBox->text() != tag->comment() &&
		   m_enableBoxes.contains(m_commentBox))
		{
182 183 184
		    m_commentBox->clear();
		    m_enableBoxes[m_commentBox]->setChecked(false);
		}
185 186
	    }
	}
187
    }
188 189 190 191 192 193 194 195 196 197 198
    else {
	// Clean up in the case that we are only handling one item.
	
	m_fileNameBox->setText(item->fileName());
	m_fileNameBox->setEnabled(true);
	
	m_lengthBox->setText(tag->lengthString());
	m_lengthBox->setEnabled(true);
	
	m_bitrateBox->setText(tag->bitrateString());
	m_bitrateBox->setEnabled(true);	    
Scott Wheeler's avatar
Scott Wheeler committed
199 200 201

	BoxMap::iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
202 203 204 205 206
	    (*boxIt)->setChecked(true);
	    (*boxIt)->hide();
	}
    }
    m_dataChanged = false;
207 208
}

209
void TagEditor::slotClear()
210
{
211 212 213 214 215 216 217 218 219 220
    m_artistNameBox->lineEdit()->clear();
    m_trackNameBox->clear();
    m_albumNameBox->lineEdit()->clear();
    m_genreBox->setCurrentItem(0);
    m_fileNameBox->clear();
    m_trackSpin->setValue(0);
    m_yearSpin->setValue(0);
    m_lengthBox->clear();
    m_bitrateBox->clear();
    m_commentBox->clear();    
221 222
}

223
void TagEditor::slotUpdateCollection()
224
{
225 226 227 228 229
    CollectionList *list = CollectionList::instance();

    if(!list)
	return;
    
230 231
    if(m_artistNameBox->listBox()) {
        m_artistNameBox->listBox()->clear();
232 233 234 235 236
	
	// This is another case where a sorted value list would be useful.  It's
	// silly to build and maintain unsorted lists and have to call sort 
	// every time that you want to verify that a list is sorted.	

237
	QStringList artistList = list->artists();
238 239
	artistList.sort();

240 241
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
242 243
    }

244 245
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
246

247
	QStringList albumList = list->albums();
248 249
	albumList.sort();

250 251
        m_albumNameBox->listBox()->insertStringList(albumList);
	m_albumNameBox->completionObject()->setItems(albumList);
252 253 254 255 256 257 258
    }    
}

////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////

259
void TagEditor::readConfig()
260
{
261 262 263
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
264
        if(m_artistNameBox && m_albumNameBox) {
265
            KGlobalSettings::Completion artistNameBoxMode = 
Scott Wheeler's avatar
Scott Wheeler committed
266 267
		KGlobalSettings::Completion(config->readNumEntry("ArtistNameBoxMode",
								 KGlobalSettings::CompletionAuto));
268
	    m_artistNameBox->setCompletionMode(artistNameBoxMode);
269 270
	    
            KGlobalSettings::Completion albumNameBoxMode = 
Scott Wheeler's avatar
Scott Wheeler committed
271 272
		KGlobalSettings::Completion(config->readNumEntry("AlbumNameBoxMode",
								 KGlobalSettings::CompletionAuto));
273
	    m_albumNameBox->setCompletionMode(albumNameBoxMode);
274 275
        }
    }
276

277 278
    // Once the custom genre list editor is done, this is where we should read 
    // the genre list from the config file.
279

280
    m_genreList = GenreListList::ID3v1List();
281

282 283
    if(m_genreBox) {
        m_genreBox->clear();
284

285
        // Add values to the genre box
286

287
        m_genreBox->insertItem(QString::null);
288

289 290
        for(GenreList::Iterator it = m_genreList.begin(); it != m_genreList.end(); ++it)
            m_genreBox->insertItem((*it));
291 292
    }
}
293

294 295 296 297 298
void TagEditor::saveConfig()
{
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
299 300 301
        if(m_artistNameBox && m_albumNameBox) {
	    config->writeEntry("ArtistNameBoxMode", m_artistNameBox->completionMode());
	    config->writeEntry("AlbumNameBoxMode", m_albumNameBox->completionMode());
302 303
        }
    }
304

305
}
306

307 308
void TagEditor::setupLayout()
{
309 310
    static const int horizontalSpacing = 10;
    static const int verticalSpacing = 2;
311

312
    QHBoxLayout *layout = new QHBoxLayout(this, 2, horizontalSpacing);
313 314 315 316 317 318 319 320 321 322 323 324 325 326

    //////////////////////////////////////////////////////////////////////////////
    // define two columns of the bottem layout
    //////////////////////////////////////////////////////////////////////////////
    QVBoxLayout *leftColumnLayout = new QVBoxLayout(layout, verticalSpacing);
    QVBoxLayout *rightColumnLayout = new QVBoxLayout(layout, verticalSpacing);

    layout->setStretchFactor(leftColumnLayout, 2);
    layout->setStretchFactor(rightColumnLayout, 3);

    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the left column -- all of the field names are class wide
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization
327 328 329
        m_artistNameBox = new KComboBox(true, this, "artistNameBox");
	m_artistNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Artist name:"), m_artistNameBox, leftColumnLayout);
330

331 332
        m_trackNameBox = new KLineEdit(this, "trackNameBox");
	addItem(i18n("Track name:"), m_trackNameBox, leftColumnLayout);
333

334 335 336
        m_albumNameBox = new KComboBox(true, this, "albumNameBox");
	m_albumNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Album name:"), m_albumNameBox, leftColumnLayout);
337

338 339
        m_genreBox = new KComboBox(true, this, "genreBox");
	addItem(i18n("Genre:"), m_genreBox, leftColumnLayout);
340 341

        // this fills the space at the bottem of the left column
Scott Wheeler's avatar
Scott Wheeler committed
342 343
        leftColumnLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Minimum,
						  QSizePolicy::Expanding));
344 345 346 347 348
    }
    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the right column
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization
349
        rightColumnLayout->addWidget(new QLabel(i18n("File name:"), this));
350

351 352
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
        rightColumnLayout->addWidget(m_fileNameBox);
353 354

        { // lay out the track row
Scott Wheeler's avatar
Scott Wheeler committed
355 356
            QHBoxLayout *trackRowLayout = new QHBoxLayout(rightColumnLayout,
							  horizontalSpacing);
357

358 359
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
	    addItem(i18n("Track:"), m_trackSpin, trackRowLayout);
360

Scott Wheeler's avatar
Scott Wheeler committed
361 362
            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding,
						    QSizePolicy::Minimum));
363

364 365
            m_yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
	    addItem(i18n("Year:"), m_yearSpin, trackRowLayout);
366

Scott Wheeler's avatar
Scott Wheeler committed
367 368
            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding,
						    QSizePolicy::Minimum));
369

370
            trackRowLayout->addWidget(new QLabel(i18n("Length:"), this));
371 372 373 374
            m_lengthBox = new KLineEdit(this, "lengthBox");
            m_lengthBox->setMaximumWidth(50);
            m_lengthBox->setReadOnly(true);
            trackRowLayout->addWidget(m_lengthBox);
375

Scott Wheeler's avatar
Scott Wheeler committed
376 377
            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding,
						    QSizePolicy::Minimum));
378

379
            trackRowLayout->addWidget(new QLabel(i18n("Bitrate:"), this));
380 381 382 383
            m_bitrateBox = new KLineEdit(this, "bitrateBox");
            m_bitrateBox->setMaximumWidth(50);
            m_bitrateBox->setReadOnly(true);
            trackRowLayout->addWidget(m_bitrateBox);
384 385
        }

386 387 388
        m_commentBox = new KEdit(this, "commentBox");
	m_commentBox->setTextFormat(Qt::PlainText);
	addItem(i18n("Comment:"), m_commentBox, rightColumnLayout);
389 390
    }

Scott Wheeler's avatar
Scott Wheeler committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    connect(m_artistNameBox, SIGNAL(textChanged(const QString&)),
	    this, SLOT(slotDataChanged()));

    connect(m_trackNameBox, SIGNAL(textChanged(const QString&)),
	    this, SLOT(slotDataChanged()));

    connect(m_albumNameBox, SIGNAL(textChanged(const QString&)),
	    this, SLOT(slotDataChanged()));

    connect(m_genreBox, SIGNAL(activated(int)),
	    this, SLOT(slotDataChanged()));

    connect(m_genreBox, SIGNAL(textChanged(const QString&)),
	    this, SLOT(slotDataChanged()));

    connect(m_fileNameBox, SIGNAL(textChanged(const QString&)),
	    this, SLOT(slotDataChanged()));

    connect(m_yearSpin, SIGNAL(valueChanged(int)),
	    this, SLOT(slotDataChanged()));

    connect(m_trackSpin, SIGNAL(valueChanged(int)),
	    this, SLOT(slotDataChanged()));

    connect(m_commentBox, SIGNAL(textChanged()),
	    this, SLOT(slotDataChanged()));
417 418 419 420
}

void TagEditor::save(const PlaylistItemList &list)
{
421
    if(list.count() > 0 && m_dataChanged) {
422 423 424 425 426 427 428
	
	KApplication::setOverrideCursor(Qt::waitCursor);

	// To keep track of the files that don't cooperate...

	QStringList errorFiles;
	
429
	for(PlaylistItemList::ConstIterator it = list.begin(); it != list.end(); ++it) {
430 431
	    PlaylistItem *item = *it;
	    
432
	    QFileInfo newFile(item->dirPath() + QDir::separator() + m_fileNameBox->text());
433 434 435 436 437 438 439
	    QFileInfo directory(item->dirPath());
	    
	    // If (the new file is writable or the new file doesn't exist and
	    // it's directory is writable) and the old file is writable...  
	    // If not we'll append it to errorFiles to tell the user which
	    // files we couldn't write to.
	    
Scott Wheeler's avatar
Scott Wheeler committed
440 441 442
	    if((newFile.isWritable() || (!newFile.exists() && directory.isWritable())) &&
	       item->isWritable())
	    {
443 444 445 446 447
		
		// If the file name in the box doesn't match the current file
		// name...
		
		if(list.count() == 1 && item->fileName() != newFile.fileName()) {
448
		    
449 450
		    // Rename the file if it doesn't exist or the user says
		    // that it's ok.
451
		    
452
		    if(!newFile.exists() ||
Scott Wheeler's avatar
Scott Wheeler committed
453 454 455 456
		       KMessageBox::warningYesNo(
			   this, 
			   i18n("This file already exists.\nDo you want to replace it?"),
			   i18n("File Exists")) == KMessageBox::Yes)
457 458 459 460
		    {
			QDir currentDir;
			currentDir.rename(item->filePath(), newFile.filePath());
			item->setFile(newFile.filePath());
461 462
		    }
		}
463 464 465 466 467 468 469
		
		// A bit more ugliness.  If there are multiple files that are
		// being modified, they each have a "enabled" checkbox that
		// says if that field is to be respected for the multiple 
		// files.  We have to check to see if that is enabled before
		// each field that we write.
		
470 471 472 473 474 475 476 477 478 479 480 481
		if(m_enableBoxes[m_artistNameBox]->isOn())
		    item->tag()->setArtist(m_artistNameBox->currentText());
		if(m_enableBoxes[m_trackNameBox]->isOn())
		    item->tag()->setTrack(m_trackNameBox->text());
		if(m_enableBoxes[m_albumNameBox]->isOn())
		    item->tag()->setAlbum(m_albumNameBox->currentText());
		if(m_enableBoxes[m_trackSpin]->isOn())
		    item->tag()->setTrackNumber(m_trackSpin->value());
		if(m_enableBoxes[m_yearSpin]->isOn())
		    item->tag()->setYear(m_yearSpin->value());
		if(m_enableBoxes[m_commentBox]->isOn())
		    item->tag()->setComment(m_commentBox->text());
482
		
483 484
		if(m_enableBoxes[m_genreBox]->isOn()) {
		    if(m_genreList.findIndex(m_genreBox->currentText()) >= 0)
Scott Wheeler's avatar
Scott Wheeler committed
485 486
			item->tag()->setGenre(
			    m_genreList[m_genreList.findIndex(m_genreBox->currentText())]);
487
		    else
Scott Wheeler's avatar
Scott Wheeler committed
488 489
			item->tag()->setGenre(
			    Genre(m_genreBox->currentText(), item->tag()->genre().getID3v1()));
490 491 492 493
		}
		
		item->tag()->save();
		
494
		item->slotRefresh();
495
	    }
496 497 498 499 500 501 502
	    else
		errorFiles.append(item->fileName());
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
503
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
504
	m_dataChanged = false;
505 506

	KApplication::restoreOverrideCursor();
507 508 509 510 511
    }
}

void TagEditor::saveChangesPrompt()
{
512
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
513

514
	QStringList files;
515 516 517

	for(PlaylistItemList::Iterator it = m_items.begin(); it != m_items.end(); it++)
            files.append((*it)->fileName());
518

519 520 521
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
522 523 524
					  i18n("Save Changes"),
					  KStdGuiItem::yes(),
					  KStdGuiItem::no(),
525 526
					  "tagEditor_showSaveChangesBox") == KMessageBox::Yes)
	{
527
            save(m_items);
528
	}
529 530 531
    }
}

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
void TagEditor::addItem(const QString &text, QWidget *item, QBoxLayout *layout)
{
    if(!item || !layout)
	return;

    QLabel *label = new QLabel(text, this);

    QCheckBox *enableBox = new QCheckBox(i18n("Enable"), this);
    enableBox->setChecked(true);

    label->setMinimumHeight(enableBox->height());

    if(layout->direction() == QBoxLayout::LeftToRight) {
	layout->addWidget(label);
	layout->addWidget(item);
	layout->addWidget(enableBox);
    }
    else {
	QHBoxLayout *l = new QHBoxLayout(layout);

	l->addWidget(label);
	l->setStretchFactor(label, 1);

	l->insertStretch(-1, 1);

	l->addWidget(enableBox);
	l->setStretchFactor(enableBox, 0);

	layout->addWidget(item);
    }

    enableBox->hide();

    connect(enableBox, SIGNAL(toggled(bool)), item, SLOT(setEnabled(bool)));
566
    m_enableBoxes.insert(item, enableBox);
567 568
}

569 570
void TagEditor::showEvent(QShowEvent *e)
{
571
    slotRefresh();
572 573 574
    QWidget::showEvent(e);
}

575 576 577 578
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

579
void TagEditor::slotDataChanged(bool c)
580
{
581
    m_dataChanged = c;
582 583 584
}

#include "tageditor.moc"