OXYGENHUB
◆ v0.9.20 oxygenhub / crates / hub / src / backups.rs
85.3 KiB · Rust · last changed Drops are backed up and restored as drops (refs #280) 15 days ago source blame history raw
d7d18246 Andy McCall ↶ 1
//! Backups (docs/backups.md, oxygenhub#169): each user and organisation
2
//! copies its repositories, on a schedule, to a destination it controls.
3
//!
4
//! A repository is its store directory (`.oxy/`): packs and loose objects
5
//! that never change once written, and small files that do (refs, the
6
//! operation log, policies, signature indexes). A run copies each file
7
//! once, named by its BLAKE3 (`blobs/`), and writes a manifest of path to
8
//! hash per repository (`runs/<at>/repos/`), so only what changed travels
9
//! and any kept run can be restored byte for byte, signatures and all.
10
//! The large files are copied first; the walk is then repeated under the
11
//! repository's read lock, which pushes wait on, so each manifest is one
12
//! consistent moment. Beside each manifest go the hub's records for the
13
//! repository as JSON (never a secret value), the owner's records, and
14
//! last a `DONE` marker: a run without one was cut short and is ignored.
15
16
use crate::db::{self, Pool};
17
use crate::repos::RepoName;
18
use crate::Shared;
19
use anyhow::{bail, Context, Result};
20
use serde::{Deserialize, Serialize};
21
use std::collections::HashMap;
22
use std::path::{Path, PathBuf};
23
24
/// How often, as the settings offer it.
25
pub const EVERY: &[(&str, &str)] = &[("off", "Off"), ("hourly", "Every hour"), ("daily", "Every day")];
26
/// How long runs are kept, in days.
27
pub const KEEP: &[i64] = &[7, 30, 90];
28
29
/// What an owner backs up, where and how often.
30
#[derive(Clone, Debug, sqlx::FromRow, Serialize)]
31
pub struct Setting {
32
    pub owner: String,
33
    pub kind: String,
34
    pub every: String,
35
    pub destination: String,
36
    pub target: String,
37
    pub prefix: String,
38
    pub provider: String,
39
    pub keep_days: i64,
40
    pub updated_ms: i64,
7b9f4570 Andy McCall ↶ 41
    /// An S3 bucket's region (migration 0063).
42
    #[sqlx(default)]
43
    pub region: String,
d7d18246 Andy McCall ↶ 44
}
45
46
impl Setting {
47
    pub fn off(owner: &str, kind: &str) -> Setting {
48
        Setting {
49
            owner: owner.into(),
50
            kind: kind.into(),
51
            every: "off".into(),
52
            destination: "dir".into(),
53
            target: String::new(),
54
            prefix: String::new(),
55
            provider: String::new(),
56
            keep_days: 30,
57
            updated_ms: 0,
7b9f4570 Andy McCall ↶ 58
            region: String::new(),
d7d18246 Andy McCall ↶ 59
        }
60
    }
61
62
    /// Seconds between runs; none when off.
63
    pub fn period_s(&self) -> Option<i64> {
64
        match self.every.as_str() {
65
            "hourly" => Some(3600),
66
            "daily" => Some(86_400),
67
            _ => None,
68
        }
69
    }
70
}
71
72
/// One run, as the settings page and the API show it.
73
#[derive(Clone, Debug, sqlx::FromRow, Serialize)]
74
pub struct Run {
75
    pub id: i64,
76
    pub owner: String,
77
    pub started_ms: i64,
78
    pub finished_ms: Option<i64>,
79
    pub status: String,
80
    pub at: String,
81
    pub repos: i64,
82
    pub files: i64,
83
    pub sent: i64,
84
    pub bytes: i64,
85
    pub detail: String,
86
    pub trigger: String,
87
}
88
89
pub async fn setting(pool: &Pool, owner: &str) -> sqlx::Result<Option<Setting>> {
5d90e0e0 Andy McCall 90
    sqlx::query_as("SELECT * FROM backup_settings WHERE owner = $1").bind(owner).fetch_optional(pool).await
d7d18246 Andy McCall ↶ 91
}
92
93
pub async fn save(pool: &Pool, s: &Setting) -> sqlx::Result<()> {
94
    sqlx::query(
7b9f4570 Andy McCall ↶ 95
        "INSERT INTO backup_settings (owner, kind, every, destination, target, prefix, provider, keep_days, updated_ms, region) \
5d90e0e0 Andy McCall 96
         VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10) ON CONFLICT(owner) DO UPDATE SET kind = excluded.kind, every = excluded.every, \
d7d18246 Andy McCall ↶ 97
         destination = excluded.destination, target = excluded.target, prefix = excluded.prefix, provider = excluded.provider, \
7b9f4570 Andy McCall ↶ 98
         keep_days = excluded.keep_days, updated_ms = excluded.updated_ms, region = excluded.region",
d7d18246 Andy McCall ↶ 99
    )
100
    .bind(&s.owner)
101
    .bind(&s.kind)
102
    .bind(&s.every)
103
    .bind(&s.destination)
104
    .bind(&s.target)
105
    .bind(&s.prefix)
106
    .bind(&s.provider)
107
    .bind(s.keep_days)
108
    .bind(db::now_ms())
7b9f4570 Andy McCall ↶ 109
    .bind(&s.region)
d7d18246 Andy McCall ↶ 110
    .execute(pool)
111
    .await?;
112
    Ok(())
113
}
114
115
pub async fn runs(pool: &Pool, owner: &str, limit: i64) -> sqlx::Result<Vec<Run>> {
5d90e0e0 Andy McCall 116
    sqlx::query_as("SELECT * FROM backup_runs WHERE owner = $1 ORDER BY id DESC LIMIT $2").bind(owner).bind(limit).fetch_all(pool).await
d7d18246 Andy McCall ↶ 117
}
118
d3b048b2 Andy McCall ↶ 119
/// What a repository may choose about its backup (§5): with its owner's,
120
/// left out, or at least hourly or daily whatever its owner's schedule.
121
pub const REPO_CHOICES: &[(&str, &str)] =
122
    &[("", "With its owner's backup"), ("hourly", "At least every hour"), ("daily", "At least every day"), ("off", "Left out")];
