OXYGENHUB
# aedfe465b611 oxygen / crates / oxy-core / src / repo / config.rs
12.9 KiB · Rust · last changed Push a long history in parts 26 days ago source blame history raw
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
    /// `core.sign`: sign every change at commit (`true`) or leave signing to
22
    /// push-time seals (`false`, the spec default).
23
    pub sign_changes: bool,
24
    pub bookmark: String,
25
    /// `remote.<name>.url`.
26
    pub remotes: BTreeMap<String, String>,
27
    /// `remote.<name>.token`: bearer token for HTTP pushes.
28
    pub remote_tokens: BTreeMap<String, String>,
29
    /// `remote.<name>.ca`: PEM file of extra roots to trust for that remote.
30
    pub remote_cas: BTreeMap<String, String>,
31
    /// `core.remote`: the remote `pull`, `fetch` and `push` use when none is
32
    /// named, for a repository whose remotes include no `origin`.
33
    pub default_remote: Option<String>,
34
    /// `core.op-retention`: days for which operations keep their states reachable (spec §12.1, §21).
35
    pub op_retention_days: u64,
36
    /// `core.gc-grace`: days an unreachable object survives, protecting concurrent writers (spec §21).
37
    pub gc_grace_days: u64,
38
    /// `core.checkpoint-interval`: changes between automatic checkpoints (spec §11).
39
    pub checkpoint_interval: u64,
40
    /// `push.batch-bytes`: about how many bytes of changes and their texts
41
    /// one request of a long push carries (spec §16.3).
42
    pub push_batch_bytes: u64,
43
    /// `filter.max-blob`: blobs larger than this many bytes are fetched lazily (spec §17).
44
    pub max_blob: Option<u64>,
45
    /// `filter.paths`: only these subtrees are materialized (spec §17); empty means everything.
46
    pub sparse_paths: Vec<String>,
47
    /// `hooks.semantic-deps`: run the semantic-deps hook at commit (spec §20).
48
    pub semantic_deps: bool,
49
    /// `revset.<name>`: a saved revset, used as `name()`.
50
    pub revsets: BTreeMap<String, String>,
51
    /// `storage.url`: the store the repository's objects and operation
52
    /// head are kept on (`dir://`, `s3://`, …) instead of `.oxy/objects`
53
    /// (oxygen#68).
54
    pub storage_url: Option<String>,
55
    /// `storage.cache`: the most the local cache in front of that store
56
    /// holds, in bytes.
57
    pub storage_cache: u64,
