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::{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 ) -> Result<(), Error> {
  39
  40     let mut query = url::form_urlencoded::Serializer::new(String::new());
  41
  42     query
  43         .append_pair("archive_name", archive_name)
  44         .append_pair("type", "host")
  45         .append_pair("id", &tools::nodename())
  46         .append_pair("time", &backup_time.timestamp().to_string());
  47
  48     if let Some(size) = chunk_size {
  49         query.append_pair("chunk-size", &size.to_string());
  50     }
  51
  52     let query = query.finish();
  53
  54     let path = format!("api2/json/admin/datastore/{}/catar?{}", repo.store, query);
  55
  56     let stream = CaTarBackupStream::open(dir_path.as_ref())?;
  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 = url::form_urlencoded::Serializer::new(String::new())
 197         .append_pair("backup-type", &group.backup_type)
 198         .append_pair("backup-id", &group.backup_id)
 199         .finish();
 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 start_garbage_collection(
 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 mut client = HttpClient::new(&repo.host, &repo.user);
 249
 250     let path = format!("api2/json/admin/datastore/{}/gc", repo.store);
 251
 252     let result = client.post(&path)?;
 253
 254     Ok(result)
 255 }
 256
 257 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
 258
 259     if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
 260         return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
 261     }
 262     bail!("unable to parse directory specification '{}'", value);
 263 }
 264
 265 fn create_backup(
 266     param: Value,
 267     _info: &ApiMethod,
 268     _rpcenv: &mut RpcEnvironment,
 269 ) -> Result<Value, Error> {
 270
 271     let repo_url = tools::required_string_param(&param, "repository")?;
 272
 273     let backupspec_list = tools::required_array_param(&param, "backupspec")?;
 274
 275     let repo = BackupRepository::parse(repo_url)?;
 276
 277     let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
 278
 279     if let Some(size) = chunk_size_opt {
 280         verify_chunk_size(size)?;
 281     }
 282
 283     let mut upload_list = vec![];
 284
 285     for backupspec in backupspec_list {
 286         let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
 287
 288         let stat = match nix::sys::stat::stat(filename) {
 289             Ok(s) => s,
 290             Err(err) => bail!("unable to access '{}' - {}", filename, err),
 291         };
 292
 293         if (stat.st_mode & libc::S_IFDIR) != 0 {
 294
 295             let target = format!("{}.catar", target);
 296
 297             upload_list.push((filename.to_owned(), target));
 298
 299         } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
 300             if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
 301             let _size = stat.st_size as usize;
 302
 303             panic!("implement me");
 304
 305             //backup_image(&datastore, &file, size, &target, chunk_size)?;
 306
 307             // let idx = datastore.open_image_reader(target)?;
 308             // idx.print_info();
 309
 310         } else {
 311             bail!("unsupported file type (expected a directory, file or block device)");
 312         }
 313     }
 314
 315     let backup_time = Utc::now();
 316
 317     let mut client = HttpClient::new(&repo.host, &repo.user);
 318
 319     client.login()?; // login before starting backup
 320
 321     let log_file_name = format!("backup-log-{}.log", backup_time.format("%Y-%m-%dT%H:%M:%S"));
 322
 323     let mut log = tools::FileLogger::new(&log_file_name, true)?;
 324
 325     flog!(log, "Starting backup");
 326     flog!(log, "Client name: {}", tools::nodename());
 327     flog!(log, "UTC Start Time: {}", Utc::now().format("%c"));
 328
 329     for (filename, target) in upload_list {
 330         flog!(log, "Upload '{}' to '{:?}' as {}", filename, repo, target);
 331         backup_directory(&mut client, &repo, &filename, &target, backup_time, chunk_size_opt)?;
 332     }
 333
 334     flog!(log, "Upload backup log");
 335     // fixme: impl upload log
 336
 337     flog!(log, "UTC End Time: {}", Utc::now().format("%c"));
 338
 339     //datastore.garbage_collection()?;
 340
 341     Ok(Value::Null)
 342
 343 }
 344
 345 pub fn complete_backup_source(arg: &str) -> Vec<String> {
 346
 347     let mut result = vec![];
 348
 349     let data: Vec<&str> = arg.splitn(2, ':').collect();
 350
 351     if data.len() != 2 { return result; }
 352
 353     let files = tools::complete_file_name(data[1]);
 354
 355     for file in files {
 356         result.push(format!("{}:{}", data[0], file));
 357     }
 358
 359     result
 360 }
 361
 362 fn prune(
 363     mut param: Value,
 364     _info: &ApiMethod,
 365     _rpcenv: &mut RpcEnvironment,
 366 ) -> Result<Value, Error> {
 367
 368     let repo_url = tools::required_string_param(&param, "repository")?;
 369     let repo = BackupRepository::parse(repo_url)?;
 370
 371     let mut client = HttpClient::new(&repo.host, &repo.user);
 372
 373     let path = format!("api2/json/admin/datastore/{}/prune", repo.store);
 374
 375     param.as_object_mut().unwrap().remove("repository");
 376
 377     let result = client.post_json(&path, param)?;
 378
 379     Ok(result)
 380 }
 381
 382 fn main() {
 383
 384     let repo_url_schema: Arc<Schema> = Arc::new(
 385         StringSchema::new("Repository URL.")
 386             .format(BACKUP_REPO_URL.clone())
 387             .max_length(256)
 388             .into()
 389     );
 390
 391     let backup_source_schema: Arc<Schema> = Arc::new(
 392         StringSchema::new("Backup source specification ([<label>:<path>]).")
 393             .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
 394             .into()
 395     );
 396
 397     let create_cmd_def = CliCommand::new(
 398         ApiMethod::new(
 399             create_backup,
 400             ObjectSchema::new("Create backup.")
 401                 .required("repository", repo_url_schema.clone())
 402                 .required(
 403                     "backupspec",
 404                     ArraySchema::new(
 405                         "List of backup source specifications ([<label>:<path>] ...)",
 406                         backup_source_schema,
 407                     ).min_length(1)
 408                 )
 409                 .optional(
 410                     "chunk-size",
 411                     IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
 412                         .minimum(64)
 413                         .maximum(4096)
 414                         .default(4096)
 415                 )
 416         ))
 417         .arg_param(vec!["repository", "backupspec"])
 418         .completion_cb("backupspec", complete_backup_source);
 419
 420     let list_cmd_def = CliCommand::new(
 421         ApiMethod::new(
 422             list_backup_groups,
 423             ObjectSchema::new("List backup groups.")
 424                 .required("repository", repo_url_schema.clone())
 425         ))
 426         .arg_param(vec!["repository"]);
 427
 428     let snapshots_cmd_def = CliCommand::new(
 429         ApiMethod::new(
 430             list_snapshots,
 431             ObjectSchema::new("List backup snapshots.")
 432                 .required("repository", repo_url_schema.clone())
 433                 .required("group", StringSchema::new("Backup group."))
 434         ))
 435         .arg_param(vec!["repository", "group"]);
 436
 437     let garbage_collect_cmd_def = CliCommand::new(
 438         ApiMethod::new(
 439             start_garbage_collection,
 440             ObjectSchema::new("Start garbage collection for a specific repository.")
 441                 .required("repository", repo_url_schema.clone())
 442         ))
 443         .arg_param(vec!["repository"]);
 444
 445     let prune_cmd_def = CliCommand::new(
 446         ApiMethod::new(
 447             prune,
 448             proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
 449                 ObjectSchema::new("Prune backup repository.")
 450                     .required("repository", repo_url_schema.clone())
 451             )
 452         ))
 453         .arg_param(vec!["repository"]);
 454     let cmd_def = CliCommandMap::new()
 455         .insert("create".to_owned(), create_cmd_def.into())
 456         .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
 457         .insert("list".to_owned(), list_cmd_def.into())
 458         .insert("prune".to_owned(), prune_cmd_def.into())
 459         .insert("snapshots".to_owned(), snapshots_cmd_def.into());
 460
 461     run_cli_command(cmd_def.into());
 462 }