Allow configuring the log directory (#783)

New config option in `app.toml`: `log_folder`
This allows the user to change the location of log and backtrace files. The default is still the same (cache directory).

When `RUST_LOG` is set to `off`, the log and backtrace files won't be created.

Closes #774.

---------

Co-authored-by: Thang Pham <[email protected]>

Author: acuteenvy

spotify_player/src/config/mod.rs

@@ -57,6 +57,8 @@ pub struct AppConfig {
 
     pub login_redirect_uri: String,
 
+    pub log_folder: Option<PathBuf>,
+
     pub player_event_hook_command: Option<Command>,
 
     pub playback_format: String,
@@ -268,6 +270,8 @@ impl Default for AppConfig {
 
             login_redirect_uri: "http://127.0.0.1:8989/login".to_string(),
 
+            log_folder: None,
+
             tracks_playback_limit: 50,
 
             playback_format: String::from(

spotify_player/src/main.rs

@@ -36,7 +36,12 @@ fn init_spotify(
     Ok(())
 }
 
-fn init_logging(cache_folder: &std::path::Path) -> Result<()> {
+fn init_logging(log_folder: &std::path::Path) -> Result<()> {
+    if std::env::var_os("RUST_LOG").is_some_and(|x| x == "off") {
+        // Don't create log files if logging is disabled.
+        return Ok(());
+    }
+
     let log_prefix = format!(
         "spotify-player-{}",
         chrono::Local::now().format("%y-%m-%d-%H-%M")
@@ -47,7 +52,10 @@ fn init_logging(cache_folder: &std::path::Path) -> Result<()> {
         // default to log the current crate and librespot crates
         std::env::set_var("RUST_LOG", "spotify_player=info,librespot=info");
     }
-    let log_file = std::fs::File::create(cache_folder.join(format!("{log_prefix}.log")))
+    if !log_folder.exists() {
+        std::fs::create_dir_all(log_folder)?;
+    }
+    let log_file = std::fs::File::create(log_folder.join(format!("{log_prefix}.log")))
         .context("failed to create log file")?;
     tracing_subscriber::fmt::fmt()
         .with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
@@ -56,9 +64,8 @@ fn init_logging(cache_folder: &std::path::Path) -> Result<()> {
         .init();
 
     // initialize the application's panic backtrace
-    let backtrace_file =
-        std::fs::File::create(cache_folder.join(format!("{log_prefix}.backtrace")))
-            .context("failed to create backtrace file")?;
+    let backtrace_file = std::fs::File::create(log_folder.join(format!("{log_prefix}.backtrace")))
+        .context("failed to create backtrace file")?;
     let backtrace_file = std::sync::Mutex::new(backtrace_file);
     std::panic::set_hook(Box::new(move |info| {
         let mut file = backtrace_file.lock().unwrap();
@@ -253,6 +260,10 @@ fn main() -> Result<()> {
     // initialize the application configs
     {
         let mut configs = config::Configs::new(&config_folder, &cache_folder)?;
+        if configs.app_config.log_folder.is_none() {
+            // set the log folder to be the cache folder if it is not set
+            configs.app_config.log_folder = Some(cache_folder);
+        }
         if let Some(theme) = args.get_one::<String>("theme") {
             // override the theme config if user specifies a `theme` cli argument
             theme.clone_into(&mut configs.app_config.theme);
@@ -263,7 +274,13 @@ fn main() -> Result<()> {
     match args.subcommand() {
         None => {
             // initialize the application's log
-            init_logging(&cache_folder).context("failed to initialize application's logging")?;
+            let log_folder = config::get_config()
+                .app_config
+                .log_folder
+                .as_deref()
+                .expect("log_folder is set");
+
+            init_logging(log_folder).context("failed to initialize application's logging")?;
 
             // log the application's configurations
             tracing::info!("Configurations: {:?}", config::get_config());