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