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