feat: update/rescan cli commands

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 - Arrow keys as secondary navigation keybinds alongside hjkl
 - Support for basic control with mouse. Check docs for more info.
 - Scrolloff option to keep some context the various lists/tables
+- Update/rescan CLI commands to refresh MPD's database
 
 ### Changed
 

docs/src/content/docs/reference/cli-command-mode.mdx

@@ -24,6 +24,8 @@ Usage: rmpc [OPTIONS] [COMMAND]
 
 Commands:
   config         Prints the default config. Can be used to bootstrap your config file
+  update         Scan MPD's music directory for updates
+  rescan         Scan MPD's music directory for updates. Also rescans unmodified files
   theme          Prints the default theme. Can be used to bootstrap your theme file
   albumart       Saves the current album art to a file. Exit codes: * 0: Success * 1: Error * 2: No album art found * 3: No song playing
   debuginfo      Prints information about optional runtime dependencies
@@ -49,7 +51,7 @@ Commands:
   enableoutput   Enable MPD output
   disableoutput  Disable MPD output
   status         Prints various information like the playback status
-  song           Prints information about the current song
+  song           Prints info about the current song. If --path specified, prints information about the song at the given path instead. If --path is specified multiple times, prints an array containing all the songs
   mount          Mounts supported storage to MPD
   unmount        Unmounts storage with given name
   listmounts     List currently mounted storages

src/cli.rs

