config.rs 84.3%

210 of 249 lines run, 41 of 70 functions · run #426 on main · run missed

//! Layered configuration: defaults, the user file, the repository file.

use super::*;

/// Effective settings: defaults, then the user file (`~/.config/oxy/config.toml`,
/// spec §19), then the repository file (`.oxy/config`). Both files are
/// `key = "value"` lines. `save` writes only the repository layer.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Config {
    /// Keys set in the repository file (or via `set`), written by `save`.
    repo_layer: BTreeMap<String, String>,
    pub author_name: String,
    pub author_email: String,
    /// The KeyId of the author's identity, once `create_identity` has run.
    pub author_key: Option<KeyId>,
    /// `author.signer` (or `$OXY_SIGNER`): the key that signs and seals in
    /// place of `author.key`, whose identity lists it as a delegate. An
    /// agent sets it to its own key, so its changes carry the human as
    /// author and the agent's signature (spec §14.2, agent workflows §2).
    pub signer_key: Option<KeyId>,
    /// `author.signer = "keyless"`: sign with fresh keys the hub certifies
    /// under the agent's grant, keeping no key on disk (spec §14.7,
    /// oxygenhub#241).
    pub signer_keyless: bool,
    /// `keyless.hub`: the hub that certifies them (default: the default
    /// remote's hub).
    pub keyless_hub: Option<String>,
    /// `author.for` (oxygen#82): in a keyless agent's home, the account it
    /// acts for; the home then authors as that person's newest identity,
    /// which the hub names with each certificate, rather than a pinned
    /// `author.key` that goes stale with every rotation.
    pub author_for: Option<String>,
    /// `core.sign`: sign every change at commit (`true`) or leave signing to
    /// push-time seals (`false`, the spec default).
    pub sign_changes: bool,
    pub bookmark: String,
    /// `remote.<name>.url`.
    pub remotes: BTreeMap<String, String>,
    /// `remote.<name>.token`: bearer token for HTTP pushes.
    pub remote_tokens: BTreeMap<String, String>,
    /// `remote.<name>.ca`: PEM file of extra roots to trust for that remote.
    pub remote_cas: BTreeMap<String, String>,
    /// `core.remote`: the remote `pull`, `fetch` and `push` use when none is
    /// named, for a repository whose remotes include no `origin`.
    pub default_remote: Option<String>,
    /// `git.claim`: a Git import authors the commits whose Git author email
    /// is this repository's identity's with its key (oxygen#97).
    pub git_claim: bool,
    /// `git.colocate`: keep a `.git` beside `.oxy` with the current
    /// bookmark exported after every operation, so editors' Git features
    /// work on an Oxygen checkout (one way: oxy to Git).
    pub git_colocate: bool,
    /// `core.op-retention`: days for which operations keep their states reachable (spec §12.1, §21).
    pub op_retention_days: u64,
    /// `core.gc-grace`: days an unreachable object survives, protecting concurrent writers (spec §21).
    pub gc_grace_days: u64,
    /// `core.snapshot-retention`: days for which past operations keep their
    /// working copies reachable (oxygen#98); each workspace's current one is
    /// always kept. A file only ever in a working copy goes with it.
    pub snapshot_retention_days: u64,
    /// `snapshot.max-new-file-size`: a new, untracked file larger than this
    /// is left out of working-copy snapshots and named instead (oxygen#98);
    /// 0 takes in files of any size.
    pub max_new_file: u64,
    /// `core.checkpoint-interval`: changes between automatic checkpoints (spec §11).
    pub checkpoint_interval: u64,
    /// `push.batch-bytes`: about how many bytes of changes and their texts
    /// one request of a long push carries (spec §16.3).
    pub push_batch_bytes: u64,
    /// `filter.max-blob`: blobs larger than this many bytes are fetched lazily (spec §17).
    pub max_blob: Option<u64>,
    /// `filter.paths`: only these subtrees are materialized (spec §17); empty means everything.
    pub sparse_paths: Vec<String>,
    /// `hooks.semantic-deps`: run the semantic-deps hook at commit (spec §20).
    pub semantic_deps: bool,
    /// `revset.<name>`: a saved revset, used as `name()`.
    pub revsets: BTreeMap<String, String>,
    /// `storage.url`: the store the repository's objects and operation
    /// head are kept on (`dir://`, `s3://`, …) instead of `.oxy/objects`
    /// (oxygen#68).
    pub storage_url: Option<String>,
    /// `storage.cache`: the most the local cache in front of that store
    /// holds, in bytes.
    pub storage_cache: u64,
}

