Prefer OS Specific Paths (#474)

Co-authored-by: Ilesh Thiada <ileshkt@gmail.com>

Author: catuhana

Cargo.lock

@@ -145,9 +145,13 @@ cargo install ferium
 
 ### Program Configuration
 
-Ferium stores profile and modpack information in its config file. By default, this is located at `~/.config/ferium/config.json`.  
-You can change this in 2 ways, setting the `FERIUM_CONFIG_FILE` environment variable, or setting the `--config-file` global flag.
-The flag always takes precedence.
+Ferium stores profile and modpack information in its config file. By default, this is located at
+- `$XDG_CONFIG_HOME/ferium/config.json` or `~/.config/ferium/config.json` on Linux.
+- `%APPDATA%/ferium/config/config.json` on Windows.
+- `~/.config/ferium/config.json` on macOS.
+
+You can change this in 2 ways; by setting the `FERIUM_CONFIG_FILE` environment variable,
+or the `--config-file` global flag. The flag takes precedence.
 
 > [!CAUTION]
 > Be mindful of syntax when manually editing the config file

README.md

@@ -32,10 +32,10 @@ serde = { version = "1.0", features = ["derive"] }
 url = { version = "2.5", features = ["serde"] }
 zip-extensions = "0.8"
 futures-util = "0.3"
+directories = "6.0"
 thiserror = "2.0"
 regex = "1.11"
 sha1 = "0.10"
-home = "0.5"
 zip = "2.5"
 
 [patch.crates-io]

libium/Cargo.toml

@@ -1,20 +1,11 @@
 pub mod filters;
 pub mod structs;
-
 use std::{
     fs::{create_dir_all, File},
     io::{BufReader, Result},
-    path::{Path, PathBuf},
-    sync::LazyLock,
+    path::Path,
 };
 
-pub static DEFAULT_CONFIG_PATH: LazyLock<PathBuf> = LazyLock::new(|| {
-    crate::HOME
-        .join(".config")
-        .join("ferium")
-        .join("config.json")
-});
-
 /// Open the config file at `path` and deserialise it into a config struct
 pub fn read_config(path: impl AsRef<Path>) -> Result<structs::Config> {
     if !path.as_ref().exists() {

libium/src/config/mod.rs

@@ -9,6 +9,7 @@ pub mod version_ext;
 pub use add::add;
 pub use scan::scan;
 
+use directories::{BaseDirs, ProjectDirs};
 use std::{path::PathBuf, sync::LazyLock};
 
 pub static GITHUB_API: LazyLock<octocrab::Octocrab> = LazyLock::new(|| {
@@ -36,24 +37,27 @@ pub static MODRINTH_API: LazyLock<ferinth::Ferinth> = LazyLock::new(|| {
     .expect("Could not build Modrinth client") // This should never fail since no `authorisation` token was provided
 });
 
-pub static HOME: LazyLock<PathBuf> =
-    LazyLock::new(|| home::home_dir().expect("Could not get user's home directory"));
+pub static BASE_DIRS: LazyLock<BaseDirs> =
+    LazyLock::new(|| BaseDirs::new().expect("Could not get OS specific directories"));
+
+pub static PROJECT_DIRS: LazyLock<ProjectDirs> = LazyLock::new(|| {
+    ProjectDirs::from("", "", "ferium").expect("Could not get OS specific directories")
+});
 
 /// Gets the default Minecraft instance directory based on the current compilation `target_os`
-///
-/// If the `target_os` doesn't match `"macos"`, `"linux"`, or `"windows"`, this function will not compile.
 pub fn get_minecraft_dir() -> PathBuf {
-    #[cfg(target_os = "windows")]
-    return HOME.join("AppData").join("Roaming").join(".minecraft");
-
     #[cfg(target_os = "macos")]
-    return HOME
-        .join("Library")
-        .join("Application Support")
-        .join("minecraft");
-
-    #[cfg(target_os = "linux")]
-    return HOME.join(".minecraft");
+    {
+        BASE_DIRS.data_dir().join("minecraft")
+    }
+    #[cfg(target_os = "windows")]
+    {
+        BASE_DIRS.data_dir().join(".minecraft")
+    }
+    #[cfg(not(any(target_os = "macos", target_os = "windows")))]
+    {
+        BASE_DIRS.home_dir().join(".minecraft")
+    }
 }
 
 /// Read `source` and return the data as a string

libium/src/lib.rs

@@ -1,13 +1,19 @@
 use super::{from_mr_version, try_from_cf_file, DistributionDeniedError};
-use crate::{config::structs::ModpackIdentifier, CURSEFORGE_API, HOME, MODRINTH_API};
+use crate::{config::structs::ModpackIdentifier, CURSEFORGE_API, MODRINTH_API, PROJECT_DIRS};
 use reqwest::Client;
 use std::{fs::create_dir_all, path::PathBuf};
 
 #[derive(Debug, thiserror::Error)]
 #[error(transparent)]
 pub enum Error {
-    /// The user can manually download the modpack zip file and place it in `~/.config/ferium/.cache/` to mitigate this.
+    /// The user can manually download the modpack zip file and place it in
+    /// `<ferium cache path>/downloaded` to mitigate this.
     /// However, they will have to manually update the modpack file.
+    ///
+    /// Ferium cache path:
+    /// - Windows: `%LOCALAPPDATA%/ferium/cache`
+    /// - Linux: `${XDG_CACHE_HOME}/ferium` or `~/.cache/ferium`
+    /// - MacOS: `~/Library/Caches/ferium`
     DistributionDenied(#[from] DistributionDeniedError),
     ModrinthError(#[from] ferinth::Error),
     CurseForgeError(#[from] furse::Error),
@@ -32,7 +38,7 @@ impl ModpackIdentifier {
             }
         };
 
-        let cache_dir = HOME.join(".config").join("ferium").join(".cache");
+        let cache_dir = PROJECT_DIRS.cache_dir().join("downloaded");
         let modpack_path = cache_dir.join(&download_data.output);
         if !modpack_path.exists() {
             create_dir_all(&cache_dir)?;

libium/src/upgrade/modpack_downloadable.rs

@@ -1,4 +1,4 @@
-use libium::HOME;
+use libium::BASE_DIRS;
 use std::{
     io::Result,
     path::{Path, PathBuf},
@@ -38,7 +38,7 @@ pub fn pick_folder(
                 .components()
                 .map(|c| {
                     if c.as_os_str() == "~" {
-                        HOME.as_os_str()
+                        BASE_DIRS.home_dir().as_os_str()
                     } else {
                         c.as_os_str()
                     }

src/file_picker.rs

@@ -35,7 +35,6 @@ use libium::{
         self,
         filters::ProfileParameters as _,
         structs::{Config, ModIdentifier, Modpack, Profile},
-        DEFAULT_CONFIG_PATH,
     },
     iter_ext::IterExt as _,
 };
@@ -157,10 +156,31 @@ async fn actual_main(mut cli_app: Ferium) -> Result<()> {
 
     let _ = SEMAPHORE.set(Semaphore::new(cli_app.parallel_tasks));
 
+    let old_default_config_path = libium::BASE_DIRS
+        .home_dir()
+        .join(".config")
+        .join("ferium")
+        .join("config.json");
     let config_path = &cli_app
         .config_file
         .or_else(|| var_os("FERIUM_CONFIG_FILE").map(Into::into))
-        .unwrap_or(DEFAULT_CONFIG_PATH.clone());
+        .unwrap_or({
+            #[cfg(target_os = "macos")]
+            {
+                old_default_config_path
+            }
+            #[cfg(not(target_os = "macos"))]
+            {
+                libium::PROJECT_DIRS.config_dir().join("config.json")
+            }
+        });
+
+    // Handle old configs which may be in a different path
+    if !config_path.exists() && old_default_config_path.exists() {
+        std::fs::rename(old_default_config_path, config_path)
+            .context("Failed to relocate config file to the new path, try doing so manually.")?;
+    }
+
     let mut config = config::read_config(config_path)?;
 
     let mut did_add_fail = false;

src/main.rs

@@ -14,7 +14,7 @@ use crate::file_picker::pick_folder;
 use anyhow::{ensure, Context as _, Result};
 use fs_extra::dir::{copy, CopyOptions};
 use inquire::Confirm;
-use libium::HOME;
+use libium::BASE_DIRS;
 use std::{fs::read_dir, path::Path};
 
 pub fn check_output_directory(output_dir: &Path) -> Result<()> {
@@ -44,7 +44,7 @@ pub fn check_output_directory(output_dir: &Path) -> Result<()> {
                 .unwrap_or_default()
             {
                 let backup_dir = pick_folder(
-                    &*HOME,
+                    BASE_DIRS.home_dir(),
                     "Where should the backup be made?",
                     "Output Directory",
                 )?

src/subcommands/modpack/mod.rs

@@ -13,7 +13,7 @@ use libium::{
         read_file_from_zip, zip_extract,
     },
     upgrade::{from_modpack_file, try_from_cf_file, DistributionDeniedError, DownloadData},
-    CURSEFORGE_API, HOME,
+    CURSEFORGE_API,
 };
 use std::{
     fs::File,
@@ -113,10 +113,9 @@ pub async fn upgrade(modpack: &'_ Modpack) -> Result<()> {
             );
 
             if modpack.install_overrides {
-                let tmp_dir = HOME
-                    .join(".config")
-                    .join("ferium")
-                    .join(".tmp")
+                let tmp_dir = libium::PROJECT_DIRS
+                    .cache_dir()
+                    .join("extracted")
                     .join(manifest.name);
                 zip_extract(&modpack_filepath, &tmp_dir)?;
                 to_install = read_overrides(&tmp_dir.join(manifest.overrides))?;
@@ -142,10 +141,9 @@ pub async fn upgrade(modpack: &'_ Modpack) -> Result<()> {
             );
 
             if modpack.install_overrides {
-                let tmp_dir = HOME
-                    .join(".config")
-                    .join("ferium")
-                    .join(".tmp")
+                let tmp_dir = libium::PROJECT_DIRS
+                    .cache_dir()
+                    .join("extracted")
                     .join(metadata.name);
                 zip_extract(&modpack_filepath, &tmp_dir)?;
                 to_install = read_overrides(&tmp_dir.join("overrides"))?;