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 result = client.get(&path)?;
 145
 146     // fixme: implement and use output formatter instead ..
 147     let list = result["data"].as_array().unwrap();
 148
 149     for item in list {
 150
 151         let id = item["backup-id"].as_str().unwrap();
 152         let btype = item["backup-type"].as_str().unwrap();
 153         let epoch = item["last-backup"].as_i64().unwrap();
 154         let last_backup = Local.timestamp(epoch, 0);
 155         let backup_count = item["backup-count"].as_u64().unwrap();
 156
 157         let group = BackupGroup::new(btype, id);
 158
 159         let path = group.group_path().to_str().unwrap().to_owned();
 160
 161         let files = item["files"].as_array().unwrap().iter()
 162             .map(|v| {
 163                 v.as_str().unwrap().to_owned()
 164             }).collect();
 165
 166         println!("{} | {} | {} | {}", path, last_backup.format("%c"),
 167                  backup_count, tools::join(&files, ' '));
 168     }
 169
 170     //Ok(result)
 171     Ok(Value::Null)
 172 }
 173
 174 fn list_snapshots(
 175     param: Value,
 176     _info: &ApiMethod,
 177     _rpcenv: &mut RpcEnvironment,
 178 ) -> Result<Value, Error> {
 179
 180     let repo_url = tools::required_string_param(&param, "repository")?;
 181     let repo = BackupRepository::parse(repo_url)?;
 182
 183     let path = tools::required_string_param(&param, "group")?;
 184     let group = BackupGroup::parse(path)?;
 185
 186     let query = tools::json_object_to_query(json!({
 187         "backup-type": group.backup_type(),
 188         "backup-id": group.backup_id(),
 189     }))?;
 190
 191     let mut client = HttpClient::new(&repo.host, &repo.user);
 192
 193     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 194
 195     // fixme: params
 196     let result = client.get(&path)?;
 197
 198     // fixme: implement and use output formatter instead ..
 199     let list = result["data"].as_array().unwrap();
 200
 201     for item in list {
 202
 203         let id = item["backup-id"].as_str().unwrap();
 204         let btype = item["backup-type"].as_str().unwrap();
 205         let epoch = item["backup-time"].as_i64().unwrap();
 206
 207         let snapshot = BackupDir::new(btype, id, epoch);
 208
 209         let path = snapshot.relative_path().to_str().unwrap().to_owned();
 210
 211         let files = item["files"].as_array().unwrap().iter()
 212             .map(|v| {
 213                 v.as_str().unwrap().to_owned()
 214             }).collect();
 215
 216         println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' '));
 217     }
 218
 219     Ok(Value::Null)
 220 }
 221
 222 fn forget_snapshots(
 223     param: Value,
 224     _info: &ApiMethod,
 225     _rpcenv: &mut RpcEnvironment,
 226 ) -> Result<Value, Error> {
 227
 228     let repo_url = tools::required_string_param(&param, "repository")?;
 229     let repo = BackupRepository::parse(repo_url)?;
 230
 231     let path = tools::required_string_param(&param, "snapshot")?;
 232     let snapshot = BackupDir::parse(path)?;
 233
 234     let query = tools::json_object_to_query(json!({
 235         "backup-type": snapshot.group().backup_type(),
 236         "backup-id": snapshot.group().backup_id(),
 237         "backup-time": snapshot.backup_time().timestamp(),
 238     }))?;
 239
 240     let mut client = HttpClient::new(&repo.host, &repo.user);
 241
 242     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 243
 244     let result = client.delete(&path)?;
 245
 246     Ok(result)
 247 }
 248
 249 fn start_garbage_collection(
 250     param: Value,
 251     _info: &ApiMethod,
 252     _rpcenv: &mut RpcEnvironment,
 253 ) -> Result<Value, Error> {
 254
 255     let repo_url = tools::required_string_param(&param, "repository")?;
 256     let repo = BackupRepository::parse(repo_url)?;
 257
 258     let mut client = HttpClient::new(&repo.host, &repo.user);
 259
 260     let path = format!("api2/json/admin/datastore/{}/gc", repo.store);
 261
 262     let result = client.post(&path)?;
 263
 264     Ok(result)
 265 }
 266
 267 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
 268
 269     if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
 270         return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
 271     }
 272     bail!("unable to parse directory specification '{}'", value);
 273 }
 274
 275 fn create_backup(
 276     param: Value,
 277     _info: &ApiMethod,
 278     _rpcenv: &mut RpcEnvironment,
 279 ) -> Result<Value, Error> {
 280
 281     let repo_url = tools::required_string_param(&param, "repository")?;
 282
 283     let backupspec_list = tools::required_array_param(&param, "backupspec")?;
 284
 285     let repo = BackupRepository::parse(repo_url)?;
 286
 287     let verbose = param["verbose"].as_bool().unwrap_or(false);
 288
 289     let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
 290
 291     if let Some(size) = chunk_size_opt {
 292         verify_chunk_size(size)?;
 293     }
 294
 295     let backup_id = param["host-id"].as_str().unwrap_or(&tools::nodename());
 296
 297     let mut upload_list = vec![];
 298
 299     for backupspec in backupspec_list {
 300         let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
 301
 302         let stat = match nix::sys::stat::stat(filename) {
 303             Ok(s) => s,
 304             Err(err) => bail!("unable to access '{}' - {}", filename, err),
 305         };
 306
 307         if (stat.st_mode & libc::S_IFDIR) != 0 {
 308
 309             let target = format!("{}.catar", target);
 310
 311             upload_list.push((filename.to_owned(), target));
 312
 313         } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
 314             if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
 315             let _size = stat.st_size as usize;
 316
 317             panic!("implement me");
 318
 319             //backup_image(&datastore, &file, size, &target, chunk_size)?;
 320
 321             // let idx = datastore.open_image_reader(target)?;
 322             // idx.print_info();
 323
 324         } else {
 325             bail!("unsupported file type (expected a directory, file or block device)");
 326         }
 327     }
 328
 329     let backup_time = Local.timestamp(Local::now().timestamp(), 0);
 330
 331     let mut client = HttpClient::new(&repo.host, &repo.user);
 332
 333     client.login()?; // login before starting backup
 334
 335     println!("Starting backup");
 336     println!("Client name: {}", tools::nodename());
 337     println!("Start Time: {}", backup_time.to_rfc3339());
 338
 339     for (filename, target) in upload_list {
 340         println!("Upload '{}' to '{:?}' as {}", filename, repo, target);
 341         backup_directory(&mut client, &repo, &filename, &target, backup_id, backup_time, chunk_size_opt, verbose)?;
 342     }
 343
 344     let end_time = Local.timestamp(Local::now().timestamp(), 0);
 345     let elapsed = end_time.signed_duration_since(backup_time);
 346     println!("Duration: {}", elapsed);
 347
 348     println!("End Time: {}", end_time.to_rfc3339());
 349
 350     Ok(Value::Null)
 351 }
 352
 353 pub fn complete_backup_source(arg: &str) -> Vec<String> {
 354
 355     let mut result = vec![];
 356
 357     let data: Vec<&str> = arg.splitn(2, ':').collect();
 358
 359     if data.len() != 2 { return result; }
 360
 361     let files = tools::complete_file_name(data[1]);
 362
 363     for file in files {
 364         result.push(format!("{}:{}", data[0], file));
 365     }
 366
 367     result
 368 }
 369
 370 fn prune(
 371     mut param: Value,
 372     _info: &ApiMethod,
 373     _rpcenv: &mut RpcEnvironment,
 374 ) -> Result<Value, Error> {
 375
 376     let repo_url = tools::required_string_param(&param, "repository")?;
 377     let repo = BackupRepository::parse(repo_url)?;
 378
 379     let mut client = HttpClient::new(&repo.host, &repo.user);
 380
 381     let path = format!("api2/json/admin/datastore/{}/prune", repo.store);
 382
 383     param.as_object_mut().unwrap().remove("repository");
 384
 385     let result = client.post_json(&path, param)?;
 386
 387     Ok(result)
 388 }
 389
 390 fn main() {
 391
 392     let repo_url_schema: Arc<Schema> = Arc::new(
 393         StringSchema::new("Repository URL.")
 394             .format(BACKUP_REPO_URL.clone())
 395             .max_length(256)
 396             .into()
 397     );
 398
 399     let backup_source_schema: Arc<Schema> = Arc::new(
 400         StringSchema::new("Backup source specification ([<label>:<path>]).")
 401             .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
 402             .into()
 403     );
 404
 405     let backup_cmd_def = CliCommand::new(
 406         ApiMethod::new(
 407             create_backup,
 408             ObjectSchema::new("Create (host) backup.")
 409                 .required("repository", repo_url_schema.clone())
 410                 .required(
 411                     "backupspec",
 412                     ArraySchema::new(
 413                         "List of backup source specifications ([<label>:<path>] ...)",
 414                         backup_source_schema,
 415                     ).min_length(1)
 416                 )
 417                 .optional(
 418                     "verbose",
 419                     BooleanSchema::new("Verbose output.").default(false))
 420                 .optional(
 421                     "host-id",
 422                     StringSchema::new("Use specified ID for the backup group name ('host/<id>'). The default is the system hostname."))
 423                 .optional(
 424                     "chunk-size",
 425                     IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
 426                         .minimum(64)
 427                         .maximum(4096)
 428                         .default(4096)
 429                 )
 430         ))
 431         .arg_param(vec!["repository", "backupspec"])
 432         .completion_cb("backupspec", complete_backup_source);
 433
 434     let list_cmd_def = CliCommand::new(
 435         ApiMethod::new(
 436             list_backup_groups,
 437             ObjectSchema::new("List backup groups.")
 438                 .required("repository", repo_url_schema.clone())
 439         ))
 440         .arg_param(vec!["repository"]);
 441
 442     let snapshots_cmd_def = CliCommand::new(
 443         ApiMethod::new(
 444             list_snapshots,
 445             ObjectSchema::new("List backup snapshots.")
 446                 .required("repository", repo_url_schema.clone())
 447                 .required("group", StringSchema::new("Backup group."))
 448         ))
 449         .arg_param(vec!["repository", "group"]);
 450
 451     let forget_cmd_def = CliCommand::new(
 452         ApiMethod::new(
 453             forget_snapshots,
 454             ObjectSchema::new("Forget (remove) backup snapshots.")
 455                 .required("repository", repo_url_schema.clone())
 456                 .required("snapshot", StringSchema::new("Snapshot path."))
 457         ))
 458         .arg_param(vec!["repository", "snapshot"]);
 459
 460     let garbage_collect_cmd_def = CliCommand::new(
 461         ApiMethod::new(
 462             start_garbage_collection,
 463             ObjectSchema::new("Start garbage collection for a specific repository.")
 464                 .required("repository", repo_url_schema.clone())
 465         ))
 466         .arg_param(vec!["repository"]);
 467
 468     let prune_cmd_def = CliCommand::new(
 469         ApiMethod::new(
 470             prune,
 471             proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
 472                 ObjectSchema::new("Prune backup repository.")
 473                     .required("repository", repo_url_schema.clone())
 474             )
 475         ))
 476         .arg_param(vec!["repository"]);
 477     let cmd_def = CliCommandMap::new()
 478         .insert("backup".to_owned(), backup_cmd_def.into())
 479         .insert("forget".to_owned(), forget_cmd_def.into())
 480         .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
 481         .insert("list".to_owned(), list_cmd_def.into())
 482         .insert("prune".to_owned(), prune_cmd_def.into())
 483         .insert("snapshots".to_owned(), snapshots_cmd_def.into());
 484
 485     run_cli_command(cmd_def.into());
 486 }