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 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
#include <qlayout.h>
#include <qdir.h>

32 33
#include <id3v1genres.h>

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

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

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

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

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

58
void TagEditor::slotSetItems(const PlaylistItemList &list)
59 60
{
    saveChangesPrompt();
61
    m_items = list;
62
    if(isVisible())
63
	slotRefresh();
64 65
}

66
void TagEditor::slotRefresh()
67
{
68
    // This method takes the list of currently selected m_items and tries to 
69 70
    // 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
71
    // check after that to see if there are other m_items and adjust accordingly.
72

73 74
    if(m_items.isEmpty()) {
	slotClear();
75
	setEnabled(false);
76 77 78
	return;
    }
    
79 80
    setEnabled(true);

81
    PlaylistItem *item = m_items.first();
82

83
    Tag *tag = item->tag();
84
	
85 86 87
    m_artistNameBox->setEditText(tag->artist());
    m_trackNameBox->setText(tag->track());
    m_albumNameBox->setEditText(tag->album());
88 89 90 91 92

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

93 94
    if(m_genreList.findIndex(tag->genre()) >= 0)
	m_genreBox->setCurrentItem(m_genreList.findIndex(tag->genre()) + 1);
95 96
    else {
	m_genreBox->setCurrentItem(0);
97
	m_genreBox->setEditText(tag->genre());
98
    }
99

100 101 102 103 104 105 106 107 108 109 110 111 112
    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()) {
113 114 115 116

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

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

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

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

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

217
void TagEditor::slotUpdateCollection()
218
{
219 220 221 222 223
    CollectionList *list = CollectionList::instance();

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

231
	QStringList artistList = list->uniqueSet(CollectionList::Artists);
232 233
	artistList.sort();

234 235
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
236 237
    }

238 239
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
240

241
	QStringList albumList = list->uniqueSet(CollectionList::Albums);
242 243
	albumList.sort();

244 245
        m_albumNameBox->listBox()->insertStringList(albumList);
	m_albumNameBox->completionObject()->setItems(albumList);
246 247 248 249 250 251 252
    }    
}

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

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

271
    TagLib::StringList genres = TagLib::ID3v1::genreList();
272

273 274 275
    for(TagLib::StringList::ConstIterator it = genres.begin(); it != genres.end(); ++it)
	m_genreList.append(TStringToQString((*it)));
    m_genreList.sort();
276

277 278 279
    m_genreBox->clear();
    m_genreBox->insertItem(QString::null);
    m_genreBox->insertStringList(m_genreList);
280
}
281

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

293
}
294

295 296
void TagEditor::setupLayout()
{
297 298
    static const int horizontalSpacing = 10;
    static const int verticalSpacing = 2;
299

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

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

319
        m_trackNameBox = new KLineEdit(this, "trackNameBox");
320
	addItem(i18n("&Track name:"), m_trackNameBox, leftColumnLayout);
321

322 323
        m_albumNameBox = new KComboBox(true, this, "albumNameBox");
	m_albumNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
324
	addItem(i18n("Album &name:"), m_albumNameBox, leftColumnLayout);
325

326
        m_genreBox = new KComboBox(true, this, "genreBox");
327
	addItem(i18n("&Genre:"), m_genreBox, leftColumnLayout);
328 329

        // this fills the space at the bottem of the left column
Scott Wheeler's avatar
Scott Wheeler committed
330 331
        leftColumnLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Minimum,
						  QSizePolicy::Expanding));
332 333 334 335 336 337
    }
    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the right column
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization

338
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
Scott Wheeler's avatar
Scott Wheeler committed
339 340 341
	QWidget *fileNameLabel = addHidden(new QLabel(m_fileNameBox, i18n("&File name:"), this));

        rightColumnLayout->addWidget(fileNameLabel);
342
        rightColumnLayout->addWidget(addHidden(m_fileNameBox));
343 344

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

348
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
349
	    addItem(i18n("T&rack:"), m_trackSpin, trackRowLayout);
350

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

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

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

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

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

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

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

Scott Wheeler's avatar
Scott Wheeler committed
381 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
    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()));
407 408 409 410
}

void TagEditor::save(const PlaylistItemList &list)
{
411
    if(!list.isEmpty() && m_dataChanged) {
412 413 414 415 416 417 418
	
	KApplication::setOverrideCursor(Qt::waitCursor);

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

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

	    kapp->processEvents();
484 485 486 487 488
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
489
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
490
	m_dataChanged = false;
491 492

	KApplication::restoreOverrideCursor();
493 494 495 496 497
    }
}

void TagEditor::saveChangesPrompt()
{
498
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
499

500
	QStringList files;
501 502 503

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

505 506 507
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
508 509 510
					  i18n("Save Changes"),
					  KStdGuiItem::yes(),
					  KStdGuiItem::no(),
511 512
					  "tagEditor_showSaveChangesBox") == KMessageBox::Yes)
	{
513
            save(m_items);
514
	}
515 516 517
    }
}

518 519 520 521 522
void TagEditor::addItem(const QString &text, QWidget *item, QBoxLayout *layout)
{
    if(!item || !layout)
	return;

523
    QLabel *label = new QLabel(item, text, this);
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

    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)));
552
    m_enableBoxes.insert(item, enableBox);
553 554
}

555 556
void TagEditor::showEvent(QShowEvent *e)
{
557
    slotRefresh();
558 559 560
    QWidget::showEvent(e);
}

561 562 563 564
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

565
void TagEditor::slotDataChanged(bool c)
566
{
567
    m_dataChanged = c;
568 569 570
}

#include "tageditor.moc"