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.4 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
    if(m_items.isEmpty()) {
	slotClear();
79
	setEnabled(false);
80 81 82
	return;
    }
    
83 84
    setEnabled(true);

85
    PlaylistItem *item = m_items.first();
86

87
    Tag *tag = item->tag();
88
	
89 90 91
    m_artistNameBox->setEditText(tag->artist());
    m_trackNameBox->setText(tag->track());
    m_albumNameBox->setEditText(tag->album());
92 93 94 95 96

    m_fileNameBox->setText(item->fileName());
    m_bitrateBox->setText(tag->bitrateString());
    m_lengthBox->setText(tag->lengthString());

97 98
    if(m_genreList.findIndex(tag->genre().name()) >= 0)
	m_genreBox->setCurrentItem(m_genreList.findIndex(tag->genre().name()) + 1);
99 100
    else {
	m_genreBox->setCurrentItem(0);
101
	m_genreBox->setEditText(tag->genre().name());
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    }
    
    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()) {
117 118 119 120

	QValueListIterator<QWidget *> hideIt = m_hideList.begin();
	for(; hideIt != m_hideList.end(); ++hideIt)
	    (*hideIt)->hide();
Scott Wheeler's avatar
Scott Wheeler committed
121 122 123

	BoxMap::Iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
124 125
	    (*boxIt)->setChecked(true);
	    (*boxIt)->show();
126 127
	}
	
128 129 130
	// 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.
131
	
132
	// Also, if there are more than 50 m_items, don't scan all of them.
133
	
134 135 136 137 138 139 140 141
	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);
142 143
	}
	else {
144 145
	    for(; it != m_items.end(); ++it) {
		tag = (*it)->tag();
Scott Wheeler's avatar
Scott Wheeler committed
146 147 148
		if(m_artistNameBox->currentText() != tag->artist() &&
		   m_enableBoxes.contains(m_artistNameBox))
		{
149 150 151
		    m_artistNameBox->lineEdit()->clear();
		    m_enableBoxes[m_artistNameBox]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
152 153 154
		if(m_trackNameBox->text() != tag->track() &&
		   m_enableBoxes.contains(m_trackNameBox))
		{
155 156 157
		    m_trackNameBox->clear();
		    m_enableBoxes[m_trackNameBox]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
158 159 160
		if(m_albumNameBox->currentText() != tag->album() &&
		   m_enableBoxes.contains(m_albumNameBox))
		{
161 162 163
		    m_albumNameBox->lineEdit()->clear();
		    m_enableBoxes[m_albumNameBox]->setChecked(false);
		}
164
		if(m_genreBox->currentText() != tag->genre().name() &&
Scott Wheeler's avatar
Scott Wheeler committed
165 166
		   m_enableBoxes.contains(m_genreBox))
		{
167 168 169
		    m_genreBox->lineEdit()->clear();
		    m_enableBoxes[m_genreBox]->setChecked(false);
		}		
Scott Wheeler's avatar
Scott Wheeler committed
170 171 172
		if(m_trackSpin->value() != tag->trackNumber() &&
		   m_enableBoxes.contains(m_trackSpin))
		{
173 174 175
		    m_trackSpin->setValue(0);
		    m_enableBoxes[m_trackSpin]->setChecked(false);
		}		
Scott Wheeler's avatar
Scott Wheeler committed
176 177 178
		if(m_yearSpin->value() != tag->year() &&
		   m_enableBoxes.contains(m_yearSpin))
		{
179 180 181
		    m_yearSpin->setValue(0);
		    m_enableBoxes[m_yearSpin]->setChecked(false);
		}
Scott Wheeler's avatar
Scott Wheeler committed
182 183 184
		if(m_commentBox->text() != tag->comment() &&
		   m_enableBoxes.contains(m_commentBox))
		{
185 186 187
		    m_commentBox->clear();
		    m_enableBoxes[m_commentBox]->setChecked(false);
		}
188 189
	    }
	}
190
    }
191 192
    else {
	// Clean up in the case that we are only handling one item.
193 194 195 196

	QValueListIterator<QWidget *> showIt = m_hideList.begin();
	for(; showIt != m_hideList.end(); ++showIt)
	    (*showIt)->show();
Scott Wheeler's avatar
Scott Wheeler committed
197 198 199

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

207
void TagEditor::slotClear()
208
{
209 210 211 212 213 214 215 216 217 218
    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();    
219 220
}

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

    if(!list)
	return;
    
228 229
    if(m_artistNameBox->listBox()) {
        m_artistNameBox->listBox()->clear();
230 231 232 233 234
	
	// 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.	

235
	QStringList artistList = list->uniqueSet(CollectionList::Artists);
236 237
	artistList.sort();

238 239
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
240 241
    }

242 243
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
244

245
	QStringList albumList = list->uniqueSet(CollectionList::Albums);
246 247
	albumList.sort();

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

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

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

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

278
    m_genreList = GenreListList::ID3v1List();
279

280 281
    if(m_genreBox) {
        m_genreBox->clear();
282

283
        // Add values to the genre box
284

285
        m_genreBox->insertItem(QString::null);
286

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

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

303
}
304

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

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

    //////////////////////////////////////////////////////////////////////////////
    // 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
325 326 327
        m_artistNameBox = new KComboBox(true, this, "artistNameBox");
	m_artistNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Artist name:"), m_artistNameBox, leftColumnLayout);
328

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

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

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

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

349
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
350
        rightColumnLayout->addWidget(addHidden(m_fileNameBox));
351 352

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

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

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

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

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

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

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

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

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

Scott Wheeler's avatar
Scott Wheeler committed
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    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()));
415 416 417 418
}

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

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

	QStringList errorFiles;
	