impl Config {
    /// Whether the repository's own file sets `key` (as against the user
    /// config or a default).
    pub fn is_repo_set(&self, key: &str) -> bool {
        self.repo_layer.contains_key(key)
    }

    pub(super) fn default_for_user() -> Config {
        let user = std::env::var("USER").unwrap_or_else(|_| "unknown".into());
        Config {
            repo_layer: BTreeMap::new(),
            author_name: std::env::var("OXY_AUTHOR_NAME").unwrap_or_else(|_| user.clone()),
            author_email: std::env::var("OXY_AUTHOR_EMAIL")
                .unwrap_or_else(|_| format!("{user}@localhost")),
            author_key: None,
            signer_key: std::env::var("OXY_SIGNER")
                .ok()
                .and_then(|v| KeyId::from_hex(&v)),
            signer_keyless: std::env::var("OXY_SIGNER").is_ok_and(|v| v == "keyless"),
            keyless_hub: None,
            author_for: None,
            sign_changes: false,
            bookmark: "main".into(),
            remotes: BTreeMap::new(),
            remote_tokens: BTreeMap::new(),
            remote_cas: BTreeMap::new(),
            default_remote: None,
            git_claim: false,
            git_colocate: false,
            op_retention_days: 90,
            gc_grace_days: 14,
            max_new_file: 100 << 20,
            snapshot_retention_days: 7,
            checkpoint_interval: 256,
            // Well under the 100 MB a proxy in front of a hub may take
            // (oxygen#133).
            push_batch_bytes: 64 << 20,
            max_blob: None,
            sparse_paths: Vec::new(),
            semantic_deps: false,
            revsets: BTreeMap::new(),
            storage_url: None,
            storage_cache: DEFAULT_STORAGE_CACHE,
        }
    }

    /// Set a key in the repository layer, as `oxy config` does.
    pub fn set(&mut self, key: &str, value: &str) -> Result<()> {
        self.apply(key, value)?;
        if value.is_empty() {
            self.repo_layer.remove(key);
        } else {
            self.repo_layer.insert(key.to_string(), value.to_string());
        }
        Ok(())
    }

    /// Set a key in the user file without touching any repository.
    pub fn set_user(user_path: &Path, key: &str, value: &str) -> Result<()> {
        Config::default_for_user().apply(key, value)?;
        let mut entries = read_config_file(user_path)?;
        if value.is_empty() {
            entries.remove(key);
        } else {
            entries.insert(key.to_string(), value.to_string());
        }
        if let Some(parent) = user_path.parent() {
            fs::create_dir_all(parent)?;
        }
        write_config_file(user_path, &entries)
    }

