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