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 16.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 46 47 48 49 50 51 52 53
#include "genrelistlist.h"

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

TagEditor::TagEditor(QWidget *parent, const char *name) : QWidget(parent, name) 
{
    setupLayout();
    readConfig();
    dataChanged = false;
}

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

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

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

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

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

    PlaylistItem *item = items.getFirst();

    if(item) {
80
	Tag *tag = item->tag();
81
	
82 83 84
	artistNameBox->setEditText(tag->artist());
	trackNameBox->setText(tag->track());
	albumNameBox->setEditText(tag->album());
85
	
86 87
	if(genreList.findIndex(tag->genre()) >= 0)
	    genreBox->setCurrentItem(genreList.findIndex(tag->genre()) + 1);
88 89
	else {
	    genreBox->setCurrentItem(0);
90
	    genreBox->setEditText(tag->genre());
91 92
	}
	
93 94
	trackSpin->setValue(tag->trackNumber());
	yearSpin->setValue(tag->year());
95
	
96
	commentBox->setText(tag->comment());
97
	
98 99 100 101 102 103 104 105 106 107
	// Start at the second item, since we've already processed the first.

	QPtrListIterator<PlaylistItem> it(items);
	++it;

	// If there is more than one item in the items that we're dealing with...

	if(it.current()) {
	    fileNameBox->clear();
	    fileNameBox->setEnabled(false);
108 109 110 111 112 113

	    lengthBox->clear();
	    lengthBox->setEnabled(false);
	    
	    bitrateBox->clear();
	    bitrateBox->setEnabled(false);
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
	    
	    for(BoxMap::iterator boxIt = enableBoxes.begin(); boxIt != enableBoxes.end(); boxIt++) {
		(*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.

	    for(; it.current(); ++it) {
		tag = (*it)->tag();
		if(artistNameBox->currentText() != tag->artist() && enableBoxes.contains(artistNameBox)) {
		    artistNameBox->lineEdit()->clear();
		    enableBoxes[artistNameBox]->setChecked(false);
		}
		if(trackNameBox->text() != tag->track() && enableBoxes.contains(trackNameBox)) {
		    trackNameBox->clear();
		    enableBoxes[trackNameBox]->setChecked(false);
		}
		if(albumNameBox->currentText() != tag->album() && enableBoxes.contains(albumNameBox)) {
		    albumNameBox->lineEdit()->clear();
		    enableBoxes[albumNameBox]->setChecked(false);
		}
		if(genreBox->currentText() != tag->genre() && enableBoxes.contains(genreBox)) {
		    genreBox->lineEdit()->clear();
		    enableBoxes[genreBox]->setChecked(false);
		}		

		if(trackSpin->value() != tag->trackNumber() && enableBoxes.contains(trackSpin)) {
		    trackSpin->setValue(0);
		    enableBoxes[trackSpin]->setChecked(false);
		}		
		if(yearSpin->value() != tag->year() && enableBoxes.contains(yearSpin)) {
		    yearSpin->setValue(0);
		    enableBoxes[yearSpin]->setChecked(false);
		}

		if(commentBox->text() != tag->comment() && enableBoxes.contains(commentBox)) {
		    commentBox->clear();
		    enableBoxes[commentBox]->setChecked(false);
		}
	    }
	}
	else {
	    // Clean up in the case that we are only handling one item.
	    
161
	    fileNameBox->setText(item->fileName());
162
	    fileNameBox->setEnabled(true);
163 164 165 166 167 168
	    
	    lengthBox->setText(tag->lengthString());
	    lengthBox->setEnabled(true);
	    
	    bitrateBox->setText(tag->bitrateString());
	    bitrateBox->setEnabled(true);	    
169 170 171 172 173 174

	    for(BoxMap::iterator boxIt = enableBoxes.begin(); boxIt != enableBoxes.end(); boxIt++) {
		(*boxIt)->setChecked(true);
		(*boxIt)->hide();
	    }
	}
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
	dataChanged = false;
    }
    else
	clear();
}

void TagEditor::clear()
{
    artistNameBox->lineEdit()->clear();
    trackNameBox->clear();
    albumNameBox->lineEdit()->clear();
    genreBox->setCurrentItem(0);
    fileNameBox->clear();
    trackSpin->setValue(0);
    yearSpin->setValue(0);
    lengthBox->clear();
    bitrateBox->clear();
    commentBox->clear();    
}

void TagEditor::save()
{
    save(items);
}

200
void TagEditor::updateCollection()
201
{
202 203 204 205 206
    CollectionList *list = CollectionList::instance();

    if(!list)
	return;
    
207 208 209 210 211 212 213
    if(artistNameBox->listBox()) {
        artistNameBox->listBox()->clear();
	
	// 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.	

214
	QStringList artistList = list->artists();
215 216 217
	artistList.sort();

        artistNameBox->listBox()->insertStringList(artistList);
218
	artistNameBox->completionObject()->setItems(artistList);
219 220 221 222 223
    }

    if(albumNameBox->listBox()) {
        albumNameBox->listBox()->clear();

224
	QStringList albumList = list->albums();
225 226 227
	albumList.sort();

        albumNameBox->listBox()->insertStringList(albumList);
228
	albumNameBox->completionObject()->setItems(albumList);
229 230 231 232 233 234 235
    }    
}

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

236
void TagEditor::readConfig()
237
{
238 239 240 241 242 243 244 245 246 247 248 249 250
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
        if(artistNameBox && albumNameBox) {
            KGlobalSettings::Completion artistNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("ArtistNameBoxMode", KGlobalSettings::CompletionAuto));
	    artistNameBox->setCompletionMode(artistNameBoxMode);
	    
            KGlobalSettings::Completion albumNameBoxMode = 
		KGlobalSettings::Completion(config->readNumEntry("AlbumNameBoxMode", KGlobalSettings::CompletionAuto));
	    albumNameBox->setCompletionMode(albumNameBoxMode);
        }
    }