58
}
59
60
impl Config {
61
    /// Whether the repository's own file sets `key` (as against the user
62
    /// config or a default).
63
    pub fn is_repo_set(&self, key: &str) -> bool {
64
        self.repo_layer.contains_key(key)
65
    }
66
67
    pub(super) fn default_for_user() -> Config {
68
        let user = std::env::var("USER").unwrap_or_else(|_| "unknown".into());
69
        Config {
70
            repo_layer: BTreeMap::new(),
71
            author_name: std::env::var("OXY_AUTHOR_NAME").unwrap_or_else(|_| user.clone()),
72
            author_email: std::env::var("OXY_AUTHOR_EMAIL")
73
                .unwrap_or_else(|_| format!("{user}@localhost")),
74
            author_key: None,
75
            signer_key: std::env::var("OXY_SIGNER")
76
                .ok()
77
                .and_then(|v| KeyId::from_hex(&v)),
78
            sign_changes: false,
79
            bookmark: "main".into(),
80
            remotes: BTreeMap::new(),
81
            remote_tokens: BTreeMap::new(),
82
            remote_cas: BTreeMap::new(),
83
            default_remote: None,
84
            op_retention_days: 90,
85
            gc_grace_days: 14,
86
            checkpoint_interval: 256,
87
            push_batch_bytes: 256 << 20,
88
            max_blob: None,
89
            sparse_paths: Vec::new(),
90
            semantic_deps: false,
91
            revsets: BTreeMap::new(),
92
            storage_url: None,
93
            storage_cache: DEFAULT_STORAGE_CACHE,
94
        }
95
    }
96
97
    /// Set a key in the repository layer, as `oxy config` does.
98
    pub fn set(&mut self, key: &str, value: &str) -> Result<()> {
99
        self.apply(key, value)?;
100
        if value.is_empty() {
101
            self.repo_layer.remove(key);
102
        } else {
103
            self.repo_layer.insert(key.to_string(), value.to_string());
104
        }
105
        Ok(())
106
    }
107
108
    /// Set a key in the user file without touching any repository.
109
    pub fn set_user(user_path: &Path, key: &str, value: &str) -> Result<()> {
110
        Config::default_for_user().apply(key, value)?;
111
        let mut entries = read_config_file(user_path)?;
112
        if value.is_empty() {
113
            entries.remove(key);
114
        } else {
115
            entries.insert(key.to_string(), value.to_string());
116
        }
117
        if let Some(parent) = user_path.parent() {
118
            fs::create_dir_all(parent)?;
119
        }
120
        write_config_file(user_path, &entries)
121
    }
122
123
    /// Apply a key to the effective values.
124
    pub(super) fn apply(&mut self, key: &str, value: &str) -> Result<()> {
125
        match key {
126
            "author.name" => self.author_name = value.into(),
127
            "author.email" => self.author_email = value.into(),
128
            "author.key" => {
129
                self.author_key = if value.is_empty() {
130
                    None
131
                } else {
132
                    Some(KeyId::from_hex(value).ok_or_else(|| {
133
                        RepoError::Msg("author.key must be a 64-character hex KeyId".into())
134
                    })?)
135
                }
136
            }
137
            "author.signer" => {
138
                self.signer_key = if value.is_empty() {
139
                    None
140
                } else {
141
                    Some(KeyId::from_hex(value).ok_or_else(|| {
142
                        RepoError::Msg("author.signer must be a 64-character hex KeyId".into())
143
                    })?)
144
                }
145
            }
146
            "core.sign" => {
147
                self.sign_changes = match value {
148
                    "change" => true,
149
                    "seal" => false,
150
                    _ => return fail("core.sign must be \"change\" or \"seal\""),
151
                }
152
            }
153
            "workspace.bookmark" => self.bookmark = value.into(),
154
            // Read by the credential store from the user file.
155
            "auth.helper" => {}
156
            "core.op-retention" => self.op_retention_days = parse_days(value)?,
157
            "core.gc-grace" => self.gc_grace_days = parse_days(value)?,
158
            "filter.max-blob" => {
159
                self.max_blob = if value.is_empty() {
160
                    None
161
                } else {
162
                    Some(parse_size(value)?)
163
                }
164
            }
165
            "storage.url" => {
166
                self.storage_url = (!value.is_empty()).then(|| value.to_string());
167
            }
168
            "storage.cache" => {
169
                self.storage_cache = if value.is_empty() {
170
                    DEFAULT_STORAGE_CACHE
171
                } else {
172
                    parse_size(value)?
173
                }
174
            }
175
            "core.remote" => {
176
                self.default_remote = (!value.is_empty()).then(|| value.to_string());
177
            }
178
            "hooks.semantic-deps" => self.semantic_deps = matches!(value, "true" | "1" | "yes"),
179
            "filter.paths" => {
180
                self.sparse_paths = value
181
                    .split(',')
182
                    .map(|p| {
183
                        p.trim()
184
                            .trim_start_matches("./")
185
                            .trim_matches('/')
186
                            .to_string()
187
                    })
188
                    .filter(|p| !p.is_empty())
189
                    .collect();
190
            }
191
            "core.checkpoint-interval" => {
192
                self.checkpoint_interval = value
193
                    .parse()
194
                    .map_err(|_| RepoError::Msg(format!("expected a number, got {value:?}")))?;
195
            }
196
            "push.batch-bytes" => {
197
                self.push_batch_bytes = value.parse().ok().filter(|n| *n > 0).ok_or_else(|| {
198
                    RepoError::Msg(format!("expected a number of bytes, got {value:?}"))
199
                })?;
200
            }
201
            k if k.starts_with("remote.") => {
202
                let rest = &k["remote.".len()..];
203
                let Some((name, field)) = rest.rsplit_once('.') else {
204
                    return fail(format!("unknown configuration key {key:?}"));
205
                };
206
                if name.is_empty() || name.contains('/') {
207
                    return fail(format!("invalid remote name in {key:?}"));
208
                }
209
                let map = match field {
210
                    "url" => &mut self.remotes,
211
                    "token" => &mut self.remote_tokens,
212
                    "ca" => &mut self.remote_cas,
213
                    _ => return fail(format!("unknown configuration key {key:?}")),
214
                };
215
                if value.is_empty() {
216
                    map.remove(name);
217
                    if field == "url" {
218
                        self.remote_tokens.remove(name);
219
                        self.remote_cas.remove(name);
220
                    }
221
                } else {
222
                    map.insert(name.to_string(), value.into());
223
                }
224
            }
225
            k if k.starts_with("revset.") => {
226
                let name = &k["revset.".len()..];
227
                if name.is_empty()
228
                    || !name
229
                        .chars()
230
                        .all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
231
                {
232
                    return fail(format!(
233
                        "a revset's name is letters, digits, _ and -: {key:?}"
234
                    ));
235
                }
236
                if value.is_empty() {
237
                    self.revsets.remove(name);
238
                } else {
239
                    crate::revset::parse(value)
240
                        .map_err(|e| RepoError::Msg(format!("{key} = {value:?}: {e}")))?;
241
                    self.revsets.insert(name.to_string(), value.into());
242
                }
243
            }
244
            _ => return fail(format!("unknown configuration key {key:?}")),
245
        }
246
        Ok(())
247
    }
248
249
    /// Defaults, then the user file if it exists, then the repository file.
250
    pub(super) fn load(user_path: Option<&Path>, repo_path: &Path) -> Result<Config> {
251
        let mut c = Config::default_for_user();
252
        if let Some(u) = user_path {
253
            for (k, v) in read_config_file(u)? {
254
                let _ = c.apply(&k, &v);
255
            }
256
        }
257
        for (k, v) in read_config_file(repo_path)? {
258
            if c.apply(&k, &v).is_ok() {
259
                c.repo_layer.insert(k, v);
260
            }
261
        }
262
        Ok(c)
263
    }
264
265
    pub(super) fn save(&self, path: &Path) -> Result<()> {
266
        write_config_file(path, &self.repo_layer)
267
    }
268
269
    /// Keys explicitly set for this repository.
270
    pub fn repo_layer(&self) -> &BTreeMap<String, String> {
271
        &self.repo_layer
272
    }
273
}
274
275
/// A byte count with an optional `K`, `M`, or `G` suffix (binary units).
276
/// `storage.cache` when unset: 2 GiB.
277
pub const DEFAULT_STORAGE_CACHE: u64 = 2 << 30;
278
279
pub fn parse_size(v: &str) -> Result<u64> {
280
    let v = v.trim();
281
    let (num, mult) = match v.chars().last() {
282
        Some('K' | 'k') => (&v[..v.len() - 1], 1u64 << 10),
283
        Some('M' | 'm') => (&v[..v.len() - 1], 1u64 << 20),
284
        Some('G' | 'g') => (&v[..v.len() - 1], 1u64 << 30),
285
        _ => (v, 1),
286
    };
287
    let n: u64 = num
288
        .trim()
289
        .parse()
290
        .map_err(|_| RepoError::Msg(format!("expected a size like 1M, got {v:?}")))?;
291
    Ok(n * mult)
292
}
293
294
/// A count of days, optionally suffixed `d`.
295
fn parse_days(v: &str) -> Result<u64> {
296
    v.trim_end_matches('d')
297
        .parse()
298
        .map_err(|_| RepoError::Msg(format!("expected a number of days, got {v:?}")))
299
}
300
301
/// Read `key = "value"` lines; a missing file is empty.
302
pub fn read_config_file(path: &Path) -> Result<BTreeMap<String, String>> {
303
    let text = match fs::read_to_string(path) {
304
        Ok(t) => t,
305
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(BTreeMap::new()),
306
        Err(e) => return Err(e.into()),
307
    };
308
    let mut out = BTreeMap::new();
309
    for line in text.lines() {
310
        let line = line.trim();
311
        if line.is_empty() || line.starts_with('#') {
312
            continue;
313
        }
314
        let Some((k, v)) = line.split_once('=') else {
315
            continue;
316
        };
317
        out.insert(k.trim().to_string(), v.trim().trim_matches('"').to_string());
318
    }
319
    Ok(out)
320
}
321
322
fn write_config_file(path: &Path, entries: &BTreeMap<String, String>) -> Result<()> {
323
    let text: String = entries
324
        .iter()
325
        .map(|(k, v)| format!("{k} = \"{v}\"\n"))
326
        .collect();
327
    write_atomic(path, text.as_bytes())
328
}