427
	for(PlaylistItemList::ConstIterator it = list.begin(); it != list.end(); ++it) {
428 429
	    PlaylistItem *item = *it;
	    
430
	    QFileInfo newFile(item->dirPath() + QDir::separator() + m_fileNameBox->text());
431 432 433 434 435 436 437
	    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
438 439 440
	    if((newFile.isWritable() || (!newFile.exists() && directory.isWritable())) &&
	       item->isWritable())
	    {
441 442 443 444 445
		
		// If the file name in the box doesn't match the current file
		// name...
		
		if(list.count() == 1 && item->fileName() != newFile.fileName()) {
446
		    
447 448
		    // Rename the file if it doesn't exist or the user says
		    // that it's ok.
449
		    
450
		    if(!newFile.exists() ||
Scott Wheeler's avatar
Scott Wheeler committed
451 452 453 454
		       KMessageBox::warningYesNo(
			   this, 
			   i18n("This file already exists.\nDo you want to replace it?"),
			   i18n("File Exists")) == KMessageBox::Yes)
455 456 457 458
		    {
			QDir currentDir;
			currentDir.rename(item->filePath(), newFile.filePath());
			item->setFile(newFile.filePath());
459 460
		    }
		}
461 462 463 464 465 466 467
		
		// 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.
		
468 469 470 471 472 473 474 475 476 477 478 479
		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());
480
		
481 482
		if(m_enableBoxes[m_genreBox]->isOn()) {
		    if(m_genreList.findIndex(m_genreBox->currentText()) >= 0)
Scott Wheeler's avatar
Scott Wheeler committed
483 484
			item->tag()->setGenre(
			    m_genreList[m_genreList.findIndex(m_genreBox->currentText())]);
485
		    else
Scott Wheeler's avatar
Scott Wheeler committed
486
			item->tag()->setGenre(
487
			    Genre(m_genreBox->currentText(), item->tag()->genre().ID3v1()));
488 489 490 491
		}
		
		item->tag()->save();
		
492
		item->slotRefresh();
493
	    }
494 495
	    else
		errorFiles.append(item->fileName());
496 497

	    kapp->processEvents();
498 499 500 501 502
	}
	
	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"