1 use std
::collections
::HashSet
;
2 use std
::io
::{self, Read, Write, Seek, SeekFrom}
;
3 use std
::path
::{Path, PathBuf}
;
5 use std
::sync
::{Arc, Mutex}
;
6 use std
::task
::Context
;
8 use anyhow
::{bail, format_err, Error}
;
9 use futures
::stream
::{StreamExt, TryStreamExt}
;
10 use serde_json
::{json, Value}
;
11 use tokio
::sync
::mpsc
;
12 use tokio_stream
::wrappers
::ReceiverStream
;
13 use xdg
::BaseDirectories
;
15 use pathpatterns
::{MatchEntry, MatchType, PatternFlag}
;
18 time
::{strftime_local, epoch_i64}
,
19 fs
::{file_get_json, replace_file, CreateOptions, image_size}
,
28 use pxar
::accessor
::{MaybeReady, ReadAt, ReadAtOperation}
;
31 BACKUP_ID_SCHEMA
, BACKUP_TIME_SCHEMA
, BACKUP_TYPE_SCHEMA
, Authid
, CryptMode
, GroupListItem
,
32 PruneListItem
, SnapshotListItem
, StorageStatus
,
38 BackupSpecificationType
,
48 parse_backup_specification
,
51 use pbs_client
::catalog_shell
::Shell
;
52 use pbs_client
::tools
::{
53 complete_archive_name
, complete_auth_id
, complete_backup_group
, complete_backup_snapshot
,
54 complete_backup_source
, complete_chunk_size
, complete_group_or_snapshot
,
55 complete_img_archive_name
, complete_pxar_archive_name
, complete_repository
, connect
,
56 extract_repository_from_value
,
58 crypto_parameters
, format_key_source
, get_encryption_key_password
, KEYFD_SCHEMA
,
59 KEYFILE_SCHEMA
, MASTER_PUBKEY_FD_SCHEMA
, MASTER_PUBKEY_FILE_SCHEMA
,
61 CHUNK_SIZE_SCHEMA
, REPO_URL_SCHEMA
,
63 use pbs_datastore
::{CATALOG_NAME, CryptConfig, KeyConfig, decrypt_key, rsa_encrypt_key_config}
;
64 use pbs_datastore
::backup_info
::{BackupDir, BackupGroup}
;
65 use pbs_datastore
::catalog
::{BackupCatalogWriter, CatalogReader, CatalogWriter}
;
66 use pbs_datastore
::chunk_store
::verify_chunk_size
;
67 use pbs_datastore
::dynamic_index
::DynamicIndexReader
;
68 use pbs_datastore
::fixed_index
::FixedIndexReader
;
69 use pbs_datastore
::index
::IndexFile
;
70 use pbs_datastore
::manifest
::{
71 ENCRYPTED_KEY_BLOB_NAME
, MANIFEST_BLOB_NAME
, ArchiveType
, BackupManifest
, archive_type
,
73 use pbs_datastore
::read_chunk
::AsyncReadChunk
;
74 use pbs_datastore
::prune
::PruneOptions
;
75 use pbs_tools
::sync
::StdChannelWriter
;
76 use pbs_tools
::tokio
::TokioWriterAdapter
;
78 use proxmox_backup
::backup
::{
79 BufferedDynamicReader
,
81 use proxmox_backup
::tools
;
83 mod proxmox_backup_client
;
84 use proxmox_backup_client
::*;
86 fn record_repository(repo
: &BackupRepository
) {
88 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
93 // usually $HOME/.cache/proxmox-backup/repo-list
94 let path
= match base
.place_cache_file("repo-list") {
99 let mut data
= file_get_json(&path
, None
).unwrap_or_else(|_
| json
!({}
));
101 let repo
= repo
.to_string();
103 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
105 let mut map
= serde_json
::map
::Map
::new();
108 let mut max_used
= 0;
109 let mut max_repo
= None
;
110 for (repo
, count
) in data
.as_object().unwrap() {
111 if map
.contains_key(repo
) { continue; }
112 if let Some(count
) = count
.as_i64() {
113 if count
> max_used
{
115 max_repo
= Some(repo
);
119 if let Some(repo
) = max_repo
{
120 map
.insert(repo
.to_owned(), json
!(max_used
));
124 if map
.len() > 10 { // store max. 10 repos
129 let new_data
= json
!(map
);
131 let _
= replace_file(path
, new_data
.to_string().as_bytes(), CreateOptions
::new());
134 async
fn api_datastore_list_snapshots(
137 group
: Option
<BackupGroup
>,
138 ) -> Result
<Value
, Error
> {
140 let path
= format
!("api2/json/admin/datastore/{}/snapshots", store
);
142 let mut args
= json
!({}
);
143 if let Some(group
) = group
{
144 args
["backup-type"] = group
.backup_type().into();
145 args
["backup-id"] = group
.backup_id().into();
148 let mut result
= client
.get(&path
, Some(args
)).await?
;
150 Ok(result
["data"].take())
153 pub async
fn api_datastore_latest_snapshot(
157 ) -> Result
<(String
, String
, i64), Error
> {
159 let list
= api_datastore_list_snapshots(client
, store
, Some(group
.clone())).await?
;
160 let mut list
: Vec
<SnapshotListItem
> = serde_json
::from_value(list
)?
;
163 bail
!("backup group {:?} does not contain any snapshots.", group
.group_path());
166 list
.sort_unstable_by(|a
, b
| b
.backup_time
.cmp(&a
.backup_time
));
168 let backup_time
= list
[0].backup_time
;
170 Ok((group
.backup_type().to_owned(), group
.backup_id().to_owned(), backup_time
))
173 async
fn backup_directory
<P
: AsRef
<Path
>>(
174 client
: &BackupWriter
,
177 chunk_size
: Option
<usize>,
178 catalog
: Arc
<Mutex
<CatalogWriter
<TokioWriterAdapter
<StdChannelWriter
>>>>,
179 pxar_create_options
: pbs_client
::pxar
::PxarCreateOptions
,
180 upload_options
: UploadOptions
,
181 ) -> Result
<BackupStats
, Error
> {
183 let pxar_stream
= PxarBackupStream
::open(
188 let mut chunk_stream
= ChunkStream
::new(pxar_stream
, chunk_size
);
190 let (tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
192 let stream
= ReceiverStream
::new(rx
)
193 .map_err(Error
::from
);
195 // spawn chunker inside a separate task so that it can run parallel
196 tokio
::spawn(async
move {
197 while let Some(v
) = chunk_stream
.next().await
{
198 let _
= tx
.send(v
).await
;
202 if upload_options
.fixed_size
.is_some() {
203 bail
!("cannot backup directory with fixed chunk size!");
207 .upload_stream(archive_name
, stream
, upload_options
)
213 async
fn backup_image
<P
: AsRef
<Path
>>(
214 client
: &BackupWriter
,
217 chunk_size
: Option
<usize>,
218 upload_options
: UploadOptions
,
219 ) -> Result
<BackupStats
, Error
> {
221 let path
= image_path
.as_ref().to_owned();
223 let file
= tokio
::fs
::File
::open(path
).await?
;
225 let stream
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
226 .map_err(Error
::from
);
228 let stream
= FixedChunkStream
::new(stream
, chunk_size
.unwrap_or(4*1024*1024));
230 if upload_options
.fixed_size
.is_none() {
231 bail
!("cannot backup image with dynamic chunk size!");
235 .upload_stream(archive_name
, stream
, upload_options
)
245 schema
: REPO_URL_SCHEMA
,
249 schema
: OUTPUT_FORMAT
,
255 /// List backup groups.
256 async
fn list_backup_groups(param
: Value
) -> Result
<Value
, Error
> {
258 let output_format
= get_output_format(¶m
);
260 let repo
= extract_repository_from_value(¶m
)?
;
262 let client
= connect(&repo
)?
;
264 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
266 let mut result
= client
.get(&path
, None
).await?
;
268 record_repository(&repo
);
270 let render_group_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
271 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
272 let group
= BackupGroup
::new(item
.backup_type
, item
.backup_id
);
273 Ok(group
.group_path().to_str().unwrap().to_owned())
276 let render_last_backup
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
277 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
278 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.last_backup
)?
;
279 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
282 let render_files
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
283 let item
: GroupListItem
= serde_json
::from_value(record
.to_owned())?
;
284 Ok(pbs_tools
::format
::render_backup_file_list(&item
.files
))
287 let options
= default_table_format_options()
288 .sortby("backup-type", false)
289 .sortby("backup-id", false)
290 .column(ColumnConfig
::new("backup-id").renderer(render_group_path
).header("group"))
292 ColumnConfig
::new("last-backup")
293 .renderer(render_last_backup
)
294 .header("last snapshot")
297 .column(ColumnConfig
::new("backup-count"))
298 .column(ColumnConfig
::new("files").renderer(render_files
));
300 let mut data
: Value
= result
["data"].take();
302 let return_type
= &proxmox_backup
::api2
::admin
::datastore
::API_METHOD_LIST_GROUPS
.returns
;
304 format_and_print_result_full(&mut data
, return_type
, &output_format
, &options
);
313 schema
: REPO_URL_SCHEMA
,
318 description
: "Backup group.",
326 /// Change owner of a backup group
327 async
fn change_backup_owner(group
: String
, mut param
: Value
) -> Result
<(), Error
> {
329 let repo
= extract_repository_from_value(¶m
)?
;
331 let mut client
= connect(&repo
)?
;
333 param
.as_object_mut().unwrap().remove("repository");
335 let group
: BackupGroup
= group
.parse()?
;
337 param
["backup-type"] = group
.backup_type().into();
338 param
["backup-id"] = group
.backup_id().into();
340 let path
= format
!("api2/json/admin/datastore/{}/change-owner", repo
.store());
341 client
.post(&path
, Some(param
)).await?
;
343 record_repository(&repo
);
352 schema
: REPO_URL_SCHEMA
,
358 /// Try to login. If successful, store ticket.
359 async
fn api_login(param
: Value
) -> Result
<Value
, Error
> {
361 let repo
= extract_repository_from_value(¶m
)?
;
363 let client
= connect(&repo
)?
;
364 client
.login().await?
;
366 record_repository(&repo
);
375 schema
: REPO_URL_SCHEMA
,
381 /// Logout (delete stored ticket).
382 fn api_logout(param
: Value
) -> Result
<Value
, Error
> {
384 let repo
= extract_repository_from_value(¶m
)?
;
386 delete_ticket_info("proxmox-backup", repo
.host(), repo
.user())?
;
395 schema
: REPO_URL_SCHEMA
,
399 schema
: OUTPUT_FORMAT
,
405 /// Show client and optional server version
406 async
fn api_version(param
: Value
) -> Result
<(), Error
> {
408 let output_format
= get_output_format(¶m
);
410 let mut version_info
= json
!({
412 "version": pbs_buildcfg
::PROXMOX_PKG_VERSION
,
413 "release": pbs_buildcfg
::PROXMOX_PKG_RELEASE
,
414 "repoid": pbs_buildcfg
::PROXMOX_PKG_REPOID
,
418 let repo
= extract_repository_from_value(¶m
);
419 if let Ok(repo
) = repo
{
420 let client
= connect(&repo
)?
;
422 match client
.get("api2/json/version", None
).await
{
423 Ok(mut result
) => version_info
["server"] = result
["data"].take(),
424 Err(e
) => eprintln
!("could not connect to server - {}", e
),
427 if output_format
== "text" {
429 "client version: {}.{}",
430 pbs_buildcfg
::PROXMOX_PKG_VERSION
,
431 pbs_buildcfg
::PROXMOX_PKG_RELEASE
,
433 if let Some(server
) = version_info
["server"].as_object() {
434 let server_version
= server
["version"].as_str().unwrap();
435 let server_release
= server
["release"].as_str().unwrap();
436 println
!("server version: {}.{}", server_version
, server_release
);
439 format_and_print_result(&version_info
, &output_format
);
449 schema
: REPO_URL_SCHEMA
,
453 schema
: OUTPUT_FORMAT
,
459 /// Start garbage collection for a specific repository.
460 async
fn start_garbage_collection(param
: Value
) -> Result
<Value
, Error
> {
462 let repo
= extract_repository_from_value(¶m
)?
;
464 let output_format
= get_output_format(¶m
);
466 let mut client
= connect(&repo
)?
;
468 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
470 let result
= client
.post(&path
, None
).await?
;
472 record_repository(&repo
);
474 view_task_result(&mut client
, result
, &output_format
).await?
;
479 struct CatalogUploadResult
{
480 catalog_writer
: Arc
<Mutex
<CatalogWriter
<TokioWriterAdapter
<StdChannelWriter
>>>>,
481 result
: tokio
::sync
::oneshot
::Receiver
<Result
<BackupStats
, Error
>>,
484 fn spawn_catalog_upload(
485 client
: Arc
<BackupWriter
>,
487 ) -> Result
<CatalogUploadResult
, Error
> {
488 let (catalog_tx
, catalog_rx
) = std
::sync
::mpsc
::sync_channel(10); // allow to buffer 10 writes
489 let catalog_stream
= crate::tools
::StdChannelStream(catalog_rx
);
490 let catalog_chunk_size
= 512*1024;
491 let catalog_chunk_stream
= ChunkStream
::new(catalog_stream
, Some(catalog_chunk_size
));
493 let catalog_writer
= Arc
::new(Mutex
::new(CatalogWriter
::new(TokioWriterAdapter
::new(StdChannelWriter
::new(catalog_tx
)))?
));
495 let (catalog_result_tx
, catalog_result_rx
) = tokio
::sync
::oneshot
::channel();
497 let upload_options
= UploadOptions
{
500 ..UploadOptions
::default()
503 tokio
::spawn(async
move {
504 let catalog_upload_result
= client
505 .upload_stream(CATALOG_NAME
, catalog_chunk_stream
, upload_options
)
508 if let Err(ref err
) = catalog_upload_result
{
509 eprintln
!("catalog upload error - {}", err
);
513 let _
= catalog_result_tx
.send(catalog_upload_result
);
516 Ok(CatalogUploadResult { catalog_writer, result: catalog_result_rx }
)
524 description
: "List of backup source specifications ([<label.ext>:<path>] ...)",
526 schema
: BACKUP_SOURCE_SCHEMA
,
530 schema
: REPO_URL_SCHEMA
,
534 description
: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
538 description
: "Path to file.",
541 "all-file-systems": {
543 description
: "Include all mounted subdirectories.",
547 schema
: KEYFILE_SCHEMA
,
551 schema
: KEYFD_SCHEMA
,
554 "master-pubkey-file": {
555 schema
: MASTER_PUBKEY_FILE_SCHEMA
,
558 "master-pubkey-fd": {
559 schema
: MASTER_PUBKEY_FD_SCHEMA
,
566 "skip-lost-and-found": {
568 description
: "Skip lost+found directory.",
572 schema
: BACKUP_TYPE_SCHEMA
,
576 schema
: BACKUP_ID_SCHEMA
,
580 schema
: BACKUP_TIME_SCHEMA
,
584 schema
: CHUNK_SIZE_SCHEMA
,
589 description
: "List of paths or patterns for matching files to exclude.",
593 description
: "Path or match pattern.",
598 description
: "Max number of entries to hold in memory.",
600 default: pbs_client
::pxar
::ENCODER_MAX_ENTRIES
as isize,
604 description
: "Verbose output.",
610 /// Create (host) backup.
611 async
fn create_backup(
614 _rpcenv
: &mut dyn RpcEnvironment
,
615 ) -> Result
<Value
, Error
> {
617 let repo
= extract_repository_from_value(¶m
)?
;
619 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
621 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
623 let skip_lost_and_found
= param
["skip-lost-and-found"].as_bool().unwrap_or(false);
625 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
627 let backup_time_opt
= param
["backup-time"].as_i64();
629 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| (v
*1024) as usize);
631 if let Some(size
) = chunk_size_opt
{
632 verify_chunk_size(size
)?
;
635 let crypto
= crypto_parameters(¶m
)?
;
637 let backup_id
= param
["backup-id"].as_str().unwrap_or(&proxmox
::tools
::nodename());
639 let backup_type
= param
["backup-type"].as_str().unwrap_or("host");
641 let include_dev
= param
["include-dev"].as_array();
643 let entries_max
= param
["entries-max"].as_u64()
644 .unwrap_or(pbs_client
::pxar
::ENCODER_MAX_ENTRIES
as u64);
646 let empty
= Vec
::new();
647 let exclude_args
= param
["exclude"].as_array().unwrap_or(&empty
);
649 let mut pattern_list
= Vec
::with_capacity(exclude_args
.len());
650 for entry
in exclude_args
{
651 let entry
= entry
.as_str().ok_or_else(|| format_err
!("Invalid pattern string slice"))?
;
653 MatchEntry
::parse_pattern(entry
, PatternFlag
::PATH_NAME
, MatchType
::Exclude
)
654 .map_err(|err
| format_err
!("invalid exclude pattern entry: {}", err
))?
658 let mut devices
= if all_file_systems { None }
else { Some(HashSet::new()) }
;
660 if let Some(include_dev
) = include_dev
{
661 if all_file_systems
{
662 bail
!("option 'all-file-systems' conflicts with option 'include-dev'");
665 let mut set
= HashSet
::new();
666 for path
in include_dev
{
667 let path
= path
.as_str().unwrap();
668 let stat
= nix
::sys
::stat
::stat(path
)
669 .map_err(|err
| format_err
!("fstat {:?} failed - {}", path
, err
))?
;
670 set
.insert(stat
.st_dev
);
675 let mut upload_list
= vec
![];
676 let mut target_set
= HashSet
::new();
678 for backupspec
in backupspec_list
{
679 let spec
= parse_backup_specification(backupspec
.as_str().unwrap())?
;
680 let filename
= &spec
.config_string
;
681 let target
= &spec
.archive_name
;
683 if target_set
.contains(target
) {
684 bail
!("got target twice: '{}'", target
);
686 target_set
.insert(target
.to_string());
688 use std
::os
::unix
::fs
::FileTypeExt
;
690 let metadata
= std
::fs
::metadata(filename
)
691 .map_err(|err
| format_err
!("unable to access '{}' - {}", filename
, err
))?
;
692 let file_type
= metadata
.file_type();
694 match spec
.spec_type
{
695 BackupSpecificationType
::PXAR
=> {
696 if !file_type
.is_dir() {
697 bail
!("got unexpected file type (expected directory)");
699 upload_list
.push((BackupSpecificationType
::PXAR
, filename
.to_owned(), format
!("{}.didx", target
), 0));
701 BackupSpecificationType
::IMAGE
=> {
702 if !(file_type
.is_file() || file_type
.is_block_device()) {
703 bail
!("got unexpected file type (expected file or block device)");
706 let size
= image_size(&PathBuf
::from(filename
))?
;
708 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
710 upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}
.fidx
", target), size));
712 BackupSpecificationType::CONFIG => {
713 if !file_type.is_file() {
714 bail!("got unexpected file
type (expected regular file
)");
716 upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
718 BackupSpecificationType::LOGFILE => {
719 if !file_type.is_file() {
720 bail!("got unexpected file
type (expected regular file
)");
722 upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}
.blob
", target), metadata.len()));
727 let backup_time = backup_time_opt.unwrap_or_else(epoch_i64);
729 let client = connect(&repo)?;
730 record_repository(&repo);
732 println!("Starting backup
: {}
/{}
/{}
", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time)?);
734 println!("Client name
: {}
", proxmox::tools::nodename());
736 let start_time = std::time::Instant::now();
738 println!("Starting backup protocol
: {}
", strftime_local("%c
", epoch_i64())?);
740 let (crypt_config, rsa_encrypted_key) = match crypto.enc_key {
741 None => (None, None),
742 Some(key_with_source) => {
745 format_key_source(&key_with_source.source, "encryption
")
748 let (key, created, fingerprint) =
749 decrypt_key(&key_with_source.key, &get_encryption_key_password)?;
750 println!("Encryption key fingerprint
: {}
", fingerprint);
752 let crypt_config = CryptConfig::new(key)?;
754 match crypto.master_pubkey {
755 Some(pem_with_source) => {
756 println!("{}
", format_key_source(&pem_with_source.source, "master
"));
758 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_with_source.key)?;
760 let mut key_config = KeyConfig::without_password(key)?;
761 key_config.created = created; // keep original value
763 let enc_key = rsa_encrypt_key_config(rsa, &key_config)?;
765 (Some(Arc::new(crypt_config)), Some(enc_key))
767 _ => (Some(Arc::new(crypt_config)), None),
772 let client = BackupWriter::start(
774 crypt_config.clone(),
783 let download_previous_manifest = match client.previous_backup_time().await {
784 Ok(Some(backup_time)) => {
786 "Downloading previous
manifest ({}
)",
787 strftime_local("%c
", backup_time)?
792 println!("No previous manifest available
.");
796 // Fallback for outdated server, TODO remove/bubble up with 2.0
801 let previous_manifest = if download_previous_manifest {
802 match client.download_previous_manifest().await {
803 Ok(previous_manifest) => {
804 match previous_manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref)) {
805 Ok(()) => Some(Arc::new(previous_manifest)),
807 println!("Couldn't re
-use previous manifest
- {}
", err);
813 println!("Couldn't download previous manifest
- {}
", err);
821 let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?;
822 let mut manifest = BackupManifest::new(snapshot);
824 let mut catalog = None;
825 let mut catalog_result_rx = None;
827 for (backup_type, filename, target, size) in upload_list {
829 BackupSpecificationType::CONFIG => {
830 let upload_options = UploadOptions {
832 encrypt: crypto.mode == CryptMode::Encrypt,
833 ..UploadOptions::default()
836 println!("Upload config file '{}' to '{}'
as {}
", filename, repo, target);
838 .upload_blob_from_file(&filename, &target, upload_options)
840 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
842 BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
843 let upload_options = UploadOptions {
845 encrypt: crypto.mode == CryptMode::Encrypt,
846 ..UploadOptions::default()
849 println!("Upload log file '{}' to '{}'
as {}
", filename, repo, target);
851 .upload_blob_from_file(&filename, &target, upload_options)
853 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
855 BackupSpecificationType::PXAR => {
856 // start catalog upload on first use
857 if catalog.is_none() {
858 let catalog_upload_res = spawn_catalog_upload(client.clone(), crypto.mode == CryptMode::Encrypt)?;
859 catalog = Some(catalog_upload_res.catalog_writer);
860 catalog_result_rx = Some(catalog_upload_res.result);
862 let catalog = catalog.as_ref().unwrap();
864 println!("Upload directory '{}' to '{}'
as {}
", filename, repo, target);
865 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
867 let pxar_options = pbs_client::pxar::PxarCreateOptions {
868 device_set: devices.clone(),
869 patterns: pattern_list.clone(),
870 entries_max: entries_max as usize,
875 let upload_options = UploadOptions {
876 previous_manifest: previous_manifest.clone(),
878 encrypt: crypto.mode == CryptMode::Encrypt,
879 ..UploadOptions::default()
882 let stats = backup_directory(
891 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
892 catalog.lock().unwrap().end_directory()?;
894 BackupSpecificationType::IMAGE => {
895 println!("Upload image '{}' to '{:?}'
as {}
", filename, repo, target);
897 let upload_options = UploadOptions {
898 previous_manifest: previous_manifest.clone(),
899 fixed_size: Some(size),
901 encrypt: crypto.mode == CryptMode::Encrypt,
904 let stats = backup_image(
911 manifest.add_file(target, stats.size, stats.csum, crypto.mode)?;
916 // finalize and upload catalog
917 if let Some(catalog) = catalog {
918 let mutex = Arc::try_unwrap(catalog)
919 .map_err(|_| format_err!("unable to get
catalog (still used
)"))?;
920 let mut catalog = mutex.into_inner().unwrap();
924 drop(catalog); // close upload stream
926 if let Some(catalog_result_rx) = catalog_result_rx {
927 let stats = catalog_result_rx.await??;
928 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum, crypto.mode)?;
932 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
933 let target = ENCRYPTED_KEY_BLOB_NAME;
934 println!("Upload RSA encoded key to '{:?}'
as {}
", repo, target);
935 let options = UploadOptions { compress: false, encrypt: false, ..UploadOptions::default() };
937 .upload_blob_from_data(rsa_encrypted_key, target, options)
939 manifest.add_file(target.to_string(), stats.size, stats.csum, crypto.mode)?;
942 // create manifest (index.json)
943 // manifests are never encrypted, but include a signature
944 let manifest = manifest.to_string(crypt_config.as_ref().map(Arc::as_ref))
945 .map_err(|err| format_err!("unable to format manifest
- {}
", err))?;
948 if verbose { println!("Upload index.json to '{}'", repo
) };
949 let options
= UploadOptions { compress: true, encrypt: false, ..UploadOptions::default() }
;
951 .upload_blob_from_data(manifest
.into_bytes(), MANIFEST_BLOB_NAME
, options
)
954 client
.finish().await?
;
956 let end_time
= std
::time
::Instant
::now();
957 let elapsed
= end_time
.duration_since(start_time
);
958 println
!("Duration: {:.2}s", elapsed
.as_secs_f64());
960 println
!("End Time: {}", strftime_local("%c", epoch_i64())?
);
965 async
fn dump_image
<W
: Write
>(
966 client
: Arc
<BackupReader
>,
967 crypt_config
: Option
<Arc
<CryptConfig
>>,
968 crypt_mode
: CryptMode
,
969 index
: FixedIndexReader
,
972 ) -> Result
<(), Error
> {
974 let most_used
= index
.find_most_used_chunks(8);
976 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, crypt_mode
, most_used
);
978 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
979 // and thus slows down reading. Instead, directly use RemoteChunkReader
982 let start_time
= std
::time
::Instant
::now();
984 for pos
in 0..index
.index_count() {
985 let digest
= index
.index_digest(pos
).unwrap();
986 let raw_data
= chunk_reader
.read_chunk(&digest
).await?
;
987 writer
.write_all(&raw_data
)?
;
988 bytes
+= raw_data
.len();
990 let next_per
= ((pos
+1)*100)/index
.index_count();
992 eprintln
!("progress {}% (read {} bytes, duration {} sec)",
993 next_per
, bytes
, start_time
.elapsed().as_secs());
999 let end_time
= std
::time
::Instant
::now();
1000 let elapsed
= end_time
.duration_since(start_time
);
1001 eprintln
!("restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)",
1003 elapsed
.as_secs_f64(),
1004 bytes
as f64/(1024.0*1024.0*elapsed
.as_secs_f64())
1011 fn parse_archive_type(name
: &str) -> (String
, ArchiveType
) {
1012 if name
.ends_with(".didx") || name
.ends_with(".fidx") || name
.ends_with(".blob") {
1013 (name
.into(), archive_type(name
).unwrap())
1014 } else if name
.ends_with(".pxar") {
1015 (format
!("{}.didx", name
), ArchiveType
::DynamicIndex
)
1016 } else if name
.ends_with(".img") {
1017 (format
!("{}.fidx", name
), ArchiveType
::FixedIndex
)
1019 (format
!("{}.blob", name
), ArchiveType
::Blob
)
1027 schema
: REPO_URL_SCHEMA
,
1032 description
: "Group/Snapshot path.",
1035 description
: "Backup archive name.",
1040 description
: r
###"Target directory path. Use '-' to write to standard output.
1042 We do not extract '.pxar' archives when writing to standard output.
1046 "allow-existing-dirs": {
1048 description
: "Do not fail if directories already exists.",
1052 schema
: KEYFILE_SCHEMA
,
1056 schema
: KEYFD_SCHEMA
,
1066 /// Restore backup repository.
1067 async
fn restore(param
: Value
) -> Result
<Value
, Error
> {
1068 let repo
= extract_repository_from_value(¶m
)?
;
1070 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
1072 let allow_existing_dirs
= param
["allow-existing-dirs"].as_bool().unwrap_or(false);
1074 let archive_name
= tools
::required_string_param(¶m
, "archive-name")?
;
1076 let client
= connect(&repo
)?
;
1078 record_repository(&repo
);
1080 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
1082 let (backup_type
, backup_id
, backup_time
) = if path
.matches('
/'
).count() == 1 {
1083 let group
: BackupGroup
= path
.parse()?
;
1084 api_datastore_latest_snapshot(&client
, repo
.store(), group
).await?
1086 let snapshot
: BackupDir
= path
.parse()?
;
1087 (snapshot
.group().backup_type().to_owned(), snapshot
.group().backup_id().to_owned(), snapshot
.backup_time())
1090 let target
= tools
::required_string_param(¶m
, "target")?
;
1091 let target
= if target
== "-" { None }
else { Some(target) }
;
1093 let crypto
= crypto_parameters(¶m
)?
;
1095 let crypt_config
= match crypto
.enc_key
{
1099 decrypt_key(&key
.key
, &get_encryption_key_password
).map_err(|err
| {
1100 eprintln
!("{}", format_key_source(&key
.source
, "encryption"));
1103 Some(Arc
::new(CryptConfig
::new(key
)?
))
1107 let client
= BackupReader
::start(
1109 crypt_config
.clone(),
1117 let (archive_name
, archive_type
) = parse_archive_type(archive_name
);
1119 let (manifest
, backup_index_data
) = client
.download_manifest().await?
;
1121 if archive_name
== ENCRYPTED_KEY_BLOB_NAME
&& crypt_config
.is_none() {
1122 eprintln
!("Restoring encrypted key blob without original key - skipping manifest fingerprint check!")
1124 if manifest
.signature
.is_some() {
1125 if let Some(key
) = &crypto
.enc_key
{
1126 eprintln
!("{}", format_key_source(&key
.source
, "encryption"));
1128 if let Some(config
) = &crypt_config
{
1129 eprintln
!("Fingerprint: {}", config
.fingerprint());
1132 manifest
.check_fingerprint(crypt_config
.as_ref().map(Arc
::as_ref
))?
;
1135 if archive_name
== MANIFEST_BLOB_NAME
{
1136 if let Some(target
) = target
{
1137 replace_file(target
, &backup_index_data
, CreateOptions
::new())?
;
1139 let stdout
= std
::io
::stdout();
1140 let mut writer
= stdout
.lock();
1141 writer
.write_all(&backup_index_data
)
1142 .map_err(|err
| format_err
!("unable to pipe data - {}", err
))?
;
1145 return Ok(Value
::Null
);
1148 let file_info
= manifest
.lookup_file_info(&archive_name
)?
;
1150 if archive_type
== ArchiveType
::Blob
{
1152 let mut reader
= client
.download_blob(&manifest
, &archive_name
).await?
;
1154 if let Some(target
) = target
{
1155 let mut writer
= std
::fs
::OpenOptions
::new()
1160 .map_err(|err
| format_err
!("unable to create target file {:?} - {}", target
, err
))?
;
1161 std
::io
::copy(&mut reader
, &mut writer
)?
;
1163 let stdout
= std
::io
::stdout();
1164 let mut writer
= stdout
.lock();
1165 std
::io
::copy(&mut reader
, &mut writer
)
1166 .map_err(|err
| format_err
!("unable to pipe data - {}", err
))?
;
1169 } else if archive_type
== ArchiveType
::DynamicIndex
{
1171 let index
= client
.download_dynamic_index(&manifest
, &archive_name
).await?
;
1173 let most_used
= index
.find_most_used_chunks(8);
1175 let chunk_reader
= RemoteChunkReader
::new(client
.clone(), crypt_config
, file_info
.chunk_crypt_mode(), most_used
);
1177 let mut reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
1179 let options
= pbs_client
::pxar
::PxarExtractOptions
{
1181 extract_match_default
: true,
1182 allow_existing_dirs
,
1186 if let Some(target
) = target
{
1187 pbs_client
::pxar
::extract_archive(
1188 pxar
::decoder
::Decoder
::from_std(reader
)?
,
1190 pbs_client
::pxar
::Flags
::DEFAULT
,
1193 println
!("{:?}", path
);
1198 .map_err(|err
| format_err
!("error extracting archive - {}", err
))?
;
1200 let mut writer
= std
::fs
::OpenOptions
::new()
1202 .open("/dev/stdout")
1203 .map_err(|err
| format_err
!("unable to open /dev/stdout - {}", err
))?
;
1205 std
::io
::copy(&mut reader
, &mut writer
)
1206 .map_err(|err
| format_err
!("unable to pipe data - {}", err
))?
;
1208 } else if archive_type
== ArchiveType
::FixedIndex
{
1210 let index
= client
.download_fixed_index(&manifest
, &archive_name
).await?
;
1212 let mut writer
= if let Some(target
) = target
{
1213 std
::fs
::OpenOptions
::new()
1218 .map_err(|err
| format_err
!("unable to create target file {:?} - {}", target
, err
))?
1220 std
::fs
::OpenOptions
::new()
1222 .open("/dev/stdout")
1223 .map_err(|err
| format_err
!("unable to open /dev/stdout - {}", err
))?
1226 dump_image(client
.clone(), crypt_config
.clone(), file_info
.chunk_crypt_mode(), index
, &mut writer
, verbose
).await?
;
1238 description
: "Just show what prune would do, but do not delete anything.",
1242 description
: "Backup group",
1249 schema
: OUTPUT_FORMAT
,
1256 description
: "Minimal output - only show removals.",
1259 schema
: REPO_URL_SCHEMA
,
1265 /// Prune a backup repository.
1267 dry_run
: Option
<bool
>,
1269 prune_options
: PruneOptions
,
1272 ) -> Result
<Value
, Error
> {
1273 let repo
= extract_repository_from_value(¶m
)?
;
1275 let mut client
= connect(&repo
)?
;
1277 let path
= format
!("api2/json/admin/datastore/{}/prune", repo
.store());
1279 let group
: BackupGroup
= group
.parse()?
;
1281 let output_format
= extract_output_format(&mut param
);
1283 let mut api_param
= serde_json
::to_value(prune_options
)?
;
1284 if let Some(dry_run
) = dry_run
{
1285 api_param
["dry-run"] = dry_run
.into();
1287 api_param
["backup-type"] = group
.backup_type().into();
1288 api_param
["backup-id"] = group
.backup_id().into();
1290 let mut result
= client
.post(&path
, Some(api_param
)).await?
;
1292 record_repository(&repo
);
1294 let render_snapshot_path
= |_v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
1295 let item
: PruneListItem
= serde_json
::from_value(record
.to_owned())?
;
1296 let snapshot
= BackupDir
::new(item
.backup_type
, item
.backup_id
, item
.backup_time
)?
;
1297 Ok(snapshot
.relative_path().to_str().unwrap().to_owned())
1300 let render_prune_action
= |v
: &Value
, _record
: &Value
| -> Result
<String
, Error
> {
1301 Ok(match v
.as_bool() {
1302 Some(true) => "keep",
1303 Some(false) => "remove",
1308 let options
= default_table_format_options()
1309 .sortby("backup-type", false)
1310 .sortby("backup-id", false)
1311 .sortby("backup-time", false)
1312 .column(ColumnConfig
::new("backup-id").renderer(render_snapshot_path
).header("snapshot"))
1313 .column(ColumnConfig
::new("backup-time").renderer(pbs_tools
::format
::render_epoch
).header("date"))
1314 .column(ColumnConfig
::new("keep").renderer(render_prune_action
).header("action"))
1317 let return_type
= &proxmox_backup
::api2
::admin
::datastore
::API_METHOD_PRUNE
.returns
;
1319 let mut data
= result
["data"].take();
1322 let list
: Vec
<Value
> = data
.as_array().unwrap().iter().filter(|item
| {
1323 item
["keep"].as_bool() == Some(false)
1324 }).cloned().collect();
1328 format_and_print_result_full(&mut data
, return_type
, &output_format
, &options
);
1337 schema
: REPO_URL_SCHEMA
,
1341 schema
: OUTPUT_FORMAT
,
1347 type: StorageStatus
,
1350 /// Get repository status.
1351 async
fn status(param
: Value
) -> Result
<Value
, Error
> {
1353 let repo
= extract_repository_from_value(¶m
)?
;
1355 let output_format
= get_output_format(¶m
);
1357 let client
= connect(&repo
)?
;
1359 let path
= format
!("api2/json/admin/datastore/{}/status", repo
.store());
1361 let mut result
= client
.get(&path
, None
).await?
;
1362 let mut data
= result
["data"].take();
1364 record_repository(&repo
);
1366 let render_total_percentage
= |v
: &Value
, record
: &Value
| -> Result
<String
, Error
> {
1367 let v
= v
.as_u64().unwrap();
1368 let total
= record
["total"].as_u64().unwrap();
1369 let roundup
= total
/200;
1370 let per
= ((v
+roundup
)*100)/total
;
1371 let info
= format
!(" ({} %)", per
);
1372 Ok(format
!("{} {:>8}", v
, info
))
1375 let options
= default_table_format_options()
1377 .column(ColumnConfig
::new("total").renderer(render_total_percentage
))
1378 .column(ColumnConfig
::new("used").renderer(render_total_percentage
))
1379 .column(ColumnConfig
::new("avail").renderer(render_total_percentage
));
1381 let return_type
= &API_METHOD_STATUS
.returns
;
1383 format_and_print_result_full(&mut data
, return_type
, &output_format
, &options
);
1388 /// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
1391 /// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
1392 /// so that we can properly access it from multiple threads simultaneously while not issuing
1393 /// duplicate simultaneous reads over http.
1394 pub struct BufferedDynamicReadAt
{
1395 inner
: Mutex
<BufferedDynamicReader
<RemoteChunkReader
>>,
1398 impl BufferedDynamicReadAt
{
1399 fn new(inner
: BufferedDynamicReader
<RemoteChunkReader
>) -> Self {
1401 inner
: Mutex
::new(inner
),
1406 impl ReadAt
for BufferedDynamicReadAt
{
1407 fn start_read_at
<'a
>(
1408 self: Pin
<&'a
Self>,
1412 ) -> MaybeReady
<io
::Result
<usize>, ReadAtOperation
<'a
>> {
1413 MaybeReady
::Ready(tokio
::task
::block_in_place(move || {
1414 let mut reader
= self.inner
.lock().unwrap();
1415 reader
.seek(SeekFrom
::Start(offset
))?
;
1416 Ok(reader
.read(buf
)?
)
1420 fn poll_complete
<'a
>(
1421 self: Pin
<&'a
Self>,
1422 _op
: ReadAtOperation
<'a
>,
1423 ) -> MaybeReady
<io
::Result
<usize>, ReadAtOperation
<'a
>> {
1424 panic
!("LocalDynamicReadAt::start_read_at returned Pending");
1430 let backup_cmd_def
= CliCommand
::new(&API_METHOD_CREATE_BACKUP
)
1431 .arg_param(&["backupspec"])
1432 .completion_cb("repository", complete_repository
)
1433 .completion_cb("backupspec", complete_backup_source
)
1434 .completion_cb("keyfile", pbs_tools
::fs
::complete_file_name
)
1435 .completion_cb("master-pubkey-file", pbs_tools
::fs
::complete_file_name
)
1436 .completion_cb("chunk-size", complete_chunk_size
);
1438 let benchmark_cmd_def
= CliCommand
::new(&API_METHOD_BENCHMARK
)
1439 .completion_cb("repository", complete_repository
)
1440 .completion_cb("keyfile", pbs_tools
::fs
::complete_file_name
);
1442 let list_cmd_def
= CliCommand
::new(&API_METHOD_LIST_BACKUP_GROUPS
)
1443 .completion_cb("repository", complete_repository
);
1445 let garbage_collect_cmd_def
= CliCommand
::new(&API_METHOD_START_GARBAGE_COLLECTION
)
1446 .completion_cb("repository", complete_repository
);
1448 let restore_cmd_def
= CliCommand
::new(&API_METHOD_RESTORE
)
1449 .arg_param(&["snapshot", "archive-name", "target"])
1450 .completion_cb("repository", complete_repository
)
1451 .completion_cb("snapshot", complete_group_or_snapshot
)
1452 .completion_cb("archive-name", complete_archive_name
)
1453 .completion_cb("target", pbs_tools
::fs
::complete_file_name
);
1455 let prune_cmd_def
= CliCommand
::new(&API_METHOD_PRUNE
)
1456 .arg_param(&["group"])
1457 .completion_cb("group", complete_backup_group
)
1458 .completion_cb("repository", complete_repository
);
1460 let status_cmd_def
= CliCommand
::new(&API_METHOD_STATUS
)
1461 .completion_cb("repository", complete_repository
);
1463 let login_cmd_def
= CliCommand
::new(&API_METHOD_API_LOGIN
)
1464 .completion_cb("repository", complete_repository
);
1466 let logout_cmd_def
= CliCommand
::new(&API_METHOD_API_LOGOUT
)
1467 .completion_cb("repository", complete_repository
);
1469 let version_cmd_def
= CliCommand
::new(&API_METHOD_API_VERSION
)
1470 .completion_cb("repository", complete_repository
);
1472 let change_owner_cmd_def
= CliCommand
::new(&API_METHOD_CHANGE_BACKUP_OWNER
)
1473 .arg_param(&["group", "new-owner"])
1474 .completion_cb("group", complete_backup_group
)
1475 .completion_cb("new-owner", complete_auth_id
)
1476 .completion_cb("repository", complete_repository
);
1478 let cmd_def
= CliCommandMap
::new()
1479 .insert("backup", backup_cmd_def
)
1480 .insert("garbage-collect", garbage_collect_cmd_def
)
1481 .insert("list", list_cmd_def
)
1482 .insert("login", login_cmd_def
)
1483 .insert("logout", logout_cmd_def
)
1484 .insert("prune", prune_cmd_def
)
1485 .insert("restore", restore_cmd_def
)
1486 .insert("snapshot", snapshot_mgtm_cli())
1487 .insert("status", status_cmd_def
)
1488 .insert("key", key
::cli())
1489 .insert("mount", mount_cmd_def())
1490 .insert("map", map_cmd_def())
1491 .insert("unmap", unmap_cmd_def())
1492 .insert("catalog", catalog_mgmt_cli())
1493 .insert("task", task_mgmt_cli())
1494 .insert("version", version_cmd_def
)
1495 .insert("benchmark", benchmark_cmd_def
)
1496 .insert("change-owner", change_owner_cmd_def
)
1498 .alias(&["files"], &["snapshot", "files"])
1499 .alias(&["forget"], &["snapshot", "forget"])
1500 .alias(&["upload-log"], &["snapshot", "upload-log"])
1501 .alias(&["snapshots"], &["snapshot", "list"])
1504 let rpcenv
= CliEnvironment
::new();
1505 run_cli_command(cmd_def
, rpcenv
, Some(|future
| {
1506 pbs_runtime
::main(future
)