123
124
/// Whether `row` is in its owner's run: never when it is left out, always
125
/// when it has its own schedule, else as its owner's schedule says (a run
126
/// asked for by hand takes every repository not left out).
127
pub fn included(s: &Setting, row: &db::repos::RepoRow, by_hand: bool) -> bool {
128
    match row.backup.as_str() {
129
        "off" => false,
130
        "hourly" | "daily" => true,
131
        _ => by_hand || s.every != "off",
132
    }
133
}
134
135
/// Seconds between an owner's runs: the shortest of its own schedule and
136
/// its repositories' own; none when nothing is scheduled.
137
pub fn period_with(s: &Setting, repos: &[db::repos::RepoRow]) -> Option<i64> {
138
    let own = repos.iter().filter_map(|r| match r.backup.as_str() {
139
        "hourly" => Some(3600),
140
        "daily" => Some(86_400),
141
        _ => None,
142
    });
143
    s.period_s().into_iter().chain(own).min()
144
}
145
1e8a6e8b Andy McCall ↶ 146
/// One owner's backup as Admin › Backups shows it (§5): its setting, its
147
/// newest run, and how many runs failed in the last day. An administrator
148
/// sees that it ran, never what it wrote.
149
#[derive(Clone, Debug, Serialize)]
150
pub struct Overview {
151
    pub setting: Setting,
152
    pub last: Option<Run>,
153
    pub failed_day: i64,
154
    /// The repositories it covers now.
155
    pub repos: i64,
156
}
157
158
impl Overview {
159
    /// Where its runs go, as a person reads it.
160
    pub fn place(&self) -> String {
2e9188ca Andy McCall ↶ 161
        place(&self.setting)
162
    }
163
}
164
165
/// Where a setting's runs go, as a person reads it.
166
pub fn place(s: &Setting) -> String {
167
    match s.destination.as_str() {
168
        "gcs" if s.prefix.is_empty() => format!("gs://{}", s.target),
169
        "gcs" => format!("gs://{}/{}", s.target, s.prefix),
170
        "s3" if s.prefix.is_empty() => format!("s3://{} ({})", s.target, s.region),
171
        "s3" => format!("s3://{}/{} ({})", s.target, s.prefix, s.region),
172
        _ => format!("{}/{}", s.target, s.owner),
1e8a6e8b Andy McCall ↶ 173
    }
174
}
175
176
/// Every owner's backup (Admin › Backups), and the owners of repositories
177
/// that none covers, with how many each has.
178
pub async fn overview(pool: &Pool) -> sqlx::Result<(Vec<Overview>, Vec<(String, i64)>)> {
179
    let settings: Vec<Setting> = sqlx::query_as("SELECT * FROM backup_settings ORDER BY owner").fetch_all(pool).await?;
180
    let counts: Vec<(String, i64)> =
9041db4e Andy McCall ↶ 181
        sqlx::query_as("SELECT owner, COUNT(*) FROM repositories GROUP BY owner ORDER BY owner").fetch_all(pool).await?;
1e8a6e8b Andy McCall ↶ 182
    let day_ago = db::now_ms() - 86_400_000;
183
    let mut out = Vec::new();
184
    for s in settings {
185
        let last = runs(pool, &s.owner, 1).await?.into_iter().next();
186
        let failed_day: i64 =
5d90e0e0 Andy McCall 187
            sqlx::query_scalar("SELECT COUNT(*) FROM backup_runs WHERE owner = $1 AND status = 'failed' AND started_ms >= $2")
1e8a6e8b Andy McCall ↶ 188
                .bind(&s.owner)
189
                .bind(day_ago)
190
                .fetch_one(pool)
191
                .await?;
9041db4e Andy McCall ↶ 192
        let repos = db::repos::list_with_drops(pool).await?.iter().filter(|r| r.owner == s.owner && included(&s, r, false)).count() as i64;
1e8a6e8b Andy McCall ↶ 193
        out.push(Overview { setting: s, last, failed_day, repos });
194
    }
d3b048b2 Andy McCall ↶ 195
    let uncovered = counts.into_iter().filter(|(owner, _)| !out.iter().any(|o| o.setting.owner == *owner && o.repos > 0)).collect();
1e8a6e8b Andy McCall ↶ 196
    Ok((out, uncovered))
197
}
198
d7d18246 Andy McCall ↶ 199
// ---------------------------------------------------------------- where
200
201
/// Where backups are written: keys are `/`-separated paths.
202
pub trait Destination: Send + Sync {
203
    fn exists(&self, key: &str) -> Result<bool>;
204
    /// Write `bytes` at `key`, whole or not at all.
205
    fn put(&self, key: &str, bytes: &[u8]) -> Result<()>;
206
    fn get(&self, key: &str) -> Result<Vec<u8>>;
207
    /// The names directly under `prefix` (files and "directories").
208
    fn list(&self, prefix: &str) -> Result<Vec<String>>;
209
    /// Remove `key` and everything under it.
210
    fn remove(&self, key: &str) -> Result<()>;
211
}
212
213
/// A directory on the hub's host.
214
pub struct Directory {
215
    pub root: PathBuf,
216
}
217
218
impl Directory {
219
    fn path(&self, key: &str) -> Result<PathBuf> {
220
        if key.split('/').any(|p| p == ".." || p == ".") || key.starts_with('/') {
221
            bail!("not a clean key: {key}");
222
        }
223
        Ok(self.root.join(key))
224
    }
225
}
226
227
impl Destination for Directory {
228
    fn exists(&self, key: &str) -> Result<bool> {
229
        Ok(self.path(key)?.exists())
230
    }
231
    fn put(&self, key: &str, bytes: &[u8]) -> Result<()> {
232
        let p = self.path(key)?;
233
        std::fs::create_dir_all(p.parent().context("no parent")?)?;
234
        let tmp = p.with_extension(format!("part-{}", std::process::id()));
235
        std::fs::write(&tmp, bytes)?;
236
        std::fs::rename(&tmp, &p)?;
237
        Ok(())
238
    }
239
    fn get(&self, key: &str) -> Result<Vec<u8>> {
240
        let p = self.path(key)?;
241
        std::fs::read(&p).with_context(|| format!("read {}", p.display()))
242
    }
243
    fn list(&self, prefix: &str) -> Result<Vec<String>> {
244
        let p = self.path(prefix)?;
245
        let mut out: Vec<String> = match std::fs::read_dir(&p) {
246
            Ok(d) => d.flatten().map(|e| e.file_name().to_string_lossy().into_owned()).collect(),
247
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
248
            Err(e) => return Err(e.into()),
249
        };
250
        out.sort();
251
        Ok(out)
252
    }
253
    fn remove(&self, key: &str) -> Result<()> {
254
        let p = self.path(key)?;
255
        if p.is_dir() {
256
            std::fs::remove_dir_all(p)?;
257
        } else if p.exists() {
258
            std::fs::remove_file(p)?;
259
        }
260
        Ok(())
261
    }
262
}
263
35fea423 Andy McCall ↶ 264
/// A Cloud Storage bucket, reached keylessly (docs/backups.md §3, §6):
265
/// the hub mints a short token as `backup:OWNER`, Google's STS exchanges
266
/// it for an access token through the owner's workload identity
267
/// provider, and that writes the bucket. No key exists anywhere; the
268
/// access token lasts an hour and is fetched again before it runs out.
269
pub struct Gcs {
270
    bucket: String,
271
    /// Keys go under this, when set.
272
    prefix: String,
273
    storage: String,
274
    sts: String,
275
    /// The provider's resource name, `//iam.googleapis.com/projects/…`.
276
    provider: String,
277
    subject: String,
278
    app: Shared,
279
    client: reqwest::Client,
280
    rt: tokio::runtime::Handle,
281
    token: std::sync::Mutex<Option<(String, i64)>>,
282
}
283
284
impl Gcs {
285
    pub fn new(app: &Shared, s: &Setting) -> Gcs {
286
        Gcs {
287
            bucket: s.target.clone(),
288
            prefix: s.prefix.trim_matches('/').to_string(),
289
            storage: app.config.backups.storage_url.trim_end_matches('/').to_string(),
290
            sts: app.config.backups.sts_url.trim_end_matches('/').to_string(),
291
            provider: s.provider.clone(),
292
            subject: format!("backup:{}", s.owner),
293
            app: app.clone(),
294
            client: reqwest::Client::builder().timeout(std::time::Duration::from_secs(300)).build().unwrap_or_default(),
295
            rt: tokio::runtime::Handle::current(),
296
            token: std::sync::Mutex::new(None),
297
        }
298
    }
299
300
    fn name(&self, key: &str) -> String {
301
        if self.prefix.is_empty() {
302
            key.to_string()
303
        } else {
304
            format!("{}/{key}", self.prefix)
305
        }
306
    }
307
308
    /// An access token, exchanged for a fresh one of the hub's when the
309
    /// last is within five minutes of running out.
310
    fn access(&self) -> Result<String> {
311
        let now = db::now_ms();
312
        if let Some((t, until)) = self.token.lock().unwrap().as_ref() {
313
            if *until - now > 300_000 {
314
                return Ok(t.clone());
315
            }
316
        }
317
        let (token, expires_in) = self.rt.block_on(async {
318
            let issuer = self.app.oidc().await?;
319
            // Google's default audience for a provider: its name over https.
320
            let audience = format!("https:{}", self.provider);
321
            let jwt = issuer.mint_for(self.app.config.base_url(), &self.subject, &audience, db::now_ms(), 600);
322
            let res = self
323
                .client
324
                .post(format!("{}/v1/token", self.sts))
325
                .json(&serde_json::json!({
326
                    "grantType": "urn:ietf:params:oauth:grant-type:token-exchange",
327
                    "audience": self.provider,
328
                    "scope": "https://www.googleapis.com/auth/devstorage.read_write",
329
                    "requestedTokenType": "urn:ietf:params:oauth:token-type:access_token",
330
                    "subjectToken": jwt,
331
                    "subjectTokenType": "urn:ietf:params:oauth:token-type:jwt",
332
                }))
333
                .send()
334
                .await?;
335
            let status = res.status();
336
            let body: serde_json::Value = res.json().await.unwrap_or_default();
337
            if !status.is_success() {
338
                bail!(
339
                    "Google's token exchange refused {}: {} (check the provider's issuer is this hub's address and its attribute condition admits backup:)",
340
                    self.subject,
341
                    body["error_description"].as_str().or(body["error"].as_str()).unwrap_or("no reason given")
342
                );
343
            }
344
            let token = body["access_token"].as_str().context("the token exchange gave no access token")?.to_string();
345
            anyhow::Ok((token, body["expires_in"].as_i64().unwrap_or(3600)))
346
        })?;
347
        *self.token.lock().unwrap() = Some((token.clone(), now + expires_in * 1000));
348
        Ok(token)
349
    }
350
351
    fn object_url(&self, key: &str) -> Result<reqwest::Url> {
352
        let mut u = reqwest::Url::parse(&format!("{}/storage/v1/b/{}/o", self.storage, self.bucket))?;
353
        u.path_segments_mut().map_err(|_| anyhow::anyhow!("bad storage URL"))?.push(&self.name(key));
354
        Ok(u)
355
    }
356
357
    fn refused(&self, what: &str, status: reqwest::StatusCode, body: &str) -> anyhow::Error {
358
        let hint = if status == reqwest::StatusCode::FORBIDDEN || status == reqwest::StatusCode::UNAUTHORIZED {
359
            format!(" (grant roles/storage.objectAdmin on gs://{} to the principal …/subject/{})", self.bucket, self.subject)
360
        } else {
361
            String::new()
362
        };
363
        anyhow::anyhow!("GCS {what}: {status}{hint}: {}", body.chars().take(200).collect::<String>())
364
    }
365
366
    /// Every object name under `full` (no delimiter), for removal.
367
    fn all_under(&self, full: &str) -> Result<Vec<String>> {
368
        let mut out = Vec::new();
369
        let mut page: Option<String> = None;
370
        loop {
371
            let token = self.access()?;
372
            let mut u = reqwest::Url::parse(&format!("{}/storage/v1/b/{}/o", self.storage, self.bucket))?;
373
            u.query_pairs_mut().append_pair("prefix", full).append_pair("fields", "items(name),nextPageToken");
374
            if let Some(p) = &page {
375
                u.query_pairs_mut().append_pair("pageToken", p);
376
            }
377
            let body: serde_json::Value = self.rt.block_on(async {
378
                let res = self.client.get(u).bearer_auth(&token).send().await?;
379
                let status = res.status();
380
                let text = res.text().await?;
381
                if !status.is_success() {
382
                    return Err(self.refused("list", status, &text));
383
                }
384
                anyhow::Ok(serde_json::from_str(&text)?)
385
            })?;
386
            out.extend(body["items"].as_array().into_iter().flatten().filter_map(|i| i["name"].as_str().map(String::from)));
387
            match body["nextPageToken"].as_str() {
388
                Some(p) => page = Some(p.to_string()),
389
                None => return Ok(out),
390
            }
391
        }
392
    }
393
}
394
7b9f4570 Andy McCall ↶ 395
/// An S3 bucket, written keylessly (§3): the hub's own short-lived token
396
/// (`sub = backup:OWNER`, audience `sts.amazonaws.com`) is exchanged at AWS
397
/// STS (AssumeRoleWithWebIdentity) for an hour's credentials of the role
398
/// the owner names, and they sign each request (Signature Version 4).
399
pub struct S3 {
400
    bucket: String,
401
    prefix: String,
402
    region: String,
403
    /// The bucket's endpoint: scheme, host and any path before keys.
404
    base: reqwest::Url,
405
    sts: String,
406
    /// The IAM role's ARN.
407
    role: String,
408
    subject: String,
409
    app: Shared,
410
    client: reqwest::Client,
411
    rt: tokio::runtime::Handle,
412
    creds: std::sync::Mutex<Option<Creds>>,
413
}
414
415
#[derive(Clone)]
416
struct Creds {
417
    id: String,
418
    secret: String,
419
    token: String,
420
    until: i64,
421
}
422
423
/// The audience AWS expects of a web identity token.
424
pub const AWS_AUDIENCE: &str = "sts.amazonaws.com";
425
426
/// Percent-encoding as AWS signs it: everything but unreserved characters,
427
/// and `/` too unless `keep_slash`.
428
pub fn aws_encode(s: &str, keep_slash: bool) -> String {
429
    let mut out = String::new();
430
    for b in s.bytes() {
431
        match b {
432
            b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b'.' | b'~' => out.push(b as char),
433
            b'/' if keep_slash => out.push('/'),
434
            _ => out.push_str(&format!("%{b:02X}")),
435
        }
436
    }
437
    out
438
}
439
440
fn hmac(key: &[u8], data: &str) -> Vec<u8> {
441
    use hmac::Mac;
442
    let mut m = hmac::Hmac::<sha2::Sha256>::new_from_slice(key).expect("any key length");
443
    m.update(data.as_bytes());
444
    m.finalize().into_bytes().to_vec()
445
}
446
447
fn sha256_hex(data: &[u8]) -> String {
448
    use sha2::Digest;
449
    hex::encode(sha2::Sha256::digest(data))
450
}
451
452
/// AWS Signature Version 4: the `Authorization` header for one request.
453
/// `uri` is the path as encoded on the wire, `query` the decoded pairs,
454
/// `headers` the signed ones (any case), `payload` the body's SHA-256 in
455
/// hex, `amz_date` as `20130524T000000Z`.
456
#[allow(clippy::too_many_arguments)]
457
pub fn sigv4(
458
    method: &str,
459
    uri: &str,
460
    query: &[(String, String)],
461
    headers: &[(String, String)],
462
    payload: &str,
463
    (id, secret): (&str, &str),
464
    region: &str,
465
    service: &str,
466
    amz_date: &str,
467
) -> String {
468
    let mut q: Vec<(String, String)> = query.iter().map(|(k, v)| (aws_encode(k, false), aws_encode(v, false))).collect();
469
    q.sort();
470
    let query = q.iter().map(|(k, v)| format!("{k}={v}")).collect::<Vec<_>>().join("&");
471
    let mut h: Vec<(String, String)> = headers.iter().map(|(k, v)| (k.to_ascii_lowercase(), v.trim().to_string())).collect();
472
    h.sort();
473
    let canonical_headers: String = h.iter().map(|(k, v)| format!("{k}:{v}\n")).collect();
474
    let signed = h.iter().map(|(k, _)| k.as_str()).collect::<Vec<_>>().join(";");
475
    let request = format!("{method}\n{uri}\n{query}\n{canonical_headers}\n{signed}\n{payload}");
476
    let date = &amz_date[..8];
477
    let scope = format!("{date}/{region}/{service}/aws4_request");
478
    let to_sign = format!("AWS4-HMAC-SHA256\n{amz_date}\n{scope}\n{}", sha256_hex(request.as_bytes()));
479
    let key = hmac(&hmac(&hmac(&hmac(format!("AWS4{secret}").as_bytes(), date), region), service), "aws4_request");
480
    let signature = hex::encode(hmac(&key, &to_sign));
481
    format!("AWS4-HMAC-SHA256 Credential={id}/{scope}, SignedHeaders={signed}, Signature={signature}")
482
}
483
484
/// The text of the first `<tag>` in `xml`, unescaped.
485
fn xml_text(xml: &str, tag: &str) -> Option<String> {
486
    xml_blocks(xml, tag).into_iter().next().map(xml_unescape)
487
}
488
489
/// The inside of every `<tag>…</tag>` in `xml`.
490
fn xml_blocks<'a>(xml: &'a str, tag: &str) -> Vec<&'a str> {
491
    let (open, close) = (format!("<{tag}>"), format!("</{tag}>"));
492
    let mut out = Vec::new();
493
    let mut rest = xml;
494
    while let Some(i) = rest.find(&open) {
495
        let after = &rest[i + open.len()..];
496
        let Some(j) = after.find(&close) else { break };
497
        out.push(&after[..j]);
498
        rest = &after[j + close.len()..];
499
    }
500
    out
