]> git.proxmox.com Git - proxmox-backup.git/blame - src/bin/proxmox-backup-client.rs
src/backup/*_index.rs: used generated magic numbers
[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;
1c0472e8 5use chrono::{Local, TimeZone};
e9c9409a 6use std::path::{Path, PathBuf};
496a6784 7use std::collections::HashMap;
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;
8968258b 17//use proxmox_backup::pxar::encoder::*;
728797d0 18//use proxmox_backup::backup::datastore::*;
23bb8780 19
f5f13ebc 20use serde_json::{json, Value};
1c0472e8 21//use hyper::Body;
33d64b81 22use std::sync::Arc;
ae0be2dd 23use regex::Regex;
d0a03d40 24use xdg::BaseDirectories;
ae0be2dd
DM
25
26use lazy_static::lazy_static;
5a2df000 27use futures::*;
c4ff3dce 28use tokio::sync::mpsc;
ae0be2dd
DM
29
30lazy_static! {
ec8a9bb9 31 static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf)):(.+)$").unwrap();
ae0be2dd 32}
33d64b81 33
d0a03d40
DM
34
35fn record_repository(repo: &BackupRepository) {
36
37 let base = match BaseDirectories::with_prefix("proxmox-backup") {
38 Ok(v) => v,
39 _ => return,
40 };
41
42 // usually $HOME/.cache/proxmox-backup/repo-list
43 let path = match base.place_cache_file("repo-list") {
44 Ok(v) => v,
45 _ => return,
46 };
47
49cf9f3d 48 let mut data = tools::file_get_json(&path, None).unwrap_or(json!({}));
d0a03d40
DM
49
50 let repo = repo.to_string();
51
52 data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 };
53
54 let mut map = serde_json::map::Map::new();
55
56 loop {
57 let mut max_used = 0;
58 let mut max_repo = None;
59 for (repo, count) in data.as_object().unwrap() {
60 if map.contains_key(repo) { continue; }
61 if let Some(count) = count.as_i64() {
62 if count > max_used {
63 max_used = count;
64 max_repo = Some(repo);
65 }
66 }
67 }
68 if let Some(repo) = max_repo {
69 map.insert(repo.to_owned(), json!(max_used));
70 } else {
71 break;
72 }
73 if map.len() > 10 { // store max. 10 repos
74 break;
75 }
76 }
77
78 let new_data = json!(map);
79
80 let _ = tools::file_set_contents(path, new_data.to_string().as_bytes(), None);
81}
82
49811347 83fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
d0a03d40
DM
84
85 let mut result = vec![];
86
87 let base = match BaseDirectories::with_prefix("proxmox-backup") {
88 Ok(v) => v,
89 _ => return result,
90 };
91
92 // usually $HOME/.cache/proxmox-backup/repo-list
93 let path = match base.place_cache_file("repo-list") {
94 Ok(v) => v,
95 _ => return result,
96 };
97
49cf9f3d 98 let data = tools::file_get_json(&path, None).unwrap_or(json!({}));
d0a03d40
DM
99
100 if let Some(map) = data.as_object() {
49811347 101 for (repo, _count) in map {
d0a03d40
DM
102 result.push(repo.to_owned());
103 }
104 }
105
106 result
107}
108
17d6979a 109fn backup_directory<P: AsRef<Path>>(
c4ff3dce 110 client: &BackupClient,
17d6979a 111 dir_path: P,
247cdbce 112 archive_name: &str,
36898ffc 113 chunk_size: Option<usize>,
eed6db39 114 all_file_systems: bool,
219ef0e6 115 verbose: bool,
f98ac774 116 crypt_config: Option<Arc<CryptConfig>>,
247cdbce 117) -> Result<(), Error> {
33d64b81 118
c4ff3dce 119 let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), all_file_systems, verbose)?;
36898ffc 120 let chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
ff3d3100 121
c4ff3dce 122 let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
5e7a09be 123
c4ff3dce
DM
124 let stream = rx
125 .map_err(Error::from)
126 .and_then(|x| x); // flatten
17d6979a 127
c4ff3dce
DM
128 // spawn chunker inside a separate task so that it can run parallel
129 tokio::spawn(
130 tx.send_all(chunk_stream.then(|r| Ok(r)))
1c0472e8 131 .map_err(|_| {}).map(|_| ())
c4ff3dce 132 );
17d6979a 133
f98ac774 134 client.upload_stream(archive_name, stream, "dynamic", None, crypt_config).wait()?;
bcd879cf
DM
135
136 Ok(())
137}
138
6af905c1
DM
139fn backup_image<P: AsRef<Path>>(
140 client: &BackupClient,
141 image_path: P,
142 archive_name: &str,
143 image_size: u64,
36898ffc 144 chunk_size: Option<usize>,
1c0472e8 145 _verbose: bool,
f98ac774 146 crypt_config: Option<Arc<CryptConfig>>,
6af905c1
DM
147) -> Result<(), Error> {
148
6af905c1
DM
149 let path = image_path.as_ref().to_owned();
150
151 let file = tokio::fs::File::open(path).wait()?;
152
153 let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
154 .map_err(Error::from);
155
36898ffc 156 let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
6af905c1 157
f98ac774 158 client.upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config).wait()?;
6af905c1
DM
159
160 Ok(())
161}
162
8e39232a
DM
163fn strip_chunked_file_expenstions(list: Vec<String>) -> Vec<String> {
164
165 let mut result = vec![];
166
167 for file in list.into_iter() {
168 if file.ends_with(".didx") {
169 result.push(file[..file.len()-5].to_owned());
170 } else if file.ends_with(".fidx") {
171 result.push(file[..file.len()-5].to_owned());
172 } else {
173 result.push(file); // should not happen
174 }
175 }
176
177 result
178}
179
8968258b 180/* not used:
6049b71f
DM
181fn list_backups(
182 param: Value,
183 _info: &ApiMethod,
dd5495d6 184 _rpcenv: &mut dyn RpcEnvironment,
6049b71f 185) -> Result<Value, Error> {
41c039e1 186
33d64b81 187 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 188 let repo: BackupRepository = repo_url.parse()?;
41c039e1 189
45cdce06 190 let mut client = HttpClient::new(repo.host(), repo.user())?;
41c039e1 191
d0a03d40 192 let path = format!("api2/json/admin/datastore/{}/backups", repo.store());
41c039e1 193
9e391bb7 194 let result = client.get(&path, None)?;
41c039e1 195
d0a03d40
DM
196 record_repository(&repo);
197
8c75372b
DM
198 // fixme: implement and use output formatter instead ..
199 let list = result["data"].as_array().unwrap();
200
201 for item in list {
202
49dc0740
DM
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();
e909522f 206
391d3107 207 let backup_dir = BackupDir::new(btype, id, epoch);
e909522f
DM
208
209 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
8e39232a 210 let files = strip_chunked_file_expenstions(files);
e909522f 211
8e39232a
DM
212 for filename in files {
213 let path = backup_dir.relative_path().to_str().unwrap().to_owned();
214 println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename);
8c75372b
DM
215 }
216 }
217
218 //Ok(result)
219 Ok(Value::Null)
41c039e1 220}
8968258b 221 */
41c039e1 222
812c6f87
DM
223fn list_backup_groups(
224 param: Value,
225 _info: &ApiMethod,
dd5495d6 226 _rpcenv: &mut dyn RpcEnvironment,
812c6f87
DM
227) -> Result<Value, Error> {
228
229 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 230 let repo: BackupRepository = repo_url.parse()?;
812c6f87 231
45cdce06 232 let client = HttpClient::new(repo.host(), repo.user())?;
812c6f87 233
d0a03d40 234 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
812c6f87 235
9e391bb7 236 let mut result = client.get(&path, None).wait()?;
812c6f87 237
d0a03d40
DM
238 record_repository(&repo);
239
812c6f87 240 // fixme: implement and use output formatter instead ..
80822b95
DM
241 let list = result["data"].as_array_mut().unwrap();
242
243 list.sort_unstable_by(|a, b| {
244 let a_id = a["backup-id"].as_str().unwrap();
245 let a_backup_type = a["backup-type"].as_str().unwrap();
246 let b_id = b["backup-id"].as_str().unwrap();
247 let b_backup_type = b["backup-type"].as_str().unwrap();
248
249 let type_order = a_backup_type.cmp(b_backup_type);
250 if type_order == std::cmp::Ordering::Equal {
251 a_id.cmp(b_id)
252 } else {
253 type_order
254 }
255 });
812c6f87
DM
256
257 for item in list {
258
ad20d198
DM
259 let id = item["backup-id"].as_str().unwrap();
260 let btype = item["backup-type"].as_str().unwrap();
261 let epoch = item["last-backup"].as_i64().unwrap();
812c6f87 262 let last_backup = Local.timestamp(epoch, 0);
ad20d198 263 let backup_count = item["backup-count"].as_u64().unwrap();
812c6f87 264
1e9a94e5 265 let group = BackupGroup::new(btype, id);
812c6f87
DM
266
267 let path = group.group_path().to_str().unwrap().to_owned();
ad20d198 268
8e39232a
DM
269 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
270 let files = strip_chunked_file_expenstions(files);
ad20d198 271
80822b95 272 println!("{:20} | {} | {:5} | {}", path, last_backup.format("%c"),
ad20d198 273 backup_count, tools::join(&files, ' '));
812c6f87
DM
274 }
275
276 //Ok(result)
277 Ok(Value::Null)
278}
279
184f17af
DM
280fn list_snapshots(
281 param: Value,
282 _info: &ApiMethod,
dd5495d6 283 _rpcenv: &mut dyn RpcEnvironment,
184f17af
DM
284) -> Result<Value, Error> {
285
286 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 287 let repo: BackupRepository = repo_url.parse()?;
184f17af
DM
288
289 let path = tools::required_string_param(&param, "group")?;
290 let group = BackupGroup::parse(path)?;
291
45cdce06 292 let client = HttpClient::new(repo.host(), repo.user())?;
184f17af 293
9e391bb7 294 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
184f17af 295
9e391bb7
DM
296 let result = client.get(&path, Some(json!({
297 "backup-type": group.backup_type(),
298 "backup-id": group.backup_id(),
299 }))).wait()?;
184f17af 300
d0a03d40
DM
301 record_repository(&repo);
302
184f17af
DM
303 // fixme: implement and use output formatter instead ..
304 let list = result["data"].as_array().unwrap();
305
306 for item in list {
307
308 let id = item["backup-id"].as_str().unwrap();
309 let btype = item["backup-type"].as_str().unwrap();
310 let epoch = item["backup-time"].as_i64().unwrap();
184f17af 311
391d3107 312 let snapshot = BackupDir::new(btype, id, epoch);
184f17af
DM
313
314 let path = snapshot.relative_path().to_str().unwrap().to_owned();
315
8e39232a
DM
316 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
317 let files = strip_chunked_file_expenstions(files);
184f17af 318
875fb1c0 319 println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' '));
184f17af
DM
320 }
321
322 Ok(Value::Null)
323}
324
6f62c924
DM
325fn forget_snapshots(
326 param: Value,
327 _info: &ApiMethod,
dd5495d6 328 _rpcenv: &mut dyn RpcEnvironment,
6f62c924
DM
329) -> Result<Value, Error> {
330
331 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 332 let repo: BackupRepository = repo_url.parse()?;
6f62c924
DM
333
334 let path = tools::required_string_param(&param, "snapshot")?;
335 let snapshot = BackupDir::parse(path)?;
336
45cdce06 337 let mut client = HttpClient::new(repo.host(), repo.user())?;
6f62c924 338
9e391bb7 339 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
6f62c924 340
9e391bb7
DM
341 let result = client.delete(&path, Some(json!({
342 "backup-type": snapshot.group().backup_type(),
343 "backup-id": snapshot.group().backup_id(),
344 "backup-time": snapshot.backup_time().timestamp(),
345 }))).wait()?;
6f62c924 346
d0a03d40
DM
347 record_repository(&repo);
348
6f62c924
DM
349 Ok(result)
350}
351
8cc0d6af
DM
352fn start_garbage_collection(
353 param: Value,
354 _info: &ApiMethod,
dd5495d6 355 _rpcenv: &mut dyn RpcEnvironment,
8cc0d6af
DM
356) -> Result<Value, Error> {
357
358 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 359 let repo: BackupRepository = repo_url.parse()?;
8cc0d6af 360
45cdce06 361 let mut client = HttpClient::new(repo.host(), repo.user())?;
8cc0d6af 362
d0a03d40 363 let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
8cc0d6af 364
5a2df000 365 let result = client.post(&path, None).wait()?;
8cc0d6af 366
d0a03d40
DM
367 record_repository(&repo);
368
8cc0d6af
DM
369 Ok(result)
370}
33d64b81 371
ae0be2dd
DM
372fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
373
374 if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
375 return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
376 }
377 bail!("unable to parse directory specification '{}'", value);
378}
379
6049b71f
DM
380fn create_backup(
381 param: Value,
382 _info: &ApiMethod,
dd5495d6 383 _rpcenv: &mut dyn RpcEnvironment,
6049b71f 384) -> Result<Value, Error> {
ff5d3707 385
33d64b81 386 let repo_url = tools::required_string_param(&param, "repository")?;
ae0be2dd
DM
387
388 let backupspec_list = tools::required_array_param(&param, "backupspec")?;
a914a774 389
edd3c8c6 390 let repo: BackupRepository = repo_url.parse()?;
33d64b81 391
eed6db39
DM
392 let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
393
219ef0e6
DM
394 let verbose = param["verbose"].as_bool().unwrap_or(false);
395
36898ffc 396 let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize);
2d9d143a 397
247cdbce
DM
398 if let Some(size) = chunk_size_opt {
399 verify_chunk_size(size)?;
2d9d143a
DM
400 }
401
fba30411
DM
402 let backup_id = param["host-id"].as_str().unwrap_or(&tools::nodename());
403
ae0be2dd 404 let mut upload_list = vec![];
a914a774 405
ec8a9bb9 406 enum BackupType { PXAR, IMAGE, CONFIG };
6af905c1 407
ae0be2dd
DM
408 for backupspec in backupspec_list {
409 let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
bcd879cf 410
eb1804c5
DM
411 use std::os::unix::fs::FileTypeExt;
412
413 let metadata = match std::fs::metadata(filename) {
414 Ok(m) => m,
ae0be2dd
DM
415 Err(err) => bail!("unable to access '{}' - {}", filename, err),
416 };
eb1804c5 417 let file_type = metadata.file_type();
23bb8780 418
ec8a9bb9 419 let extension = Path::new(target).extension().map(|s| s.to_str().unwrap()).unwrap();
bcd879cf 420
ec8a9bb9
DM
421 match extension {
422 "pxar" => {
423 if !file_type.is_dir() {
424 bail!("got unexpected file type (expected directory)");
425 }
426 upload_list.push((BackupType::PXAR, filename.to_owned(), target.to_owned(), 0));
427 }
428 "img" => {
eb1804c5 429
ec8a9bb9
DM
430 if !(file_type.is_file() || file_type.is_block_device()) {
431 bail!("got unexpected file type (expected file or block device)");
432 }
eb1804c5 433
ec8a9bb9 434 let size = tools::image_size(&PathBuf::from(filename))?;
23bb8780 435
ec8a9bb9 436 if size == 0 { bail!("got zero-sized file '{}'", filename); }
ae0be2dd 437
ec8a9bb9
DM
438 upload_list.push((BackupType::IMAGE, filename.to_owned(), target.to_owned(), size));
439 }
440 "conf" => {
441 if !file_type.is_file() {
442 bail!("got unexpected file type (expected regular file)");
443 }
444 upload_list.push((BackupType::CONFIG, filename.to_owned(), target.to_owned(), metadata.len()));
445 }
446 _ => {
447 bail!("got unknown archive extension '{}'", extension);
448 }
ae0be2dd
DM
449 }
450 }
451
cdebd467 452 let backup_time = Local.timestamp(Local::now().timestamp(), 0);
ae0be2dd 453
c4ff3dce 454 let client = HttpClient::new(repo.host(), repo.user())?;
d0a03d40
DM
455 record_repository(&repo);
456
cdebd467
DM
457 println!("Starting backup");
458 println!("Client name: {}", tools::nodename());
459 println!("Start Time: {}", backup_time.to_rfc3339());
51144821 460
f98ac774
DM
461 let crypt_config = None;
462
39e60bd6 463 let client = client.start_backup(repo.store(), "host", &backup_id, verbose).wait()?;
c4ff3dce 464
6af905c1
DM
465 for (backup_type, filename, target, size) in upload_list {
466 match backup_type {
ec8a9bb9
DM
467 BackupType::CONFIG => {
468 println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
469 client.upload_config(&filename, &target).wait()?;
470 }
6af905c1
DM
471 BackupType::PXAR => {
472 println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
f98ac774
DM
473 backup_directory(
474 &client,
475 &filename,
476 &target,
477 chunk_size_opt,
478 all_file_systems,
479 verbose,
480 crypt_config.clone(),
481 )?;
6af905c1
DM
482 }
483 BackupType::IMAGE => {
484 println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
f98ac774
DM
485 backup_image(
486 &client,
487 &filename,
488 &target,
489 size,
490 chunk_size_opt,
491 verbose,
492 crypt_config.clone(),
493 )?;
6af905c1
DM
494 }
495 }
4818c8b6
DM
496 }
497
c4ff3dce
DM
498 client.finish().wait()?;
499
cdebd467 500 let end_time = Local.timestamp(Local::now().timestamp(), 0);
3ec3ec3f
DM
501 let elapsed = end_time.signed_duration_since(backup_time);
502 println!("Duration: {}", elapsed);
503
cdebd467 504 println!("End Time: {}", end_time.to_rfc3339());
3d5c11e5 505
ff5d3707 506 Ok(Value::Null)
f98ea63d
DM
507}
508
d0a03d40 509fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
f98ea63d
DM
510
511 let mut result = vec![];
512
513 let data: Vec<&str> = arg.splitn(2, ':').collect();
514
bff11030 515 if data.len() != 2 {
8968258b
DM
516 result.push(String::from("root.pxar:/"));
517 result.push(String::from("etc.pxar:/etc"));
bff11030
DM
518 return result;
519 }
f98ea63d 520
496a6784 521 let files = tools::complete_file_name(data[1], param);
f98ea63d
DM
522
523 for file in files {
524 result.push(format!("{}:{}", data[0], file));
525 }
526
527 result
ff5d3707 528}
529
9f912493
DM
530fn restore(
531 param: Value,
532 _info: &ApiMethod,
dd5495d6 533 _rpcenv: &mut dyn RpcEnvironment,
9f912493
DM
534) -> Result<Value, Error> {
535
536 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 537 let repo: BackupRepository = repo_url.parse()?;
9f912493 538
d5c34d98
DM
539 let archive_name = tools::required_string_param(&param, "archive-name")?;
540
45cdce06 541 let mut client = HttpClient::new(repo.host(), repo.user())?;
d0a03d40 542
d0a03d40 543 record_repository(&repo);
d5c34d98 544
9f912493 545 let path = tools::required_string_param(&param, "snapshot")?;
9f912493 546
d5c34d98 547 let query;
9f912493 548
d5c34d98
DM
549 if path.matches('/').count() == 1 {
550 let group = BackupGroup::parse(path)?;
9f912493 551
9e391bb7
DM
552 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
553 let result = client.get(&path, Some(json!({
d5c34d98
DM
554 "backup-type": group.backup_type(),
555 "backup-id": group.backup_id(),
9e391bb7 556 }))).wait()?;
9f912493 557
d5c34d98
DM
558 let list = result["data"].as_array().unwrap();
559 if list.len() == 0 {
560 bail!("backup group '{}' does not contain any snapshots:", path);
561 }
9f912493 562
d5c34d98
DM
563 query = tools::json_object_to_query(json!({
564 "backup-type": group.backup_type(),
565 "backup-id": group.backup_id(),
566 "backup-time": list[0]["backup-time"].as_i64().unwrap(),
567 "archive-name": archive_name,
568 }))?;
569 } else {
570 let snapshot = BackupDir::parse(path)?;
9f912493 571
d5c34d98 572 query = tools::json_object_to_query(json!({
9f912493
DM
573 "backup-type": snapshot.group().backup_type(),
574 "backup-id": snapshot.group().backup_id(),
575 "backup-time": snapshot.backup_time().timestamp(),
d5c34d98 576 "archive-name": archive_name,
9f912493 577 }))?;
d5c34d98 578 }
9f912493 579
d5c34d98 580 let target = tools::required_string_param(&param, "target")?;
2ae7d196 581
8968258b
DM
582 if archive_name.ends_with(".pxar") {
583 let path = format!("api2/json/admin/datastore/{}/pxar?{}", repo.store(), query);
2ae7d196 584
d5c34d98
DM
585 println!("DOWNLOAD FILE {} to {}", path, target);
586
587 let target = PathBuf::from(target);
5defa71b 588 let writer = PxarDecodeWriter::new(&target, true)?;
5a2df000 589 client.download(&path, Box::new(writer)).wait()?;
d5c34d98
DM
590 } else {
591 bail!("unknown file extensions - unable to download '{}'", archive_name);
9f912493
DM
592 }
593
594 Ok(Value::Null)
595}
596
83b7db02
DM
597fn prune(
598 mut param: Value,
599 _info: &ApiMethod,
dd5495d6 600 _rpcenv: &mut dyn RpcEnvironment,
83b7db02
DM
601) -> Result<Value, Error> {
602
603 let repo_url = tools::required_string_param(&param, "repository")?;
edd3c8c6 604 let repo: BackupRepository = repo_url.parse()?;
83b7db02 605
45cdce06 606 let mut client = HttpClient::new(repo.host(), repo.user())?;
83b7db02 607
d0a03d40 608 let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
83b7db02
DM
609
610 param.as_object_mut().unwrap().remove("repository");
611
5a2df000 612 let result = client.post(&path, Some(param)).wait()?;
83b7db02 613
d0a03d40
DM
614 record_repository(&repo);
615
83b7db02
DM
616 Ok(result)
617}
618
5a2df000 619// like get, but simply ignore errors and return Null instead
b2388518 620fn try_get(repo: &BackupRepository, url: &str) -> Value {
024f11bb 621
45cdce06
DM
622 let client = match HttpClient::new(repo.host(), repo.user()) {
623 Ok(v) => v,
624 _ => return Value::Null,
625 };
b2388518 626
9e391bb7 627 let mut resp = match client.get(url, None).wait() {
b2388518
DM
628 Ok(v) => v,
629 _ => return Value::Null,
630 };
631
632 if let Some(map) = resp.as_object_mut() {
633 if let Some(data) = map.remove("data") {
634 return data;
635 }
636 }
637 Value::Null
638}
639
640fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> {
024f11bb
DM
641
642 let repo_url = match param.get("repository") {
643 Some(v) => v,
b2388518 644 _ => return None,
024f11bb
DM
645 };
646
647 let repo: BackupRepository = match repo_url.parse() {
648 Ok(v) => v,
b2388518 649 _ => return None,
024f11bb
DM
650 };
651
b2388518
DM
652 Some(repo)
653}
024f11bb 654
b2388518 655fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
024f11bb 656
b2388518
DM
657 let mut result = vec![];
658
659 let repo = match extract_repo(param) {
660 Some(v) => v,
024f11bb
DM
661 _ => return result,
662 };
663
b2388518
DM
664 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
665
666 let data = try_get(&repo, &path);
667
668 if let Some(list) = data.as_array() {
024f11bb 669 for item in list {
98f0b972
DM
670 if let (Some(backup_id), Some(backup_type)) =
671 (item["backup-id"].as_str(), item["backup-type"].as_str())
672 {
673 result.push(format!("{}/{}", backup_type, backup_id));
024f11bb
DM
674 }
675 }
676 }
677
678 result
679}
680
b2388518
DM
681fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
682
683 let mut result = vec![];
684
685 let repo = match extract_repo(param) {
686 Some(v) => v,
687 _ => return result,
688 };
689
690 if arg.matches('/').count() < 2 {
691 let groups = complete_backup_group(arg, param);
692 for group in groups {
693 result.push(group.to_string());
694 result.push(format!("{}/", group));
695 }
696 return result;
697 }
698
699 let mut parts = arg.split('/');
700 let query = tools::json_object_to_query(json!({
701 "backup-type": parts.next().unwrap(),
702 "backup-id": parts.next().unwrap(),
703 })).unwrap();
704
705 let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), query);
706
707 let data = try_get(&repo, &path);
708
709 if let Some(list) = data.as_array() {
710 for item in list {
711 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
712 (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64())
713 {
714 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
715 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
716 }
717 }
718 }
719
720 result
721}
722
08dc340a
DM
723fn complete_archive_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
724
725 let mut result = vec![];
726
727 let repo = match extract_repo(param) {
728 Some(v) => v,
729 _ => return result,
730 };
731
732 let snapshot = match param.get("snapshot") {
733 Some(path) => {
734 match BackupDir::parse(path) {
735 Ok(v) => v,
736 _ => return result,
737 }
738 }
739 _ => return result,
740 };
741
742 let query = tools::json_object_to_query(json!({
743 "backup-type": snapshot.group().backup_type(),
744 "backup-id": snapshot.group().backup_id(),
745 "backup-time": snapshot.backup_time().timestamp(),
746 })).unwrap();
747
748 let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query);
749
750 let data = try_get(&repo, &path);
751
752 if let Some(list) = data.as_array() {
753 for item in list {
754 if let Some(filename) = item.as_str() {
755 result.push(filename.to_owned());
756 }
757 }
758 }
759
760 strip_chunked_file_expenstions(result)
761}
762
49811347
DM
763fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
764
765 let mut result = vec![];
766
767 let mut size = 64;
768 loop {
769 result.push(size.to_string());
770 size = size * 2;
771 if size > 4096 { break; }
772 }
773
774 result
775}
776
ff5d3707 777fn main() {
778
33d64b81
DM
779 let repo_url_schema: Arc<Schema> = Arc::new(
780 StringSchema::new("Repository URL.")
781 .format(BACKUP_REPO_URL.clone())
782 .max_length(256)
783 .into()
784 );
785
25f1650b
DM
786 let backup_source_schema: Arc<Schema> = Arc::new(
787 StringSchema::new("Backup source specification ([<label>:<path>]).")
788 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
789 .into()
790 );
791
597a9203 792 let backup_cmd_def = CliCommand::new(
ff5d3707 793 ApiMethod::new(
bcd879cf 794 create_backup,
597a9203 795 ObjectSchema::new("Create (host) backup.")
33d64b81 796 .required("repository", repo_url_schema.clone())
ae0be2dd
DM
797 .required(
798 "backupspec",
799 ArraySchema::new(
74cdb521 800 "List of backup source specifications ([<label.ext>:<path>] ...)",
25f1650b 801 backup_source_schema,
ae0be2dd
DM
802 ).min_length(1)
803 )
219ef0e6
DM
804 .optional(
805 "verbose",
806 BooleanSchema::new("Verbose output.").default(false))
fba30411
DM
807 .optional(
808 "host-id",
809 StringSchema::new("Use specified ID for the backup group name ('host/<id>'). The default is the system hostname."))
2d9d143a
DM
810 .optional(
811 "chunk-size",
812 IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
813 .minimum(64)
814 .maximum(4096)
815 .default(4096)
816 )
ff5d3707 817 ))
ae0be2dd 818 .arg_param(vec!["repository", "backupspec"])
d0a03d40 819 .completion_cb("repository", complete_repository)
49811347
DM
820 .completion_cb("backupspec", complete_backup_source)
821 .completion_cb("chunk-size", complete_chunk_size);
f8838fe9 822
41c039e1
DM
823 let list_cmd_def = CliCommand::new(
824 ApiMethod::new(
812c6f87
DM
825 list_backup_groups,
826 ObjectSchema::new("List backup groups.")
33d64b81 827 .required("repository", repo_url_schema.clone())
41c039e1 828 ))
d0a03d40
DM
829 .arg_param(vec!["repository"])
830 .completion_cb("repository", complete_repository);
41c039e1 831
184f17af
DM
832 let snapshots_cmd_def = CliCommand::new(
833 ApiMethod::new(
834 list_snapshots,
835 ObjectSchema::new("List backup snapshots.")
836 .required("repository", repo_url_schema.clone())
837 .required("group", StringSchema::new("Backup group."))
838 ))
d0a03d40 839 .arg_param(vec!["repository", "group"])
024f11bb 840 .completion_cb("group", complete_backup_group)
d0a03d40 841 .completion_cb("repository", complete_repository);
184f17af 842
6f62c924
DM
843 let forget_cmd_def = CliCommand::new(
844 ApiMethod::new(
845 forget_snapshots,
846 ObjectSchema::new("Forget (remove) backup snapshots.")
847 .required("repository", repo_url_schema.clone())
848 .required("snapshot", StringSchema::new("Snapshot path."))
849 ))
d0a03d40 850 .arg_param(vec!["repository", "snapshot"])
b2388518
DM
851 .completion_cb("repository", complete_repository)
852 .completion_cb("snapshot", complete_group_or_snapshot);
6f62c924 853
8cc0d6af
DM
854 let garbage_collect_cmd_def = CliCommand::new(
855 ApiMethod::new(
856 start_garbage_collection,
857 ObjectSchema::new("Start garbage collection for a specific repository.")
858 .required("repository", repo_url_schema.clone())
859 ))
d0a03d40
DM
860 .arg_param(vec!["repository"])
861 .completion_cb("repository", complete_repository);
8cc0d6af 862
9f912493
DM
863 let restore_cmd_def = CliCommand::new(
864 ApiMethod::new(
865 restore,
866 ObjectSchema::new("Restore backup repository.")
867 .required("repository", repo_url_schema.clone())
d5c34d98
DM
868 .required("snapshot", StringSchema::new("Group/Snapshot path."))
869 .required("archive-name", StringSchema::new("Backup archive name."))
9f912493
DM
870 .required("target", StringSchema::new("Target directory path."))
871 ))
d0a03d40 872 .arg_param(vec!["repository", "snapshot", "archive-name", "target"])
b2388518 873 .completion_cb("repository", complete_repository)
08dc340a
DM
874 .completion_cb("snapshot", complete_group_or_snapshot)
875 .completion_cb("archive-name", complete_archive_name)
876 .completion_cb("target", tools::complete_file_name);
9f912493 877
83b7db02
DM
878 let prune_cmd_def = CliCommand::new(
879 ApiMethod::new(
880 prune,
881 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
882 ObjectSchema::new("Prune backup repository.")
883 .required("repository", repo_url_schema.clone())
884 )
885 ))
d0a03d40
DM
886 .arg_param(vec!["repository"])
887 .completion_cb("repository", complete_repository);
9f912493 888
41c039e1 889 let cmd_def = CliCommandMap::new()
597a9203 890 .insert("backup".to_owned(), backup_cmd_def.into())
6f62c924 891 .insert("forget".to_owned(), forget_cmd_def.into())
8cc0d6af 892 .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
83b7db02 893 .insert("list".to_owned(), list_cmd_def.into())
184f17af 894 .insert("prune".to_owned(), prune_cmd_def.into())
9f912493 895 .insert("restore".to_owned(), restore_cmd_def.into())
184f17af 896 .insert("snapshots".to_owned(), snapshots_cmd_def.into());
a914a774 897
5a2df000
DM
898 hyper::rt::run(futures::future::lazy(move || {
899 run_cli_command(cmd_def.into());
900 Ok(())
901 }));
496a6784 902
ff5d3707 903}