fix: $HOME detection on windows

pascalkuthe · pascalkuthe · commit d1bd513f27e1 · 2023-03-30T15:48:59.000+02:00
diff --git a/cargo-smart-release/src/crates_index.rs b/cargo-smart-release/src/crates_index.rs
@@ -36,7 +36,7 @@ fn default_path() -> PathBuf {
         .or_else(|| {
             std::env::var_os("CARGO_HOME")
                 .map(PathBuf::from)
-                .or_else(|| std::env::var_os("HOME").map(|dir| Path::new(&dir).join(".cargo")))
+                .or_else(|| home::home_dir().map(|dir| Path::new(&dir).join(".cargo")))
         })
         .expect("one of these paths works")
         .join("registry/index")
diff --git a/gix-config/src/file/init/comfort.rs b/gix-config/src/file/init/comfort.rs
@@ -1,5 +1,7 @@
 use std::path::PathBuf;
 
+use gix_path::home;
+
 use crate::{
     file::{init, Metadata},
     path, source, File, Source,
@@ -30,7 +32,7 @@ impl File<'static> {
             .flat_map(|kind| kind.sources())
             .filter_map(|source| {
                 let path = source
-                    .storage_location(&mut |name| std::env::var_os(name))
+                    .storage_location(&mut crate::env_var)
                     .and_then(|p| p.is_file().then_some(p))
                     .map(|p| p.into_owned());
 
@@ -43,7 +45,7 @@ impl File<'static> {
                 .into()
             });
 
-        let home = std::env::var("HOME").ok().map(PathBuf::from);
+        let home = home();
         let options = init::Options {
             includes: init::includes::Options::follow_without_conditional(home.as_deref()),
             ..Default::default()
@@ -59,7 +61,7 @@ impl File<'static> {
     ///
     /// [`gix-config`'s documentation]: https://git-scm.com/docs/gix-config#Documentation/gix-config.txt-GITCONFIGCOUNT
     pub fn from_environment_overrides() -> Result<File<'static>, init::from_env::Error> {
-        let home = std::env::var("HOME").ok().map(PathBuf::from);
+        let home = home();
         let options = init::Options {
             includes: init::includes::Options::follow_without_conditional(home.as_deref()),
             ..Default::default()
@@ -88,7 +90,7 @@ impl File<'static> {
             let mut path = dir.into();
             path.push(
                 source
-                    .storage_location(&mut |n| std::env::var_os(n))
+                    .storage_location(&mut crate::env_var)
                     .expect("location available for local"),
             );
             let local = Self::from_path_no_includes(&path, source)?;
@@ -101,7 +103,7 @@ impl File<'static> {
                 let source = Source::Worktree;
                 let path = git_dir.join(
                     source
-                        .storage_location(&mut |n| std::env::var_os(n))
+                        .storage_location(&mut crate::env_var)
                         .expect("location available for worktree"),
                 );
                 Self::from_path_no_includes(path, source)
@@ -110,7 +112,7 @@ impl File<'static> {
         }
         .transpose()?;
 
-        let home = std::env::var("HOME").ok().map(PathBuf::from);
+        let home = home();
         let options = init::Options {
             includes: init::includes::Options::follow(
                 path::interpolate::Context {
diff --git a/gix-config/src/lib.rs b/gix-config/src/lib.rs
@@ -44,9 +44,21 @@ pub mod lookup;
 pub mod parse;
 ///
 pub mod value;
+use std::ffi::OsString;
+
 pub use gix_config_value::{color, integer, path, Boolean, Color, Integer, Path};
 
 mod types;
 pub use types::{File, Source};
 ///
 pub mod source;
+
+/// Returns the contents of an eviorment variable with some specical handeling
+/// for certain enviorment variables (like $HOME) for platform compatability
+pub fn env_var(var: &str) -> Option<OsString> {
+    if var == "HOME" {
+        gix_path::home().map(|home| home.into_os_string())
+    } else {
+        std::env::var_os(var)
+    }
+}
diff --git a/gix-path/src/lib.rs b/gix-path/src/lib.rs
@@ -56,6 +56,9 @@
 pub struct Spec(bstr::BString);
 
 mod convert;
+use std::env::var_os;
+use std::path::PathBuf;
+
 pub use convert::*;
 
 mod util;
@@ -66,3 +69,32 @@ mod spec;
 ///
 pub mod realpath;
 pub use realpath::function::{realpath, realpath_opts};
+
+/// Returns a platform independent home directory
+/// On unix this simply returns $HOME on windows this uses %HOMEDRIVE%\%HOMEPATH% or %USERPROFILE%
+pub fn home() -> Option<PathBuf> {
+    if let Some(home) = var_os("HOME") {
+        return Some(home.into());
+    }
+
+    // TODO cache env access on windows? git does this by setting HOME but
+    // setting enviorment variables is a *really* bad idea in library
+
+    // FIXME: technically we should also check HOMESHARE in case HOME is a UNC path
+    // but git doesn't do this either so probably best to wait for an upstream fix
+    #[cfg(windows)]
+    if let Some(homedrive) = var_os("HOMEDRIVE") {
+        if let Some(home_path) = var_os("HOMEPATH") {
+            let home = PathBuf::from(homedrive).join(home_path);
+            if home.metadata().map_or(false, |home| home.is_dir()) {
+                return Some(home);
+            }
+        }
+    }
+    #[cfg(windows)]
+    if let Some(userprofile) = var_os("USERPROFILE") {
+        return Some(userprofile.into());
+    }
+
+    None
+}
diff --git a/gix/src/config/cache/access.rs b/gix/src/config/cache/access.rs
@@ -2,6 +2,7 @@
 use std::{borrow::Cow, path::PathBuf, time::Duration};
 
 use gix_lock::acquire::Fail;
+use gix_path::home;
 
 use crate::{
     bstr::BStr,
@@ -203,10 +204,9 @@ impl Cache {
         std::env::var_os("XDG_CONFIG_HOME")
             .map(|path| (PathBuf::from(path), &self.xdg_config_home_env))
             .or_else(|| {
-                std::env::var_os("HOME").map(|path| {
+                home().map(|mut p| {
                     (
                         {
-                            let mut p = PathBuf::from(path);
                             p.push(".config");
                             p
                         },
@@ -226,8 +226,6 @@ impl Cache {
     /// We never fail for here even if the permission is set to deny as we `gix-config` will fail later
     /// if it actually wants to use the home directory - we don't want to fail prematurely.
     pub(crate) fn home_dir(&self) -> Option<PathBuf> {
-        std::env::var_os("HOME")
-            .map(PathBuf::from)
-            .and_then(|path| self.home_env.check_opt(path))
+        home().and_then(|path| self.home_env.check_opt(path))
     }
 }
diff --git a/gix/src/config/cache/init.rs b/gix/src/config/cache/init.rs
@@ -95,7 +95,7 @@ impl Cache {
                             "HOME" => Some(home_env),
                             _ => None,
                         }
-                        .and_then(|perm| perm.check_opt(name).and_then(std::env::var_os))
+                        .and_then(|perm| perm.check_opt(name).and_then(gix_config::env_var))
                     })
                     .map(|p| (source, p.into_owned()))
             })
diff --git a/gix/src/open/repository.rs b/gix/src/open/repository.rs
@@ -2,6 +2,7 @@
 use std::{borrow::Cow, path::PathBuf};
 
 use gix_features::threading::OwnShared;
+use gix_path::home;
 
 use super::{Error, Options};
 use crate::{
@@ -180,9 +181,7 @@ impl ThreadSafeRepository {
         };
         let head = refs.find("HEAD").ok();
         let git_install_dir = crate::path::install_dir().ok();
-        let home = std::env::var_os("HOME")
-            .map(PathBuf::from)
-            .and_then(|home| env.home.check_opt(home));
+        let home = home().and_then(|home| env.home.check_opt(home));
 
         let mut filter_config_section = filter_config_section.unwrap_or(config::section::is_trusted);
         let config = config::Cache::from_stage_one(

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`use std::{borrow::Cow, path::PathBuf, time::Duration};`
`3`	`3`
`4`	`4`	`use gix_lock::acquire::Fail;`
	`5`	`+use gix_path::home;`
`5`	`6`
`6`	`7`	`use crate::{`
`7`	`8`	`bstr::BStr,`
`@@ -203,10 +204,9 @@ impl Cache {`
`203`	`204`	`std::env::var_os("XDG_CONFIG_HOME")`
`204`	`205`	`.map(\|path\| (PathBuf::from(path), &self.xdg_config_home_env))`
`205`	`206`	`.or_else(\|\| {`
`206`		`- std::env::var_os("HOME").map(\|path\| {`
	`207`	`+ home().map(\|mut p\| {`
`207`	`208`	`(`
`208`	`209`	`{`
`209`		`- let mut p = PathBuf::from(path);`
`210`	`210`	`p.push(".config");`
`211`	`211`	`p`
`212`	`212`	`},`
`@@ -226,8 +226,6 @@ impl Cache {`
`226`	`226`	/// We never fail for here even if the permission is set to deny as we `gix-config` will fail later
`227`	`227`	`/// if it actually wants to use the home directory - we don't want to fail prematurely.`
`228`	`228`	`pub(crate) fn home_dir(&self) -> Option<PathBuf> {`
`229`		`- std::env::var_os("HOME")`
`230`		`- .map(PathBuf::from)`
`231`		`- .and_then(\|path\| self.home_env.check_opt(path))`
	`229`	`+ home().and_then(\|path\| self.home_env.check_opt(path))`
`232`	`230`	`}`
`233`	`231`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ impl Cache {`
`95`	`95`	`"HOME" => Some(home_env),`
`96`	`96`	`_ => None,`
`97`	`97`	`}`
`98`		`- .and_then(\|perm\| perm.check_opt(name).and_then(std::env::var_os))`
	`98`	`+ .and_then(\|perm\| perm.check_opt(name).and_then(gix_config::env_var))`
`99`	`99`	`})`
`100`	`100`	`.map(\|p\| (source, p.into_owned()))`
`101`	`101`	`})`