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

#include "tageditor.h"
33
#include "collectionlist.h"
34 35 36 37 38 39 40 41 42 43
#include "genrelistlist.h"

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

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

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

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

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

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

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

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

83
    Tag *tag = item->tag();
84
	
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
    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);
111
	
112 113 114 115 116 117 118 119 120
	m_lengthBox->clear();
	m_lengthBox->setEnabled(false);
	
	m_bitrateBox->clear();
	m_bitrateBox->setEnabled(false);
	
	for(BoxMap::Iterator boxIt = m_enableBoxes.begin(); boxIt != m_enableBoxes.end(); boxIt++) {
	    (*boxIt)->setChecked(true);
	    (*boxIt)->show();
121 122
	}
	
123 124 125
	// 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.
126
	
127
	// Also, if there are more than 50 m_items, don't scan all of them.
128
	
129 130 131 132 133 134 135 136
	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);
137 138
	}
	else {
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	    for(; it != m_items.end(); ++it) {
		tag = (*it)->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->track() && 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->trackNumber() && 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);
		}
171 172
	    }
	}
173
    }
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    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);	    
	
	for(BoxMap::iterator boxIt = m_enableBoxes.begin(); boxIt != m_enableBoxes.end(); boxIt++) {
	    (*boxIt)->setChecked(true);
	    (*boxIt)->hide();
	}
    }
    m_dataChanged = false;
192 193
}

194
void TagEditor::slotClear()
195
{
196 197 198 199 200 201 202 203 204 205
    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();    
206 207
}

208
void TagEditor::slotUpdateCollection()
209
{
210 211 212 213 214
    CollectionList *list = CollectionList::instance();

    if(!list)
	return;
    
215 216
    if(m_artistNameBox->listBox()) {
        m_artistNameBox->listBox()->clear();
217 218 219 220 221
	
	// 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.	

222
	QStringList artistList = list->artists();
223 224
	artistList.sort();

225 226
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
227 228
    }

229 230
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
231

232
	QStringList albumList = list->albums();
233 234
	albumList.sort();

235 236
        m_albumNameBox->listBox()->insertStringList(albumList);
	m_albumNameBox->completionObject()->setItems(albumList);
237 238 239 240 241 242 243
    }    
}

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

244
void TagEditor::readConfig()
245
{
246 247 248
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
249
        if(m_artistNameBox && m_albumNameBox) {
250 251
            KGlobalSettings::Completion artistNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("ArtistNameBoxMode", KGlobalSettings::CompletionAuto));
252
	    m_artistNameBox->setCompletionMode(artistNameBoxMode);
253 254 255
	    
            KGlobalSettings::Completion albumNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("AlbumNameBoxMode", KGlobalSettings::CompletionAuto));
256
	    m_albumNameBox->setCompletionMode(albumNameBoxMode);
257 258
        }
    }
259

260 261
    // Once the custom genre list editor is done, this is where we should read 
    // the genre list from the config file.
262

263
    m_genreList = GenreListList::ID3v1List();
264

265 266
    if(m_genreBox) {
        m_genreBox->clear();
267

268
        // Add values to the genre box
269

270
        m_genreBox->insertItem(QString::null);
271

272 273
        for(GenreList::Iterator it = m_genreList.begin(); it != m_genreList.end(); ++it)
            m_genreBox->insertItem((*it));
274 275
    }
}
276

277 278 279 280 281
void TagEditor::saveConfig()
{
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
282 283 284
        if(m_artistNameBox && m_albumNameBox) {
	    config->writeEntry("ArtistNameBoxMode", m_artistNameBox->completionMode());
	    config->writeEntry("AlbumNameBoxMode", m_albumNameBox->completionMode());
285 286
        }
    }
287

288
}
289

290 291
void TagEditor::setupLayout()
{
292 293
    static const int horizontalSpacing = 10;
    static const int verticalSpacing = 2;
294

295
    QHBoxLayout *layout = new QHBoxLayout(this, 2, horizontalSpacing);
296 297 298 299 300 301 302 303 304 305 306 307 308 309

    //////////////////////////////////////////////////////////////////////////////
    // 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
310 311 312
        m_artistNameBox = new KComboBox(true, this, "artistNameBox");
	m_artistNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Artist name:"), m_artistNameBox, leftColumnLayout);
313

314 315
        m_trackNameBox = new KLineEdit(this, "trackNameBox");
	addItem(i18n("Track name:"), m_trackNameBox, leftColumnLayout);
316

317 318 319
        m_albumNameBox = new KComboBox(true, this, "albumNameBox");
	m_albumNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Album name:"), m_albumNameBox, leftColumnLayout);
320

321 322
        m_genreBox = new KComboBox(true, this, "genreBox");
	addItem(i18n("Genre:"), m_genreBox, leftColumnLayout);
323 324 325 326 327 328 329 330

        // this fills the space at the bottem of the left column
        leftColumnLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Minimum, QSizePolicy::Expanding));
    }
    //////////////////////////////////////////////////////////////////////////////
    // put stuff in the right column
    //////////////////////////////////////////////////////////////////////////////
    { // just for organization
331
        rightColumnLayout->addWidget(new QLabel(i18n("File name:"), this));
332

333 334
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
        rightColumnLayout->addWidget(m_fileNameBox);
335 336 337 338

        { // lay out the track row
            QHBoxLayout *trackRowLayout = new QHBoxLayout(rightColumnLayout, horizontalSpacing);

339 340
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
	    addItem(i18n("Track:"), m_trackSpin, trackRowLayout);
341 342

            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding, QSizePolicy::Minimum));