251

252 253
    // Once the custom genre list editor is done, this is where we should read 
    // the genre list from the config file.
254

255
    genreList = GenreListList::ID3v1List();
256

257 258
    if(genreBox) {
        genreBox->clear();
259

260
        // Add values to the genre box
261

262
        genreBox->insertItem(QString::null);
263

264 265 266 267
        for(GenreList::Iterator it = genreList.begin(); it != genreList.end(); ++it)
            genreBox->insertItem((*it));
    }
}
268

269 270 271 272 273 274 275 276 277 278
void TagEditor::saveConfig()
{
    KConfig *config = KGlobal::config();
    { // combo box completion modes
        KConfigGroupSaver saver(config, "TagEditor");
        if(artistNameBox && albumNameBox) {
	    config->writeEntry("ArtistNameBoxMode", artistNameBox->completionMode());
	    config->writeEntry("AlbumNameBoxMode", albumNameBox->completionMode());
        }
    }
279

280
}
281

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
void TagEditor::setupLayout()
{
    const int horizontalSpacing = 10;
    const int verticalSpacing = 2;

    QHBoxLayout *layout = new QHBoxLayout(this, 0, horizontalSpacing);

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

        trackNameBox = new KLineEdit(this, "trackNameBox");
	addItem(i18n("Track Name"), trackNameBox, leftColumnLayout);

        albumNameBox = new KComboBox(true, this, "albumNameBox");
	albumNameBox->setCompletionMode(KGlobalSettings::CompletionAuto);
	addItem(i18n("Album Name"), albumNameBox, leftColumnLayout);

        genreBox = new KComboBox(true, this, "genreBox");
	addItem(i18n("Genre"), genreBox, leftColumnLayout);

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

        fileNameBox = new KLineEdit(this, "fileNameBox");
        rightColumnLayout->addWidget(fileNameBox);

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

            trackSpin = new KIntSpinBox(0, 255, 1, 0, 10, this, "trackSpin");
	    addItem("Track", trackSpin, trackRowLayout);

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

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
            yearSpin = new KIntSpinBox(0, 9999, 1, 0, 10, this, "yearSpin");
	    addItem(i18n("Year"), yearSpin, trackRowLayout);

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

            trackRowLayout->addWidget(new QLabel(i18n("Length"), this));
            lengthBox = new KLineEdit(this, "lengthBox");
            lengthBox->setMaximumWidth(50);
            lengthBox->setReadOnly(true);
            trackRowLayout->addWidget(lengthBox);

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

            trackRowLayout->addWidget(new QLabel(i18n("Bitrate"), this));
            bitrateBox = new KLineEdit(this, "bitrateBox");
            bitrateBox->setMaximumWidth(50);
            bitrateBox->setReadOnly(true);
            trackRowLayout->addWidget(bitrateBox);
        }

        commentBox = new KEdit(this, "commentBox");
	commentBox->setTextFormat(Qt::PlainText);
	addItem(i18n("Comment"), commentBox, rightColumnLayout);
    }

    connect(artistNameBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(changed()));
    connect(trackNameBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(changed()));
    connect(albumNameBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(changed()));
    connect(genreBox, SIGNAL(activated(int)), this, SIGNAL(changed()));
    connect(genreBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(changed()));
    connect(fileNameBox, SIGNAL(textChanged(const QString&)), this, SIGNAL(changed()));
    connect(yearSpin, SIGNAL(valueChanged(int)), this, SIGNAL(changed()));
    connect(trackSpin, SIGNAL(valueChanged(int)), this, SIGNAL(changed()));
    connect(commentBox, SIGNAL(textChanged()), this, SIGNAL(changed()));

    connect(this, SIGNAL(changed()), this, SLOT(setDataChanged()));
}