@@ -6,7 +6,7 @@ use crate::{
     config::{cli::Command, Config},
     context::AppContext,
     mpd::{
-        commands::volume::Bound,
+        commands::{volume::Bound, IdleEvent},
         mpd_client::{Filter, MpdClient, Tag},
     },
     utils::macros::status_error,
@@ -26,6 +26,25 @@ impl Command {
         F: FnMut(WorkRequest, &mut C),
     {
         match self {
+            ref cmd @ Command::Update { ref path, wait } | ref cmd @ Command::Rescan { ref path, wait } => {
+                let crate::mpd::commands::Update { job_id } = if matches!(cmd, Command::Update { .. }) {
+                    client.update(path.as_deref())?
+                } else {
+                    client.rescan(path.as_deref())?
+                };
+
+                if wait {
+                    loop {
+                        client.idle(Some(IdleEvent::Update))?;
+                        let crate::mpd::commands::Status { updating_db, .. } = client.get_status()?;
+                        match updating_db {
+                            Some(current_id) if current_id > job_id => break,
+                            Some(_id) => continue,
+                            None => break,
+                        }
+                    }
+                }
+            }
             Command::Play { position: None } => client.play()?,
             Command::Play { position: Some(pos) } => client.play_pos(pos)?,
             Command::Pause => client.pause()?,

src/config/cli.rs

@@ -17,6 +17,22 @@ pub struct Args {
 pub enum Command {
     /// Prints the default config. Can be used to bootstrap your config file.
     Config,
+    /// Scan MPD's music directory for updates.
+    Update {
+        /// If supplied, MPD will update only the provided directory/file. If not specified, everything is updated.
+        path: Option<String>,
+        /// Rmpc will wait for the update job to finish before returning.
+        #[arg(short, long, default_value = "false")]
+        wait: bool,
+    },
+    /// Scan MPD's music directory for updates. Also rescans unmodified files.
+    Rescan {
+        /// If supplied, MPD will update only the provided directory/file. If not specified, everything is updated.
+        path: Option<String>,
+        /// Rmpc will wait for the update job to finish before returning.
+        #[arg(short, long, default_value = "false")]
+        wait: bool,
+    },
     /// Prints the default theme. Can be used to bootstrap your theme file.
     Theme,
     /// Saves the current album art to a file.

src/main.rs

@@ -532,7 +532,7 @@ fn idle_task(mut idle_client: Client<'_>, sender: std::sync::mpsc::Sender<AppEve
     let mut error_count = 0;
     let sender = sender;
     loop {
-        let events = match idle_client.idle() {
+        let events = match idle_client.idle(None) {
             Ok(val) => val,
             Err(err) => {
                 if error_count > 5 {

src/mpd/commands/idle.rs

@@ -1,7 +1,8 @@
 use crate::mpd::errors::MpdError;
 use crate::mpd::{FromMpd, LineHandled};
 
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone, Copy, strum::Display)]
+#[strum(serialize_all = "snake_case")]
 pub enum IdleEvent {
     Player, // the player has been started, stopped or seeked or tags of the currently playing song have changed (e.g. received from stream)
     Mixer,  // the volume has been changed

src/mpd/commands/mod.rs

@@ -9,6 +9,7 @@ pub mod lsinfo;
 pub mod outputs;
 pub mod playlist_info;
 pub mod status;
+pub mod update;
 pub mod volume;
 
 pub use self::current_song::Song;
@@ -20,4 +21,5 @@ pub use self::lsinfo::LsInfo;
 pub use self::outputs::Output;
 pub use self::status::State;
 pub use self::status::Status;
+pub use self::update::Update;
 pub use self::volume::Volume;

src/mpd/commands/update.rs

@@ -7,8 +7,8 @@ pub struct Update {
 }
 
 impl FromMpd for Update {
-    fn next_internal(&mut self, _key: &str, value: String) -> Result<LineHandled, MpdError> {
-        match value.as_str() {
+    fn next_internal(&mut self, key: &str, value: String) -> Result<LineHandled, MpdError> {
+        match key {
             "updating_db" => self.job_id = value.parse()?,
             _ => return Ok(LineHandled::No { value }),
         };

src/mpd/mpd_client.rs

@@ -10,7 +10,7 @@ use super::{
     client::Client,
     commands::{
         list::MpdList, list_playlist::FileList, outputs::Outputs, status::OnOffOneshot, volume::Bound, IdleEvent,
-        ListFiles, LsInfo, Mounts, Playlist, Song, Status, Volume,
+        ListFiles, LsInfo, Mounts, Playlist, Song, Status, Update, Volume,
     },
     errors::{ErrorCode, MpdError, MpdFailureResponse},
     proto_client::ProtoClient,
@@ -62,7 +62,9 @@ impl ValueChange {
 pub trait MpdClient {
     fn version(&mut self) -> Version;
     fn commands(&mut self) -> MpdResult<MpdList>;
-    fn idle(&mut self) -> MpdResult<Vec<IdleEvent>>;
+    fn update(&mut self, path: Option<&str>) -> MpdResult<Update>;
+    fn rescan(&mut self, path: Option<&str>) -> MpdResult<Update>;
+    fn idle(&mut self, subsystem: Option<IdleEvent>) -> MpdResult<Vec<IdleEvent>>;
     fn noidle(&mut self) -> MpdResult<()>;
     fn get_volume(&mut self) -> MpdResult<Volume>;
     fn set_volume(&mut self, volume: Volume) -> MpdResult<()>;
@@ -134,14 +136,37 @@ impl MpdClient for Client<'_> {
         self.version
     }
 
+    fn update(&mut self, path: Option<&str>) -> MpdResult<Update> {
+        if let Some(path) = path {
+            self.send(&format!("update {path}"))
+                .and_then(ProtoClient::read_response)
+        } else {
+            self.send("update").and_then(ProtoClient::read_response)
+        }
+    }
+
+    fn rescan(&mut self, path: Option<&str>) -> MpdResult<Update> {
+        if let Some(path) = path {
+            self.send(&format!("rescan {path}"))
+                .and_then(ProtoClient::read_response)
+        } else {
+            self.send("rescan").and_then(ProtoClient::read_response)
+        }
+    }
+
     // Lists commands supported by the MPD server
     fn commands(&mut self) -> MpdResult<MpdList> {
         self.send("commands").and_then(ProtoClient::read_response)
     }
 
     // Queries
-    fn idle(&mut self) -> MpdResult<Vec<IdleEvent>> {
-        self.send("idle").and_then(ProtoClient::read_response)
+    fn idle(&mut self, subsystem: Option<IdleEvent>) -> MpdResult<Vec<IdleEvent>> {
+        if let Some(subsystem) = subsystem {
+            self.send(&format!("idle {subsystem}"))
+                .and_then(ProtoClient::read_response)
+        } else {
+            self.send("idle").and_then(ProtoClient::read_response)
+        }
     }
 
     fn noidle(&mut self) -> MpdResult<()> {

src/tests/fixtures/mpd_client.rs

@@ -6,7 +6,7 @@ use rstest::fixture;
 use crate::mpd::{
     commands::{
         list::MpdList, list_playlist::FileList, status::OnOffOneshot, volume::Bound, IdleEvent, ListFiles, LsInfo,
-        Playlist, Song, Status, Volume,
+        Playlist, Song, Status, Update, Volume,
     },
     errors::MpdError,
     mpd_client::{Filter, MpdClient, QueueMoveTarget, SaveMode, SingleOrRange, Tag, ValueChange},
@@ -91,8 +91,8 @@ impl MpdClient for TestMpdClient {
         todo!("Not yet implemented")
     }
 
-    fn idle(&mut self) -> MpdResult<Vec<IdleEvent>> {
-        todo!()
+    fn idle(&mut self, _subsystem: Option<IdleEvent>) -> MpdResult<Vec<IdleEvent>> {
+        todo!("Not yet implemented")
     }
 
     fn noidle(&mut self) -> MpdResult<()> {
@@ -478,4 +478,12 @@ impl MpdClient for TestMpdClient {
     fn search_add(&mut self, _filter: &[Filter<'_, '_>]) -> MpdResult<()> {
         todo!("Not yet implemented")
     }
+
+    fn update(&mut self, _path: Option<&str>) -> MpdResult<Update> {
+        todo!("Not yet implemented")
+    }
+
+    fn rescan(&mut self, _path: Option<&str>) -> MpdResult<Update> {
+        todo!("Not yet implemented")
+    }
 }