    /// Apply a key to the effective values.
    pub(super) fn apply(&mut self, key: &str, value: &str) -> Result<()> {
        match key {
            "author.name" => self.author_name = value.into(),
            "author.email" => self.author_email = value.into(),
            "author.key" => {
                self.author_key = if value.is_empty() {
                    None
                } else {
                    Some(KeyId::from_hex(value).ok_or_else(|| {
                        RepoError::Msg("author.key must be a 64-character hex KeyId".into())
                    })?)
                }
            }
            "author.signer" => {
                self.signer_keyless = value == "keyless";
                self.signer_key = if value.is_empty() || self.signer_keyless {
                    None
                } else {
                    Some(KeyId::from_hex(value).ok_or_else(|| {
                        RepoError::Msg(
                            "author.signer must be a 64-character hex KeyId, or \"keyless\"".into(),
                        )
                    })?)
                }
            }
            "core.sign" => {
                self.sign_changes = match value {
                    "change" => true,
                    // Empty: unset, the default.
                    "seal" | "" => false,
                    _ => return fail("core.sign must be \"change\" or \"seal\""),
                }
            }
            "workspace.bookmark" => self.bookmark = value.into(),
            "keyless.hub" => self.keyless_hub = (!value.is_empty()).then(|| value.to_string()),
            "author.for" => self.author_for = (!value.is_empty()).then(|| value.to_string()),
            // Read by the credential store from the user file.
            "auth.helper" => {}
            "core.op-retention" => self.op_retention_days = parse_days(value)?,
            "core.gc-grace" => self.gc_grace_days = parse_days(value)?,
            "snapshot.max-new-file-size" => self.max_new_file = parse_size(value)?,
            "core.snapshot-retention" => self.snapshot_retention_days = parse_days(value)?,
            "filter.max-blob" => {
                self.max_blob = if value.is_empty() {
                    None
                } else {
                    Some(parse_size(value)?)
                }
            }
            "storage.url" => {
                self.storage_url = (!value.is_empty()).then(|| value.to_string());
            }
            "storage.cache" => {
                self.storage_cache = if value.is_empty() {
                    DEFAULT_STORAGE_CACHE
                } else {
                    parse_size(value)?
                }
            }
            "core.remote" => {
                self.default_remote = (!value.is_empty()).then(|| value.to_string());
            }
            "hooks.semantic-deps" => self.semantic_deps = matches!(value, "true" | "1" | "yes"),
            "git.claim" => self.git_claim = matches!(value, "true" | "1" | "yes"),
            "git.colocate" => self.git_colocate = matches!(value, "true" | "1" | "yes"),
            "filter.paths" => {
                self.sparse_paths = value
                    .split(',')
                    .map(|p| {
                        p.trim()
                            .trim_start_matches("./")
                            .trim_matches('/')
                            .to_string()
                    })
                    .filter(|p| !p.is_empty())
                    .collect();
            }
            "core.checkpoint-interval" => {
                self.checkpoint_interval = value
                    .parse()
                    .map_err(|_| RepoError::Msg(format!("expected a number, got {value:?}")))?;
            }
            "push.batch-bytes" => {
                self.push_batch_bytes = value.parse().ok().filter(|n| *n > 0).ok_or_else(|| {
                    RepoError::Msg(format!("expected a number of bytes, got {value:?}"))
                })?;
            }
            k if k.starts_with("remote.") => {
                let rest = &k["remote.".len()..];
                let Some((name, field)) = rest.rsplit_once('.') else {
                    return fail(format!("unknown configuration key {key:?}"));
                };
                if name.is_empty() || name.contains('/') {
                    return fail(format!("invalid remote name in {key:?}"));
                }
                let map = match field {
                    "url" => &mut self.remotes,
                    "token" => &mut self.remote_tokens,
                    "ca" => &mut self.remote_cas,
                    _ => return fail(format!("unknown configuration key {key:?}")),
                };
                if value.is_empty() {
                    map.remove(name);
                    if field == "url" {
                        self.remote_tokens.remove(name);
                        self.remote_cas.remove(name);
                    }
                } else {
                    map.insert(name.to_string(), value.into());
                }
            }
            k if k.starts_with("revset.") => {
                let name = &k["revset.".len()..];
                if name.is_empty()
                    || !name
                        .chars()
                        .all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
                {
                    return fail(format!(
                        "a revset's name is letters, digits, _ and -: {key:?}"
                    ));
                }
                if value.is_empty() {
                    self.revsets.remove(name);
                } else {
                    crate::revset::parse(value)
                        .map_err(|e| RepoError::Msg(format!("{key} = {value:?}: {e}")))?;
                    self.revsets.insert(name.to_string(), value.into());
                }
            }
            _ => return fail(format!("unknown configuration key {key:?}")),
        }
        Ok(())
    }

    /// Defaults, then the user file if it exists, then the repository file.
    pub(super) fn load(user_path: Option<&Path>, repo_path: &Path) -> Result<Config> {
        let mut c = Config::default_for_user();
        if let Some(u) = user_path {
            for (k, v) in read_config_file(u)? {
                let _ = c.apply(&k, &v);
            }
        }
        for (k, v) in read_config_file(repo_path)? {
            if c.apply(&k, &v).is_ok() {
                c.repo_layer.insert(k, v);
            }
        }
        // author.for (oxygen#82): the identity the hub last named as the
        // person's newest, kept in the home; a repository's own
        // author.key pin still wins.
        if c.author_for.is_some() && !c.repo_layer.contains_key("author.key") {
            if let Some(k) = user_path
                .and_then(Path::parent)
                .and_then(|home| fs::read_to_string(home.join("keys").join(AUTHOR_FOR_FILE)).ok())
                .and_then(|s| KeyId::from_hex(s.trim()))
            {
                c.author_key = Some(k);
            }
        }
        Ok(c)
    }

