OXYGENHUB
# 835ceb9b3ea7 oxygen / crates / oxy-core / src / repo / config.rs
16.2 KiB · Rust · last changed oxy git colocate: a .git beside .oxy, kept up to date after every command; .git is never content and never written by checkout (closes #160) 4 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
    /// `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
    pub fn is_repo_set(&self, key: &str) -> bool {
91
        self.repo_layer.contains_key(key)
92
    }
93
94
    pub(super) fn default_for_user() -> Config {
95
        let user = std::env::var("USER").unwrap_or_else(|_| "unknown".into());
96
        Config {
97
            repo_layer: BTreeMap::new(),
98
            author_name: std::env::var("OXY_AUTHOR_NAME").unwrap_or_else(|_| user.clone()),
99
            author_email: std::env::var("OXY_AUTHOR_EMAIL")
100
                .unwrap_or_else(|_| format!("{user}@localhost")),
101
            author_key: None,
102
            signer_key: std::env::var("OXY_SIGNER")
103
                .ok()
104
                .and_then(|v| KeyId::from_hex(&v)),
105
            signer_keyless: std::env::var("OXY_SIGNER").is_ok_and(|v| v == "keyless"),
106
            keyless_hub: None,
107
            author_for: None,
108
            sign_changes: false,
109
            bookmark: "main".into(),
110
            remotes: BTreeMap::new(),
111
            remote_tokens: BTreeMap::new(),
112
            remote_cas: BTreeMap::new(),
113
            default_remote: None,
114
            git_claim: false,
115
            git_colocate: false,
116
            op_retention_days: 90,
117
            gc_grace_days: 14,
118
            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
            push_batch_bytes: 64 << 20,
124
            max_blob: None,
125
            sparse_paths: Vec::new(),
126
            semantic_deps: false,
127
            revsets: BTreeMap::new(),
128
            storage_url: None,
129
            storage_cache: DEFAULT_STORAGE_CACHE,
130
        }
131
    }
132
133
    /// Set a key in the repository layer, as `oxy config` does.
134
    pub fn set(&mut self, key: &str, value: &str) -> Result<()> {
135
        self.apply(key, value)?;
136
        if value.is_empty() {
137
            self.repo_layer.remove(key);
138
        } else {
139
            self.repo_layer.insert(key.to_string(), value.to_string());
140
        }
141
        Ok(())
142
    }
143
144
    /// Set a key in the user file without touching any repository.
145
    pub fn set_user(user_path: &Path, key: &str, value: &str) -> Result<()> {
146
        Config::default_for_user().apply(key, value)?;
147
        let mut entries = read_config_file(user_path)?;
148
        if value.is_empty() {
149
            entries.remove(key);
150
        } else {
151
            entries.insert(key.to_string(), value.to_string());
152
        }
153
        if let Some(parent) = user_path.parent() {
154
            fs::create_dir_all(parent)?;
155
        }
156
        write_config_file(user_path, &entries)
157
    }
158
159
    /// Apply a key to the effective values.
160
    pub(super) fn apply(&mut self, key: &str, value: &str) -> Result<()> {
161
        match key {
162
            "author.name" => self.author_name = value.into(),
163
            "author.email" => self.author_email = value.into(),
164
            "author.key" => {
165
                self.author_key = if value.is_empty() {
166
                    None
167
                } else {
168
                    Some(KeyId::from_hex(value).ok_or_else(|| {
169
                        RepoError::Msg("author.key must be a 64-character hex KeyId".into())
170
                    })?)
171
                }
172
            }
173
            "author.signer" => {
174
                self.signer_keyless = value == "keyless";
175
                self.signer_key = if value.is_empty() || self.signer_keyless {
176
                    None
177
                } else {
178
                    Some(KeyId::from_hex(value).ok_or_else(|| {
179
                        RepoError::Msg(
180
                            "author.signer must be a 64-character hex KeyId, or \"keyless\"".into(),
181
                        )
182
                    })?)
183
                }
184
            }
185
            "core.sign" => {
186
                self.sign_changes = match value {
187
                    "change" => true,
188
                    "seal" => false,
189
                    _ => return fail("core.sign must be \"change\" or \"seal\""),
190
                }
191
            }
192
            "workspace.bookmark" => self.bookmark = value.into(),
193
            "keyless.hub" => self.keyless_hub = (!value.is_empty()).then(|| value.to_string()),
194
            "author.for" => self.author_for = (!value.is_empty()).then(|| value.to_string()),
195
            // Read by the credential store from the user file.
196
            "auth.helper" => {}
197
            "core.op-retention" => self.op_retention_days = parse_days(value)?,
198
            "core.gc-grace" => self.gc_grace_days = parse_days(value)?,
199
            "snapshot.max-new-file-size" => self.max_new_file = parse_size(value)?,
200
            "core.snapshot-retention" => self.snapshot_retention_days = parse_days(value)?,
201
            "filter.max-blob" => {
202
                self.max_blob = if value.is_empty() {
203
                    None
204
                } else {
205
                    Some(parse_size(value)?)
206
                }
207
            }
208
            "storage.url" => {
209
                self.storage_url = (!value.is_empty()).then(|| value.to_string());
210
            }
211
            "storage.cache" => {
212
                self.storage_cache = if value.is_empty() {
213
                    DEFAULT_STORAGE_CACHE
214
                } else {
215
                    parse_size(value)?
216
                }
217
            }
218
            "core.remote" => {
219
                self.default_remote = (!value.is_empty()).then(|| value.to_string());
220
            }
221
            "hooks.semantic-deps" => self.semantic_deps = matches!(value, "true" | "1" | "yes"),
222
            "git.claim" => self.git_claim = matches!(value, "true" | "1" | "yes"),
223
            "git.colocate" => self.git_colocate = matches!(value, "true" | "1" | "yes"),
224
            "filter.paths" => {
225
                self.sparse_paths = value
226
                    .split(',')
227
                    .map(|p| {
228
                        p.trim()
229
                            .trim_start_matches("./")
230
                            .trim_matches('/')
231
                            .to_string()
232
                    })
233
                    .filter(|p| !p.is_empty())
234
                    .collect();
235
            }
236
            "core.checkpoint-interval" => {
237
                self.checkpoint_interval = value
238
                    .parse()
239
                    .map_err(|_| RepoError::Msg(format!("expected a number, got {value:?}")))?;
240
            }
241
            "push.batch-bytes" => {
242
                self.push_batch_bytes = value.parse().ok().filter(|n| *n > 0).ok_or_else(|| {
243
                    RepoError::Msg(format!("expected a number of bytes, got {value:?}"))
244
                })?;
245
            }
246
            k if k.starts_with("remote.") => {
247
                let rest = &k["remote.".len()..];
248
                let Some((name, field)) = rest.rsplit_once('.') else {
249
                    return fail(format!("unknown configuration key {key:?}"));
250
                };
251
                if name.is_empty() || name.contains('/') {
252
                    return fail(format!("invalid remote name in {key:?}"));
253
                }
254
                let map = match field {
255
                    "url" => &mut self.remotes,
256
                    "token" => &mut self.remote_tokens,
257
                    "ca" => &mut self.remote_cas,
258
                    _ => return fail(format!("unknown configuration key {key:?}")),
259
                };
260
                if value.is_empty() {
261
                    map.remove(name);
262
                    if field == "url" {
263
                        self.remote_tokens.remove(name);
264
                        self.remote_cas.remove(name);
265
                    }
266
                } else {
267
                    map.insert(name.to_string(), value.into());
268
                }
269
            }
270
            k if k.starts_with("revset.") => {
271
                let name = &k["revset.".len()..];
272
                if name.is_empty()
273
                    || !name
274
                        .chars()
275
                        .all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '-')
276
                {
277
                    return fail(format!(
278
                        "a revset's name is letters, digits, _ and -: {key:?}"
279
                    ));
280
                }
281
                if value.is_empty() {
282
                    self.revsets.remove(name);
283
                } else {
284
                    crate::revset::parse(value)
285
                        .map_err(|e| RepoError::Msg(format!("{key} = {value:?}: {e}")))?;
286
                    self.revsets.insert(name.to_string(), value.into());
287
                }
288
            }
289
            _ => return fail(format!("unknown configuration key {key:?}")),
290
        }
291
        Ok(())
292
    }
