ghostty-rs/crates/ghostty-os/src/homedir.rs

use std::ffi::{OsStr, OsString};
#[cfg(unix)]
use std::process::{Command, Stdio};

use crate::osbytes;
#[cfg(unix)]
use crate::passwd;

#[derive(Debug, thiserror::Error, PartialEq, Eq)]
pub enum Error {
    /// The buffer used for output is not large enough to store the value.
    #[error("buffer too small")]
    BufferTooSmall,
}

#[derive(Debug, thiserror::Error, PartialEq, Eq)]
pub enum ExpandError {
    #[error("home detection failed")]
    HomeDetectionFailed,
    #[error("buffer too small")]
    BufferTooSmall,
}

/// Equivalent of `std.fs.max_path_bytes` on Linux.
const MAX_PATH_BYTES: usize = 4096;

/// Determine the home directory for the currently executing user. This
/// is generally an expensive process so the value should be cached.
///
/// Non-UTF-8 bytes are preserved through [`crate::osbytes`]; use
/// [`home_os`] for the raw OS string.
pub fn home() -> Result<Option<osbytes::EncodedOs>, Error> {
    home_with_capacity(MAX_PATH_BYTES)
}

/// Byte-preserving [`home`].
pub fn home_os() -> Result<Option<OsString>, Error> {
    home_os_with_capacity(MAX_PATH_BYTES)
}

/// Like [`home`] but emulates the fixed output buffer of the Zig version:
/// errors with `BufferTooSmall` if the result is longer than `cap` bytes.
pub fn home_with_capacity(cap: usize) -> Result<Option<osbytes::EncodedOs>, Error> {
    Ok(home_os_with_capacity(cap)?.map(|h| osbytes::EncodedOs::from_os(&h)))
}

/// Byte-preserving [`home_with_capacity`].
#[cfg(unix)]
pub fn home_os_with_capacity(cap: usize) -> Result<Option<OsString>, Error> {
    let check = |s: OsString| {
        if cap < osbytes::os_bytes(&s).len() {
            Err(Error::BufferTooSmall)
        } else {
            Ok(Some(s))
        }
    };

    // First: if we have a HOME env var, then we use that.
    if let Some(result) = std::env::var_os("HOME") {
        return check(result);
    }

    // On macOS: [NSFileManager defaultManager].homeDirectoryForCurrentUser.path
    #[cfg(target_os = "macos")]
    {
        use objc2_foundation::NSFileManager;

        let manager = NSFileManager::defaultManager();
        let home_url = manager.homeDirectoryForCurrentUser();
        if let Some(path) = home_url.path() {
            return check(OsString::from(path.to_string()));
        }
    }

    // We try passwd. This doesn't work on multi-user mac but we try it anyways.
    if let Ok(pw) = passwd::get_os()
        && let Some(result) = pw.home
    {
        return check(result);
    }

    // If all else fails, have the shell tell us...
    let run = Command::new("/bin/sh")
        .args(["-c", "cd && pwd"])
        .stdin(Stdio::null())
        .stderr(Stdio::null())
        .output();
    if let Ok(run) = run
        && run.status.success()
    {
        return check(osbytes::os_from_bytes(trim_space(&run.stdout).to_vec()));
    }

    Ok(None)
}

/// Windows: `%HOMEDRIVE%%HOMEPATH%` (`homeWindows`). Returns `None` if
/// either variable is missing.
#[cfg(windows)]
pub fn home_os_with_capacity(cap: usize) -> Result<Option<OsString>, Error> {
    let drive = std::env::var_os("HOMEDRIVE");
    let path = std::env::var_os("HOMEPATH");
    home_windows(drive.as_deref(), path.as_deref(), cap)
}

/// Pure part of [`home_with_capacity`] on Windows.
#[cfg(any(windows, test))]
fn home_windows(
    drive: Option<&OsStr>,
    path: Option<&OsStr>,
    cap: usize,
) -> Result<Option<OsString>, Error> {
    let (Some(drive), Some(path)) = (drive, path) else {
        return Ok(None);
    };
    // Lossless (WTF-16 safe) concatenation; the size is measured in WTF-8
    // bytes like the Zig buffer.
    if cap < osbytes::os_bytes(drive).len() + osbytes::os_bytes(path).len() {
        return Err(Error::BufferTooSmall);
    }
    let mut home = drive.to_owned();
    home.push(path);
    Ok(Some(home))
}

#[cfg(unix)]
fn trim_space(input: &[u8]) -> &[u8] {
    let is_ws = |b: &u8| matches!(b, b' ' | b'\n' | b'\t');
    let start = input.iter().position(|b| !is_ws(b)).unwrap_or(input.len());
    let end = input
        .iter()
        .rposition(|b| !is_ws(b))
        .map_or(start, |i| i + 1);
    &input[start..end]
}

/// Expands a path that starts with a tilde (~) to the home directory of
/// the current user.
///
/// Errors if `home` fails or if the size of the expanded path is larger
/// than the maximum path length.
pub fn expand_home(path: &osbytes::EncodedOs) -> Result<osbytes::EncodedOs, ExpandError> {
    expand_home_with_capacity(path, MAX_PATH_BYTES)
}

/// Byte-preserving [`expand_home`].
pub fn expand_home_os(path: &OsStr) -> Result<OsString, ExpandError> {
    expand_home_os_with_capacity(path, MAX_PATH_BYTES)
}

