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_time: DateTime<Local>,
  36     chunk_size: Option<u64>,
  37     verbose: bool,
  38 ) -> Result<(), Error> {
  39
  40     let mut param = json!({
  41         "archive-name": archive_name,
  42         "backup-type": "host",
  43         "backup-id": &tools::nodename(),
  44         "backup-time": backup_time.timestamp(),
  45     });
  46
  47     if let Some(size) = chunk_size {
  48         param["chunk-size"] = size.into();
  49     }
  50
  51     let query = tools::json_object_to_query(param)?;
  52
  53     let path = format!("api2/json/admin/datastore/{}/catar?{}", repo.store, query);
  54
  55     let stream = CaTarBackupStream::open(dir_path.as_ref(), verbose)?;
  56
  57     let body = Body::wrap_stream(stream);
  58
  59     client.upload("application/x-proxmox-backup-catar", body, &path)?;
  60
  61     Ok(())
  62 }
  63
  64 /****
  65 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
  66
  67     let mut target = PathBuf::from(target);
  68
  69     if let Some(ext) = target.extension() {
  70         if ext != "fidx" {
  71             bail!("got wrong file extension - expected '.fidx'");
  72         }
  73     } else {
  74         target.set_extension("fidx");
  75     }
  76
  77     let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
  78
  79     tools::file_chunker(file, chunk_size, |pos, chunk| {
  80         index.add_chunk(pos, chunk)?;
  81         Ok(true)
  82     })?;
  83
  84     index.close()?; // commit changes
  85
  86     Ok(())
  87 }
  88 */
  89
  90 fn list_backups(
  91     param: Value,
  92     _info: &ApiMethod,
  93     _rpcenv: &mut RpcEnvironment,
  94 ) -> Result<Value, Error> {
  95
  96     let repo_url = tools::required_string_param(&param, "repository")?;
  97     let repo = BackupRepository::parse(repo_url)?;
  98
  99     let mut client = HttpClient::new(&repo.host, &repo.user);
 100
 101     let path = format!("api2/json/admin/datastore/{}/backups", repo.store);
 102
 103     let result = client.get(&path)?;
 104
 105     // fixme: implement and use output formatter instead ..
 106     let list = result["data"].as_array().unwrap();
 107
 108     for item in list {
 109
 110         let id = item["backup-id"].as_str().unwrap();
 111         let btype = item["backup-type"].as_str().unwrap();
 112         let epoch = item["backup-time"].as_i64().unwrap();
 113
 114         let backup_dir = BackupDir::new(BackupGroup::new(btype, id), epoch);
 115
 116         let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
 117
 118         let info = BackupInfo { backup_dir, files };
 119
 120         for filename in info.files {
 121             let path = info.backup_dir.relative_path().to_str().unwrap().to_owned();
 122             println!("{} | {}/{}", info.backup_dir.backup_time().format("%c"), path, filename);
 123         }
 124     }
 125
 126     //Ok(result)
 127     Ok(Value::Null)
 128 }
 129
 130 fn list_backup_groups(
 131     param: Value,
 132     _info: &ApiMethod,
 133     _rpcenv: &mut RpcEnvironment,
 134 ) -> Result<Value, Error> {
 135
 136     let repo_url = tools::required_string_param(&param, "repository")?;
 137     let repo = BackupRepository::parse(repo_url)?;
 138
 139     let mut client = HttpClient::new(&repo.host, &repo.user);
 140
 141     let path = format!("api2/json/admin/datastore/{}/groups", repo.store);
 142
 143     let result = client.get(&path)?;
 144
 145     // fixme: implement and use output formatter instead ..
 146     let list = result["data"].as_array().unwrap();
 147
 148     for item in list {
 149
 150         let id = item["backup-id"].as_str().unwrap();
 151         let btype = item["backup-type"].as_str().unwrap();
 152         let epoch = item["last-backup"].as_i64().unwrap();
 153         let last_backup = Local.timestamp(epoch, 0);
 154         let backup_count = item["backup-count"].as_u64().unwrap();
 155
 156         let group = BackupGroup::new(btype, id);
 157
 158         let path = group.group_path().to_str().unwrap().to_owned();
 159
 160         let files = item["files"].as_array().unwrap().iter()
 161             .map(|v| {
 162                 v.as_str().unwrap().to_owned()
 163             }).collect();
 164
 165         println!("{} | {} | {} | {}", path, last_backup.format("%c"),
 166                  backup_count, tools::join(&files, ' '));
 167     }
 168
 169     //Ok(result)
 170     Ok(Value::Null)
 171 }
 172
 173 fn list_snapshots(
 174     param: Value,
 175     _info: &ApiMethod,
 176     _rpcenv: &mut RpcEnvironment,
 177 ) -> Result<Value, Error> {
 178
 179     let repo_url = tools::required_string_param(&param, "repository")?;
 180     let repo = BackupRepository::parse(repo_url)?;
 181
 182     let path = tools::required_string_param(&param, "group")?;
 183     let group = BackupGroup::parse(path)?;
 184
 185     let query = tools::json_object_to_query(json!({
 186         "backup-type": group.backup_type(),
 187         "backup-id": group.backup_id(),
 188     }))?;
 189
 190     let mut client = HttpClient::new(&repo.host, &repo.user);
 191
 192     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 193
 194     // fixme: params
 195     let result = client.get(&path)?;
 196
 197     // fixme: implement and use output formatter instead ..
 198     let list = result["data"].as_array().unwrap();
 199
 200     for item in list {
 201
 202         let id = item["backup-id"].as_str().unwrap();
 203         let btype = item["backup-type"].as_str().unwrap();
 204         let epoch = item["backup-time"].as_i64().unwrap();
 205
 206         let snapshot = BackupDir::new(BackupGroup::new(btype, id), epoch);
 207
 208         let path = snapshot.relative_path().to_str().unwrap().to_owned();
 209
 210         let files = item["files"].as_array().unwrap().iter()
 211             .map(|v| {
 212                 v.as_str().unwrap().to_owned()
 213             }).collect();
 214
 215         println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' '));
 216     }
 217
 218     Ok(Value::Null)
 219 }
 220
 221 fn forget_snapshots(
 222     param: Value,
 223     _info: &ApiMethod,
 224     _rpcenv: &mut RpcEnvironment,
 225 ) -> Result<Value, Error> {
 226
 227     let repo_url = tools::required_string_param(&param, "repository")?;
 228     let repo = BackupRepository::parse(repo_url)?;
 229
 230     let path = tools::required_string_param(&param, "snapshot")?;
 231     let snapshot = BackupDir::parse(path)?;
 232
 233     let query = tools::json_object_to_query(json!({
 234         "backup-type": snapshot.group().backup_type(),
 235         "backup-id": snapshot.group().backup_id(),
 236         "backup-time": snapshot.backup_time().timestamp(),
 237     }))?;
 238
 239     let mut client = HttpClient::new(&repo.host, &repo.user);
 240
 241     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store, query);
 242
 243     let result = client.delete(&path)?;
 244
 245     Ok(result)
 246 }
 247
 248 fn start_garbage_collection(
 249     param: Value,
 250     _info: &ApiMethod,
 251     _rpcenv: &mut RpcEnvironment,
 252 ) -> Result<Value, Error> {
 253
 254     let repo_url = tools::required_string_param(&param, "repository")?;
 255     let repo = BackupRepository::parse(repo_url)?;
 256
 257     let mut client = HttpClient::new(&repo.host, &repo.user);
 258
 259     let path = format!("api2/json/admin/datastore/{}/gc", repo.store);
 260
 261     let result = client.post(&path)?;
 262
 263     Ok(result)
 264 }
 265
 266 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
 267
 268     if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
 269         return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
 270     }
 271     bail!("unable to parse directory specification '{}'", value);
 272 }
 273
 274 fn create_backup(
 275     param: Value,
 276     _info: &ApiMethod,
 277     _rpcenv: &mut RpcEnvironment,
 278 ) -> Result<Value, Error> {
 279
 280     let repo_url = tools::required_string_param(&param, "repository")?;
 281
 282     let backupspec_list = tools::required_array_param(&param, "backupspec")?;
 283
 284     let repo = BackupRepository::parse(repo_url)?;
 285
 286     let verbose = param["verbose"].as_bool().unwrap_or(false);
 287
 288     let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
 289
 290     if let Some(size) = chunk_size_opt {
 291         verify_chunk_size(size)?;
 292     }
 293
 294     let mut upload_list = vec![];
 295
 296     for backupspec in backupspec_list {
 297         let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
 298
 299         let stat = match nix::sys::stat::stat(filename) {
 300             Ok(s) => s,
 301             Err(err) => bail!("unable to access '{}' - {}", filename, err),
 302         };
 303
 304         if (stat.st_mode & libc::S_IFDIR) != 0 {
 305
 306             let target = format!("{}.catar", target);
 307
 308             upload_list.push((filename.to_owned(), target));
 309
 310         } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
 311             if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
 312             let _size = stat.st_size as usize;
 313
 314             panic!("implement me");
 315
 316             //backup_image(&datastore, &file, size, &target, chunk_size)?;
 317
 318             // let idx = datastore.open_image_reader(target)?;
 319             // idx.print_info();
 320
 321         } else {
 322             bail!("unsupported file type (expected a directory, file or block device)");
 323         }
 324     }
 325
 326     let backup_time = Local.timestamp(Local::now().timestamp(), 0);
 327
 328     let mut client = HttpClient::new(&repo.host, &repo.user);
 329
 330     client.login()?; // login before starting backup
 331
 332     println!("Starting backup");
 333     println!("Client name: {}", tools::nodename());
 334     println!("Start Time: {}", backup_time.to_rfc3339());
 335
 336     for (filename, target) in upload_list {
 337         println!("Upload '{}' to '{:?}' as {}", filename, repo, target);
 338         backup_directory(&mut client, &repo, &filename, &target, backup_time, chunk_size_opt, verbose)?;
 339     }
 340
 341     let end_time = Local.timestamp(Local::now().timestamp(), 0);
 342     println!("End Time: {}", end_time.to_rfc3339());
 343
 344     Ok(Value::Null)
 345 }
 346
 347 pub fn complete_backup_source(arg: &str) -> Vec<String> {
 348
 349     let mut result = vec![];
 350
 351     let data: Vec<&str> = arg.splitn(2, ':').collect();
 352
 353     if data.len() != 2 { return result; }
 354
 355     let files = tools::complete_file_name(data[1]);
 356
 357     for file in files {
 358         result.push(format!("{}:{}", data[0], file));
 359     }
 360
 361     result
 362 }
 363
 364 fn prune(
 365     mut param: Value,
 366     _info: &ApiMethod,
 367     _rpcenv: &mut RpcEnvironment,
 368 ) -> Result<Value, Error> {
 369
 370     let repo_url = tools::required_string_param(&param, "repository")?;
 371     let repo = BackupRepository::parse(repo_url)?;
 372
 373     let mut client = HttpClient::new(&repo.host, &repo.user);
 374
 375     let path = format!("api2/json/admin/datastore/{}/prune", repo.store);
 376
 377     param.as_object_mut().unwrap().remove("repository");
 378
 379     let result = client.post_json(&path, param)?;
 380
 381     Ok(result)
 382 }
 383
 384 fn main() {
 385
 386     let repo_url_schema: Arc<Schema> = Arc::new(
 387         StringSchema::new("Repository URL.")
 388             .format(BACKUP_REPO_URL.clone())
 389             .max_length(256)
 390             .into()
 391     );
 392
 393     let backup_source_schema: Arc<Schema> = Arc::new(
 394         StringSchema::new("Backup source specification ([<label>:<path>]).")
 395             .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
 396             .into()
 397     );
 398
 399     let backup_cmd_def = CliCommand::new(
 400         ApiMethod::new(
 401             create_backup,
 402             ObjectSchema::new("Create (host) backup.")
 403                 .required("repository", repo_url_schema.clone())
 404                 .required(
 405                     "backupspec",
 406                     ArraySchema::new(
 407                         "List of backup source specifications ([<label>:<path>] ...)",
 408                         backup_source_schema,
 409                     ).min_length(1)
 410                 )
 411                 .optional(
 412                     "verbose",
 413                     BooleanSchema::new("Verbose output.").default(false))
 414                 .optional(
 415                     "chunk-size",
 416                     IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
 417                         .minimum(64)
 418                         .maximum(4096)
 419                         .default(4096)
 420                 )
 421         ))
 422         .arg_param(vec!["repository", "backupspec"])
 423         .completion_cb("backupspec", complete_backup_source);
 424
 425     let list_cmd_def = CliCommand::new(
 426         ApiMethod::new(
 427             list_backup_groups,
 428             ObjectSchema::new("List backup groups.")
 429                 .required("repository", repo_url_schema.clone())
 430         ))
 431         .arg_param(vec!["repository"]);
 432
 433     let snapshots_cmd_def = CliCommand::new(
 434         ApiMethod::new(
 435             list_snapshots,
 436             ObjectSchema::new("List backup snapshots.")
 437                 .required("repository", repo_url_schema.clone())
 438                 .required("group", StringSchema::new("Backup group."))
 439         ))
 440         .arg_param(vec!["repository", "group"]);
 441
 442     let forget_cmd_def = CliCommand::new(
 443         ApiMethod::new(
 444             forget_snapshots,
 445             ObjectSchema::new("Forget (remove) backup snapshots.")
 446                 .required("repository", repo_url_schema.clone())
 447                 .required("snapshot", StringSchema::new("Snapshot path."))
 448         ))
 449         .arg_param(vec!["repository", "snapshot"]);
 450
 451     let garbage_collect_cmd_def = CliCommand::new(
 452         ApiMethod::new(
 453             start_garbage_collection,
 454             ObjectSchema::new("Start garbage collection for a specific repository.")
 455                 .required("repository", repo_url_schema.clone())
 456         ))
 457         .arg_param(vec!["repository"]);
 458
 459     let prune_cmd_def = CliCommand::new(
 460         ApiMethod::new(
 461             prune,
 462             proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
 463                 ObjectSchema::new("Prune backup repository.")
 464                     .required("repository", repo_url_schema.clone())
 465             )
 466         ))
 467         .arg_param(vec!["repository"]);
 468     let cmd_def = CliCommandMap::new()
 469         .insert("backup".to_owned(), backup_cmd_def.into())
 470         .insert("forget".to_owned(), forget_cmd_def.into())
 471         .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
 472         .insert("list".to_owned(), list_cmd_def.into())
 473         .insert("prune".to_owned(), prune_cmd_def.into())
 474         .insert("snapshots".to_owned(), snapshots_cmd_def.into());
 475
 476     run_cli_command(cmd_def.into());
 477 }