OXYGENHUB
# 9ac1fbe211b4 oxygen / crates / oxy-core / src / repo / mod.rs
30.2 KiB · Rust · last changed Lazy blobs: clone --max-blob / filter.max-blob, absent-blob registry fetched on first read, objects endpoint (spec 0.6e) 1 month ago source blame history raw
1
//! A repository on disk: the `.oxy` directory, one workspace, the operation
2
//! log, and the working-copy change (spec §12, §13.1).
3
//!
4
//! Not yet implemented from the spec: packs, checkpoints, multiple
5
//! workspaces, multi-signer policy updates, and the `objects`/`checkpoint`
6
//! endpoints. A repository without a policy is unverified and accepts
7
//! unsigned pushes; with one, everything received is checked (spec §14.5). Changes are signed individually when `core.sign` is
8
//! `change`; the default `seal` leaves them unsigned until push exists.
9
10
use crate::attest::{Attest, AttestBody};
11
use crate::diff::{ranges, split_lines, text_edits};
12
use crate::protocol::{open_remote, Bundle, RefResult, RefUpdate, RefsResponse, RemoteOptions, RemoteRef, SignedAttest, SignedPolicy};
13
use crate::hash::{hash_object, ChangeHash, KeyId, ObjectRef, ObjectType};
14
use crate::identity::{verify as verify_signature, Domain, Identity, SecretKey, Signature};
15
use crate::ids::{ChangeId, NodeId, WorkspaceId};
16
use crate::objects::{Blob, Change, ChangeKind, Edit, Hlc, Mode, NodeKind, OpRef, StateObject, TreeOp};
17
use crate::oplog::{Format1Op, Op, View, SNAPSHOT_SUFFIX};
18
use crate::state::{FileContent, Snapshot, State};
19
use crate::store::{Store, StoreError};
20
use crate::tree::OpKey;
21
use rand::RngCore;
22
use std::collections::{BTreeMap, BTreeSet, HashMap};
23
use std::fs;
24
use std::io::Write;
25
use std::path::{Path, PathBuf};
26
27
pub const OXY_DIR: &str = ".oxy";
28
pub const FORMAT_LINE: &str = "oxy repository format 2\n";
29
const FORMAT1_LINE: &str = "oxy repository format 1\n";
30
const BINARY_SNIFF: usize = 8 * 1024;
31
/// Loose objects tolerated before a commit packs them (spec §13.4).
32
pub const AUTOPACK_THRESHOLD: usize = 4096;
33
34
#[derive(Debug, thiserror::Error)]
35
pub enum RepoError {
36
    #[error("io: {0}")]
37
    Io(#[from] std::io::Error),
38
    #[error(transparent)]
39
    Store(#[from] StoreError),
40
    #[error(transparent)]
41
    Object(#[from] crate::objects::ObjectError),
42
    #[error(transparent)]
43
    State(#[from] crate::state::StateError),
44
    #[error("{0}")]
45
    Msg(String),
46
}
47
48
pub type Result<T> = std::result::Result<T, RepoError>;
49
50
fn fail<T>(s: impl Into<String>) -> Result<T> {
51
    Err(RepoError::Msg(s.into()))
52
}
53
54
mod checkout;
55
mod checkpoint;
56
mod config;
57
mod gc;
58
mod git;
59
mod history;
60
mod hooks;
61
mod identity;
62
mod policy;
63
mod prompt;
64
mod snapshot;
65
mod sync;
66
mod tags;
67
mod workspace;
68
#[cfg(test)]
69
mod tests;
70
71
pub use checkout::CheckoutReport;
72
pub use config::{parse_size, read_config_file, Config};
73
pub use gc::GcReport;
74
pub use hooks::{json_array, json_str, HookOutcome};
75
pub use prompt::{PromptInfo, DEFAULT_PROMPT_FORMAT};
76
pub use git::{GitExportReport, GitImportReport};
77
pub use identity::{Rotation, SignatureStatus};
78
pub use policy::PolicyUpdate;
79
pub use snapshot::{added_node_paths, has_conflict_markers, is_binary, referenced_changes, render_change, similarity, ChangeStatus, PathStatus, SnapshotResult};
80
pub use sync::{FetchReport, PullReport};
81
pub use tags::TagInfo;
82
pub use workspace::{SnapshotLock, WorkspaceInfo};
83
84
fn write_atomic(path: &Path, data: &[u8]) -> Result<()> {
85
    let tmp = path.with_extension("tmp");
86
    {
87
        let mut f = fs::File::create(&tmp)?;
88
        f.write_all(data)?;
89
        f.sync_all()?;
90
    }
91
    fs::rename(&tmp, path)?;
92
    Ok(())
93
}
94
95
pub struct LogEntry {
96
    pub hash: ChangeHash,
97
    /// Metadata from the state; the full change may be absent in a shallow repository.
98
    pub change: crate::state::ChangeMeta,
99
    pub is_working_copy: bool,
100
    pub is_head: bool,
101
}
102
103
/// A file as found on disk or in an imported tree.
104
pub(crate) struct FsEntry {
105
    pub kind: NodeKind,
106
    pub exec: bool,
107
    /// File content, or a symlink's target. Empty when `blob` is set.
108
    pub content: Vec<u8>,
109
    /// The stored blob of an opaque file whose size and mtime are unchanged
110
    /// since the last manifest (spec §12.3 stat cache); the content was not
111
    /// read.
112
    pub blob: Option<ObjectRef>,
113
    /// BLAKE3 of the content, carried over from the manifest when the stat
114
    /// is unchanged, so the manifest can be rewritten without rehashing.
115
    pub content_hash: Option<String>,
116
}
117
118
impl FsEntry {
119
    pub(crate) fn new(kind: NodeKind, exec: bool, content: Vec<u8>) -> FsEntry {
120
        FsEntry { kind, exec, content, blob: None, content_hash: None }
121
    }
122
}
123
124
pub struct Repo {
125
    root: PathBuf,
126
    oxy: PathBuf,
127
    store: Store,
128
    workspace: WorkspaceId,
129
    keys_dir: PathBuf,
130
    user_config: PathBuf,
131
    pub config: Config,
132
}
133
134
/// The user's oxy directory: `$OXY_HOME`, else `$XDG_CONFIG_HOME/oxy`, else
135
/// `~/.config/oxy`. It holds `config.toml` (spec §19) and `keys/`.
136
pub fn default_home() -> PathBuf {
137
    if let Ok(h) = std::env::var("OXY_HOME") {
138
        return PathBuf::from(h);
139
    }
140
    if let Ok(x) = std::env::var("XDG_CONFIG_HOME") {
141
        return PathBuf::from(x).join("oxy");
142
    }
143
    let home = std::env::var("HOME").unwrap_or_else(|_| ".".into());
144
    PathBuf::from(home).join(".config").join("oxy")
145
}
146
147
pub fn default_keys_dir() -> PathBuf {
148
    default_home().join("keys")
149
}
150
151
pub fn default_user_config() -> PathBuf {
152
    default_home().join("config.toml")
153
}
154
155
/// Where `create_identity` records the author.
156
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
157
pub enum IdentityScope {
158
    /// The user file: every repository of this user signs with it.
159
    User,
160
    /// This repository only.
161
    Repo,
162
}
163
164
impl Repo {
165
    // ------------------------------------------------------------ lifecycle
166
167
    pub fn init(root: &Path) -> Result<Repo> {
168
        let mut id = [0u8; 16];
169
        rand::rngs::OsRng.fill_bytes(&mut id);
170
        Self::init_with_id(root, id)
171
    }
172
173
    /// Initialize a repository with a given repository ID (clones share the
174
    /// ID of their origin, spec §14.4).
175
    pub fn init_with_id(root: &Path, id: [u8; 16]) -> Result<Repo> {
176
        fs::create_dir_all(root)?;
177
        let root = root.canonicalize().unwrap_or_else(|_| root.to_path_buf());
178
        let oxy = root.join(OXY_DIR);
179
        if oxy.exists() {
180
            return fail(format!("{} is already an oxy repository", root.display()));
181
        }
182
        fs::create_dir_all(oxy.join("ops"))?;
183
        write_atomic(&oxy.join("format"), FORMAT_LINE.as_bytes())?;
184
        write_atomic(&oxy.join("id"), hex::encode(id).as_bytes())?;
185
        let config = Config::load(Some(&default_user_config()), &oxy.join("config"))?;
186
        config.save(&oxy.join("config"))?;
187
        let workspace = WorkspaceId::random();
188
        write_atomic(&oxy.join("workspace"), workspace.to_hex().as_bytes())?;
189
        let store = Store::open(oxy.join("objects"))?;
190
        let repo = Repo { root, oxy, store, workspace, keys_dir: default_keys_dir(), user_config: default_user_config(), config };
191
        repo.register_workspace(&workspace, &repo.root)?;
192
193
        let wc = repo.new_working_copy(vec![], "");
194
        let wc_hash = repo.store.put_change(&wc)?;
195
        let mut view = View::default();
196
        view.bookmarks.insert(repo.config.bookmark.clone(), repo.store.put_state(&StateObject::new(vec![]))?);
197
        view.workspaces.insert(workspace, wc_hash);
198
        repo.record_op(&[], "oxy init", view)?;
199
        Ok(repo)
200
    }
201
202
    /// Open the repository containing `start` (searching upwards).
203
    pub fn open(start: &Path) -> Result<Repo> {
204
        let start = start.canonicalize()?;
205
        let mut dir: Option<&Path> = Some(&start);
206
        while let Some(d) = dir {
207
            let oxy = d.join(OXY_DIR);
208
            if oxy.is_file() {
209
                // A secondary workspace (spec §12.2): the file points at the repository.
210
                let text = fs::read_to_string(&oxy)?;
211
                let Some((shared, workspace)) = workspace::parse_workspace_file(&text) else {
212
                    return fail(format!("{} is not a valid workspace file", oxy.display()));
213
                };
214
                let format = fs::read_to_string(shared.join("format"))?;
215
                if format != FORMAT_LINE {
216
                    return fail(format!("unsupported repository format: {}", format.trim()));
217
                }
218
                let config = Config::load(Some(&default_user_config()), &shared.join("config"))?;
219
                let store = Store::open(shared.join("objects"))?;
220
                return Ok(Repo { root: d.to_path_buf(), oxy: shared, store, workspace, keys_dir: default_keys_dir(), user_config: default_user_config(), config });
221
            }
222
            if oxy.is_dir() {
223
                let format = fs::read_to_string(oxy.join("format"))?;
224
                let config = Config::load(Some(&default_user_config()), &oxy.join("config"))?;
225
                let workspace = WorkspaceId::from_hex(fs::read_to_string(oxy.join("workspace"))?.trim())
226
                    .ok_or_else(|| RepoError::Msg("corrupt .oxy/workspace".into()))?;
227
                let store = Store::open(oxy.join("objects"))?;
228
                let repo = Repo { root: d.to_path_buf(), oxy, store, workspace, keys_dir: default_keys_dir(), user_config: default_user_config(), config };
229
                if format == FORMAT1_LINE {
230
                    repo.migrate_format1()?;
231
                } else if format != FORMAT_LINE {
232
                    return fail(format!("unsupported repository format: {}", format.trim()));
233
                }
234
                return Ok(repo);
235
            }
236
            dir = d.parent();
237
        }
238
        fail(format!("no oxy repository found at or above {}", start.display()))
239
    }
240
241
    /// Rewrite a format-1 operation log, whose bookmarks were head lists,
242
    /// into format 2, where each bookmark names a `state` object.
243
    fn migrate_format1(&self) -> Result<()> {
244
        let hex = fs::read_to_string(self.oxy.join("ops").join("head"))?;
245
        let head = ObjectRef::from_hex(hex.trim()).ok_or_else(|| RepoError::Msg("corrupt .oxy/ops/head".into()))?;
246
        // Collect the chain root-first.
247
        let mut chain: Vec<Format1Op> = Vec::new();
248
        let mut cur = Some(head);
249
        while let Some(r) = cur {
250
            let op = Op::decode_format1(&self.store.get_typed(&r, ObjectType::Op)?)?;
251
            cur = op.parents.first().copied();
252
            chain.push(op);
253
        }
254
        chain.reverse();
255
        let mut new_parent: Option<ObjectRef> = None;
256
        for old in chain {
257
            let mut view = View::default();
258
            for (name, heads) in &old.view.bookmarks {
259
                view.bookmarks.insert(name.clone(), self.store.put_state(&StateObject::new(heads.clone()))?);
260
            }
261
            view.workspaces = old.view.workspaces.clone();
262
            let op = Op { parents: new_parent.into_iter().collect(), hlc: old.hlc, command: old.command, view };
263
            new_parent = Some(self.store.put(ObjectType::Op, &op.encode())?);
264
        }
265
        write_atomic(&self.oxy.join("ops").join("head"), new_parent.unwrap().to_hex().as_bytes())?;
266
        write_atomic(&self.oxy.join("format"), FORMAT_LINE.as_bytes())?;
267
        Ok(())
268
    }
269
270
    /// Pack automatically once many loose objects have accumulated.
271
    pub(crate) fn maybe_autopack(&self) -> Result<()> {
272
        if self.store.loose_count()? > AUTOPACK_THRESHOLD {
273
            self.store.pack_loose()?;
274
            self.store.merge_packs()?;
275
        }
276
        Ok(())
277
    }
278
279
    /// The repository ID (spec §14.4). Repositories made before IDs existed get one on first use.
280
    pub fn id(&self) -> Result<[u8; 16]> {
281
        let path = self.oxy.join("id");
282
        match fs::read_to_string(&path) {
283
            Ok(h) => hex::decode(h.trim()).ok().and_then(|v| v.try_into().ok()).ok_or_else(|| RepoError::Msg("corrupt .oxy/id".into())),
284
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => {
285
                let mut id = [0u8; 16];
286
                rand::rngs::OsRng.fill_bytes(&mut id);
287
                write_atomic(&path, hex::encode(id).as_bytes())?;
288
                Ok(id)
289
            }
290
            Err(e) => Err(e.into()),
291
        }
292
    }
293
294
    pub fn root(&self) -> &Path {
295
        &self.root
296
    }
297
    pub fn store(&self) -> &Store {
298
        &self.store
299
    }
300
    pub fn workspace(&self) -> WorkspaceId {
301
        self.workspace
302
    }
303
304
    /// Use a different user directory for keys and the user config file
305
    /// (tests, or `$OXY_HOME`). Reloads the effective configuration.
306
    pub fn with_home(mut self, dir: impl Into<PathBuf>) -> Repo {
307
        let dir = dir.into();
308
        self.keys_dir = dir.join("keys");
309
        self.user_config = dir.join("config.toml");
310
        if let Ok(c) = Config::load(Some(&self.user_config), &self.oxy.join("config")) {
311
            self.config = c;
312
        }
313
        self
314
    }
315
316
    pub fn user_config_path(&self) -> &Path {
317
        &self.user_config
318
    }
319
320
    /// Set a key in the user file and refresh the effective configuration.
321
    pub fn set_user_config(&mut self, key: &str, value: &str) -> Result<()> {
322
        Config::set_user(&self.user_config, key, value)?;
323
        self.config = Config::load(Some(&self.user_config), &self.oxy.join("config"))?;
324
        Ok(())
325
    }
326
327
    pub fn save_config(&self) -> Result<()> {
328
        self.config.save(&self.oxy.join("config"))
329
    }
330
331
    fn author(&self) -> KeyId {
332
        self.config.author_key.unwrap_or(ObjectRef::ZERO)
333
    }
334
}
335
336
impl Repo {
337
    fn new_working_copy(&self, deps: Vec<ChangeHash>, message: &str) -> Change {
338
        let mut c = Change {
339
            change_id: ChangeId::random(),
340
            deps,
341
            author: self.author(),
342
            hlc: Hlc::now(),
343
            message: message.into(),
344
            tree_ops: vec![],
345
            edits: vec![],
346
            kind: ChangeKind::WorkingCopy,
347
        };
348
        c.normalize();
349
        c
350
    }
351
352
    // ------------------------------------------------------------ operation log
353
354
    pub fn head_op(&self) -> Result<(ObjectRef, Op)> {
355
        let hex = fs::read_to_string(self.oxy.join("ops").join("head"))?;
356
        let r = ObjectRef::from_hex(hex.trim()).ok_or_else(|| RepoError::Msg("corrupt .oxy/ops/head".into()))?;
357
        let op = Op::decode(&self.store.get_typed(&r, ObjectType::Op)?)?;
358
        Ok((r, op))
359
    }
360
361
    pub fn view(&self) -> Result<View> {
362
        Ok(self.head_op()?.1.view)
363
    }
364
365
    fn record_op(&self, parents: &[ObjectRef], command: &str, view: View) -> Result<ObjectRef> {
366
        let op = Op { parents: parents.to_vec(), hlc: Hlc::now(), command: command.into(), view };
367
        let r = self.store.put(ObjectType::Op, &op.encode())?;
368
        write_atomic(&self.oxy.join("ops").join("head"), r.to_hex().as_bytes())?;
369
        Ok(r)
370
    }
371
372
    pub fn op_log(&self) -> Result<Vec<(ObjectRef, Op)>> {
373
        let mut out = Vec::new();
374
        let (mut r, mut op) = self.head_op()?;
375
        loop {
376
            let next = op.parents.first().copied();
377
            out.push((r, op));
378
            match next {
379
                Some(p) => {
380
                    r = p;
381
                    op = Op::decode(&self.store.get_typed(&r, ObjectType::Op)?)?;
382
                }
383
                None => break,
384
            }
385
        }
386
        Ok(out)
387
    }
388
389
    /// Undo the last user command (spec §12.1). Operations that only recorded
390
    /// a working-copy snapshot are skipped, since the files are still on disk
391
    /// and the next snapshot recreates them.
392
    pub fn undo(&self) -> Result<Op> {
393
        let (_, mut op) = self.head_op()?;
394
        while op.is_snapshot() {
395
            let Some(parent) = op.parents.first() else { break };
396
            op = Op::decode(&self.store.get_typed(parent, ObjectType::Op)?)?;
397
        }
398
        let Some(parent) = op.parents.first() else {
399
            return fail("nothing to undo");
400
        };
401
        let parent_op = Op::decode(&self.store.get_typed(parent, ObjectType::Op)?)?;
402
        write_atomic(&self.oxy.join("ops").join("head"), parent.to_hex().as_bytes())?;
403
        self.drop_manifest();
404
        Ok(parent_op)
405
    }
406
407
    /// The last operation that was not a snapshot.
408
    pub fn last_command(&self) -> Result<Op> {
409
        let (_, mut op) = self.head_op()?;
410
        while op.is_snapshot() {
411
            let Some(parent) = op.parents.first() else { break };
412
            op = Op::decode(&self.store.get_typed(parent, ObjectType::Op)?)?;
413
        }
414
        Ok(op)
415
    }
416
417
    // ------------------------------------------------------------ states
418
419
    /// Load the dependency closure of `heads`, through a checkpoint when one applies.
420
    pub fn load_state(&self, heads: &[ChangeHash]) -> Result<State> {
421
        if let Some(st) = self.load_state_checkpointed(heads)? {
422
            return Ok(st);
423
        }
424
        self.load_state_full(heads)
425
    }
426
427
    /// Load the dependency closure of `heads` change by change.
428
    pub fn load_state_full(&self, heads: &[ChangeHash]) -> Result<State> {
429
        let mut state = State::new();
430
        let mut stack: Vec<ChangeHash> = heads.to_vec();
431
        let mut seen: BTreeSet<ChangeHash> = BTreeSet::new();
432
        while let Some(h) = stack.pop() {
433
            if !seen.insert(h) {
434
                continue;
435
            }
436
            let c = self.store.get_change(&h)?;
437
            stack.extend(c.deps.iter().copied());
438
            state.add_unchecked(c);
439
        }
440
        state.validate()?;
441
        Ok(state)
442
    }
443
444
    pub fn working_copy(&self) -> Result<(ChangeHash, Change)> {
445
        let view = self.view()?;
446
        let h = *view
447
            .workspaces
448
            .get(&self.workspace)
449
            .ok_or_else(|| RepoError::Msg("this workspace is not in the current view".into()))?;
450
        Ok((h, self.store.get_change(&h)?))
451
    }
452
453
    /// Heads of a bookmark's state (spec §10.1).
454
    pub fn heads_of(&self, view: &View, bookmark: &str) -> Result<Vec<ChangeHash>> {
455
        match view.bookmarks.get(bookmark) {
456
            Some(st) => Ok(self.store.get_state(st)?.heads),
457
            None => Ok(vec![]),
458
        }
459
    }
460
461
    pub fn bookmark_heads(&self) -> Result<Vec<ChangeHash>> {
462
        self.heads_of(&self.view()?, &self.config.bookmark)
463
    }
464
465
    // ------------------------------------------------------------ blobs
466
467
    fn blob_for(content: &[u8]) -> Blob {
468
        Blob {
469
            length: content.len() as u64,
470
            chunks: crate::chunk::chunks(content).into_iter().map(|c| hash_object(ObjectType::Chunk, c)).collect(),
471
        }
472
    }
473
474
    pub fn blob_ref(content: &[u8]) -> ObjectRef {
475
        Self::blob_for(content).hash()
476
    }
477
478
    pub fn store_blob(&self, content: &[u8]) -> Result<ObjectRef> {
479
        for c in crate::chunk::chunks(content) {
480
            self.store.put_chunk(c)?;
481
        }
482
        Ok(self.store.put(ObjectType::Blob, &Self::blob_for(content).encode())?)
483
    }
484
485
    /// Read a blob's content, fetching it from the remote that withheld it
486
    /// when it is lazily absent (spec §13.5).
487
    pub fn read_blob(&self, r: &ObjectRef) -> Result<Vec<u8>> {
488
        if !self.store.has(r) && self.lazy_remote(r).is_some() {
489
            self.fetch_lazy_blob(r)?;
490
        }
491
        let blob = Blob::decode(&self.store.get_typed(r, ObjectType::Blob)?)?;
492
        let mut out = Vec::with_capacity(blob.length as usize);
493
        for c in &blob.chunks {
494
            out.extend(self.store.get_typed(c, ObjectType::Chunk)?);
495
        }
496
        Ok(out)
497
    }
498
499
    // ------------------------------------------------------------ working copy
500
501
    /// Attributes from the `.oxyattributes` files in the working directory.
502
    pub fn disk_attributes(&self) -> crate::attributes::Attributes {
503
        let mut files: Vec<(String, Vec<u8>)> = Vec::new();
504
        if let Ok(b) = fs::read(self.root.join(".oxyattributes")) {
505
            files.push((".oxyattributes".into(), b));
506
        }
507
        let mut wb = ignore::WalkBuilder::new(&self.root);
508
        wb.hidden(false).git_ignore(false).git_global(false).git_exclude(false).require_git(false).follow_links(false).add_custom_ignore_filename(".oxyignore");
509
        wb.filter_entry(|e| e.file_name() != OXY_DIR);
510
        for entry in wb.build().flatten() {
511
            if entry.file_name() == ".oxyattributes" && entry.path() != self.root.join(".oxyattributes") {
512
                if let Ok(b) = fs::read(entry.path()) {
513
                    let rel: String = entry.path().strip_prefix(&self.root).unwrap().components().map(|c| c.as_os_str().to_string_lossy().to_string()).collect::<Vec<_>>().join("/");
514
                    files.push((rel, b));
515
                }
516
            }
517
        }
518
        crate::attributes::Attributes::from_files(files.iter().map(|(p, c)| (p.as_str(), c.as_slice())))
519
    }
520
521
    /// Attributes from a materialized state's `.oxyattributes` files.
522
    pub fn state_attributes(snapshot: &Snapshot) -> crate::attributes::Attributes {
523
        crate::attributes::Attributes::from_files(snapshot.files.iter().filter_map(|(p, f)| match &f.content {
524
            FileContent::Text { bytes, .. } if p == ".oxyattributes" || p.ends_with("/.oxyattributes") => Some((p.as_str(), bytes.as_slice())),
525
            _ => None,
526
        }))
527
    }
528
529
    /// Store a blob, raw when the path is `nocompress`.
530
    pub fn store_blob_for(&self, content: &[u8], nocompress: bool) -> Result<ObjectRef> {
531
        if !nocompress {
532
            return self.store_blob(content);
533
        }
534
        for c in crate::chunk::chunks(content) {
535
            self.store.put_chunk_nocompress(c)?;
536
        }
537
        Ok(self.store.put(ObjectType::Blob, &Self::blob_for(content).encode())?)
538
    }
539
540
    fn locks_dir(&self) -> PathBuf {
541
        self.oxy.join("locks")
542
    }
543
544
    /// Whether `path` is locked locally for editing (spec §18, advisory).
545
    pub fn is_locked(&self, path: &str) -> bool {
546
        self.locks_dir().join(path.replace('/', "%2F")).exists()
547
    }
548
549
    /// Take the advisory local lock on a `lockable` file and make it writable.
550
    pub fn lock_path(&self, path: &str) -> Result<()> {
551
        let attrs = self.disk_attributes();
552
        if !attrs.lookup(path).lockable {
553
            return fail(format!("{path} is not marked lockable in .oxyattributes"));
554
        }
555
        fs::create_dir_all(self.locks_dir())?;
556
        write_atomic(&self.locks_dir().join(path.replace('/', "%2F")), std::process::id().to_string().as_bytes())?;
557
        set_readonly(&self.root.join(path), false)?;
558
        Ok(())
559
    }
560
561
    /// Release the local lock and make the file read-only again.
562
    pub fn unlock_path(&self, path: &str) -> Result<()> {
563
        let _ = fs::remove_file(self.locks_dir().join(path.replace('/', "%2F")));
564
        if self.root.join(path).exists() {
565
            set_readonly(&self.root.join(path), true)?;
566
        }
567
        Ok(())
568
    }
569
570
    /// Whether a repository path is inside the sparse filter (spec §17).
571
    pub fn in_scope(&self, path: &str) -> bool {
572
        self.config.sparse_paths.is_empty() || self.config.sparse_paths.iter().any(|p| path == p || path.starts_with(&format!("{p}/")))
573
    }
574
575
    fn walk_working_copy(&self) -> Result<BTreeMap<String, FsEntry>> {
576
        self.walk_working_copy_with(None, &BTreeSet::new())
577
    }
578
579
    /// Walk the working copy; with a manifest, a file whose size and mtime
580
    /// match it is not read: an opaque file yields its known blob, a text
581
    /// file is read but keeps its known hash. Files modified within two
582
    /// seconds of the manifest are never trusted (a racy stat).
583
    ///
584
    /// `.oxyignore` applies to untracked paths only: every path in `tracked`
585
    /// (the base state's files) that exists on disk is included even when
586
    /// an ignore rule matches it, as in Git.
587
    fn walk_working_copy_with(&self, cache: Option<&prompt::Manifest>, tracked: &BTreeSet<String>) -> Result<BTreeMap<String, FsEntry>> {
588
        let mut wb = ignore::WalkBuilder::new(&self.root);
589
        wb.hidden(false)
590
            .git_ignore(false)
591
            .git_global(false)
592
            .git_exclude(false)
593
            .require_git(false)
594
            .follow_links(false)
595
            .add_custom_ignore_filename(".oxyignore");
596
        wb.filter_entry(|e| e.file_name() != OXY_DIR);
597
        let mut out = BTreeMap::new();
598
        for entry in wb.build() {
599
            let entry = entry.map_err(|e| RepoError::Msg(e.to_string()))?;
600
            let path = entry.path();
601
            if path == self.root {
602
                continue;
603
            }
604
            let rel = path.strip_prefix(&self.root).unwrap();
605
            let rel: String = rel.components().map(|c| c.as_os_str().to_string_lossy().to_string()).collect::<Vec<_>>().join("/");
606
            let Some(ft) = entry.file_type() else { continue };
607
            if ft.is_dir() || !self.in_scope(&rel) {
608
                continue;
609
            }
610
            if ft.is_symlink() {
611
                let target = fs::read_link(path)?;
612
                out.insert(rel, FsEntry::new(NodeKind::Symlink, false, target.to_string_lossy().as_bytes().to_vec()));
613
            } else if ft.is_file() {
614
                let meta = entry.metadata().map_err(|e| RepoError::Msg(e.to_string()))?;
615
                let e = self.file_entry(&rel, path, &meta, cache)?;
616
                out.insert(rel, e);
617
            }
618
        }
619
        // Tracked paths the ignore rules hid.
620
        for rel in tracked {
621
            if out.contains_key(rel) || !self.in_scope(rel) {
622
                continue;
623
            }
624
            let path = self.root.join(rel);
625
            let Ok(meta) = fs::symlink_metadata(&path) else { continue };
626
            let ft = meta.file_type();
627
            if ft.is_symlink() {
628
                let target = fs::read_link(&path)?;
629
                out.insert(rel.clone(), FsEntry::new(NodeKind::Symlink, false, target.to_string_lossy().as_bytes().to_vec()));
630
            } else if ft.is_file() {
631
                let e = self.file_entry(rel, &path, &meta, cache)?;
632
                out.insert(rel.clone(), e);
633
            }
634
        }
635
        Ok(out)
636
    }
637
638
    /// The entry for one regular file, read or served from the stat cache.
639
    fn file_entry(&self, rel: &str, path: &Path, meta: &fs::Metadata, cache: Option<&prompt::Manifest>) -> Result<FsEntry> {
640
        let exec = is_executable(meta);
641
        let cached = cache.and_then(|m| {
642
            let e = m.entries.get(rel)?;
643
            let mtime_ns = prompt::mtime_ns(meta);
644
            let racy = mtime_ns + 2_000_000_000 >= m.written_ns;
645
            (e.size == meta.len() && e.mtime_ns == mtime_ns && !racy).then_some(e)
646
        });
647
        Ok(match cached {
648
            Some(e) if e.blob.is_some_and(|b| self.store.has(&b)) => FsEntry { kind: NodeKind::File, exec, content: vec![], blob: e.blob, content_hash: Some(e.hash.clone()) },
649
            Some(e) => FsEntry { kind: NodeKind::File, exec, content: fs::read(path)?, blob: None, content_hash: Some(e.hash.clone()) },
650
            None => FsEntry::new(NodeKind::File, exec, fs::read(path)?),
651
        })
652
    }
653
654
    /// The non-directory paths of a snapshot, for the walker's `tracked` set.
655
    pub(crate) fn tracked_paths(snapshot: &Snapshot) -> BTreeSet<String> {
656
        snapshot.files.iter().filter(|(_, f)| f.kind != NodeKind::Dir).map(|(p, _)| p.clone()).collect()
657
    }
658
}
659
660
impl Repo {
661
    /// Changes reachable from the bookmark and the working copy, newest first.
662
    pub fn log(&self) -> Result<Vec<LogEntry>> {
663
        let (wc_hash, _) = self.working_copy()?;
664
        let mut heads = self.bookmark_heads()?;
665
        heads.push(wc_hash);
666
        let state = self.load_state(&heads)?;
667
        let head_set: BTreeSet<ChangeHash> = self.bookmark_heads()?.into_iter().collect();
668
        let mut entries: Vec<LogEntry> = Vec::new();
669
        for (h, meta) in state.changes() {
670
            entries.push(LogEntry { hash: *h, change: meta.clone(), is_working_copy: *h == wc_hash, is_head: head_set.contains(h) });
671
        }
672
        entries.sort_by(|a, b| b.is_working_copy.cmp(&a.is_working_copy).then(b.change.hlc.cmp(&a.change.hlc)).then(b.hash.cmp(&a.hash)));
673
        Ok(entries)
674
    }
675
676
    /// Resolve a spec to a set of heads: a tag name, the current bookmark's
677
    /// name, or a single change (`resolve_change`).
678
    pub fn resolve_heads(&self, spec: &str) -> Result<Vec<ChangeHash>> {
679
        if spec == self.config.bookmark {
680
            return self.bookmark_heads();
681
        }
682
        if let Some(heads) = self.tag_heads(spec)? {
683
            return Ok(heads);
684
        }
685
        Ok(vec![self.resolve_change(spec)?])
686
    }
687
688
    /// Resolve a change by ChangeId prefix, `#hash` prefix, `@` (working copy), or bookmark.
689
    pub fn resolve_change(&self, spec: &str) -> Result<ChangeHash> {
690
        if spec == "@" {
691
            return Ok(self.working_copy()?.0);
692
        }
693
        if spec.is_empty() || spec == "#" {
694
            return fail("empty change specifier");
695
        }
696
        let entries = self.log()?;
697
        let matches: Vec<&LogEntry> = if let Some(hp) = spec.strip_prefix('#') {
698
            entries.iter().filter(|e| e.hash.starts_with_hex(hp)).collect()
699
        } else {
700
            entries.iter().filter(|e| e.change.change_id.starts_with_hex(spec)).collect()
701
        };
702
        match matches.len() {
703
            1 => Ok(matches[0].hash),
704
            0 => fail(format!("no change matches {spec:?}")),
705
            _ => {
706
                let ids: BTreeSet<ChangeId> = matches.iter().map(|e| e.change.change_id).collect();
707
                if ids.len() == 1 {
708
                    fail(format!("change {spec} is divergent: {} variants", matches.len()))
709
                } else {
710
                    fail(format!("{spec:?} is ambiguous"))
711
                }
712
            }
713
        }
714
    }
715
716
    /// Human-readable description of what a change does, with line content.
717
    pub fn describe_change(&self, hash: &ChangeHash) -> Result<String> {
718
        let change = self.store.get_change(hash)?;
719
        let base = self.load_state(&change.deps)?;
720
        let base_snapshot = base.materialize();
721
        Ok(render_change(&change, &base, &base_snapshot))
722
    }
723
}
724
725
fn remove_any(path: &Path) -> std::io::Result<()> {
726
    let m = fs::symlink_metadata(path)?;
727
    if m.is_dir() { fs::remove_dir_all(path) } else { fs::remove_file(path) }
728
}
729
730
fn set_readonly(path: &Path, readonly: bool) -> std::io::Result<()> {
731
    let mut perms = fs::metadata(path)?.permissions();
732
    perms.set_readonly(readonly);
733
    fs::set_permissions(path, perms)
734
}
735
736
#[cfg(unix)]
737
fn set_executable(path: &Path, exec: bool) -> std::io::Result<()> {
738
    use std::os::unix::fs::PermissionsExt;
739
    let mut perms = fs::metadata(path)?.permissions();
740
    let mode = perms.mode();
741
    let want = if exec { mode | 0o111 } else { mode & !0o111 };
742
    if want != mode {
743
        perms.set_mode(want);
744
        fs::set_permissions(path, perms)?;
745
    }
746
    Ok(())
747
}
748
#[cfg(not(unix))]
749
fn set_executable(_path: &Path, _exec: bool) -> std::io::Result<()> {
750
    Ok(())
751
}
752
753
#[cfg(unix)]
754
fn is_executable(m: &fs::Metadata) -> bool {
755
    use std::os::unix::fs::PermissionsExt;
756
    m.permissions().mode() & 0o111 != 0
757
}
758
#[cfg(not(unix))]
759
fn is_executable(_m: &fs::Metadata) -> bool {
760
    false
761
}
762
763
fn op_ref(k: OpKey) -> OpRef {
764
    OpRef { change: k.0, index: k.1 }
765
}
766
767
fn split_path(path: &str) -> (&str, &str) {
768
    match path.rfind('/') {
769
        Some(i) => (&path[..i], &path[i + 1..]),
770
        None => ("", path),
771
    }
772
}