OXYGENHUB
# aedfe465b611 oxygen / src / cli / sync.rs
34.6 KiB · Rust · last changed Push a long history in parts 26 days ago source blame history raw
fce44ae9 Andy McCall ↶ 1
//! Commands that talk to remotes, and the reference server.
2
3
use super::format::plural;
75167672 Andy McCall 4
use super::json;
fce44ae9 Andy McCall ↶ 5
use super::open;
135212de Andy McCall ↶ 6
use super::ui;
fce44ae9 Andy McCall ↶ 7
use anyhow::{Context, Result};
8
use oxy_core::repo::Repo;
9
use std::path::PathBuf;
10
75167672 Andy McCall 11
pub fn clone(
12
    url: &str,
13
    dest: Option<PathBuf>,
14
    max_blob: Option<&str>,
15
    sparse: &[String],
16
    depth: Option<u32>,
14edbaaf Andy McCall ↶ 17
    recursive: bool,
75167672 Andy McCall 18
) -> Result<i32> {
fce44ae9 Andy McCall ↶ 19
    let dest = dest.unwrap_or_else(|| {
75167672 Andy McCall 20
        let base = url
21
            .trim_end_matches('/')
22
            .rsplit('/')
23
            .next()
24
            .unwrap_or("repo");
fce44ae9 Andy McCall ↶ 25
        PathBuf::from(base)
26
    });
b3c5a59a Andy McCall ↶ 27
    let max_blob = max_blob.map(oxy_core::repo::parse_size).transpose()?;
135212de Andy McCall ↶ 28
    let sp = ui::spinner(&format!("Cloning {url}…"));
2863456a Andy McCall ↶ 29
    let repo = match depth {
30
        Some(d) => Repo::clone_shallow(url, &dest, d, max_blob, sparse)?,
31
        None => Repo::clone_with(url, &dest, max_blob, sparse)?,
32
    };
fce44ae9 Andy McCall ↶ 33
    let heads = repo.bookmark_heads()?;
75167672 Andy McCall 34
    sp.done(&format!(
35
        "{} into {} {}",
36
        ui::done("Cloned"),
37
        ui::path(repo.root().display()),
38
        ui::dim(format!(
39
            "({url}, {} with {})",
40
            ui::bookmark(&repo.config.bookmark),
41
            plural(heads.len(), "head")
42
        ))
43
    ));
14edbaaf Andy McCall ↶ 44
    let others = repo.remote_only_bookmarks()?.len();
45
    if others > 0 {
46
        println!(
47
            "  {} {}",
48
            ui::note(),
49
            ui::dim(format!(
50
                "origin has {} more: oxy bookmark list --all, then oxy bookmark switch NAME",
51
                plural(others, "bookmark")
52
            ))
53
        );
54
    }
55
    let subrepos = repo.subrepos()?.len();
56
    if subrepos == 0 {
57
        return Ok(0);
58
    }
59
    if recursive {
60
        let sp = ui::spinner("Cloning subrepos…");
61
        let results = repo.submodule_update(true, &[])?;
62
        sp.clear();
63
        return Ok(print_subrepo_results(results));
64
    }
65
    println!(
66
        "  {} {}",
67
        ui::note(),
68
        ui::dim(format!(
69
            "{} not cloned: oxy submodule update --init (or clone with --recursive)",
70
            plural(subrepos, "subrepo")
71
        ))
72
    );
fce44ae9 Andy McCall ↶ 73
    Ok(0)
74
}
75
14edbaaf Andy McCall ↶ 76
/// After a switch or pull: say when subrepos are not at their pins.
77
pub fn subrepos_behind(repo: &Repo) {
78
    let Ok(subs) = repo.subrepos() else {
79
        return;
80
    };
81
    let stale = subs
82
        .iter()
83
        .filter(|s| s.committed && s.actual.as_ref() != Some(&s.pin))
84
        .count();
85
    if stale > 0 {
86
        println!(
87
            "  {} {}",
88
            ui::note(),
89
            ui::dim(format!(
90
                "{} not at {} pin: oxy submodule update --init",
91
                plural(stale, "subrepo"),
92
                if stale == 1 { "its" } else { "their" }
93
            ))
94
        );
95
    }
96
}
97
9aa39904 Andy McCall ↶ 98
/// Whether a URL names a store (a bucket or a directory in the store
99
/// layout) rather than a repository.
100
fn is_store_url(url: &str) -> bool {
101
    ["s3://", "gs://", "az://", "dir://"]
102
        .iter()
103
        .any(|p| url.starts_with(p))
104
}
105
106
/// Percent-encode what would break a query parameter.
107
fn encode_param(v: &str) -> String {
108
    let mut out = String::with_capacity(v.len());
109
    for b in v.bytes() {
110
        match b {
111
            b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b'.' | b'~' | b'/' | b':' => {
112
                out.push(b as char)
113
            }
114
            _ => out.push_str(&format!("%{b:02X}")),
115
        }
116
    }
117
    out
118
}
119
120
/// A store URL with settings added as query parameters, which is where a
121
/// store remote keeps them (`s3://b/p?profile=work&region=eu-west-2`).
122
fn url_with_settings(url: &str, settings: &[(&str, Option<String>)]) -> Result<String> {
123
    let given: Vec<(&str, &str)> = settings
124
        .iter()
125
        .filter_map(|(k, v)| v.as_deref().map(|v| (*k, v)))
126
        .collect();
127
    if given.is_empty() {
128
        return Ok(url.to_string());
129
    }
130
    if !is_store_url(url) || url.starts_with("dir://") {
131
        let names: Vec<String> = given.iter().map(|(k, _)| format!("--{k}")).collect();
132
        anyhow::bail!(
133
            "{} apply to a store remote (s3://, gs://, az://), not to {url}",
134
            names.join(", ")
135
        );
136
    }
137
    let mut out = url.to_string();
138
    for (k, v) in given {
139
        out.push(if out.contains('?') { '&' } else { '?' });
140
        out.push_str(k);
141
        out.push('=');
142
        out.push_str(&encode_param(v));
143
    }
144
    Ok(out)
145
}
146
147
pub fn remote_add(name: &str, url: &str, settings: &[(&str, Option<String>)]) -> Result<i32> {
fce44ae9 Andy McCall ↶ 148
    let mut repo = open()?;
9aa39904 Andy McCall ↶ 149
    let url = url_with_settings(url, settings)?;
150
    let url = url.as_str();
827281ee Andy McCall ↶ 151
    repo.config.set(
152
        &format!("remote.{name}.url"),
153
        &oxy_core::protocol::stored_url(url),
154
    )?;
fce44ae9 Andy McCall ↶ 155
    repo.save_config()?;
75167672 Andy McCall 156
    println!(
157
        "{} remote {} {} {url}",
158
        ui::done("Added"),
159
        ui::bookmark(name),
160
        ui::dim(ui::glyph("→", "->"))
161
    );
fce44ae9 Andy McCall ↶ 162
    Ok(0)
9aa39904 Andy McCall ↶ 163
}
164
165
/// `oxy remote check NAME`: reach the remote with the credentials in
166
/// hand, say what it holds, and, for a store, put it through the
167
/// conformance check under a probe prefix (left empty afterwards).
168
pub fn remote_check(name: &str) -> Result<i32> {
169
    let repo = open()?;
170
    let Some(url) = repo.config.remotes.get(name).cloned() else {
171
        anyhow::bail!("no remote {name:?}; oxy remote list shows the remotes there are");
172
    };
173
    let options = repo.options_for_url(&url);
174
    let mine = repo.id()?;
175
    let started = std::time::Instant::now();
176
    let sp = ui::spinner(&format!("Checking {name}…"));
177
    let Some(store) = oxy_core::protocol::open_store(&url, &options) else {
178
        // A hub or another repository: reach it and read its references.
179
        let (_, remote) = repo.open_remote_at(&url)?;
180
        let id = remote.repo_id()?;
181
        let refs = remote.refs()?;
182
        sp.done(&format!(
183
            "{} {} {}",
184
            ui::done("Reachable"),
185
            ui::bookmark(name),
186
            ui::dim(format!("({url}, {} ms)", started.elapsed().as_millis()))
187
        ));
188
        describe_holding(id, mine, refs.refs.len(), refs.tags.len(), None);
189
        return Ok(0);
190
    };
191
    let store = store.with_context(|| format!("opening the store of {name}"))?;
192
    // What it holds, in one listing and two reads.
193
    let marker = match store.get("oxygen.toml") {
194
        Ok(b) => Some(b),
195
        Err(oxy_core::strata::Error::NotFound(_)) => None,
196
        Err(e) => {
197
            sp.clear();
198
            return Err(anyhow::anyhow!("{e}"))
199
                .with_context(|| format!("reaching the store of {name}"));
200
        }
201
    };
202
    let reached = started.elapsed();
203
    let bundles = store.list("bundles/")?.len();
204
    let record = store.read_ref("refs")?;
205
    sp.done(&format!(
206
        "{} {} {}",
207
        ui::done("Reachable"),
208
        ui::bookmark(name),
209
        ui::dim(format!("({url}, {} ms)", reached.as_millis()))
210
    ));
211
    match marker {
212
        None => println!(
213
            "  {} {}",
214
            ui::note(),
215
            ui::dim("holds no repository yet: oxy push NAME binds it to this one")
216
        ),
217
        Some(_) => {
218
            let (id, bookmarks, tags) = match record {
219
                Some((bytes, _)) => {
220
                    let (id, resp) = oxy_core::protocol::wire::decode_refs(&bytes)?;
221
                    (id, resp.refs.len(), resp.tags.len())
222
                }
223
                None => (mine, 0, 0),
224
            };
225
            describe_holding(id, mine, bookmarks, tags, Some(bundles));
226
        }
227
    }
228
    // Then the behaviour a repository depends on, under a prefix of its own.
229
    let sp = ui::spinner("Checking that the store behaves…");
230
    let probe = format!("oxy-check-{}", std::process::id());
231
    let began = std::time::Instant::now();
232
    match oxy_core::strata::conformance(store.as_ref(), &probe) {
233
        Ok(passed) => {
234
            sp.clear();
235
            for p in &passed {
236
                println!("  {} {}", ui::ok(ui::glyph("✔", "*")), p);
237
            }
238
            println!(
239
                "{} {}",
240
                ui::done("Behaves"),
241
                ui::dim(format!(
242
                    "({} checks in {} ms; nothing left behind)",
243
                    passed.len(),
244
                    began.elapsed().as_millis()
245
                ))
246
            );
247
            Ok(0)
248
        }
249
        Err(e) => {
250
            sp.clear();
251
            // Leave nothing behind, even after a failed check.
252
            if let Ok(left) = store.list(&probe) {
253
                for entry in left {
254
                    let _ = store.delete(&entry.key);
255
                }
256
            }
257
            println!("{} {}", ui::err(ui::glyph("✘", "x")), e);
258
            println!(
259
                "  {} {}",
260
                ui::note(),
261
                ui::dim("a store that fails this cannot keep a repository safely; check the service and the credentials' permissions")
262
            );
263
            Ok(1)
264
        }
265
    }
266
}
267
268
fn describe_holding(
269
    id: [u8; 16],
270
    mine: [u8; 16],
271
    bookmarks: usize,
272
    tags: usize,
273
    bundles: Option<usize>,
274
) {
275
    let short: String = id[..6].iter().map(|b| format!("{b:02x}")).collect();
276
    let mut what = format!(
277
        "repository {short}: {} and {}",
278
        plural(bookmarks, "bookmark"),
279
        plural(tags, "tag")
280
    );
281
    if let Some(b) = bundles {
282
        what.push_str(&format!(" in {}", plural(b, "bundle")));
283
    }
284
    if id == mine {
285
        println!("  {} {}", ui::note(), ui::dim(format!("holds this {what}")));
286
    } else if id == oxy_core::protocol::UNBOUND_ID {
287
        println!("  {} {}", ui::note(), ui::dim("holds no repository yet"));
288
    } else {
289
        println!(
290
            "  {} {}",
291
            ui::caution(),
292
            ui::warn(format!("holds another {what}; a push would be refused"))
293
        );
294
    }
fce44ae9 Andy McCall ↶ 295
}
296
297
pub fn remote_remove(name: &str) -> Result<i32> {
298
    let mut repo = open()?;
299
    repo.config.set(&format!("remote.{name}.url"), "")?;
300
    repo.save_config()?;
94084087 Andy McCall ↶ 301
    println!("{} remote {}", ui::done("Removed"), ui::bookmark(name));
fce44ae9 Andy McCall ↶ 302
    Ok(0)
303
}
304
c6aa5bd9 Andy McCall ↶ 305
pub fn remote_list(as_json: bool) -> Result<i32> {
fce44ae9 Andy McCall ↶ 306
    let repo = open()?;
307
    let view = repo.view()?;
c6aa5bd9 Andy McCall ↶ 308
    if as_json {
309
        let items = repo.config.remotes.iter().map(|(name, url)| {
310
            let bms = view.remotes.get(name).map(|b| {
311
                json::arr(b.iter().map(|(bm, st)| {
75167672 Andy McCall 312
                    let heads = repo
313
                        .store()
314
                        .get_state(st)
315
                        .map(|s| s.heads)
316
                        .unwrap_or_default();
c6aa5bd9 Andy McCall ↶ 317
                    json::obj([("name", json::s(bm)), ("heads", json::hashes(&heads))])
318
                }))
319
            });
75167672 Andy McCall 320
            json::obj([
321
                ("name", json::s(name)),
322
                ("url", json::s(url)),
dfb23a3a Andy McCall ↶ 323
                // The CA file `remote.NAME.ca` names, for tools that talk to
324
                // the same hub (an editor's forge view, `oh`).
325
                (
326
                    "ca",
327
                    json::opt(repo.config.remote_cas.get(name), |c| json::s(c)),
328
                ),
75167672 Andy McCall 329
                ("bookmarks", bms.unwrap_or_else(|| "[]".into())),
330
            ])
c6aa5bd9 Andy McCall ↶ 331
        });
332
        println!("{}", json::arr(items));
333
        return Ok(0);
334
    }
94084087 Andy McCall ↶ 335
    if repo.config.remotes.is_empty() {
75167672 Andy McCall 336
        println!(
337
            "{}",
338
            ui::dim("No remotes; add one with oxy remote add <name> <url>.")
339
        );
94084087 Andy McCall ↶ 340
    }
fce44ae9 Andy McCall ↶ 341
    for (name, url) in &repo.config.remotes {
75167672 Andy McCall 342
        println!(
343
            "{} {}{}{}",
344
            ui::ok(ui::glyph("⇄", "<>")),
345
            ui::bookmark(name),
346
            ui::sep(),
347
            ui::dim(url)
348
        );
fce44ae9 Andy McCall ↶ 349
        if let Some(bms) = view.remotes.get(name) {
350
            for (bm, st) in bms {
75167672 Andy McCall 351
                let heads = repo
352
                    .store()
353
                    .get_state(st)
354
                    .map(|s| s.heads.len())
355
                    .unwrap_or(0);
356
                println!(
357
                    "    {} {}{}{}",
358
                    ui::dim(ui::glyph("↳", "->")),
359
                    ui::id(format!("{name}/{bm}")),
360
                    ui::sep(),
361
                    ui::dim(plural(heads, "head"))
362
                );
fce44ae9 Andy McCall ↶ 363
            }
364
        }
365
    }
366
    Ok(0)
367
}
368
b35df36b Andy McCall ↶ 369
/// The remote named, else `origin`, else the only remote there is.
370
fn remote_name(repo: &oxy_core::repo::Repo, remote: Option<&str>) -> String {
371
    remote.map_or_else(|| repo.default_remote(), str::to_string)
fce44ae9 Andy McCall ↶ 372
}
373
c6aa5bd9 Andy McCall ↶ 374
pub fn fetch(remote: Option<&str>, as_json: bool) -> Result<i32> {
fce44ae9 Andy McCall ↶ 375
    let repo = open()?;
b35df36b Andy McCall ↶ 376
    let remote = remote_name(&repo, remote);
135212de Andy McCall ↶ 377
    let sp = ui::spinner(&format!("Fetching from {remote}…"));
83e0677b Andy McCall ↶ 378
    let report = repo.fetch(&remote)?;
135212de Andy McCall ↶ 379
    sp.clear();
c6aa5bd9 Andy McCall ↶ 380
    if as_json {
381
        println!(
382
            "{}",
383
            json::obj([
384
                ("remote", json::s(&remote)),
75167672 Andy McCall 385
                (
386
                    "refs",
b35df36b Andy McCall ↶ 387
                    json::arr(report.refs.iter().map(|(name, heads, n)| {
388
                        let t = repo.tracking(&remote, name).ok().flatten();
389
                        json::obj([
390
                            ("name", json::s(name)),
391
                            ("heads", json::hashes(heads)),
392
                            ("new", json::n(*n)),
393
                            (
394
                                "ahead",
395
                                t.map_or_else(|| "null".into(), |(a, _)| json::n(a)),
396
                            ),
397
                            (
398
                                "behind",
399
                                t.map_or_else(|| "null".into(), |(_, b)| json::n(b)),
400
                            ),
401
                        ])
402
                    }))
75167672 Andy McCall 403
                ),
c6aa5bd9 Andy McCall ↶ 404
                ("new_tags", json::n(report.new_tags)),
405
                ("unverified", json::b(report.unverified)),
406
            ])
407
        );
408
        return Ok(0);
409
    }
94084087 Andy McCall ↶ 410
    if report.refs.is_empty() {
75167672 Andy McCall 411
        println!(
412
            "{} {}",
413
            ui::done("Fetched"),
414
            ui::dim(format!("nothing new from {remote}"))
415
        );
94084087 Andy McCall ↶ 416
    }
83e0677b Andy McCall ↶ 417
    for (name, heads, n) in &report.refs {
b35df36b Andy McCall ↶ 418
        // What was fetched, then how the local bookmark stands against it:
419
        // "up to date" only when the two are the same (oxygen#56).
420
        let fetched =
421
            (*n > 0).then(|| format!("{}{}", ui::ok(plural(*n, "new change")), ui::sep()));
422
        let them = |k: usize| if k == 1 { "it" } else { "them" };
423
        let standing = match repo.tracking(&remote, name).ok().flatten() {
424
            None => ui::dim(format!("no local bookmark {name}")),
425
            Some((0, 0)) => ui::dim(format!("{name} up to date")),
426
            Some((0, b)) if *name == repo.config.bookmark => ui::warn(format!(
427
                "{name} is {} behind: oxy pull to take {}",
428
                plural(b, "change"),
429
                them(b)
430
            )),
431
            Some((0, b)) => ui::warn(format!(
432
                "{name} is {} behind: oxy bookmark switch {name} then oxy pull to take {}",
433
                plural(b, "change"),
434
                them(b)
435
            )),
436
            Some((a, 0)) => ui::dim(format!(
437
                "{name} is {} ahead: oxy push to send {}",
438
                plural(a, "change"),
439
                them(a)
440
            )),
441
            Some((a, b)) => ui::warn(format!(
442
                "{name} and {remote}/{name} have diverged ({a} here, {b} there): oxy pull to merge them"
443
            )),
75167672 Andy McCall 444
        };
b35df36b Andy McCall ↶ 445
        let what = format!("{}{standing}", fetched.unwrap_or_default());
75167672 Andy McCall 446
        println!(
447
            "{} {}{}{}{}{what}",
448
            ui::done("Fetched"),
449
            ui::id(format!("{remote}/{name}")),
450
            ui::sep(),
451
            ui::dim(plural(heads.len(), "head")),
452
            ui::sep()
453
        );
83e0677b Andy McCall ↶ 454
    }
132b884b Andy McCall ↶ 455
    if report.new_tags > 0 {
75167672 Andy McCall 456
        println!(
457
            "  {} {}",
458
            ui::note(),
459
            ui::dim(format!("{} adopted", plural(report.new_tags, "tag")))
460
        );
132b884b Andy McCall ↶ 461
    }
83e0677b Andy McCall ↶ 462
    if report.unverified {
75167672 Andy McCall 463
        eprintln!(
464
            "{} {remote} has no trust policy; nothing fetched from it was verified",
465
            ui::caution()
466
        );
fce44ae9 Andy McCall ↶ 467
    }
468
    Ok(0)
469
}
470
7d9dab13 Andy McCall ↶ 471
/// Pull acts on the current bookmark only: name the others the fetch
472
/// found behind their remote, which is easy to take for the current one
473
/// (oxygen#29).
474
fn others_behind(repo: &oxy_core::repo::Repo, remote: &str) {
475
    let Ok(bookmarks) = repo.bookmarks() else {
476
        return;
477
    };
478
    for b in bookmarks {
479
        let Some(n) = b.behind.filter(|n| *n > 0) else {
480
            continue;
481
        };
482
        if b.current {
483
            continue;
484
        }
485
        println!(
486
            "  {} {}",
487
            ui::note(),
488
            ui::dim(format!(
489
                "{} is {} behind {remote}/{}: oxy bookmark switch {} then oxy pull to take {}",
490
                b.name,
491
                plural(n, "change"),
492
                b.name,
493
                b.name,
494
                if n == 1 { "it" } else { "them" }
495
            ))
496
        );
497
    }
498
}
499
c6aa5bd9 Andy McCall ↶ 500
pub fn pull(remote: Option<&str>, as_json: bool) -> Result<i32> {
fce44ae9 Andy McCall ↶ 501
    let repo = open()?;
b35df36b Andy McCall ↶ 502
    let remote = remote_name(&repo, remote);
135212de Andy McCall ↶ 503
    let sp = ui::spinner(&format!("Pulling from {remote}…"));
fce44ae9 Andy McCall ↶ 504
    let r = repo.pull(&remote)?;
c6aa5bd9 Andy McCall ↶ 505
    if as_json {
506
        sp.clear();
cc7a0056 Andy McCall ↶ 507
        let conflicted = repo
508
            .snapshot_status("oxy pull")?
509
            .base_snapshot
510
            .is_conflicted();
75167672 Andy McCall 511
        println!(
512
            "{}",
513
            json::obj([
514
                ("remote", json::s(&remote)),
7d9dab13 Andy McCall ↶ 515
                ("bookmark", json::s(&repo.config.bookmark)),
75167672 Andy McCall 516
                ("heads", json::hashes(&r.heads)),
517
                ("changed", json::b(r.changed)),
518
                ("checked_out", json::b(r.checked_out)),
14edbaaf Andy McCall ↶ 519
                ("conflicted", json::b(conflicted)),
520
                ("others", json::arr(r.others.iter().map(|o| json::s(o))))
75167672 Andy McCall 521
            ])
522
        );
c6aa5bd9 Andy McCall ↶ 523
        return Ok(0);
524
    }
fce44ae9 Andy McCall ↶ 525
    if !r.changed {
75167672 Andy McCall 526
        sp.done(&format!(
f6dccc45 Andy McCall ↶ 527
            "{} {}{}",
75167672 Andy McCall 528
            ui::ok(ui::glyph("✔", "*")),
7d9dab13 Andy McCall ↶ 529
            ui::dim(format!(
530
                "{} is up to date with {remote}.",
531
                repo.config.bookmark
f6dccc45 Andy McCall ↶ 532
            )),
533
            if r.checked_out {
534
                ui::dim(" The working copy had fallen behind it and is updated.")
535
            } else {
536
                String::new()
537
            }
75167672 Andy McCall 538
        ));
14edbaaf Andy McCall ↶ 539
        others_pulled(&r.others);
7d9dab13 Andy McCall ↶ 540
        others_behind(&repo, &remote);
f6dccc45 Andy McCall ↶ 541
        if r.checked_out {
542
            super::workspace::where_now(&repo);
543
        }
fce44ae9 Andy McCall ↶ 544
        return Ok(0);
545
    }
135212de Andy McCall ↶ 546
    sp.done(&format!(
547
        "{} {} now has {}{}",
94084087 Andy McCall ↶ 548
        ui::done("Pulled:"),
549
        ui::bookmark(&repo.config.bookmark),
fce44ae9 Andy McCall ↶ 550
        plural(r.heads.len(), "head"),
75167672 Andy McCall 551
        ui::dim(if r.checked_out {
552
            "; working copy updated"
553
        } else {
554
            "; run oxy checkout to update the working copy"
555
        })
135212de Andy McCall ↶ 556
    ));
fce44ae9 Andy McCall ↶ 557
    let snap = repo.snapshot("oxy pull")?;
558
    if snap.base_snapshot.is_conflicted() {
75167672 Andy McCall 559
        println!(
560
            "  {} {}",
561
            ui::caution(),
562
            ui::warn("the result has conflicts; see oxy status")
563
        );
fce44ae9 Andy McCall ↶ 564
    }
14edbaaf Andy McCall ↶ 565
    others_pulled(&r.others);
7d9dab13 Andy McCall ↶ 566
    others_behind(&repo, &remote);
14edbaaf Andy McCall ↶ 567
    subrepos_behind(&repo);
98a1620a Andy McCall ↶ 568
    super::workspace::where_now(&repo);
fce44ae9 Andy McCall ↶ 569
    Ok(0)
570
}
571
14edbaaf Andy McCall ↶ 572
/// The other bookmarks a pull moved.
573
fn others_pulled(others: &[String]) {
574
    if others.is_empty() {
575
        return;
576
    }
577
    let shown: Vec<String> = others.iter().take(8).map(ui::bookmark).collect();
578
    let more = others.len().saturating_sub(8);
579
    println!(
580
        "  {} {}{}",
581
        ui::done("Also updated"),
582
        shown.join(", "),
583
        if more > 0 {
584
            ui::dim(format!(" and {more} more"))
585
        } else {
586
            String::new()
587
        }
588
    );
589
}
590
f8c69576 Andy McCall ↶ 591
/// `oxy push [REMOTE] --delete NAME`.
592
pub fn push_delete(remote: Option<&str>, name: &str, as_json: bool) -> Result<i32> {
593
    let repo = open()?;
b35df36b Andy McCall ↶ 594
    let remote = remote_name(&repo, remote);
f8c69576 Andy McCall ↶ 595
    let sp = ui::spinner(&format!("Deleting {remote}/{name}…"));
596
    let results = repo.push_delete(&remote, name)?;
597
    sp.clear();
598
    if as_json {
599
        println!(
600
            "{}",
601
            json::arr(results.iter().map(|r| {
602
                json::obj([
603
                    ("name", json::s(&r.name)),
604
                    ("ok", json::b(r.ok)),
605
                    ("reason", json::s(&r.reason)),
606
                    ("state", json::s("")),
607
                ])
608
            }))
609
        );
610
        return Ok(if results.iter().all(|r| r.ok) { 0 } else { 1 });
611
    }
612
    let mut code = 0;
613
    for r in results {
614
        if r.ok {
615
            println!(
616
                "{} {}",
617
                ui::done("Deleted"),
618
                ui::id(format!("{remote}/{}", r.name))
619
            );
620
        } else {
621
            println!(
622
                "{} {} {}{}{}",
623
                ui::err(ui::glyph("✖", "x")),
624
                ui::err("Rejected"),
625
                ui::id(format!("{remote}/{}", r.name)),
626
                ui::sep(),
627
                r.reason
628
            );
629
            code = 1;
630
        }
631
    }
632
    Ok(code)
633
}
634
75167672 Andy McCall 635
pub fn push(
636
    remote: Option<&str>,
637
    force: bool,
638
    bookmark: Option<&str>,
639
    as_json: bool,
640
) -> Result<i32> {
fce44ae9 Andy McCall ↶ 641
    let repo = open()?;
b35df36b Andy McCall ↶ 642
    let remote = remote_name(&repo, remote);
135212de Andy McCall ↶ 643
    let sp = ui::spinner(&format!("Pushing to {remote}…"));
cb8b8082 Andy McCall ↶ 644
    let bookmark_name = bookmark.map_or_else(|| repo.config.bookmark.clone(), String::from);
645
    // A long push goes in parts: the spinner says which.
646
    let results = repo.push_bookmark_with(&remote, &bookmark_name, force, &mut |m| {
647
        sp.set(&format!("Pushing to {remote}… {m}"))
648
    })?;
135212de Andy McCall ↶ 649
    sp.clear();
c6aa5bd9 Andy McCall ↶ 650
    if as_json {
75167672 Andy McCall 651
        println!(
652
            "{}",
653
            json::arr(results.iter().map(|r| json::obj([
654
                ("name", json::s(&r.name)),
655
                ("ok", json::b(r.ok)),
656
                ("reason", json::s(&r.reason))
657
            ])))
658
        );
c6aa5bd9 Andy McCall ↶ 659
        return Ok(if results.iter().all(|r| r.ok) { 0 } else { 1 });
660
    }
fce44ae9 Andy McCall ↶ 661
    let mut code = 0;
135212de Andy McCall ↶ 662
    for r in results {
fce44ae9 Andy McCall ↶ 663
        if r.ok {
75167672 Andy McCall 664
            println!(
665
                "{} {}{}{}",
666
                ui::done("Pushed"),
667
                ui::id(format!("{remote}/{}", r.name)),
668
                ui::sep(),
669
                ui::dim(if r.reason.is_empty() {
670
                    "updated"
671
                } else {
672
                    r.reason.as_str()
673
                })
674
            );
fce44ae9 Andy McCall ↶ 675
        } else {
75167672 Andy McCall 676
            println!(
677
                "{} {} {}{}{}",
678
                ui::err(ui::glyph("✖", "x")),
679
                ui::err("Rejected"),
680
                ui::id(format!("{remote}/{}", r.name)),
681
                ui::sep(),
682
                r.reason
683
            );
fce44ae9 Andy McCall ↶ 684
            code = 1;
685
        }
686
    }
687
    Ok(code)
688
}
689
75167672 Andy McCall 690
pub fn serve(
691
    root: PathBuf,
692
    bind: &str,
693
    tokens: Vec<String>,
694
    tls: Option<(PathBuf, PathBuf)>,
695
) -> Result<i32> {
fce44ae9 Andy McCall ↶ 696
    let listener = std::net::TcpListener::bind(bind).with_context(|| format!("binding {bind}"))?;
697
    let root = root.canonicalize()?;
2b5ee371 Andy McCall ↶ 698
    let tls = tls.map(|(cert, key)| oxy_server::TlsFiles { cert, key });
fce44ae9 Andy McCall ↶ 699
    println!(
2b5ee371 Andy McCall ↶ 700
        "Serving repositories under {} on {}://{bind}/<repo>/oxy/v1/ ({})",
fce44ae9 Andy McCall ↶ 701
        root.display(),
2b5ee371 Andy McCall ↶ 702
        if tls.is_some() { "https" } else { "http" },
75167672 Andy McCall 703
        if tokens.is_empty() {
704
            "open: no push tokens configured"
705
        } else {
706
            "push requires a token"
707
        }
fce44ae9 Andy McCall ↶ 708
    );
75167672 Andy McCall 709
    if tls.is_none()
710
        && !bind.starts_with("127.")
711
        && !bind.starts_with("localhost")
712
        && !bind.starts_with("[::1]")
713
    {
2b5ee371 Andy McCall ↶ 714
        eprintln!("warning: serving plain HTTP on a non-loopback address; put a TLS terminator in front or pass --tls-cert/--tls-key");
715
    }
716
    oxy_server::run_blocking(listener, oxy_server::ServerConfig { root, tokens, tls })?;
fce44ae9 Andy McCall ↶ 717
    Ok(0)
718
}
79ab8528 Andy McCall ↶ 719
30ea9c1e Andy McCall ↶ 720
pub fn git_export(git_dir: &std::path::Path, branch: Option<&str>) -> Result<i32> {
79ab8528 Andy McCall ↶ 721
    let repo = open()?;
135212de Andy McCall ↶ 722
    let sp = ui::spinner("Exporting to Git…");
30ea9c1e Andy McCall ↶ 723
    let r = match branch {
724
        Some(b) => repo.git_export_as(git_dir, b)?,
725
        None => repo.git_export(git_dir)?,
726
    };
135212de Andy McCall ↶ 727
    sp.clear();
79ab8528 Andy McCall ↶ 728
    println!(
94084087 Andy McCall ↶ 729
        "{} {} to {} as branch {} {}",
730
        ui::done("Exported"),
e8b4e156 Andy McCall ↶ 731
        plural(r.exported, "new state"),
94084087 Andy McCall ↶ 732
        ui::path(git_dir.display()),
733
        ui::bookmark(&r.branch),
75167672 Andy McCall 734
        ui::dim(format!(
735
            "(currently {}; {} already exported)",
736
            plural(r.heads, "head"),
737
            r.skipped
738
        ))
79ab8528 Andy McCall ↶ 739
    );
740
    Ok(0)
741
}
c3069537 Andy McCall ↶ 742
30ea9c1e Andy McCall ↶ 743
pub fn git_fetch(url: &str, branch: &str) -> Result<i32> {
744
    let repo = open()?;
745
    let sp = ui::spinner(&format!("Fetching {url} {branch}…"));
746
    let r = repo.git_fetch(url, branch)?;
747
    sp.clear();
748
    if r.commits == 0 {
75167672 Andy McCall 749
        println!(
750
            "{} {}",
751
            ui::done("Fetched"),
752
            ui::dim(format!("nothing new from {url} {branch}"))
753
        );
30ea9c1e Andy McCall ↶ 754
    } else {
755
        println!(
756
            "{} {} ({} merges) from {} {}{}{} now has {}",
757
            ui::done("Fetched"),
758
            plural(r.commits, "new commit"),
759
            r.merges,
760
            ui::path(url),
761
            ui::bookmark(branch),
762
            ui::sep(),
763
            ui::bookmark(&repo.config.bookmark),
764
            plural(r.heads, "head")
765
        );
766
        if !repo.snapshot("oxy git fetch")?.changed {
767
            println!("  {} {}", ui::note(), ui::dim("working copy updated"));
768
        } else {
75167672 Andy McCall 769
            println!(
770
                "  {} {}",
771
                ui::note(),
772
                ui::dim("run oxy checkout to update the working copy")
773
            );
30ea9c1e Andy McCall ↶ 774
        }
775
    }
4dee277c Andy McCall ↶ 776
    if r.submodules > 0 {
75167672 Andy McCall 777
        println!(
778
            "  {} {}",
779
            ui::note(),
780
            ui::dim(format!(
781
                "{} submodule {} imported as subrepos with Git pins",
782
                r.submodules,
783
                if r.submodules == 1 {
784
                    "entry"
785
                } else {
786
                    "entries"
787
                }
788
            ))
789
        );
30ea9c1e Andy McCall ↶ 790
    }
791
    Ok(0)
792
}
793
794
pub fn git_push(url: &str, branch: &str) -> Result<i32> {
795
    let repo = open()?;
796
    let sp = ui::spinner(&format!("Pushing to {url} {branch}…"));
797
    let r = repo.git_push(url, branch)?;
798
    sp.clear();
799
    println!(
800
        "{} {} to {} {} {}",
801
        ui::done("Pushed"),
802
        plural(r.exported, "new commit"),
803
        ui::path(url),
804
        ui::bookmark(&r.branch),
805
        ui::dim(format!("({} already there)", r.skipped))
806
    );
807
    Ok(0)
808
}
809
62794ecc Andy McCall ↶ 810
/// `oxy git verify`: exit 1 if any commit's tree is not reproduced.
811
pub fn git_verify(git_dir: &std::path::Path, branch: &str) -> Result<i32> {
812
    let repo = open()?;
813
    let started = std::time::Instant::now();
814
    let sp = ui::spinner(&format!(
815
        "Rebuilding every commit of {} {branch}…",
816
        git_dir.display()
817
    ));
818
    let r = repo.verify_git_import(git_dir, branch)?;
819
    sp.clear();
820
    for (_, what) in &r.mismatches {
821
        println!("{} {what}", ui::err(ui::glyph("✖", "x")));
822
    }
823
    if r.mismatches.is_empty() {
824
        println!(
825
            "{}",
826
            ui::done(format!(
827
                "Every commit reproduced: {} commits, {} files compared, in {:.1}s",
828
                r.commits,
829
                r.files_compared,
830
                started.elapsed().as_secs_f64()
831
            ))
832
        );
833
        Ok(0)
834
    } else {
835
        println!(
836
            "{} differences in {} commits checked",
837
            r.mismatches.len(),
838
            r.commits
839
        );
840
        Ok(1)
841
    }
842
}
843
c3069537 Andy McCall ↶ 844
pub fn git_import(git_dir: &std::path::Path, dest: &std::path::Path, branch: &str) -> Result<i32> {
845
    let repo = Repo::init(dest)?;
846
    let started = std::time::Instant::now();
135212de Andy McCall ↶ 847
    let sp = ui::spinner(&format!("Importing {} {branch}…", git_dir.display()));
58dfe0e1 Andy McCall ↶ 848
    let r = repo.import_git_with(git_dir, branch, &mut |where_| sp.set(where_))?;
135212de Andy McCall ↶ 849
    sp.clear();
c3069537 Andy McCall ↶ 850
    println!(
94084087 Andy McCall ↶ 851
        "{} {} ({} merges) from {} {} into {} {}",
852
        ui::done("Imported"),
c3069537 Andy McCall ↶ 853
        plural(r.commits, "commit"),
854
        r.merges,
94084087 Andy McCall ↶ 855
        ui::path(git_dir.display()),
856
        ui::bookmark(branch),
857
        ui::path(repo.root().display()),
75167672 Andy McCall 858
        ui::dim(format!(
859
            "in {:.1?}; {} now has {}",
860
            started.elapsed(),
861
            repo.config.bookmark,
862
            plural(r.heads, "head")
863
        ))
c3069537 Andy McCall ↶ 864
    );
4dee277c Andy McCall ↶ 865
    if r.submodules > 0 {
75167672 Andy McCall 866
        println!(
867
            "  {} {}",
868
            ui::note(),
869
            ui::dim(format!(
870
                "{} submodule {} imported as subrepos with Git pins",
871
                r.submodules,
872
                if r.submodules == 1 {
873
                    "entry"
874
                } else {
875
                    "entries"
876
                }
877
            ))
878
        );
4dee277c Andy McCall ↶ 879
    }
880
    Ok(0)
881
}
882
883
pub fn submodule_add(url: &str, path: &str, bookmark: Option<&str>) -> Result<i32> {
884
    let repo = open()?;
885
    let sp = ui::spinner(&format!("Cloning {url} into {path}…"));
886
    let pin = repo.submodule_add(url, path, bookmark)?;
75167672 Andy McCall 887
    sp.done(&format!(
888
        "{} subrepo {} {} {}",
889
        ui::done("Added"),
890
        ui::path(path),
891
        ui::dim(ui::glyph("→", "->")),
892
        ui::dim(pin.summary())
893
    ));
894
    println!(
895
        "  {} {}",
896
        ui::note(),
897
        ui::dim("recorded in .oxymodules; commit to pin it")
898
    );
4dee277c Andy McCall ↶ 899
    Ok(0)
900
}
901
902
pub fn submodule_update(init: bool, paths: &[String]) -> Result<i32> {
903
    let repo = open()?;
904
    let sp = ui::spinner("Updating subrepos…");
905
    let results = repo.submodule_update(init, paths)?;
7993d465 Andy McCall ↶ 906
    let unpinned: Vec<_> = repo
907
        .unpinned_modules()?
908
        .into_iter()
909
        .filter(|(p, _)| paths.is_empty() || paths.iter().any(|q| q.trim_end_matches('/') == p))
910
        .collect();
4dee277c Andy McCall ↶ 911
    sp.clear();
7993d465 Andy McCall ↶ 912
    if results.is_empty() && unpinned.is_empty() {
913
        println!("{}", ui::dim("No subrepos."));
914
    }
915
    let code = print_subrepo_results(results);
916
    print_unpinned(&unpinned);
917
    Ok(if unpinned.is_empty() { code } else { 1 })
14edbaaf Andy McCall ↶ 918
}
919
7993d465 Andy McCall ↶ 920
/// `.oxymodules` entries never added: nothing to clone, so say how to add
921
/// them (oxygen#72).
922
fn print_unpinned(unpinned: &[(String, oxy_core::subrepo::Module)]) {
923
    for (path, m) in unpinned {
924
        let url = if m.url.is_empty() { "<url>" } else { &m.url };
925
        println!(
926
            "{} {}",
927
            ui::warn(format!(
928
                "{} in .oxymodules but never added, so no pin",
929
                ui::glyph("⚠", "!")
930
            )),
931
            ui::path(path)
932
        );
933
        println!(
934
            "  {}",
935
            ui::dim(format!("add it with: oxy submodule add {url} {path}"))
936
        );
937
    }
938
}
939
14edbaaf Andy McCall ↶ 940
fn print_subrepo_results(results: Vec<(String, oxy_core::repo::SubrepoSync)>) -> i32 {
4dee277c Andy McCall ↶ 941
    let mut code = 0;
942
    for (path, r) in results {
943
        use oxy_core::repo::SubrepoSync::*;
944
        let line = match r {
945
            Updated => ui::done("Updated"),
946
            UpToDate => ui::ok(format!("{} up to date", ui::glyph("✔", "*"))),
947
            Missing => {
948
                code = 1;
75167672 Andy McCall 949
                ui::warn(format!(
950
                    "{} missing (pass --init to clone)",
951
                    ui::glyph("⚠", "!")
952
                ))
4dee277c Andy McCall ↶ 953
            }
954
            Dirty => {
955
                code = 1;
75167672 Andy McCall 956
                ui::warn(format!(
957
                    "{} has uncommitted changes; left as is",
958
                    ui::glyph("⚠", "!")
959
                ))
4dee277c Andy McCall ↶ 960
            }
1a3b6203 Andy McCall ↶ 961
            KeptBookmark { bookmark, newer } => ui::warn(format!(
962
                "{} checked out at the pin; its bookmark {bookmark} keeps {} the pin lacks",
963
                ui::glyph("⚠", "!"),
964
                plural(newer, "newer change")
965
            )),
4dee277c Andy McCall ↶ 966
            Failed(e) => {
967
                code = 1;
968
                ui::err(format!("{} {e}", ui::glyph("✖", "x")))
969
            }
970
        };
971
        println!("{line} {}", ui::path(path));
972
    }
14edbaaf Andy McCall ↶ 973
    code
4dee277c Andy McCall ↶ 974
}
975
c6aa5bd9 Andy McCall ↶ 976
fn pin_json(p: &oxy_core::subrepo::Pin) -> String {
977
    match p {
75167672 Andy McCall 978
        oxy_core::subrepo::Pin::Oxy {
979
            repo,
980
            heads,
981
            bookmark,
982
        } => json::obj([
983
            ("kind", json::s("oxy")),
984
            (
985
                "repo",
986
                json::s(&repo.iter().map(|b| format!("{b:02x}")).collect::<String>()),
987
            ),
988
            ("heads", json::hashes(heads)),
989
            ("bookmark", json::s(bookmark)),
990
        ]),
991
        oxy_core::subrepo::Pin::Git { sha, branch } => json::obj([
992
            ("kind", json::s("git")),
993
            ("sha", json::s(sha)),
994
            ("branch", json::s(branch)),
995
        ]),
c6aa5bd9 Andy McCall ↶ 996
    }
997
}
998
999
pub fn submodule_status(as_json: bool) -> Result<i32> {
4dee277c Andy McCall ↶ 1000
    let repo = open()?;
1001
    let subs = repo.subrepos()?;
7993d465 Andy McCall ↶ 1002
    let unpinned = repo.unpinned_modules()?;
c6aa5bd9 Andy McCall ↶ 1003
    if as_json {
7993d465 Andy McCall ↶ 1004
        let pinned = subs.iter().map(|s| {
1005
            json::obj([
1006
                ("path", json::s(&s.path)),
1007
                ("pin", pin_json(&s.pin)),
1008
                ("actual", json::opt(s.actual.as_ref(), pin_json)),
1009
                ("at_pin", json::b(s.actual.as_ref() == Some(&s.pin))),
1010
                ("dirty", json::b(s.dirty)),
1011
                ("committed", json::b(s.committed)),
1012
                ("url", json::opt(s.url.as_deref(), json::s)),
1013
            ])
1014
        });
1015
        // Listed in .oxymodules but never added: no pin at all.
1016
        let unpinned_json = unpinned.iter().map(|(path, m)| {
1017
            json::obj([
1018
                ("path", json::s(path)),
1019
                ("pin", "null".to_string()),
1020
                ("actual", "null".to_string()),
1021
                ("at_pin", json::b(false)),
1022
                ("dirty", json::b(false)),
1023
                ("committed", json::b(false)),
1024
                ("url", json::s(&m.url)),
1025
            ])
1026
        });
1027
        println!("{}", json::arr(pinned.chain(unpinned_json)));
c6aa5bd9 Andy McCall ↶ 1028
        return Ok(0);
1029
    }
7993d465 Andy McCall ↶ 1030
    if subs.is_empty() && unpinned.is_empty() {
4dee277c Andy McCall ↶ 1031
        println!("{}", ui::dim("No subrepos."));
94084087 Andy McCall ↶ 1032
    }
4dee277c Andy McCall ↶ 1033
    for s in subs {
1034
        let state = match (&s.actual, s.dirty) {
e7ac6c2e Andy McCall ↶ 1035
            _ if !s.committed => {
1036
                ui::warn(format!("{} added, not committed yet", ui::glyph("+", "+")))
1037
            }
4dee277c Andy McCall ↶ 1038
            (None, _) => ui::warn(format!("{} missing", ui::glyph("⚠", "!"))),
1039
            (Some(a), dirty) if *a == s.pin => {
75167672 Andy McCall 1040
                if dirty {
1041
                    ui::warn(format!(
1042
                        "{} at pin, uncommitted changes",
1043
                        ui::glyph("✎", "~")
1044
                    ))
1045
                } else {
1046
                    ui::ok(format!("{} at pin", ui::glyph("✔", "*")))
1047
                }
4dee277c Andy McCall ↶ 1048
            }
1049
            (Some(a), _) => ui::warn(format!("{} at {}", ui::glyph("↕", "<>"), a.summary())),
1050
        };
75167672 Andy McCall 1051
        println!(
1052
            "{} {}{}{}{}{state}",
1053
            ui::ok(ui::glyph("⧉", "#")),
1054
            ui::path(&s.path),
1055
            ui::sep(),
1056
            ui::dim(s.pin.summary()),
1057
            ui::sep()
1058
        );
4dee277c Andy McCall ↶ 1059
        if let Some(u) = s.url {
1060
            println!("    {} {}", ui::dim(ui::glyph("↳", "->")), ui::dim(u));
1061
        }
1062
    }
7993d465 Andy McCall ↶ 1063
    print_unpinned(&unpinned);
4dee277c Andy McCall ↶ 1064
    Ok(0)
1065
}
1066
1067
pub fn submodule_remove(path: &str) -> Result<i32> {
1068
    let repo = open()?;
1069
    repo.submodule_remove(path)?;
75167672 Andy McCall 1070
    println!(
1071
        "{} subrepo {} {}",
1072
        ui::done("Removed"),
1073
        ui::path(path),
1074
        ui::dim("(directory left in place; commit to record the removal)")
1075
    );
c3069537 Andy McCall ↶ 1076
    Ok(0)
1077
}
2863456a Andy McCall ↶ 1078
1079
pub fn deepen(remote: &str, depth: u32) -> Result<i32> {
1080
    let repo = open()?;
1081
    if !repo.is_shallow() {
75167672 Andy McCall 1082
        println!(
1083
            "{}",
1084
            ui::dim("This repository is not shallow; nothing to deepen.")
1085
        );
2863456a Andy McCall ↶ 1086
        return Ok(0);
1087
    }
1088
    let sp = ui::spinner(&format!("Fetching {depth} more levels from {remote}…"));
1089
    let n = repo.deepen(remote, depth)?;
75167672 Andy McCall 1090
    sp.done(&format!(
1091
        "{} {}; {}",
c07406bc Andy McCall ↶ 1092
        ui::done("Deepened by"),
75167672 Andy McCall 1093
        plural(n, "change"),
1094
        if repo.is_shallow() {
1095
            "still shallow".to_string()
1096
        } else {
1097
            ui::ok("history is now complete")
1098
        }
1099
    ));
2863456a Andy McCall ↶ 1100
    Ok(0)
1101
}