support moving items in a playlist (#224)

add commands to move items up and down in the current playlist 🎵

closes #197

README.md

@@ -372,6 +372,8 @@ List of supported commands:
 | `SortTrackByDuration`          | sort the track table (if any) by track's duration                       | `s d`              |
 | `SortTrackByAddedDate`         | sort the track table (if any) by track's added date                     | `s D`              |
 | `ReverseOrder`                 | reverse the order of the track table (if any)                           | `s r`              |
+| `MovePlaylistItemUp`           | move playlist item up one position                                      | `C-k`              |
+| `MovePlaylistItemDown`         | move playlist item down one position                                    | `C-j`              |
 
 To add new shortcuts or modify the default shortcuts, please refer to the [keymaps section](docs/config.md#keymaps) in the configuration documentation.
 

spotify_player/src/client/mod.rs

@@ -375,6 +375,23 @@ impl Client {
                     state.player.write().queue = Some(queue);
                 }
             }
+            ClientRequest::ReorderPlaylistItems {
+                playlist_id,
+                insert_index,
+                range_start,
+                range_length,
+                snapshot_id,
+            } => {
+                self.reorder_playlist_items(
+                    state,
+                    playlist_id,
+                    insert_index,
+                    range_start,
+                    range_length,
+                    snapshot_id.as_deref(),
+                )
+                .await?;
+            }
         };
 
         tracing::info!(
@@ -866,6 +883,46 @@ impl Client {
         Ok(())
     }
 
+    /// reorder items in a playlist
+    pub async fn reorder_playlist_items(
+        &self,
+        state: &SharedState,
+        playlist_id: PlaylistId<'_>,
+        insert_index: usize,
+        range_start: usize,
+        range_length: Option<usize>,
+        snapshot_id: Option<&str>,
+    ) -> Result<()> {
+        let insert_before = match insert_index > range_start {
+            true => insert_index + 1,
+            false => insert_index,
+        };
+
+        self.spotify
+            .playlist_reorder_items(
+                playlist_id.clone(),
+                Some(range_start as i32),
+                Some(insert_before as i32),
+                range_length.map(|range_length| range_length as u32),
+                snapshot_id,
+            )
+            .await?;
+
+        // After making a reorder request, update the playlist in-memory data stored inside the app caches.
+        if let Some(Context::Playlist { tracks, .. }) = state
+            .data
+            .write()
+            .caches
+            .context
+            .get_mut(&playlist_id.uri())
+        {
+            let track = tracks.remove(range_start);
+            tracks.insert(insert_index, track);
+        }
+
+        Ok(())
+    }
+
     /// adds a Spotify item to current user's library.
     /// Before adding new item, the function checks if that item already exists in the library
     /// to avoid adding a duplicated item.

spotify_player/src/command.rs

@@ -68,6 +68,9 @@ pub enum Command {
     SortTrackByDuration,
     SortTrackByAddedDate,
     ReverseTrackOrder,
+
+    MovePlaylistItemUp,
+    MovePlaylistItemDown,
 }
 
 #[derive(Debug, Copy, Clone)]
@@ -199,6 +202,8 @@ impl Command {
             Self::SortTrackByDuration => "sort the track table (if any) by track's duration",
             Self::SortTrackByAddedDate => "sort the track table (if any) by track's added date",
             Self::ReverseTrackOrder => "reverse the order of the track table (if any)",
+            Self::MovePlaylistItemUp => "move playlist item up one position",
+            Self::MovePlaylistItemDown => "move playlist item down one position",
         }
     }
 }

spotify_player/src/config/keymap.rs

@@ -274,6 +274,14 @@ impl Default for KeymapConfig {
                     key_sequence: "s r".into(),
                     command: Command::ReverseTrackOrder,
                 },
+                Keymap {
+                    key_sequence: "C-k".into(),
+                    command: Command::MovePlaylistItemUp,
+                },
+                Keymap {
+                    key_sequence: "C-j".into(),
+                    command: Command::MovePlaylistItemDown,
+                },
             ],
         }
     }

spotify_player/src/event/mod.rs

@@ -50,6 +50,13 @@ pub enum ClientRequest {
     AddTrackToQueue(TrackId<'static>),
     AddTrackToPlaylist(PlaylistId<'static>, TrackId<'static>),
     DeleteTrackFromPlaylist(PlaylistId<'static>, TrackId<'static>),
+    ReorderPlaylistItems {
+        playlist_id: PlaylistId<'static>,
+        insert_index: usize,
+        range_start: usize,
+        range_length: Option<usize>,
+        snapshot_id: Option<String>,
+    },
     AddToLibrary(Item),
     DeleteFromLibrary(ItemId),
     ConnectDevice(Option<String>),

spotify_player/src/event/window.rs

@@ -185,6 +185,58 @@ pub fn handle_command_for_track_table_window(
         Command::AddSelectedItemToQueue => {
             client_pub.send(ClientRequest::AddTrackToQueue(tracks[id].id.clone()))?;
         }
+        Command::MovePlaylistItemUp => {
+            if let PageState::Context {
+                id: Some(ContextId::Playlist(playlist_id)),
+                ..
+            } = ui.current_page()
+            {
+                if id > 0
+                    && data.user_data.playlists.iter().any(|playlist| {
+                        &playlist.id == playlist_id
+                            && Some(&playlist.owner.1)
+                                == data.user_data.user.as_ref().map(|user| &user.id)
+                    })
+                {
+                    let insert_index = id - 1;
+                    client_pub.send(ClientRequest::ReorderPlaylistItems {
+                        playlist_id: playlist_id.clone_static(),
+                        insert_index,
+                        range_start: id,
+                        range_length: None,
+                        snapshot_id: None,
+                    })?;
+                    ui.current_page_mut().select(insert_index);
+                };
+            }
+            ui.popup = None;
+        }
+        Command::MovePlaylistItemDown => {
+            if let PageState::Context {
+                id: Some(ContextId::Playlist(playlist_id)),
+                ..
+            } = ui.current_page()
+            {
+                let insert_index = id + 1;
+                if insert_index < tracks.len()
+                    && data.user_data.playlists.iter().any(|playlist| {
+                        &playlist.id == playlist_id
+                            && Some(&playlist.owner.1)
+                                == data.user_data.user.as_ref().map(|user| &user.id)
+                    })
+                {
+                    client_pub.send(ClientRequest::ReorderPlaylistItems {
+                        playlist_id: playlist_id.clone_static(),
+                        insert_index,
+                        range_start: id,
+                        range_length: None,
+                        snapshot_id: None,
+                    })?;
+                    ui.current_page_mut().select(insert_index);
+                };
+            }
+            ui.popup = None;
+        }
         _ => return Ok(false),
     }
     Ok(true)