✨ feat: execute script on change

Author: MidHunterX

README.md

@@ -17,6 +17,7 @@ Expression is a highly customizable, time-aware wallpaper engine for Linux. It a
 - [x] Distribute wallpapers from a group evenly across the hour
 - [x] Override with special wallpaper based on a timetable (e.g., lunch, sleep)
 - [x] Per group config overrides
+- [x] Execute custom scripts on wallpaper change
 
 ## 🚀 Installation
 
@@ -106,6 +107,10 @@ backend = "swww"
 enable_special = true
 # Way to select wallpaper from a group: random, spread
 group_selection_strategy = "random"
+# Command to execute on wallpaper change
+# Examples:
+# execute_on_change = "~/.scripts/custom_script.sh"
+execute_on_change = "notify-send 'Wallpaper Changed'"
 
 [directories]
 # Default wallpaper directory

config.toml

@@ -2,6 +2,7 @@
 backend = "swww"
 enable_special = true
 group_selection_strategy = "random" # random, spread
+# execute_on_change = "/path/to/script_or_executable"
 
 [directories]
 wallpaper = "~/Pictures/"

src/config.rs

@@ -23,6 +23,7 @@ pub struct GeneralConfig {
     pub backend: String,
     pub enable_special: bool,
     pub group_selection_strategy: GroupSelectionStrategy,
+    pub execute_on_change: Option<String>,
 }
 
 #[derive(Debug, Deserialize)]

src/main.rs

@@ -3,7 +3,7 @@ use colored::Colorize;
 use ctrlc;
 use expression::backends::get_backend;
 use expression::config::{get_group_config, Config, GroupSelectionStrategy};
-use expression::utils::{calc, logger, wallpaper};
+use expression::utils::{calc, cmd, logger, wallpaper};
 use log2::{debug, error, info, warn};
 use std::process;
 use std::sync::atomic::{AtomicBool, Ordering};
@@ -39,6 +39,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let config_special_entries = config.special_entries;
     let config_special_enabled = config.general.enable_special;
     let mut config_group_selection = config.general.group_selection_strategy;
+    let exec_cmd = config.general.execute_on_change;
 
     let mut selected_item = Vec::new();
 
@@ -232,13 +233,18 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
             );
         }
 
-        // REFRESH
+        // REFRESH LOOP
         match refresh_strategy {
-            RefreshStrategy::Sleep => {
-                calc::sleep(wait_seconds);
-            }
-            RefreshStrategy::Log2Sleep => {
-                calc::refresh_tlog2(interval, now, wait_seconds);
+            RefreshStrategy::Sleep => calc::sleep(wait_seconds),
+            RefreshStrategy::Log2Sleep => calc::refresh_tlog2(interval, now, wait_seconds),
+        }
+
+        // EXECUTE SCRIPT
+        if exec_cmd.is_some() {
+            let result = cmd::execute(exec_cmd.as_ref().unwrap());
+            match result {
+                Ok(_) => {}
+                Err(err) => error!("Error executing command: {}", err),
             }
         }
     }

src/utils/cmd.rs

@@ -0,0 +1,31 @@
+use std::io;
+use std::process::{Command, Output};
+
+/// Execute a shell command and return the result
+/// # Arguments
+/// * `cmd` - The command string to execute
+/// # Returns
+/// * `Result<Output, io::Error>` - The command output or an error
+/// # Example
+/// ```
+/// use expression::utils::command::execute_shell_command;
+///
+/// let result = execute("ls -la");
+/// match result {
+///     Ok(output) => {
+///         println!("stdout: {}", String::from_utf8_lossy(&output.stdout));
+///         println!("stderr: {}", String::from_utf8_lossy(&output.stderr));
+///         println!("status: {}", output.status);
+///     }
+///     Err(e) => eprintln!("Error executing command: {}", e),
+/// }
+/// ```
+pub fn execute(cmd: &str) -> Result<Output, io::Error> {
+    let (shell, flag) = if cfg!(target_os = "windows") {
+        ("cmd", "/C")
+    } else {
+        ("bash", "-c")
+    };
+
+    Command::new(shell).arg(flag).arg(cmd).output()
+}

src/utils/mod.rs

@@ -1,3 +1,4 @@
 pub mod wallpaper;
 pub mod calc;
 pub mod logger;
+pub mod cmd;