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
    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()) {
110 111 112 113

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

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

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

	BoxMap::iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
193 194 195 196 197
	    (*boxIt)->setChecked(true);
	    (*boxIt)->hide();
	}
    }
    m_dataChanged = false;
198 199
}

200
void TagEditor::slotClear()
201
{
202 203 204 205 206 207 208 209 210 211
    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();    
212 213
}

214
void TagEditor::slotUpdateCollection()
215
{
216 217 218 219 220
    CollectionList *list = CollectionList::instance();

    if(!list)
	return;
    
221 222
    if(m_artistNameBox->listBox()) {
        m_artistNameBox->listBox()->clear();
223 224 225 226 227
	
	// 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.	

228
	QStringList artistList = list->uniqueSet(CollectionList::Artists);
229 230
	artistList.sort();

231 232
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
233 234
    }

235 236
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
237

238
	QStringList albumList = list->uniqueSet(CollectionList::Albums);
239 240
	albumList.sort();

241 242
        m_albumNameBox->listBox()->insertStringList(albumList);
	m_albumNameBox->completionObject()->setItems(albumList);
243 244 245 246 247 248 249
    }    
}

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

250
void TagEditor::readConfig()
251
{
252 253 254
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
255
        if(m_artistNameBox && m_albumNameBox) {
256
            KGlobalSettings::Completion artistNameBoxMode = 
Scott Wheeler's avatar
Scott Wheeler committed
257 258
		KGlobalSettings::Completion(config->readNumEntry("ArtistNameBoxMode",
								 KGlobalSettings::CompletionAuto));
259
	    m_artistNameBox->setCompletionMode(artistNameBoxMode);
260 261
	    
            KGlobalSettings::Completion albumNameBoxMode = 
Scott Wheeler's avatar
Scott Wheeler committed
262 263
		KGlobalSettings::Completion(config->readNumEntry("AlbumNameBoxMode",
								 KGlobalSettings::CompletionAuto));
264
	    m_albumNameBox->setCompletionMode(albumNameBoxMode);
265 266
        }
    }
267

268 269
    // Once the custom genre list editor is done, this is where we should read 
    // the genre list from the config file.
270

271
    m_genreList = GenreListList::ID3v1List();
272

273 274
    if(m_genreBox) {
        m_genreBox->clear();
275

276
        // Add values to the genre box
277

278
        m_genreBox->insertItem(QString::null);
279

280 281
        for(GenreList::Iterator it = m_genreList.begin(); it != m_genreList.end(); ++it)
            m_genreBox->insertItem((*it));
282 283
    }
}
284

285 286 287 288 289
void TagEditor::saveConfig()
{
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
290 291 292
        if(m_artistNameBox && m_albumNameBox) {
	    config->writeEntry("ArtistNameBoxMode", m_artistNameBox->completionMode());
	    config->writeEntry("AlbumNameBoxMode", m_albumNameBox->completionMode());
293 294
        }
    }
295

296
}
297

298 299
void TagEditor::setupLayout()
{
300 301
    static const int horizontalSpacing = 10;
    static const int verticalSpacing = 2;
302

303
    QHBoxLayout *layout = new QHBoxLayout(this, 2, horizontalSpacing);
304 305 306 307 308 309 310 311 312 313 314 315 316 317

    //////////////////////////////////////////////////////////////////////////////
    // 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
318 319 320
        m_artistNameBox = new KComboBox(true, this, "artistNameBox");
	m_artistNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Artist name:"), m_artistNameBox, leftColumnLayout);
321

322 323
        m_trackNameBox = new KLineEdit(this, "trackNameBox");
	addItem(i18n("Track name:"), m_trackNameBox, leftColumnLayout);
324

325 326 327
        m_albumNameBox = new KComboBox(true, this, "albumNameBox");
	m_albumNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Album name:"), m_albumNameBox, leftColumnLayout);
328

329 330
        m_genreBox = new KComboBox(true, this, "genreBox");
	addItem(i18n("Genre:"), m_genreBox, leftColumnLayout);
331 332

        // this fills the space at the bottem of the left column
Scott Wheeler's avatar
Scott Wheeler committed
333 334
        leftColumnLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Minimum,
						  QSizePolicy::Expanding));
335 336 337 338 339
    }
    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the right column
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization
340
        rightColumnLayout->addWidget(addHidden(new QLabel(i18n("File name:"), this)));
341

342
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
343
        rightColumnLayout->addWidget(addHidden(m_fileNameBox));
344 345

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

349 350
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
	    addItem(i18n("Track:"), m_trackSpin, trackRowLayout);
351

Scott Wheeler's avatar
Scott Wheeler committed
352 353
            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding,
						    QSizePolicy::Minimum));
354

355 356
            m_yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
	    addItem(i18n("Year:"), m_yearSpin, trackRowLayout);
357

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

361
            trackRowLayout->addWidget(addHidden(new QLabel(i18n("Length:"), this)));
362 363 364
            m_lengthBox = new KLineEdit(this, "lengthBox");
            m_lengthBox->setMaximumWidth(50);
            m_lengthBox->setReadOnly(true);
365
            trackRowLayout->addWidget(addHidden(m_lengthBox));
366

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

370
            trackRowLayout->addWidget(addHidden(new QLabel(i18n("Bitrate:"), this)));
371 372 373
            m_bitrateBox = new KLineEdit(this, "bitrateBox");
            m_bitrateBox->setMaximumWidth(50);
            m_bitrateBox->setReadOnly(true);
374
            trackRowLayout->addWidget(addHidden(m_bitrateBox));
375 376
        }

377 378 379
        m_commentBox = new KEdit(this, "commentBox");
	m_commentBox->setTextFormat(Qt::PlainText);
	addItem(i18n("Comment:"), m_commentBox, rightColumnLayout);
380 381
    }

Scott Wheeler's avatar
Scott Wheeler committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
    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()));
408 409 410 411
}

void TagEditor::save(const PlaylistItemList &list)
{
412
    if(list.count() > 0 && m_dataChanged) {
413 414 415 416 417 418 419
	
	KApplication::setOverrideCursor(Qt::waitCursor);

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

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

	    kapp->processEvents();
491 492 493 494 495
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
496
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
497
	m_dataChanged = false;
498 499

	KApplication::restoreOverrideCursor();
500 501 502 503 504
    }
}

void TagEditor::saveChangesPrompt()
{
505
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
506

507
	QStringList files;
508 509 510

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

512 513 514
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
515 516 517
					  i18n("Save Changes"),
					  KStdGuiItem::yes(),
					  KStdGuiItem::no(),
518 519
					  "tagEditor_showSaveChangesBox") == KMessageBox::Yes)
	{
520
            save(m_items);
521
	}
522 523 524
    }
}

525 526 527 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
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)));
559
    m_enableBoxes.insert(item, enableBox);
560 561
}

562 563
void TagEditor::showEvent(QShowEvent *e)
{
564
    slotRefresh();
565 566 567
    QWidget::showEvent(e);
}

568 569 570 571
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

572
void TagEditor::slotDataChanged(bool c)
573
{
574
    m_dataChanged = c;
575 576 577
}

#include "tageditor.moc"