src/bin/proxmox-backup-client.rs

   1 extern crate proxmox_backup;
   2
   3 use failure::*;
   4 //use std::os::unix::io::AsRawFd;
   5 use chrono::{DateTime, Local, TimeZone};
   6 use std::path::{Path, PathBuf};
   7 use std::ffi::OsString;
   8
   9 use proxmox_backup::tools;
  10 use proxmox_backup::cli::*;
  11 use proxmox_backup::api_schema::*;
  12 use proxmox_backup::api_schema::router::*;
  13 use proxmox_backup::client::*;
  14 use proxmox_backup::backup::*;
  15 //use proxmox_backup::backup::image_index::*;
  16 //use proxmox_backup::config::datastore;
  17 //use proxmox_backup::catar::encoder::*;
  18 //use proxmox_backup::backup::datastore::*;
  19
  20 use serde_json::{json, Value};
  21 use hyper::Body;
  22 use std::sync::Arc;
  23 use regex::Regex;
  24
  25 use lazy_static::lazy_static;
  26
  27 lazy_static! {
  28     static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(:?catar|raw)):(.+)$").unwrap();
  29 }
  30
  31 fn backup_directory<P: AsRef<Path>>(
  32     client: &mut HttpClient,
  33     repo: &BackupRepository,
  34     dir_path: P,
  35     archive_name: &str,
  36     backup_id: &str,
  37     backup_time: DateTime<Local>,
  38     chunk_size: Option<u64>,
  39     all_file_systems: bool,
  40     verbose: bool,
  41 ) -> Result<(), Error> {
  42
  43     let mut param = json!({
  44         "archive-name": archive_name,
  45         "backup-type": "host",
  46         "backup-id": backup_id,
  47         "backup-time": backup_time.timestamp(),
  48     });
  49
  50     if let Some(size) = chunk_size {
  51         param["chunk-size"] = size.into();
  52     }
  53
  54     let query = tools::json_object_to_query(param)?;
  55
  56     let path = format!("api2/json/admin/datastore/{}/catar?{}", repo.store, query);
  57
  58     let stream = CaTarBackupStream::open(dir_path.as_ref(), all_file_systems, verbose)?;
  59
  60     let body = Body::wrap_stream(stream);
  61
  62     client.upload("application/x-proxmox-backup-catar", body, &path)?;
  63
  64     Ok(())
  65 }
  66
  67 /****
  68 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
  69
  70     let mut target = PathBuf::from(target);
  71
  72     if let Some(ext) = target.extension() {
  73         if ext != "fidx" {
  74             bail!("got wrong file extension - expected '.fidx'");
  75         }
  76     } else {
  77         target.set_extension("fidx");
  78     }
  79
  80     let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
  81
  82     tools::file_chunker(file, chunk_size, |pos, chunk| {
  83         index.add_chunk(pos, chunk)?;
  84         Ok(true)
  85     })?;
  86
  87     index.close()?; // commit changes
  88
  89     Ok(())
  90 }
  91 */
  92
  93 fn strip_chunked_file_expenstions(list: Vec<String>) -> Vec<String> {
  94
  95     let mut result = vec![];
  96
  97     for file in list.into_iter() {
  98         if file.ends_with(".didx") {
  99             result.push(file[..file.len()-5].to_owned());
 100         } else if file.ends_with(".fidx") {
 101             result.push(file[..file.len()-5].to_owned());
 102         } else {
 103             result.push(file); // should not happen
 104         }
 105     }
 106
 107     result
 108 }
 109
 110 fn list_backups(
 111     param: Value,
 112     _info: &ApiMethod,
 113     _rpcenv: &mut RpcEnvironment,
 114 ) -> Result<Value, Error> {
 115
 116     let repo_url = tools::required_string_param(&param, "repository")?;
 117     let repo = BackupRepository::parse(repo_url)?;
 118
 119     let mut client = HttpClient::new(&repo.host, &repo.user);
 120
 121     let path = format!("api2/json/admin/datastore/{}/backups", repo.store);
 122
 123     let result = client.get(&path)?;
 124
 125     // fixme: implement and use output formatter instead ..
 126     let list = result["data"].as_array().unwrap();
 127
 128     for item in list {
 129
 130         let id = item["backup-id"].as_str().unwrap();
 131         let btype = item["backup-type"].as_str().unwrap();
 132         let epoch = item["backup-time"].as_i64().unwrap();
 133
 134         let backup_dir = BackupDir::new(btype, id, epoch);
 135
 136         let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
 137         let files = strip_chunked_file_expenstions(files);
 138
 139         for filename in files {
 140             let path = backup_dir.relative_path().to_str().unwrap().to_owned();
 141             println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename);
 142         }
 143     }
 144
 145     //Ok(result)
 146     Ok(Value::Null)
 147 }
 148
 149 fn list_backup_groups(
 150     param: Value,
 151     _info: &ApiMethod,
 152     _rpcenv: &mut RpcEnvironment,
 153 ) -> Result<Value, Error> {
 154
 155     let repo_url = tools::required_string_param(&param, "repository")?;
 156     let repo = BackupRepository::parse(repo_url)?;
 157
 158     let mut client = HttpClient::new(&repo.host, &repo.user);
 159
 160     let path = format!("api2/json/admin/datastore/{}/groups", repo.store);
 161
 162     let mut result = client.get(&path)?;
 163
 164     // fixme: implement and use output formatter instead ..
 165     let list = result["data"].as_array_mut().unwrap();
 166
 167     list.sort_unstable_by(|a, b| {
 168         let a_id = a["backup-id"].as_str().unwrap();
 169         let a_backup_type = a["backup-type"].as_str().unwrap();
 170         let b_id = b["backup-id"].as_str().unwrap();
 171         let b_backup_type = b["backup-type"].as_str().unwrap();
 172
 173         let type_order = a_backup_type.cmp(b_backup_type);
 174         if type_order == std::cmp::Ordering::Equal {
 175             a_id.cmp(b_id)
 176         } else {
 177             type_order
 178         }
 179     });
 180
 181     for item in list {
 182
 183         let id = item["backup-id"].as_str().unwrap();
 184         let btype = item["backup-type"].as_str().unwrap();
 185         let epoch = item["last-backup"].as_i64().unwrap();
 186         let last_backup = Local.timestamp(epoch, 0);
 187         let backup_count = item["backup-count"].as_u64().unwrap();
 188
 189         let group = BackupGroup::new(btype, id);
 190
 191         let path = group.group_path().to_str().unwrap().to_owned();
 192
 193         let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
 194         let files = strip_chunked_file_expenstions(files);
 195
 196         println!("{:20} | {} | {:5} | {}", path, last_backup.format("%c"),
 197                  backup_count, tools::join(&files, ' '));
 198     }
 199
 200     //Ok(result)
 201     Ok(Value::Null)
 202 }
 203
 204 fn list_snapshots(
 205     param: Value,
 206     _info: &ApiMethod,
 207     _rpcenv: &mut RpcEnvironment,
 208 ) -> Result<Value, Error> {
 209
 210     let repo_url = tools::required_string_param(&param, "repository")?;
 211     let repo = BackupRepository::parse(repo_url)?;
 212
 213     let path = tools::required_string_param(&param, "group")?;
 214     let group = BackupGroup::parse(path)?;
 215
 216     let query = tools::json_object_to_query(json!({
 217         "backup-type": group.backup_type(),
 218         "backup-id": group.backup_id(),
 219     }))?;
 220
 221     let mut client = HttpClient::new(&repo.host, &repo.user);
 222
 223     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 224
 225     // fixme: params
 226     let result = client.get(&path)?;
 227
 228     // fixme: implement and use output formatter instead ..
 229     let list = result["data"].as_array().unwrap();
 230
 231     for item in list {
 232
 233         let id = item["backup-id"].as_str().unwrap();
 234         let btype = item["backup-type"].as_str().unwrap();
 235         let epoch = item["backup-time"].as_i64().unwrap();
 236
 237         let snapshot = BackupDir::new(btype, id, epoch);
 238
 239         let path = snapshot.relative_path().to_str().unwrap().to_owned();
 240
 241         let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
 242         let files = strip_chunked_file_expenstions(files);
 243
 244         println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' '));
 245     }
 246
 247     Ok(Value::Null)
 248 }
 249
 250 fn forget_snapshots(
 251     param: Value,
 252     _info: &ApiMethod,
 253     _rpcenv: &mut RpcEnvironment,
 254 ) -> Result<Value, Error> {
 255
 256     let repo_url = tools::required_string_param(&param, "repository")?;
 257     let repo = BackupRepository::parse(repo_url)?;
 258
 259     let path = tools::required_string_param(&param, "snapshot")?;
 260     let snapshot = BackupDir::parse(path)?;
 261
 262     let query = tools::json_object_to_query(json!({
 263         "backup-type": snapshot.group().backup_type(),
 264         "backup-id": snapshot.group().backup_id(),
 265         "backup-time": snapshot.backup_time().timestamp(),
 266     }))?;
 267
 268     let mut client = HttpClient::new(&repo.host, &repo.user);
 269
 270     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 271
 272     let result = client.delete(&path)?;
 273
 274     Ok(result)
 275 }
 276
 277 fn start_garbage_collection(
 278     param: Value,
 279     _info: &ApiMethod,
 280     _rpcenv: &mut RpcEnvironment,
 281 ) -> Result<Value, Error> {
 282
 283     let repo_url = tools::required_string_param(&param, "repository")?;
 284     let repo = BackupRepository::parse(repo_url)?;
 285
 286     let mut client = HttpClient::new(&repo.host, &repo.user);
 287
 288     let path = format!("api2/json/admin/datastore/{}/gc", repo.store);
 289
 290     let result = client.post(&path)?;
 291
 292     Ok(result)
 293 }
 294
 295 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
 296
 297     if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
 298         return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
 299     }
 300     bail!("unable to parse directory specification '{}'", value);
 301 }
 302
 303 fn create_backup(
 304     param: Value,
 305     _info: &ApiMethod,
 306     _rpcenv: &mut RpcEnvironment,
 307 ) -> Result<Value, Error> {
 308
 309     let repo_url = tools::required_string_param(&param, "repository")?;
 310
 311     let backupspec_list = tools::required_array_param(&param, "backupspec")?;
 312
 313     let repo = BackupRepository::parse(repo_url)?;
 314
 315     let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
 316
 317     let verbose = param["verbose"].as_bool().unwrap_or(false);
 318
 319     let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
 320
 321     if let Some(size) = chunk_size_opt {
 322         verify_chunk_size(size)?;
 323     }
 324
 325     let backup_id = param["host-id"].as_str().unwrap_or(&tools::nodename());
 326
 327     let mut upload_list = vec![];
 328
 329     for backupspec in backupspec_list {
 330         let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
 331
 332         let stat = match nix::sys::stat::stat(filename) {
 333             Ok(s) => s,
 334             Err(err) => bail!("unable to access '{}' - {}", filename, err),
 335         };
 336
 337         if (stat.st_mode & libc::S_IFDIR) != 0 {
 338
 339             upload_list.push((filename.to_owned(), target.to_owned()));
 340
 341         } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
 342             if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
 343             let _size = stat.st_size as usize;
 344
 345             panic!("implement me");
 346
 347             //backup_image(&datastore, &file, size, &target, chunk_size)?;
 348
 349             // let idx = datastore.open_image_reader(target)?;
 350             // idx.print_info();
 351
 352         } else {
 353             bail!("unsupported file type (expected a directory, file or block device)");
 354         }
 355     }
 356
 357     let backup_time = Local.timestamp(Local::now().timestamp(), 0);
 358
 359     let mut client = HttpClient::new(&repo.host, &repo.user);
 360
 361     client.login()?; // login before starting backup
 362
 363     println!("Starting backup");
 364     println!("Client name: {}", tools::nodename());
 365     println!("Start Time: {}", backup_time.to_rfc3339());
 366
 367     for (filename, target) in upload_list {
 368         println!("Upload '{}' to '{:?}' as {}", filename, repo, target);
 369         backup_directory(&mut client, &repo, &filename, &target, backup_id, backup_time,
 370                          chunk_size_opt, all_file_systems, verbose)?;
 371     }
 372
 373     let end_time = Local.timestamp(Local::now().timestamp(), 0);
 374     let elapsed = end_time.signed_duration_since(backup_time);
 375     println!("Duration: {}", elapsed);
 376
 377     println!("End Time: {}", end_time.to_rfc3339());
 378
 379     Ok(Value::Null)
 380 }
 381
 382 pub fn complete_backup_source(arg: &str) -> Vec<String> {
 383
 384     let mut result = vec![];
 385
 386     let data: Vec<&str> = arg.splitn(2, ':').collect();
 387
 388     if data.len() != 2 { return result; }
 389
 390     let files = tools::complete_file_name(data[1]);
 391
 392     for file in files {
 393         result.push(format!("{}:{}", data[0], file));
 394     }
 395
 396     result
 397 }
 398
 399 fn restore(
 400     param: Value,
 401     _info: &ApiMethod,
 402     _rpcenv: &mut RpcEnvironment,
 403 ) -> Result<Value, Error> {
 404
 405     let repo_url = tools::required_string_param(&param, "repository")?;
 406     let repo = BackupRepository::parse(repo_url)?;
 407
 408     let archive_name = tools::required_string_param(&param, "archive-name")?;
 409
 410     let mut client = HttpClient::new(&repo.host, &repo.user);
 411
 412     let path = tools::required_string_param(&param, "snapshot")?;
 413
 414     let query;
 415
 416     if path.matches('/').count() == 1 {
 417         let group = BackupGroup::parse(path)?;
 418
 419         let subquery = tools::json_object_to_query(json!({
 420             "backup-type": group.backup_type(),
 421             "backup-id": group.backup_id(),
 422         }))?;
 423
 424         let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, subquery);
 425         let result = client.get(&path)?;
 426
 427         let list = result["data"].as_array().unwrap();
 428         if list.len() == 0 {
 429             bail!("backup group '{}' does not contain any snapshots:", path);
 430         }
 431
 432         query = tools::json_object_to_query(json!({
 433             "backup-type": group.backup_type(),
 434             "backup-id": group.backup_id(),
 435             "backup-time": list[0]["backup-time"].as_i64().unwrap(),
 436             "archive-name": archive_name,
 437         }))?;
 438     } else {
 439         let snapshot = BackupDir::parse(path)?;
 440
 441         query = tools::json_object_to_query(json!({
 442             "backup-type": snapshot.group().backup_type(),
 443             "backup-id": snapshot.group().backup_id(),
 444             "backup-time": snapshot.backup_time().timestamp(),
 445             "archive-name": archive_name,
 446         }))?;
 447     }
 448
 449     let target = tools::required_string_param(&param, "target")?;
 450
 451     if archive_name.ends_with(".catar") {
 452         let path = format!("api2/json/admin/datastore/{}/catar?{}", repo.store, query);
 453
 454         println!("DOWNLOAD FILE {} to {}", path, target);
 455
 456         let target = PathBuf::from(target);
 457         let writer = CaTarBackupWriter::new(&target, true)?;
 458         client.download(&path, Box::new(writer))?;
 459     } else {
 460         bail!("unknown file extensions - unable to download '{}'", archive_name);
 461     }
 462
 463     Ok(Value::Null)
 464 }
 465
 466 fn prune(
 467     mut param: Value,
 468     _info: &ApiMethod,
 469     _rpcenv: &mut RpcEnvironment,
 470 ) -> Result<Value, Error> {
 471
 472     let repo_url = tools::required_string_param(&param, "repository")?;
 473     let repo = BackupRepository::parse(repo_url)?;
 474
 475     let mut client = HttpClient::new(&repo.host, &repo.user);
 476
 477     let path = format!("api2/json/admin/datastore/{}/prune", repo.store);
 478
 479     param.as_object_mut().unwrap().remove("repository");
 480
 481     let result = client.post_json(&path, param)?;
 482
 483     Ok(result)
 484 }
 485
 486 fn main() {
 487
 488     let repo_url_schema: Arc<Schema> = Arc::new(
 489         StringSchema::new("Repository URL.")
 490             .format(BACKUP_REPO_URL.clone())
 491             .max_length(256)
 492             .into()
 493     );
 494
 495     let backup_source_schema: Arc<Schema> = Arc::new(
 496         StringSchema::new("Backup source specification ([<label>:<path>]).")
 497             .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
 498             .into()
 499     );
 500
 501     let backup_cmd_def = CliCommand::new(
 502         ApiMethod::new(
 503             create_backup,
 504             ObjectSchema::new("Create (host) backup.")
 505                 .required("repository", repo_url_schema.clone())
 506                 .required(
 507                     "backupspec",
 508                     ArraySchema::new(
 509                         "List of backup source specifications ([<label.ext>:<path>] ...)",
 510                         backup_source_schema,
 511                     ).min_length(1)
 512                 )
 513                 .optional(
 514                     "verbose",
 515                     BooleanSchema::new("Verbose output.").default(false))
 516                 .optional(
 517                     "host-id",
 518                     StringSchema::new("Use specified ID for the backup group name ('host/<id>'). The default is the system hostname."))
 519                 .optional(
 520                     "chunk-size",
 521                     IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
 522                         .minimum(64)
 523                         .maximum(4096)
 524                         .default(4096)
 525                 )
 526         ))
 527         .arg_param(vec!["repository", "backupspec"])
 528         .completion_cb("backupspec", complete_backup_source);
 529
 530     let list_cmd_def = CliCommand::new(
 531         ApiMethod::new(
 532             list_backup_groups,
 533             ObjectSchema::new("List backup groups.")
 534                 .required("repository", repo_url_schema.clone())
 535         ))
 536         .arg_param(vec!["repository"]);
 537
 538     let snapshots_cmd_def = CliCommand::new(
 539         ApiMethod::new(
 540             list_snapshots,
 541             ObjectSchema::new("List backup snapshots.")
 542                 .required("repository", repo_url_schema.clone())
 543                 .required("group", StringSchema::new("Backup group."))
 544         ))
 545         .arg_param(vec!["repository", "group"]);
 546
 547     let forget_cmd_def = CliCommand::new(
 548         ApiMethod::new(
 549             forget_snapshots,
 550             ObjectSchema::new("Forget (remove) backup snapshots.")
 551                 .required("repository", repo_url_schema.clone())
 552                 .required("snapshot", StringSchema::new("Snapshot path."))
 553         ))
 554         .arg_param(vec!["repository", "snapshot"]);
 555
 556     let garbage_collect_cmd_def = CliCommand::new(
 557         ApiMethod::new(
 558             start_garbage_collection,
 559             ObjectSchema::new("Start garbage collection for a specific repository.")
 560                 .required("repository", repo_url_schema.clone())
 561         ))
 562         .arg_param(vec!["repository"]);
 563
 564     let restore_cmd_def = CliCommand::new(
 565         ApiMethod::new(
 566             restore,
 567             ObjectSchema::new("Restore backup repository.")
 568                 .required("repository", repo_url_schema.clone())
 569                 .required("snapshot", StringSchema::new("Group/Snapshot path."))
 570                 .required("archive-name", StringSchema::new("Backup archive name."))
 571                 .required("target", StringSchema::new("Target directory path."))
 572         ))
 573         .arg_param(vec!["repository", "snapshot", "archive-name", "target"]);
 574
 575     let prune_cmd_def = CliCommand::new(
 576         ApiMethod::new(
 577             prune,
 578             proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
 579                 ObjectSchema::new("Prune backup repository.")
 580                     .required("repository", repo_url_schema.clone())
 581             )
 582         ))
 583         .arg_param(vec!["repository"]);
 584
 585     let cmd_def = CliCommandMap::new()
 586         .insert("backup".to_owned(), backup_cmd_def.into())
 587         .insert("forget".to_owned(), forget_cmd_def.into())
 588         .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
 589         .insert("list".to_owned(), list_cmd_def.into())
 590         .insert("prune".to_owned(), prune_cmd_def.into())
 591         .insert("restore".to_owned(), restore_cmd_def.into())
 592         .insert("snapshots".to_owned(), snapshots_cmd_def.into());
 593
 594     run_cli_command(cmd_def.into());
 595 }