293
294
    /// Defaults, then the user file if it exists, then the repository file.
295
    pub(super) fn load(user_path: Option<&Path>, repo_path: &Path) -> Result<Config> {
296
        let mut c = Config::default_for_user();
297
        if let Some(u) = user_path {
298
            for (k, v) in read_config_file(u)? {
299
                let _ = c.apply(&k, &v);
300
            }
301
        }
302
        for (k, v) in read_config_file(repo_path)? {
303
            if c.apply(&k, &v).is_ok() {
304
                c.repo_layer.insert(k, v);
305
            }
306
        }
307
        // author.for (oxygen#82): the identity the hub last named as the
308
        // person's newest, kept in the home; a repository's own
309
        // author.key pin still wins.
310
        if c.author_for.is_some() && !c.repo_layer.contains_key("author.key") {
311
            if let Some(k) = user_path
312
                .and_then(Path::parent)
313
                .and_then(|home| fs::read_to_string(home.join("keys").join(AUTHOR_FOR_FILE)).ok())
314
                .and_then(|s| KeyId::from_hex(s.trim()))
315
            {
316
                c.author_key = Some(k);
317
            }
318
        }
319
        Ok(c)
320
    }
321
322
    pub(super) fn save(&self, path: &Path) -> Result<()> {
323
        write_config_file(path, &self.repo_layer)
324
    }
