118 lines · 4.8 KB · Rust
RawDownload
use std::{ffi::OsString, path::PathBuf}; use crate::Source; /// The category of a [`Source`], in order of ascending precedence.#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]pub enum Kind {    /// A special configuration file that ships with the git installation, and is thus tied to the used git binary.    GitInstallation,    /// A source shared for the entire system.    System,    /// Application specific configuration unique for each user of the `System`.    Global,    /// Configuration relevant only to the repository, possibly including the worktree.    Repository,    /// Configuration specified after all other configuration was loaded for the purpose of overrides.    Override,} impl Kind {    /// Return a list of sources associated with this `Kind` of source, in order of ascending precedence.    pub fn sources(self) -> &'static [Source] {        let src = match self {            Kind::GitInstallation => &[Source::GitInstallation] as &[_],            Kind::System => &[Source::System],            Kind::Global => &[Source::Git, Source::User],            Kind::Repository => &[Source::Local, Source::Worktree],            Kind::Override => &[Source::Env, Source::Cli, Source::Api],        };        debug_assert!(            src.iter().all(|src| src.kind() == self),            "BUG: classification of source has to match the ordering here, see `Source::kind()`"        );        src    }} impl Source {    /// Return true if the source indicates a location within a file of a repository.    pub const fn kind(self) -> Kind {        use Source::*;        match self {            GitInstallation => Kind::GitInstallation,            System => Kind::System,            Git | User => Kind::Global,            Local | Worktree => Kind::Repository,            Env | Cli | Api | EnvOverride => Kind::Override,        }    }     /// Returns the location at which a file of this type would be stored, or `None` if    /// there is no notion of persistent storage for this source, with `env_var` to obtain environment variables.    /// Note that the location can be relative for repository-local sources like `Local` and `Worktree`,    /// and the caller has to known which base it is relative to, namely the `common_dir` in the `Local` case    /// and the `git_dir` in the `Worktree` case.    /// Be aware that depending on environment overrides, multiple scopes might return the same path, which should    /// only be loaded once nonetheless.    ///    /// With `env_var` it becomes possible to prevent accessing environment variables entirely to comply with `gix-sec`    /// permissions for example.    pub fn storage_location(self, env_var: &mut dyn FnMut(&str) -> Option<OsString>) -> Option<PathBuf> {        use Source::*;        match self {            GitInstallation => {                if env_var("GIT_CONFIG_NOSYSTEM")                    .map(crate::Boolean::try_from)                    .transpose()                    .ok()                    .flatten()                    .is_some_and(|b| b.0)                {                    None                } else {                    gix_path::env::installation_config().map(Into::into)                }            }            System => {                if env_var("GIT_CONFIG_NOSYSTEM")                    .map(crate::Boolean::try_from)                    .transpose()                    .ok()                    .flatten()                    .is_some_and(|b| b.0)                {                    None                } else {                    env_var("GIT_CONFIG_SYSTEM")                        .map(Into::into)                        .or_else(|| gix_path::env::system_prefix().map(|p| p.join("etc/gitconfig")))                }            }            Git => match env_var("GIT_CONFIG_GLOBAL") {                Some(global_override) => Some(PathBuf::from(global_override)),                None => gix_path::env::xdg_config("config", env_var),            },            User => env_var("GIT_CONFIG_GLOBAL").map(PathBuf::from).or_else(|| {                env_var("HOME")                    .map(PathBuf::from)                    .or_else(|| {                        if cfg!(windows) {                            // On Windows, HOME is rarely set, and we generally need something more.                            std::env::home_dir()                        } else {                            // Git also only tries the env var on unix, and so do we                            None                        }                    })                    .map(|mut p| {                        p.push(".gitconfig");                        p                    })            }),            Local => Some("config".into()),            Worktree => Some("config.worktree".into()),            Env | Cli | Api | EnvOverride => None,        }    }}