void TagEditor::save(const PlaylistItemList &list)
{
    if(list.count() > 0 && dataChanged) {
	
	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;
	    
	    QFileInfo newFile(item->dirPath() + QDir::separator() + fileNameBox->text());
	    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()) {
401
		    
402 403
		    // Rename the file if it doesn't exist or the user says
		    // that it's ok.
404
		    
405 406 407 408 409 410 411
		    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());
412 413
		    }
		}
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
		
		// 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.
		
		if(enableBoxes[artistNameBox]->isOn())
		    item->tag()->setArtist(artistNameBox->currentText());
		if(enableBoxes[trackNameBox]->isOn())
		    item->tag()->setTrack(trackNameBox->text());
		if(enableBoxes[albumNameBox]->isOn())
		    item->tag()->setAlbum(albumNameBox->currentText());
		if(enableBoxes[trackSpin]->isOn())
		    item->tag()->setTrackNumber(trackSpin->value());
		if(enableBoxes[yearSpin]->isOn())
		    item->tag()->setYear(yearSpin->value());
		if(enableBoxes[commentBox]->isOn())
		    item->tag()->setComment(commentBox->text());
		
		if(enableBoxes[genreBox]->isOn()) {
		    if(genreList.findIndex(genreBox->currentText()) >= 0)
			item->tag()->setGenre(genreList[genreList.findIndex(genreBox->currentText())]);
		    else
			item->tag()->setGenre(Genre(genreBox->currentText(), item->tag()->genre().getID3v1()));
		}
		
		item->tag()->save();
		
		item->refresh();
444
	    }
445 446 447 448 449 450 451 452 453 454 455
	    else
		errorFiles.append(item->fileName());
	}
	
	if(!errorFiles.isEmpty())
	    KMessageBox::detailedSorry(this,
				       i18n("Could not save to specified file(s)."), 
				       i18n("Could not write to:\n") + errorFiles.join("\n"));
	dataChanged = false;

	KApplication::restoreOverrideCursor();
456 457 458 459 460 461 462
    }
}

void TagEditor::saveChangesPrompt()
{
    if(dataChanged && !items.isEmpty()) {

463
	QStringList files;
464 465
        PlaylistItem *item = items.first();
        while(item) {
466
            files.append(item->fileName());
467 468 469
            item = items.next();
        }

470 471 472 473
        if(KMessageBox::questionYesNoList(this,
					  i18n("Do you want to save your changes to:\n"), 
					  files, 
					  i18n("Save Changes")) == KMessageBox::Yes) {
474
            save(items);
475
	}
476 477 478
    }
}

479 480 481 482 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
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)));
    enableBoxes.insert(item, enableBox);
}

516 517 518 519 520 521 522 523 524 525
////////////////////////////////////////////////////////////////////////////////
// private slots
////////////////////////////////////////////////////////////////////////////////

void TagEditor::setDataChanged(bool c)
{
    dataChanged = c;
}

#include "tageditor.moc"