325
326
    /// Keys explicitly set for this repository.
327
    pub fn repo_layer(&self) -> &BTreeMap<String, String> {
328
        &self.repo_layer
329
    }
330
}
331
332
/// In a home's `keys/`: the key of the identity `author.for` follows,
333
/// as the hub last named it (oxygen#82).
334
pub const AUTHOR_FOR_FILE: &str = "author.for";
335
336
/// A byte count with an optional `K`, `M`, or `G` suffix (binary units).
337
/// `storage.cache` when unset: 2 GiB.
338
pub const DEFAULT_STORAGE_CACHE: u64 = 2 << 30;
339
340
pub fn parse_size(v: &str) -> Result<u64> {
341
    let v = v.trim();
342
    let (num, mult) = match v.chars().last() {
343
        Some('K' | 'k') => (&v[..v.len() - 1], 1u64 << 10),
344
        Some('M' | 'm') => (&v[..v.len() - 1], 1u64 << 20),
345
        Some('G' | 'g') => (&v[..v.len() - 1], 1u64 << 30),
346
        _ => (v, 1),
347
    };
348
    let n: u64 = num
349
        .trim()
350
        .parse()
351
        .map_err(|_| RepoError::Msg(format!("expected a size like 1M, got {v:?}")))?;
352
    Ok(n * mult)
353
}
354
355
/// A count of days, optionally suffixed `d`.
356
fn parse_days(v: &str) -> Result<u64> {
357
    v.trim_end_matches('d')
358
        .parse()
359
        .map_err(|_| RepoError::Msg(format!("expected a number of days, got {v:?}")))
360
}
361
362
/// Read `key = "value"` lines; a missing file is empty.
363
pub fn read_config_file(path: &Path) -> Result<BTreeMap<String, String>> {
364
    let text = match fs::read_to_string(path) {
365
        Ok(t) => t,
366
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(BTreeMap::new()),
367
        Err(e) => return Err(e.into()),
368
    };
369
    let mut out = BTreeMap::new();
370
    for line in text.lines() {
371
        let line = line.trim();
372
        if line.is_empty() || line.starts_with('#') {
373
            continue;
374
        }
375
        let Some((k, v)) = line.split_once('=') else {
376
            continue;
377
        };
378
        out.insert(k.trim().to_string(), v.trim().trim_matches('"').to_string());
379
    }
380
    Ok(out)
381
}
382
383
fn write_config_file(path: &Path, entries: &BTreeMap<String, String>) -> Result<()> {
384
    let text: String = entries
385
        .iter()
386
        .map(|(k, v)| format!("{k} = \"{v}\"\n"))
387
        .collect();
388
    write_atomic(path, text.as_bytes())
389
}