343

344 345
            m_yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
	    addItem(i18n("Year:"), m_yearSpin, trackRowLayout);
346 347 348

            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding, QSizePolicy::Minimum));

349
            trackRowLayout->addWidget(new QLabel(i18n("Length:"), this));
350 351 352 353
            m_lengthBox = new KLineEdit(this, "lengthBox");
            m_lengthBox->setMaximumWidth(50);
            m_lengthBox->setReadOnly(true);
            trackRowLayout->addWidget(m_lengthBox);
354 355 356

            trackRowLayout->addItem(new QSpacerItem(0, 0, QSizePolicy::Expanding, QSizePolicy::Minimum));

357
            trackRowLayout->addWidget(new QLabel(i18n("Bitrate:"), this));
358 359 360 361
            m_bitrateBox = new KLineEdit(this, "bitrateBox");
            m_bitrateBox->setMaximumWidth(50);
            m_bitrateBox->setReadOnly(true);
            trackRowLayout->addWidget(m_bitrateBox);
362 363
        }

364 365 366
        m_commentBox = new KEdit(this, "commentBox");
	m_commentBox->setTextFormat(Qt::PlainText);
	addItem(i18n("Comment:"), m_commentBox, rightColumnLayout);
367 368
    }

369 370 371 372 373 374 375 376 377
    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()));
378 379 380 381
}

void TagEditor::save(const PlaylistItemList &list)
{
382
    if(list.count() > 0 && m_dataChanged) {
383 384 385 386 387 388 389
	
	KApplication::setOverrideCursor(Qt::waitCursor);

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

	QStringList errorFiles;
	
390
	for(PlaylistItemList::ConstIterator it = list.begin(); it != list.end(); ++it) {
391 392
	    PlaylistItem *item = *it;
	    
393
	    QFileInfo newFile(item->dirPath() + QDir::separator() + m_fileNameBox->text());
394 395 396 397 398 399 400 401 402 403 404 405 406
	    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.
	    
	    if((newFile.isWritable() || (!newFile.exists() && directory.isWritable())) && item->isWritable()) {
		
		// If the file name in the box doesn't match the current file
		// name...
		
		if(list.count() == 1 && item->fileName() != newFile.fileName()) {
407
		    
408 409
		    // Rename the file if it doesn't exist or the user says
		    // that it's ok.
410
		    
411 412 413 414 415 416 417
		    if(!newFile.exists() ||
		       KMessageBox::warningYesNo(this, i18n("This file already exists.\nDo you want to replace it?"),
						 i18n("File Exists")) == KMessageBox::Yes)
		    {
			QDir currentDir;
			currentDir.rename(item->filePath(), newFile.filePath());
			item->setFile(newFile.filePath());
418 419
		    }
		}
420 421 422 423 424 425 426
		
		// 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.
		
427 428 429 430 431 432 433 434 435 436 437 438
		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());
439
		
440 441 442
		if(m_enableBoxes[m_genreBox]->isOn()) {
		    if(m_genreList.findIndex(m_genreBox->currentText()) >= 0)
			item->tag()->setGenre(m_genreList[m_genreList.findIndex(m_genreBox->currentText())]);
443
		    else
444
			item->tag()->setGenre(Genre(m_genreBox->currentText(), item->tag()->genre().getID3v1()));
445 446 447 448
		}
		
		item->tag()->save();
		
449
		item->slotRefresh();
450
	    }
451 452 453 454 455 456 457
	    else
		errorFiles.append(item->fileName());
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
458
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
459
	m_dataChanged = false;
460 461

	KApplication::restoreOverrideCursor();
462 463 464 465 466
    }
}

void TagEditor::saveChangesPrompt()
{
467
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
468

469
	QStringList files;
470 471 472

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

474 475 476
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
477 478 479
					  i18n("Save Changes"),
					  KStdGuiItem::yes(),
					  KStdGuiItem::no(),
480 481
					  "tagEditor_showSaveChangesBox") == KMessageBox::Yes)
	{
482
            save(m_items);
483
	}
484 485 486
    }
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
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)));
521
    m_enableBoxes.insert(item, enableBox);
522 523
}

524 525
void TagEditor::showEvent(QShowEvent *e)
{
526
    slotRefresh();
527 528 529
    QWidget::showEvent(e);
}

530 531 532 533
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

534
void TagEditor::slotDataChanged(bool c)
535
{
536
    m_dataChanged = c;
537 538 539
}

#include "tageditor.moc"