OXYGENHUB
# 0554aaa7ddef oxygen / crates / oxy-core / src / repo / prompt.rs
20.2 KiB · Rust · last changed Check out against the manifest, without the base state 1 month ago source blame history raw
1
//! Fast, side-effect-free status for shell prompts.
2
//!
3
//! Every snapshot and checkout writes a manifest of the working copy as it
4
//! was last seen: `size`, `mtime`, and BLAKE3 of each file. `quick_status`
5
//! walks the working copy and compares against that manifest, reading a
6
//! file's content only when its size or mtime changed, and records no
7
//! operation. Ahead/behind counts come from walking the store between the
8
//! local bookmark and its `origin` tracking state.
9
10
use super::*;
11
use std::time::UNIX_EPOCH;
12
13
#[derive(Debug, Clone, Default, PartialEq, Eq)]
14
pub struct PromptInfo {
15
    pub bookmark: String,
16
    /// Working-copy ChangeId prefix.
17
    pub change_id: String,
18
    pub heads: usize,
19
    pub dirty: bool,
20
    pub conflicted: bool,
21
    /// Changes local `main` has that `origin/main` lacks, when tracking exists.
22
    pub ahead: Option<usize>,
23
    pub behind: Option<usize>,
24
}
25
26
impl PromptInfo {
27
    /// The glyph for the working copy's state: `‼` conflicted, `✎` dirty,
28
    /// `✔` clean.
29
    pub fn state_glyph(&self) -> &'static str {
30
        if self.conflicted {
31
            "‼"
32
        } else if self.dirty {
33
            "✎"
34
        } else {
35
            "✔"
36
        }
37
    }
38
39
    /// The ANSI colour (SGR parameter) for the state: red, yellow, or cyan.
40
    pub fn state_color(&self) -> u8 {
41
        if self.conflicted {
42
            31
43
        } else if self.dirty {
44
            33
45
        } else {
46
            36
47
        }
48
    }
49
50
    /// `format` wrapped in the state colour. `guard` is `("\\[", "\\]")` for
51
    /// bash prompts, `("%{", "%}")` for zsh, or empty for raw output.
52
    pub fn format_colored(&self, fmt: &str, guard: (&str, &str)) -> String {
53
        format!(
54
            "{}\x1b[{}m{}{}{}\x1b[0m{}",
55
            guard.0,
56
            self.state_color(),
57
            guard.1,
58
            self.format(fmt),
59
            guard.0,
60
            guard.1
61
        )
62
    }
63
64
    /// Expand `%b` bookmark, `%c` change id, `%h` heads, `%d` dirty marker
65
    /// (`*`), `%x` conflict marker (`!`), `%a`/`%B` ahead/behind counts
66
    /// (empty when unknown), `%A`/`%D` `+n`/`-n` when non-zero, `%s` the
67
    /// state glyph, `%U`/`%O` `↑n`/`↓n` when non-zero, `%i` the repository
68
    /// icon, `%%` percent.
69
    pub fn format(&self, fmt: &str) -> String {
70
        let mut out = String::new();
71
        let mut chars = fmt.chars();
72
        while let Some(c) = chars.next() {
73
            if c != '%' {
74
                out.push(c);
75
                continue;
76
            }
77
            match chars.next() {
78
                Some('b') => out.push_str(&self.bookmark),
79
                Some('c') => out.push_str(&self.change_id),
80
                Some('h') => out.push_str(&self.heads.to_string()),
81
                Some('d') => {
82
                    if self.dirty {
83
                        out.push('*');
84
                    }
85
                }
86
                Some('x') => {
87
                    if self.conflicted {
88
                        out.push('!');
89
                    }
90
                }
91
                Some('a') => out.push_str(&self.ahead.map(|n| n.to_string()).unwrap_or_default()),
92
                Some('B') => out.push_str(&self.behind.map(|n| n.to_string()).unwrap_or_default()),
93
                Some('A') => {
94
                    if let Some(n) = self.ahead.filter(|n| *n > 0) {
95
                        out.push_str(&format!("+{n}"));
96
                    }
97
                }
98
                Some('D') => {
99
                    if let Some(n) = self.behind.filter(|n| *n > 0) {
100
                        out.push_str(&format!("-{n}"));
101
                    }
102
                }
103
                Some('s') => out.push_str(self.state_glyph()),
104
                Some('U') => {
105
                    if let Some(n) = self.ahead.filter(|n| *n > 0) {
106
                        out.push_str(&format!("↑{n}"));
107
                    }
108
                }
109
                Some('O') => {
110
                    if let Some(n) = self.behind.filter(|n| *n > 0) {
111
                        out.push_str(&format!("↓{n}"));
112
                    }
113
                }
114
                Some('i') => out.push_str(ICON),
115
                Some('%') => out.push('%'),
116
                Some(other) => {
117
                    out.push('%');
118
                    out.push(other);
119
                }
120
                None => out.push('%'),
121
            }
122
        }
123
        out
124
    }
