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 17.9 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 27 28
#include <klocale.h>
#include <kdebug.h>

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

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

////////////////////////////////////////////////////////////////////////////////
// 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
}

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

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

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

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

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

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

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

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

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

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

110 111
	    m_lengthBox->clear();
	    m_lengthBox->setEnabled(false);
112
	    
113 114
	    m_bitrateBox->clear();
	    m_bitrateBox->setEnabled(false);
115
	    
116
	    for(BoxMap::iterator boxIt = m_enableBoxes.begin(); boxIt != m_enableBoxes.end(); boxIt++) {
117 118 119 120 121 122 123
		(*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.
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 137 138
	    }
	    else {
		for(; it.current(); ++it) {
		    tag = (*it)->tag();
139 140 141
		    if(m_artistNameBox->currentText() != tag->artist() && m_enableBoxes.contains(m_artistNameBox)) {
			m_artistNameBox->lineEdit()->clear();
			m_enableBoxes[m_artistNameBox]->setChecked(false);
142
		    }
143 144 145
		    if(m_trackNameBox->text() != tag->track() && m_enableBoxes.contains(m_trackNameBox)) {
			m_trackNameBox->clear();
			m_enableBoxes[m_trackNameBox]->setChecked(false);
146
		    }
147 148 149
		    if(m_albumNameBox->currentText() != tag->album() && m_enableBoxes.contains(m_albumNameBox)) {
			m_albumNameBox->lineEdit()->clear();
			m_enableBoxes[m_albumNameBox]->setChecked(false);
150
		    }
151 152 153
		    if(m_genreBox->currentText() != tag->genre() && m_enableBoxes.contains(m_genreBox)) {
			m_genreBox->lineEdit()->clear();
			m_enableBoxes[m_genreBox]->setChecked(false);
154 155
		    }		
		    
156 157 158
		    if(m_trackSpin->value() != tag->trackNumber() && m_enableBoxes.contains(m_trackSpin)) {
			m_trackSpin->setValue(0);
			m_enableBoxes[m_trackSpin]->setChecked(false);
159
		    }		
160 161 162
		    if(m_yearSpin->value() != tag->year() && m_enableBoxes.contains(m_yearSpin)) {
			m_yearSpin->setValue(0);
			m_enableBoxes[m_yearSpin]->setChecked(false);
163 164
		    }
		    
165 166 167
		    if(m_commentBox->text() != tag->comment() && m_enableBoxes.contains(m_commentBox)) {
			m_commentBox->clear();
			m_enableBoxes[m_commentBox]->setChecked(false);
168
		    }
169 170 171 172 173 174
		}
	    }
	}
	else {
	    // Clean up in the case that we are only handling one item.
	    
175 176
	    m_fileNameBox->setText(item->fileName());
	    m_fileNameBox->setEnabled(true);
177
	    
178 179
	    m_lengthBox->setText(tag->lengthString());
	    m_lengthBox->setEnabled(true);
180
	    
181 182
	    m_bitrateBox->setText(tag->bitrateString());
	    m_bitrateBox->setEnabled(true);	    
183

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

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

void TagEditor::save()
{
211
    save(m_items);
212 213
}

214
void TagEditor::updateCollection()
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->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->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 257
            KGlobalSettings::Completion artistNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("ArtistNameBoxMode", KGlobalSettings::CompletionAuto));
258
	    m_artistNameBox->setCompletionMode(artistNameBoxMode);
259 260 261
	    
            KGlobalSettings::Completion albumNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("AlbumNameBoxMode", KGlobalSettings::CompletionAuto));
262
	    m_albumNameBox->setCompletionMode(albumNameBoxMode);
263 264
        }
    }
265

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

269
    m_genreList = GenreListList::ID3v1List();
270

271 272
    if(m_genreBox) {
        m_genreBox->clear();
273

274
        // Add values to the genre box
275

276
        m_genreBox->insertItem(QString::null);
277

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

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

294
}
295

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

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

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

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

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

327 328
        m_genreBox = new KComboBox(true, this, "genreBox");
	addItem(i18n("Genre:"), m_genreBox, leftColumnLayout);
329 330 331 332 333 334 335 336

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

339 340
        m_fileNameBox = new KLineEdit(this, "fileNameBox");
        rightColumnLayout->addWidget(m_fileNameBox);
341 342 343 344

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

345 346
            m_trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
	    addItem(i18n("Track:"), m_trackSpin, trackRowLayout);
347 348

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

350 351
            m_yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
	    addItem(i18n("Year:"), m_yearSpin, trackRowLayout);
352 353 354

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

355
            trackRowLayout->addWidget(new QLabel(i18n("Length:"), this));
356 357 358 359
            m_lengthBox = new KLineEdit(this, "lengthBox");
            m_lengthBox->setMaximumWidth(50);
            m_lengthBox->setReadOnly(true);
            trackRowLayout->addWidget(m_lengthBox);
360 361 362

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

363
            trackRowLayout->addWidget(new QLabel(i18n("Bitrate:"), this));
364 365 366 367
            m_bitrateBox = new KLineEdit(this, "bitrateBox");
            m_bitrateBox->setMaximumWidth(50);
            m_bitrateBox->setReadOnly(true);
            trackRowLayout->addWidget(m_bitrateBox);
368 369
        }

370 371 372
        m_commentBox = new KEdit(this, "commentBox");
	m_commentBox->setTextFormat(Qt::PlainText);
	addItem(i18n("Comment:"), m_commentBox, rightColumnLayout);
373 374
    }

375 376 377 378 379 380 381 382 383
    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()));
384 385 386 387
}

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

	KApplication::restoreOverrideCursor();
468 469 470 471 472
    }
}

void TagEditor::saveChangesPrompt()
{
473
    if(isVisible() && m_dataChanged && !m_items.isEmpty()) {
474

475
	QStringList files;
476
        PlaylistItem *item = m_items.first();
477
        while(item) {
478
            files.append(item->fileName());
479
            item = m_items.next();
480 481
        }

482 483 484 485
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
					  i18n("Save Changes")) == KMessageBox::Yes) {
486
            save(m_items);
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 524
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)));
525
    m_enableBoxes.insert(item, enableBox);
526 527
}

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

534 535 536 537
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

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

#include "tageditor.moc"