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