    pub(super) fn save(&self, path: &Path) -> Result<()> {
        write_config_file(path, &self.repo_layer)
    }

    /// Keys explicitly set for this repository.
    pub fn repo_layer(&self) -> &BTreeMap<String, String> {
        &self.repo_layer
    }
}

/// In a home's `keys/`: the key of the identity `author.for` follows,
/// as the hub last named it (oxygen#82).
pub const AUTHOR_FOR_FILE: &str = "author.for";

/// A byte count with an optional `K`, `M`, or `G` suffix (binary units).
/// `storage.cache` when unset: 2 GiB.
pub const DEFAULT_STORAGE_CACHE: u64 = 2 << 30;

pub fn parse_size(v: &str) -> Result<u64> {
    let v = v.trim();
    let (num, mult) = match v.chars().last() {
        Some('K' | 'k') => (&v[..v.len() - 1], 1u64 << 10),
        Some('M' | 'm') => (&v[..v.len() - 1], 1u64 << 20),
        Some('G' | 'g') => (&v[..v.len() - 1], 1u64 << 30),
        _ => (v, 1),
    };
    let n: u64 = num
        .trim()
        .parse()
        .map_err(|_| RepoError::Msg(format!("expected a size like 1M, got {v:?}")))?;
    Ok(n * mult)
}

/// A count of days, optionally suffixed `d`.
fn parse_days(v: &str) -> Result<u64> {
    v.trim_end_matches('d')
        .parse()
        .map_err(|_| RepoError::Msg(format!("expected a number of days, got {v:?}")))
}

/// Read `key = "value"` lines; a missing file is empty.
pub fn read_config_file(path: &Path) -> Result<BTreeMap<String, String>> {
    let text = match fs::read_to_string(path) {
        Ok(t) => t,
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(BTreeMap::new()),
        Err(e) => return Err(e.into()),
    };
    let mut out = BTreeMap::new();
    for line in text.lines() {
        let line = line.trim();
        if line.is_empty() || line.starts_with('#') {
            continue;
        }
        let Some((k, v)) = line.split_once('=') else {
            continue;
        };
        out.insert(k.trim().to_string(), v.trim().trim_matches('"').to_string());
    }
    Ok(out)
}

