]> git.proxmox.com Git - proxmox-backup.git/blob - proxmox-backup-client/src/main.rs
rustfmt
[proxmox-backup.git] / proxmox-backup-client / src / main.rs
1 use std::collections::HashSet;
2 use std::io::{self, Read, Seek, SeekFrom, Write};
3 use std::path::{Path, PathBuf};
4 use std::pin::Pin;
5 use std::sync::{Arc, Mutex};
6 use std::task::Context;
7
8 use anyhow::{bail, format_err, Error};
9 use futures::stream::{StreamExt, TryStreamExt};
10 use serde::Deserialize;
11 use serde_json::{json, Value};
12 use tokio::sync::mpsc;
13 use tokio_stream::wrappers::ReceiverStream;
14 use xdg::BaseDirectories;
15
16 use pathpatterns::{MatchEntry, MatchType, PatternFlag};
17 use proxmox_async::blocking::TokioWriterAdapter;
18 use proxmox_io::StdChannelWriter;
19 use proxmox_router::{cli::*, ApiMethod, RpcEnvironment};
20 use proxmox_schema::api;
21 use proxmox_sys::fs::{file_get_json, image_size, replace_file, CreateOptions};
22 use proxmox_time::{epoch_i64, strftime_local};
23 use pxar::accessor::{MaybeReady, ReadAt, ReadAtOperation};
24
25 use pbs_api_types::{
26 Authid, BackupDir, BackupGroup, BackupNamespace, BackupPart, BackupType, CryptMode,
27 Fingerprint, GroupListItem, HumanByte, PruneJobOptions, PruneListItem, RateLimitConfig,
28 SnapshotListItem, StorageStatus, BACKUP_ID_SCHEMA, BACKUP_NAMESPACE_SCHEMA, BACKUP_TIME_SCHEMA,
29 BACKUP_TYPE_SCHEMA, TRAFFIC_CONTROL_BURST_SCHEMA, TRAFFIC_CONTROL_RATE_SCHEMA,
30 };
31 use pbs_client::catalog_shell::Shell;
32 use pbs_client::tools::{
33 complete_archive_name, complete_auth_id, complete_backup_group, complete_backup_snapshot,
34 complete_backup_source, complete_chunk_size, complete_group_or_snapshot,
35 complete_img_archive_name, complete_namespace, complete_pxar_archive_name, complete_repository,
36 connect, connect_rate_limited, extract_repository_from_value,
37 key_source::{
38 crypto_parameters, format_key_source, get_encryption_key_password, KEYFD_SCHEMA,
39 KEYFILE_SCHEMA, MASTER_PUBKEY_FD_SCHEMA, MASTER_PUBKEY_FILE_SCHEMA,
40 },
41 CHUNK_SIZE_SCHEMA, REPO_URL_SCHEMA,
42 };
43 use pbs_client::{
44 delete_ticket_info, parse_backup_specification, view_task_result, BackupReader,
45 BackupRepository, BackupSpecificationType, BackupStats, BackupWriter, ChunkStream,
46 FixedChunkStream, HttpClient, PxarBackupStream, RemoteChunkReader, UploadOptions,
47 BACKUP_SOURCE_SCHEMA,
48 };
49 use pbs_config::key_config::{decrypt_key, rsa_encrypt_key_config, KeyConfig};
50 use pbs_datastore::catalog::{BackupCatalogWriter, CatalogReader, CatalogWriter};
51 use pbs_datastore::chunk_store::verify_chunk_size;
52 use pbs_datastore::dynamic_index::{BufferedDynamicReader, DynamicIndexReader};
53 use pbs_datastore::fixed_index::FixedIndexReader;
54 use pbs_datastore::index::IndexFile;
55 use pbs_datastore::manifest::{
56 archive_type, ArchiveType, BackupManifest, ENCRYPTED_KEY_BLOB_NAME, MANIFEST_BLOB_NAME,
57 };
58 use pbs_datastore::read_chunk::AsyncReadChunk;
59 use pbs_datastore::CATALOG_NAME;
60 use pbs_tools::crypt_config::CryptConfig;
61 use pbs_tools::json;
62
63 mod benchmark;
64 pub use benchmark::*;
65 mod mount;
66 pub use mount::*;
67 mod task;
68 pub use task::*;
69 mod catalog;
70 pub use catalog::*;
71 mod snapshot;
72 pub use snapshot::*;
73 pub mod key;
74 pub mod namespace;
75
76 fn record_repository(repo: &BackupRepository) {
77 let base = match BaseDirectories::with_prefix("proxmox-backup") {
78 Ok(v) => v,
79 _ => return,
80 };
81
82 // usually $HOME/.cache/proxmox-backup/repo-list
83 let path = match base.place_cache_file("repo-list") {
84 Ok(v) => v,
85 _ => return,
86 };
87
88 let mut data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
89
90 let repo = repo.to_string();
91
92 data[&repo] = json! { data[&repo].as_i64().unwrap_or(0) + 1 };
93
94 let mut map = serde_json::map::Map::new();
95
96 loop {
97 let mut max_used = 0;
98 let mut max_repo = None;
99 for (repo, count) in data.as_object().unwrap() {
100 if map.contains_key(repo) {
101 continue;
102 }
103 if let Some(count) = count.as_i64() {
104 if count > max_used {
105 max_used = count;
106 max_repo = Some(repo);
107 }
108 }
109 }
110 if let Some(repo) = max_repo {
111 map.insert(repo.to_owned(), json!(max_used));
112 } else {
113 break;
114 }
115 if map.len() > 10 {
116 // store max. 10 repos
117 break;
118 }
119 }
120
121 let new_data = json!(map);
122
123 let _ = replace_file(
124 path,
125 new_data.to_string().as_bytes(),
126 CreateOptions::new(),
127 false,
128 );
129 }
130
131 async fn api_datastore_list_snapshots(
132 client: &HttpClient,
133 store: &str,
134 ns: &BackupNamespace,
135 group: Option<&BackupGroup>,
136 ) -> Result<Value, Error> {
137 let path = format!("api2/json/admin/datastore/{}/snapshots", store);
138
139 let mut args = match group {
140 Some(group) => serde_json::to_value(group)?,
141 None => json!({}),
142 };
143 if !ns.is_root() {
144 args["ns"] = serde_json::to_value(ns)?;
145 }
146
147 let mut result = client.get(&path, Some(args)).await?;
148
149 Ok(result["data"].take())
150 }
151
152 pub async fn api_datastore_latest_snapshot(
153 client: &HttpClient,
154 store: &str,
155 ns: &BackupNamespace,
156 group: BackupGroup,
157 ) -> Result<BackupDir, Error> {
158 let list = api_datastore_list_snapshots(client, store, ns, Some(&group)).await?;
159 let mut list: Vec<SnapshotListItem> = serde_json::from_value(list)?;
160
161 if list.is_empty() {
162 bail!("backup group {} does not contain any snapshots.", group);
163 }
164
165 list.sort_unstable_by(|a, b| b.backup.time.cmp(&a.backup.time));
166
167 Ok((group, list[0].backup.time).into())
168 }
169
170 pub async fn dir_or_last_from_group(
171 client: &HttpClient,
172 repo: &BackupRepository,
173 ns: &BackupNamespace,
174 path: &str,
175 ) -> Result<BackupDir, Error> {
176 match path.parse::<BackupPart>()? {
177 BackupPart::Dir(dir) => Ok(dir),
178 BackupPart::Group(group) => {
179 api_datastore_latest_snapshot(client, repo.store(), ns, group).await
180 }
181 }
182 }
183
184 async fn backup_directory<P: AsRef<Path>>(
185 client: &BackupWriter,
186 dir_path: P,
187 archive_name: &str,
188 chunk_size: Option<usize>,
189 catalog: Arc<Mutex<CatalogWriter<TokioWriterAdapter<StdChannelWriter<Error>>>>>,
190 pxar_create_options: pbs_client::pxar::PxarCreateOptions,
191 upload_options: UploadOptions,
192 ) -> Result<BackupStats, Error> {
193 let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), catalog, pxar_create_options)?;
194 let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
195
196 let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
197
198 let stream = ReceiverStream::new(rx).map_err(Error::from);
199
200 // spawn chunker inside a separate task so that it can run parallel
201 tokio::spawn(async move {
202 while let Some(v) = chunk_stream.next().await {
203 let _ = tx.send(v).await;
204 }
205 });
206
207 if upload_options.fixed_size.is_some() {
208 bail!("cannot backup directory with fixed chunk size!");
209 }
210
211 let stats = client
212 .upload_stream(archive_name, stream, upload_options)
213 .await?;
214
215 Ok(stats)
216 }
217
218 async fn backup_image<P: AsRef<Path>>(
219 client: &BackupWriter,
220 image_path: P,
221 archive_name: &str,
222 chunk_size: Option<usize>,
223 upload_options: UploadOptions,
224 ) -> Result<BackupStats, Error> {
225 let path = image_path.as_ref().to_owned();
226
227 let file = tokio::fs::File::open(path).await?;
228
229 let stream = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
230 .map_err(Error::from);
231
232 let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4 * 1024 * 1024));
233
234 if upload_options.fixed_size.is_none() {
235 bail!("cannot backup image with dynamic chunk size!");
236 }
237
238 let stats = client
239 .upload_stream(archive_name, stream, upload_options)
240 .await?;
241
242 Ok(stats)
243 }
244
245 pub fn optional_ns_param(param: &Value) -> Result<BackupNamespace, Error> {
246 Ok(match param.get("ns") {
247 Some(Value::String(ns)) => ns.parse()?,
248 Some(_) => bail!("invalid namespace parameter"),
249 None => BackupNamespace::root(),
250 })
251 }
252
253 #[api(
254 input: {
255 properties: {
256 repository: {
257 schema: REPO_URL_SCHEMA,
258 optional: true,
259 },
260 "ns": {
261 type: BackupNamespace,
262 optional: true,
263 },
264 "output-format": {
265 schema: OUTPUT_FORMAT,
266 optional: true,
267 },
268 }
269 }
270 )]
271 /// List backup groups.
272 async fn list_backup_groups(param: Value) -> Result<Value, Error> {
273 let output_format = get_output_format(&param);
274
275 let repo = extract_repository_from_value(&param)?;
276
277 let client = connect(&repo)?;
278
279 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
280
281 let backup_ns = optional_ns_param(&param)?;
282 let mut result = client
283 .get(
284 &path,
285 match backup_ns.is_root() {
286 true => None,
287 false => Some(json!({ "ns": backup_ns })),
288 },
289 )
290 .await?;
291
292 record_repository(&repo);
293
294 let render_group_path = |_v: &Value, record: &Value| -> Result<String, Error> {
295 let item = GroupListItem::deserialize(record)?;
296 Ok(item.backup.to_string())
297 };
298
299 let render_last_backup = |_v: &Value, record: &Value| -> Result<String, Error> {
300 let item = GroupListItem::deserialize(record)?;
301 let snapshot = BackupDir {
302 group: item.backup,
303 time: item.last_backup,
304 };
305 Ok(snapshot.to_string())
306 };
307
308 let render_files = |_v: &Value, record: &Value| -> Result<String, Error> {
309 let item = GroupListItem::deserialize(record)?;
310 Ok(pbs_tools::format::render_backup_file_list(&item.files))
311 };
312
313 let options = default_table_format_options()
314 .sortby("backup-type", false)
315 .sortby("backup-id", false)
316 .column(
317 ColumnConfig::new("backup-id")
318 .renderer(render_group_path)
319 .header("group"),
320 )
321 .column(
322 ColumnConfig::new("last-backup")
323 .renderer(render_last_backup)
324 .header("last snapshot")
325 .right_align(false),
326 )
327 .column(ColumnConfig::new("backup-count"))
328 .column(ColumnConfig::new("files").renderer(render_files));
329
330 let mut data: Value = result["data"].take();
331
332 let return_type = &pbs_api_types::ADMIN_DATASTORE_LIST_GROUPS_RETURN_TYPE;
333
334 format_and_print_result_full(&mut data, return_type, &output_format, &options);
335
336 Ok(Value::Null)
337 }
338
339 fn merge_group_into(to: &mut serde_json::Map<String, Value>, group: BackupGroup) {
340 match serde_json::to_value(group).unwrap() {
341 Value::Object(group) => to.extend(group),
342 _ => unreachable!(),
343 }
344 }
345
346 #[api(
347 input: {
348 properties: {
349 repository: {
350 schema: REPO_URL_SCHEMA,
351 optional: true,
352 },
353 group: {
354 type: String,
355 description: "Backup group.",
356 },
357 "ns": {
358 type: BackupNamespace,
359 optional: true,
360 },
361 "new-owner": {
362 type: Authid,
363 },
364 }
365 }
366 )]
367 /// Change owner of a backup group
368 async fn change_backup_owner(group: String, mut param: Value) -> Result<(), Error> {
369 let repo = extract_repository_from_value(&param)?;
370 let ns = optional_ns_param(&param)?;
371
372 let client = connect(&repo)?;
373
374 param.as_object_mut().unwrap().remove("repository");
375
376 let group: BackupGroup = group.parse()?;
377
378 merge_group_into(param.as_object_mut().unwrap(), group);
379 if !ns.is_root() {
380 param["ns"] = serde_json::to_value(ns)?;
381 }
382
383 let path = format!("api2/json/admin/datastore/{}/change-owner", repo.store());
384 client.post(&path, Some(param)).await?;
385
386 record_repository(&repo);
387
388 Ok(())
389 }
390
391 #[api(
392 input: {
393 properties: {
394 repository: {
395 schema: REPO_URL_SCHEMA,
396 optional: true,
397 },
398 }
399 }
400 )]
401 /// Try to login. If successful, store ticket.
402 async fn api_login(param: Value) -> Result<Value, Error> {
403 let repo = extract_repository_from_value(&param)?;
404
405 let client = connect(&repo)?;
406 client.login().await?;
407
408 record_repository(&repo);
409
410 Ok(Value::Null)
411 }
412
413 #[api(
414 input: {
415 properties: {
416 repository: {
417 schema: REPO_URL_SCHEMA,
418 optional: true,
419 },
420 }
421 }
422 )]
423 /// Logout (delete stored ticket).
424 fn api_logout(param: Value) -> Result<Value, Error> {
425 let repo = extract_repository_from_value(&param)?;
426
427 delete_ticket_info("proxmox-backup", repo.host(), repo.user())?;
428
429 Ok(Value::Null)
430 }
431
432 #[api(
433 input: {
434 properties: {
435 repository: {
436 schema: REPO_URL_SCHEMA,
437 optional: true,
438 },
439 "output-format": {
440 schema: OUTPUT_FORMAT,
441 optional: true,
442 },
443 }
444 }
445 )]
446 /// Show client and optional server version
447 async fn api_version(param: Value) -> Result<(), Error> {
448 let output_format = get_output_format(&param);
449
450 let mut version_info = json!({
451 "client": {
452 "version": pbs_buildcfg::PROXMOX_PKG_VERSION,
453 "release": pbs_buildcfg::PROXMOX_PKG_RELEASE,
454 "repoid": pbs_buildcfg::PROXMOX_PKG_REPOID,
455 }
456 });
457
458 let repo = extract_repository_from_value(&param);
459 if let Ok(repo) = repo {
460 let client = connect(&repo)?;
461
462 match client.get("api2/json/version", None).await {
463 Ok(mut result) => version_info["server"] = result["data"].take(),
464 Err(e) => log::error!("could not connect to server - {}", e),
465 }
466 }
467 if output_format == "text" {
468 println!(
469 "client version: {}.{}",
470 pbs_buildcfg::PROXMOX_PKG_VERSION,
471 pbs_buildcfg::PROXMOX_PKG_RELEASE,
472 );
473 if let Some(server) = version_info["server"].as_object() {
474 let server_version = server["version"].as_str().unwrap();
475 let server_release = server["release"].as_str().unwrap();
476 println!("server version: {}.{}", server_version, server_release);
477 }
478 } else {
479 format_and_print_result(&version_info, &output_format);
480 }
481
482 Ok(())
483 }
484
485 #[api(
486 input: {
487 properties: {
488 repository: {
489 schema: REPO_URL_SCHEMA,
490 optional: true,
491 },
492 "output-format": {
493 schema: OUTPUT_FORMAT,
494 optional: true,
495 },
496 },
497 },
498 )]
499 /// Start garbage collection for a specific repository.
500 async fn start_garbage_collection(param: Value) -> Result<Value, Error> {
501 let repo = extract_repository_from_value(&param)?;
502
503 let output_format = get_output_format(&param);
504
505 let client = connect(&repo)?;
506
507 let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
508
509 let result = client.post(&path, None).await?;
510
511 record_repository(&repo);
512
513 view_task_result(&client, result, &output_format).await?;
514
515 Ok(Value::Null)
516 }
517
518 struct CatalogUploadResult {
519 catalog_writer: Arc<Mutex<CatalogWriter<TokioWriterAdapter<StdChannelWriter<Error>>>>>,
520 result: tokio::sync::oneshot::Receiver<Result<BackupStats, Error>>,
521 }
522
523 fn spawn_catalog_upload(
524 client: Arc<BackupWriter>,
525 encrypt: bool,
526 ) -> Result<CatalogUploadResult, Error> {
527 let (catalog_tx, catalog_rx) = std::sync::mpsc::sync_channel(10); // allow to buffer 10 writes
528 let catalog_stream = proxmox_async::blocking::StdChannelStream(catalog_rx);
529 let catalog_chunk_size = 512 * 1024;
530 let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size));
531
532 let catalog_writer = Arc::new(Mutex::new(CatalogWriter::new(TokioWriterAdapter::new(
533 StdChannelWriter::new(catalog_tx),
534 ))?));
535
536 let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel();
537
538 let upload_options = UploadOptions {
539 encrypt,
540 compress: true,
541 ..UploadOptions::default()
542 };
543
544 tokio::spawn(async move {
545 let catalog_upload_result = client
546 .upload_stream(CATALOG_NAME, catalog_chunk_stream, upload_options)
547 .await;
548
549 if let Err(ref err) = catalog_upload_result {
550 log::error!("catalog upload error - {}", err);
551 client.cancel();
552 }
553
554 let _ = catalog_result_tx.send(catalog_upload_result);
555 });
556
557 Ok(CatalogUploadResult {
558 catalog_writer,
559 result: catalog_result_rx,
560 })
561 }
562
563 #[api(
564 input: {
565 properties: {
566 backupspec: {
567 type: Array,
568 description: "List of backup source specifications ([<label.ext>:<path>] ...)",
569 items: {
570 schema: BACKUP_SOURCE_SCHEMA,
571 }
572 },
573 repository: {
574 schema: REPO_URL_SCHEMA,
575 optional: true,
576 },
577 "include-dev": {
578 description: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
579 optional: true,
580 items: {
581 type: String,
582 description: "Path to file.",
583 }
584 },
585 "all-file-systems": {
586 type: Boolean,
587 description: "Include all mounted subdirectories.",
588 optional: true,
589 default: false,
590 },
591 keyfile: {
592 schema: KEYFILE_SCHEMA,
593 optional: true,
594 },
595 "keyfd": {
596 schema: KEYFD_SCHEMA,
597 optional: true,
598 },
599 "master-pubkey-file": {
600 schema: MASTER_PUBKEY_FILE_SCHEMA,
601 optional: true,
602 },
603 "master-pubkey-fd": {
604 schema: MASTER_PUBKEY_FD_SCHEMA,
605 optional: true,
606 },
607 "crypt-mode": {
608 type: CryptMode,
609 optional: true,
610 },
611 "skip-lost-and-found": {
612 type: Boolean,
613 description: "Skip lost+found directory.",
614 optional: true,
615 default: false,
616 },
617 "ns": {
618 schema: BACKUP_NAMESPACE_SCHEMA,
619 optional: true,
620 },
621 "backup-type": {
622 schema: BACKUP_TYPE_SCHEMA,
623 optional: true,
624 },
625 "backup-id": {
626 schema: BACKUP_ID_SCHEMA,
627 optional: true,
628 },
629 "backup-time": {
630 schema: BACKUP_TIME_SCHEMA,
631 optional: true,
632 },
633 "chunk-size": {
634 schema: CHUNK_SIZE_SCHEMA,
635 optional: true,
636 },
637 rate: {
638 schema: TRAFFIC_CONTROL_RATE_SCHEMA,
639 optional: true,
640 },
641 burst: {
642 schema: TRAFFIC_CONTROL_BURST_SCHEMA,
643 optional: true,
644 },
645 "exclude": {
646 type: Array,
647 description: "List of paths or patterns for matching files to exclude.",
648 optional: true,
649 items: {
650 type: String,
651 description: "Path or match pattern.",
652 }
653 },
654 "entries-max": {
655 type: Integer,
656 description: "Max number of entries to hold in memory.",
657 optional: true,
658 default: pbs_client::pxar::ENCODER_MAX_ENTRIES as isize,
659 },
660 "dry-run": {
661 type: Boolean,
662 description: "Just show what backup would do, but do not upload anything.",
663 optional: true,
664 default: false,
665 },
666 }
667 }
668 )]
669 /// Create (host) backup.
670 async fn create_backup(
671 param: Value,
672 all_file_systems: bool,
673 skip_lost_and_found: bool,
674 dry_run: bool,
675 _info: &ApiMethod,
676 _rpcenv: &mut dyn RpcEnvironment,
677 ) -> Result<Value, Error> {
678 let repo = extract_repository_from_value(&param)?;
679
680 let backupspec_list = json::required_array_param(&param, "backupspec")?;
681
682 let backup_time_opt = param["backup-time"].as_i64();
683
684 let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v * 1024) as usize);
685
686 if let Some(size) = chunk_size_opt {
687 verify_chunk_size(size)?;
688 }
689
690 let rate = match param["rate"].as_str() {
691 Some(s) => Some(s.parse::<HumanByte>()?),
692 None => None,
693 };
694 let burst = match param["burst"].as_str() {
695 Some(s) => Some(s.parse::<HumanByte>()?),
696 None => None,
697 };
698
699 let rate_limit = RateLimitConfig::with_same_inout(rate, burst);
700
701 let crypto = crypto_parameters(&param)?;
702
703 let backup_id = param["backup-id"]
704 .as_str()
705 .unwrap_or_else(|| proxmox_sys::nodename());
706
707 let backup_ns = optional_ns_param(&param)?;
708
709 let backup_type: BackupType = param["backup-type"].as_str().unwrap_or("host").parse()?;
710
711 let include_dev = param["include-dev"].as_array();
712
713 let entries_max = param["entries-max"]
714 .as_u64()
715 .unwrap_or(pbs_client::pxar::ENCODER_MAX_ENTRIES as u64);
716
717 let empty = Vec::new();
718 let exclude_args = param["exclude"].as_array().unwrap_or(&empty);
719
720 let mut pattern_list = Vec::with_capacity(exclude_args.len());
721 for entry in exclude_args {
722 let entry = entry
723 .as_str()
724 .ok_or_else(|| format_err!("Invalid pattern string slice"))?;
725 pattern_list.push(
726 MatchEntry::parse_pattern(entry, PatternFlag::PATH_NAME, MatchType::Exclude)
727 .map_err(|err| format_err!("invalid exclude pattern entry: {}", err))?,
728 );
729 }
730
731 let mut devices = if all_file_systems {
732 None
733 } else {
734 Some(HashSet::new())
735 };
736
737 if let Some(include_dev) = include_dev {
738 if all_file_systems {
739 bail!("option 'all-file-systems' conflicts with option 'include-dev'");
740 }
741
742 let mut set = HashSet::new();
743 for path in include_dev {
744 let path = path.as_str().unwrap();
745 let stat = nix::sys::stat::stat(path)
746 .map_err(|err| format_err!("fstat {:?} failed - {}", path, err))?;
747 set.insert(stat.st_dev);
748 }
749 devices = Some(set);
750 }
751
752 let mut upload_list = vec![];
753 let mut target_set = HashSet::new();
754
755 for backupspec in backupspec_list {
756 let spec = parse_backup_specification(backupspec.as_str().unwrap())?;
757 let filename = &spec.config_string;
758 let target = &spec.archive_name;
759
760 if target_set.contains(target) {
761 bail!("got target twice: '{}'", target);
762 }
763 target_set.insert(target.to_string());
764
765 use std::os::unix::fs::FileTypeExt;
766
767 let metadata = std::fs::metadata(filename)
768 .map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?;
769 let file_type = metadata.file_type();
770
771 match spec.spec_type {
772 BackupSpecificationType::PXAR => {
773 if !file_type.is_dir() {
774 bail!("got unexpected file type (expected directory)");
775 }
776 upload_list.push((
777 BackupSpecificationType::PXAR,
778 filename.to_owned(),
779 format!("{}.didx", target),
780 0,
781 ));
782 }
783 BackupSpecificationType::IMAGE => {
784 if !(file_type.is_file() || file_type.is_block_device()) {
785 bail!("got unexpected file type (expected file or block device)");
786 }
787
788 let size = image_size(&PathBuf::from(filename))?;
789
790 if size == 0 {
791 bail!("got zero-sized file '{}'", filename);
792 }
793
794 upload_list.push((
795 BackupSpecificationType::IMAGE,
796 filename.to_owned(),
797 format!("{}.fidx", target),
798 size,
799 ));
800 }
801 BackupSpecificationType::CONFIG => {
802 if !file_type.is_file() {
803 bail!("got unexpected file type (expected regular file)");
804 }
805 upload_list.push((
806 BackupSpecificationType::CONFIG,
807 filename.to_owned(),
808 format!("{}.blob", target),
809 metadata.len(),
810 ));
811 }
812 BackupSpecificationType::LOGFILE => {
813 if !file_type.is_file() {
814 bail!("got unexpected file type (expected regular file)");
815 }
816 upload_list.push((
817 BackupSpecificationType::LOGFILE,
818 filename.to_owned(),
819 format!("{}.blob", target),
820 metadata.len(),
821 ));
822 }
823 }
824 }
825
826 let backup_time = backup_time_opt.unwrap_or_else(epoch_i64);
827
828 let client = connect_rate_limited(&repo, rate_limit)?;
829 record_repository(&repo);
830
831 let snapshot = BackupDir::from((backup_type, backup_id.to_owned(), backup_time));
832 if backup_ns.is_root() {
833 log::info!("Starting backup: {snapshot}");
834 } else {
835 log::info!("Starting backup: [{backup_ns}]:{snapshot}");
836 }
837
838 log::info!("Client name: {}", proxmox_sys::nodename());
839
840 let start_time = std::time::Instant::now();
841
842 log::info!(
843 "Starting backup protocol: {}",
844 strftime_local("%c", epoch_i64())?
845 );
846
847 let (crypt_config, rsa_encrypted_key) = match crypto.enc_key {
848 None => (None, None),
849 Some(key_with_source) => {
850 log::info!(
851 "{}",
852 format_key_source(&key_with_source.source, "encryption")
853 );
854
855 let (key, created, fingerprint) =
856 decrypt_key(&key_with_source.key, &get_encryption_key_password)?;
857 log::info!("Encryption key fingerprint: {}", fingerprint);
858
859 let crypt_config = CryptConfig::new(key)?;
860
861 match crypto.master_pubkey {
862 Some(pem_with_source) => {
863 log::info!("{}", format_key_source(&pem_with_source.source, "master"));
864
865 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_with_source.key)?;
866
867 let mut key_config = KeyConfig::without_password(key)?;
868 key_config.created = created; // keep original value
869
870 let enc_key = rsa_encrypt_key_config(rsa, &key_config)?;
871
872 (Some(Arc::new(crypt_config)), Some(enc_key))
873 }
874 _ => (Some(Arc::new(crypt_config)), None),
875 }
876 }
877 };
878
879 let client = BackupWriter::start(
880 client,
881 crypt_config.clone(),
882 repo.store(),
883 &backup_ns,
884 &snapshot,
885 true,
886 false,
887 )
888 .await?;
889
890 let download_previous_manifest = match client.previous_backup_time().await {
891 Ok(Some(backup_time)) => {
892 log::info!(
893 "Downloading previous manifest ({})",
894 strftime_local("%c", backup_time)?
895 );
896 true
897 }
898 Ok(None) => {
899 log::info!("No previous manifest available.");
900 false
901 }
902 Err(_) => {
903 // Fallback for outdated server, TODO remove/bubble up with 2.0
904 true
905 }
906 };
907
908 let previous_manifest = if download_previous_manifest {
909 match client.download_previous_manifest().await {
910 Ok(previous_manifest) => {
911 match previous_manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref)) {
912 Ok(()) => Some(Arc::new(previous_manifest)),
913 Err(err) => {
914 log::error!("Couldn't re-use previous manifest - {}", err);
915 None
916 }
917 }
918 }
919 Err(err) => {
920 log::error!("Couldn't download previous manifest - {}", err);
921 None
922 }
923 }
924 } else {
925 None
926 };
927
928 let mut manifest = BackupManifest::new(snapshot);
929
930 let mut catalog = None;
931 let mut catalog_result_rx = None;
932
933 let log_file = |desc: &str, file: &str, target: &str| {
934 let what = if dry_run { "Would upload" } else { "Upload" };
935 log::info!("{} {} '{}' to '{}' as {}", what, desc, file, repo, target);
936 };
937
938 for (backup_type, filename, target, size) in upload_list {
939 match (backup_type, dry_run) {
940 // dry-run
941 (BackupSpecificationType::CONFIG, true) => log_file("config file", &filename, &target),
942 (BackupSpecificationType::LOGFILE, true) => log_file("log file", &filename, &target),
943 (BackupSpecificationType::PXAR, true) => log_file("directory", &filename, &target),
944 (BackupSpecificationType::IMAGE, true) => log_file("image", &filename, &target),
945 // no dry-run
946 (BackupSpecificationType::CONFIG, false) => {
947 let upload_options = UploadOptions {
948 compress: true,
949 encrypt: crypto.mode == CryptMode::Encrypt,
950 ..UploadOptions::default()
951 };
952
953 log_file("config file", &filename, &target);
954 let stats = client
955 .upload_blob_from_file(&filename, &target, upload_options)
956 .await?;
957 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
958 }
959 (BackupSpecificationType::LOGFILE, false) => {
960 // fixme: remove - not needed anymore ?
961 let upload_options = UploadOptions {
962 compress: true,
963 encrypt: crypto.mode == CryptMode::Encrypt,
964 ..UploadOptions::default()
965 };
966
967 log_file("log file", &filename, &target);
968 let stats = client
969 .upload_blob_from_file(&filename, &target, upload_options)
970 .await?;
971 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
972 }
973 (BackupSpecificationType::PXAR, false) => {
974 // start catalog upload on first use
975 if catalog.is_none() {
976 let catalog_upload_res =
977 spawn_catalog_upload(client.clone(), crypto.mode == CryptMode::Encrypt)?;
978 catalog = Some(catalog_upload_res.catalog_writer);
979 catalog_result_rx = Some(catalog_upload_res.result);
980 }
981 let catalog = catalog.as_ref().unwrap();
982
983 log_file("directory", &filename, &target);
984 catalog
985 .lock()
986 .unwrap()
987 .start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
988
989 let pxar_options = pbs_client::pxar::PxarCreateOptions {
990 device_set: devices.clone(),
991 patterns: pattern_list.clone(),
992 entries_max: entries_max as usize,
993 skip_lost_and_found,
994 };
995
996 let upload_options = UploadOptions {
997 previous_manifest: previous_manifest.clone(),
998 compress: true,
999 encrypt: crypto.mode == CryptMode::Encrypt,
1000 ..UploadOptions::default()
1001 };
1002
1003 let stats = backup_directory(
1004 &client,
1005 &filename,
1006 &target,
1007 chunk_size_opt,
1008 catalog.clone(),
1009 pxar_options,
1010 upload_options,
1011 )
1012 .await?;
1013 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
1014 catalog.lock().unwrap().end_directory()?;
1015 }
1016 (BackupSpecificationType::IMAGE, false) => {
1017 log_file("image", &filename, &target);
1018
1019 let upload_options = UploadOptions {
1020 previous_manifest: previous_manifest.clone(),
1021 fixed_size: Some(size),
1022 compress: true,
1023 encrypt: crypto.mode == CryptMode::Encrypt,
1024 };
1025
1026 let stats =
1027 backup_image(&client, &filename, &target, chunk_size_opt, upload_options)
1028 .await?;
1029 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
1030 }
1031 }
1032 }
1033
1034 if dry_run {
1035 log::info!("dry-run: no upload happend");
1036 return Ok(Value::Null);
1037 }
1038
1039 // finalize and upload catalog
1040 if let Some(catalog) = catalog {
1041 let mutex = Arc::try_unwrap(catalog)
1042 .map_err(|_| format_err!("unable to get catalog (still used)"))?;
1043 let mut catalog = mutex.into_inner().unwrap();
1044
1045 catalog.finish()?;
1046
1047 drop(catalog); // close upload stream
1048
1049 if let Some(catalog_result_rx) = catalog_result_rx {
1050 let stats = catalog_result_rx.await??;
1051 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum, crypto.mode)?;
1052 }
1053 }
1054
1055 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
1056 let target = ENCRYPTED_KEY_BLOB_NAME;
1057 log::info!("Upload RSA encoded key to '{:?}' as {}", repo, target);
1058 let options = UploadOptions {
1059 compress: false,
1060 encrypt: false,
1061 ..UploadOptions::default()
1062 };
1063 let stats = client
1064 .upload_blob_from_data(rsa_encrypted_key, target, options)
1065 .await?;
1066 manifest.add_file(target.to_string(), stats.size, stats.csum, crypto.mode)?;
1067 }
1068 // create manifest (index.json)
1069 // manifests are never encrypted, but include a signature
1070 let manifest = manifest
1071 .to_string(crypt_config.as_ref().map(Arc::as_ref))
1072 .map_err(|err| format_err!("unable to format manifest - {}", err))?;
1073
1074 log::debug!("Upload index.json to '{}'", repo);
1075
1076 let options = UploadOptions {
1077 compress: true,
1078 encrypt: false,
1079 ..UploadOptions::default()
1080 };
1081 client
1082 .upload_blob_from_data(manifest.into_bytes(), MANIFEST_BLOB_NAME, options)
1083 .await?;
1084
1085 client.finish().await?;
1086
1087 let end_time = std::time::Instant::now();
1088 let elapsed = end_time.duration_since(start_time);
1089 log::info!("Duration: {:.2}s", elapsed.as_secs_f64());
1090 log::info!("End Time: {}", strftime_local("%c", epoch_i64())?);
1091 Ok(Value::Null)
1092 }
1093
1094 async fn dump_image<W: Write>(
1095 client: Arc<BackupReader>,
1096 crypt_config: Option<Arc<CryptConfig>>,
1097 crypt_mode: CryptMode,
1098 index: FixedIndexReader,
1099 mut writer: W,
1100 ) -> Result<(), Error> {
1101 let most_used = index.find_most_used_chunks(8);
1102
1103 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, crypt_mode, most_used);
1104
1105 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1106 // and thus slows down reading. Instead, directly use RemoteChunkReader
1107 let mut per = 0;
1108 let mut bytes = 0;
1109 let start_time = std::time::Instant::now();
1110
1111 for pos in 0..index.index_count() {
1112 let digest = index.index_digest(pos).unwrap();
1113 let raw_data = chunk_reader.read_chunk(digest).await?;
1114 writer.write_all(&raw_data)?;
1115 bytes += raw_data.len();
1116 let next_per = ((pos + 1) * 100) / index.index_count();
1117 if per != next_per {
1118 log::debug!(
1119 "progress {}% (read {} bytes, duration {} sec)",
1120 next_per,
1121 bytes,
1122 start_time.elapsed().as_secs()
1123 );
1124 per = next_per;
1125 }
1126 }
1127
1128 let end_time = std::time::Instant::now();
1129 let elapsed = end_time.duration_since(start_time);
1130 log::info!(
1131 "restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)",
1132 bytes,
1133 elapsed.as_secs_f64(),
1134 bytes as f64 / (1024.0 * 1024.0 * elapsed.as_secs_f64())
1135 );
1136
1137 Ok(())
1138 }
1139
1140 fn parse_archive_type(name: &str) -> (String, ArchiveType) {
1141 if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
1142 (name.into(), archive_type(name).unwrap())
1143 } else if name.ends_with(".pxar") {
1144 (format!("{}.didx", name), ArchiveType::DynamicIndex)
1145 } else if name.ends_with(".img") {
1146 (format!("{}.fidx", name), ArchiveType::FixedIndex)
1147 } else {
1148 (format!("{}.blob", name), ArchiveType::Blob)
1149 }
1150 }
1151
1152 #[api(
1153 input: {
1154 properties: {
1155 repository: {
1156 schema: REPO_URL_SCHEMA,
1157 optional: true,
1158 },
1159 ns: {
1160 type: BackupNamespace,
1161 optional: true,
1162 },
1163 snapshot: {
1164 type: String,
1165 description: "Group/Snapshot path.",
1166 },
1167 "archive-name": {
1168 description: "Backup archive name.",
1169 type: String,
1170 },
1171 target: {
1172 type: String,
1173 description: r###"Target directory path. Use '-' to write to standard output.
1174
1175 We do not extract '.pxar' archives when writing to standard output.
1176
1177 "###
1178 },
1179 rate: {
1180 schema: TRAFFIC_CONTROL_RATE_SCHEMA,
1181 optional: true,
1182 },
1183 burst: {
1184 schema: TRAFFIC_CONTROL_BURST_SCHEMA,
1185 optional: true,
1186 },
1187 "allow-existing-dirs": {
1188 type: Boolean,
1189 description: "Do not fail if directories already exists.",
1190 optional: true,
1191 default: false,
1192 },
1193 keyfile: {
1194 schema: KEYFILE_SCHEMA,
1195 optional: true,
1196 },
1197 "keyfd": {
1198 schema: KEYFD_SCHEMA,
1199 optional: true,
1200 },
1201 "crypt-mode": {
1202 type: CryptMode,
1203 optional: true,
1204 },
1205 "ignore-acls": {
1206 type: Boolean,
1207 description: "ignore acl settings",
1208 optional: true,
1209 default: false,
1210 },
1211 "ignore-xattrs": {
1212 type: Boolean,
1213 description: "ignore xattr settings",
1214 optional: true,
1215 default: false,
1216 },
1217 "ignore-ownership": {
1218 type: Boolean,
1219 description: "ignore owner settings (no chown)",
1220 optional: true,
1221 default: false,
1222 },
1223 "ignore-permissions": {
1224 type: Boolean,
1225 description: "ignore permission settings (no chmod)",
1226 optional: true,
1227 default: false,
1228 },
1229 "overwrite": {
1230 type: Boolean,
1231 description: "overwrite already existing files",
1232 optional: true,
1233 default: false,
1234 },
1235 }
1236 }
1237 )]
1238 /// Restore backup repository.
1239 async fn restore(
1240 param: Value,
1241 allow_existing_dirs: bool,
1242 ignore_acls: bool,
1243 ignore_xattrs: bool,
1244 ignore_ownership: bool,
1245 ignore_permissions: bool,
1246 overwrite: bool,
1247 ) -> Result<Value, Error> {
1248 let repo = extract_repository_from_value(&param)?;
1249
1250 let archive_name = json::required_string_param(&param, "archive-name")?;
1251
1252 let rate = match param["rate"].as_str() {
1253 Some(s) => Some(s.parse::<HumanByte>()?),
1254 None => None,
1255 };
1256 let burst = match param["burst"].as_str() {
1257 Some(s) => Some(s.parse::<HumanByte>()?),
1258 None => None,
1259 };
1260
1261 let rate_limit = RateLimitConfig::with_same_inout(rate, burst);
1262
1263 let client = connect_rate_limited(&repo, rate_limit)?;
1264 record_repository(&repo);
1265
1266 let ns = optional_ns_param(&param)?;
1267 let path = json::required_string_param(&param, "snapshot")?;
1268
1269 let backup_dir = dir_or_last_from_group(&client, &repo, &ns, path).await?;
1270
1271 let target = json::required_string_param(&param, "target")?;
1272 let target = if target == "-" { None } else { Some(target) };
1273
1274 let crypto = crypto_parameters(&param)?;
1275
1276 let crypt_config = match crypto.enc_key {
1277 None => None,
1278 Some(ref key) => {
1279 let (key, _, _) =
1280 decrypt_key(&key.key, &get_encryption_key_password).map_err(|err| {
1281 log::error!("{}", format_key_source(&key.source, "encryption"));
1282 err
1283 })?;
1284 Some(Arc::new(CryptConfig::new(key)?))
1285 }
1286 };
1287
1288 let client = BackupReader::start(
1289 client,
1290 crypt_config.clone(),
1291 repo.store(),
1292 &ns,
1293 &backup_dir,
1294 true,
1295 )
1296 .await?;
1297
1298 let (archive_name, archive_type) = parse_archive_type(archive_name);
1299
1300 let (manifest, backup_index_data) = client.download_manifest().await?;
1301
1302 if archive_name == ENCRYPTED_KEY_BLOB_NAME && crypt_config.is_none() {
1303 log::info!("Restoring encrypted key blob without original key - skipping manifest fingerprint check!")
1304 } else {
1305 if manifest.signature.is_some() {
1306 if let Some(key) = &crypto.enc_key {
1307 log::info!("{}", format_key_source(&key.source, "encryption"));
1308 }
1309 if let Some(config) = &crypt_config {
1310 log::info!("Fingerprint: {}", Fingerprint::new(config.fingerprint()));
1311 }
1312 }
1313 manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref))?;
1314 }
1315
1316 if archive_name == MANIFEST_BLOB_NAME {
1317 if let Some(target) = target {
1318 replace_file(target, &backup_index_data, CreateOptions::new(), false)?;
1319 } else {
1320 let stdout = std::io::stdout();
1321 let mut writer = stdout.lock();
1322 writer
1323 .write_all(&backup_index_data)
1324 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1325 }
1326
1327 return Ok(Value::Null);
1328 }
1329
1330 let file_info = manifest.lookup_file_info(&archive_name)?;
1331
1332 if archive_type == ArchiveType::Blob {
1333 let mut reader = client.download_blob(&manifest, &archive_name).await?;
1334
1335 if let Some(target) = target {
1336 let mut writer = std::fs::OpenOptions::new()
1337 .write(true)
1338 .create(true)
1339 .create_new(true)
1340 .open(target)
1341 .map_err(|err| {
1342 format_err!("unable to create target file {:?} - {}", target, err)
1343 })?;
1344 std::io::copy(&mut reader, &mut writer)?;
1345 } else {
1346 let stdout = std::io::stdout();
1347 let mut writer = stdout.lock();
1348 std::io::copy(&mut reader, &mut writer)
1349 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1350 }
1351 } else if archive_type == ArchiveType::DynamicIndex {
1352 let index = client
1353 .download_dynamic_index(&manifest, &archive_name)
1354 .await?;
1355
1356 let most_used = index.find_most_used_chunks(8);
1357
1358 let chunk_reader = RemoteChunkReader::new(
1359 client.clone(),
1360 crypt_config,
1361 file_info.chunk_crypt_mode(),
1362 most_used,
1363 );
1364
1365 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
1366
1367 let options = pbs_client::pxar::PxarExtractOptions {
1368 match_list: &[],
1369 extract_match_default: true,
1370 allow_existing_dirs,
1371 overwrite,
1372 on_error: None,
1373 };
1374
1375 let mut feature_flags = pbs_client::pxar::Flags::DEFAULT;
1376
1377 if ignore_acls {
1378 feature_flags.remove(pbs_client::pxar::Flags::WITH_ACL);
1379 }
1380 if ignore_xattrs {
1381 feature_flags.remove(pbs_client::pxar::Flags::WITH_XATTRS);
1382 }
1383 if ignore_ownership {
1384 feature_flags.remove(pbs_client::pxar::Flags::WITH_OWNER);
1385 }
1386 if ignore_permissions {
1387 feature_flags.remove(pbs_client::pxar::Flags::WITH_PERMISSIONS);
1388 }
1389
1390 if let Some(target) = target {
1391 pbs_client::pxar::extract_archive(
1392 pxar::decoder::Decoder::from_std(reader)?,
1393 Path::new(target),
1394 feature_flags,
1395 |path| {
1396 log::debug!("{:?}", path);
1397 },
1398 options,
1399 )
1400 .map_err(|err| format_err!("error extracting archive - {}", err))?;
1401 } else {
1402 let mut writer = std::fs::OpenOptions::new()
1403 .write(true)
1404 .open("/dev/stdout")
1405 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?;
1406
1407 std::io::copy(&mut reader, &mut writer)
1408 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1409 }
1410 } else if archive_type == ArchiveType::FixedIndex {
1411 let index = client
1412 .download_fixed_index(&manifest, &archive_name)
1413 .await?;
1414
1415 let mut writer = if let Some(target) = target {
1416 std::fs::OpenOptions::new()
1417 .write(true)
1418 .create(true)
1419 .create_new(true)
1420 .open(target)
1421 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?
1422 } else {
1423 std::fs::OpenOptions::new()
1424 .write(true)
1425 .open("/dev/stdout")
1426 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?
1427 };
1428
1429 dump_image(
1430 client.clone(),
1431 crypt_config.clone(),
1432 file_info.chunk_crypt_mode(),
1433 index,
1434 &mut writer,
1435 )
1436 .await?;
1437 }
1438
1439 Ok(Value::Null)
1440 }
1441
1442 #[api(
1443 input: {
1444 properties: {
1445 "dry-run": {
1446 type: bool,
1447 optional: true,
1448 description: "Just show what prune would do, but do not delete anything.",
1449 },
1450 group: {
1451 type: String,
1452 description: "Backup group",
1453 },
1454 "prune-options": {
1455 type: PruneJobOptions,
1456 flatten: true,
1457 },
1458 "output-format": {
1459 schema: OUTPUT_FORMAT,
1460 optional: true,
1461 },
1462 quiet: {
1463 type: bool,
1464 optional: true,
1465 default: false,
1466 description: "Minimal output - only show removals.",
1467 },
1468 repository: {
1469 schema: REPO_URL_SCHEMA,
1470 optional: true,
1471 },
1472 },
1473 },
1474 )]
1475 /// Prune a backup repository.
1476 async fn prune(
1477 dry_run: Option<bool>,
1478 group: String,
1479 prune_options: PruneJobOptions,
1480 quiet: bool,
1481 mut param: Value,
1482 ) -> Result<Value, Error> {
1483 let repo = extract_repository_from_value(&param)?;
1484
1485 let client = connect(&repo)?;
1486
1487 let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
1488
1489 let group: BackupGroup = group.parse()?;
1490
1491 let output_format = extract_output_format(&mut param);
1492
1493 let mut api_param = serde_json::to_value(prune_options)?;
1494 if let Some(dry_run) = dry_run {
1495 api_param["dry-run"] = dry_run.into();
1496 }
1497 merge_group_into(api_param.as_object_mut().unwrap(), group);
1498
1499 let mut result = client.post(&path, Some(api_param)).await?;
1500
1501 record_repository(&repo);
1502
1503 let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
1504 let item: PruneListItem = serde_json::from_value(record.to_owned())?;
1505 Ok(item.backup.to_string())
1506 };
1507
1508 let render_prune_action = |v: &Value, _record: &Value| -> Result<String, Error> {
1509 Ok(match v.as_bool() {
1510 Some(true) => "keep",
1511 Some(false) => "remove",
1512 None => "unknown",
1513 }
1514 .to_string())
1515 };
1516
1517 let options = default_table_format_options()
1518 .sortby("backup-type", false)
1519 .sortby("backup-id", false)
1520 .sortby("backup-time", false)
1521 .column(
1522 ColumnConfig::new("backup-id")
1523 .renderer(render_snapshot_path)
1524 .header("snapshot"),
1525 )
1526 .column(
1527 ColumnConfig::new("backup-time")
1528 .renderer(pbs_tools::format::render_epoch)
1529 .header("date"),
1530 )
1531 .column(
1532 ColumnConfig::new("keep")
1533 .renderer(render_prune_action)
1534 .header("action"),
1535 );
1536
1537 let return_type = &pbs_api_types::ADMIN_DATASTORE_PRUNE_RETURN_TYPE;
1538
1539 let mut data = result["data"].take();
1540
1541 if quiet {
1542 let list: Vec<Value> = data
1543 .as_array()
1544 .unwrap()
1545 .iter()
1546 .filter(|item| item["keep"].as_bool() == Some(false))
1547 .cloned()
1548 .collect();
1549 data = list.into();
1550 }
1551
1552 format_and_print_result_full(&mut data, return_type, &output_format, &options);
1553
1554 Ok(Value::Null)
1555 }
1556
1557 #[api(
1558 input: {
1559 properties: {
1560 repository: {
1561 schema: REPO_URL_SCHEMA,
1562 optional: true,
1563 },
1564 "output-format": {
1565 schema: OUTPUT_FORMAT,
1566 optional: true,
1567 },
1568 }
1569 },
1570 returns: {
1571 type: StorageStatus,
1572 },
1573 )]
1574 /// Get repository status.
1575 async fn status(param: Value) -> Result<Value, Error> {
1576 let repo = extract_repository_from_value(&param)?;
1577
1578 let output_format = get_output_format(&param);
1579
1580 let client = connect(&repo)?;
1581
1582 let path = format!("api2/json/admin/datastore/{}/status", repo.store());
1583
1584 let mut result = client.get(&path, None).await?;
1585 let mut data = result["data"].take();
1586
1587 record_repository(&repo);
1588
1589 let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
1590 let v = v.as_u64().unwrap();
1591 let total = record["total"].as_u64().unwrap();
1592 let roundup = total / 200;
1593 let per = ((v + roundup) * 100) / total;
1594 let info = format!(" ({} %)", per);
1595 Ok(format!("{} {:>8}", v, info))
1596 };
1597
1598 let options = default_table_format_options()
1599 .noheader(true)
1600 .column(ColumnConfig::new("total").renderer(render_total_percentage))
1601 .column(ColumnConfig::new("used").renderer(render_total_percentage))
1602 .column(ColumnConfig::new("avail").renderer(render_total_percentage));
1603
1604 let return_type = &API_METHOD_STATUS.returns;
1605
1606 format_and_print_result_full(&mut data, return_type, &output_format, &options);
1607
1608 Ok(Value::Null)
1609 }
1610
1611 /// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
1612 /// async use!
1613 ///
1614 /// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
1615 /// so that we can properly access it from multiple threads simultaneously while not issuing
1616 /// duplicate simultaneous reads over http.
1617 pub struct BufferedDynamicReadAt {
1618 inner: Mutex<BufferedDynamicReader<RemoteChunkReader>>,
1619 }
1620
1621 impl BufferedDynamicReadAt {
1622 fn new(inner: BufferedDynamicReader<RemoteChunkReader>) -> Self {
1623 Self {
1624 inner: Mutex::new(inner),
1625 }
1626 }
1627 }
1628
1629 impl ReadAt for BufferedDynamicReadAt {
1630 fn start_read_at<'a>(
1631 self: Pin<&'a Self>,
1632 _cx: &mut Context,
1633 buf: &'a mut [u8],
1634 offset: u64,
1635 ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
1636 MaybeReady::Ready(tokio::task::block_in_place(move || {
1637 let mut reader = self.inner.lock().unwrap();
1638 reader.seek(SeekFrom::Start(offset))?;
1639 reader.read(buf)
1640 }))
1641 }
1642
1643 fn poll_complete<'a>(
1644 self: Pin<&'a Self>,
1645 _op: ReadAtOperation<'a>,
1646 ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
1647 panic!("BufferedDynamicReadAt::start_read_at returned Pending");
1648 }
1649 }
1650
1651 fn main() {
1652 pbs_tools::setup_libc_malloc_opts();
1653 init_cli_logger("PBS_LOG", "info");
1654
1655 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
1656 .arg_param(&["backupspec"])
1657 .completion_cb("repository", complete_repository)
1658 .completion_cb("backupspec", complete_backup_source)
1659 .completion_cb("keyfile", complete_file_name)
1660 .completion_cb("master-pubkey-file", complete_file_name)
1661 .completion_cb("chunk-size", complete_chunk_size);
1662
1663 let benchmark_cmd_def = CliCommand::new(&API_METHOD_BENCHMARK)
1664 .completion_cb("repository", complete_repository)
1665 .completion_cb("keyfile", complete_file_name);
1666
1667 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
1668 .completion_cb("ns", complete_namespace)
1669 .completion_cb("repository", complete_repository);
1670
1671 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
1672 .completion_cb("repository", complete_repository);
1673
1674 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
1675 .arg_param(&["snapshot", "archive-name", "target"])
1676 .completion_cb("repository", complete_repository)
1677 .completion_cb("ns", complete_namespace)
1678 .completion_cb("snapshot", complete_group_or_snapshot)
1679 .completion_cb("archive-name", complete_archive_name)
1680 .completion_cb("target", complete_file_name);
1681
1682 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
1683 .arg_param(&["group"])
1684 .completion_cb("ns", complete_namespace)
1685 .completion_cb("group", complete_backup_group)
1686 .completion_cb("repository", complete_repository);
1687
1688 let status_cmd_def =
1689 CliCommand::new(&API_METHOD_STATUS).completion_cb("repository", complete_repository);
1690
1691 let login_cmd_def =
1692 CliCommand::new(&API_METHOD_API_LOGIN).completion_cb("repository", complete_repository);
1693
1694 let logout_cmd_def =
1695 CliCommand::new(&API_METHOD_API_LOGOUT).completion_cb("repository", complete_repository);
1696
1697 let version_cmd_def =
1698 CliCommand::new(&API_METHOD_API_VERSION).completion_cb("repository", complete_repository);
1699
1700 let change_owner_cmd_def = CliCommand::new(&API_METHOD_CHANGE_BACKUP_OWNER)
1701 .arg_param(&["group", "new-owner"])
1702 .completion_cb("ns", complete_namespace)
1703 .completion_cb("group", complete_backup_group)
1704 .completion_cb("new-owner", complete_auth_id)
1705 .completion_cb("repository", complete_repository);
1706
1707 let cmd_def = CliCommandMap::new()
1708 .insert("backup", backup_cmd_def)
1709 .insert("garbage-collect", garbage_collect_cmd_def)
1710 .insert("list", list_cmd_def)
1711 .insert("login", login_cmd_def)
1712 .insert("logout", logout_cmd_def)
1713 .insert("prune", prune_cmd_def)
1714 .insert("restore", restore_cmd_def)
1715 .insert("snapshot", snapshot_mgtm_cli())
1716 .insert("status", status_cmd_def)
1717 .insert("key", key::cli())
1718 .insert("mount", mount_cmd_def())
1719 .insert("map", map_cmd_def())
1720 .insert("unmap", unmap_cmd_def())
1721 .insert("catalog", catalog_mgmt_cli())
1722 .insert("task", task_mgmt_cli())
1723 .insert("version", version_cmd_def)
1724 .insert("benchmark", benchmark_cmd_def)
1725 .insert("change-owner", change_owner_cmd_def)
1726 .insert("namespace", namespace::cli_map())
1727 .alias(&["files"], &["snapshot", "files"])
1728 .alias(&["forget"], &["snapshot", "forget"])
1729 .alias(&["upload-log"], &["snapshot", "upload-log"])
1730 .alias(&["snapshots"], &["snapshot", "list"]);
1731
1732 let rpcenv = CliEnvironment::new();
1733 run_cli_command(
1734 cmd_def,
1735 rpcenv,
1736 Some(|future| proxmox_async::runtime::main(future)),
1737 );
1738 }