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
#include <kapplication.h>
19 20 21 22
#include <kcombobox.h>
#include <klineedit.h>
#include <knuminput.h>
#include <keditcl.h>
23
#include <kmessagebox.h>
24
#include <kconfig.h>
25 26
#include <klocale.h>
#include <kdebug.h>
27
#include <kpushbutton.h>
28 29

#include <qlabel.h>
30
#include <qcheckbox.h>
31 32 33 34
#include <qlayout.h>
#include <qdir.h>

#include "tageditor.h"
35 36
#include "tag.h"
#include "collectionlist.h"
37 38 39 40 41 42 43 44 45 46
#include "genrelistlist.h"

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

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

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

55
void TagEditor::setGenreList(const GenreList &list)
56
{
57
    m_genreList = list;
58 59 60 61 62 63
}

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

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

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

79
    PlaylistItem *item = m_items.getFirst();
80 81

    if(item) {
82
	Tag *tag = item->tag();
83
	
84 85 86
	m_artistNameBox->setEditText(tag->artist());
	m_trackNameBox->setText(tag->track());
	m_albumNameBox->setEditText(tag->album());
87
	
88 89
	if(m_genreList.findIndex(tag->genre()) >= 0)
	    m_genreBox->setCurrentItem(m_genreList.findIndex(tag->genre()) + 1);
90
	else {
91 92
	    m_genreBox->setCurrentItem(0);
	    m_genreBox->setEditText(tag->genre());
93 94
	}
	
95 96
	m_trackSpin->setValue(tag->trackNumber());
	m_yearSpin->setValue(tag->year());
97
	
98
	m_commentBox->setText(tag->comment());
99
	
100 101
	// Start at the second item, since we've already processed the first.

102
	QPtrListIterator<PlaylistItem> it(m_items);
103 104
	++it;

105
	// If there is more than one item in the m_items that we're dealing with...
106 107

	if(it.current()) {
108 109
	    m_fileNameBox->clear();
	    m_fileNameBox->setEnabled(false);
110

111 112
	    m_lengthBox->clear();
	    m_lengthBox->setEnabled(false);
113
	    
114 115
	    m_bitrateBox->clear();
	    m_bitrateBox->setEnabled(false);
116
	    
117
	    for(BoxMap::iterator boxIt = m_enableBoxes.begin(); boxIt != m_enableBoxes.end(); boxIt++) {
118 119 120 121 122 123 124
		(*boxIt)->setChecked(true);
		(*boxIt)->show();
	    }

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

185
	    for(BoxMap::iterator boxIt = m_enableBoxes.begin(); boxIt != m_enableBoxes.end(); boxIt++) {
186 187 188 189
		(*boxIt)->setChecked(true);
		(*boxIt)->hide();
	    }
	}
190
	m_dataChanged = false;
191 192
    }
    else
193
	slotClear();
194 195
}

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

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

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

224
	QStringList artistList = list->artists();
225 226
	artistList.sort();

227 228
        m_artistNameBox->listBox()->insertStringList(artistList);
	m_artistNameBox->completionObject()->setItems(artistList);
229 230
    }

231 232
    if(m_albumNameBox->listBox()) {
        m_albumNameBox->listBox()->clear();
233

234
	QStringList albumList = list->albums();
235 236
	albumList.sort();

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

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

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

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

265
    m_genreList = GenreListList::ID3v1List();
266

267 268
    if(m_genreBox) {
        m_genreBox->clear();
269

270
        // Add values to the genre box
271

272
        m_genreBox->insertItem(QString::null);
273

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

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

290
}
291

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

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

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

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

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

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

        // 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
333
        rightColumnLayout->addWidget(new QLabel(i18n("File name:"), this));
334

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

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

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

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

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

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

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

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

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

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

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

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

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

	QStringList errorFiles;
	
	for(QPtrListIterator<PlaylistItem> it(list); it.current(); ++it) {
	    PlaylistItem *item = *it;
	    
395
	    QFileInfo newFile(item->dirPath() + QDir::separator() + m_fileNameBox->text());
396 397 398 399 400 401 402 403 404 405 406 407 408
	    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()) {
409
		    
410 411
		    // Rename the file if it doesn't exist or the user says
		    // that it's ok.
412
		    
413 414 415 416 417 418 419
		    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());
420 421
		    }
		}
422 423 424 425 426 427 428
		
		// 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.
		
429 430 431 432 433 434 435 436 437 438 439 440
		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());
441
		
442 443 444
		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())]);
445
		    else
446
			item->tag()->setGenre(Genre(m_genreBox->currentText(), item->tag()->genre().getID3v1()));
447 448 449 450
		}
		
		item->tag()->save();
		
451
		item->slotRefresh();
452
	    }
453 454 455 456 457 458 459
	    else
		errorFiles.append(item->fileName());
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
460
				       i18n("Could Not Write to:\n") + errorFiles.join("\n"));
461
	m_dataChanged = false;
462 463

	KApplication::restoreOverrideCursor();
464 465 466 467 468
    }
}

void TagEditor::saveChangesPrompt()
{
469
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
470

471
	QStringList files;
472
        PlaylistItem *item = m_items.first();
473
        while(item) {
474
            files.append(item->fileName());
475
            item = m_items.next();
476 477
        }

478 479 480
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
481 482 483 484
					  i18n("Save Changes"),
					  KStdGuiItem::yes(),
					  KStdGuiItem::no(),
					  "tagEditor_showSaveChangesBox") == KMessageBox::Yes) {
485
            save(m_items);
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 521 522 523
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)));
524
    m_enableBoxes.insert(item, enableBox);
525 526
}

527 528
void TagEditor::showEvent(QShowEvent *e)
{
529
    slotRefresh();
530 531 532
    QWidget::showEvent(e);
}

533 534 535 536
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

537
void TagEditor::slotDataChanged(bool c)
538
{
539
    m_dataChanged = c;
540 541 542
}

#include "tageditor.moc"