125
}
126
127
/// Path → (size, mtime in nanoseconds, BLAKE3 hex) as last seen.
128
/// One manifest entry: the file's stat, its content hash, and the stored
129
/// blob for an opaque file.
130
#[derive(Clone, Debug)]
131
pub(crate) struct ManifestEntry {
132
    pub size: u64,
133
    pub mtime_ns: u128,
134
    pub hash: String,
135
    pub blob: Option<ObjectRef>,
136
    /// The graph key (`State::graph_key`) of the base file this text file
137
    /// was found equal to, rendered, byte for byte.
138
    pub graph: Option<String>,
139
    /// Whether the file was executable: a mode change alters neither size
140
    /// nor time.
141
    pub exec: bool,
142
}
143
144
#[derive(Clone, Debug, Default)]
145
pub(crate) struct Manifest {
146
    /// When the manifest was written, for the racy-stat guard.
147
    pub written_ns: u128,
148
    pub entries: BTreeMap<String, ManifestEntry>,
149
}
150
151
pub(crate) fn mtime_ns(m: &fs::Metadata) -> u128 {
152
    m.modified()
153
        .ok()
154
        .and_then(|t| t.duration_since(UNIX_EPOCH).ok())
155
        .map(|d| d.as_nanos())
156
        .unwrap_or(0)
157
}
158
159
pub const DEFAULT_PROMPT_FORMAT: &str = "%b %c%d%x%A%D";
160
/// The repository icon for `%i` (an atom, for oxygen).
161
pub const ICON: &str = "⚛";
162
/// A format with glyphs: icon, bookmark, change id, state, ahead/behind.
163
pub const GLYPH_PROMPT_FORMAT: &str = "%i %b %c %s%U%O";
164
165
/// One manifest line per file: size, mtime in nanoseconds, hash, blob ref
166
/// or `-`, graph key or `-`, `x` when executable or `-`, path.
167
fn manifest_line(
168
    path: &str,
169
    size: u64,
170
    mtime_ns: u128,
171
    hash: &str,
172
    blob: Option<ObjectRef>,
173
    graph: Option<&str>,
174
    exec: bool,
175
) -> String {
176
    format!(
177
        "{size}\t{mtime_ns}\t{hash}\t{}\t{}\t{}\t{path}\n",
178
        blob.map(|b| b.to_hex()).unwrap_or_else(|| "-".into()),
179
        graph.unwrap_or("-"),
180
        if exec { "x" } else { "-" }
181
    )
182
}
183
184
impl Repo {
185
    pub(crate) fn manifest_path(&self) -> PathBuf {
186
        self.oxy
187
            .join("workspaces")
188
            .join(self.workspace.to_hex())
189
            .join("manifest")
190
    }
191
192
    /// Record the working copy as it is now (after a snapshot, commit, or
193
    /// checkout), with header lines saying whether the base state is
194
    /// conflicted and whether the working-copy change holds uncommitted work.
195
    pub(crate) fn write_manifest(&self, conflicted: bool, uncommitted: bool) -> Result<()> {
196
        let entries = self.walk_working_copy()?;
197
        self.write_manifest_entries(conflicted, uncommitted, &entries, &HashMap::new())
198
    }
199
200
    /// Write the manifest from entries already walked; `blobs` names the
201
    /// stored blob of each opaque path so the next walk can skip reading it.
202
    pub(crate) fn write_manifest_entries(
203
        &self,
204
        conflicted: bool,
205
        uncommitted: bool,
206
        entries: &BTreeMap<String, FsEntry>,
207
        blobs: &HashMap<String, ObjectRef>,
208
    ) -> Result<()> {
209
        let written = std::time::SystemTime::now()
210
            .duration_since(UNIX_EPOCH)
211
            .map(|d| d.as_nanos())
212
            .unwrap_or(0);
213
        let head = format!(
214
            "# conflicted={}\n# uncommitted={}\n",
215
            conflicted as u8, uncommitted as u8
216
        );
217
        let mut body = String::new();
218
        let mut newest_ns: u128 = 0;
219
        for (path, e) in entries {
220
            let full = self.root.join(path);
221
            let (size, mtime_ns) = match e.stat {
222
                Some(known) => known,
223
                None => match fs::symlink_metadata(&full) {
224
                    Ok(m) => (m.len(), mtime_ns(&m)),
225
                    Err(_) => (e.content.len() as u64, 0),
226
                },
227
            };
228
            let hash = match &e.content_hash {
229
                Some(h) => h.clone(),
230
                None => blake3::hash(&e.content).to_hex().to_string(),
231
            };
232
            let blob = blobs.get(path).copied().or(e.blob);
233
            newest_ns = newest_ns.max(mtime_ns);
234
            body.push_str(&manifest_line(
235
                path,
236
                size,
237
                mtime_ns,
238
                &hash,
239
                blob,
240
                e.graph_key.as_deref(),
241
                e.exec,
242
            ));
243
        }
244
        let p = self.manifest_path();
245
        // Leave an unchanged manifest alone when its stamp already trusts
246
        // every entry (none is within the racy window): rewriting it would
247
        // change nothing but the file, which editors watching the tree
248
        // (and subrepos inside it) take as a change.
249
        if let Ok(old) = fs::read_to_string(&p) {
250
            let old_written: Option<u128> = old.lines().find_map(|l| {
251
                l.strip_prefix("# written=")
252
                    .and_then(|v| v.trim().parse().ok())
253
            });
254
            let old_rest: String = old
255
                .lines()
256
                .filter(|l| !l.starts_with("# written="))
257
                .map(|l| format!("{l}\n"))
258
                .collect();
259
            if let Some(w) = old_written {
260
                if old_rest == format!("{head}{body}") && newest_ns + 2_000_000_000 < w {
261
                    return Ok(());
262
                }
263
            }
264
        }
265
        let text = format!("{head}# written={written}\n{body}");
266
        fs::create_dir_all(p.parent().unwrap())?;
267
        write_atomic(&p, text.as_bytes())
268
    }
269
270
    /// Change the header flags, and set the graph key of each path in
271
    /// `keys` (after a commit, the new base's keys of the files it holds as
272
    /// they are on disk).
273
    pub(crate) fn rewrite_manifest(
274
        &self,
275
        conflicted: bool,
276
        uncommitted: bool,
277
        keys: &HashMap<String, String>,
278
    ) -> Result<()> {
279
        let p = self.manifest_path();
280
        let text = match fs::read_to_string(&p) {
281
            Ok(t) => t,
282
            Err(_) => return self.write_manifest(conflicted, uncommitted),
283
        };
284
        let mut out = String::with_capacity(text.len());
285
        for line in text.lines() {
286
            if line.starts_with("# conflicted=") {
287
                out.push_str(&format!("# conflicted={}\n", conflicted as u8));
288
            } else if line.starts_with("# uncommitted=") {
289
                out.push_str(&format!("# uncommitted={}\n", uncommitted as u8));
290
            } else {
291
                let f: Vec<&str> = line.splitn(7, '\t').collect();
292
                match (f.len() == 7).then(|| keys.get(f[6])).flatten() {
293
                    Some(k) => out.push_str(&format!(
294
                        "{}\t{}\t{}\t{}\t{k}\t{}\t{}\n",
295
                        f[0], f[1], f[2], f[3], f[5], f[6]
296
                    )),
297
                    None => {
298
                        out.push_str(line);
299
                        out.push('\n');
300
                    }
301
                }
302
            }
303
        }
304
        write_atomic(&p, out.as_bytes())
305
    }
306
307
    /// Forget the manifest after an operation that changed the working-copy
308
    /// change without a snapshot (undo, rewrites); the prompt shows blank
309
    /// markers until the next snapshot.
310
    pub(crate) fn drop_manifest(&self) {
311
        let _ = fs::remove_file(self.manifest_path());
312
    }
313
314
    pub(crate) fn read_manifest(&self) -> Result<Option<(bool, bool, Manifest)>> {
315
        let text = match fs::read_to_string(self.manifest_path()) {
316
            Ok(t) => t,
317
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
318
            Err(e) => return Err(e.into()),
319
        };
320
        let mut out = Manifest::default();
321
        let mut conflicted = false;
322
        let mut uncommitted = false;
323
        for line in text.lines() {
324
            if let Some(v) = line.strip_prefix("# conflicted=") {
325
                conflicted = v.trim() == "1";
326
                continue;
327
            }
328
            if let Some(v) = line.strip_prefix("# uncommitted=") {
329
                uncommitted = v.trim() == "1";
330
                continue;
331
            }
332
            if let Some(v) = line.strip_prefix("# written=") {
333
                out.written_ns = v.trim().parse().unwrap_or(u128::MAX);
334
                continue;
335
            }
336
            // A line of another shape (an older manifest) is no entry: the
337
            // file is then read, and the next snapshot rewrites the line.
338
            let f: Vec<&str> = line.splitn(7, '\t').collect();
339
            if f.len() == 7 {
340
                out.entries.insert(
341
                    f[6].to_string(),
342
                    ManifestEntry {
343
                        size: f[0].parse().unwrap_or(0),
344
                        mtime_ns: f[1].parse().unwrap_or(0),
345
                        hash: f[2].to_string(),
346
                        blob: ObjectRef::from_hex(f[3]),
347
                        graph: (f[4] != "-").then(|| f[4].to_string()),
348
                        exec: f[5] == "x",
349
                    },
350
                );
351
            }
352
        }
353
        Ok(Some((conflicted, uncommitted, out)))
354
    }
355
356
    /// Whether the working copy is certainly clean, known from the manifest
357
    /// alone, without loading any history (spec §12.4): the last snapshot
358
    /// or commit found no uncommitted work and no conflict, there are no
359
    /// subrepos (whose state the manifest does not hold), and no file was
360
    /// added, removed or changed since. An entry inside the racy window,
361
    /// where an equal size and time do not prove equal content, is checked
362
    /// by hashing the file. `false` means only that a snapshot must decide.
363
    pub fn clean_by_manifest(&self) -> Result<bool> {
364
        let _t = crate::timing::phase("status: check the manifest");
365
        let Some((conflicted, uncommitted, m)) = self.read_manifest()? else {
366
            return Ok(false);
367
        };
368
        if conflicted || uncommitted || self.root.join(".oxymodules").exists() {
369
            return Ok(false);
370
        }
371
        for (rel, e) in &m.entries {
372
            if e.mtime_ns + 2_000_000_000 < m.written_ns {
373
                continue;
374
            }
375
            let path = self.root.join(rel);
376
            let same = match fs::symlink_metadata(&path) {
377
                Ok(md) if md.file_type().is_symlink() => fs::read_link(&path).is_ok_and(|t| {
378
                    blake3::hash(t.to_string_lossy().as_bytes())
379
                        .to_hex()
380
                        .as_str()
381
                        == e.hash
382
                }),
383
                Ok(md) if md.is_file() => {
384
                    md.len() == e.size
385
                        && fs::read(&path)
386
                            .is_ok_and(|b| blake3::hash(&b).to_hex().as_str() == e.hash)
387
                }
388
                _ => false,
389
            };
390
            if !same {
391
                return Ok(false);
392
            }
393
        }
394
        Ok(self.quick_dirty()? == Some(false))
395
    }
396
397
    /// Whether the working copy differs from the last manifest. Without a
398
    /// manifest the answer is `None`.
399
    pub fn quick_dirty(&self) -> Result<Option<bool>> {
400
        let Some((_, uncommitted, manifest)) = self.read_manifest()? else {
401
            return Ok(None);
402
        };
403
        if uncommitted {
404
            return Ok(Some(true));
405
        }
406
        let mut seen = 0usize;
407
        let nested = std::sync::Arc::new(std::sync::Mutex::new(Vec::new()));
408
        let wb = self.walker(&nested);
409
        for entry in wb.build() {
410
            let Ok(entry) = entry else { continue };
411
            let Some(ft) = entry.file_type() else {
412
                continue;
413
            };
414
            if ft.is_dir() {
415
                continue;
416
            }
417
            let rel: String = entry
418
                .path()
419
                .strip_prefix(&self.root)
420
                .unwrap()
421
                .components()
422
                .map(|c| c.as_os_str().to_string_lossy().to_string())
423
                .collect::<Vec<_>>()
424
                .join("/");
425
            if !self.in_scope(&rel) {
426
                continue;
427
            }
428
            let Some(me) = manifest.entries.get(&rel) else {
429
                return Ok(Some(true));
430
            };
431
            seen += 1;
432
            let m = fs::symlink_metadata(entry.path())?;
433
            let now_mtime = mtime_ns(&m);
434
            if ft.is_symlink() {
435
                let target = fs::read_link(entry.path())?;
436
                if blake3::hash(target.to_string_lossy().as_bytes())
437
                    .to_hex()
438
                    .as_str()
439
                    != me.hash
440
                {
441
                    return Ok(Some(true));
442
                }
443
                continue;
444
            }
445
            if m.len() != me.size || super::is_executable(&m) != me.exec {
446
                return Ok(Some(true));
447
            }
448
            if now_mtime != me.mtime_ns
449
                && blake3::hash(&fs::read(entry.path())?).to_hex().as_str() != me.hash
450
            {
451
                return Ok(Some(true));
452
            }
453
        }
454
        if seen == manifest.entries.len() {
455
            return Ok(Some(false));
456
        }
457
        // Manifest entries the walk skipped: tracked files that ignore rules
458
        // hide. They count as present when still on disk and unchanged.
459
        for (rel, me) in &manifest.entries {
460
            let path = self.root.join(rel);
461
            let Ok(m) = fs::symlink_metadata(&path) else {
462
                return Ok(Some(true));
463
            };
464
            if m.file_type().is_symlink() {
465
                continue;
466
            }
467
            if m.len() != me.size
468
                || super::is_executable(&m) != me.exec
469
                || (mtime_ns(&m) != me.mtime_ns
470
                    && blake3::hash(&fs::read(&path)?).to_hex().as_str() != me.hash)
471
            {
472
                return Ok(Some(true));
473
            }
474
        }
475
        Ok(Some(false))
476
    }
477
478
    /// Prompt information without recording anything.
479
    pub fn quick_status(&self) -> Result<PromptInfo> {
480
        let view = self.view()?;
481
        let bookmark = self.config.bookmark.clone();
482
        let heads = self.heads_of(&view, &bookmark)?;
483
        let wc_hash = view.workspaces.get(&self.workspace).copied();
484
        let change_id = match wc_hash {
485
            Some(h) => self.store.get_change(&h)?.change_id.short(8),
486
            None => String::new(),
487
        };
488
        // Conflictedness was recorded by the last snapshot; without a
489
        // manifest (never snapshotted) both flags are unknown and shown clear.
490
        let manifest = self.read_manifest()?;
491
        let conflicted = manifest.as_ref().map(|(c, _, _)| *c).unwrap_or(false);
492
        let dirty = self.quick_dirty()?.unwrap_or(false);
493
        let (ahead, behind) = match view.remotes.get("origin").and_then(|b| b.get(&bookmark)) {
494
            Some(st) => {
495
                let remote_heads = self.store.get_state(st)?.heads;
496
                let ahead = self.negotiate(&remote_heads, &heads).map(|v| v.len()).ok();
497
                let behind = self.negotiate(&heads, &remote_heads).map(|v| v.len()).ok();
498
                (ahead, behind)
499
            }
500
            None => (None, None),
501
        };
502
        Ok(PromptInfo {
503
            bookmark,
504
            change_id,
505
            heads: heads.len(),
506
            dirty,
507
            conflicted,
508
            ahead,
509
            behind,
510
        })
511
    }
512
}
513
514
#[cfg(test)]
515
mod tests {
516
    use super::*;
517
518
    #[test]
519
    fn placeholders_and_glyphs() {
520
        let clean = PromptInfo {
521
            bookmark: "main".into(),
522
            change_id: "658990aa".into(),
523
            heads: 1,
524
            dirty: false,
525
            conflicted: false,
526
            ahead: Some(0),
527
            behind: None,
528
        };
529
        assert_eq!(clean.format(DEFAULT_PROMPT_FORMAT), "main 658990aa");
530
        assert_eq!(clean.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✔");
531
        let busy = PromptInfo {
532
            dirty: true,
533
            ahead: Some(2),
534
            behind: Some(3),
535
            ..clean.clone()
536
        };
537
        assert_eq!(busy.format(DEFAULT_PROMPT_FORMAT), "main 658990aa*+2-3");
538
        assert_eq!(busy.format(GLYPH_PROMPT_FORMAT), "⚛ main 658990aa ✎↑2↓3");
539
        let bad = PromptInfo {
540
            conflicted: true,
541
            ..busy.clone()
542
        };
543
        assert_eq!(bad.format("%s%x%d %h %a/%B %%"), "‼!* 1 2/3 %");
544
        assert_eq!(bad.state_color(), 31);
545
        assert_eq!(
546
            busy.format_colored("%b", ("\\[", "\\]")),
547
            "\\[\x1b[33m\\]main\\[\x1b[0m\\]"
548
        );
549
        assert_eq!(clean.format_colored("%b", ("", "")), "\x1b[36mmain\x1b[0m");
550
        assert_eq!(clean.format("%q"), "%q");
551
    }
552
}