fn write_config_file(path: &Path, entries: &BTreeMap<String, String>) -> Result<()> {
    let text: String = entries
        .iter()
        .map(|(k, v)| format!("{k} = \"{v}\"\n"))
        .collect();
    write_atomic(path, text.as_bytes())
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

1		//! Layered configuration: defaults, the user file, the repository file.
2
3		use super::*;
4
5		/// Effective settings: defaults, then the user file (`~/.config/oxy/config.toml`,
6		/// spec §19), then the repository file (`.oxy/config`). Both files are
7		/// `key = "value"` lines. `save` writes only the repository layer.
8		#[derive(Clone, Debug, PartialEq, Eq)]
9		pub struct Config {
10		/// Keys set in the repository file (or via `set`), written by `save`.
11		repo_layer: BTreeMap<String, String>,
12		pub author_name: String,
13		pub author_email: String,
14		/// The KeyId of the author's identity, once `create_identity` has run.
15		pub author_key: Option<KeyId>,
16		/// `author.signer` (or `$OXY_SIGNER`): the key that signs and seals in
17		/// place of `author.key`, whose identity lists it as a delegate. An
18		/// agent sets it to its own key, so its changes carry the human as
19		/// author and the agent's signature (spec §14.2, agent workflows §2).
20		pub signer_key: Option<KeyId>,
21		/// `author.signer = "keyless"`: sign with fresh keys the hub certifies
22		/// under the agent's grant, keeping no key on disk (spec §14.7,
23		/// oxygenhub#241).
24		pub signer_keyless: bool,
25		/// `keyless.hub`: the hub that certifies them (default: the default
26		/// remote's hub).
27		pub keyless_hub: Option<String>,
28		/// `author.for` (oxygen#82): in a keyless agent's home, the account it
29		/// acts for; the home then authors as that person's newest identity,
30		/// which the hub names with each certificate, rather than a pinned
31		/// `author.key` that goes stale with every rotation.
32		pub author_for: Option<String>,
33		/// `core.sign`: sign every change at commit (`true`) or leave signing to
34		/// push-time seals (`false`, the spec default).
35		pub sign_changes: bool,
36		pub bookmark: String,
37		/// `remote.<name>.url`.
38		pub remotes: BTreeMap<String, String>,
39		/// `remote.<name>.token`: bearer token for HTTP pushes.
40		pub remote_tokens: BTreeMap<String, String>,
41		/// `remote.<name>.ca`: PEM file of extra roots to trust for that remote.
42		pub remote_cas: BTreeMap<String, String>,
43		/// `core.remote`: the remote `pull`, `fetch` and `push` use when none is
44		/// named, for a repository whose remotes include no `origin`.
45		pub default_remote: Option<String>,
46		/// `git.claim`: a Git import authors the commits whose Git author email
47		/// is this repository's identity's with its key (oxygen#97).
48		pub git_claim: bool,
49		/// `git.colocate`: keep a `.git` beside `.oxy` with the current
50		/// bookmark exported after every operation, so editors' Git features
51		/// work on an Oxygen checkout (one way: oxy to Git).
52		pub git_colocate: bool,
53		/// `core.op-retention`: days for which operations keep their states reachable (spec §12.1, §21).
54		pub op_retention_days: u64,
55		/// `core.gc-grace`: days an unreachable object survives, protecting concurrent writers (spec §21).
56		pub gc_grace_days: u64,
57		/// `core.snapshot-retention`: days for which past operations keep their
58		/// working copies reachable (oxygen#98); each workspace's current one is
59		/// always kept. A file only ever in a working copy goes with it.
60		pub snapshot_retention_days: u64,
61		/// `snapshot.max-new-file-size`: a new, untracked file larger than this
62		/// is left out of working-copy snapshots and named instead (oxygen#98);
63		/// 0 takes in files of any size.
64		pub max_new_file: u64,
65		/// `core.checkpoint-interval`: changes between automatic checkpoints (spec §11).
66		pub checkpoint_interval: u64,
67		/// `push.batch-bytes`: about how many bytes of changes and their texts
68		/// one request of a long push carries (spec §16.3).
69		pub push_batch_bytes: u64,
70		/// `filter.max-blob`: blobs larger than this many bytes are fetched lazily (spec §17).
71		pub max_blob: Option<u64>,
72		/// `filter.paths`: only these subtrees are materialized (spec §17); empty means everything.
73		pub sparse_paths: Vec<String>,
74		/// `hooks.semantic-deps`: run the semantic-deps hook at commit (spec §20).
75		pub semantic_deps: bool,
76		/// `revset.<name>`: a saved revset, used as `name()`.
77		pub revsets: BTreeMap<String, String>,
78		/// `storage.url`: the store the repository's objects and operation
79		/// head are kept on (`dir://`, `s3://`, …) instead of `.oxy/objects`
80		/// (oxygen#68).
81		pub storage_url: Option<String>,
82		/// `storage.cache`: the most the local cache in front of that store
83		/// holds, in bytes.
84		pub storage_cache: u64,
85		}
86
87		impl Config {
88		/// Whether the repository's own file sets `key` (as against the user
89		/// config or a default).
90	4×	pub fn is_repo_set(&self, key: &str) -> bool {
91	4×	self.repo_layer.contains_key(key)
92	4×	}
93
94	3590×	pub(super) fn default_for_user() -> Config {
95	3590×	let user = std::env::var("USER").unwrap_or_else(\|_\| "unknown".into());
96		Config {
97	3590×	repo_layer: BTreeMap::new(),
98	3590×	author_name: std::env::var("OXY_AUTHOR_NAME").unwrap_or_else(\|_\| user.clone()),
99	3590×	author_email: std::env::var("OXY_AUTHOR_EMAIL")
100	3590×	.unwrap_or_else(\|_\| format!("{user}@localhost")),
101	3590×	author_key: None,
102	3590×	signer_key: std::env::var("OXY_SIGNER")
103	3590×	.ok()
104	3590×	.and_then(\|v\| KeyId::from_hex(&v)),
105	3590×	signer_keyless: std::env::var("OXY_SIGNER").is_ok_and(\|v\| v == "keyless"),
106	3590×	keyless_hub: None,
107	3590×	author_for: None,
108		sign_changes: false,
109	3590×	bookmark: "main".into(),
110	3590×	remotes: BTreeMap::new(),
111	3590×	remote_tokens: BTreeMap::new(),
112	3590×	remote_cas: BTreeMap::new(),
113	3590×	default_remote: None,
114		git_claim: false,
115		git_colocate: false,
116		op_retention_days: 90,
117		gc_grace_days: 14,
118	3590×	max_new_file: 100 << 20,
119		snapshot_retention_days: 7,
120		checkpoint_interval: 256,
121		// Well under the 100 MB a proxy in front of a hub may take
122		// (oxygen#133).
123	3590×	push_batch_bytes: 64 << 20,
124	3590×	max_blob: None,
125	3590×	sparse_paths: Vec::new(),
126		semantic_deps: false,
127	3590×	revsets: BTreeMap::new(),
128	3590×	storage_url: None,
129		storage_cache: DEFAULT_STORAGE_CACHE,
130		}
131	3590×	}
132
133		/// Set a key in the repository layer, as `oxy config` does.
134	546×	pub fn set(&mut self, key: &str, value: &str) -> Result<()> {
135	546×	self.apply(key, value)?;
136	546×	if value.is_empty() {
137	4×	self.repo_layer.remove(key);
138	542×	} else {
139	542×	self.repo_layer.insert(key.to_string(), value.to_string());
140	542×	}
141	546×	Ok(())
142	546×	}
143
144		/// Set a key in the user file without touching any repository.
145	225×	pub fn set_user(user_path: &Path, key: &str, value: &str) -> Result<()> {
146	225×	Config::default_for_user().apply(key, value)?;
147	224×	let mut entries = read_config_file(user_path)?;
148	224×	if value.is_empty() {
149	0×	entries.remove(key);
150	224×	} else {
151	224×	entries.insert(key.to_string(), value.to_string());
152	224×	}
153	224×	if let Some(parent) = user_path.parent() {
154	224×	fs::create_dir_all(parent)?;
155	0×	}
156	224×	write_config_file(user_path, &entries)
157	225×	}
158
159		/// Apply a key to the effective values.
160	2625×	pub(super) fn apply(&mut self, key: &str, value: &str) -> Result<()> {
161	3×	match key {
162	2625×	"author.name" => self.author_name = value.into(),
163	2135×	"author.email" => self.author_email = value.into(),
164	1645×	"author.key" => {
165	509×	self.author_key = if value.is_empty() {
166	0×	None
167		} else {
168	509×	Some(KeyId::from_hex(value).ok_or_else(\|\| {
169	0×	RepoError::Msg("author.key must be a 64-character hex KeyId".into())
170	0×	})?)
171		}
172		}
173	1136×	"author.signer" => {
174	23×	self.signer_keyless = value == "keyless";
175	23×	self.signer_key = if value.is_empty() \|\| self.signer_keyless {
176	2×	None
177		} else {
178	21×	Some(KeyId::from_hex(value).ok_or_else(\|\| {
179	0×	RepoError::Msg(
180	0×	"author.signer must be a 64-character hex KeyId, or \"keyless\"".into(),
181	0×	)
182	0×	})?)
183		}
184		}
185	1113×	"core.sign" => {
186	153×	self.sign_changes = match value {
187	153×	"change" => true,
188		// Empty: unset, the default.
189	7×	"seal" \| "" => false,
190	0×	_ => return fail("core.sign must be \"change\" or \"seal\""),
191		}
192		}
193	960×	"workspace.bookmark" => self.bookmark = value.into(),
194	956×	"keyless.hub" => self.keyless_hub = (!value.is_empty()).then(\|\| value.to_string()),
195	956×	"author.for" => self.author_for = (!value.is_empty()).then(\|\| value.to_string()),
196		// Read by the credential store from the user file.
197	954×	"auth.helper" => {}
198	954×	"core.op-retention" => self.op_retention_days = parse_days(value)?,
199	942×	"core.gc-grace" => self.gc_grace_days = parse_days(value)?,
200	942×	"snapshot.max-new-file-size" => self.max_new_file = parse_size(value)?,
201	942×	"core.snapshot-retention" => self.snapshot_retention_days = parse_days(value)?,
202	942×	"filter.max-blob" => {
203	6×	self.max_blob = if value.is_empty() {
204	0×	None
205		} else {
206	6×	Some(parse_size(value)?)
207		}
208		}
209	936×	"storage.url" => {
210	5×	self.storage_url = (!value.is_empty()).then(\|\| value.to_string());
211		}
212	931×	"storage.cache" => {
213	0×	self.storage_cache = if value.is_empty() {
214	0×	DEFAULT_STORAGE_CACHE
215		} else {
216	0×	parse_size(value)?
217		}
218		}
219	931×	"core.remote" => {
220	1×	self.default_remote = (!value.is_empty()).then(\|\| value.to_string());
221		}
222	930×	"hooks.semantic-deps" => self.semantic_deps = matches!(value, "true" \| "1" \| "yes"),
223	929×	"git.claim" => self.git_claim = matches!(value, "true" \| "1" \| "yes"),
224	927×	"git.colocate" => self.git_colocate = matches!(value, "true" \| "1" \| "yes"),
225	916×	"filter.paths" => {
226	3×	self.sparse_paths = value
227	3×	.split(',')
228	4×	.map(\|p\| {
229	4×	p.trim()
230	4×	.trim_start_matches("./")
231	4×	.trim_matches('/')
232	4×	.to_string()
233	4×	})
234	4×	.filter(\|p\| !p.is_empty())
235	3×	.collect();
236		}
237	913×	"core.checkpoint-interval" => {
238	3×	self.checkpoint_interval = value
239	3×	.parse()
240	3×	.map_err(\|_\| RepoError::Msg(format!("expected a number, got {value:?}")))?;
241		}
242	910×	"push.batch-bytes" => {
243	2×	self.push_batch_bytes = value.parse().ok().filter(\|n\| *n > 0).ok_or_else(\|\| {
244	0×	RepoError::Msg(format!("expected a number of bytes, got {value:?}"))
245	0×	})?;
246		}
247	908×	k if k.starts_with("remote.") => {
248	905×	let rest = &k["remote.".len()..];
249	905×	let Some((name, field)) = rest.rsplit_once('.') else {
250	0×	return fail(format!("unknown configuration key {key:?}"));
251		};
252	905×	if name.is_empty() \|\| name.contains('/') {
253	0×	return fail(format!("invalid remote name in {key:?}"));
254	905×	}
255	905×	let map = match field {
256	905×	"url" => &mut self.remotes,
257	16×	"token" => &mut self.remote_tokens,
258	4×	"ca" => &mut self.remote_cas,
259	0×	_ => return fail(format!("unknown configuration key {key:?}")),
260		};
261	905×	if value.is_empty() {
262	4×	map.remove(name);
263	4×	if field == "url" {
264	3×	self.remote_tokens.remove(name);
265	3×	self.remote_cas.remove(name);
266	3×	}
267	901×	} else {
268	901×	map.insert(name.to_string(), value.into());
269	901×	}
270		}
271	3×	k if k.starts_with("revset.") => {
272	3×	let name = &k["revset.".len()..];
273	3×	if name.is_empty()
274	3×	\|\| !name
275	3×	.chars()
276	11×	.all(\|c\| c.is_ascii_alphanumeric() \|\| c == '_' \|\| c == '-')
277		{
278	0×	return fail(format!(
279		"a revset's name is letters, digits, _ and -: {key:?}"
280		));
281	3×	}
282	3×	if value.is_empty() {
283	0×	self.revsets.remove(name);
284	0×	} else {
285	3×	crate::revset::parse(value)
286	3×	.map_err(\|e\| RepoError::Msg(format!("{key} = {value:?}: {e}")))?;
287	2×	self.revsets.insert(name.to_string(), value.into());
288		}
289		}
290	0×	_ => return fail(format!("unknown configuration key {key:?}")),
291		}
292	2624×	Ok(())
293	2625×	}
294
295		/// Defaults, then the user file if it exists, then the repository file.
296	3365×	pub(super) fn load(user_path: Option<&Path>, repo_path: &Path) -> Result<Config> {
297	3365×	let mut c = Config::default_for_user();
298	3365×	if let Some(u) = user_path {
299	3365×	for (k, v) in read_config_file(u)? {
300	942×	let _ = c.apply(&k, &v);
301	942×	}
302	0×	}
303	3365×	for (k, v) in read_config_file(repo_path)? {
304	912×	if c.apply(&k, &v).is_ok() {
305	912×	c.repo_layer.insert(k, v);
306	912×	}
307		}
308		// author.for (oxygen#82): the identity the hub last named as the
309		// person's newest, kept in the home; a repository's own
310		// author.key pin still wins.
311	3365×	if c.author_for.is_some() && !c.repo_layer.contains_key("author.key") {
312	1×	if let Some(k) = user_path
313	1×	.and_then(Path::parent)
314	1×	.and_then(\|home\| fs::read_to_string(home.join("keys").join(AUTHOR_FOR_FILE)).ok())
315	1×	.and_then(\|s\| KeyId::from_hex(s.trim()))
316	1×	{
317	1×	c.author_key = Some(k);
318	1×	}
319	3364×	}
320	3365×	Ok(c)
321	3365×	}
322
323	1061×	pub(super) fn save(&self, path: &Path) -> Result<()> {
324	1061×	write_config_file(path, &self.repo_layer)
325	1061×	}
326
327		/// Keys explicitly set for this repository.
328	25×	pub fn repo_layer(&self) -> &BTreeMap<String, String> {
329	25×	&self.repo_layer
330	25×	}
331		}
332
333		/// In a home's `keys/`: the key of the identity `author.for` follows,
334		/// as the hub last named it (oxygen#82).
335		pub const AUTHOR_FOR_FILE: &str = "author.for";
336
337		/// A byte count with an optional `K`, `M`, or `G` suffix (binary units).
338		/// `storage.cache` when unset: 2 GiB.
339		pub const DEFAULT_STORAGE_CACHE: u64 = 2 << 30;
340
341	8×	pub fn parse_size(v: &str) -> Result<u64> {
342	8×	let v = v.trim();
343	8×	let (num, mult) = match v.chars().last() {
344	1×	Some('K' \| 'k') => (&v[..v.len() - 1], 1u64 << 10),
345	1×	Some('M' \| 'm') => (&v[..v.len() - 1], 1u64 << 20),
346	0×	Some('G' \| 'g') => (&v[..v.len() - 1], 1u64 << 30),
347	6×	_ => (v, 1),
348		};
349	8×	let n: u64 = num
350	8×	.trim()
351	8×	.parse()
352	8×	.map_err(\|_\| RepoError::Msg(format!("expected a size like 1M, got {v:?}")))?;
353	7×	Ok(n * mult)
354	8×	}
355
356		/// A count of days, optionally suffixed `d`.
357	12×	fn parse_days(v: &str) -> Result<u64> {
358	12×	v.trim_end_matches('d')
359	12×	.parse()
360	12×	.map_err(\|_\| RepoError::Msg(format!("expected a number of days, got {v:?}")))
361	12×	}
362
363		/// Read `key = "value"` lines; a missing file is empty.
364	7542×	pub fn read_config_file(path: &Path) -> Result<BTreeMap<String, String>> {
365	7542×	let text = match fs::read_to_string(path) {
366	3208×	Ok(t) => t,
367	4334×	Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(BTreeMap::new()),
368	0×	Err(e) => return Err(e.into()),
369		};
370	3208×	let mut out = BTreeMap::new();
371	3208×	for line in text.lines() {
372	2294×	let line = line.trim();
373	2294×	if line.is_empty() \|\| line.starts_with('#') {
374	0×	continue;
375	2294×	}
376	2294×	let Some((k, v)) = line.split_once('=') else {
377	0×	continue;
378		};
379	2294×	out.insert(k.trim().to_string(), v.trim().trim_matches('"').to_string());
380		}
381	3208×	Ok(out)
382	7542×	}
383
384	1285×	fn write_config_file(path: &Path, entries: &BTreeMap<String, String>) -> Result<()> {
385	1285×	let text: String = entries
386	1285×	.iter()
387	1285×	.map(\|(k, v)\| format!("{k} = \"{v}\"\n"))
388	1285×	.collect();
389	1285×	write_atomic(path, text.as_bytes())
390	1285×	}

Coverage / crates/oxy-core/src/repo/config.rs 84.3%

Keyboard