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