501
}
502
503
fn xml_unescape(s: &str) -> String {
504
    s.replace("&lt;", "<").replace("&gt;", ">").replace("&quot;", "\"").replace("&apos;", "'").replace("&amp;", "&")
505
}
506
507
fn amz_date(ms: i64) -> String {
508
    let t = time::OffsetDateTime::from_unix_timestamp_nanos(ms as i128 * 1_000_000).unwrap_or(time::OffsetDateTime::UNIX_EPOCH);
509
    format!("{:04}{:02}{:02}T{:02}{:02}{:02}Z", t.year(), u8::from(t.month()), t.day(), t.hour(), t.minute(), t.second())
510
}
511
512
impl S3 {
513
    pub fn new(app: &Shared, s: &Setting) -> S3 {
514
        let url = app.config.backups.s3_url.replace("{bucket}", &s.target).replace("{region}", &s.region);
515
        S3 {
516
            bucket: s.target.clone(),
517
            prefix: s.prefix.trim_matches('/').to_string(),
518
            region: s.region.clone(),
519
            base: reqwest::Url::parse(url.trim_end_matches('/')).unwrap_or_else(|_| reqwest::Url::parse("https://invalid.").unwrap()),
520
            sts: app.config.backups.aws_sts_url.trim_end_matches('/').to_string(),
521
            role: s.provider.clone(),
522
            subject: format!("backup:{}", s.owner),
523
            app: app.clone(),
524
            client: reqwest::Client::builder().timeout(std::time::Duration::from_secs(300)).build().unwrap_or_default(),
525
            rt: tokio::runtime::Handle::current(),
526
            creds: std::sync::Mutex::new(None),
527
        }
528
    }
529
530
    fn name(&self, key: &str) -> String {
531
        if self.prefix.is_empty() {
532
            key.to_string()
533
        } else {
534
            format!("{}/{key}", self.prefix)
535
        }
536
    }
537
538
    /// Credentials of the owner's role, exchanged again when the last are
539
    /// within five minutes of running out.
540
    fn creds(&self) -> Result<Creds> {
541
        let now = db::now_ms();
542
        if let Some(c) = self.creds.lock().unwrap().as_ref() {
543
            if c.until - now > 300_000 {
544
                return Ok(c.clone());
545
            }
546
        }
547
        let session: String = format!("oxygenhub-{}", self.subject.trim_start_matches("backup:"))
548
            .chars()
549
            .filter(|c| c.is_ascii_alphanumeric() || "=,.@-_".contains(*c))
550
            .take(64)
551
            .collect();
552
        let c = self.rt.block_on(async {
553
            let issuer = self.app.oidc().await?;
554
            let jwt = issuer.mint_for(self.app.config.base_url(), &self.subject, AWS_AUDIENCE, db::now_ms(), 600);
555
            let res = self
556
                .client
557
                .post(format!("{}/", self.sts))
558
                .form(&[
559
                    ("Action", "AssumeRoleWithWebIdentity"),
560
                    ("Version", "2011-06-15"),
561
                    ("RoleArn", self.role.as_str()),
562
                    ("RoleSessionName", session.as_str()),
563
                    ("WebIdentityToken", jwt.as_str()),
564
                    ("DurationSeconds", "3600"),
565
                ])
566
                .send()
567
                .await?;
568
            let status = res.status();
569
            let text = res.text().await.unwrap_or_default();
570
            if !status.is_success() {
571
                bail!(
572
                    "AWS STS refused {} for {}: {} (check the role's trust policy: this hub's address as its OIDC provider, audience {AWS_AUDIENCE}, and sub {})",
573
                    self.subject,
574
                    self.role,
575
                    xml_text(&text, "Message").unwrap_or_else(|| status.to_string()),
576
                    self.subject
577
                );
578
            }
579
            let get = |t: &str| xml_text(&text, t).with_context(|| format!("AWS STS gave no {t}"));
580
            anyhow::Ok(Creds { id: get("AccessKeyId")?, secret: get("SecretAccessKey")?, token: get("SessionToken")?, until: now + 3_600_000 })
581
        })?;
582
        *self.creds.lock().unwrap() = Some(c.clone());
583
        Ok(c)
584
    }
585
586
    /// One signed request: `key` is an object's (none for the bucket).
587
    fn send(
588
        &self,
589
        method: reqwest::Method,
590
        key: Option<&str>,
591
        query: &[(String, String)],
592
        body: Vec<u8>,
593
    ) -> Result<(reqwest::StatusCode, Vec<u8>)> {
594
        let c = self.creds()?;
595
        let base_path = self.base.path().trim_end_matches('/');
596
        let uri = match key {
597
            Some(k) => format!("{base_path}/{}", aws_encode(&self.name(k), true)),
598
            None => format!("{base_path}/"),
599
        };
600
        let host = match self.base.port() {
601
            Some(p) => format!("{}:{p}", self.base.host_str().unwrap_or_default()),
602
            None => self.base.host_str().unwrap_or_default().to_string(),
603
        };
604
        let payload = sha256_hex(&body);
605
        let date = amz_date(db::now_ms());
606
        let headers = vec![
607
            ("host".to_string(), host.clone()),
608
            ("x-amz-content-sha256".to_string(), payload.clone()),
609
            ("x-amz-date".to_string(), date.clone()),
610
            ("x-amz-security-token".to_string(), c.token.clone()),
611
        ];
612
        let auth = sigv4(method.as_str(), &uri, query, &headers, &payload, (&c.id, &c.secret), &self.region, "s3", &date);
613
        let mut q: Vec<(String, String)> = query.iter().map(|(k, v)| (aws_encode(k, false), aws_encode(v, false))).collect();
614
        q.sort();
615
        let qs = q.iter().map(|(k, v)| format!("{k}={v}")).collect::<Vec<_>>().join("&");
616
        let url = format!("{}://{host}{uri}{}{qs}", self.base.scheme(), if qs.is_empty() { "" } else { "?" });
0cd11874 Andy McCall ↶ 617
        let method_has_body = method == reqwest::Method::PUT;
7b9f4570 Andy McCall ↶ 618
        self.rt.block_on(async {
619
            let mut req = self
620
                .client
621
                .request(method, &url)
622
                .header("authorization", auth)
623
                .header("x-amz-content-sha256", &payload)
624
                .header("x-amz-date", &date)
625
                .header("x-amz-security-token", &c.token);
626
            if !body.is_empty() {
0cd11874 Andy McCall ↶ 627
                req = req.header("content-type", "application/octet-stream");
7b9f4570 Andy McCall ↶ 628
            }
0cd11874 Andy McCall ↶ 629
            // Always the length, an empty body's too: S3 and GCS refuse
630
            // an upload without one (411 Length Required).
631
            if method_has_body {
632
                req = req.header("content-length", body.len().to_string()).body(body);
633
            }
7b9f4570 Andy McCall ↶ 634
            let res = req.send().await?;
635
            let status = res.status();
636
            anyhow::Ok((status, res.bytes().await?.to_vec()))
637
        })
638
    }
639
640
    fn refused(&self, what: &str, status: reqwest::StatusCode, body: &[u8]) -> anyhow::Error {
641
        let text = String::from_utf8_lossy(body);
642
        let hint = if status == reqwest::StatusCode::FORBIDDEN {
643
            format!(" (the role {} needs s3:GetObject, s3:PutObject, s3:DeleteObject and s3:ListBucket on {})", self.role, self.bucket)
644
        } else {
645
            String::new()
646
        };
647
        anyhow::anyhow!("S3 {what}: {status}{hint}: {}", xml_text(&text, "Message").unwrap_or_else(|| text.chars().take(200).collect()))
648
    }
649
650
    /// The keys under `full` (`delimited`: and the next level's prefixes).
651
    fn listing(&self, full: &str, delimited: bool) -> Result<(Vec<String>, Vec<String>)> {
652
        let (mut keys, mut prefixes) = (Vec::new(), Vec::new());
653
        let mut token: Option<String> = None;
654
        loop {
655
            let mut q = vec![("list-type".to_string(), "2".to_string()), ("prefix".to_string(), full.to_string())];
656
            if delimited {
657
                q.push(("delimiter".to_string(), "/".to_string()));
658
            }
659
            if let Some(t) = &token {
660
                q.push(("continuation-token".to_string(), t.clone()));
661
            }
662
            let (status, body) = self.send(reqwest::Method::GET, None, &q, Vec::new())?;
663
            if !status.is_success() {
664
                return Err(self.refused("list", status, &body));
665
            }
666
            let text = String::from_utf8_lossy(&body).into_owned();
667
            for c in xml_blocks(&text, "Contents") {
668
                keys.extend(xml_text(c, "Key"));
669
            }
670
            for c in xml_blocks(&text, "CommonPrefixes") {
671
                prefixes.extend(xml_text(c, "Prefix"));
672
            }
673
            match (xml_text(&text, "IsTruncated").as_deref(), xml_text(&text, "NextContinuationToken")) {
674
                (Some("true"), Some(t)) => token = Some(t),
675
                _ => return Ok((keys, prefixes)),
676
            }
677
        }
678
    }
679
}
680
681
impl Destination for S3 {
682
    fn exists(&self, key: &str) -> Result<bool> {
683
        let (status, body) = self.send(reqwest::Method::HEAD, Some(key), &[], Vec::new())?;
684
        match status {
685
            s if s.is_success() => Ok(true),
686
            reqwest::StatusCode::NOT_FOUND => Ok(false),
687
            s => Err(self.refused("read", s, &body)),
688
        }
689
    }
690
    fn put(&self, key: &str, bytes: &[u8]) -> Result<()> {
691
        let (status, body) = self.send(reqwest::Method::PUT, Some(key), &[], bytes.to_vec())?;
692
        if !status.is_success() {
693
            return Err(self.refused("write", status, &body));
694
        }
695
        Ok(())
696
    }
697
    fn get(&self, key: &str) -> Result<Vec<u8>> {
698
        let (status, body) = self.send(reqwest::Method::GET, Some(key), &[], Vec::new())?;
699
        if !status.is_success() {
700
            return Err(self.refused(&format!("read {key}"), status, &body));
701
        }
702
        Ok(body)
703
    }
704
    fn list(&self, prefix: &str) -> Result<Vec<String>> {
705
        let full = format!("{}/", self.name(prefix.trim_end_matches('/')));
706
        let (keys, prefixes) = self.listing(&full, true)?;
707
        let mut out: std::collections::BTreeSet<String> = keys.iter().map(|k| k.trim_start_matches(&full).to_string()).collect();
708
        out.extend(prefixes.iter().map(|p| p.trim_start_matches(&full).trim_end_matches('/').to_string()));
709
        Ok(out.into_iter().filter(|n| !n.is_empty()).collect())
710
    }
711
    fn remove(&self, key: &str) -> Result<()> {
712
        let full = self.name(key);
713
        let (mut keys, _) = self.listing(&format!("{full}/"), false)?;
714
        keys.push(full);
715
        for k in keys {
716
            let rel = if self.prefix.is_empty() { k.clone() } else { k.trim_start_matches(&format!("{}/", self.prefix)).to_string() };
717
            let (status, body) = self.send(reqwest::Method::DELETE, Some(&rel), &[], Vec::new())?;
718
            if !status.is_success() && status != reqwest::StatusCode::NOT_FOUND {
719
                return Err(self.refused("remove", status, &body));
720
            }
721
        }
722
        Ok(())
723
    }
724
}
725
35fea423 Andy McCall ↶ 726
impl Destination for Gcs {
727
    fn exists(&self, key: &str) -> Result<bool> {
728
        let token = self.access()?;
729
        let mut u = self.object_url(key)?;
730
        u.query_pairs_mut().append_pair("fields", "name");
731
        self.rt.block_on(async {
732
            let res = self.client.get(u).bearer_auth(&token).send().await?;
733
            match res.status() {
734
                s if s.is_success() => Ok(true),
735
                reqwest::StatusCode::NOT_FOUND => Ok(false),
736
                s => Err(self.refused("read", s, &res.text().await.unwrap_or_default())),
737
            }
738
        })
739
    }
740
    fn put(&self, key: &str, bytes: &[u8]) -> Result<()> {
741
        let token = self.access()?;
742
        let mut u = reqwest::Url::parse(&format!("{}/upload/storage/v1/b/{}/o", self.storage, self.bucket))?;
743
        u.query_pairs_mut().append_pair("uploadType", "media").append_pair("name", &self.name(key));
744
        let body = bytes.to_vec();
745
        self.rt.block_on(async {
0cd11874 Andy McCall ↶ 746
            // The length always, an empty object's too: Google refuses an
747
            // upload without one (411 Length Required).
748
            let res = self
749
                .client
750
                .post(u)
751
                .bearer_auth(&token)
752
                .header("content-type", "application/octet-stream")
753
                .header("content-length", body.len().to_string())
754
                .body(body)
755
                .send()
756
                .await?;
35fea423 Andy McCall ↶ 757
            let status = res.status();
758
            if !status.is_success() {
759
                return Err(self.refused("write", status, &res.text().await.unwrap_or_default()));
760
            }
761
            Ok(())
762
        })
763
    }
764
    fn get(&self, key: &str) -> Result<Vec<u8>> {
765
        let token = self.access()?;
766
        let mut u = self.object_url(key)?;
767
        u.query_pairs_mut().append_pair("alt", "media");
768
        self.rt.block_on(async {
769
            let res = self.client.get(u).bearer_auth(&token).send().await?;
770
            let status = res.status();
771
            if !status.is_success() {
772
                return Err(self.refused(&format!("read {key}"), status, &res.text().await.unwrap_or_default()));
773
            }
774
            Ok(res.bytes().await?.to_vec())
775
        })
776
    }
777
    fn list(&self, prefix: &str) -> Result<Vec<String>> {
778
        let full = format!("{}/", self.name(prefix.trim_end_matches('/')));
779
        let mut out = std::collections::BTreeSet::new();
780
        let mut page: Option<String> = None;
781
        loop {
782
            let token = self.access()?;
783
            let mut u = reqwest::Url::parse(&format!("{}/storage/v1/b/{}/o", self.storage, self.bucket))?;
784
            u.query_pairs_mut()
785
                .append_pair("prefix", &full)
786
                .append_pair("delimiter", "/")
787
                .append_pair("fields", "items(name),prefixes,nextPageToken");
788
            if let Some(p) = &page {
789
                u.query_pairs_mut().append_pair("pageToken", p);
790
            }
791
            let body: serde_json::Value = self.rt.block_on(async {
792
                let res = self.client.get(u).bearer_auth(&token).send().await?;
793
                let status = res.status();
794
                let text = res.text().await?;
795
                if !status.is_success() {
796
                    return Err(self.refused("list", status, &text));
797
                }
798
                anyhow::Ok(serde_json::from_str(&text)?)
799
            })?;
800
            for n in body["items"].as_array().into_iter().flatten().filter_map(|i| i["name"].as_str()) {
801
                out.insert(n.trim_start_matches(&full).to_string());
802
            }
803
            for p in body["prefixes"].as_array().into_iter().flatten().filter_map(|p| p.as_str()) {
804
                out.insert(p.trim_start_matches(&full).trim_end_matches('/').to_string());
805
            }
806
            match body["nextPageToken"].as_str() {
807
                Some(p) => page = Some(p.to_string()),
808
                None => return Ok(out.into_iter().filter(|n| !n.is_empty()).collect()),
809
            }
810
        }
811
    }
812
    fn remove(&self, key: &str) -> Result<()> {
813
        let mut names = self.all_under(&format!("{}/", self.name(key)))?;
814
        names.push(self.name(key));
815
        for n in names {
816
            let token = self.access()?;
817
            let mut u = reqwest::Url::parse(&format!("{}/storage/v1/b/{}/o", self.storage, self.bucket))?;
818
            u.path_segments_mut().map_err(|_| anyhow::anyhow!("bad storage URL"))?.push(&n);
819
            self.rt.block_on(async {
820
                let res = self.client.delete(u).bearer_auth(&token).send().await?;
821
                match res.status() {
822
                    s if s.is_success() || s == reqwest::StatusCode::NOT_FOUND => Ok(()),
823
                    s => Err(self.refused("delete", s, &res.text().await.unwrap_or_default())),
824
                }
825
            })?;
826
        }
827
        Ok(())
828
    }
829
}
830
831
/// Check a destination end to end: write a probe, read it back, remove it.
832
pub fn probe(dest: &dyn Destination) -> Result<()> {
833
    let marker = format!("probe {}", db::now_ms());
834
    dest.put(".oxyhub-probe", marker.as_bytes())?;
835
    if dest.get(".oxyhub-probe")? != marker.as_bytes() {
836
        bail!("the probe read back differently");
837
    }
838
    dest.remove(".oxyhub-probe")
839
}
840
d7d18246 Andy McCall ↶ 841
/// The owner's destination, from its setting and the site's rules.
842
pub fn destination(app: &Shared, s: &Setting) -> Result<Box<dyn Destination>> {
843
    match s.destination.as_str() {
844
        "dir" => {
845
            let allowed = &app.config.backups.directories;
846
            let target = PathBuf::from(&s.target);
847
            if !allowed.contains(&target) {
848
                bail!("{} is not a backup directory this hub allows (hub.toml [backups] directories)", s.target);
849
            }
850
            let mut root = target.join(&s.owner);
851
            if !s.prefix.is_empty() {
852
                root = root.join(s.prefix.trim_matches('/'));
853
            }
854
            Ok(Box::new(Directory { root }))
35fea423 Andy McCall ↶ 855
        }
856
        "gcs" => {
857
            if s.target.is_empty() || s.provider.is_empty() {
858
                bail!("a GCS destination needs its bucket and its workload identity provider");
859
            }
860
            Ok(Box::new(Gcs::new(app, s)))
7b9f4570 Andy McCall ↶ 861
        }
862
        "s3" => {
863
            if s.target.is_empty() || s.provider.is_empty() || s.region.is_empty() {
864
                bail!("an S3 destination needs its bucket, its region and the IAM role the hub assumes");
865
            }
866
            Ok(Box::new(S3::new(app, s)))
d7d18246 Andy McCall ↶ 867
        }
868
        other => bail!("unknown destination {other:?}"),
869
    }
870
}
871
872
// ---------------------------------------------------------------- what
873
874
/// One file of a repository's store, in a manifest.
875
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
876
pub struct File {
877
    pub path: String,
878
    pub size: u64,
879
    /// Its modification time in nanoseconds: unchanged size and time mean
880
    /// unchanged content, so it is not hashed again.
881
    pub mtime: i128,
882
    pub hash: String,
883
}
884
885
/// A repository at one run.
886
#[derive(Clone, Debug, Serialize, Deserialize)]
887
pub struct Manifest {
888
    pub owner: String,
889
    pub name: String,
890
    /// `repos` or `wikis`.
891
    pub kind: String,
892
    pub files: Vec<File>,
9041db4e Andy McCall ↶ 893
}
894
895
/// A repository's name as one key segment: a drop's `drops/ID` becomes
896
/// `drops~ID` (#280), so a run's manifests and records stay one level deep;
897
/// the files inside keep the real name, which restore uses.
898
fn key_name(name: &str) -> String {
899
    name.replace('/', "~")
d7d18246 Andy McCall ↶ 900
}
901
902
fn blob_key(hash: &str) -> String {
903
    format!("blobs/{}/{hash}", &hash[..2])
904
}
905
906
/// The large files that never change once written come first.
907
fn immutable(path: &str) -> bool {
908
    path.starts_with(".oxy/objects/") && (path.contains("/pack-") || path.contains("/loose/"))
909
}
910
911
#[derive(Default)]
912
struct Sent {
913
    files: i64,
914
    sent: i64,
915
    bytes: i64,
916
}
917
918
/// Walk `dir`, sending each file the destination lacks; `known` says which
919
/// paths are unchanged since the last run (and their hashes).
920
fn copy_dir(dest: &dyn Destination, dir: &Path, known: &HashMap<String, File>, only_immutable: bool, sent: &mut Sent) -> Result<Vec<File>> {
921
    let mut out = Vec::new();
922
    let mut stack = vec![dir.to_path_buf()];
923
    while let Some(d) = stack.pop() {
924
        let entries = match std::fs::read_dir(&d) {
925
            Ok(e) => e,
926
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => continue,
927
            Err(e) => return Err(e.into()),
928
        };
929
        for e in entries.flatten() {
930
            let p = e.path();
931
            let ft = e.file_type()?;
932
            if ft.is_dir() {
933
                stack.push(p);
934
                continue;
935
            }
936
            if !ft.is_file() {
937
                continue;
938
            }
939
            let rel = p.strip_prefix(dir).unwrap_or(&p).to_string_lossy().replace('\\', "/");
940
            if only_immutable && !immutable(&rel) {
941
                continue;
942
            }
943
            // A file packed away while the walk ran is simply gone.
944
            let Ok(md) = std::fs::metadata(&p) else { continue };
945
            let mtime =
946
                md.modified().ok().and_then(|t| t.duration_since(std::time::UNIX_EPOCH).ok()).map(|d| d.as_nanos() as i128).unwrap_or(0);
947
            let size = md.len();
948
            sent.files += 1;
949
            if let Some(k) = known.get(&rel).filter(|k| k.size == size && k.mtime == mtime) {
950
                out.push(k.clone());
951
                continue;
952
            }
953
            let Ok(bytes) = std::fs::read(&p) else { continue };
954
            let hash = blake3::hash(&bytes).to_hex().to_string();
955
            let key = blob_key(&hash);
956
            if !dest.exists(&key)? {
957
                dest.put(&key, &bytes)?;
958
                sent.sent += 1;
959
                sent.bytes += bytes.len() as i64;
960
            }
961
            out.push(File { path: rel, size, mtime, hash });
962
        }
963
    }
964
    out.sort_by(|a, b| a.path.cmp(&b.path));
965
    Ok(out)
966
}
967
968
// ---------------------------------------------------------------- records
969
970
/// Tables and columns never written: secrets, credentials, sessions.
971
fn private_table(t: &str) -> bool {
972
    ["secret", "token", "session", "password", "totp", "recovery", "sqlx"].iter().any(|w| t.contains(w))
973
}
974
975
fn private_column(c: &str) -> bool {
976
    ["secret", "token", "password", "salt", "totp", "sealed", "hash_key"].iter().any(|w| c.contains(w))
977
}
978
979
async fn tables(pool: &Pool) -> Result<Vec<String>> {
3b1bc27f Andy McCall 980
    let mut t = catalog::tables(pool).await?;
d7d18246 Andy McCall ↶ 981
    t.retain(|t| !private_table(t));
982
    t.sort();
983
    Ok(t)
984
}
985
986
async fn columns(pool: &Pool, table: &str) -> Result<Vec<String>> {
3b1bc27f Andy McCall 987
    Ok(table_cols(pool, table).await?.into_iter().map(|c| c.name).collect())
d7d18246 Andy McCall ↶ 988
}
989
990
/// The rows of `table` matching `cond`, as a JSON array, private columns
3b1bc27f Andy McCall 991
/// left out, blobs as hex and flags as 0 or 1, whichever engine wrote them,
992
/// so a run from either restores into either.
d7d18246 Andy McCall ↶ 993
async fn rows(pool: &Pool, table: &str, cond: &str) -> Result<serde_json::Value> {
3b1bc27f Andy McCall 994
    let cols: Vec<Col> = table_cols(pool, table).await?.into_iter().filter(|c| !private_column(&c.name)).collect();
995
    if cols.is_empty() {
d7d18246 Andy McCall ↶ 996
        return Ok(serde_json::json!([]));
997
    }
3b1bc27f Andy McCall 998
    let text: String = sqlx::query_scalar(&catalog::rows_sql(table, &cols, cond)).fetch_one(pool).await?;
d7d18246 Andy McCall ↶ 999
    Ok(serde_json::from_str(&text)?)
1000
}
1001
3b1bc27f Andy McCall 1002
/// What backups ask of the database's own catalog, per engine. Column
1003
/// types are given in SQLite's words (INTEGER, TEXT, BLOB, REAL) plus
1004
/// BOOLEAN, which only Postgres has.
1005
#[cfg(not(feature = "postgres"))]
1006
mod catalog {
1007
    use super::{Col, Pool, Result};
1008
1009
    pub async fn tables(pool: &Pool) -> Result<Vec<String>> {
1010
        Ok(sqlx::query_scalar("SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT LIKE 'sqlite_%'").fetch_all(pool).await?)
1011
    }
1012
1013
    pub async fn cols(pool: &Pool, table: &str) -> Result<Vec<Col>> {
1014
        let rows: Vec<(String, String, i64, Option<String>, i64)> =
1015
            sqlx::query_as(&format!("SELECT name, type, \"notnull\", dflt_value, pk FROM pragma_table_info('{table}')"))
1016
                .fetch_all(pool)
1017
                .await?;
1018
        Ok(rows.into_iter().map(|(name, ty, notnull, default, pk)| Col { name, ty, notnull: notnull != 0, default, pk }).collect())
1019
    }
1020
1021
    /// `(parent table, column, parent column)` for each reference.
1022
    pub async fn fks(pool: &Pool, table: &str) -> Result<Vec<(String, String, String)>> {
1023
        Ok(sqlx::query_as(&format!("SELECT \"table\", \"from\", \"to\" FROM pragma_foreign_key_list('{table}')")).fetch_all(pool).await?)
1024
    }
1025
1026
    pub fn rows_sql(table: &str, cols: &[Col], cond: &str) -> String {
1027
        let fields: Vec<String> =
1028
            cols.iter().map(|c| format!("'{0}', CASE WHEN typeof(\"{0}\") = 'blob' THEN hex(\"{0}\") ELSE \"{0}\" END", c.name)).collect();
1029
        format!("SELECT json_group_array(json_object({})) FROM \"{table}\" WHERE {cond}", fields.join(", "))
1030
    }
1031
1032
    /// How a restored row goes in when its key is taken: `INSERT …` then this.
1033
    pub fn insert(verb: super::Verb, _cols: &[String]) -> (&'static str, String) {
1034
        match verb {
1035
            super::Verb::Replace => ("INSERT OR REPLACE", String::new()),
1036
            super::Verb::New => ("INSERT", String::new()),
1037
            super::Verb::Ignore => ("INSERT OR IGNORE", String::new()),
1038
        }
1039
    }
1040
}
1041
1042
#[cfg(feature = "postgres")]
1043
mod catalog {
1044
    use super::{Col, Pool, Result};
1045
1046
    pub async fn tables(pool: &Pool) -> Result<Vec<String>> {
1047
        Ok(sqlx::query_scalar(
1048
            "SELECT CAST(relname AS TEXT) FROM pg_class WHERE relkind = 'r' AND relnamespace = CAST(current_schema() AS regnamespace)",
1049
        )
1050
        .fetch_all(pool)
1051
        .await?)
1052
    }
1053
1054
    /// Generated columns (the search index's) are left out: they are made,
1055
    /// never restored.
1056
    pub async fn cols(pool: &Pool, table: &str) -> Result<Vec<Col>> {
1057
        // pg_catalog, not information_schema: many times faster.
1058
        let rows: Vec<(String, String, bool, Option<String>, i64)> = sqlx::query_as(
1059
            "SELECT CAST(a.attname AS TEXT), format_type(a.atttypid, a.atttypmod), a.attnotnull, pg_get_expr(d.adbin, d.adrelid), \
1060
               CAST(COALESCE((SELECT array_position(k.conkey, a.attnum) FROM pg_constraint k WHERE k.conrelid = t.oid AND k.contype = 'p'), 0) AS BIGINT) \
1061
             FROM pg_attribute a JOIN pg_class t ON t.oid = a.attrelid \
1062
             LEFT JOIN pg_attrdef d ON d.adrelid = a.attrelid AND d.adnum = a.attnum \
1063
             WHERE t.relname = $1 AND t.relnamespace = CAST(current_schema() AS regnamespace) \
1064
               AND a.attnum > 0 AND NOT a.attisdropped AND a.attgenerated = '' ORDER BY a.attnum",
1065
        )
1066
        .bind(table)
1067
        .fetch_all(pool)
1068
        .await?;
1069
        Ok(rows
1070
            .into_iter()
1071
            .map(|(name, ty, notnull, default, pk)| {
1072
                let ty = match ty.as_str() {
1073
                    "bigint" | "integer" | "smallint" => "INTEGER",
1074
                    "bytea" => "BLOB",
1075
                    "boolean" => "BOOLEAN",
1076
                    "double precision" | "real" => "REAL",
1077
                    _ => "TEXT",
1078
                };
1079
                // An identity column's default is the sequence, as SQLite's
1080
                // rowid: none to give.
1081
                let default = default.filter(|d| !d.starts_with("nextval("));
1082
                Col { name, ty: ty.to_string(), notnull, default, pk }
1083
            })
1084
            .collect())
1085
    }
1086
1087
    /// `(parent table, column, parent column)` for each reference.
1088
    pub async fn fks(pool: &Pool, table: &str) -> Result<Vec<(String, String, String)>> {
1089
        Ok(sqlx::query_as(
1090
            "SELECT CAST(p.relname AS TEXT), CAST(a.attname AS TEXT), CAST(pa.attname AS TEXT) FROM pg_constraint k \
1091
             JOIN pg_class t ON t.oid = k.conrelid JOIN pg_class p ON p.oid = k.confrelid \
1092
             JOIN pg_attribute a ON a.attrelid = k.conrelid AND a.attnum = k.conkey[1] \
1093
             JOIN pg_attribute pa ON pa.attrelid = k.confrelid AND pa.attnum = k.confkey[1] \
1094
             WHERE k.contype = 'f' AND t.relname = $1 AND t.relnamespace = CAST(current_schema() AS regnamespace)",
1095
        )
1096
        .bind(table)
1097
        .fetch_all(pool)
1098
        .await?)
1099
    }
1100
1101
    pub fn rows_sql(table: &str, cols: &[Col], cond: &str) -> String {
1102
        let fields: Vec<String> = cols
1103
            .iter()
1104
            .map(|c| match c.ty.as_str() {
1105
                "BLOB" => format!("upper(encode(\"{0}\", 'hex')) AS \"{0}\"", c.name),
1106
                "BOOLEAN" => format!("CASE WHEN \"{0}\" THEN 1 ELSE 0 END AS \"{0}\"", c.name),
1107
                _ => format!("\"{0}\"", c.name),
1108
            })
1109
            .collect();
1110
        format!("SELECT CAST(COALESCE(json_agg(r), '[]') AS TEXT) FROM (SELECT {} FROM \"{table}\" WHERE {cond}) r", fields.join(", "))
1111
    }
1112
1113
    /// How a restored row goes in when its key is taken: `INSERT …` then this.
1114
    pub fn insert(verb: super::Verb, cols: &[String]) -> (&'static str, String) {
1115
        match verb {
1116
            super::Verb::Replace => {
1117
                let set: Vec<String> = cols.iter().filter(|c| *c != "repo_id").map(|c| format!("\"{c}\" = excluded.\"{c}\"")).collect();
1118
                let tail = if set.is_empty() {
1119
                    " ON CONFLICT (repo_id) DO NOTHING".to_string()
1120
                } else {
1121
                    format!(" ON CONFLICT (repo_id) DO UPDATE SET {}", set.join(", "))
1122
                };
1123
                ("INSERT", tail)
1124
            }
1125
            super::Verb::New => ("INSERT", String::new()),
1126
            super::Verb::Ignore => ("INSERT", " ON CONFLICT DO NOTHING".to_string()),
1127
        }
1128
    }
1129
}
1130
1131
/// How restored rows meet the rows already there.
1132
#[derive(Clone, Copy)]
1133
enum Verb {
1134
    /// One row per repository: the restored one wins.
1135
    Replace,
1136
    /// A row with an id of its own, given a new one.
1137
    New,
1138
    /// Kept as it is when already there.
1139
    Ignore,
1140
}
1141
d7d18246 Andy McCall ↶ 1142
/// Every row about something: the tables with column `key` equal to `id`,
1143
/// then, three levels deep, the tables whose foreign keys point at rows
1144
/// already taken (an issue's comments, a proposal's reviews and their
1145
/// threads).
1146
async fn records(pool: &Pool, key: &str, id: i64) -> Result<serde_json::Value> {
1147
    let all = tables(pool).await?;
1148
    let mut conds: Vec<(String, String)> = Vec::new();
1149
    for t in &all {
1150
        if columns(pool, t).await?.iter().any(|c| c == key) {
1151
            conds.push((t.clone(), format!("\"{key}\" = {id}")));
1152
        }
1153
    }
1154
    for _ in 0..3 {
1155
        let mut more = Vec::new();
1156
        for t in &all {
1157
            if conds.iter().any(|(c, _)| c == t) || more.iter().any(|(c, _): &(String, String)| c == t) {
1158
                continue;
1159
            }
3b1bc27f Andy McCall 1160
            let fks = catalog::fks(pool, t).await?;
d7d18246 Andy McCall ↶ 1161
            if let Some((parent, from, to, pcond)) = fks
1162
                .iter()
1163
                .find_map(|(p, f, to)| conds.iter().find(|(c, _)| c == p).map(|(_, pc)| (p.clone(), f.clone(), to.clone(), pc.clone())))
1164
            {
1165
                more.push((t.clone(), format!("\"{from}\" IN (SELECT \"{to}\" FROM \"{parent}\" WHERE {pcond})")));
1166
            }
1167
        }
1168
        if more.is_empty() {
1169
            break;
1170
        }
1171
        conds.extend(more);
1172
    }
1173
    let mut out = serde_json::Map::new();
1174
    for (t, cond) in conds {
1175
        let r = rows(pool, &t, &cond).await?;
1176
        if r.as_array().is_some_and(|a| !a.is_empty()) {
1177
            out.insert(t, r);
1178
        }
1179
    }
1180
    Ok(serde_json::Value::Object(out))
1181
}
1182
5ef6cf72 Andy McCall ↶ 1183
/// The key of a run's records naming the accounts, teams and organisations
1184
/// their rows point at, by id: `{"accounts": {"7": "andy"}, …}`.
1185
const NAMES: &str = "_names";
1186
1187
/// Tables a restore leaves out: the search index (rebuilt from what is
1188
/// restored), and what is passing or personal rather than the
1189
/// repository's: inboxes, webhook deliveries, runners' declines.
1190
const NOT_RESTORED: [&str; 5] = ["search", "notifications", "deliveries", "flow_declines", NAMES];
1191
1192
async fn fk_list(pool: &Pool, table: &str) -> Result<Vec<(String, String, String)>> {
3b1bc27f Andy McCall 1193
    catalog::fks(pool, table).await
5ef6cf72 Andy McCall ↶ 1194
}
1195
1196
/// The names behind the account, team and organisation ids that `rec`'s
1197
/// rows point at, so a restore on another hub finds them again by name.
1198
async fn names_of(pool: &Pool, rec: &serde_json::Value) -> Result<serde_json::Value> {
1199
    let mut ids: HashMap<String, std::collections::BTreeSet<i64>> = HashMap::new();
1200
    for (table, rows) in rec.as_object().into_iter().flatten() {
1201
        let Some(rows) = rows.as_array() else { continue };
1202
        for (parent, from, _) in fk_list(pool, table).await? {
1203
            if ["accounts", "teams", "organisations"].contains(&parent.as_str()) {
1204
                ids.entry(parent).or_default().extend(rows.iter().filter_map(|r| r[&from].as_i64()));
1205
            }
1206
        }
1207
    }
1208
    let mut out = serde_json::Map::new();
1209
    for (kind, sql) in [
5d90e0e0 Andy McCall 1210
        ("accounts", "SELECT id, username FROM accounts WHERE id = $1"),
1211
        ("organisations", "SELECT id, name FROM organisations WHERE id = $1"),
1212
        ("teams", "SELECT t.id, o.name || '/' || t.name FROM teams t JOIN organisations o ON o.id = t.org_id WHERE t.id = $1"),
5ef6cf72 Andy McCall ↶ 1213
    ] {
1214
        let mut m = serde_json::Map::new();
1215
        for id in ids.get(kind).into_iter().flatten() {
1216
            if let Some((id, name)) = sqlx::query_as::<_, (i64, String)>(sql).bind(id).fetch_optional(pool).await? {
1217
                m.insert(id.to_string(), name.into());
1218
            }
1219
        }
1220
        out.insert(kind.into(), m.into());
1221
    }
1222
    Ok(out.into())
1223
}
1224
1225
/// The id `name` has on this hub as one of `_names`' kinds.
1226
async fn id_by_name(pool: &Pool, kind: &str, name: &str) -> Result<Option<i64>> {
1227
    Ok(match kind {
5d90e0e0 Andy McCall 1228
        "accounts" => sqlx::query_scalar("SELECT id FROM accounts WHERE username = $1").bind(name).fetch_optional(pool).await?,
1229
        "organisations" => sqlx::query_scalar("SELECT id FROM organisations WHERE name = $1").bind(name).fetch_optional(pool).await?,
5ef6cf72 Andy McCall ↶ 1230
        "teams" => match name.split_once('/') {
1231
            Some((org, team)) => {
5d90e0e0 Andy McCall 1232
                sqlx::query_scalar("SELECT t.id FROM teams t JOIN organisations o ON o.id = t.org_id WHERE o.name = $1 AND t.name = $2")
5ef6cf72 Andy McCall ↶ 1233
                    .bind(org)
1234
                    .bind(team)
1235
                    .fetch_optional(pool)
1236
                    .await?
1237
            }
1238
            None => None,
1239
        },
1240
        _ => None,
1241
    })
1242
}
1243
1244
/// One column of a table on this hub.
1245
struct Col {
1246
    name: String,
1247
    ty: String,
1248
    notnull: bool,
1249
    default: Option<String>,
1250
    pk: i64,
1251
}
1252
1253
async fn table_cols(pool: &Pool, table: &str) -> Result<Vec<Col>> {
3b1bc27f Andy McCall 1254
    catalog::cols(pool, table).await
5ef6cf72 Andy McCall ↶ 1255
}
1256
3b1bc27f Andy McCall 1257
/// Bind one value of a backed-up row to a column of type `ty`: blobs were
1258
/// written as hex, flags as 0 or 1 (a Postgres BOOLEAN takes them as such).
5ef6cf72 Andy McCall ↶ 1259
fn bind_json<'q>(
3b1bc27f Andy McCall 1260
    q: sqlx::query::Query<'q, crate::db::Db, <crate::db::Db as sqlx::Database>::Arguments<'q>>,
