tageditor.cpp 18.9 KB
Newer Older
1 2 3 4
/***************************************************************************
                          tageditor.cpp  -  description
                             -------------------
    begin                : Sat Sep 7 2002
5
    copyright            : (C) 2002, 2003 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 22
#include "tageditor.h"
#include "collectionlist.h"
#include "playlistitem.h"
#include "tag.h"

23 24 25 26
#include <kcombobox.h>
#include <klineedit.h>
#include <knuminput.h>
#include <keditcl.h>
27
#include <kmessagebox.h>
28
#include <kconfig.h>
29 30 31 32
#include <klocale.h>
#include <kdebug.h>

#include <qlabel.h>
33
#include <qcheckbox.h>
34 35 36
#include <qlayout.h>
#include <qdir.h>

37 38
#include <id3v1genres.h>

39 40 41 42
////////////////////////////////////////////////////////////////////////////////
// public members
////////////////////////////////////////////////////////////////////////////////

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

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

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

60
void TagEditor::slotSetItems(const PlaylistItemList &list)
61 62
{
    saveChangesPrompt();
63 64 65 66 67 68 69 70 71 72 73 74 75

    if(m_currentPlaylist) {
	disconnect(m_currentPlaylist, SIGNAL(signalAboutToRemove(PlaylistItem *)),
		   this, SLOT(slotItemRemoved(PlaylistItem *)));
    }

    m_currentPlaylist = list.isEmpty() ? 0 : static_cast<Playlist *>(list.first()->listView());

    if(m_currentPlaylist) {
	connect(m_currentPlaylist, SIGNAL(signalAboutToRemove(PlaylistItem *)),
		this, SLOT(slotItemRemoved(PlaylistItem *)));
    }

76
    m_items = list;
77

78
    if(isVisible())
79
	slotRefresh();
80 81
}

82
void TagEditor::slotRefresh()
83
{
84
    // This method takes the list of currently selected m_items and tries to 
85 86
    // 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
87
    // check after that to see if there are other m_items and adjust accordingly.
88

89
    if(m_items.isEmpty() || !m_items.first()->file().tag()) {
90
	slotClear();
91
	setEnabled(false);
92 93 94
	return;
    }
    
95 96
    setEnabled(true);

97
    PlaylistItem *item = m_items.first();
98

99
    Tag *tag = item->file().tag();
100
	
101
    m_artistNameBox->setEditText(tag->artist());
102
    m_trackNameBox->setText(tag->title());
103
    m_albumNameBox->setEditText(tag->album());
104

105
    m_fileNameBox->setText(item->file().absFilePath());
106
    m_bitrateBox->setText(QString::number(tag->bitrate()));
107 108
    m_lengthBox->setText(tag->lengthString());

109 110
    if(m_genreList.findIndex(tag->genre()) >= 0)
	m_genreBox->setCurrentItem(m_genreList.findIndex(tag->genre()) + 1);
111 112
    else {
	m_genreBox->setCurrentItem(0);
113
	m_genreBox->setEditText(tag->genre());
114
    }
115

116
    m_trackSpin->setValue(tag->track());
117 118 119 120 121 122 123 124 125 126 127 128
    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()) {
129 130 131 132

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

	BoxMap::Iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
136 137
	    (*boxIt)->setChecked(true);
	    (*boxIt)->show();
138 139
	}
	
140 141 142
	// 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.
143
	
144
	// Also, if there are more than 50 m_items, don't scan all of them.
145
	
146 147 148 149 150 151 152 153
	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);
154 155
	}
	else {
156
	    for(; it != m_items.end(); ++it) {
157
		tag = (*it)->file().tag();
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

		if(tag) {

		    if(m_artistNameBox->currentText() != tag->artist() &&
		       m_enableBoxes.contains(m_artistNameBox))
		    {
			m_artistNameBox->lineEdit()->clear();
			m_enableBoxes[m_artistNameBox]->setChecked(false);
		    }
		    if(m_trackNameBox->text() != tag->title() &&
		       m_enableBoxes.contains(m_trackNameBox))
		    {
			m_trackNameBox->clear();
			m_enableBoxes[m_trackNameBox]->setChecked(false);
		    }
		    if(m_albumNameBox->currentText() != tag->album() &&
		       m_enableBoxes.contains(m_albumNameBox))
		    {
			m_albumNameBox->lineEdit()->clear();
			m_enableBoxes[m_albumNameBox]->setChecked(false);
		    }
		    if(m_genreBox->currentText() != tag->genre() &&
		       m_enableBoxes.contains(m_genreBox))
		    {
			m_genreBox->lineEdit()->clear();
			m_enableBoxes[m_genreBox]->setChecked(false);
		    }		
		    if(m_trackSpin->value() != tag->track() &&
		       m_enableBoxes.contains(m_trackSpin))
		    {
			m_trackSpin->setValue(0);
			m_enableBoxes[m_trackSpin]->setChecked(false);
		    }		
		    if(m_yearSpin->value() != tag->year() &&
		       m_enableBoxes.contains(m_yearSpin))
		    {
			m_yearSpin->setValue(0);
			m_enableBoxes[m_yearSpin]->setChecked(false);
		    }
		    if(m_commentBox->text() != tag->comment() &&
		       m_enableBoxes.contains(m_commentBox))
		    {
			m_commentBox->clear();
			m_enableBoxes[m_commentBox]->setChecked(false);
		    }
203
		}
204 205
	    }
	}
206
    }
207 208
    else {
	// Clean up in the case that we are only handling one item.
209 210 211 212

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

	BoxMap::iterator boxIt = m_enableBoxes.begin();
	for(; boxIt != m_enableBoxes.end(); boxIt++) {
216 217 218 219 220
	    (*boxIt)->setChecked(true);
	    (*boxIt)->hide();
	}
    }
    m_dataChanged = false;
221 222
}

223
void TagEditor::slotClear()
224
{
225 226 227 228 229 230 231 232 233 234
    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();    
235 236
}

237
void TagEditor::slotUpdateCollection()
238
{
239 240 241 242 243
    CollectionList *list = CollectionList::instance();

    if(!list)
	return;
    
244 245 246 247 248 249 250 251 252
    QStringList artistList = list->uniqueSet(CollectionList::Artists);
    m_artistNameBox->listBox()->clear();
    m_artistNameBox->listBox()->insertStringList(artistList);
    m_artistNameBox->completionObject()->setItems(artistList);

    QStringList albumList = list->uniqueSet(CollectionList::Albums);
    m_albumNameBox->listBox()->clear();
    m_albumNameBox->listBox()->insertStringList(albumList);
    m_albumNameBox->completionObject()->setItems(albumList);
253 254 255 256 257 258
}

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

259
void TagEditor::readConfig()
260
{
261 262
    KConfig *config = KGlobal::config();
    { // combo box completion modes
263 264
	KConfigGroupSaver saver(config, "TagEditor");
	if(m_artistNameBox && m_albumNameBox) {
265 266 267
	    readCompletionMode(config, m_artistNameBox, "ArtistNameBoxMode");
	    readCompletionMode(config, m_albumNameBox, "AlbumNameBoxMode");
	    readCompletionMode(config, m_genreBox, "GenreBoxMode");
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 287 288
    m_genreBox->completionObject()->setItems(m_genreList);
}

void TagEditor::readCompletionMode(KConfig *config, KComboBox *box, const QString &key)
{
    KGlobalSettings::Completion mode =
	KGlobalSettings::Completion(config->readNumEntry(key, KGlobalSettings::CompletionAuto));

    box->setCompletionMode(mode);
289
}
290

291 292 293 294 295
void TagEditor::saveConfig()
{
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
296 297 298
        if(m_artistNameBox && m_albumNameBox) {
	    config->writeEntry("ArtistNameBoxMode", m_artistNameBox->completionMode());
	    config->writeEntry("AlbumNameBoxMode", m_albumNameBox->completionMode());
299
	    config->writeEntry("GenreBoxMode", m_genreBox->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
        m_artistNameBox = new KComboBox(true, this, "artistNameBox");
	m_artistNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
327
	addItem(i18n("&Artist name:"), m_artistNameBox, leftColumnLayout);
328

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

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

336
        m_genreBox = new KComboBox(true, this, "genreBox");
337
	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 347
    }
    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the right column
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization

348
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
Scott Wheeler's avatar
Scott Wheeler committed
349 350 351
	QWidget *fileNameLabel = addHidden(new QLabel(m_fileNameBox, i18n("&File name:"), this));

        rightColumnLayout->addWidget(fileNameLabel);
352
        rightColumnLayout->addWidget(addHidden(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
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
359
	    addItem(i18n("T&rack:"), m_trackSpin, trackRowLayout);
360
	    m_trackSpin->installEventFilter(this);
361

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

365
            m_yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
366
	    addItem(i18n("&Year:"), m_yearSpin, trackRowLayout);
367
	    m_yearSpin->installEventFilter(this);
368

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

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

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

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

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

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

void TagEditor::save(const PlaylistItemList &list)
{
423
    if(!list.isEmpty() && m_dataChanged) {
424 425 426 427 428 429 430
	
	KApplication::setOverrideCursor(Qt::waitCursor);

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

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

	    kapp->processEvents();
499 500 501 502 503
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
504
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
505
	m_dataChanged = false;
506 507

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

void TagEditor::saveChangesPrompt()
{
513 514 515 516 517 518
    if(!isVisible() || !m_dataChanged || m_items.isEmpty())
	return;

    QStringList files;

    for(PlaylistItemList::Iterator it = m_items.begin(); it != m_items.end(); it++)
519
	files.append((*it)->file().absFilePath());
520 521 522 523 524 525 526 527 528 529

    if(KMessageBox::questionYesNoList(this,
				      i18n("Do you want to save your changes to:\n"), 
				      files, 
				      i18n("Save Changes"),
				      KStdGuiItem::yes(),
				      KStdGuiItem::no(),
				      "tagEditor_showSaveChangesBox") == KMessageBox::Yes)
    {
	save(m_items);
530 531 532
    }
}

533 534 535 536 537
void TagEditor::addItem(const QString &text, QWidget *item, QBoxLayout *layout)
{
    if(!item || !layout)
	return;

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

    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)));
567
    m_enableBoxes.insert(item, enableBox);
568 569
}

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

576 577 578 579 580 581 582 583
bool TagEditor::eventFilter(QObject *watched, QEvent *e)
{
    if(watched->inherits("QSpinBox") && e->type() == QEvent::KeyRelease)
	slotDataChanged();

    return false;
}

584 585 586 587
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

588
void TagEditor::slotDataChanged(bool c)
589
{
590
    m_dataChanged = c;
591 592
}

593 594 595 596 597 598 599
void TagEditor::slotItemRemoved(PlaylistItem *item)
{
    m_items.remove(item);
    if(m_items.isEmpty())
	slotRefresh();
}

600
#include "tageditor.moc"