| 1 | |
|
| 2 | |
|
| 3 | |
|
| 4 | |
|
| 5 | |
|
| 6 | | use super::settings::{csrf, require}; |
| 7 | | use super::{filters, Error, Page, Shell}; |
| 8 | | use crate::auth::Viewer; |
| 9 | | use crate::backups::{self, Overview, Run, Setting}; |
| 10 | | use crate::Shared; |
| 11 | | use askama::Template; |
| 12 | | use axum::extract::{Path, State}; |
| 13 | | use axum::Form; |
| 14 | | use serde::Deserialize; |
| 15 | |
|
| 16 | | #[derive(Template)] |
| 17 | | #[template(path = "backups.html")] |
| 18 | | pub struct BackupsPage { |
| 19 | | shell: Shell, |
| 20 | | |
| 21 | | kind: &'static str, |
| 22 | | owner: String, |
| 23 | | |
| 24 | | base: String, |
| 25 | | setting: Setting, |
| 26 | | runs: Vec<Run>, |
| 27 | | |
| 28 | | dirs: Vec<String>, |
| 29 | | notice: Option<String>, |
| 30 | | error: Option<String>, |
| 31 | | } |
| 32 | |
|
| 33 | | impl BackupsPage { |
| 34 | 8× | fn every(&self) -> &'static [(&'static str, &'static str)] { |
| 35 | 8× | backups::EVERY |
| 36 | 8× | } |
| 37 | 8× | fn keeps(&self) -> &'static [i64] { |
| 38 | 8× | backups::KEEP |
| 39 | 8× | } |
| 40 | | } |
| 41 | |
|
| 42 | 8× | async fn page( |
| 43 | 8× | app: &Shared, |
| 44 | 8× | shell: Shell, |
| 45 | 8× | kind: &'static str, |
| 46 | 8× | owner: &str, |
| 47 | 8× | notice: Option<String>, |
| 48 | 8× | error: Option<String>, |
| 49 | 8× | ) -> Result<Page<BackupsPage>, Error> { |
| 50 | 8× | let e = |e| Error::from_db(shell.clone(), e); |
| 51 | 8× | let setting = backups::setting(&app.db, owner).await.map_err(e)?.unwrap_or_else(|| Setting::off(owner, kind)); |
| 52 | 8× | let runs = backups::runs(&app.db, owner, 50).await.map_err(e)?; |
| 53 | 8× | let base = if kind == "org" { format!("/orgs/{owner}/settings/backups") } else { "/settings/backups".into() }; |
| 54 | 8× | let dirs = app.config.backups.directories.iter().map(|d| d.display().to_string()).collect(); |
| 55 | 8× | Ok(Page(BackupsPage { shell, kind, owner: owner.into(), base, setting, runs, dirs, notice, error })) |
| 56 | 8× | } |
| 57 | |
|
| 58 | | #[derive(Deserialize)] |
| 59 | | pub struct BackupForm { |
| 60 | | #[serde(rename = "_csrf")] |
| 61 | | csrf_token: String, |
| 62 | | #[serde(flatten)] |
| 63 | | input: SettingInput, |
| 64 | | } |
| 65 | |
|
| 66 | |
|
| 67 | |
|
| 68 | | #[derive(Clone, Debug, Default, Deserialize)] |
| 69 | | pub(crate) struct SettingInput { |
| 70 | | pub every: String, |
| 71 | | #[serde(default)] |
| 72 | | pub destination: String, |
| 73 | | #[serde(default)] |
| 74 | | pub dir: String, |
| 75 | | #[serde(default)] |
| 76 | | pub bucket: String, |
| 77 | | #[serde(default)] |
| 78 | | pub provider: String, |
| 79 | | #[serde(default)] |
| 80 | | pub prefix: String, |
| 81 | | #[serde(default)] |
| 82 | | pub keep_days: String, |
| 83 | | |
| 84 | | #[serde(default)] |
| 85 | | pub s3_bucket: String, |
| 86 | | #[serde(default)] |
| 87 | | pub s3_region: String, |
| 88 | | #[serde(default)] |
| 89 | | pub s3_role: String, |
| 90 | | } |
| 91 | |
|
| 92 | |
|
| 93 | 9× | pub(crate) fn setting_of(app: &Shared, owner: &str, kind: &str, f: &SettingInput) -> Result<Setting, String> { |
| 94 | 20× | if !backups::EVERY.iter().any(|(v, _)| *v == f.every) { |
| 95 | 0× | return Err("Pick how often: off, hourly or daily.".into()); |
| 96 | 9× | } |
| 97 | 9× | let keep_days: i64 = f.keep_days.parse().unwrap_or(30); |
| 98 | 9× | if !backups::KEEP.contains(&keep_days) { |
| 99 | 0× | return Err("Keep runs for 7, 30 or 90 days.".into()); |
| 100 | 9× | } |
| 101 | 9× | let prefix = f.prefix.trim().trim_matches('/').to_string(); |
| 102 | 9× | if prefix.split('/').any(|p| p == ".." || p == ".") { |
| 103 | 0× | return Err("The prefix is a plain path, without . or .. parts.".into()); |
| 104 | 9× | } |
| 105 | 9× | let mut region = String::new(); |
| 106 | 9× | let (target, provider) = match f.destination.as_str() { |
| 107 | 9× | "dir" => { |
| 108 | 3× | if !app.config.backups.directories.iter().any(|d| d.display().to_string() == f.dir) { |
| 109 | 1× | return Err("Pick one of the directories this hub allows.".into()); |
| 110 | 2× | } |
| 111 | 2× | (f.dir.clone(), String::new()) |
| 112 | | } |
| 113 | 6× | "s3" => { |
| 114 | 2× | let bucket = f.s3_bucket.trim().trim_start_matches("s3://").trim_end_matches('/').to_string(); |
| 115 | 22× | if bucket.is_empty() || !bucket.chars().all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || "-.".contains(c)) { |
| 116 | 0× | return Err("Give the S3 bucket's name, such as andymccall-oxygen-backup.".into()); |
| 117 | 2× | } |
| 118 | 2× | region = f.s3_region.trim().to_string(); |
| 119 | 18× | if region.is_empty() || !region.chars().all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-') { |
| 120 | 0× | return Err("Give the bucket's region, such as eu-west-2.".into()); |
| 121 | 2× | } |
| 122 | 2× | let role = f.s3_role.trim().to_string(); |
| 123 | 2× | if !role.starts_with("arn:aws:iam::") || !role.contains(":role/") { |
| 124 | 1× | return Err("Give the IAM role's ARN, arn:aws:iam::ACCOUNT:role/NAME (docs/backups.md §6).".into()); |
| 125 | 1× | } |
| 126 | 1× | (bucket, role) |
| 127 | | } |
| 128 | 4× | "gcs" => { |
| 129 | 4× | let bucket = f.bucket.trim().trim_start_matches("gs://").trim_end_matches('/').to_string(); |
| 130 | 44× | if bucket.is_empty() || !bucket.chars().all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || "-_.".contains(c)) { |
| 131 | 0× | return Err("Give the bucket's name, such as andymccall-oxygen-backup.".into()); |
| 132 | 4× | } |
| 133 | 4× | let provider = f.provider.trim().to_string(); |
| 134 | 4× | if !provider.starts_with("//iam.googleapis.com/projects/") || !provider.contains("/providers/") { |
| 135 | 2× | return Err( |
| 136 | 2× | "Give the workload identity provider's full name, //iam.googleapis.com/projects/…/providers/… (docs/backups.md §6)." |
| 137 | 2× | .into(), |
| 138 | 2× | ); |
| 139 | 2× | } |
| 140 | 2× | (bucket, provider) |
| 141 | | } |
| 142 | 0× | _ => return Err("Pick where backups go.".into()), |
| 143 | | }; |
| 144 | 5× | Ok(Setting { |
| 145 | 5× | owner: owner.into(), |
| 146 | 5× | kind: kind.into(), |
| 147 | 5× | every: f.every.clone(), |
| 148 | 5× | destination: f.destination.clone(), |
| 149 | 5× | target, |
| 150 | 5× | prefix, |
| 151 | 5× | provider, |
| 152 | 5× | keep_days, |
| 153 | 5× | updated_ms: 0, |
| 154 | 5× | region, |
| 155 | 5× | }) |
| 156 | 9× | } |
| 157 | |
|
| 158 | 6× | async fn save(app: &Shared, shell: Shell, kind: &'static str, owner: &str, f: &BackupForm) -> Result<Page<BackupsPage>, Error> { |
| 159 | 6× | match setting_of(app, owner, kind, &f.input) { |
| 160 | 3× | Ok(s) => { |
| 161 | 3× | backups::save(&app.db, &s).await.map_err(|e| Error::from_db(shell.clone(), e))?; |
| 162 | 3× | page(app, shell, kind, owner, Some("Saved.".into()), None).await |
| 163 | | } |
| 164 | 3× | Err(why) => page(app, shell, kind, owner, None, Some(why)).await, |
| 165 | | } |
| 166 | 6× | } |
| 167 | |
|
| 168 | 0× | async fn run_now(app: &Shared, shell: Shell, kind: &'static str, owner: &str) -> Result<Page<BackupsPage>, Error> { |
| 169 | 0× | let set = backups::setting(&app.db, owner).await.map_err(|e| Error::from_db(shell.clone(), e))?; |
| 170 | 0× | if set.is_none() { |
| 171 | 0× | return page(app, shell, kind, owner, None, Some("Save where backups go first.".into())).await; |
| 172 | 0× | } |
| 173 | 0× | let (app2, owner2) = (app.clone(), owner.to_string()); |
| 174 | 0× | tokio::spawn(async move { |
| 175 | 0× | if let Err(e) = backups::run(&app2, &owner2, "now").await { |
| 176 | 0× | tracing::warn!("backup of {owner2}: {e:#}"); |
| 177 | 0× | } |
| 178 | 0× | }); |
| 179 | 0× | page(app, shell, kind, owner, Some("Backing up now: the run shows below when it finishes.".into()), None).await |
| 180 | 0× | } |
| 181 | |
|
| 182 | |
|
| 183 | 0× | async fn test(app: &Shared, shell: Shell, kind: &'static str, owner: &str) -> Result<Page<BackupsPage>, Error> { |
| 184 | 0× | let Some(set) = backups::setting(&app.db, owner).await.map_err(|e| Error::from_db(shell.clone(), e))? else { |
| 185 | 0× | return page(app, shell, kind, owner, None, Some("Save where backups go first.".into())).await; |
| 186 | | }; |
| 187 | 0× | let outcome = match backups::destination(app, &set) { |
| 188 | 0× | Ok(dest) => { |
| 189 | 0× | tokio::task::spawn_blocking(move || backups::probe(dest.as_ref())).await.unwrap_or_else(|e| Err(anyhow::anyhow!("{e}"))) |
| 190 | | } |
| 191 | 0× | Err(e) => Err(e), |
| 192 | | }; |
| 193 | 0× | match outcome { |
| 194 | | Ok(()) => { |
| 195 | 0× | let place = backups::place(&set); |
| 196 | 0× | page(app, shell, kind, owner, Some(format!("TEST passed: wrote, read and removed a probe in {place}.")), None).await |
| 197 | | } |
| 198 | 0× | Err(e) => page(app, shell, kind, owner, None, Some(format!("TEST failed: {e:#}"))).await, |
| 199 | | } |
| 200 | 0× | } |
| 201 | |
|
| 202 | | #[derive(Deserialize)] |
| 203 | | pub struct Csrf { |
| 204 | | #[serde(rename = "_csrf")] |
| 205 | | csrf_token: String, |
| 206 | | } |
| 207 | |
|
| 208 | 1× | pub async fn user(State(app): State<Shared>, viewer: Viewer) -> Result<Page<BackupsPage>, Error> { |
| 209 | 1× | let shell = Shell::new(&app, "/settings/backups", &viewer); |
| 210 | 1× | let me = require(&viewer, &shell)?; |
| 211 | 1× | page(&app, shell, "user", &me.account.username, None, None).await |
| 212 | 1× | } |
| 213 | |
|
| 214 | 6× | pub async fn user_save(State(app): State<Shared>, viewer: Viewer, Form(f): Form<BackupForm>) -> Result<Page<BackupsPage>, Error> { |
| 215 | 6× | let shell = Shell::new(&app, "/settings/backups", &viewer); |
| 216 | 6× | let me = require(&viewer, &shell)?; |
| 217 | 6× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 218 | 6× | save(&app, shell, "user", &me.account.username, &f).await |
| 219 | 6× | } |
| 220 | |
|
| 221 | 0× | pub async fn user_run(State(app): State<Shared>, viewer: Viewer, Form(f): Form<Csrf>) -> Result<Page<BackupsPage>, Error> { |
| 222 | 0× | let shell = Shell::new(&app, "/settings/backups", &viewer); |
| 223 | 0× | let me = require(&viewer, &shell)?; |
| 224 | 0× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 225 | 0× | run_now(&app, shell, "user", &me.account.username).await |
| 226 | 0× | } |
| 227 | |
|
| 228 | 2× | pub async fn org(State(app): State<Shared>, viewer: Viewer, Path(name): Path<String>) -> Result<Page<BackupsPage>, Error> { |
| 229 | 2× | let shell = Shell::new(&app, &format!("/orgs/{name}/settings/backups"), &viewer); |
| 230 | 2× | let (_, org) = super::orgs::owned_org(&app, &shell, &viewer, &name).await?; |
| 231 | 1× | page(&app, shell, "org", &org.name, None, None).await |
| 232 | 2× | } |
| 233 | |
|
| 234 | 0× | pub async fn org_save( |
| 235 | 0× | State(app): State<Shared>, |
| 236 | 0× | viewer: Viewer, |
| 237 | 0× | Path(name): Path<String>, |
| 238 | 0× | Form(f): Form<BackupForm>, |
| 239 | 0× | ) -> Result<Page<BackupsPage>, Error> { |
| 240 | 0× | let shell = Shell::new(&app, &format!("/orgs/{name}/settings/backups"), &viewer); |
| 241 | 0× | let (_, org) = super::orgs::owned_org(&app, &shell, &viewer, &name).await?; |
| 242 | 0× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 243 | 0× | save(&app, shell, "org", &org.name, &f).await |
| 244 | 0× | } |
| 245 | |
|
| 246 | 0× | pub async fn org_run( |
| 247 | 0× | State(app): State<Shared>, |
| 248 | 0× | viewer: Viewer, |
| 249 | 0× | Path(name): Path<String>, |
| 250 | 0× | Form(f): Form<Csrf>, |
| 251 | 0× | ) -> Result<Page<BackupsPage>, Error> { |
| 252 | 0× | let shell = Shell::new(&app, &format!("/orgs/{name}/settings/backups"), &viewer); |
| 253 | 0× | let (_, org) = super::orgs::owned_org(&app, &shell, &viewer, &name).await?; |
| 254 | 0× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 255 | 0× | run_now(&app, shell, "org", &org.name).await |
| 256 | 0× | } |
| 257 | |
|
| 258 | 0× | pub async fn user_test(State(app): State<Shared>, viewer: Viewer, Form(f): Form<Csrf>) -> Result<Page<BackupsPage>, Error> { |
| 259 | 0× | let shell = Shell::new(&app, "/settings/backups", &viewer); |
| 260 | 0× | let me = require(&viewer, &shell)?; |
| 261 | 0× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 262 | 0× | test(&app, shell, "user", &me.account.username).await |
| 263 | 0× | } |
| 264 | |
|
| 265 | 0× | pub async fn org_test( |
| 266 | 0× | State(app): State<Shared>, |
| 267 | 0× | viewer: Viewer, |
| 268 | 0× | Path(name): Path<String>, |
| 269 | 0× | Form(f): Form<Csrf>, |
| 270 | 0× | ) -> Result<Page<BackupsPage>, Error> { |
| 271 | 0× | let shell = Shell::new(&app, &format!("/orgs/{name}/settings/backups"), &viewer); |
| 272 | 0× | let (_, org) = super::orgs::owned_org(&app, &shell, &viewer, &name).await?; |
| 273 | 0× | csrf(&viewer, &f.csrf_token, &shell)?; |
| 274 | 0× | test(&app, shell, "org", &org.name).await |
| 275 | 0× | } |
| 276 | |
|
| 277 | | #[derive(Template)] |
| 278 | | #[template(path = "admin_backups.html")] |
| 279 | | pub struct AdminPage { |
| 280 | | shell: Shell, |
| 281 | | owners: Vec<Overview>, |
| 282 | | |
| 283 | | uncovered: Vec<(String, i64)>, |
| 284 | | } |
| 285 | |
|
| 286 | |
|
| 287 | |
|
| 288 | 3× | pub async fn admin(State(app): State<Shared>, viewer: Viewer) -> Result<Page<AdminPage>, Error> { |
| 289 | 3× | let shell = Shell::new(&app, "/admin/backups", &viewer); |
| 290 | 3× | if !viewer.is_admin() { |
| 291 | 1× | return Err(Error::not_found(shell)); |
| 292 | 2× | } |
| 293 | 2× | let (owners, uncovered) = backups::overview(&app.db).await.map_err(|e| Error::from_db(shell.clone(), e))?; |
| 294 | 2× | Ok(Page(AdminPage { shell, owners, uncovered })) |
| 295 | 3× | } |