5ef6cf72 Andy McCall ↶ 1261
    v: serde_json::Value,
3b1bc27f Andy McCall 1262
    ty: &str,
1263
) -> sqlx::query::Query<'q, crate::db::Db, <crate::db::Db as sqlx::Database>::Arguments<'q>> {
1264
    let blob = ty.eq_ignore_ascii_case("BLOB");
1265
    if ty == "BOOLEAN" {
1266
        return match v {
1267
            serde_json::Value::Null => q.bind(None::<bool>),
1268
            serde_json::Value::Bool(b) => q.bind(b),
1269
            serde_json::Value::Number(n) => q.bind(n.as_f64().unwrap_or(0.0) != 0.0),
1270
            other => q.bind(matches!(other.as_str(), Some("1" | "true"))),
1271
        };
1272
    }
5ef6cf72 Andy McCall ↶ 1273
    match v {
1274
        serde_json::Value::Null => q.bind(None::<i64>),
1275
        serde_json::Value::Bool(b) => q.bind(b as i64),
1276
        serde_json::Value::Number(n) => match n.as_i64() {
1277
            Some(i) => q.bind(i),
1278
            None => q.bind(n.as_f64().unwrap_or(0.0)),
1279
        },
1280
        serde_json::Value::String(s) if blob => q.bind(hex::decode(&s).unwrap_or_else(|_| s.into_bytes())),
1281
        serde_json::Value::String(s) => q.bind(s),
1282
        other => q.bind(other.to_string()),
1283
    }
1284
}
1285
1286
/// Restore one repository's records from a run into this hub, the
1287
/// repository being `repo` here and `old` in the backup (docs/backups.md
1288
/// §7): its issues, proposals, labels, milestones, releases and their
1289
/// assets, checks, Flow runs and the rest, each table after the tables it
1290
/// points at, every id mapped to its new one and every account, team and
1291
/// organisation found again by name. A row pointing at an account this
1292
/// hub lacks keeps a blank reference where it may, and is left out where
1293
/// it may not. What needs re-entering (webhook secrets, never backed up)
1294
/// and what was left out come back as notes.
1295
async fn restore_records(
1296
    app: &Shared,
1297
    dest: &std::sync::Arc<dyn Destination>,
1298
    rec: &serde_json::Value,
1299
    old: i64,
1300
    repo: i64,
1301
) -> Result<Vec<String>> {
1302
    let pool = &app.db;
1303
    let obj = rec.as_object().context("the records are not an object")?;
1304
    let mut by_name: HashMap<(String, i64), Option<i64>> = HashMap::new();
1305
    for (kind, m) in obj.get(NAMES).and_then(|n| n.as_object()).into_iter().flatten() {
1306
        for (id, name) in m.as_object().into_iter().flatten() {
1307
            let (Ok(id), Some(name)) = (id.parse::<i64>(), name.as_str()) else { continue };
1308
            by_name.insert((kind.clone(), id), id_by_name(pool, kind, name).await?);
1309
        }
1310
    }
1311
    let here: std::collections::HashSet<String> = tables(pool).await?.into_iter().collect();
1312
    let mut notes = Vec::new();
1313
    let mut todo: Vec<String> = Vec::new();
1314
    for t in obj.keys().filter(|t| t.as_str() != "repositories" && !NOT_RESTORED.contains(&t.as_str())) {
1315
        if here.contains(t) {
1316
            todo.push(t.clone());
1317
        } else {
1318
            notes.push(format!("{t}: not a table on this hub, left out"));
1319
        }
1320
    }
1321
    let mut fks: HashMap<String, Vec<(String, String, String)>> = HashMap::new();
1322
    for t in &todo {
1323
        fks.insert(t.clone(), fk_list(pool, t).await?);
1324
    }
1325
    // Each table after the tables of the records it points at.
1326
    let mut order = Vec::new();
1327
    while !todo.is_empty() {
1328
        let mut ready: Vec<String> =
1329
            todo.iter().filter(|t| fks[*t].iter().all(|(p, _, _)| p == *t || !todo.contains(p))).cloned().collect();
1330
        if ready.is_empty() {
1331
            ready.push(todo[0].clone());
1332
        }
1333
        todo.retain(|t| !ready.contains(t));
1334
        order.extend(ready);
1335
    }
1336
    let mut maps: HashMap<String, HashMap<i64, i64>> = HashMap::new();
1337
    maps.insert("repositories".into(), [(old, repo)].into());
1338
    let mut left_out: std::collections::BTreeMap<String, usize> = Default::default();
1339
    let mut tx = pool.begin().await?;
1340
    for table in &order {
1341
        let cols = table_cols(pool, table).await?;
1342
        let keys: Vec<&str> = cols.iter().filter(|c| c.pk > 0).map(|c| c.name.as_str()).collect();
1343
        let by_id = keys == ["id"] && cols.iter().any(|c| c.name == "id" && c.ty.eq_ignore_ascii_case("INTEGER"));
1344
        let verb = if keys == ["repo_id"] {
3b1bc27f Andy McCall 1345
            Verb::Replace
5ef6cf72 Andy McCall ↶ 1346
        } else if by_id {
3b1bc27f Andy McCall 1347
            Verb::New
5ef6cf72 Andy McCall ↶ 1348
        } else {
3b1bc27f Andy McCall 1349
            Verb::Ignore
5ef6cf72 Andy McCall ↶ 1350
        };
1351
        let mut rows: Vec<&serde_json::Map<String, serde_json::Value>> =
1352
            obj[table].as_array().into_iter().flatten().filter_map(|r| r.as_object()).collect();
1353
        rows.sort_by_key(|r| r.get("id").and_then(|v| v.as_i64()).unwrap_or(0));
1354
        'row: for row in rows {
1355
            let (mut names, mut values) = (Vec::new(), Vec::new());
1356
            for c in &cols {
1357
                if by_id && c.name == "id" {
1358
                    continue;
1359
                }
1360
                let mut v = row.get(&c.name).cloned().filter(|v| !v.is_null());
1361
                if let Some((parent, _, _)) = fks[table].iter().find(|(_, from, _)| *from == c.name) {
1362
                    if let Some(was) = v.as_ref().and_then(|v| v.as_i64()) {
1363
                        let now = match parent.as_str() {
1364
                            "accounts" | "teams" | "organisations" => by_name.get(&(parent.clone(), was)).copied().flatten(),
1365
                            p => maps.get(p).and_then(|m| m.get(&was)).copied(),
1366
                        };
1367
                        if now.is_none() && c.notnull {
1368
                            *left_out.entry(table.clone()).or_default() += 1;
1369
                            continue 'row;
1370
                        }
1371
                        v = now.map(serde_json::Value::from);
1372
                    }
1373
                }
1374
                match v {
1375
                    Some(v) => {
1376
                        names.push(c.name.clone());
3b1bc27f Andy McCall 1377
                        values.push((v, c.ty.as_str()));
5ef6cf72 Andy McCall ↶ 1378
                    }
1379
                    // Never backed up (a secret): blank here, to enter again.
1380
                    None if c.notnull && c.default.is_none() => {
1381
                        names.push(c.name.clone());
3b1bc27f Andy McCall 1382
                        let blank = if c.ty.to_ascii_uppercase().contains("INT") || c.ty == "BOOLEAN" {
1383
                            serde_json::json!(0)
1384
                        } else {
1385
                            serde_json::json!("")
1386
                        };
1387
                        values.push((blank, c.ty.as_str()));
5ef6cf72 Andy McCall ↶ 1388
                    }
1389
                    None => {}
1390
                }
1391
            }
3b1bc27f Andy McCall 1392
            // A row with a new id says what it is (a plain INSERT, so one row).
1393
            let (insert, tail) = catalog::insert(verb, &names);
5ef6cf72 Andy McCall ↶ 1394
            let sql = format!(
3b1bc27f Andy McCall 1395
                "{insert} INTO \"{table}\" ({}) VALUES ({}){tail}{}",
5ef6cf72 Andy McCall ↶ 1396
                names.iter().map(|n| format!("\"{n}\"")).collect::<Vec<_>>().join(", "),
3b1bc27f Andy McCall 1397
                (1..=names.len()).map(|i| format!("${i}")).collect::<Vec<_>>().join(", "),
1398
                if by_id { " RETURNING id" } else { "" }
5ef6cf72 Andy McCall ↶ 1399
            );
1400
            let mut q = sqlx::query(&sql);
3b1bc27f Andy McCall 1401
            for (v, ty) in values {
1402
                q = bind_json(q, v, ty);
5ef6cf72 Andy McCall ↶ 1403
            }
3b1bc27f Andy McCall 1404
            let context = || format!("restore a row of {table}");
1405
            if by_id {
1406
                let made: i64 = sqlx::Row::try_get(&q.fetch_one(&mut *tx).await.with_context(context)?, 0)?;
1407
                if let Some(was) = row.get("id").and_then(|v| v.as_i64()) {
1408
                    maps.entry(table.clone()).or_default().insert(was, made);
1409
                }
1410
            } else {
1411
                q.execute(&mut *tx).await.with_context(context)?;
5ef6cf72 Andy McCall ↶ 1412
            }
1413
        }
1414
    }
1415
    tx.commit().await?;
1416
    for (table, n) in left_out {
1417
        notes.push(format!("{table}: {n} row(s) left out: they name accounts or rows this hub lacks"));
1418
    }
1419
    // Search finds what came back.
1420
    for (kind, table) in [("issue", "issues"), ("proposal", "proposals")] {
1421
        let found: Vec<(i64, i64, String, String)> =
5d90e0e0 Andy McCall 1422
            sqlx::query_as(&format!("SELECT id, number, title, body FROM {table} WHERE repo_id = $1")).bind(repo).fetch_all(pool).await?;
5ef6cf72 Andy McCall ↶ 1423
        for (id, number, title, body) in found {
1424
            db::notify::index(pool, kind, repo, id, number, &title, &body).await?;
1425
        }
1426
    }
1427
    // Webhook secrets were never written: they are entered again.
1428
    let hooks: Vec<String> =
5d90e0e0 Andy McCall 1429
        sqlx::query_scalar("SELECT url FROM hooks WHERE repo_id = $1 AND secret = ''").bind(repo).fetch_all(pool).await?;
5ef6cf72 Andy McCall ↶ 1430
    for url in hooks {
1431
        notes.push(format!("webhook {url}: enter its secret again (Settings › Webhooks)"));
1432
    }
