Playlist feature: add 'Shuffle playlist' sidebar action

src/library/playlisttablemodel.cpp

@@ -291,6 +291,7 @@ void PlaylistTableModel::shuffleTracks(const QModelIndexList& shuffle, const QMo
         // this is used to exclude the already loaded track at pos #1 if used from running Auto-DJ
         excludePos = exclude.sibling(exclude.row(), positionColumn).data().toInt();
     }
+    int numOfTracks = rowCount();
     if (shuffle.count() > 1) {
         // if there is more then one track selected, shuffle selection only
         foreach (QModelIndex shuffleIndex, shuffle) {
@@ -300,8 +301,7 @@ void PlaylistTableModel::shuffleTracks(const QModelIndexList& shuffle, const QMo
             }
         }
     } else {
-        // if there is only one track selected, shuffle all tracks
-        int numOfTracks = rowCount();
+        // if there is no track or only one selected, shuffle all tracks
         for (int i = 0; i < numOfTracks; i++) {
             int oldPosition = index(i, positionColumn).data().toInt();
             if (oldPosition != excludePos) {
@@ -310,7 +310,6 @@ void PlaylistTableModel::shuffleTracks(const QModelIndexList& shuffle, const QMo
         }
     }
     // Set up list of all IDs
-    int numOfTracks = rowCount();
     for (int i = 0; i < numOfTracks; i++) {
         int position = index(i, positionColumn).data().toInt();
         TrackId trackId(index(i, idColumn).data());

src/library/trackset/baseplaylistfeature.cpp

@@ -678,17 +678,18 @@ TreeItemModel* BasePlaylistFeature::sidebarModel() const {
     return m_pSidebarModel;
 }
 
-void BasePlaylistFeature::bindLibraryWidget(WLibrary* libraryWidget,
-        KeyboardEventFilter* keyboard) {
-    Q_UNUSED(keyboard);
-    WLibraryTextBrowser* edit = new WLibraryTextBrowser(libraryWidget);
-    edit->setHtml(getRootViewHtml());
-    edit->setOpenLinks(false);
-    connect(edit,
+void BasePlaylistFeature::bindLibraryWidget(WLibrary* pLibraryWidget,
+        KeyboardEventFilter* pKeyboard) {
+    Q_UNUSED(pKeyboard);
+    WLibraryTextBrowser* pEdit = new WLibraryTextBrowser(pLibraryWidget);
+    pEdit->setHtml(getRootViewHtml());
+    pEdit->setOpenLinks(false);
+    connect(pEdit,
             &WLibraryTextBrowser::anchorClicked,
             this,
             &BasePlaylistFeature::htmlLinkClicked);
-    libraryWidget->registerView(m_rootViewName, edit);
+    m_pLibraryWidget = QPointer(pLibraryWidget);
+    m_pLibraryWidget->registerView(m_rootViewName, pEdit);
 }
 
 void BasePlaylistFeature::bindSidebarWidget(WLibrarySidebar* pSidebarWidget) {

src/library/trackset/baseplaylistfeature.h

@@ -96,6 +96,7 @@ class BasePlaylistFeature : public BaseTrackSetFeature {
     QModelIndex m_lastClickedIndex;
     QModelIndex m_lastRightClickedIndex;
     QPointer<WLibrarySidebar> m_pSidebarWidget;
+    QPointer<WLibrary> m_pLibraryWidget;
 
     QAction* m_pCreatePlaylistAction;
     QAction* m_pDeletePlaylistAction;

src/library/trackset/playlistfeature.cpp

@@ -14,7 +14,9 @@
 #include "sources/soundsourceproxy.h"
 #include "util/db/dbconnection.h"
 #include "util/duration.h"
+#include "widget/wlibrary.h"
 #include "widget/wlibrarysidebar.h"
+#include "widget/wtracktableview.h"
 
 namespace {
 
@@ -43,6 +45,12 @@ PlaylistFeature::PlaylistFeature(Library* pLibrary, UserSettingsPointer pConfig)
     std::unique_ptr<TreeItem> pRootItem = TreeItem::newRoot(this);
     m_pSidebarModel->setRootItem(std::move(pRootItem));
     constructChildModel(kInvalidPlaylistId);
+
+    m_pShufflePlaylistAction = new QAction(tr("Shuffle Playlist"), this);
+    connect(m_pShufflePlaylistAction,
+            &QAction::triggered,
+            this,
+            &PlaylistFeature::slotShufflePlaylist);
 }
 
 QVariant PlaylistFeature::title() {
@@ -73,6 +81,10 @@ void PlaylistFeature::onRightClickChild(
     QMenu menu(m_pSidebarWidget);
     menu.addAction(m_pCreatePlaylistAction);
     menu.addSeparator();
+    // TODO If playlist is selected and has more than one track selected
+    // show "Shuffle selected tracks", else show "Shuffle playlist"?
+    menu.addAction(m_pShufflePlaylistAction);
+    menu.addSeparator();
     menu.addAction(m_pRenamePlaylistAction);
     menu.addAction(m_pDuplicatePlaylistAction);
     menu.addAction(m_pDeletePlaylistAction);
@@ -222,6 +234,49 @@ QString PlaylistFeature::fetchPlaylistLabel(int playlistId) {
     return QString();
 }
 
+void PlaylistFeature::slotShufflePlaylist() {
+    int playlistId = playlistIdFromIndex(m_lastRightClickedIndex);
+    if (playlistId == kInvalidPlaylistId) {
+        return;
+    }
+
+    if (m_playlistDao.isPlaylistLocked(playlistId)) {
+        qDebug() << "Can't shuffle locked playlist" << playlistId
+                 << m_playlistDao.getPlaylistName(playlistId);
+        return;
+    }
+
+    // Shuffle all tracks
+    // If the playlist is loaded/visible shuffle only selected tracks
+    QModelIndexList selection;
+    if (isChildIndexSelectedInSidebar(m_lastRightClickedIndex) &&
+            m_pPlaylistTableModel->getPlaylist() == playlistId) {
+        if (m_pLibraryWidget) {
+            WTrackTableView* view = dynamic_cast<WTrackTableView*>(
+                    m_pLibraryWidget->getActiveView());
+            if (view != nullptr) {
+                selection = view->selectionModel()->selectedIndexes();
+            }
+        }
+        m_pPlaylistTableModel->shuffleTracks(selection, QModelIndex());
+    } else {
+        // Create a temp model so we don't need to select the playlist
+        // in the persistent model in order to shuffle it
+        QScopedPointer<PlaylistTableModel> pPlaylistTableModel(
+                new PlaylistTableModel(this,
+                        m_pLibrary->trackCollectionManager(),
+                        "mixxx.db.model.playlist_shuffle"));
+        pPlaylistTableModel->selectPlaylist(playlistId);
+        pPlaylistTableModel->setSort(
+                pPlaylistTableModel->fieldIndex(
+                        ColumnCache::COLUMN_PLAYLISTTRACKSTABLE_POSITION),
+                Qt::AscendingOrder);
+        pPlaylistTableModel->select();
+
+        pPlaylistTableModel->shuffleTracks(selection, QModelIndex());
+    }
+}
+
 /// Purpose: When inserting or removing playlists,
 /// we require the sidebar model not to reset.
 /// This method queries the database and does dynamic insertion

src/library/trackset/playlistfeature.h

@@ -35,6 +35,7 @@ class PlaylistFeature : public BasePlaylistFeature {
     void slotPlaylistTableChanged(int playlistId) override;
     void slotPlaylistContentOrLockChanged(const QSet<int>& playlistIds) override;
     void slotPlaylistTableRenamed(int playlistId, const QString& newName) override;
+    void slotShufflePlaylist();
 
   protected:
     QString fetchPlaylistLabel(int playlistId) override;
@@ -44,4 +45,6 @@ class PlaylistFeature : public BasePlaylistFeature {
 
   private:
     QString getRootViewHtml() const override;
+
+    QAction* m_pShufflePlaylistAction;
 };

src/library/trackset/setlogfeature.cpp

@@ -106,13 +106,13 @@ QVariant SetlogFeature::title() {
 }
 
 void SetlogFeature::bindLibraryWidget(
-        WLibrary* libraryWidget, KeyboardEventFilter* keyboard) {
-    BasePlaylistFeature::bindLibraryWidget(libraryWidget, keyboard);
+        WLibrary* pLibraryWidget, KeyboardEventFilter* pKeyboard) {
+    BasePlaylistFeature::bindLibraryWidget(pLibraryWidget, pKeyboard);
     connect(&PlayerInfo::instance(),
             &PlayerInfo::currentPlayingTrackChanged,
             this,
             &SetlogFeature::slotPlayingTrackChanged);
-    m_libraryWidget = QPointer(libraryWidget);
+    m_pLibraryWidget = QPointer(pLibraryWidget);
 }
 
 void SetlogFeature::deleteAllUnlockedPlaylistsWithFewerTracks() {
@@ -598,9 +598,9 @@ void SetlogFeature::slotPlayingTrackChanged(TrackPointer currentPlayingTrack) {
         // View needs a refresh
 
         bool hasActiveView = false;
-        if (m_libraryWidget) {
+        if (m_pLibraryWidget) {
             WTrackTableView* view = dynamic_cast<WTrackTableView*>(
-                    m_libraryWidget->getActiveView());
+                    m_pLibraryWidget->getActiveView());
             if (view != nullptr) {
                 // We have a active view on the history. The user may have some
                 // important active selection. For example putting track into crates

src/library/trackset/setlogfeature.h

@@ -61,8 +61,6 @@ class SetlogFeature : public BasePlaylistFeature {
 
     int m_currentPlaylistId;
     int m_yearNodeId;
-
-    QPointer<WLibrary> m_libraryWidget;
     Library* m_pLibrary;
     UserSettingsPointer m_pConfig;
 };