/// Like [`expand_home`] with an explicit output capacity (emulating the
/// caller-provided buffer of the Zig version).
pub fn expand_home_with_capacity(
    path: &osbytes::EncodedOs,
    cap: usize,
) -> Result<osbytes::EncodedOs, ExpandError> {
    #[cfg(windows)]
    {
        // Zig returns the original byte slice on Windows without converting it.
        let _ = cap;
        Ok(path.clone())
    }
    #[cfg(not(windows))]
    expand_home_os_with_capacity(&path.to_os(), cap).map(osbytes::EncodedOs::from)
}

/// Windows: `~/` is not an idiom generally used on Windows.
#[cfg(windows)]
pub fn expand_home_os_with_capacity(path: &OsStr, _cap: usize) -> Result<OsString, ExpandError> {
    Ok(path.to_owned())
}

/// See the Windows variant above.
#[cfg(unix)]
pub fn expand_home_os_with_capacity(path: &OsStr, cap: usize) -> Result<OsString, ExpandError> {
    let bytes = osbytes::os_bytes(path);
    if !bytes.starts_with(b"~/") {
        return Ok(path.to_owned());
    }
    let Ok(Some(home_dir)) = home_os_with_capacity(cap) else {
        return Err(ExpandError::HomeDetectionFailed);
    };
    let mut out = osbytes::os_bytes(&home_dir);
    let rest = &bytes[1..]; // Skip the ~
    if out.len() + rest.len() > cap {
        return Err(ExpandError::BufferTooSmall);
    }
    out.extend_from_slice(rest);
    Ok(osbytes::os_from_bytes(out))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[cfg(windows)]
    #[test]
    fn windows_home_expansion_keeps_malformed_path_bytes() {
        let path = osbytes::EncodedOs::from_bytes(b"~/bad\xff");
        assert_eq!(expand_home(&path).unwrap(), path);
        assert_eq!(path.to_path().unwrap_err().to_string(), "BadPathName");
    }

    #[test]
    fn home_windows_joins_drive_and_path() {
        assert_eq!(
            home_windows(
                Some(OsStr::new("C:")),
                Some(OsStr::new("\\Users\\me")),
                4096
            ),
            Ok(Some(OsString::from("C:\\Users\\me")))
        );
        assert_eq!(home_windows(None, Some(OsStr::new("\\x")), 4096), Ok(None));
        assert_eq!(home_windows(Some(OsStr::new("C:")), None, 4096), Ok(None));
        assert_eq!(
            home_windows(Some(OsStr::new("C:")), Some(OsStr::new("\\Users")), 3),
            Err(Error::BufferTooSmall)
        );
    }
}

#[cfg(all(test, unix))]
mod tests_unix {
    use super::*;
    use crate::testutil::with_env_lock;

    #[test]
    fn expand_home_unix() {
        with_env_lock(|| {
            let cap = MAX_PATH_BYTES;
            let ex =
                |s: &str| expand_home_with_capacity(&osbytes::EncodedOs::from_plain_text(s), cap);
            let home_dir = ex("~/").unwrap();
            // Joining the home directory `~` with the path `/`
            // the result should end with a separator here. (e.g. `/home/user/`)
            assert!(home_dir.ends_with_plain("/"));

            let downloads = ex("~/Downloads/shader.glsl").unwrap();
            let expected_downloads = format!("{}Downloads/shader.glsl", home_dir.as_encoded());
            assert_eq!(downloads, expected_downloads.as_str());

            assert_eq!(ex("~").unwrap(), "~");
            assert_eq!(ex("~abc/").unwrap(), "~abc/");
            assert_eq!(ex("/home/user").unwrap(), "/home/user");
            assert_eq!(ex("").unwrap(), "");

            // Expect an error if the buffer is large enough to hold the home directory,
            // but not the expanded path
            assert_eq!(
                Err(ExpandError::BufferTooSmall),
                expand_home_with_capacity(
                    &osbytes::EncodedOs::from_plain_text("~/Downloads"),
                    home_dir.as_encoded().len()
                )
            );
        });
    }

    #[test]
    fn home_is_detected() {
        with_env_lock(|| {
            let result = home().unwrap();
            assert!(result.is_some());
            assert!(!result.unwrap().is_empty());
        });
    }

    #[test]
    fn home_preserves_non_utf8_env() {
        use std::os::unix::ffi::{OsStrExt, OsStringExt};
        let h = OsString::from_vec(b"/home/\xffu".to_vec());
        temp_env::with_var("HOME", Some(&h), || {
            assert_eq!(home_os().unwrap().unwrap(), h);
            let e = expand_home_os(OsStr::from_bytes(b"~/x\xfe")).unwrap();
            assert_eq!(e.as_bytes(), b"/home/\xffu/x\xfe");
            // The String API round-trips through the escape encoding.
            let s = expand_home(&osbytes::EncodedOs::from_plain_text("~/y")).unwrap();
            assert_eq!(s.to_bytes(), b"/home/\xffu/y");
        });
    }

    #[test]
    fn home_prefers_env() {
        temp_env::with_var("HOME", Some("/some/home"), || {
            assert_eq!(home().unwrap().unwrap(), "/some/home");
            assert_eq!(
                expand_home(&osbytes::EncodedOs::from_plain_text("~/x")).unwrap(),
                "/some/home/x"
            );
            assert_eq!(home_with_capacity(3), Err(Error::BufferTooSmall));
        });
    }
}