1433
    // Release assets, each checked against its name.
1434
    for hash in obj.get("release_assets").and_then(|a| a.as_array()).into_iter().flatten().filter_map(|a| a["hash"].as_str()) {
1435
        if hash.len() != 64 || !hash.bytes().all(|b| b.is_ascii_hexdigit()) {
1436
            continue;
1437
        }
1438
        let path = crate::web::releases::blob_path(app, hash);
1439
        if path.exists() {
1440
            continue;
1441
        }
1442
        let got = tokio::task::block_in_place(|| dest.get(&blob_key(hash)));
1443
        match got {
1444
            Ok(bytes) if blake3::hash(&bytes).to_hex().as_str() == hash => {
1445
                std::fs::create_dir_all(path.parent().context("no parent")?)?;
1446
                std::fs::write(&path, &bytes)?;
1447
            }
1448
            Ok(_) => notes.push(format!("release asset {}: the copy does not match its hash", &hash[..12])),
1449
            Err(_) => notes.push(format!("release asset {}: not in the backup", &hash[..12])),
1450
        }
1451
    }
1452
    Ok(notes)
1453
}
1454
d7d18246 Andy McCall ↶ 1455
// ---------------------------------------------------------------- a run
1456
1457
fn run_name(ms: i64) -> String {
1458
    let t = time::OffsetDateTime::from_unix_timestamp_nanos(ms as i128 * 1_000_000).unwrap_or(time::OffsetDateTime::UNIX_EPOCH);
1459
    format!("{:04}{:02}{:02}T{:02}{:02}{:02}Z", t.year(), u8::from(t.month()), t.day(), t.hour(), t.minute(), t.second())
1460
}
1461
1462
/// The last whole run's manifests, by `kind/name`.
1463
fn last_manifests(dest: &dyn Destination) -> HashMap<String, HashMap<String, File>> {
1464
    let mut out = HashMap::new();
1465
    let Ok(at) = dest.get("LATEST").map(|b| String::from_utf8_lossy(&b).trim().to_string()) else { return out };
1466
    for name in dest.list(&format!("runs/{at}/repos")).unwrap_or_default() {
1467
        if let Ok(m) = dest.get(&format!("runs/{at}/repos/{name}")).and_then(|b| Ok(serde_json::from_slice::<Manifest>(&b)?)) {
1468
            out.insert(format!("{}/{}", m.kind, m.name), m.files.into_iter().map(|f| (f.path.clone(), f)).collect());
1469
        }
1470
    }
1471
    out
1472
}
1473
1474
/// Back up `owner` now, as its setting says. The run is recorded whatever
1475
/// happens; a failure notifies the owner once until a run succeeds.
1476
pub async fn run(app: &Shared, owner: &str, trigger: &str) -> Result<Run> {
1477
    let s = setting(&app.db, owner).await?.with_context(|| format!("{owner} has no backup set up"))?;
1478
    let started = db::now_ms();
1479
    let at = run_name(started);
5d90e0e0 Andy McCall 1480
    let id: i64 = sqlx::query_scalar(
1481
        "INSERT INTO backup_runs (owner, started_ms, status, at, trigger) VALUES ($1, $2, 'running', $3, $4) RETURNING id",
1482
    )
1483
    .bind(owner)
1484
    .bind(started)
1485
    .bind(&at)
1486
    .bind(trigger)
1487
    .fetch_one(&app.db)
1488
    .await?;
d3b048b2 Andy McCall ↶ 1489
    let outcome = run_into(app, &s, &at, trigger == "now").await;
d7d18246 Andy McCall ↶ 1490
    let (status, detail, sent) = match outcome {
1491
        Ok((sent, problems)) if problems.is_empty() => ("ok", String::new(), sent),
1492
        Ok((sent, problems)) => ("partial", problems.join("; "), sent),
1493
        Err(e) => ("failed", format!("{e:#}"), (0, Sent::default())),
1494
    };
5d90e0e0 Andy McCall 1495
    sqlx::query(
1496
        "UPDATE backup_runs SET finished_ms = $1, status = $2, detail = $3, repos = $4, files = $5, sent = $6, bytes = $7 WHERE id = $8",
1497
    )
1498
    .bind(db::now_ms())
1499
    .bind(status)
1500
    .bind(&detail)
1501
    .bind(sent.0)
1502
    .bind(sent.1.files)
1503
    .bind(sent.1.sent)
1504
    .bind(sent.1.bytes)
1505
    .bind(id)
1506
    .execute(&app.db)
1507
    .await?;
1508
    let r: Run = sqlx::query_as("SELECT * FROM backup_runs WHERE id = $1").bind(id).fetch_one(&app.db).await?;
d7d18246 Andy McCall ↶ 1509
    if status != "ok" {
1510
        notify_failure(app, &s, status, &detail).await;
bff9106e Andy McCall ↶ 1511
    } else {
1512
        notify_recovered(app, &s, &r).await;
d7d18246 Andy McCall ↶ 1513
    }
1514
    Ok(r)
1515
}
1516
d3b048b2 Andy McCall ↶ 1517
async fn run_into(app: &Shared, s: &Setting, at: &str, by_hand: bool) -> Result<((i64, Sent), Vec<String>)> {
d7d18246 Andy McCall ↶ 1518
    let dest: std::sync::Arc<dyn Destination> = destination(app, s)?.into();
1519
    let known = {
1520
        let d = dest.clone();
1521
        tokio::task::spawn_blocking(move || last_manifests(d.as_ref())).await?
1522
    };
9041db4e Andy McCall ↶ 1523
    // Its repositories and drops (#280), but those left out (§5).
d3b048b2 Andy McCall ↶ 1524
    let mine: Vec<db::repos::RepoRow> =
9041db4e Andy McCall ↶ 1525
        db::repos::list_with_drops(&app.db).await?.into_iter().filter(|r| r.owner == s.owner && included(s, r, by_hand)).collect();
d7d18246 Andy McCall ↶ 1526
    let mut problems = Vec::new();
1527
    let mut sent = Sent::default();
1528
    let mut repos = 0i64;
1529
    for row in &mine {
1530
        let Some(name) = RepoName::new(&row.owner, &row.name) else { continue };
1531
        for (kind, store) in [("repos", &app.repos), ("wikis", &app.wikis)] {
1532
            if !store.exists(&name) {
1533
                continue;
1534
            }
1535
            let dir = store.dir(&name);
1536
            let k = known.get(&format!("{kind}/{}", row.name)).cloned().unwrap_or_default();
1537
            // The large, unchanging files without the lock, then the whole
1538
            // walk again under the read lock: pushes wait for that moment.
1539
            let (d1, dir1, k1) = (dest.clone(), dir.clone(), k.clone());
1540
            let first = tokio::task::spawn_blocking(move || {
1541
                let mut s = Sent::default();
1542
                copy_dir(d1.as_ref(), &dir1, &k1, true, &mut s).map(|f| (f, s))
1543
            })
1544
            .await?;
1545
            let mut k2 = k;
1546
            if let Ok((files, _)) = &first {
1547
                for f in files {
1548
                    k2.insert(f.path.clone(), f.clone());
1549
                }
1550
            }
7c06f5b2 Andy McCall ↶ 1551
            // Writers wait while the last pass copies (readers carry on),
1552
            // so the refs copied name only objects copied (#249).
1553
            let guard = store.write_guard(&name).await;
d7d18246 Andy McCall ↶ 1554
            let (d2, dir2) = (dest.clone(), dir.clone());
1555
            let second = tokio::task::spawn_blocking(move || {
1556
                let _guard = guard;
1557
                let mut s = Sent::default();
1558
                copy_dir(d2.as_ref(), &dir2, &k2, false, &mut s).map(|f| (f, s))
1559
            })
1560
            .await?;
1561
            match second {
1562
                Ok((files, s2)) => {
1563
                    let s1 = first.map(|(_, s)| s).unwrap_or_default();
1564
                    sent.files += s2.files;
1565
                    sent.sent += s1.sent + s2.sent;
1566
                    sent.bytes += s1.bytes + s2.bytes;
1567
                    let m = Manifest { owner: row.owner.clone(), name: row.name.clone(), kind: kind.into(), files };
9041db4e Andy McCall ↶ 1568
                    let key = format!("runs/{at}/repos/{kind}-{}.json", key_name(&row.name));
35fea423 Andy McCall ↶ 1569
                    tokio::task::block_in_place(|| dest.put(&key, &serde_json::to_vec(&m)?))?;
d7d18246 Andy McCall ↶ 1570
                    if kind == "repos" {
1571
                        repos += 1;
1572
                    }
1573
                }
1574
                Err(e) => problems.push(format!("{}/{} ({kind}): {e:#}", row.owner, row.name)),
1575
            }
1576
        }
1577
        let rec = async {
1578
            let mut r = records(&app.db, "repo_id", row.id).await?;
5ef6cf72 Andy McCall ↶ 1579
            // The repository's own row, which restore recreates first, and
1580
            // the names behind the accounts, teams and organisations its
1581
            // rows point at, which another hub finds them by.
d7d18246 Andy McCall ↶ 1582
            let own = rows(&app.db, "repositories", &format!("id = {}", row.id)).await?;
5ef6cf72 Andy McCall ↶ 1583
            let names = names_of(&app.db, &r).await?;
d7d18246 Andy McCall ↶ 1584
            if let Some(m) = r.as_object_mut() {
1585
                m.insert("repositories".into(), own);
5ef6cf72 Andy McCall ↶ 1586
                m.insert(NAMES.into(), names);
d7d18246 Andy McCall ↶ 1587
            }
1588
            anyhow::Ok(r)
1589
        };
1590
        match rec.await {
5ef6cf72 Andy McCall ↶ 1591
            Ok(r) => {
9041db4e Andy McCall ↶ 1592
                tokio::task::block_in_place(|| {
1593
                    dest.put(&format!("runs/{at}/records/{}.json", key_name(&row.name)), &serde_json::to_vec(&r)?)
1594
                })?;
5ef6cf72 Andy McCall ↶ 1595
                // Release assets live beside the stores, named by their
1596
                // BLAKE3: each sent once, as the stores' files are.
1597
                for hash in r["release_assets"].as_array().into_iter().flatten().filter_map(|a| a["hash"].as_str()) {
1598
                    if hash.len() != 64 || !hash.bytes().all(|b| b.is_ascii_hexdigit()) {
1599
                        continue;
1600
                    }
1601
                    let path = crate::web::releases::blob_path(app, hash);
1602
                    let key = blob_key(hash);
1603
                    let put = tokio::task::block_in_place(|| -> Result<Option<i64>> {
1604
                        if dest.exists(&key)? {
1605
                            return Ok(None);
1606
                        }
1607
                        let bytes = std::fs::read(&path).with_context(|| format!("read release asset {}", &hash[..12]))?;
1608
                        dest.put(&key, &bytes)?;
1609
                        Ok(Some(bytes.len() as i64))
1610
                    });
1611
                    match put {
1612
                        Ok(Some(n)) => {
1613
                            sent.files += 1;
1614
                            sent.sent += 1;
1615
                            sent.bytes += n;
1616
                        }
1617
                        Ok(None) => sent.files += 1,
1618
                        Err(e) => problems.push(format!("{}/{} release asset: {e:#}", row.owner, row.name)),
1619
                    }
1620
                }
1621
            }
d7d18246 Andy McCall ↶ 1622
            Err(e) => problems.push(format!("{}/{} records: {e:#}", row.owner, row.name)),
1623
        }
1624
    }
1625
    // The owner itself.
1626
    let owner_rows = if s.kind == "org" {
1627
        match db::accounts::org_by_name(&app.db, &s.owner).await? {
1628
            Some(o) => records(&app.db, "org_id", o.id).await?,
1629
            None => serde_json::json!({}),
1630
        }
1631
    } else {
1632
        match db::accounts::account_by_name(&app.db, &s.owner).await? {
1633
            Some(a) => records(&app.db, "account_id", a.id).await?,
1634
            None => serde_json::json!({}),
1635
        }
1636
    };
35fea423 Andy McCall ↶ 1637
    // The blocking calls of a destination (GCS drives its client on this
1638
    // runtime) run where blocking is allowed.
1639
    tokio::task::block_in_place(|| -> Result<()> {
1640
        dest.put(&format!("runs/{at}/owner.json"), &serde_json::to_vec(&owner_rows)?)?;
1641
        dest.put(&format!("runs/{at}/DONE"), at.as_bytes())?;
1642
        dest.put("LATEST", at.as_bytes())?;
1643
        prune(dest.as_ref(), s.keep_days)
1644
    })?;
d7d18246 Andy McCall ↶ 1645
    Ok(((repos, sent), problems))
1646
}
1647
1648
/// Drop whole runs older than `keep_days`, and the blobs no kept run
1649
/// names. The newest whole run is always kept.
1650
pub fn prune(dest: &dyn Destination, keep_days: i64) -> Result<()> {
1651
    let cutoff = run_name(db::now_ms() - keep_days.max(1) * 86_400_000);
1652
    let runs = dest.list("runs")?;
1653
    let whole: Vec<&String> = runs.iter().filter(|r| dest.exists(&format!("runs/{r}/DONE")).unwrap_or(false)).collect();
1654
    let newest = whole.last().map(|s| s.to_string());
1655
    let mut removed = false;
1656
    for r in &runs {
1657
        if r.as_str() < cutoff.as_str() && Some(r.to_string()) != newest {
1658
            dest.remove(&format!("runs/{r}"))?;
1659
            removed = true;
1660
        }
1661
    }
1662
    if !removed {
1663
        return Ok(());
1664
    }
1665
    let mut wanted = std::collections::HashSet::new();
1666
    for r in dest.list("runs")? {
1667
        for m in dest.list(&format!("runs/{r}/repos"))? {
1668
            if let Ok(m) = dest.get(&format!("runs/{r}/repos/{m}")).and_then(|b| Ok(serde_json::from_slice::<Manifest>(&b)?)) {
1669
                wanted.extend(m.files.into_iter().map(|f| f.hash));
1670
            }
1671
        }
1672
    }
1673
    for shard in dest.list("blobs")? {
1674
        for b in dest.list(&format!("blobs/{shard}"))? {
1675
            if !wanted.contains(&b) {
1676
                dest.remove(&format!("blobs/{shard}/{b}"))?;
1677
            }
1678
        }
1679
    }
1680
    Ok(())
bff9106e Andy McCall ↶ 1681
}
1682
1683
/// Who hears about `s`'s backups, and where they look: the user, or the
1684
/// organisation's owners.
1685
async fn told(app: &Shared, s: &Setting) -> Option<(Vec<(i64, db::notify::Reason)>, String)> {
1686
    let p = db::notify::Reason::Participating;
1687
    if s.kind == "org" {
1688
        let o = db::accounts::org_by_name(&app.db, &s.owner).await.ok().flatten()?;
1689
        let owners = db::accounts::org_members(&app.db, o.id)
1690
            .await
1691
            .ok()?
1692
            .into_iter()
1693
            .filter(|(_, r)| r == "owner")
1694
            .map(|(a, _)| (a.id, p))
1695
            .collect();
1696
        Some((owners, format!("/orgs/{}/settings/backups", s.owner)))
1697
    } else {
1698
        let a = db::accounts::account_by_name(&app.db, &s.owner).await.ok().flatten()?;
1699
        Some((vec![(a.id, p)], "/settings/backups".into()))
1700
    }
1701
}
1702
1703
/// The status of `owner`'s finished run before the newest.
1704
async fn status_before(app: &Shared, owner: &str) -> Option<String> {
5d90e0e0 Andy McCall 1705
    sqlx::query_scalar("SELECT status FROM backup_runs WHERE owner = $1 AND finished_ms IS NOT NULL ORDER BY id DESC LIMIT 1 OFFSET 1")
bff9106e Andy McCall ↶ 1706
        .bind(owner)
1707
        .fetch_optional(&app.db)
1708
        .await
1709
        .ok()
1710
        .flatten()
d7d18246 Andy McCall ↶ 1711
}
1712
bff9106e Andy McCall ↶ 1713
/// A run that did not finish whole tells the owner (inbox and email), once
1714
/// per spell of failures: not when the run before failed too.
d7d18246 Andy McCall ↶ 1715
async fn notify_failure(app: &Shared, s: &Setting, status: &str, detail: &str) {
bff9106e Andy McCall ↶ 1716
    if status_before(app, &s.owner).await.is_some_and(|b| b != "ok") {
1717
        return;
1718
    }
1719
    let Some((who, url)) = told(app, s).await else { return };
1720
    let title = format!("Backup of {} {status}: {}", s.owner, detail.chars().take(160).collect::<String>());
1721
    crate::notify::tell(app, "backup", &title, &url, "backups", None, who).await;
1722
}
1723
1724
/// A whole run after one that was not: the owner hears it works again
1725
/// (oxygenhub#183).
1726
async fn notify_recovered(app: &Shared, s: &Setting, run: &Run) {
1727
    if !status_before(app, &s.owner).await.is_some_and(|b| b != "ok") {
d7d18246 Andy McCall ↶ 1728
        return;
bff9106e Andy McCall ↶ 1729
    }
1730
    let Some((who, url)) = told(app, s).await else { return };
1731
    let title = format!("Backup of {} works again: {} repositories to {}", s.owner, run.repos, place(s));
1732
    crate::notify::tell(app, "backup.recovered", &title, &url, "backups", None, who).await;
1733
}
1734
1735
/// The hour (UTC) each day's backup summary goes out.
1736
const SUMMARY_HOUR: u8 = 7;
1737
const SUMMARY_SENT: &str = "backups.summary_day";
1738
1739
/// One message a day per owner (oxygenhub#183): the last day's runs, how
1740
/// they went and what they sent. Sent at the first scheduler tick from
1741
/// SUMMARY_HOUR (UTC), once a day. How many owners were told.
1742
pub async fn daily_summary(app: &Shared, now_ms: i64, force: bool) -> sqlx::Result<usize> {
1743
    let t = time::OffsetDateTime::from_unix_timestamp_nanos(now_ms as i128 * 1_000_000).unwrap_or(time::OffsetDateTime::UNIX_EPOCH);
1744
    let day = format!("{:04}-{:02}-{:02}", t.year(), u8::from(t.month()), t.day());
1745
    if !force && (t.hour() < SUMMARY_HOUR || db::accounts::setting(&app.db, SUMMARY_SENT).await?.as_deref() == Some(day.as_str())) {
1746
        return Ok(0);
d7d18246 Andy McCall ↶ 1747
    }
bff9106e Andy McCall ↶ 1748
    db::accounts::set_setting(&app.db, SUMMARY_SENT, &day).await?;
1749
    let settings: Vec<Setting> = sqlx::query_as("SELECT * FROM backup_settings WHERE updated_ms > 0").fetch_all(&app.db).await?;
1750
    let mut sent = 0;
1751
    for s in settings {
5d90e0e0 Andy McCall 1752
        let runs: Vec<Run> = sqlx::query_as("SELECT * FROM backup_runs WHERE owner = $1 AND started_ms >= $2 ORDER BY id")
bff9106e Andy McCall ↶ 1753
            .bind(&s.owner)
1754
            .bind(now_ms - 86_400_000)
1755
            .fetch_all(&app.db)
1756
            .await?;
1757
        if runs.is_empty() {
1758
            continue;
d7d18246 Andy McCall ↶ 1759
        }
bff9106e Andy McCall ↶ 1760
        let ok = runs.iter().filter(|r| r.status == "ok").count();
1761
        let bytes: i64 = runs.iter().map(|r| r.bytes).sum();
1762
        let repos = runs.iter().rev().find(|r| r.status == "ok").map_or(0, |r| r.repos);
1763
        let how = if ok == runs.len() { "all ok".to_string() } else { format!("{} not whole", runs.len() - ok) };
1764
        let title = format!(
1765
            "Backups of {} today: {} runs, {how}, {repos} repositories, {:.1} MiB sent to {}",
1766
            s.owner,
1767
            runs.len(),
1768
            bytes as f64 / 1_048_576.0,
1769
            place(&s)
1770
        );
1771
        let Some((who, url)) = told(app, &s).await else { continue };
1772
        crate::notify::tell(app, "backup.summary", &title, &url, "backups", None, who).await;
1773
        sent += 1;
d7d18246 Andy McCall ↶ 1774
    }
bff9106e Andy McCall ↶ 1775
    Ok(sent)
d7d18246 Andy McCall ↶ 1776
}
1777
1778
/// Run each owner's backup when it is due, one at a time. A run left
1779
/// "running" by a restart is marked failed first.
1780
pub async fn scheduler(app: Shared) {
1781
    let _ = sqlx::query(
5d90e0e0 Andy McCall 1782
        "UPDATE backup_runs SET status = 'failed', detail = 'the hub restarted during the run', finished_ms = $1 WHERE status = 'running'",
d7d18246 Andy McCall ↶ 1783
    )
1784
    .bind(db::now_ms())
1785
    .execute(&app.db)
1786
    .await;
1787
    loop {
1788
        tokio::time::sleep(std::time::Duration::from_secs(60)).await;
bff9106e Andy McCall ↶ 1789
        if let Err(e) = daily_summary(&app, db::now_ms(), false).await {
1790
            tracing::warn!("backup summary: {e}");
1791
        }
d7d18246 Andy McCall ↶ 1792
        for s in due(&app.db).await.unwrap_or_default() {
1793
            if let Err(e) = run(&app, &s.owner, "schedule").await {
1794
                tracing::warn!("backup of {}: {e:#}", s.owner);
1795
            }
1796
        }
1797
    }
1798
}
1799
d3b048b2 Andy McCall ↶ 1800
/// The owners whose next run is due now: by their own schedule, or by
1801
/// the shortest schedule one of their repositories chose (§5). A run takes
1802
/// every included repository and sends only what changed, so each run
1803
/// stays whole and a restore point has everything.
d7d18246 Andy McCall ↶ 1804
pub async fn due(pool: &Pool) -> sqlx::Result<Vec<Setting>> {
d3b048b2 Andy McCall ↶ 1805
    let all: Vec<Setting> = sqlx::query_as("SELECT * FROM backup_settings WHERE updated_ms > 0").fetch_all(pool).await?;
1806
    let repos = db::repos::list(pool).await?;
d7d18246 Andy McCall ↶ 1807
    let now = db::now_ms();
1808
    let mut out = Vec::new();
1809
    for s in all {
d3b048b2 Andy McCall ↶ 1810
        let theirs: Vec<db::repos::RepoRow> = repos.iter().filter(|r| r.owner == s.owner).cloned().collect();
1811
        let Some(period) = period_with(&s, &theirs) else { continue };
d7d18246 Andy McCall ↶ 1812
        let last: Option<i64> =
5d90e0e0 Andy McCall 1813
            sqlx::query_scalar("SELECT MAX(started_ms) FROM backup_runs WHERE owner = $1").bind(&s.owner).fetch_one(pool).await?;
d7d18246 Andy McCall ↶ 1814
        if last.is_none_or(|l| now - l >= period * 1000) {
1815
            out.push(s);
1816
        }
1817
    }
1818
    Ok(out)
1819
}
1820
1821
/// Restore every repository of the whole run `at` (the latest when none)
1822
/// from `dest` into `repos_root/OWNER/NAME` and `wikis_root/…`, refusing to
1823
/// overwrite one that exists. Each file is checked against its hash.
1824
pub fn restore(dest: &dyn Destination, at: Option<&str>, repos_root: &Path, wikis_root: &Path) -> Result<Vec<String>> {
1825
    let at = match at {
1826
        Some(a) => a.to_string(),
1827
        None => String::from_utf8_lossy(&dest.get("LATEST").context("no whole run at this destination")?).trim().to_string(),
1828
    };
1829
    if !dest.exists(&format!("runs/{at}/DONE"))? {
1830
        bail!("run {at} is not whole (no DONE): pick another with --run");
1831
    }
1832
    let mut done = Vec::new();
1833
    for name in dest.list(&format!("runs/{at}/repos"))? {
1834
        let m: Manifest = serde_json::from_slice(&dest.get(&format!("runs/{at}/repos/{name}"))?)?;
1835
        let root = if m.kind == "wikis" { wikis_root } else { repos_root };
1836
        let dir = root.join(&m.owner).join(&m.name);
1837
        if dir.exists() {
1838
            bail!("{} exists: restore into an empty hub, or move it aside", dir.display());
1839
        }
1840
        for f in &m.files {
1841
            let bytes = dest.get(&blob_key(&f.hash))?;
1842
            if blake3::hash(&bytes).to_hex().as_str() != f.hash {
1843
                bail!("{}/{} {}: the copy does not match its hash", m.owner, m.name, f.path);
1844
            }
1845
            let p = dir.join(&f.path);
1846
            std::fs::create_dir_all(p.parent().context("no parent")?)?;
1847
            std::fs::write(&p, &bytes)?;
1848
        }
1849
        done.push(format!("{}/{} ({})", m.owner, m.name, m.kind));
1850
    }
1851
    Ok(done)
1852
}
1853
1854
/// Restore the whole run `at` (the latest when none) into this hub: each
5ef6cf72 Andy McCall ↶ 1855
/// repository's and wiki's store byte for byte, then its row and settings,
1856
/// then its records (issues, proposals, releases and the rest), so it shows
1857
/// on the hub as it was (docs/backups.md §7). What was restored, then any
1858
/// notes (`note: …`) on what needs entering again or was left out.
d7d18246 Andy McCall ↶ 1859
pub async fn restore_into_hub(app: &Shared, dest: std::sync::Arc<dyn Destination>, at: Option<String>) -> Result<Vec<String>> {
1860
    let (repos_root, wikis_root) = (app.repos.root().to_path_buf(), app.wikis.root().to_path_buf());
1861
    let (d, a) = (dest.clone(), at.clone());
1862
    let done = tokio::task::spawn_blocking(move || restore(d.as_ref(), a.as_deref(), &repos_root, &wikis_root)).await??;
1863
    let at = match at {
1864
        Some(a) => a,
35fea423 Andy McCall ↶ 1865
        None => String::from_utf8_lossy(&tokio::task::block_in_place(|| dest.get("LATEST"))?).trim().to_string(),
d7d18246 Andy McCall ↶ 1866
    };
5ef6cf72 Andy McCall ↶ 1867
    let mut notes = Vec::new();
35fea423 Andy McCall ↶ 1868
    for name in tokio::task::block_in_place(|| dest.list(&format!("runs/{at}/records")))? {
1869
        let rec: serde_json::Value =
1870
            serde_json::from_slice(&tokio::task::block_in_place(|| dest.get(&format!("runs/{at}/records/{name}")))?)?;
d7d18246 Andy McCall ↶ 1871
        let Some(row) = rec["repositories"].as_array().and_then(|a| a.first()) else { continue };
1872
        let (owner, repo) = (row["owner"].as_str().unwrap_or_default(), row["name"].as_str().unwrap_or_default());
1873
        if owner.is_empty() || db::repos::get(&app.db, owner, repo).await?.is_some() {
1874
            continue;
1875
        }
1876
        let visibility = match row["visibility"].as_str() {
1877
            Some("private") => hub_api::Visibility::Private,
1878
            Some("internal") => hub_api::Visibility::Internal,
1879
            _ => hub_api::Visibility::Public,
1880
        };
1881
        let made = db::repos::create(&app.db, owner, repo, row["description"].as_str().unwrap_or_default(), visibility).await?;
5ef6cf72 Andy McCall ↶ 1882
        // Its settings as they were: every column the row kept but its
1883
        // name, its id and a fork's parent (another hub's id).
1884
        let cols = table_cols(&app.db, "repositories").await?;
1885
        let set: Vec<(&Col, serde_json::Value)> = cols
1886
            .iter()
1887
            .filter(|c| !["id", "owner", "name", "forked_from"].contains(&c.name.as_str()))
1888
            .filter_map(|c| row.get(&c.name).filter(|v| !v.is_null()).map(|v| (c, v.clone())))
1889
            .collect();
1890
        if !set.is_empty() {
1891
            let sql = format!(
5d90e0e0 Andy McCall 1892
                "UPDATE repositories SET {} WHERE id = ${}",
1893
                set.iter().enumerate().map(|(i, (c, _))| format!("\"{}\" = ${}", c.name, i + 1)).collect::<Vec<_>>().join(", "),
1894
                set.len() + 1
5ef6cf72 Andy McCall ↶ 1895
            );
1896
            let mut q = sqlx::query(&sql);
1897
            for (c, v) in set {
3b1bc27f Andy McCall 1898
                q = bind_json(q, v, &c.ty);
5ef6cf72 Andy McCall ↶ 1899
            }
1900
            q.bind(made.id).execute(&app.db).await?;
1901
        }
1902
        let old = row["id"].as_i64().unwrap_or(-1);
1903
        for n in restore_records(app, &dest, &rec, old, made.id).await.with_context(|| format!("restore {owner}/{repo}'s records"))? {
1904
            notes.push(format!("note: {owner}/{repo}: {n}"));
d7d18246 Andy McCall ↶ 1905
        }
1906
    }
5ef6cf72 Andy McCall ↶ 1907
    let mut done = done;
1908
    done.extend(notes);
d7d18246 Andy McCall ↶ 1909
    Ok(done)
1910
}
1911
1912
#[cfg(test)]
1913
mod tests {
1914
    use super::*;
1915
1916
    #[test]
1917
    fn a_directory_destination_keeps_keys_inside_its_root() {
1918
        let d = tempfile::tempdir().unwrap();
1919
        let dest = Directory { root: d.path().to_path_buf() };
1920
        dest.put("runs/a/DONE", b"a").unwrap();
1921
        assert_eq!(dest.get("runs/a/DONE").unwrap(), b"a");
1922
        assert_eq!(dest.list("runs").unwrap(), vec!["a"]);
1923
        assert!(dest.put("../escape", b"x").is_err() && dest.put("/abs", b"x").is_err());
1924
        dest.remove("runs").unwrap();
1925
        assert!(dest.list("runs").unwrap().is_empty());
1926
    }
1927
1928
    #[test]
1929
    fn files_are_sent_once_and_unchanged_ones_not_read_again() {
1930
        let src = tempfile::tempdir().unwrap();
1931
        let out = tempfile::tempdir().unwrap();
1932
        let dest = Directory { root: out.path().to_path_buf() };
1933
        std::fs::create_dir_all(src.path().join(".oxy/objects/loose")).unwrap();
1934
        std::fs::write(src.path().join(".oxy/objects/loose/aa"), b"object").unwrap();
1935
        std::fs::write(src.path().join(".oxy/ops-head"), b"ref one").unwrap();
1936
        let mut s = Sent::default();
1937
        let files = copy_dir(&dest, src.path(), &HashMap::new(), false, &mut s).unwrap();
1938
        assert_eq!((files.len(), s.sent), (2, 2));
1939
        let known: HashMap<String, File> = files.iter().map(|f| (f.path.clone(), f.clone())).collect();
1940
        let mut s = Sent::default();
1941
        let again = copy_dir(&dest, src.path(), &known, false, &mut s).unwrap();
1942
        assert_eq!((again, s.sent), (files.clone(), 0), "nothing new travels");
1943
        // The first pass takes only the files that never change.
1944
        let mut s = Sent::default();
1945
        let first = copy_dir(&dest, src.path(), &HashMap::new(), true, &mut s).unwrap();
1946
        assert_eq!(first.iter().map(|f| f.path.as_str()).collect::<Vec<_>>(), vec![".oxy/objects/loose/aa"]);
7b9f4570 Andy McCall ↶ 1947
    }
1948
1949
    #[test]
1950
    fn requests_are_signed_as_aws_documents() {
1951
        // AWS's own example (S3 API reference, "Signature calculations":
cb7b3cd4 Andy McCall ↶ 1952
        // GET Object), with its published signature. Its documented example
1953
        // keys are put together at run time, so this file is not itself a
1954
        // push protection or history scan finding (#277).
1955
        let key_id = format!("{}{}", "AKIA", "IOSFODNN7EXAMPLE");
1956
        let secret = format!("{}{}", "wJalrXUtnFEMI/K7MDENG/", "bPxRfiCYEXAMPLEKEY");
7b9f4570 Andy McCall ↶ 1957
        let empty = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855";
1958
        let headers = vec![
1959
            ("Host".to_string(), "examplebucket.s3.amazonaws.com".to_string()),
1960
            ("Range".to_string(), "bytes=0-9".to_string()),
1961
            ("x-amz-content-sha256".to_string(), empty.to_string()),
1962
            ("x-amz-date".to_string(), "20130524T000000Z".to_string()),
1963
        ];
cb7b3cd4 Andy McCall ↶ 1964
        let auth =
1965
            sigv4("GET", "/test.txt", &[], &headers, empty, (key_id.as_str(), secret.as_str()), "us-east-1", "s3", "20130524T000000Z");
7b9f4570 Andy McCall ↶ 1966
        assert_eq!(
1967
            auth,
cb7b3cd4 Andy McCall ↶ 1968
            format!(
1969
                "AWS4-HMAC-SHA256 Credential={key_id}/20130524/us-east-1/s3/aws4_request, \
1970
                 SignedHeaders=host;range;x-amz-content-sha256;x-amz-date, \
1971
                 Signature=f0e8bdb87c964420e857bd35b5d6ed310bd44f0170aba48dd91039c6036bdb41"
1972
            )
7b9f4570 Andy McCall ↶ 1973
        );
1974
        assert_eq!(aws_encode("runs/2026 x+y", true), "runs/2026%20x%2By");
1975
        assert_eq!(aws_encode("a/b", false), "a%2Fb");
1976
        assert_eq!(xml_text("<A><Key>runs/x&amp;y</Key></A>", "Key").as_deref(), Some("runs/x&y"));
d7d18246 Andy McCall ↶ 1977
    }
1978
1979
    #[test]
1980
    fn run_names_sort_by_time() {
1981
        assert_eq!(run_name(0), "19700101T000000Z");
1982
        assert!(run_name(1_791_900_000_000) < run_name(1_791_903_600_000));
1983
    }
1984
}