File indexing completed on 2023-05-30 11:30:50

 /**
  * Copyright (C) 2002-2004 Scott Wheeler <wheeler@kde.org>
  *
  * 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.
  *
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  * PARTICULAR PURPOSE. See the GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License along with
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "playlistitem.h"
 
 #include <algorithm>
 
 #include <kiconloader.h>
 
 #include <QCollator>
 #include <QFileInfo>
 #include <QHeaderView>
 
 #include "collectionlist.h"
 #include "juktag.h"
 #include "coverinfo.h"
 #include "covermanager.h"
 #include "tagtransactionmanager.h"
 
 #include "juk_debug.h"
 
 PlaylistItemList PlaylistItem::m_playingItems; // static
 
 static int naturalCompare(const QString &first, const QString &second)
 {
     static QCollator collator;
     collator.setNumericMode(true);
     collator.setCaseSensitivity(Qt::CaseInsensitive);
     return collator.compare(first, second);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // PlaylistItem public methods
 ////////////////////////////////////////////////////////////////////////////////
 
 PlaylistItem::~PlaylistItem()
 {
     // Although this isn't the most efficient way to accomplish the task of
     // stopping playback when deleting the item being played, it has the
     // stark advantage of working reliably.  I'll tell anyone who tries to
     // optimize this, the timing issues can be *hard*. -- mpyne
 
     if(m_collectionItem) {
         m_collectionItem->removeChildItem(this);
     }
 
     if(m_playingItems.contains(this)) {
         m_playingItems.removeAll(this);
         if(m_playingItems.isEmpty())
             playlist()->setPlaying(0);
     }
 
     playlist()->updateDeletedItem(this);
     emit playlist()->signalAboutToRemove(this);
 
     if(m_watched)
         Pointer::clear(this);
 }
 
 void PlaylistItem::setFile(const FileHandle &file)
 {
     m_collectionItem->updateCollectionDict(d->fileHandle.absFilePath(), file.absFilePath());
     d->fileHandle = file;
     refresh();
 }
 
 void PlaylistItem::setFile(const QString &file)
 {
     QString oldPath = d->fileHandle.absFilePath();
     d->fileHandle.setFile(file);
     m_collectionItem->updateCollectionDict(oldPath, d->fileHandle.absFilePath());
     refresh();
 }
 
 FileHandle PlaylistItem::file() const
 {
     return d->fileHandle;
 }
 
 QString PlaylistItem::text(int column) const
 {
     if(!d->fileHandle.tag())
         return QString();
 
     int offset = playlist()->columnOffset();
 
     switch(column - offset) {
     case TrackColumn:
         return d->fileHandle.tag()->title();
     case ArtistColumn:
         return d->fileHandle.tag()->artist();
     case AlbumColumn:
         return d->fileHandle.tag()->album();
     case CoverColumn:
         return QString();
     case TrackNumberColumn:
         return d->fileHandle.tag()->track() > 0
             ? QString::number(d->fileHandle.tag()->track())
             : QString();
     case GenreColumn:
         return d->fileHandle.tag()->genre();
     case YearColumn:
         return d->fileHandle.tag()->year() > 0
             ? QString::number(d->fileHandle.tag()->year())
             : QString();
     case LengthColumn:
         return d->fileHandle.tag()->lengthString();
     case BitrateColumn:
         return QString::number(d->fileHandle.tag()->bitrate());
     case CommentColumn:
         return d->fileHandle.tag()->comment();
     case FileNameColumn:
         return d->fileHandle.fileInfo().fileName();
     case FullPathColumn:
         return d->fileHandle.fileInfo().absoluteFilePath();
     default:
         return QTreeWidgetItem::text(column);
     }
 }
 
 void PlaylistItem::setText(int column, const QString &text)
 {
     QTreeWidgetItem::setText(column, text);
     playlist()->slotWeightDirty(column);
 }
 
 bool PlaylistItem::isPlaying() const
 {
     return std::any_of(m_playingItems.begin(), m_playingItems.end(),
         [this](const PlaylistItem *playingItem) {
             return this == playingItem;
         });
 }
 
 void PlaylistItem::setPlaying(bool playing, bool master)
 {
     m_playingItems.removeAll(this);
 
     if(playing) {
         if(master)
             m_playingItems.prepend(this);
         else
             m_playingItems.append(this);
     }
     else {
 
         // This is a tricky little recursion, but it
         // in fact does clear the list.
 
         if(!m_playingItems.isEmpty())
             m_playingItems.front()->setPlaying(false);
     }
 
     treeWidget()->viewport()->update();
 }
 
 void PlaylistItem::guessTagInfo(TagGuesser::Type type)
 {
     switch(type) {
     case TagGuesser::FileName:
     {
         TagGuesser guesser(d->fileHandle.absFilePath());
         Tag *tag = TagTransactionManager::duplicateTag(d->fileHandle.tag());
 
         if(!guesser.title().isNull())
             tag->setTitle(guesser.title());
         if(!guesser.artist().isNull())
             tag->setArtist(guesser.artist());
         if(!guesser.album().isNull())
             tag->setAlbum(guesser.album());
         if(!guesser.track().isNull())
             tag->setTrack(guesser.track().toInt());
         if(!guesser.comment().isNull())
             tag->setComment(guesser.comment());
 
         TagTransactionManager::instance()->changeTagOnItem(this, tag);
         break;
     }
     case TagGuesser::MusicBrainz:
         qCDebug(JUK_LOG) << "Ignoring MusicBrainz query request until support is reimplemented.";
         break;
     }
 }
 
 Playlist *PlaylistItem::playlist() const
 {
     return static_cast<Playlist *>(treeWidget());
 }
 
 QVector<int> PlaylistItem::cachedWidths() const
 {
     return d->cachedWidths;
 }
 
 void PlaylistItem::refresh()
 {
     m_collectionItem->refresh();
 }
 
 void PlaylistItem::refreshFromDisk()
 {
     d->fileHandle.refresh();
     refresh();
 }
 
 void PlaylistItem::clear()
 {
     playlist()->clearItem(this);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // PlaylistItem protected methods
 ////////////////////////////////////////////////////////////////////////////////
 
 PlaylistItem::PlaylistItem(CollectionListItem *item, Playlist *parent) :
     QTreeWidgetItem(parent),
     d(0),
     m_watched(0)
 {
     setup(item);
 }
 
 PlaylistItem::PlaylistItem(CollectionListItem *item, Playlist *parent, QTreeWidgetItem *after) :
     QTreeWidgetItem(parent, after),
     d(0),
     m_watched(0)
 {
     setup(item);
 }
 
 
 // This constructor should only be used by the CollectionList subclass.
 
 PlaylistItem::PlaylistItem(CollectionList *parent)
   : QTreeWidgetItem(parent)
     // We *will* be this but we aren't yet; subclass will fix
   , m_collectionItem(nullptr)
   , m_watched(false)
 {
     d = new Data;
     setFlags(flags() | Qt::ItemIsEditable | Qt::ItemIsDragEnabled);
 }
 
 int PlaylistItem::compare(const QTreeWidgetItem *item, int column, bool ascending) const
 {
     // reimplemented from QListViewItem
 
     int offset = playlist()->columnOffset();
 
     if(!item)
         return 0;
 
     const PlaylistItem *playlistItem = static_cast<const PlaylistItem *>(item);
 
     // The following statments first check to see if you can sort based on the
     // specified column.  If the values for the two PlaylistItems are the same
     // in that column it then tries to sort based on columns 1, 2, 3 and 0,
     // (artist, album, track number, track name) in that order.
 
     int c = compare(this, playlistItem, column, ascending);
 
     if(c != 0)
         return c;
     else {
         // Loop through the columns doing comparisons until something is differnt.
         // If all else is the same, compare the track name.
 
         int last = !playlist()->isColumnHidden(AlbumColumn + offset) ? TrackNumberColumn : ArtistColumn;
 
         for(int i = ArtistColumn; i <= last; i++) {
             if(!playlist()->isColumnHidden(i + offset)) {
                 c = compare(this, playlistItem, i, ascending);
                 if(c != 0)
                     return c;
             }
         }
         return compare(this, playlistItem, TrackColumn + offset, ascending);
     }
 }
 
 int PlaylistItem::compare(const PlaylistItem *firstItem, const PlaylistItem *secondItem, int column, bool) const
 {
     int offset = playlist()->columnOffset();
 
     if(column < 0 || column > lastColumn() + offset || !firstItem->d || !secondItem->d)
         return 0;
 
     if(column < offset) {
         QString first = firstItem->text(column);
         QString second = secondItem->text(column);
         return naturalCompare(first, second);
     }
 
     switch(column - offset) {
     case TrackNumberColumn:
         if(firstItem->d->fileHandle.tag()->track() > secondItem->d->fileHandle.tag()->track())
             return 1;
         else if(firstItem->d->fileHandle.tag()->track() < secondItem->d->fileHandle.tag()->track())
             return -1;
         else
             return 0;
         break;
     case LengthColumn:
         if(firstItem->d->fileHandle.tag()->seconds() > secondItem->d->fileHandle.tag()->seconds())
             return 1;
         else if(firstItem->d->fileHandle.tag()->seconds() < secondItem->d->fileHandle.tag()->seconds())
             return -1;
         else
             return 0;
         break;
     case BitrateColumn:
         if(firstItem->d->fileHandle.tag()->bitrate() > secondItem->d->fileHandle.tag()->bitrate())
             return 1;
         else if(firstItem->d->fileHandle.tag()->bitrate() < secondItem->d->fileHandle.tag()->bitrate())
             return -1;
         else
             return 0;
         break;
     case CoverColumn:
         if(firstItem->d->fileHandle.coverInfo()->coverId() == secondItem->d->fileHandle.coverInfo()->coverId())
             return 0;
         else if (firstItem->d->fileHandle.coverInfo()->coverId() != CoverManager::NoMatch)
             return -1;
         else
             return 1;
         break;
     default:
         return naturalCompare(firstItem->d->metadata[column - offset],
                               secondItem->d->metadata[column - offset]);
     }
 }
 
 bool PlaylistItem::operator<(const QTreeWidgetItem &other) const
 {
     bool ascending = playlist()->header()->sortIndicatorOrder() == Qt::AscendingOrder;
     return compare(&other, playlist()->sortColumn(), ascending) == -1;
 }
 
 bool PlaylistItem::isValid() const
 {
     return bool(d->fileHandle.tag());
 }
 
 void PlaylistItem::setTrackId(quint32 id)
 {
     m_trackId = id;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // PlaylistItem private methods
 ////////////////////////////////////////////////////////////////////////////////
 
 void PlaylistItem::setup(CollectionListItem *item)
 {
     m_collectionItem = item;
 
     d = item->d;
     item->addChildItem(this);
     setFlags(flags() | Qt::ItemIsEditable | Qt::ItemIsDragEnabled);
 
     int offset = playlist()->columnOffset();
     int columns = lastColumn() + offset + 1;
 
     for(int i = offset; i < columns; i++) {
         setText(i, text(i));
     }
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // PlaylistItem::Pointer implementation
 ////////////////////////////////////////////////////////////////////////////////
 
 QHash<PlaylistItem *, QVector<PlaylistItem::Pointer *> > PlaylistItem::Pointer::m_itemPointers; // static
 
 PlaylistItem::Pointer::Pointer(PlaylistItem *item) :
     m_item(item)
 {
     if(!m_item)
         return;
 
     m_item->m_watched = true;
     m_itemPointers[m_item].append(this);
 }
 
 PlaylistItem::Pointer::Pointer(const Pointer &p) :
     m_item(p.m_item)
 {
     m_itemPointers[m_item].append(this);
 }
 
 PlaylistItem::Pointer::~Pointer()
 {
     if(!m_item)
         return;
 
     m_itemPointers[m_item].removeAll(this);
     if(m_itemPointers[m_item].isEmpty()) {
         m_itemPointers.remove(m_item);
         m_item->m_watched = false;
     }
 }
 
 PlaylistItem::Pointer &PlaylistItem::Pointer::operator=(PlaylistItem *item)
 {
     if(item == m_item)
         return *this;
 
     if(m_item) {
         m_itemPointers[m_item].removeAll(this);
         if(m_itemPointers[m_item].isEmpty()) {
             m_itemPointers.remove(m_item);
             m_item->m_watched = false;
         }
     }
 
     if(item) {
         m_itemPointers[item].append(this);
         item->m_watched = true;
     }
 
     m_item = item;
 
     return *this;
 }
 
 void PlaylistItem::Pointer::clear(PlaylistItem *item) // static
 {
     if(!item)
         return;
 
     const auto itemPointers = m_itemPointers[item];
     for(const auto &pointerGuard : itemPointers)
         pointerGuard->m_item = nullptr;
     m_itemPointers.remove(item);
     item->m_watched = false;
 }
 
 // vim: set et sw=4 tw=0 sta: