]> git.proxmox.com Git - proxmox-backup.git/blame - src/bin/proxmox-backup-client.rs
src/pxar/decoder.rs: require Send
[proxmox-backup.git] / src / bin / proxmox-backup-client.rs
CommitLineData
ff5d3707 1use failure::*;
70235f72
CE
2use nix::unistd::{fork, ForkResult, pipe};
3use std::os::unix::io::RawFd;
fa5d6977 4use chrono::{Local, Utc, TimeZone};
e9c9409a 5use std::path::{Path, PathBuf};
2eeaacb9 6use std::collections::{HashSet, HashMap};
70235f72 7use std::ffi::OsStr;
bb19af73 8use std::io::{Write, Seek, SeekFrom};
2761d6a4
DM
9use std::os::unix::fs::OpenOptionsExt;
10
552c2259 11use proxmox::{sortable, identity};
e18a6c9e 12use proxmox::tools::fs::{file_get_contents, file_get_json, file_set_contents, image_size};
3d482025
WB
13use proxmox::api::{ApiHandler, ApiMethod, RpcEnvironment};
14use proxmox::api::schema::*;
7eea56ca 15use proxmox::api::cli::*;
5830c205 16use proxmox::api::api;
ff5d3707 17
fe0e04c6 18use proxmox_backup::tools;
bbf9e7e9 19use proxmox_backup::api2::types::*;
151c6ce2 20use proxmox_backup::client::*;
247cdbce 21use proxmox_backup::backup::*;
7926a3a1 22use proxmox_backup::pxar::{ self, catalog::* };
86eda3eb 23
fe0e04c6
DM
24//use proxmox_backup::backup::image_index::*;
25//use proxmox_backup::config::datastore;
8968258b 26//use proxmox_backup::pxar::encoder::*;
728797d0 27//use proxmox_backup::backup::datastore::*;
23bb8780 28
f5f13ebc 29use serde_json::{json, Value};
1c0472e8 30//use hyper::Body;
2761d6a4 31use std::sync::{Arc, Mutex};
255f378a 32//use regex::Regex;
d0a03d40 33use xdg::BaseDirectories;
ae0be2dd 34
5a2df000 35use futures::*;
c4ff3dce 36use tokio::sync::mpsc;
ae0be2dd 37
3d482025 38proxmox::api::const_regex! {
255f378a 39 BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$";
ae0be2dd 40}
33d64b81 41
255f378a
DM
42const REPO_URL_SCHEMA: Schema = StringSchema::new("Repository URL.")
43 .format(&BACKUP_REPO_URL)
44 .max_length(256)
45 .schema();
d0a03d40 46
2665cef7
DM
47fn get_default_repository() -> Option<String> {
48 std::env::var("PBS_REPOSITORY").ok()
49}
50
51fn extract_repository_from_value(
52 param: &Value,
53) -> Result<BackupRepository, Error> {
54
55 let repo_url = param["repository"]
56 .as_str()
57 .map(String::from)
58 .or_else(get_default_repository)
59 .ok_or_else(|| format_err!("unable to get (default) repository"))?;
60
61 let repo: BackupRepository = repo_url.parse()?;
62
63 Ok(repo)
64}
65
66fn extract_repository_from_map(
67 param: &HashMap<String, String>,
68) -> Option<BackupRepository> {
69
70 param.get("repository")
71 .map(String::from)
72 .or_else(get_default_repository)
73 .and_then(|repo_url| repo_url.parse::<BackupRepository>().ok())
74}
75
d0a03d40
DM
76fn record_repository(repo: &BackupRepository) {
77
78 let base = match BaseDirectories::with_prefix("proxmox-backup") {
79 Ok(v) => v,
80 _ => return,
81 };
82
83 // usually $HOME/.cache/proxmox-backup/repo-list
84 let path = match base.place_cache_file("repo-list") {
85 Ok(v) => v,
86 _ => return,
87 };
88
11377a47 89 let mut data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
d0a03d40
DM
90
91 let repo = repo.to_string();
92
93 data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 };
94
95 let mut map = serde_json::map::Map::new();
96
97 loop {
98 let mut max_used = 0;
99 let mut max_repo = None;
100 for (repo, count) in data.as_object().unwrap() {
101 if map.contains_key(repo) { continue; }
102 if let Some(count) = count.as_i64() {
103 if count > max_used {
104 max_used = count;
105 max_repo = Some(repo);
106 }
107 }
108 }
109 if let Some(repo) = max_repo {
110 map.insert(repo.to_owned(), json!(max_used));
111 } else {
112 break;
113 }
114 if map.len() > 10 { // store max. 10 repos
115 break;
116 }
117 }
118
119 let new_data = json!(map);
120
e18a6c9e 121 let _ = file_set_contents(path, new_data.to_string().as_bytes(), None);
d0a03d40
DM
122}
123
49811347 124fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
d0a03d40
DM
125
126 let mut result = vec![];
127
128 let base = match BaseDirectories::with_prefix("proxmox-backup") {
129 Ok(v) => v,
130 _ => return result,
131 };
132
133 // usually $HOME/.cache/proxmox-backup/repo-list
134 let path = match base.place_cache_file("repo-list") {
135 Ok(v) => v,
136 _ => return result,
137 };
138
11377a47 139 let data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
d0a03d40
DM
140
141 if let Some(map) = data.as_object() {
49811347 142 for (repo, _count) in map {
d0a03d40
DM
143 result.push(repo.to_owned());
144 }
145 }
146
147 result
148}
149
d105176f
DM
150async fn view_task_result(
151 client: HttpClient,
152 result: Value,
153 output_format: &str,
154) -> Result<(), Error> {
155 let data = &result["data"];
156 if output_format == "text" {
157 if let Some(upid) = data.as_str() {
158 display_task_log(client, upid, true).await?;
159 }
160 } else {
161 format_and_print_result(&data, &output_format);
162 }
163
164 Ok(())
165}
166
e9722f8b 167async fn backup_directory<P: AsRef<Path>>(
cf9271e2 168 client: &BackupWriter,
17d6979a 169 dir_path: P,
247cdbce 170 archive_name: &str,
36898ffc 171 chunk_size: Option<usize>,
2eeaacb9 172 device_set: Option<HashSet<u64>>,
219ef0e6 173 verbose: bool,
5b72c9b4 174 skip_lost_and_found: bool,
f98ac774 175 crypt_config: Option<Arc<CryptConfig>>,
bf6e3217 176 catalog: Arc<Mutex<CatalogWriter<SenderWriter>>>,
2c3891d1 177) -> Result<BackupStats, Error> {
33d64b81 178
2761d6a4 179 let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), device_set, verbose, skip_lost_and_found, catalog)?;
e9722f8b 180 let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
ff3d3100 181
e9722f8b 182 let (mut tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
5e7a09be 183
c4ff3dce 184 let stream = rx
e9722f8b 185 .map_err(Error::from);
17d6979a 186
c4ff3dce 187 // spawn chunker inside a separate task so that it can run parallel
e9722f8b 188 tokio::spawn(async move {
db0cb9ce
WB
189 while let Some(v) = chunk_stream.next().await {
190 let _ = tx.send(v).await;
191 }
e9722f8b 192 });
17d6979a 193
e9722f8b
WB
194 let stats = client
195 .upload_stream(archive_name, stream, "dynamic", None, crypt_config)
196 .await?;
bcd879cf 197
2c3891d1 198 Ok(stats)
bcd879cf
DM
199}
200
e9722f8b 201async fn backup_image<P: AsRef<Path>>(
cf9271e2 202 client: &BackupWriter,
6af905c1
DM
203 image_path: P,
204 archive_name: &str,
205 image_size: u64,
36898ffc 206 chunk_size: Option<usize>,
1c0472e8 207 _verbose: bool,
f98ac774 208 crypt_config: Option<Arc<CryptConfig>>,
2c3891d1 209) -> Result<BackupStats, Error> {
6af905c1 210
6af905c1
DM
211 let path = image_path.as_ref().to_owned();
212
e9722f8b 213 let file = tokio::fs::File::open(path).await?;
6af905c1 214
db0cb9ce 215 let stream = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
6af905c1
DM
216 .map_err(Error::from);
217
36898ffc 218 let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
6af905c1 219
e9722f8b
WB
220 let stats = client
221 .upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config)
222 .await?;
6af905c1 223
2c3891d1 224 Ok(stats)
6af905c1
DM
225}
226
52c171e4
DM
227fn strip_server_file_expenstion(name: &str) -> String {
228
11377a47
DM
229 if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
230 name[..name.len()-5].to_owned()
52c171e4 231 } else {
11377a47 232 name.to_owned() // should not happen
8e39232a 233 }
8e39232a
DM
234}
235
812c6f87
DM
236fn list_backup_groups(
237 param: Value,
238 _info: &ApiMethod,
dd5495d6 239 _rpcenv: &mut dyn RpcEnvironment,
812c6f87
DM
240) -> Result<Value, Error> {
241
2665cef7 242 let repo = extract_repository_from_value(&param)?;
812c6f87 243
cc2ce4a9 244 let client = HttpClient::new(repo.host(), repo.user(), None)?;
812c6f87 245
d0a03d40 246 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
812c6f87 247
e9722f8b
WB
248 let mut result = async_main(async move {
249 client.get(&path, None).await
250 })?;
812c6f87 251
d0a03d40
DM
252 record_repository(&repo);
253
812c6f87 254 // fixme: implement and use output formatter instead ..
80822b95
DM
255 let list = result["data"].as_array_mut().unwrap();
256
257 list.sort_unstable_by(|a, b| {
258 let a_id = a["backup-id"].as_str().unwrap();
259 let a_backup_type = a["backup-type"].as_str().unwrap();
260 let b_id = b["backup-id"].as_str().unwrap();
261 let b_backup_type = b["backup-type"].as_str().unwrap();
262
263 let type_order = a_backup_type.cmp(b_backup_type);
264 if type_order == std::cmp::Ordering::Equal {
265 a_id.cmp(b_id)
266 } else {
267 type_order
268 }
269 });
812c6f87 270
34a816cc
DM
271 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
272
273 let mut result = vec![];
274
812c6f87
DM
275 for item in list {
276
ad20d198
DM
277 let id = item["backup-id"].as_str().unwrap();
278 let btype = item["backup-type"].as_str().unwrap();
279 let epoch = item["last-backup"].as_i64().unwrap();
fa5d6977 280 let last_backup = Utc.timestamp(epoch, 0);
ad20d198 281 let backup_count = item["backup-count"].as_u64().unwrap();
812c6f87 282
1e9a94e5 283 let group = BackupGroup::new(btype, id);
812c6f87
DM
284
285 let path = group.group_path().to_str().unwrap().to_owned();
ad20d198 286
52c171e4
DM
287 let files = item["files"].as_array().unwrap().iter()
288 .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
ad20d198 289
34a816cc 290 if output_format == "text" {
fa5d6977
DM
291 println!(
292 "{:20} | {} | {:5} | {}",
293 path,
294 BackupDir::backup_time_to_string(last_backup),
295 backup_count,
296 tools::join(&files, ' '),
297 );
34a816cc
DM
298 } else {
299 result.push(json!({
300 "backup-type": btype,
301 "backup-id": id,
302 "last-backup": epoch,
303 "backup-count": backup_count,
304 "files": files,
305 }));
306 }
812c6f87
DM
307 }
308
9aa3f682 309 if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
34a816cc 310
812c6f87
DM
311 Ok(Value::Null)
312}
313
184f17af
DM
314fn list_snapshots(
315 param: Value,
316 _info: &ApiMethod,
dd5495d6 317 _rpcenv: &mut dyn RpcEnvironment,
184f17af
DM
318) -> Result<Value, Error> {
319
2665cef7 320 let repo = extract_repository_from_value(&param)?;
184f17af 321
34a816cc
DM
322 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
323
cc2ce4a9 324 let client = HttpClient::new(repo.host(), repo.user(), None)?;
184f17af 325
9e391bb7 326 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
184f17af 327
15c847f1
DM
328 let mut args = json!({});
329 if let Some(path) = param["group"].as_str() {
330 let group = BackupGroup::parse(path)?;
331 args["backup-type"] = group.backup_type().into();
332 args["backup-id"] = group.backup_id().into();
333 }
334
e9722f8b
WB
335 let result = async_main(async move {
336 client.get(&path, Some(args)).await
337 })?;
184f17af 338
d0a03d40
DM
339 record_repository(&repo);
340
184f17af
DM
341 let list = result["data"].as_array().unwrap();
342
34a816cc
DM
343 let mut result = vec![];
344
184f17af
DM
345 for item in list {
346
347 let id = item["backup-id"].as_str().unwrap();
348 let btype = item["backup-type"].as_str().unwrap();
349 let epoch = item["backup-time"].as_i64().unwrap();
184f17af 350
391d3107 351 let snapshot = BackupDir::new(btype, id, epoch);
184f17af
DM
352
353 let path = snapshot.relative_path().to_str().unwrap().to_owned();
354
52c171e4
DM
355 let files = item["files"].as_array().unwrap().iter()
356 .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
184f17af 357
34a816cc 358 if output_format == "text" {
a17a0e7a
DM
359 let size_str = if let Some(size) = item["size"].as_u64() {
360 size.to_string()
361 } else {
362 String::from("-")
363 };
364 println!("{} | {} | {}", path, size_str, tools::join(&files, ' '));
34a816cc 365 } else {
a17a0e7a 366 let mut data = json!({
34a816cc
DM
367 "backup-type": btype,
368 "backup-id": id,
369 "backup-time": epoch,
370 "files": files,
a17a0e7a
DM
371 });
372 if let Some(size) = item["size"].as_u64() {
373 data["size"] = size.into();
374 }
375 result.push(data);
34a816cc 376 }
184f17af
DM
377 }
378
f6ede796 379 if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
34a816cc 380
184f17af
DM
381 Ok(Value::Null)
382}
383
6f62c924
DM
384fn forget_snapshots(
385 param: Value,
386 _info: &ApiMethod,
dd5495d6 387 _rpcenv: &mut dyn RpcEnvironment,
6f62c924
DM
388) -> Result<Value, Error> {
389
2665cef7 390 let repo = extract_repository_from_value(&param)?;
6f62c924
DM
391
392 let path = tools::required_string_param(&param, "snapshot")?;
393 let snapshot = BackupDir::parse(path)?;
394
cc2ce4a9 395 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
6f62c924 396
9e391bb7 397 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
6f62c924 398
e9722f8b
WB
399 let result = async_main(async move {
400 client.delete(&path, Some(json!({
401 "backup-type": snapshot.group().backup_type(),
402 "backup-id": snapshot.group().backup_id(),
403 "backup-time": snapshot.backup_time().timestamp(),
404 }))).await
405 })?;
6f62c924 406
d0a03d40
DM
407 record_repository(&repo);
408
6f62c924
DM
409 Ok(result)
410}
411
e240d8be
DM
412fn api_login(
413 param: Value,
414 _info: &ApiMethod,
415 _rpcenv: &mut dyn RpcEnvironment,
416) -> Result<Value, Error> {
417
418 let repo = extract_repository_from_value(&param)?;
419
cc2ce4a9 420 let client = HttpClient::new(repo.host(), repo.user(), None)?;
e9722f8b 421 async_main(async move { client.login().await })?;
e240d8be
DM
422
423 record_repository(&repo);
424
425 Ok(Value::Null)
426}
427
428fn api_logout(
429 param: Value,
430 _info: &ApiMethod,
431 _rpcenv: &mut dyn RpcEnvironment,
432) -> Result<Value, Error> {
433
434 let repo = extract_repository_from_value(&param)?;
435
436 delete_ticket_info(repo.host(), repo.user())?;
437
438 Ok(Value::Null)
439}
440
9049a8cf
DM
441fn dump_catalog(
442 param: Value,
443 _info: &ApiMethod,
444 _rpcenv: &mut dyn RpcEnvironment,
445) -> Result<Value, Error> {
446
447 let repo = extract_repository_from_value(&param)?;
448
449 let path = tools::required_string_param(&param, "snapshot")?;
450 let snapshot = BackupDir::parse(path)?;
451
11377a47 452 let keyfile = param["keyfile"].as_str().map(PathBuf::from);
9049a8cf
DM
453
454 let crypt_config = match keyfile {
455 None => None,
456 Some(path) => {
a8f10f84 457 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
9025312a 458 Some(Arc::new(CryptConfig::new(key)?))
9049a8cf
DM
459 }
460 };
461
cc2ce4a9 462 let client = HttpClient::new(repo.host(), repo.user(), None)?;
9049a8cf 463
e9722f8b 464 async_main(async move {
9e490a74
DM
465 let client = BackupReader::start(
466 client,
296c50ba 467 crypt_config.clone(),
e9722f8b
WB
468 repo.store(),
469 &snapshot.group().backup_type(),
470 &snapshot.group().backup_id(),
9e490a74
DM
471 snapshot.backup_time(),
472 true,
473 ).await?;
9049a8cf 474
f06b820a 475 let manifest = client.download_manifest().await?;
d2267b11 476
c3d84a22 477 let index = client.download_dynamic_index(&manifest, CATALOG_NAME).await?;
bf6e3217
DM
478
479 let most_used = index.find_most_used_chunks(8);
480
481 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
482
483 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
484
485 let mut catalogfile = std::fs::OpenOptions::new()
e9722f8b 486 .write(true)
bf6e3217 487 .read(true)
e9722f8b
WB
488 .custom_flags(libc::O_TMPFILE)
489 .open("/tmp")?;
9049a8cf 490
bf6e3217
DM
491 std::io::copy(&mut reader, &mut catalogfile)
492 .map_err(|err| format_err!("unable to download catalog - {}", err))?;
d2267b11 493
bf6e3217 494 catalogfile.seek(SeekFrom::Start(0))?;
a84ef4c2 495
bf6e3217 496 let mut catalog_reader = CatalogReader::new(catalogfile);
9049a8cf 497
e9722f8b 498 catalog_reader.dump()?;
9049a8cf 499
e9722f8b
WB
500 record_repository(&repo);
501
502 Ok::<(), Error>(())
503 })?;
9049a8cf
DM
504
505 Ok(Value::Null)
506}
507
52c171e4
DM
508fn list_snapshot_files(
509 param: Value,
510 _info: &ApiMethod,
511 _rpcenv: &mut dyn RpcEnvironment,
512) -> Result<Value, Error> {
513
514 let repo = extract_repository_from_value(&param)?;
515
516 let path = tools::required_string_param(&param, "snapshot")?;
517 let snapshot = BackupDir::parse(path)?;
518
519 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
520
cc2ce4a9 521 let client = HttpClient::new(repo.host(), repo.user(), None)?;
52c171e4
DM
522
523 let path = format!("api2/json/admin/datastore/{}/files", repo.store());
524
e9722f8b
WB
525 let mut result = async_main(async move {
526 client.get(&path, Some(json!({
527 "backup-type": snapshot.group().backup_type(),
528 "backup-id": snapshot.group().backup_id(),
529 "backup-time": snapshot.backup_time().timestamp(),
530 }))).await
531 })?;
52c171e4
DM
532
533 record_repository(&repo);
534
8c70e3eb 535 let list: Value = result["data"].take();
52c171e4
DM
536
537 if output_format == "text" {
8c70e3eb
DM
538 for item in list.as_array().unwrap().iter() {
539 println!(
540 "{} {}",
541 strip_server_file_expenstion(item["filename"].as_str().unwrap()),
542 item["size"].as_u64().unwrap_or(0),
543 );
52c171e4
DM
544 }
545 } else {
8c70e3eb 546 format_and_print_result(&list, &output_format);
52c171e4
DM
547 }
548
549 Ok(Value::Null)
550}
551
8cc0d6af
DM
552fn start_garbage_collection(
553 param: Value,
554 _info: &ApiMethod,
dd5495d6 555 _rpcenv: &mut dyn RpcEnvironment,
8cc0d6af
DM
556) -> Result<Value, Error> {
557
2665cef7 558 let repo = extract_repository_from_value(&param)?;
e5f7def4 559 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
8cc0d6af 560
cc2ce4a9 561 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
8cc0d6af 562
d0a03d40 563 let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
8cc0d6af 564
e5f7def4
DM
565 async_main(async {
566 let result = client.post(&path, None).await?;
8cc0d6af 567
e5f7def4 568 record_repository(&repo);
d0a03d40 569
d105176f 570 view_task_result(client, result, &output_format).await
e5f7def4
DM
571 })?;
572
e5f7def4 573 Ok(Value::Null)
8cc0d6af 574}
33d64b81 575
ae0be2dd
DM
576fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
577
255f378a 578 if let Some(caps) = (BACKUPSPEC_REGEX.regex_obj)().captures(value) {
ae0be2dd
DM
579 return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
580 }
581 bail!("unable to parse directory specification '{}'", value);
582}
583
bf6e3217
DM
584fn spawn_catalog_upload(
585 client: Arc<BackupWriter>,
586 crypt_config: Option<Arc<CryptConfig>>,
587) -> Result<
588 (
589 Arc<Mutex<CatalogWriter<SenderWriter>>>,
590 tokio::sync::oneshot::Receiver<Result<BackupStats, Error>>
591 ), Error>
592{
593 let (catalog_tx, catalog_rx) = mpsc::channel(10); // allow to buffer 10 writes
594 let catalog_stream = catalog_rx.map_err(Error::from);
595 let catalog_chunk_size = 512*1024;
596 let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size));
597
598 let catalog = Arc::new(Mutex::new(CatalogWriter::new(SenderWriter::new(catalog_tx))?));
599
600 let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel();
601
602 tokio::spawn(async move {
603 let catalog_upload_result = client
604 .upload_stream(CATALOG_NAME, catalog_chunk_stream, "dynamic", None, crypt_config)
605 .await;
606
607 if let Err(ref err) = catalog_upload_result {
608 eprintln!("catalog upload error - {}", err);
609 client.cancel();
610 }
611
612 let _ = catalog_result_tx.send(catalog_upload_result);
613 });
614
615 Ok((catalog, catalog_result_rx))
616}
617
6049b71f
DM
618fn create_backup(
619 param: Value,
620 _info: &ApiMethod,
dd5495d6 621 _rpcenv: &mut dyn RpcEnvironment,
6049b71f 622) -> Result<Value, Error> {
ff5d3707 623
2665cef7 624 let repo = extract_repository_from_value(&param)?;
ae0be2dd
DM
625
626 let backupspec_list = tools::required_array_param(&param, "backupspec")?;
a914a774 627
eed6db39
DM
628 let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
629
5b72c9b4
DM
630 let skip_lost_and_found = param["skip-lost-and-found"].as_bool().unwrap_or(false);
631
219ef0e6
DM
632 let verbose = param["verbose"].as_bool().unwrap_or(false);
633
ca5d0b61
DM
634 let backup_time_opt = param["backup-time"].as_i64();
635
36898ffc 636 let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize);
2d9d143a 637
247cdbce
DM
638 if let Some(size) = chunk_size_opt {
639 verify_chunk_size(size)?;
2d9d143a
DM
640 }
641
11377a47 642 let keyfile = param["keyfile"].as_str().map(PathBuf::from);
6d0983db 643
f69adc81 644 let backup_id = param["backup-id"].as_str().unwrap_or(&proxmox::tools::nodename());
fba30411 645
bbf9e7e9 646 let backup_type = param["backup-type"].as_str().unwrap_or("host");
ca5d0b61 647
2eeaacb9
DM
648 let include_dev = param["include-dev"].as_array();
649
650 let mut devices = if all_file_systems { None } else { Some(HashSet::new()) };
651
652 if let Some(include_dev) = include_dev {
653 if all_file_systems {
654 bail!("option 'all-file-systems' conflicts with option 'include-dev'");
655 }
656
657 let mut set = HashSet::new();
658 for path in include_dev {
659 let path = path.as_str().unwrap();
660 let stat = nix::sys::stat::stat(path)
661 .map_err(|err| format_err!("fstat {:?} failed - {}", path, err))?;
662 set.insert(stat.st_dev);
663 }
664 devices = Some(set);
665 }
666
ae0be2dd 667 let mut upload_list = vec![];
a914a774 668
79679c2d 669 enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE };
6af905c1 670
bf6e3217
DM
671 let mut upload_catalog = false;
672
ae0be2dd
DM
673 for backupspec in backupspec_list {
674 let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
bcd879cf 675
eb1804c5
DM
676 use std::os::unix::fs::FileTypeExt;
677
3fa71727
CE
678 let metadata = std::fs::metadata(filename)
679 .map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?;
eb1804c5 680 let file_type = metadata.file_type();
23bb8780 681
4af0ee05 682 let extension = target.rsplit('.').next()
11377a47 683 .ok_or_else(|| format_err!("missing target file extenion '{}'", target))?;
bcd879cf 684
ec8a9bb9
DM
685 match extension {
686 "pxar" => {
687 if !file_type.is_dir() {
688 bail!("got unexpected file type (expected directory)");
689 }
4af0ee05 690 upload_list.push((BackupType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
bf6e3217 691 upload_catalog = true;
ec8a9bb9
DM
692 }
693 "img" => {
eb1804c5 694
ec8a9bb9
DM
695 if !(file_type.is_file() || file_type.is_block_device()) {
696 bail!("got unexpected file type (expected file or block device)");
697 }
eb1804c5 698
e18a6c9e 699 let size = image_size(&PathBuf::from(filename))?;
23bb8780 700
ec8a9bb9 701 if size == 0 { bail!("got zero-sized file '{}'", filename); }
ae0be2dd 702
4af0ee05 703 upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
ec8a9bb9
DM
704 }
705 "conf" => {
706 if !file_type.is_file() {
707 bail!("got unexpected file type (expected regular file)");
708 }
4af0ee05 709 upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
ec8a9bb9 710 }
79679c2d
DM
711 "log" => {
712 if !file_type.is_file() {
713 bail!("got unexpected file type (expected regular file)");
714 }
4af0ee05 715 upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
79679c2d 716 }
ec8a9bb9
DM
717 _ => {
718 bail!("got unknown archive extension '{}'", extension);
719 }
ae0be2dd
DM
720 }
721 }
722
11377a47 723 let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
ae0be2dd 724
cc2ce4a9 725 let client = HttpClient::new(repo.host(), repo.user(), None)?;
d0a03d40
DM
726 record_repository(&repo);
727
ca5d0b61
DM
728 println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
729
f69adc81 730 println!("Client name: {}", proxmox::tools::nodename());
ca5d0b61
DM
731
732 let start_time = Local::now();
733
7a6cfbd9 734 println!("Starting protocol: {}", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
51144821 735
bb823140
DM
736 let (crypt_config, rsa_encrypted_key) = match keyfile {
737 None => (None, None),
6d0983db 738 Some(path) => {
a8f10f84 739 let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
bb823140
DM
740
741 let crypt_config = CryptConfig::new(key)?;
742
743 let path = master_pubkey_path()?;
744 if path.exists() {
e18a6c9e 745 let pem_data = file_get_contents(&path)?;
bb823140
DM
746 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
747 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
748 (Some(Arc::new(crypt_config)), Some(enc_key))
749 } else {
750 (Some(Arc::new(crypt_config)), None)
751 }
6d0983db
DM
752 }
753 };
f98ac774 754
e9722f8b 755 async_main(async move {
cf9271e2
DM
756 let client = BackupWriter::start(
757 client,
758 repo.store(),
759 backup_type,
760 &backup_id,
761 backup_time,
762 verbose,
763 ).await?;
e9722f8b 764
59e9ba01
DM
765 let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
766 let mut manifest = BackupManifest::new(snapshot);
e9722f8b 767
bf6e3217 768 let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
e9722f8b
WB
769
770 for (backup_type, filename, target, size) in upload_list {
771 match backup_type {
772 BackupType::CONFIG => {
773 println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
774 let stats = client
775 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
776 .await?;
59e9ba01 777 manifest.add_file(target, stats.size, stats.csum);
e9722f8b
WB
778 }
779 BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
780 println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target);
781 let stats = client
782 .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
783 .await?;
59e9ba01 784 manifest.add_file(target, stats.size, stats.csum);
e9722f8b
WB
785 }
786 BackupType::PXAR => {
e9722f8b
WB
787 println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
788 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
789 let stats = backup_directory(
790 &client,
791 &filename,
792 &target,
793 chunk_size_opt,
794 devices.clone(),
795 verbose,
796 skip_lost_and_found,
797 crypt_config.clone(),
798 catalog.clone(),
799 ).await?;
59e9ba01 800 manifest.add_file(target, stats.size, stats.csum);
e9722f8b
WB
801 catalog.lock().unwrap().end_directory()?;
802 }
803 BackupType::IMAGE => {
804 println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
805 let stats = backup_image(
806 &client,
807 &filename,
808 &target,
809 size,
810 chunk_size_opt,
811 verbose,
812 crypt_config.clone(),
813 ).await?;
59e9ba01 814 manifest.add_file(target, stats.size, stats.csum);
e9722f8b 815 }
6af905c1
DM
816 }
817 }
4818c8b6 818
e9722f8b
WB
819 // finalize and upload catalog
820 if upload_catalog {
821 let mutex = Arc::try_unwrap(catalog)
822 .map_err(|_| format_err!("unable to get catalog (still used)"))?;
bf6e3217
DM
823 let mut catalog = mutex.into_inner().unwrap();
824
825 catalog.finish()?;
2761d6a4 826
bf6e3217 827 drop(catalog); // close upload stream
2761d6a4 828
bf6e3217 829 let stats = catalog_result_rx.await??;
9d135fe6 830
bf6e3217 831 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum);
e9722f8b 832 }
2761d6a4 833
e9722f8b
WB
834 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
835 let target = "rsa-encrypted.key";
836 println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
837 let stats = client
838 .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
839 .await?;
59e9ba01 840 manifest.add_file(format!("{}.blob", target), stats.size, stats.csum);
e9722f8b
WB
841
842 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
843 /*
844 let mut buffer2 = vec![0u8; rsa.size() as usize];
845 let pem_data = file_get_contents("master-private.pem")?;
846 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
847 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
848 println!("TEST {} {:?}", len, buffer2);
849 */
850 }
9f46c7de 851
59e9ba01
DM
852 // create manifest (index.json)
853 let manifest = manifest.into_json();
2c3891d1 854
e9722f8b 855 println!("Upload index.json to '{:?}'", repo);
59e9ba01 856 let manifest = serde_json::to_string_pretty(&manifest)?.into();
e9722f8b 857 client
59e9ba01 858 .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
e9722f8b 859 .await?;
2c3891d1 860
e9722f8b 861 client.finish().await?;
c4ff3dce 862
e9722f8b
WB
863 let end_time = Local::now();
864 let elapsed = end_time.signed_duration_since(start_time);
865 println!("Duration: {}", elapsed);
3ec3ec3f 866
e9722f8b 867 println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
3d5c11e5 868
e9722f8b
WB
869 Ok(Value::Null)
870 })
f98ea63d
DM
871}
872
d0a03d40 873fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
f98ea63d
DM
874
875 let mut result = vec![];
876
877 let data: Vec<&str> = arg.splitn(2, ':').collect();
878
bff11030 879 if data.len() != 2 {
8968258b
DM
880 result.push(String::from("root.pxar:/"));
881 result.push(String::from("etc.pxar:/etc"));
bff11030
DM
882 return result;
883 }
f98ea63d 884
496a6784 885 let files = tools::complete_file_name(data[1], param);
f98ea63d
DM
886
887 for file in files {
888 result.push(format!("{}:{}", data[0], file));
889 }
890
891 result
ff5d3707 892}
893
9f912493
DM
894fn restore(
895 param: Value,
896 _info: &ApiMethod,
dd5495d6 897 _rpcenv: &mut dyn RpcEnvironment,
9f912493 898) -> Result<Value, Error> {
e9722f8b
WB
899 async_main(restore_do(param))
900}
9f912493 901
88892ea8
DM
902fn dump_image<W: Write>(
903 client: Arc<BackupReader>,
904 crypt_config: Option<Arc<CryptConfig>>,
905 index: FixedIndexReader,
906 mut writer: W,
fd04ca7a 907 verbose: bool,
88892ea8
DM
908) -> Result<(), Error> {
909
910 let most_used = index.find_most_used_chunks(8);
911
912 let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
913
914 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
915 // and thus slows down reading. Instead, directly use RemoteChunkReader
fd04ca7a
DM
916 let mut per = 0;
917 let mut bytes = 0;
918 let start_time = std::time::Instant::now();
919
88892ea8
DM
920 for pos in 0..index.index_count() {
921 let digest = index.index_digest(pos).unwrap();
922 let raw_data = chunk_reader.read_chunk(&digest)?;
923 writer.write_all(&raw_data)?;
fd04ca7a
DM
924 bytes += raw_data.len();
925 if verbose {
926 let next_per = ((pos+1)*100)/index.index_count();
927 if per != next_per {
928 eprintln!("progress {}% (read {} bytes, duration {} sec)",
929 next_per, bytes, start_time.elapsed().as_secs());
930 per = next_per;
931 }
932 }
88892ea8
DM
933 }
934
fd04ca7a
DM
935 let end_time = std::time::Instant::now();
936 let elapsed = end_time.duration_since(start_time);
937 eprintln!("restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)",
938 bytes,
939 elapsed.as_secs_f64(),
940 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
941 );
942
943
88892ea8
DM
944 Ok(())
945}
946
e9722f8b 947async fn restore_do(param: Value) -> Result<Value, Error> {
2665cef7 948 let repo = extract_repository_from_value(&param)?;
9f912493 949
86eda3eb
DM
950 let verbose = param["verbose"].as_bool().unwrap_or(false);
951
46d5aa0a
DM
952 let allow_existing_dirs = param["allow-existing-dirs"].as_bool().unwrap_or(false);
953
d5c34d98
DM
954 let archive_name = tools::required_string_param(&param, "archive-name")?;
955
cc2ce4a9 956 let client = HttpClient::new(repo.host(), repo.user(), None)?;
d0a03d40 957
d0a03d40 958 record_repository(&repo);
d5c34d98 959
9f912493 960 let path = tools::required_string_param(&param, "snapshot")?;
9f912493 961
86eda3eb 962 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
d5c34d98 963 let group = BackupGroup::parse(path)?;
9f912493 964
9e391bb7
DM
965 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
966 let result = client.get(&path, Some(json!({
d5c34d98
DM
967 "backup-type": group.backup_type(),
968 "backup-id": group.backup_id(),
e9722f8b 969 }))).await?;
9f912493 970
d5c34d98 971 let list = result["data"].as_array().unwrap();
11377a47 972 if list.is_empty() {
d5c34d98
DM
973 bail!("backup group '{}' does not contain any snapshots:", path);
974 }
9f912493 975
86eda3eb 976 let epoch = list[0]["backup-time"].as_i64().unwrap();
fa5d6977 977 let backup_time = Utc.timestamp(epoch, 0);
86eda3eb 978 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
d5c34d98
DM
979 } else {
980 let snapshot = BackupDir::parse(path)?;
86eda3eb
DM
981 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
982 };
9f912493 983
d5c34d98 984 let target = tools::required_string_param(&param, "target")?;
bf125261 985 let target = if target == "-" { None } else { Some(target) };
2ae7d196 986
11377a47 987 let keyfile = param["keyfile"].as_str().map(PathBuf::from);
2ae7d196 988
86eda3eb
DM
989 let crypt_config = match keyfile {
990 None => None,
991 Some(path) => {
a8f10f84 992 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
86eda3eb
DM
993 Some(Arc::new(CryptConfig::new(key)?))
994 }
995 };
d5c34d98 996
afb4cd28
DM
997 let server_archive_name = if archive_name.ends_with(".pxar") {
998 format!("{}.didx", archive_name)
999 } else if archive_name.ends_with(".img") {
1000 format!("{}.fidx", archive_name)
1001 } else {
f8100e96 1002 format!("{}.blob", archive_name)
afb4cd28 1003 };
9f912493 1004
296c50ba
DM
1005 let client = BackupReader::start(
1006 client,
1007 crypt_config.clone(),
1008 repo.store(),
1009 &backup_type,
1010 &backup_id,
1011 backup_time,
1012 true,
1013 ).await?;
86eda3eb 1014
f06b820a 1015 let manifest = client.download_manifest().await?;
02fcf372 1016
ad6e5a6f 1017 if server_archive_name == MANIFEST_BLOB_NAME {
f06b820a 1018 let backup_index_data = manifest.into_json().to_string();
02fcf372 1019 if let Some(target) = target {
296c50ba 1020 file_set_contents(target, backup_index_data.as_bytes(), None)?;
02fcf372
DM
1021 } else {
1022 let stdout = std::io::stdout();
1023 let mut writer = stdout.lock();
296c50ba 1024 writer.write_all(backup_index_data.as_bytes())
02fcf372
DM
1025 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1026 }
1027
1028 } else if server_archive_name.ends_with(".blob") {
d2267b11 1029
bb19af73 1030 let mut reader = client.download_blob(&manifest, &server_archive_name).await?;
f8100e96 1031
bf125261 1032 if let Some(target) = target {
0d986280
DM
1033 let mut writer = std::fs::OpenOptions::new()
1034 .write(true)
1035 .create(true)
1036 .create_new(true)
1037 .open(target)
1038 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?;
1039 std::io::copy(&mut reader, &mut writer)?;
bf125261
DM
1040 } else {
1041 let stdout = std::io::stdout();
1042 let mut writer = stdout.lock();
0d986280 1043 std::io::copy(&mut reader, &mut writer)
bf125261
DM
1044 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1045 }
f8100e96
DM
1046
1047 } else if server_archive_name.ends_with(".didx") {
86eda3eb 1048
c3d84a22 1049 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
df65bd3d 1050
f4bf7dfc
DM
1051 let most_used = index.find_most_used_chunks(8);
1052
1053 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1054
afb4cd28 1055 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
86eda3eb 1056
bf125261 1057 if let Some(target) = target {
86eda3eb 1058
47651f95 1059 let feature_flags = pxar::flags::DEFAULT;
f701d033
DM
1060 let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags);
1061 decoder.set_callback(move |path| {
bf125261 1062 if verbose {
fd04ca7a 1063 eprintln!("{:?}", path);
bf125261
DM
1064 }
1065 Ok(())
1066 });
6a879109
CE
1067 decoder.set_allow_existing_dirs(allow_existing_dirs);
1068
fa7e957c 1069 decoder.restore(Path::new(target), &Vec::new())?;
bf125261 1070 } else {
88892ea8
DM
1071 let mut writer = std::fs::OpenOptions::new()
1072 .write(true)
1073 .open("/dev/stdout")
1074 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?;
afb4cd28 1075
bf125261
DM
1076 std::io::copy(&mut reader, &mut writer)
1077 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1078 }
afb4cd28 1079 } else if server_archive_name.ends_with(".fidx") {
afb4cd28 1080
72050500 1081 let index = client.download_fixed_index(&manifest, &server_archive_name).await?;
df65bd3d 1082
88892ea8
DM
1083 let mut writer = if let Some(target) = target {
1084 std::fs::OpenOptions::new()
bf125261
DM
1085 .write(true)
1086 .create(true)
1087 .create_new(true)
1088 .open(target)
88892ea8 1089 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?
bf125261 1090 } else {
88892ea8
DM
1091 std::fs::OpenOptions::new()
1092 .write(true)
1093 .open("/dev/stdout")
1094 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?
1095 };
afb4cd28 1096
fd04ca7a 1097 dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
88892ea8
DM
1098
1099 } else {
f8100e96 1100 bail!("unknown archive file extension (expected .pxar of .img)");
3031e44c 1101 }
fef44d4f
DM
1102
1103 Ok(Value::Null)
45db6f89
DM
1104}
1105
ec34f7eb
DM
1106fn upload_log(
1107 param: Value,
1108 _info: &ApiMethod,
1109 _rpcenv: &mut dyn RpcEnvironment,
1110) -> Result<Value, Error> {
1111
1112 let logfile = tools::required_string_param(&param, "logfile")?;
1113 let repo = extract_repository_from_value(&param)?;
1114
1115 let snapshot = tools::required_string_param(&param, "snapshot")?;
1116 let snapshot = BackupDir::parse(snapshot)?;
1117
cc2ce4a9 1118 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
ec34f7eb 1119
11377a47 1120 let keyfile = param["keyfile"].as_str().map(PathBuf::from);
ec34f7eb
DM
1121
1122 let crypt_config = match keyfile {
1123 None => None,
1124 Some(path) => {
a8f10f84 1125 let (key, _created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
ec34f7eb 1126 let crypt_config = CryptConfig::new(key)?;
9025312a 1127 Some(Arc::new(crypt_config))
ec34f7eb
DM
1128 }
1129 };
1130
e18a6c9e 1131 let data = file_get_contents(logfile)?;
ec34f7eb 1132
7123ff7d 1133 let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
ec34f7eb
DM
1134
1135 let raw_data = blob.into_inner();
1136
1137 let path = format!("api2/json/admin/datastore/{}/upload-backup-log", repo.store());
1138
1139 let args = json!({
1140 "backup-type": snapshot.group().backup_type(),
1141 "backup-id": snapshot.group().backup_id(),
1142 "backup-time": snapshot.backup_time().timestamp(),
1143 });
1144
1145 let body = hyper::Body::from(raw_data);
1146
e9722f8b
WB
1147 async_main(async move {
1148 client.upload("application/octet-stream", body, &path, Some(args)).await
1149 })
ec34f7eb
DM
1150}
1151
83b7db02 1152fn prune(
ea7a7ef2 1153 mut param: Value,
83b7db02 1154 _info: &ApiMethod,
dd5495d6 1155 _rpcenv: &mut dyn RpcEnvironment,
83b7db02
DM
1156) -> Result<Value, Error> {
1157
2665cef7 1158 let repo = extract_repository_from_value(&param)?;
83b7db02 1159
cc2ce4a9 1160 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
83b7db02 1161
d0a03d40 1162 let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
83b7db02 1163
9fdc3ef4
DM
1164 let group = tools::required_string_param(&param, "group")?;
1165 let group = BackupGroup::parse(group)?;
163e9bbe 1166 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
9fdc3ef4 1167
ea7a7ef2
DM
1168 param.as_object_mut().unwrap().remove("repository");
1169 param.as_object_mut().unwrap().remove("group");
163e9bbe 1170 param.as_object_mut().unwrap().remove("output-format");
ea7a7ef2
DM
1171
1172 param["backup-type"] = group.backup_type().into();
1173 param["backup-id"] = group.backup_id().into();
83b7db02 1174
5a0b484b
DM
1175 async_main(async {
1176 let result = client.post(&path, Some(param)).await?;
74fa81b8 1177
5a0b484b 1178 record_repository(&repo);
3b03abfe 1179
d105176f
DM
1180 view_task_result(client, result, &output_format).await
1181 })?;
d0a03d40 1182
43a406fd 1183 Ok(Value::Null)
83b7db02
DM
1184}
1185
34a816cc
DM
1186fn status(
1187 param: Value,
1188 _info: &ApiMethod,
1189 _rpcenv: &mut dyn RpcEnvironment,
1190) -> Result<Value, Error> {
1191
1192 let repo = extract_repository_from_value(&param)?;
1193
1194 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
1195
cc2ce4a9 1196 let client = HttpClient::new(repo.host(), repo.user(), None)?;
34a816cc
DM
1197
1198 let path = format!("api2/json/admin/datastore/{}/status", repo.store());
1199
e9722f8b 1200 let result = async_main(async move { client.get(&path, None).await })?;
34a816cc
DM
1201 let data = &result["data"];
1202
1203 record_repository(&repo);
1204
1205 if output_format == "text" {
1206 let total = data["total"].as_u64().unwrap();
1207 let used = data["used"].as_u64().unwrap();
1208 let avail = data["avail"].as_u64().unwrap();
1209 let roundup = total/200;
1210
1211 println!(
1212 "total: {} used: {} ({} %) available: {}",
1213 total,
1214 used,
1215 ((used+roundup)*100)/total,
1216 avail,
1217 );
1218 } else {
f6ede796 1219 format_and_print_result(data, &output_format);
34a816cc
DM
1220 }
1221
1222 Ok(Value::Null)
1223}
1224
5a2df000 1225// like get, but simply ignore errors and return Null instead
e9722f8b 1226async fn try_get(repo: &BackupRepository, url: &str) -> Value {
024f11bb 1227
cc2ce4a9 1228 let client = match HttpClient::new(repo.host(), repo.user(), None) {
45cdce06
DM
1229 Ok(v) => v,
1230 _ => return Value::Null,
1231 };
b2388518 1232
e9722f8b 1233 let mut resp = match client.get(url, None).await {
b2388518
DM
1234 Ok(v) => v,
1235 _ => return Value::Null,
1236 };
1237
1238 if let Some(map) = resp.as_object_mut() {
1239 if let Some(data) = map.remove("data") {
1240 return data;
1241 }
1242 }
1243 Value::Null
1244}
1245
b2388518 1246fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
e9722f8b
WB
1247 async_main(async { complete_backup_group_do(param).await })
1248}
1249
1250async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
024f11bb 1251
b2388518
DM
1252 let mut result = vec![];
1253
2665cef7 1254 let repo = match extract_repository_from_map(param) {
b2388518 1255 Some(v) => v,
024f11bb
DM
1256 _ => return result,
1257 };
1258
b2388518
DM
1259 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
1260
e9722f8b 1261 let data = try_get(&repo, &path).await;
b2388518
DM
1262
1263 if let Some(list) = data.as_array() {
024f11bb 1264 for item in list {
98f0b972
DM
1265 if let (Some(backup_id), Some(backup_type)) =
1266 (item["backup-id"].as_str(), item["backup-type"].as_str())
1267 {
1268 result.push(format!("{}/{}", backup_type, backup_id));
024f11bb
DM
1269 }
1270 }
1271 }
1272
1273 result
1274}
1275
b2388518 1276fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
e9722f8b
WB
1277 async_main(async { complete_group_or_snapshot_do(arg, param).await })
1278}
1279
1280async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
b2388518 1281
b2388518 1282 if arg.matches('/').count() < 2 {
e9722f8b 1283 let groups = complete_backup_group_do(param).await;
543a260f 1284 let mut result = vec![];
b2388518
DM
1285 for group in groups {
1286 result.push(group.to_string());
1287 result.push(format!("{}/", group));
1288 }
1289 return result;
1290 }
1291
e9722f8b 1292 complete_backup_snapshot_do(param).await
543a260f 1293}
b2388518 1294
3fb53e07 1295fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
e9722f8b
WB
1296 async_main(async { complete_backup_snapshot_do(param).await })
1297}
1298
1299async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
543a260f
DM
1300
1301 let mut result = vec![];
1302
1303 let repo = match extract_repository_from_map(param) {
1304 Some(v) => v,
1305 _ => return result,
1306 };
1307
1308 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
b2388518 1309
e9722f8b 1310 let data = try_get(&repo, &path).await;
b2388518
DM
1311
1312 if let Some(list) = data.as_array() {
1313 for item in list {
1314 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1315 (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64())
1316 {
1317 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1318 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1319 }
1320 }
1321 }
1322
1323 result
1324}
1325
45db6f89 1326fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
e9722f8b
WB
1327 async_main(async { complete_server_file_name_do(param).await })
1328}
1329
1330async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
08dc340a
DM
1331
1332 let mut result = vec![];
1333
2665cef7 1334 let repo = match extract_repository_from_map(param) {
08dc340a
DM
1335 Some(v) => v,
1336 _ => return result,
1337 };
1338
1339 let snapshot = match param.get("snapshot") {
1340 Some(path) => {
1341 match BackupDir::parse(path) {
1342 Ok(v) => v,
1343 _ => return result,
1344 }
1345 }
1346 _ => return result,
1347 };
1348
1349 let query = tools::json_object_to_query(json!({
1350 "backup-type": snapshot.group().backup_type(),
1351 "backup-id": snapshot.group().backup_id(),
1352 "backup-time": snapshot.backup_time().timestamp(),
1353 })).unwrap();
1354
1355 let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query);
1356
e9722f8b 1357 let data = try_get(&repo, &path).await;
08dc340a
DM
1358
1359 if let Some(list) = data.as_array() {
1360 for item in list {
c4f025eb 1361 if let Some(filename) = item["filename"].as_str() {
08dc340a
DM
1362 result.push(filename.to_owned());
1363 }
1364 }
1365 }
1366
45db6f89
DM
1367 result
1368}
1369
1370fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
52c171e4 1371 complete_server_file_name(arg, param)
e9722f8b
WB
1372 .iter()
1373 .map(|v| strip_server_file_expenstion(&v))
1374 .collect()
08dc340a
DM
1375}
1376
0ec9e1b0
DM
1377fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1378 complete_server_file_name(arg, param)
1379 .iter()
1380 .filter_map(|v| {
1381 let name = strip_server_file_expenstion(&v);
1382 if name.ends_with(".pxar") {
1383 Some(name)
1384 } else {
1385 None
1386 }
1387 })
1388 .collect()
1389}
1390
49811347
DM
1391fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1392
1393 let mut result = vec![];
1394
1395 let mut size = 64;
1396 loop {
1397 result.push(size.to_string());
11377a47 1398 size *= 2;
49811347
DM
1399 if size > 4096 { break; }
1400 }
1401
1402 result
1403}
1404
826f309b 1405fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
ff5d3707 1406
f2401311
DM
1407 // fixme: implement other input methods
1408
1409 use std::env::VarError::*;
1410 match std::env::var("PBS_ENCRYPTION_PASSWORD") {
826f309b 1411 Ok(p) => return Ok(p.as_bytes().to_vec()),
f2401311
DM
1412 Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters"),
1413 Err(NotPresent) => {
1414 // Try another method
1415 }
1416 }
1417
1418 // If we're on a TTY, query the user for a password
1419 if crate::tools::tty::stdin_isatty() {
826f309b 1420 return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?);
f2401311
DM
1421 }
1422
1423 bail!("no password input mechanism available");
1424}
1425
ac716234
DM
1426fn key_create(
1427 param: Value,
1428 _info: &ApiMethod,
1429 _rpcenv: &mut dyn RpcEnvironment,
1430) -> Result<Value, Error> {
1431
9b06db45
DM
1432 let path = tools::required_string_param(&param, "path")?;
1433 let path = PathBuf::from(path);
ac716234 1434
181f097a 1435 let kdf = param["kdf"].as_str().unwrap_or("scrypt");
ac716234
DM
1436
1437 let key = proxmox::sys::linux::random_data(32)?;
1438
181f097a
DM
1439 if kdf == "scrypt" {
1440 // always read passphrase from tty
1441 if !crate::tools::tty::stdin_isatty() {
1442 bail!("unable to read passphrase - no tty");
1443 }
ac716234 1444
181f097a
DM
1445 let password = crate::tools::tty::read_password("Encryption Key Password: ")?;
1446
ab44acff 1447 let key_config = encrypt_key_with_passphrase(&key, &password)?;
37c5a175 1448
ab44acff 1449 store_key_config(&path, false, key_config)?;
181f097a
DM
1450
1451 Ok(Value::Null)
1452 } else if kdf == "none" {
1453 let created = Local.timestamp(Local::now().timestamp(), 0);
1454
1455 store_key_config(&path, false, KeyConfig {
1456 kdf: None,
1457 created,
ab44acff 1458 modified: created,
181f097a
DM
1459 data: key,
1460 })?;
1461
1462 Ok(Value::Null)
1463 } else {
1464 unreachable!();
1465 }
ac716234
DM
1466}
1467
9f46c7de
DM
1468fn master_pubkey_path() -> Result<PathBuf, Error> {
1469 let base = BaseDirectories::with_prefix("proxmox-backup")?;
1470
1471 // usually $HOME/.config/proxmox-backup/master-public.pem
1472 let path = base.place_config_file("master-public.pem")?;
1473
1474 Ok(path)
1475}
1476
3ea8bfc9
DM
1477fn key_import_master_pubkey(
1478 param: Value,
1479 _info: &ApiMethod,
1480 _rpcenv: &mut dyn RpcEnvironment,
1481) -> Result<Value, Error> {
1482
1483 let path = tools::required_string_param(&param, "path")?;
1484 let path = PathBuf::from(path);
1485
e18a6c9e 1486 let pem_data = file_get_contents(&path)?;
3ea8bfc9
DM
1487
1488 if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1489 bail!("Unable to decode PEM data - {}", err);
1490 }
1491
9f46c7de 1492 let target_path = master_pubkey_path()?;
3ea8bfc9 1493
e18a6c9e 1494 file_set_contents(&target_path, &pem_data, None)?;
3ea8bfc9
DM
1495
1496 println!("Imported public master key to {:?}", target_path);
1497
1498 Ok(Value::Null)
1499}
1500
37c5a175
DM
1501fn key_create_master_key(
1502 _param: Value,
1503 _info: &ApiMethod,
1504 _rpcenv: &mut dyn RpcEnvironment,
1505) -> Result<Value, Error> {
1506
1507 // we need a TTY to query the new password
1508 if !crate::tools::tty::stdin_isatty() {
1509 bail!("unable to create master key - no tty");
1510 }
1511
1512 let rsa = openssl::rsa::Rsa::generate(4096)?;
1513 let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1514
1515 let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?;
1516 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
1517
1518 if new_pw != verify_pw {
1519 bail!("Password verification fail!");
1520 }
1521
1522 if new_pw.len() < 5 {
1523 bail!("Password is too short!");
1524 }
1525
1526 let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1527 let filename_pub = "master-public.pem";
1528 println!("Writing public master key to {}", filename_pub);
e18a6c9e 1529 file_set_contents(filename_pub, pub_key.as_slice(), None)?;
37c5a175
DM
1530
1531 let cipher = openssl::symm::Cipher::aes_256_cbc();
1532 let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
1533
1534 let filename_priv = "master-private.pem";
1535 println!("Writing private master key to {}", filename_priv);
e18a6c9e 1536 file_set_contents(filename_priv, priv_key.as_slice(), None)?;
37c5a175
DM
1537
1538 Ok(Value::Null)
1539}
ac716234
DM
1540
1541fn key_change_passphrase(
1542 param: Value,
1543 _info: &ApiMethod,
1544 _rpcenv: &mut dyn RpcEnvironment,
1545) -> Result<Value, Error> {
1546
9b06db45
DM
1547 let path = tools::required_string_param(&param, "path")?;
1548 let path = PathBuf::from(path);
ac716234 1549
181f097a
DM
1550 let kdf = param["kdf"].as_str().unwrap_or("scrypt");
1551
ac716234
DM
1552 // we need a TTY to query the new password
1553 if !crate::tools::tty::stdin_isatty() {
1554 bail!("unable to change passphrase - no tty");
1555 }
1556
a8f10f84 1557 let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
ac716234 1558
181f097a 1559 if kdf == "scrypt" {
ac716234 1560
181f097a
DM
1561 let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?;
1562 let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
ac716234 1563
181f097a
DM
1564 if new_pw != verify_pw {
1565 bail!("Password verification fail!");
1566 }
1567
1568 if new_pw.len() < 5 {
1569 bail!("Password is too short!");
1570 }
ac716234 1571
ab44acff
DM
1572 let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
1573 new_key_config.created = created; // keep original value
1574
1575 store_key_config(&path, true, new_key_config)?;
ac716234 1576
181f097a
DM
1577 Ok(Value::Null)
1578 } else if kdf == "none" {
ab44acff 1579 let modified = Local.timestamp(Local::now().timestamp(), 0);
181f097a
DM
1580
1581 store_key_config(&path, true, KeyConfig {
1582 kdf: None,
ab44acff
DM
1583 created, // keep original value
1584 modified,
6d0983db 1585 data: key.to_vec(),
181f097a
DM
1586 })?;
1587
1588 Ok(Value::Null)
1589 } else {
1590 unreachable!();
1591 }
f2401311
DM
1592}
1593
1594fn key_mgmt_cli() -> CliCommandMap {
1595
255f378a 1596 const KDF_SCHEMA: Schema =
181f097a 1597 StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.")
255f378a
DM
1598 .format(&ApiStringFormat::Enum(&["scrypt", "none"]))
1599 .default("scrypt")
1600 .schema();
1601
552c2259 1602 #[sortable]
255f378a
DM
1603 const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new(
1604 &ApiHandler::Sync(&key_create),
1605 &ObjectSchema::new(
1606 "Create a new encryption key.",
552c2259 1607 &sorted!([
255f378a
DM
1608 ("path", false, &StringSchema::new("File system path.").schema()),
1609 ("kdf", true, &KDF_SCHEMA),
552c2259 1610 ]),
255f378a 1611 )
181f097a 1612 );
7074a0b3 1613
255f378a 1614 let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE)
49fddd98 1615 .arg_param(&["path"])
9b06db45 1616 .completion_cb("path", tools::complete_file_name);
f2401311 1617
552c2259 1618 #[sortable]
255f378a
DM
1619 const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new(
1620 &ApiHandler::Sync(&key_change_passphrase),
1621 &ObjectSchema::new(
1622 "Change the passphrase required to decrypt the key.",
552c2259 1623 &sorted!([
255f378a
DM
1624 ("path", false, &StringSchema::new("File system path.").schema()),
1625 ("kdf", true, &KDF_SCHEMA),
552c2259 1626 ]),
255f378a
DM
1627 )
1628 );
7074a0b3 1629
255f378a 1630 let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE)
49fddd98 1631 .arg_param(&["path"])
9b06db45 1632 .completion_cb("path", tools::complete_file_name);
ac716234 1633
255f378a
DM
1634 const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new(
1635 &ApiHandler::Sync(&key_create_master_key),
1636 &ObjectSchema::new("Create a new 4096 bit RSA master pub/priv key pair.", &[])
1637 );
7074a0b3 1638
255f378a
DM
1639 let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY);
1640
552c2259 1641 #[sortable]
255f378a
DM
1642 const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new(
1643 &ApiHandler::Sync(&key_import_master_pubkey),
1644 &ObjectSchema::new(
1645 "Import a new RSA public key and use it as master key. The key is expected to be in '.pem' format.",
552c2259 1646 &sorted!([ ("path", false, &StringSchema::new("File system path.").schema()) ]),
255f378a
DM
1647 )
1648 );
7074a0b3 1649
255f378a 1650 let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY)
49fddd98 1651 .arg_param(&["path"])
3ea8bfc9
DM
1652 .completion_cb("path", tools::complete_file_name);
1653
11377a47 1654 CliCommandMap::new()
48ef3c33
DM
1655 .insert("create", key_create_cmd_def)
1656 .insert("create-master-key", key_create_master_key_cmd_def)
1657 .insert("import-master-pubkey", key_import_master_pubkey_cmd_def)
1658 .insert("change-passphrase", key_change_passphrase_cmd_def)
f2401311
DM
1659}
1660
70235f72
CE
1661fn mount(
1662 param: Value,
1663 _info: &ApiMethod,
1664 _rpcenv: &mut dyn RpcEnvironment,
1665) -> Result<Value, Error> {
1666 let verbose = param["verbose"].as_bool().unwrap_or(false);
1667 if verbose {
1668 // This will stay in foreground with debug output enabled as None is
1669 // passed for the RawFd.
1670 return async_main(mount_do(param, None));
1671 }
1672
1673 // Process should be deamonized.
1674 // Make sure to fork before the async runtime is instantiated to avoid troubles.
1675 let pipe = pipe()?;
1676 match fork() {
11377a47 1677 Ok(ForkResult::Parent { .. }) => {
70235f72
CE
1678 nix::unistd::close(pipe.1).unwrap();
1679 // Blocks the parent process until we are ready to go in the child
1680 let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
1681 Ok(Value::Null)
1682 }
1683 Ok(ForkResult::Child) => {
1684 nix::unistd::close(pipe.0).unwrap();
1685 nix::unistd::setsid().unwrap();
1686 async_main(mount_do(param, Some(pipe.1)))
1687 }
1688 Err(_) => bail!("failed to daemonize process"),
1689 }
1690}
1691
1692async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
1693 let repo = extract_repository_from_value(&param)?;
1694 let archive_name = tools::required_string_param(&param, "archive-name")?;
1695 let target = tools::required_string_param(&param, "target")?;
1696 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1697
1698 record_repository(&repo);
1699
1700 let path = tools::required_string_param(&param, "snapshot")?;
1701 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1702 let group = BackupGroup::parse(path)?;
1703
1704 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
1705 let result = client.get(&path, Some(json!({
1706 "backup-type": group.backup_type(),
1707 "backup-id": group.backup_id(),
1708 }))).await?;
1709
1710 let list = result["data"].as_array().unwrap();
11377a47 1711 if list.is_empty() {
70235f72
CE
1712 bail!("backup group '{}' does not contain any snapshots:", path);
1713 }
1714
1715 let epoch = list[0]["backup-time"].as_i64().unwrap();
1716 let backup_time = Utc.timestamp(epoch, 0);
1717 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
1718 } else {
1719 let snapshot = BackupDir::parse(path)?;
1720 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1721 };
1722
11377a47 1723 let keyfile = param["keyfile"].as_str().map(PathBuf::from);
70235f72
CE
1724 let crypt_config = match keyfile {
1725 None => None,
1726 Some(path) => {
a8f10f84 1727 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
70235f72
CE
1728 Some(Arc::new(CryptConfig::new(key)?))
1729 }
1730 };
1731
1732 let server_archive_name = if archive_name.ends_with(".pxar") {
1733 format!("{}.didx", archive_name)
1734 } else {
1735 bail!("Can only mount pxar archives.");
1736 };
1737
296c50ba
DM
1738 let client = BackupReader::start(
1739 client,
1740 crypt_config.clone(),
1741 repo.store(),
1742 &backup_type,
1743 &backup_id,
1744 backup_time,
1745 true,
1746 ).await?;
70235f72 1747
f06b820a 1748 let manifest = client.download_manifest().await?;
296c50ba 1749
70235f72 1750 if server_archive_name.ends_with(".didx") {
c3d84a22 1751 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
70235f72
CE
1752 let most_used = index.find_most_used_chunks(8);
1753 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1754 let reader = BufferedDynamicReader::new(index, chunk_reader);
f701d033 1755 let decoder = pxar::Decoder::new(reader)?;
70235f72 1756 let options = OsStr::new("ro,default_permissions");
2a111910 1757 let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none())
70235f72
CE
1758 .map_err(|err| format_err!("pxar mount failed: {}", err))?;
1759
1760 // Mount the session but not call fuse deamonize as this will cause
1761 // issues with the runtime after the fork
1762 let deamonize = false;
1763 session.mount(&Path::new(target), deamonize)?;
1764
1765 if let Some(pipe) = pipe {
1766 nix::unistd::chdir(Path::new("/")).unwrap();
1767 // Finish creation of deamon by redirecting filedescriptors.
1768 let nullfd = nix::fcntl::open(
1769 "/dev/null",
1770 nix::fcntl::OFlag::O_RDWR,
1771 nix::sys::stat::Mode::empty(),
1772 ).unwrap();
1773 nix::unistd::dup2(nullfd, 0).unwrap();
1774 nix::unistd::dup2(nullfd, 1).unwrap();
1775 nix::unistd::dup2(nullfd, 2).unwrap();
1776 if nullfd > 2 {
1777 nix::unistd::close(nullfd).unwrap();
1778 }
1779 // Signal the parent process that we are done with the setup and it can
1780 // terminate.
11377a47 1781 nix::unistd::write(pipe, &[0u8])?;
70235f72
CE
1782 nix::unistd::close(pipe).unwrap();
1783 }
1784
1785 let multithreaded = true;
1786 session.run_loop(multithreaded)?;
1787 } else {
1788 bail!("unknown archive file extension (expected .pxar)");
1789 }
1790
1791 Ok(Value::Null)
1792}
1793
1c6ad6ef 1794fn catalog_shell(
3cf73c4e
CE
1795 param: Value,
1796 _info: &ApiMethod,
1797 _rpcenv: &mut dyn RpcEnvironment,
1798) -> Result<Value, Error> {
1c6ad6ef 1799 async_main(catalog_shell_async(param))
3cf73c4e
CE
1800}
1801
1c6ad6ef 1802async fn catalog_shell_async(param: Value) -> Result<Value, Error> {
3cf73c4e
CE
1803 let repo = extract_repository_from_value(&param)?;
1804 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1805 let path = tools::required_string_param(&param, "snapshot")?;
1806 let archive_name = tools::required_string_param(&param, "archive-name")?;
1807
1808 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
1809 let group = BackupGroup::parse(path)?;
1810
1811 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
1812 let result = client.get(&path, Some(json!({
1813 "backup-type": group.backup_type(),
1814 "backup-id": group.backup_id(),
1815 }))).await?;
1816
1817 let list = result["data"].as_array().unwrap();
314bb358 1818 if list.is_empty() {
3cf73c4e
CE
1819 bail!("backup group '{}' does not contain any snapshots:", path);
1820 }
1821
1822 let epoch = list[0]["backup-time"].as_i64().unwrap();
1823 let backup_time = Utc.timestamp(epoch, 0);
1824 (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
1825 } else {
1826 let snapshot = BackupDir::parse(path)?;
1827 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1828 };
1829
1830 let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
1831 let crypt_config = match keyfile {
1832 None => None,
1833 Some(path) => {
1834 let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
1835 Some(Arc::new(CryptConfig::new(key)?))
1836 }
1837 };
1838
1839 let server_archive_name = if archive_name.ends_with(".pxar") {
1840 format!("{}.didx", archive_name)
1841 } else {
1842 bail!("Can only mount pxar archives.");
1843 };
1844
1845 let client = BackupReader::start(
1846 client,
1847 crypt_config.clone(),
1848 repo.store(),
1849 &backup_type,
1850 &backup_id,
1851 backup_time,
1852 true,
1853 ).await?;
1854
1855 let tmpfile = std::fs::OpenOptions::new()
1856 .write(true)
1857 .read(true)
1858 .custom_flags(libc::O_TMPFILE)
1859 .open("/tmp")?;
1860
1861 let manifest = client.download_manifest().await?;
1862
1863 let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
1864 let most_used = index.find_most_used_chunks(8);
1865 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
1866 let reader = BufferedDynamicReader::new(index, chunk_reader);
f701d033
DM
1867 let mut decoder = pxar::Decoder::new(reader)?;
1868 decoder.set_callback(|path| {
1869 println!("{:?}", path);
1870 Ok(())
1871 });
3cf73c4e
CE
1872
1873 let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
1874 let index = DynamicIndexReader::new(tmpfile)
1875 .map_err(|err| format_err!("unable to read catalog index - {}", err))?;
1876
1877 // Note: do not use values stored in index (not trusted) - instead, computed them again
1878 let (csum, size) = index.compute_csum();
1879 manifest.verify_file(CATALOG_NAME, &csum, size)?;
1880
1881 let most_used = index.find_most_used_chunks(8);
1882 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
1883 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1884 let mut catalogfile = std::fs::OpenOptions::new()
1885 .write(true)
1886 .read(true)
1887 .custom_flags(libc::O_TMPFILE)
1888 .open("/tmp")?;
1889
1890 std::io::copy(&mut reader, &mut catalogfile)
1891 .map_err(|err| format_err!("unable to download catalog - {}", err))?;
1892
1893 catalogfile.seek(SeekFrom::Start(0))?;
1894 let catalog_reader = CatalogReader::new(catalogfile);
1895 let state = Shell::new(
1896 catalog_reader,
1897 &server_archive_name,
1898 decoder,
1899 )?;
1900
1901 println!("Starting interactive shell");
1902 state.shell()?;
1903
1904 record_repository(&repo);
1905
1906 Ok(Value::Null)
1907}
1908
1c6ad6ef
DM
1909fn catalog_mgmt_cli() -> CliCommandMap {
1910
1911 #[sortable]
1912 const API_METHOD_SHELL: ApiMethod = ApiMethod::new(
1913 &ApiHandler::Sync(&catalog_shell),
1914 &ObjectSchema::new(
1915 "Shell to interactively inspect and restore snapshots.",
1916 &sorted!([
1917 ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()),
1918 ("archive-name", false, &StringSchema::new("Backup archive name.").schema()),
1919 ("repository", true, &REPO_URL_SCHEMA),
1920 ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()),
1921 ]),
1922 )
1923 );
1924
1925 let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_SHELL)
1926 .arg_param(&["snapshot", "archive-name"])
1927 .completion_cb("repository", complete_repository)
0ec9e1b0 1928 .completion_cb("archive-name", complete_pxar_archive_name)
1c6ad6ef
DM
1929 .completion_cb("snapshot", complete_group_or_snapshot);
1930
1931 #[sortable]
1932 const API_METHOD_DUMP_CATALOG: ApiMethod = ApiMethod::new(
1933 &ApiHandler::Sync(&dump_catalog),
1934 &ObjectSchema::new(
1935 "Dump catalog.",
1936 &sorted!([
1937 ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
1938 ("repository", true, &REPO_URL_SCHEMA),
1939 ]),
1940 )
1941 );
1942
1943 let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
1944 .arg_param(&["snapshot"])
1945 .completion_cb("repository", complete_repository)
1946 .completion_cb("snapshot", complete_backup_snapshot);
1947
1948 CliCommandMap::new()
48ef3c33
DM
1949 .insert("dump", catalog_dump_cmd_def)
1950 .insert("shell", catalog_shell_cmd_def)
1c6ad6ef
DM
1951}
1952
5830c205
DM
1953#[api(
1954 input: {
1955 properties: {
1956 repository: {
1957 schema: REPO_URL_SCHEMA,
1958 optional: true,
1959 },
1960 limit: {
1961 description: "The maximal number of tasks to list.",
1962 type: Integer,
1963 optional: true,
1964 minimum: 1,
1965 maximum: 1000,
1966 default: 50,
1967 },
1968 "output-format": {
1969 schema: OUTPUT_FORMAT,
1970 optional: true,
1971 },
1972 }
1973 }
1974)]
1975/// List running server tasks for this repo user
1976fn task_list(param: Value) -> Result<Value, Error> {
1977
1978 async_main(async {
1979 let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
1980 let repo = extract_repository_from_value(&param)?;
1981 let client = HttpClient::new(repo.host(), repo.user(), None)?;
1982
1983 let limit = param["limit"].as_u64().unwrap_or(50) as usize;
1984
567d3e00
DM
1985 let args = json!({
1986 "running": true,
1987 "start": 0,
1988 "limit": limit,
1989 "userfilter": repo.user(),
1990 "store": repo.store(),
1991 });
5830c205
DM
1992 let result = client.get("api2/json/nodes/localhost/tasks", Some(args)).await?;
1993
1994 let data = &result["data"];
1995
1996 if output_format == "text" {
1997 for item in data.as_array().unwrap() {
1998 println!(
1999 "{} {}",
2000 item["upid"].as_str().unwrap(),
2001 item["status"].as_str().unwrap_or("running"),
2002 );
2003 }
2004 } else {
2005 format_and_print_result(data, &output_format);
2006 }
2007
2008 Ok::<_, Error>(())
2009 })?;
2010
2011 Ok(Value::Null)
2012}
2013
2014#[api(
2015 input: {
2016 properties: {
2017 repository: {
2018 schema: REPO_URL_SCHEMA,
2019 optional: true,
2020 },
2021 upid: {
2022 schema: UPID_SCHEMA,
2023 },
2024 }
2025 }
2026)]
2027/// Display the task log.
2028fn task_log(param: Value) -> Result<Value, Error> {
2029
2030 async_main(async {
2031 let repo = extract_repository_from_value(&param)?;
2032 let upid = tools::required_string_param(&param, "upid")?;
2033
2034 let client = HttpClient::new(repo.host(), repo.user(), None)?;
2035
2036 display_task_log(client, upid, true).await?;
2037
2038 Ok::<_, Error>(())
2039 })?;
2040
2041 Ok(Value::Null)
2042}
2043
3f1020b7
DM
2044#[api(
2045 input: {
2046 properties: {
2047 repository: {
2048 schema: REPO_URL_SCHEMA,
2049 optional: true,
2050 },
2051 upid: {
2052 schema: UPID_SCHEMA,
2053 },
2054 }
2055 }
2056)]
2057/// Try to stop a specific task.
2058fn task_stop(param: Value) -> Result<Value, Error> {
2059
2060 async_main(async {
2061 let repo = extract_repository_from_value(&param)?;
2062 let upid_str = tools::required_string_param(&param, "upid")?;
2063
2064 let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
2065
2066 let path = format!("api2/json/nodes/localhost/tasks/{}", upid_str);
2067 let _ = client.delete(&path, None).await?;
2068
2069 Ok::<_, Error>(())
2070 })?;
2071
2072 Ok(Value::Null)
2073}
2074
5830c205
DM
2075fn task_mgmt_cli() -> CliCommandMap {
2076
2077 let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
2078 .completion_cb("repository", complete_repository);
2079
2080 let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
2081 .arg_param(&["upid"]);
2082
3f1020b7
DM
2083 let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
2084 .arg_param(&["upid"]);
2085
5830c205
DM
2086 CliCommandMap::new()
2087 .insert("log", task_log_cmd_def)
2088 .insert("list", task_list_cmd_def)
3f1020b7 2089 .insert("stop", task_stop_cmd_def)
5830c205 2090}
1c6ad6ef 2091
f2401311 2092fn main() {
33d64b81 2093
255f378a
DM
2094 const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new("Backup source specification ([<label>:<path>]).")
2095 .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
2096 .schema();
25f1650b 2097
552c2259 2098 #[sortable]
255f378a
DM
2099 const API_METHOD_CREATE_BACKUP: ApiMethod = ApiMethod::new(
2100 &ApiHandler::Sync(&create_backup),
2101 &ObjectSchema::new(
2102 "Create (host) backup.",
552c2259 2103 &sorted!([
255f378a 2104 (
ae0be2dd 2105 "backupspec",
255f378a
DM
2106 false,
2107 &ArraySchema::new(
74cdb521 2108 "List of backup source specifications ([<label.ext>:<path>] ...)",
255f378a
DM
2109 &BACKUP_SOURCE_SCHEMA,
2110 ).min_length(1).schema()
2111 ),
2112 (
2113 "repository",
2114 true,
2115 &REPO_URL_SCHEMA
2116 ),
2117 (
2eeaacb9 2118 "include-dev",
255f378a
DM
2119 true,
2120 &ArraySchema::new(
2eeaacb9 2121 "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
255f378a
DM
2122 &StringSchema::new("Path to file.").schema()
2123 ).schema()
2124 ),
2125 (
6d0983db 2126 "keyfile",
255f378a
DM
2127 true,
2128 &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema()
2129 ),
2130 (
219ef0e6 2131 "verbose",
255f378a
DM
2132 true,
2133 &BooleanSchema::new("Verbose output.")
2134 .default(false)
2135 .schema()
2136 ),
2137 (
5b72c9b4 2138 "skip-lost-and-found",
255f378a
DM
2139 true,
2140 &BooleanSchema::new("Skip lost+found directory")
2141 .default(false)
2142 .schema()
2143 ),
2144 (
bbf9e7e9 2145 "backup-type",
255f378a
DM
2146 true,
2147 &BACKUP_TYPE_SCHEMA,
2148 ),
2149 (
bbf9e7e9 2150 "backup-id",
255f378a
DM
2151 true,
2152 &BACKUP_ID_SCHEMA
2153 ),
2154 (
ca5d0b61 2155 "backup-time",
255f378a
DM
2156 true,
2157 &BACKUP_TIME_SCHEMA
2158 ),
2159 (
2d9d143a 2160 "chunk-size",
255f378a
DM
2161 true,
2162 &IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
2d9d143a
DM
2163 .minimum(64)
2164 .maximum(4096)
2165 .default(4096)
255f378a
DM
2166 .schema()
2167 ),
552c2259 2168 ]),
255f378a
DM
2169 )
2170 );
7074a0b3 2171
255f378a 2172 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
49fddd98 2173 .arg_param(&["backupspec"])
d0a03d40 2174 .completion_cb("repository", complete_repository)
49811347 2175 .completion_cb("backupspec", complete_backup_source)
6d0983db 2176 .completion_cb("keyfile", tools::complete_file_name)
49811347 2177 .completion_cb("chunk-size", complete_chunk_size);
f8838fe9 2178
552c2259 2179 #[sortable]
255f378a
DM
2180 const API_METHOD_UPLOAD_LOG: ApiMethod = ApiMethod::new(
2181 &ApiHandler::Sync(&upload_log),
2182 &ObjectSchema::new(
2183 "Upload backup log file.",
552c2259 2184 &sorted!([
255f378a
DM
2185 (
2186 "snapshot",
2187 false,
2188 &StringSchema::new("Snapshot path.").schema()
2189 ),
2190 (
2191 "logfile",
2192 false,
2193 &StringSchema::new("The path to the log file you want to upload.").schema()
2194 ),
2195 (
2196 "repository",
2197 true,
2198 &REPO_URL_SCHEMA
2199 ),
2200 (
ec34f7eb 2201 "keyfile",
255f378a
DM
2202 true,
2203 &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema()
2204 ),
552c2259 2205 ]),
255f378a
DM
2206 )
2207 );
7074a0b3 2208
255f378a 2209 let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
49fddd98 2210 .arg_param(&["snapshot", "logfile"])
543a260f 2211 .completion_cb("snapshot", complete_backup_snapshot)
ec34f7eb
DM
2212 .completion_cb("logfile", tools::complete_file_name)
2213 .completion_cb("keyfile", tools::complete_file_name)
2214 .completion_cb("repository", complete_repository);
2215
552c2259 2216 #[sortable]
255f378a
DM
2217 const API_METHOD_LIST_BACKUP_GROUPS: ApiMethod = ApiMethod::new(
2218 &ApiHandler::Sync(&list_backup_groups),
2219 &ObjectSchema::new(
2220 "List backup groups.",
552c2259 2221 &sorted!([
255f378a
DM
2222 ("repository", true, &REPO_URL_SCHEMA),
2223 ("output-format", true, &OUTPUT_FORMAT),
552c2259 2224 ]),
255f378a
DM
2225 )
2226 );
7074a0b3 2227
255f378a 2228 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
d0a03d40 2229 .completion_cb("repository", complete_repository);
41c039e1 2230
552c2259 2231 #[sortable]
255f378a
DM
2232 const API_METHOD_LIST_SNAPSHOTS: ApiMethod = ApiMethod::new(
2233 &ApiHandler::Sync(&list_snapshots),
2234 &ObjectSchema::new(
2235 "List backup snapshots.",
552c2259 2236 &sorted!([
255f378a
DM
2237 ("group", true, &StringSchema::new("Backup group.").schema()),
2238 ("repository", true, &REPO_URL_SCHEMA),
2239 ("output-format", true, &OUTPUT_FORMAT),
552c2259 2240 ]),
255f378a
DM
2241 )
2242 );
7074a0b3 2243
255f378a 2244 let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
49fddd98 2245 .arg_param(&["group"])
024f11bb 2246 .completion_cb("group", complete_backup_group)
d0a03d40 2247 .completion_cb("repository", complete_repository);
184f17af 2248
552c2259 2249 #[sortable]
255f378a
DM
2250 const API_METHOD_FORGET_SNAPSHOTS: ApiMethod = ApiMethod::new(
2251 &ApiHandler::Sync(&forget_snapshots),
2252 &ObjectSchema::new(
2253 "Forget (remove) backup snapshots.",
552c2259 2254 &sorted!([
255f378a
DM
2255 ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
2256 ("repository", true, &REPO_URL_SCHEMA),
552c2259 2257 ]),
255f378a
DM
2258 )
2259 );
7074a0b3 2260
255f378a 2261 let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
49fddd98 2262 .arg_param(&["snapshot"])
b2388518 2263 .completion_cb("repository", complete_repository)
543a260f 2264 .completion_cb("snapshot", complete_backup_snapshot);
6f62c924 2265
552c2259 2266 #[sortable]
255f378a
DM
2267 const API_METHOD_START_GARBAGE_COLLECTION: ApiMethod = ApiMethod::new(
2268 &ApiHandler::Sync(&start_garbage_collection),
2269 &ObjectSchema::new(
2270 "Start garbage collection for a specific repository.",
552c2259 2271 &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
255f378a
DM
2272 )
2273 );
7074a0b3 2274
255f378a 2275 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
d0a03d40 2276 .completion_cb("repository", complete_repository);
8cc0d6af 2277
552c2259 2278 #[sortable]
255f378a
DM
2279 const API_METHOD_RESTORE: ApiMethod = ApiMethod::new(
2280 &ApiHandler::Sync(&restore),
2281 &ObjectSchema::new(
2282 "Restore backup repository.",
552c2259 2283 &sorted!([
255f378a
DM
2284 ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()),
2285 ("archive-name", false, &StringSchema::new("Backup archive name.").schema()),
2286 (
2287 "target",
2288 false,
2289 &StringSchema::new(
2290 r###"Target directory path. Use '-' to write to stdandard output.
bf125261
DM
2291
2292We do not extraxt '.pxar' archives when writing to stdandard output.
2293
2294"###
255f378a
DM
2295 ).schema()
2296 ),
2297 (
46d5aa0a 2298 "allow-existing-dirs",
255f378a
DM
2299 true,
2300 &BooleanSchema::new("Do not fail if directories already exists.")
2301 .default(false)
2302 .schema()
2303 ),
2304 ("repository", true, &REPO_URL_SCHEMA),
2305 ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()),
2306 (
86eda3eb 2307 "verbose",
7074a0b3 2308 true,
255f378a
DM
2309 &BooleanSchema::new("Verbose output.")
2310 .default(false)
2311 .schema()
2312 ),
552c2259 2313 ]),
255f378a
DM
2314 )
2315 );
7074a0b3 2316
255f378a 2317 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
49fddd98 2318 .arg_param(&["snapshot", "archive-name", "target"])
b2388518 2319 .completion_cb("repository", complete_repository)
08dc340a
DM
2320 .completion_cb("snapshot", complete_group_or_snapshot)
2321 .completion_cb("archive-name", complete_archive_name)
2322 .completion_cb("target", tools::complete_file_name);
9f912493 2323
552c2259 2324 #[sortable]
255f378a
DM
2325 const API_METHOD_LIST_SNAPSHOT_FILES: ApiMethod = ApiMethod::new(
2326 &ApiHandler::Sync(&list_snapshot_files),
2327 &ObjectSchema::new(
2328 "List snapshot files.",
552c2259 2329 &sorted!([
255f378a
DM
2330 ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
2331 ("repository", true, &REPO_URL_SCHEMA),
2332 ("output-format", true, &OUTPUT_FORMAT),
552c2259 2333 ]),
255f378a
DM
2334 )
2335 );
7074a0b3 2336
255f378a 2337 let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
49fddd98 2338 .arg_param(&["snapshot"])
52c171e4 2339 .completion_cb("repository", complete_repository)
543a260f 2340 .completion_cb("snapshot", complete_backup_snapshot);
52c171e4 2341
255f378a
DM
2342 const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
2343 &ApiHandler::Sync(&prune),
2344 &ObjectSchema::new(
2345 "Prune backup repository.",
552c2259 2346 &proxmox_backup::add_common_prune_prameters!([
74fa81b8
DM
2347 ("dry-run", true, &BooleanSchema::new(
2348 "Just show what prune would do, but do not delete anything.")
2349 .schema()),
255f378a 2350 ("group", false, &StringSchema::new("Backup group.").schema()),
552c2259 2351 ], [
163e9bbe 2352 ("output-format", true, &OUTPUT_FORMAT),
255f378a 2353 ("repository", true, &REPO_URL_SCHEMA),
552c2259 2354 ])
255f378a
DM
2355 )
2356 );
7074a0b3 2357
255f378a 2358 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
49fddd98 2359 .arg_param(&["group"])
9fdc3ef4 2360 .completion_cb("group", complete_backup_group)
d0a03d40 2361 .completion_cb("repository", complete_repository);
9f912493 2362
552c2259 2363 #[sortable]
255f378a
DM
2364 const API_METHOD_STATUS: ApiMethod = ApiMethod::new(
2365 &ApiHandler::Sync(&status),
2366 &ObjectSchema::new(
2367 "Get repository status.",
552c2259 2368 &sorted!([
255f378a
DM
2369 ("repository", true, &REPO_URL_SCHEMA),
2370 ("output-format", true, &OUTPUT_FORMAT),
552c2259 2371 ]),
255f378a
DM
2372 )
2373 );
7074a0b3 2374
255f378a 2375 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
34a816cc
DM
2376 .completion_cb("repository", complete_repository);
2377
552c2259 2378 #[sortable]
255f378a
DM
2379 const API_METHOD_API_LOGIN: ApiMethod = ApiMethod::new(
2380 &ApiHandler::Sync(&api_login),
2381 &ObjectSchema::new(
2382 "Try to login. If successful, store ticket.",
552c2259 2383 &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
255f378a
DM
2384 )
2385 );
7074a0b3 2386
255f378a 2387 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
e240d8be
DM
2388 .completion_cb("repository", complete_repository);
2389
552c2259 2390 #[sortable]
255f378a
DM
2391 const API_METHOD_API_LOGOUT: ApiMethod = ApiMethod::new(
2392 &ApiHandler::Sync(&api_logout),
2393 &ObjectSchema::new(
2394 "Logout (delete stored ticket).",
552c2259 2395 &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
255f378a
DM
2396 )
2397 );
7074a0b3 2398
255f378a 2399 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
e240d8be 2400 .completion_cb("repository", complete_repository);
32efac1c 2401
552c2259 2402 #[sortable]
255f378a
DM
2403 const API_METHOD_MOUNT: ApiMethod = ApiMethod::new(
2404 &ApiHandler::Sync(&mount),
2405 &ObjectSchema::new(
2406 "Mount pxar archive.",
552c2259 2407 &sorted!([
255f378a
DM
2408 ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()),
2409 ("archive-name", false, &StringSchema::new("Backup archive name.").schema()),
2410 ("target", false, &StringSchema::new("Target directory path.").schema()),
2411 ("repository", true, &REPO_URL_SCHEMA),
2412 ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()),
2413 ("verbose", true, &BooleanSchema::new("Verbose output.").default(false).schema()),
552c2259 2414 ]),
255f378a
DM
2415 )
2416 );
7074a0b3 2417
255f378a 2418 let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT)
49fddd98 2419 .arg_param(&["snapshot", "archive-name", "target"])
70235f72
CE
2420 .completion_cb("repository", complete_repository)
2421 .completion_cb("snapshot", complete_group_or_snapshot)
0ec9e1b0 2422 .completion_cb("archive-name", complete_pxar_archive_name)
70235f72 2423 .completion_cb("target", tools::complete_file_name);
e240d8be 2424
3cf73c4e 2425
41c039e1 2426 let cmd_def = CliCommandMap::new()
48ef3c33
DM
2427 .insert("backup", backup_cmd_def)
2428 .insert("upload-log", upload_log_cmd_def)
2429 .insert("forget", forget_cmd_def)
2430 .insert("garbage-collect", garbage_collect_cmd_def)
2431 .insert("list", list_cmd_def)
2432 .insert("login", login_cmd_def)
2433 .insert("logout", logout_cmd_def)
2434 .insert("prune", prune_cmd_def)
2435 .insert("restore", restore_cmd_def)
2436 .insert("snapshots", snapshots_cmd_def)
2437 .insert("files", files_cmd_def)
2438 .insert("status", status_cmd_def)
2439 .insert("key", key_mgmt_cli())
2440 .insert("mount", mount_cmd_def)
5830c205
DM
2441 .insert("catalog", catalog_mgmt_cli())
2442 .insert("task", task_mgmt_cli());
48ef3c33
DM
2443
2444 run_cli_command(cmd_def);
e9722f8b 2445}
496a6784 2446
e9722f8b 2447fn async_main<F: Future>(fut: F) -> <F as Future>::Output {
db0cb9ce 2448 let mut rt = tokio::runtime::Runtime::new().unwrap();
e9722f8b 2449 let ret = rt.block_on(fut);
db0cb9ce
WB
2450 // This does not exist anymore. We need to actually stop our runaways instead...
2451 // rt.shutdown_now();
e9722f8b 2452 ret
ff5d3707 2453}