1 //! Datastore Management
3 use std
::collections
::HashSet
;
5 use std
::os
::unix
::ffi
::OsStrExt
;
6 use std
::path
::PathBuf
;
8 use anyhow
::{bail, format_err, Error}
;
10 use hyper
::http
::request
::Parts
;
11 use hyper
::{header, Body, Response, StatusCode}
;
12 use serde_json
::{json, Value}
;
13 use tokio_stream
::wrappers
::ReceiverStream
;
16 api
, ApiResponseFuture
, ApiHandler
, ApiMethod
, Router
,
17 RpcEnvironment
, RpcEnvironmentType
, Permission
19 use proxmox
::api
::router
::SubdirMap
;
20 use proxmox
::api
::schema
::*;
21 use proxmox
::tools
::fs
::{
22 file_read_firstline
, file_read_optional_string
, replace_file
, CreateOptions
,
24 use proxmox
::{http_err, identity, list_subdirs_api_method, sortable}
;
26 use pxar
::accessor
::aio
::Accessor
;
29 use pbs_api_types
::{ Authid
, BackupContent
, Counts
, CryptMode
,
30 DataStoreListItem
, GarbageCollectionStatus
, GroupListItem
,
31 SnapshotListItem
, SnapshotVerifyState
, PruneOptions
,
32 DataStoreStatus
, RRDMode
, RRDTimeFrameResolution
,
33 BACKUP_ARCHIVE_NAME_SCHEMA
, BACKUP_ID_SCHEMA
, BACKUP_TIME_SCHEMA
,
34 BACKUP_TYPE_SCHEMA
, DATASTORE_SCHEMA
,
35 IGNORE_VERIFIED_BACKUPS_SCHEMA
, UPID_SCHEMA
,
36 VERIFICATION_OUTDATED_AFTER_SCHEMA
, PRIV_DATASTORE_AUDIT
,
37 PRIV_DATASTORE_MODIFY
, PRIV_DATASTORE_READ
, PRIV_DATASTORE_PRUNE
,
38 PRIV_DATASTORE_BACKUP
, PRIV_DATASTORE_VERIFY
,
41 use pbs_client
::pxar
::create_zip
;
42 use pbs_datastore
::{BackupDir, BackupGroup, StoreProgress, CATALOG_NAME}
;
43 use pbs_datastore
::backup_info
::BackupInfo
;
44 use pbs_datastore
::cached_chunk_reader
::CachedChunkReader
;
45 use pbs_datastore
::catalog
::{ArchiveEntry, CatalogReader}
;
46 use pbs_datastore
::data_blob
::DataBlob
;
47 use pbs_datastore
::data_blob_reader
::DataBlobReader
;
48 use pbs_datastore
::dynamic_index
::{BufferedDynamicReader, DynamicIndexReader, LocalDynamicReadAt}
;
49 use pbs_datastore
::fixed_index
::{FixedIndexReader}
;
50 use pbs_datastore
::index
::IndexFile
;
51 use pbs_datastore
::manifest
::{BackupManifest, CLIENT_LOG_BLOB_NAME, MANIFEST_BLOB_NAME}
;
52 use pbs_datastore
::prune
::compute_prune_info
;
53 use pbs_tools
::blocking
::WrappedReaderStream
;
54 use pbs_tools
::stream
::{AsyncReaderStream, AsyncChannelWriter}
;
55 use pbs_tools
::json
::{required_integer_param, required_string_param}
;
56 use pbs_config
::CachedUserInfo
;
58 use crate::api2
::node
::rrd
::create_value_from_rrd
;
60 check_backup_owner
, verify_all_backups
, verify_backup_group
, verify_backup_dir
, verify_filter
,
61 DataStore
, LocalChunkReader
,
64 use crate::server
::{jobstate::Job, WorkerTask}
;
67 const GROUP_NOTES_FILE_NAME
: &str = "notes";
69 fn get_group_note_path(store
: &DataStore
, group
: &BackupGroup
) -> PathBuf
{
70 let mut note_path
= store
.base_path();
71 note_path
.push(group
.group_path());
72 note_path
.push(GROUP_NOTES_FILE_NAME
);
76 fn check_priv_or_backup_owner(
81 ) -> Result
<(), Error
> {
82 let user_info
= CachedUserInfo
::new()?
;
83 let privs
= user_info
.lookup_privs(&auth_id
, &["datastore", store
.name()]);
85 if privs
& required_privs
== 0 {
86 let owner
= store
.get_owner(group
)?
;
87 check_backup_owner(&owner
, auth_id
)?
;
94 backup_dir
: &BackupDir
,
95 ) -> Result
<(BackupManifest
, Vec
<BackupContent
>), Error
> {
97 let (manifest
, index_size
) = store
.load_manifest(backup_dir
)?
;
99 let mut result
= Vec
::new();
100 for item
in manifest
.files() {
101 result
.push(BackupContent
{
102 filename
: item
.filename
.clone(),
103 crypt_mode
: Some(item
.crypt_mode
),
104 size
: Some(item
.size
),
108 result
.push(BackupContent
{
109 filename
: MANIFEST_BLOB_NAME
.to_string(),
110 crypt_mode
: match manifest
.signature
{
111 Some(_
) => Some(CryptMode
::SignOnly
),
112 None
=> Some(CryptMode
::None
),
114 size
: Some(index_size
),
117 Ok((manifest
, result
))
120 fn get_all_snapshot_files(
123 ) -> Result
<(BackupManifest
, Vec
<BackupContent
>), Error
> {
125 let (manifest
, mut files
) = read_backup_index(&store
, &info
.backup_dir
)?
;
127 let file_set
= files
.iter().fold(HashSet
::new(), |mut acc
, item
| {
128 acc
.insert(item
.filename
.clone());
132 for file
in &info
.files
{
133 if file_set
.contains(file
) { continue; }
134 files
.push(BackupContent
{
135 filename
: file
.to_string(),
141 Ok((manifest
, files
))
148 schema
: DATASTORE_SCHEMA
,
152 returns
: pbs_api_types
::ADMIN_DATASTORE_LIST_GROUPS_RETURN_TYPE
,
154 permission
: &Permission
::Privilege(
155 &["datastore", "{store}"],
156 PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
,
160 /// List backup groups.
163 rpcenv
: &mut dyn RpcEnvironment
,
164 ) -> Result
<Vec
<GroupListItem
>, Error
> {
166 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
167 let user_info
= CachedUserInfo
::new()?
;
168 let user_privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
170 let datastore
= DataStore
::lookup_datastore(&store
)?
;
171 let list_all
= (user_privs
& PRIV_DATASTORE_AUDIT
) != 0;
173 let backup_groups
= BackupInfo
::list_backup_groups(&datastore
.base_path())?
;
175 let group_info
= backup_groups
177 .fold(Vec
::new(), |mut group_info
, group
| {
178 let owner
= match datastore
.get_owner(&group
) {
179 Ok(auth_id
) => auth_id
,
181 eprintln
!("Failed to get owner of group '{}/{}' - {}",
188 if !list_all
&& check_backup_owner(&owner
, &auth_id
).is_err() {
192 let snapshots
= match group
.list_backups(&datastore
.base_path()) {
193 Ok(snapshots
) => snapshots
,
199 let backup_count
: u64 = snapshots
.len() as u64;
200 if backup_count
== 0 {
204 let last_backup
= snapshots
206 .fold(&snapshots
[0], |last
, curr
| {
207 if curr
.is_finished()
208 && curr
.backup_dir
.backup_time() > last
.backup_dir
.backup_time() {
216 let note_path
= get_group_note_path(&datastore
, &group
);
217 let comment
= file_read_firstline(¬e_path
).ok();
219 group_info
.push(GroupListItem
{
220 backup_type
: group
.backup_type().to_string(),
221 backup_id
: group
.backup_id().to_string(),
222 last_backup
: last_backup
.backup_dir
.backup_time(),
225 files
: last_backup
.files
,
239 schema
: DATASTORE_SCHEMA
,
242 schema
: BACKUP_TYPE_SCHEMA
,
245 schema
: BACKUP_ID_SCHEMA
,
250 permission
: &Permission
::Privilege(
251 &["datastore", "{store}"],
252 PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_PRUNE
,
256 /// Delete backup group including all snapshots.
262 rpcenv
: &mut dyn RpcEnvironment
,
263 ) -> Result
<Value
, Error
> {
265 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
267 let group
= BackupGroup
::new(backup_type
, backup_id
);
268 let datastore
= DataStore
::lookup_datastore(&store
)?
;
270 check_priv_or_backup_owner(&datastore
, &group
, &auth_id
, PRIV_DATASTORE_MODIFY
)?
;
272 datastore
.remove_backup_group(&group
)?
;
281 schema
: DATASTORE_SCHEMA
,
284 schema
: BACKUP_TYPE_SCHEMA
,
287 schema
: BACKUP_ID_SCHEMA
,
290 schema
: BACKUP_TIME_SCHEMA
,
294 returns
: pbs_api_types
::ADMIN_DATASTORE_LIST_SNAPSHOT_FILES_RETURN_TYPE
,
296 permission
: &Permission
::Privilege(
297 &["datastore", "{store}"],
298 PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_READ
| PRIV_DATASTORE_BACKUP
,
302 /// List snapshot files.
303 pub fn list_snapshot_files(
309 rpcenv
: &mut dyn RpcEnvironment
,
310 ) -> Result
<Vec
<BackupContent
>, Error
> {
312 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
313 let datastore
= DataStore
::lookup_datastore(&store
)?
;
315 let snapshot
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
317 check_priv_or_backup_owner(&datastore
, snapshot
.group(), &auth_id
, PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_READ
)?
;
319 let info
= BackupInfo
::new(&datastore
.base_path(), snapshot
)?
;
321 let (_manifest
, files
) = get_all_snapshot_files(&datastore
, &info
)?
;
330 schema
: DATASTORE_SCHEMA
,
333 schema
: BACKUP_TYPE_SCHEMA
,
336 schema
: BACKUP_ID_SCHEMA
,
339 schema
: BACKUP_TIME_SCHEMA
,
344 permission
: &Permission
::Privilege(
345 &["datastore", "{store}"],
346 PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_PRUNE
,
350 /// Delete backup snapshot.
351 pub fn delete_snapshot(
357 rpcenv
: &mut dyn RpcEnvironment
,
358 ) -> Result
<Value
, Error
> {
360 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
362 let snapshot
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
363 let datastore
= DataStore
::lookup_datastore(&store
)?
;
365 check_priv_or_backup_owner(&datastore
, snapshot
.group(), &auth_id
, PRIV_DATASTORE_MODIFY
)?
;
367 datastore
.remove_backup_dir(&snapshot
, false)?
;
376 schema
: DATASTORE_SCHEMA
,
380 schema
: BACKUP_TYPE_SCHEMA
,
384 schema
: BACKUP_ID_SCHEMA
,
388 returns
: pbs_api_types
::ADMIN_DATASTORE_LIST_SNAPSHOTS_RETURN_TYPE
,
390 permission
: &Permission
::Privilege(
391 &["datastore", "{store}"],
392 PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
,
396 /// List backup snapshots.
397 pub fn list_snapshots (
399 backup_type
: Option
<String
>,
400 backup_id
: Option
<String
>,
403 rpcenv
: &mut dyn RpcEnvironment
,
404 ) -> Result
<Vec
<SnapshotListItem
>, Error
> {
406 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
407 let user_info
= CachedUserInfo
::new()?
;
408 let user_privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
410 let list_all
= (user_privs
& PRIV_DATASTORE_AUDIT
) != 0;
412 let datastore
= DataStore
::lookup_datastore(&store
)?
;
414 let base_path
= datastore
.base_path();
416 let groups
= match (backup_type
, backup_id
) {
417 (Some(backup_type
), Some(backup_id
)) => {
418 let mut groups
= Vec
::with_capacity(1);
419 groups
.push(BackupGroup
::new(backup_type
, backup_id
));
422 (Some(backup_type
), None
) => {
423 BackupInfo
::list_backup_groups(&base_path
)?
425 .filter(|group
| group
.backup_type() == backup_type
)
428 (None
, Some(backup_id
)) => {
429 BackupInfo
::list_backup_groups(&base_path
)?
431 .filter(|group
| group
.backup_id() == backup_id
)
434 _
=> BackupInfo
::list_backup_groups(&base_path
)?
,
437 let info_to_snapshot_list_item
= |group
: &BackupGroup
, owner
, info
: BackupInfo
| {
438 let backup_type
= group
.backup_type().to_string();
439 let backup_id
= group
.backup_id().to_string();
440 let backup_time
= info
.backup_dir
.backup_time();
442 match get_all_snapshot_files(&datastore
, &info
) {
443 Ok((manifest
, files
)) => {
444 // extract the first line from notes
445 let comment
: Option
<String
> = manifest
.unprotected
["notes"]
447 .and_then(|notes
| notes
.lines().next())
450 let fingerprint
= match manifest
.fingerprint() {
453 eprintln
!("error parsing fingerprint: '{}'", err
);
458 let verification
= manifest
.unprotected
["verify_state"].clone();
459 let verification
: Option
<SnapshotVerifyState
> = match serde_json
::from_value(verification
) {
460 Ok(verify
) => verify
,
462 eprintln
!("error parsing verification state : '{}'", err
);
467 let size
= Some(files
.iter().map(|x
| x
.size
.unwrap_or(0)).sum());
482 eprintln
!("error during snapshot file listing: '{}'", err
);
486 .map(|filename
| BackupContent
{
510 .try_fold(Vec
::new(), |mut snapshots
, group
| {
511 let owner
= match datastore
.get_owner(group
) {
512 Ok(auth_id
) => auth_id
,
514 eprintln
!("Failed to get owner of group '{}/{}' - {}",
518 return Ok(snapshots
);
522 if !list_all
&& check_backup_owner(&owner
, &auth_id
).is_err() {
523 return Ok(snapshots
);
526 let group_backups
= group
.list_backups(&datastore
.base_path())?
;
531 .map(|info
| info_to_snapshot_list_item(&group
, Some(owner
.clone()), info
))
538 fn get_snapshots_count(store
: &DataStore
, filter_owner
: Option
<&Authid
>) -> Result
<Counts
, Error
> {
539 let base_path
= store
.base_path();
540 let groups
= BackupInfo
::list_backup_groups(&base_path
)?
;
544 let owner
= match store
.get_owner(&group
) {
547 eprintln
!("Failed to get owner of group '{}/{}' - {}",
556 Some(filter
) => check_backup_owner(&owner
, filter
).is_ok(),
560 .try_fold(Counts
::default(), |mut counts
, group
| {
561 let snapshot_count
= group
.list_backups(&base_path
)?
.len() as u64;
563 let type_count
= match group
.backup_type() {
564 "ct" => counts
.ct
.get_or_insert(Default
::default()),
565 "vm" => counts
.vm
.get_or_insert(Default
::default()),
566 "host" => counts
.host
.get_or_insert(Default
::default()),
567 _
=> counts
.other
.get_or_insert(Default
::default()),
570 type_count
.groups
+= 1;
571 type_count
.snapshots
+= snapshot_count
;
581 schema
: DATASTORE_SCHEMA
,
587 description
: "Include additional information like snapshot counts and GC status.",
593 type: DataStoreStatus
,
596 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
, true),
599 /// Get datastore status.
604 rpcenv
: &mut dyn RpcEnvironment
,
605 ) -> Result
<DataStoreStatus
, Error
> {
606 let datastore
= DataStore
::lookup_datastore(&store
)?
;
607 let storage
= crate::tools
::disks
::disk_usage(&datastore
.base_path())?
;
608 let (counts
, gc_status
) = if verbose
{
609 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
610 let user_info
= CachedUserInfo
::new()?
;
612 let store_privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
613 let filter_owner
= if store_privs
& PRIV_DATASTORE_AUDIT
!= 0 {
619 let counts
= Some(get_snapshots_count(&datastore
, filter_owner
)?
);
620 let gc_status
= Some(datastore
.last_gc_status());
628 total
: storage
.total
,
630 avail
: storage
.avail
,
640 schema
: DATASTORE_SCHEMA
,
643 schema
: BACKUP_TYPE_SCHEMA
,
647 schema
: BACKUP_ID_SCHEMA
,
651 schema
: IGNORE_VERIFIED_BACKUPS_SCHEMA
,
655 schema
: VERIFICATION_OUTDATED_AFTER_SCHEMA
,
659 schema
: BACKUP_TIME_SCHEMA
,
668 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_VERIFY
| PRIV_DATASTORE_BACKUP
, true),
673 /// This function can verify a single backup snapshot, all backup from a backup group,
674 /// or all backups in the datastore.
677 backup_type
: Option
<String
>,
678 backup_id
: Option
<String
>,
679 backup_time
: Option
<i64>,
680 ignore_verified
: Option
<bool
>,
681 outdated_after
: Option
<i64>,
682 rpcenv
: &mut dyn RpcEnvironment
,
683 ) -> Result
<Value
, Error
> {
684 let datastore
= DataStore
::lookup_datastore(&store
)?
;
685 let ignore_verified
= ignore_verified
.unwrap_or(true);
687 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
690 let mut backup_dir
= None
;
691 let mut backup_group
= None
;
692 let mut worker_type
= "verify";
694 match (backup_type
, backup_id
, backup_time
) {
695 (Some(backup_type
), Some(backup_id
), Some(backup_time
)) => {
696 worker_id
= format
!("{}:{}/{}/{:08X}", store
, backup_type
, backup_id
, backup_time
);
697 let dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
699 check_priv_or_backup_owner(&datastore
, dir
.group(), &auth_id
, PRIV_DATASTORE_VERIFY
)?
;
701 backup_dir
= Some(dir
);
702 worker_type
= "verify_snapshot";
704 (Some(backup_type
), Some(backup_id
), None
) => {
705 worker_id
= format
!("{}:{}/{}", store
, backup_type
, backup_id
);
706 let group
= BackupGroup
::new(backup_type
, backup_id
);
708 check_priv_or_backup_owner(&datastore
, &group
, &auth_id
, PRIV_DATASTORE_VERIFY
)?
;
710 backup_group
= Some(group
);
711 worker_type
= "verify_group";
713 (None
, None
, None
) => {
714 worker_id
= store
.clone();
716 _
=> bail
!("parameters do not specify a backup group or snapshot"),
719 let to_stdout
= rpcenv
.env_type() == RpcEnvironmentType
::CLI
;
721 let upid_str
= WorkerTask
::new_thread(
727 let verify_worker
= crate::backup
::VerifyWorker
::new(worker
.clone(), datastore
);
728 let failed_dirs
= if let Some(backup_dir
) = backup_dir
{
729 let mut res
= Vec
::new();
730 if !verify_backup_dir(
733 worker
.upid().clone(),
734 Some(&move |manifest
| {
735 verify_filter(ignore_verified
, outdated_after
, manifest
)
738 res
.push(backup_dir
.to_string());
741 } else if let Some(backup_group
) = backup_group
{
742 let failed_dirs
= verify_backup_group(
745 &mut StoreProgress
::new(1),
747 Some(&move |manifest
| {
748 verify_filter(ignore_verified
, outdated_after
, manifest
)
753 let privs
= CachedUserInfo
::new()?
754 .lookup_privs(&auth_id
, &["datastore", &store
]);
756 let owner
= if privs
& PRIV_DATASTORE_VERIFY
== 0 {
766 Some(&move |manifest
| {
767 verify_filter(ignore_verified
, outdated_after
, manifest
)
771 if !failed_dirs
.is_empty() {
772 worker
.log("Failed to verify the following snapshots/groups:");
773 for dir
in failed_dirs
{
774 worker
.log(format
!("\t{}", dir
));
776 bail
!("verification failed - please check the log for details");
789 schema
: BACKUP_ID_SCHEMA
,
792 schema
: BACKUP_TYPE_SCHEMA
,
798 description
: "Just show what prune would do, but do not delete anything.",
805 schema
: DATASTORE_SCHEMA
,
809 returns
: pbs_api_types
::ADMIN_DATASTORE_PRUNE_RETURN_TYPE
,
811 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_PRUNE
, true),
814 /// Prune a group on the datastore
819 prune_options
: PruneOptions
,
822 rpcenv
: &mut dyn RpcEnvironment
,
823 ) -> Result
<Value
, Error
> {
825 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
827 let group
= BackupGroup
::new(&backup_type
, &backup_id
);
829 let datastore
= DataStore
::lookup_datastore(&store
)?
;
831 check_priv_or_backup_owner(&datastore
, &group
, &auth_id
, PRIV_DATASTORE_MODIFY
)?
;
833 let worker_id
= format
!("{}:{}/{}", store
, &backup_type
, &backup_id
);
835 let mut prune_result
= Vec
::new();
837 let list
= group
.list_backups(&datastore
.base_path())?
;
839 let mut prune_info
= compute_prune_info(list
, &prune_options
)?
;
841 prune_info
.reverse(); // delete older snapshots first
843 let keep_all
= !pbs_datastore
::prune
::keeps_something(&prune_options
);
846 for (info
, mut keep
) in prune_info
{
847 if keep_all { keep = true; }
849 let backup_time
= info
.backup_dir
.backup_time();
850 let group
= info
.backup_dir
.group();
852 prune_result
.push(json
!({
853 "backup-type": group
.backup_type(),
854 "backup-id": group
.backup_id(),
855 "backup-time": backup_time
,
859 return Ok(json
!(prune_result
));
863 // We use a WorkerTask just to have a task log, but run synchrounously
864 let worker
= WorkerTask
::new("prune", Some(worker_id
), auth_id
, true)?
;
867 worker
.log("No prune selection - keeping all files.");
869 worker
.log(format
!("retention options: {}", pbs_datastore
::prune
::cli_options_string(&prune_options
)));
870 worker
.log(format
!("Starting prune on store \"{}\" group \"{}/{}\"",
871 store
, backup_type
, backup_id
));
874 for (info
, mut keep
) in prune_info
{
875 if keep_all { keep = true; }
877 let backup_time
= info
.backup_dir
.backup_time();
878 let timestamp
= info
.backup_dir
.backup_time_string();
879 let group
= info
.backup_dir
.group();
887 if keep { "keep" }
else { "remove" }
,
892 prune_result
.push(json
!({
893 "backup-type": group
.backup_type(),
894 "backup-id": group
.backup_id(),
895 "backup-time": backup_time
,
899 if !(dry_run
|| keep
) {
900 if let Err(err
) = datastore
.remove_backup_dir(&info
.backup_dir
, false) {
903 "failed to remove dir {:?}: {}",
904 info
.backup_dir
.relative_path(), err
911 worker
.log_result(&Ok(()));
913 Ok(json
!(prune_result
))
923 description
: "Just show what prune would do, but do not delete anything.",
930 schema
: DATASTORE_SCHEMA
,
938 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_PRUNE
, true),
941 /// Prune the datastore
942 pub fn prune_datastore(
944 prune_options
: PruneOptions
,
947 rpcenv
: &mut dyn RpcEnvironment
,
948 ) -> Result
<String
, Error
> {
950 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
952 let datastore
= DataStore
::lookup_datastore(&store
)?
;
954 let upid_str
= WorkerTask
::new_thread(
959 move |worker
| crate::server
::prune_datastore(
976 schema
: DATASTORE_SCHEMA
,
984 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY
, false),
987 /// Start garbage collection.
988 pub fn start_garbage_collection(
991 rpcenv
: &mut dyn RpcEnvironment
,
992 ) -> Result
<Value
, Error
> {
994 let datastore
= DataStore
::lookup_datastore(&store
)?
;
995 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
997 let job
= Job
::new("garbage_collection", &store
)
998 .map_err(|_
| format_err
!("garbage collection already running"))?
;
1000 let to_stdout
= rpcenv
.env_type() == RpcEnvironmentType
::CLI
;
1002 let upid_str
= crate::server
::do_garbage_collection_job(job
, datastore
, &auth_id
, None
, to_stdout
)
1003 .map_err(|err
| format_err
!("unable to start garbage collection job on datastore {} - {}", store
, err
))?
;
1012 schema
: DATASTORE_SCHEMA
,
1017 type: GarbageCollectionStatus
,
1020 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT
, false),
1023 /// Garbage collection status.
1024 pub fn garbage_collection_status(
1027 _rpcenv
: &mut dyn RpcEnvironment
,
1028 ) -> Result
<GarbageCollectionStatus
, Error
> {
1030 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1032 let status
= datastore
.last_gc_status();
1039 description
: "List the accessible datastores.",
1041 items
: { type: DataStoreListItem }
,
1044 permission
: &Permission
::Anybody
,
1048 pub fn get_datastore_list(
1051 rpcenv
: &mut dyn RpcEnvironment
,
1052 ) -> Result
<Vec
<DataStoreListItem
>, Error
> {
1054 let (config
, _digest
) = pbs_config
::datastore
::config()?
;
1056 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1057 let user_info
= CachedUserInfo
::new()?
;
1059 let mut list
= Vec
::new();
1061 for (store
, (_
, data
)) in &config
.sections
{
1062 let user_privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
1063 let allowed
= (user_privs
& (PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
)) != 0;
1067 store
: store
.clone(),
1068 comment
: data
["comment"].as_str().map(String
::from
),
1078 pub const API_METHOD_DOWNLOAD_FILE
: ApiMethod
= ApiMethod
::new(
1079 &ApiHandler
::AsyncHttp(&download_file
),
1081 "Download single raw file from backup snapshot.",
1083 ("store", false, &DATASTORE_SCHEMA
),
1084 ("backup-type", false, &BACKUP_TYPE_SCHEMA
),
1085 ("backup-id", false, &BACKUP_ID_SCHEMA
),
1086 ("backup-time", false, &BACKUP_TIME_SCHEMA
),
1087 ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA
),
1090 ).access(None
, &Permission
::Privilege(
1091 &["datastore", "{store}"],
1092 PRIV_DATASTORE_READ
| PRIV_DATASTORE_BACKUP
,
1096 pub fn download_file(
1101 rpcenv
: Box
<dyn RpcEnvironment
>,
1102 ) -> ApiResponseFuture
{
1105 let store
= required_string_param(¶m
, "store")?
;
1106 let datastore
= DataStore
::lookup_datastore(store
)?
;
1108 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1110 let file_name
= required_string_param(¶m
, "file-name")?
.to_owned();
1112 let backup_type
= required_string_param(¶m
, "backup-type")?
;
1113 let backup_id
= required_string_param(¶m
, "backup-id")?
;
1114 let backup_time
= required_integer_param(¶m
, "backup-time")?
;
1116 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1118 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_READ
)?
;
1120 println
!("Download {} from {} ({}/{})", file_name
, store
, backup_dir
, file_name
);
1122 let mut path
= datastore
.base_path();
1123 path
.push(backup_dir
.relative_path());
1124 path
.push(&file_name
);
1126 let file
= tokio
::fs
::File
::open(&path
)
1128 .map_err(|err
| http_err
!(BAD_REQUEST
, "File open failed: {}", err
))?
;
1130 let payload
= tokio_util
::codec
::FramedRead
::new(file
, tokio_util
::codec
::BytesCodec
::new())
1131 .map_ok(|bytes
| bytes
.freeze())
1132 .map_err(move |err
| {
1133 eprintln
!("error during streaming of '{:?}' - {}", &path
, err
);
1136 let body
= Body
::wrap_stream(payload
);
1138 // fixme: set other headers ?
1139 Ok(Response
::builder()
1140 .status(StatusCode
::OK
)
1141 .header(header
::CONTENT_TYPE
, "application/octet-stream")
1148 pub const API_METHOD_DOWNLOAD_FILE_DECODED
: ApiMethod
= ApiMethod
::new(
1149 &ApiHandler
::AsyncHttp(&download_file_decoded
),
1151 "Download single decoded file from backup snapshot. Only works if it's not encrypted.",
1153 ("store", false, &DATASTORE_SCHEMA
),
1154 ("backup-type", false, &BACKUP_TYPE_SCHEMA
),
1155 ("backup-id", false, &BACKUP_ID_SCHEMA
),
1156 ("backup-time", false, &BACKUP_TIME_SCHEMA
),
1157 ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA
),
1160 ).access(None
, &Permission
::Privilege(
1161 &["datastore", "{store}"],
1162 PRIV_DATASTORE_READ
| PRIV_DATASTORE_BACKUP
,
1166 pub fn download_file_decoded(
1171 rpcenv
: Box
<dyn RpcEnvironment
>,
1172 ) -> ApiResponseFuture
{
1175 let store
= required_string_param(¶m
, "store")?
;
1176 let datastore
= DataStore
::lookup_datastore(store
)?
;
1178 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1180 let file_name
= required_string_param(¶m
, "file-name")?
.to_owned();
1182 let backup_type
= required_string_param(¶m
, "backup-type")?
;
1183 let backup_id
= required_string_param(¶m
, "backup-id")?
;
1184 let backup_time
= required_integer_param(¶m
, "backup-time")?
;
1186 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1188 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_READ
)?
;
1190 let (manifest
, files
) = read_backup_index(&datastore
, &backup_dir
)?
;
1192 if file
.filename
== file_name
&& file
.crypt_mode
== Some(CryptMode
::Encrypt
) {
1193 bail
!("cannot decode '{}' - is encrypted", file_name
);
1197 println
!("Download {} from {} ({}/{})", file_name
, store
, backup_dir
, file_name
);
1199 let mut path
= datastore
.base_path();
1200 path
.push(backup_dir
.relative_path());
1201 path
.push(&file_name
);
1203 let extension
= file_name
.rsplitn(2, '
.'
).next().unwrap();
1205 let body
= match extension
{
1207 let index
= DynamicIndexReader
::open(&path
)
1208 .map_err(|err
| format_err
!("unable to read dynamic index '{:?}' - {}", &path
, err
))?
;
1209 let (csum
, size
) = index
.compute_csum();
1210 manifest
.verify_file(&file_name
, &csum
, size
)?
;
1212 let chunk_reader
= LocalChunkReader
::new(datastore
, None
, CryptMode
::None
);
1213 let reader
= CachedChunkReader
::new(chunk_reader
, index
, 1).seekable();
1214 Body
::wrap_stream(AsyncReaderStream
::new(reader
)
1215 .map_err(move |err
| {
1216 eprintln
!("error during streaming of '{:?}' - {}", path
, err
);
1221 let index
= FixedIndexReader
::open(&path
)
1222 .map_err(|err
| format_err
!("unable to read fixed index '{:?}' - {}", &path
, err
))?
;
1224 let (csum
, size
) = index
.compute_csum();
1225 manifest
.verify_file(&file_name
, &csum
, size
)?
;
1227 let chunk_reader
= LocalChunkReader
::new(datastore
, None
, CryptMode
::None
);
1228 let reader
= CachedChunkReader
::new(chunk_reader
, index
, 1).seekable();
1229 Body
::wrap_stream(AsyncReaderStream
::with_buffer_size(reader
, 4*1024*1024)
1230 .map_err(move |err
| {
1231 eprintln
!("error during streaming of '{:?}' - {}", path
, err
);
1236 let file
= std
::fs
::File
::open(&path
)
1237 .map_err(|err
| http_err
!(BAD_REQUEST
, "File open failed: {}", err
))?
;
1239 // FIXME: load full blob to verify index checksum?
1242 WrappedReaderStream
::new(DataBlobReader
::new(file
, None
)?
)
1243 .map_err(move |err
| {
1244 eprintln
!("error during streaming of '{:?}' - {}", path
, err
);
1250 bail
!("cannot download '{}' files", extension
);
1254 // fixme: set other headers ?
1255 Ok(Response
::builder()
1256 .status(StatusCode
::OK
)
1257 .header(header
::CONTENT_TYPE
, "application/octet-stream")
1264 pub const API_METHOD_UPLOAD_BACKUP_LOG
: ApiMethod
= ApiMethod
::new(
1265 &ApiHandler
::AsyncHttp(&upload_backup_log
),
1267 "Upload the client backup log file into a backup snapshot ('client.log.blob').",
1269 ("store", false, &DATASTORE_SCHEMA
),
1270 ("backup-type", false, &BACKUP_TYPE_SCHEMA
),
1271 ("backup-id", false, &BACKUP_ID_SCHEMA
),
1272 ("backup-time", false, &BACKUP_TIME_SCHEMA
),
1276 Some("Only the backup creator/owner is allowed to do this."),
1277 &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_BACKUP
, false)
1280 pub fn upload_backup_log(
1285 rpcenv
: Box
<dyn RpcEnvironment
>,
1286 ) -> ApiResponseFuture
{
1289 let store
= required_string_param(¶m
, "store")?
;
1290 let datastore
= DataStore
::lookup_datastore(store
)?
;
1292 let file_name
= CLIENT_LOG_BLOB_NAME
;
1294 let backup_type
= required_string_param(¶m
, "backup-type")?
;
1295 let backup_id
= required_string_param(¶m
, "backup-id")?
;
1296 let backup_time
= required_integer_param(¶m
, "backup-time")?
;
1298 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1300 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1301 let owner
= datastore
.get_owner(backup_dir
.group())?
;
1302 check_backup_owner(&owner
, &auth_id
)?
;
1304 let mut path
= datastore
.base_path();
1305 path
.push(backup_dir
.relative_path());
1306 path
.push(&file_name
);
1309 bail
!("backup already contains a log.");
1312 println
!("Upload backup log to {}/{}/{}/{}/{}", store
,
1313 backup_type
, backup_id
, backup_dir
.backup_time_string(), file_name
);
1316 .map_err(Error
::from
)
1317 .try_fold(Vec
::new(), |mut acc
, chunk
| {
1318 acc
.extend_from_slice(&*chunk
);
1319 future
::ok
::<_
, Error
>(acc
)
1323 // always verify blob/CRC at server side
1324 let blob
= DataBlob
::load_from_reader(&mut &data
[..])?
;
1326 replace_file(&path
, blob
.raw_data(), CreateOptions
::new())?
;
1328 // fixme: use correct formatter
1329 Ok(crate::server
::formatter
::json_response(Ok(Value
::Null
)))
1337 schema
: DATASTORE_SCHEMA
,
1340 schema
: BACKUP_TYPE_SCHEMA
,
1343 schema
: BACKUP_ID_SCHEMA
,
1346 schema
: BACKUP_TIME_SCHEMA
,
1349 description
: "Base64 encoded path.",
1355 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_READ
| PRIV_DATASTORE_BACKUP
, true),
1358 /// Get the entries of the given path of the catalog
1361 backup_type
: String
,
1365 rpcenv
: &mut dyn RpcEnvironment
,
1366 ) -> Result
<Vec
<ArchiveEntry
>, Error
> {
1367 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1369 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1371 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1373 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_READ
)?
;
1375 let file_name
= CATALOG_NAME
;
1377 let (manifest
, files
) = read_backup_index(&datastore
, &backup_dir
)?
;
1379 if file
.filename
== file_name
&& file
.crypt_mode
== Some(CryptMode
::Encrypt
) {
1380 bail
!("cannot decode '{}' - is encrypted", file_name
);
1384 let mut path
= datastore
.base_path();
1385 path
.push(backup_dir
.relative_path());
1386 path
.push(file_name
);
1388 let index
= DynamicIndexReader
::open(&path
)
1389 .map_err(|err
| format_err
!("unable to read dynamic index '{:?}' - {}", &path
, err
))?
;
1391 let (csum
, size
) = index
.compute_csum();
1392 manifest
.verify_file(&file_name
, &csum
, size
)?
;
1394 let chunk_reader
= LocalChunkReader
::new(datastore
, None
, CryptMode
::None
);
1395 let reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
1397 let mut catalog_reader
= CatalogReader
::new(reader
);
1399 let path
= if filepath
!= "root" && filepath
!= "/" {
1400 base64
::decode(filepath
)?
1405 catalog_reader
.list_dir_contents(&path
)
1409 pub const API_METHOD_PXAR_FILE_DOWNLOAD
: ApiMethod
= ApiMethod
::new(
1410 &ApiHandler
::AsyncHttp(&pxar_file_download
),
1412 "Download single file from pxar file of a backup snapshot. Only works if it's not encrypted.",
1414 ("store", false, &DATASTORE_SCHEMA
),
1415 ("backup-type", false, &BACKUP_TYPE_SCHEMA
),
1416 ("backup-id", false, &BACKUP_ID_SCHEMA
),
1417 ("backup-time", false, &BACKUP_TIME_SCHEMA
),
1418 ("filepath", false, &StringSchema
::new("Base64 encoded path").schema()),
1421 ).access(None
, &Permission
::Privilege(
1422 &["datastore", "{store}"],
1423 PRIV_DATASTORE_READ
| PRIV_DATASTORE_BACKUP
,
1427 pub fn pxar_file_download(
1432 rpcenv
: Box
<dyn RpcEnvironment
>,
1433 ) -> ApiResponseFuture
{
1436 let store
= required_string_param(¶m
, "store")?
;
1437 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1439 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1441 let filepath
= required_string_param(¶m
, "filepath")?
.to_owned();
1443 let backup_type
= required_string_param(¶m
, "backup-type")?
;
1444 let backup_id
= required_string_param(¶m
, "backup-id")?
;
1445 let backup_time
= required_integer_param(¶m
, "backup-time")?
;
1447 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1449 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_READ
)?
;
1451 let mut components
= base64
::decode(&filepath
)?
;
1452 if !components
.is_empty() && components
[0] == b'
/'
{
1453 components
.remove(0);
1456 let mut split
= components
.splitn(2, |c
| *c
== b'
/'
);
1457 let pxar_name
= std
::str::from_utf8(split
.next().unwrap())?
;
1458 let file_path
= split
.next().unwrap_or(b
"/");
1459 let (manifest
, files
) = read_backup_index(&datastore
, &backup_dir
)?
;
1461 if file
.filename
== pxar_name
&& file
.crypt_mode
== Some(CryptMode
::Encrypt
) {
1462 bail
!("cannot decode '{}' - is encrypted", pxar_name
);
1466 let mut path
= datastore
.base_path();
1467 path
.push(backup_dir
.relative_path());
1468 path
.push(pxar_name
);
1470 let index
= DynamicIndexReader
::open(&path
)
1471 .map_err(|err
| format_err
!("unable to read dynamic index '{:?}' - {}", &path
, err
))?
;
1473 let (csum
, size
) = index
.compute_csum();
1474 manifest
.verify_file(&pxar_name
, &csum
, size
)?
;
1476 let chunk_reader
= LocalChunkReader
::new(datastore
, None
, CryptMode
::None
);
1477 let reader
= BufferedDynamicReader
::new(index
, chunk_reader
);
1478 let archive_size
= reader
.archive_size();
1479 let reader
= LocalDynamicReadAt
::new(reader
);
1481 let decoder
= Accessor
::new(reader
, archive_size
).await?
;
1482 let root
= decoder
.open_root().await?
;
1483 let path
= OsStr
::from_bytes(file_path
).to_os_string();
1485 .lookup(&path
).await?
1486 .ok_or_else(|| format_err
!("error opening '{:?}'", path
))?
;
1488 let body
= match file
.kind() {
1489 EntryKind
::File { .. }
=> Body
::wrap_stream(
1490 AsyncReaderStream
::new(file
.contents().await?
).map_err(move |err
| {
1491 eprintln
!("error during streaming of file '{:?}' - {}", filepath
, err
);
1495 EntryKind
::Hardlink(_
) => Body
::wrap_stream(
1496 AsyncReaderStream
::new(decoder
.follow_hardlink(&file
).await?
.contents().await?
)
1497 .map_err(move |err
| {
1499 "error during streaming of hardlink '{:?}' - {}",
1505 EntryKind
::Directory
=> {
1506 let (sender
, receiver
) = tokio
::sync
::mpsc
::channel(100);
1507 let channelwriter
= AsyncChannelWriter
::new(sender
, 1024 * 1024);
1508 crate::server
::spawn_internal_task(
1509 create_zip(channelwriter
, decoder
, path
.clone(), false)
1511 Body
::wrap_stream(ReceiverStream
::new(receiver
).map_err(move |err
| {
1512 eprintln
!("error during streaming of zip '{:?}' - {}", path
, err
);
1516 other
=> bail
!("cannot download file of type {:?}", other
),
1519 // fixme: set other headers ?
1520 Ok(Response
::builder()
1521 .status(StatusCode
::OK
)
1522 .header(header
::CONTENT_TYPE
, "application/octet-stream")
1532 schema
: DATASTORE_SCHEMA
,
1535 type: RRDTimeFrameResolution
,
1543 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
, true),
1546 /// Read datastore stats
1547 pub fn get_rrd_stats(
1549 timeframe
: RRDTimeFrameResolution
,
1552 ) -> Result
<Value
, Error
> {
1554 create_value_from_rrd(
1555 &format
!("datastore/{}", store
),
1558 "read_ios", "read_bytes",
1559 "write_ios", "write_bytes",
1571 schema
: DATASTORE_SCHEMA
,
1574 schema
: BACKUP_TYPE_SCHEMA
,
1577 schema
: BACKUP_ID_SCHEMA
,
1582 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
, true),
1585 /// Get "notes" for a backup group
1586 pub fn get_group_notes(
1588 backup_type
: String
,
1590 rpcenv
: &mut dyn RpcEnvironment
,
1591 ) -> Result
<String
, Error
> {
1592 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1594 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1595 let backup_group
= BackupGroup
::new(backup_type
, backup_id
);
1597 check_priv_or_backup_owner(&datastore
, &backup_group
, &auth_id
, PRIV_DATASTORE_AUDIT
)?
;
1599 let note_path
= get_group_note_path(&datastore
, &backup_group
);
1600 Ok(file_read_optional_string(note_path
)?
.unwrap_or_else(|| "".to_owned()))
1607 schema
: DATASTORE_SCHEMA
,
1610 schema
: BACKUP_TYPE_SCHEMA
,
1613 schema
: BACKUP_ID_SCHEMA
,
1616 description
: "A multiline text.",
1621 permission
: &Permission
::Privilege(&["datastore", "{store}"],
1622 PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_BACKUP
,
1626 /// Set "notes" for a backup group
1627 pub fn set_group_notes(
1629 backup_type
: String
,
1632 rpcenv
: &mut dyn RpcEnvironment
,
1633 ) -> Result
<(), Error
> {
1634 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1636 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1637 let backup_group
= BackupGroup
::new(backup_type
, backup_id
);
1639 check_priv_or_backup_owner(&datastore
, &backup_group
, &auth_id
, PRIV_DATASTORE_MODIFY
)?
;
1641 let note_path
= get_group_note_path(&datastore
, &backup_group
);
1642 replace_file(note_path
, notes
.as_bytes(), CreateOptions
::new())?
;
1651 schema
: DATASTORE_SCHEMA
,
1654 schema
: BACKUP_TYPE_SCHEMA
,
1657 schema
: BACKUP_ID_SCHEMA
,
1660 schema
: BACKUP_TIME_SCHEMA
,
1665 permission
: &Permission
::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT
| PRIV_DATASTORE_BACKUP
, true),
1668 /// Get "notes" for a specific backup
1671 backup_type
: String
,
1674 rpcenv
: &mut dyn RpcEnvironment
,
1675 ) -> Result
<String
, Error
> {
1676 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1678 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1679 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1681 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_AUDIT
)?
;
1683 let (manifest
, _
) = datastore
.load_manifest(&backup_dir
)?
;
1685 let notes
= manifest
.unprotected
["notes"]
1689 Ok(String
::from(notes
))
1696 schema
: DATASTORE_SCHEMA
,
1699 schema
: BACKUP_TYPE_SCHEMA
,
1702 schema
: BACKUP_ID_SCHEMA
,
1705 schema
: BACKUP_TIME_SCHEMA
,
1708 description
: "A multiline text.",
1713 permission
: &Permission
::Privilege(&["datastore", "{store}"],
1714 PRIV_DATASTORE_MODIFY
| PRIV_DATASTORE_BACKUP
,
1718 /// Set "notes" for a specific backup
1721 backup_type
: String
,
1725 rpcenv
: &mut dyn RpcEnvironment
,
1726 ) -> Result
<(), Error
> {
1727 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1729 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1730 let backup_dir
= BackupDir
::new(backup_type
, backup_id
, backup_time
)?
;
1732 check_priv_or_backup_owner(&datastore
, backup_dir
.group(), &auth_id
, PRIV_DATASTORE_MODIFY
)?
;
1734 datastore
.update_manifest(&backup_dir
,|manifest
| {
1735 manifest
.unprotected
["notes"] = notes
.into();
1736 }).map_err(|err
| format_err
!("unable to update manifest blob - {}", err
))?
;
1745 schema
: DATASTORE_SCHEMA
,
1748 schema
: BACKUP_TYPE_SCHEMA
,
1751 schema
: BACKUP_ID_SCHEMA
,
1759 permission
: &Permission
::Anybody
,
1760 description
: "Datastore.Modify on whole datastore, or changing ownership between user and a user's token for owned backups with Datastore.Backup"
1763 /// Change owner of a backup group
1764 pub fn set_backup_owner(
1766 backup_type
: String
,
1769 rpcenv
: &mut dyn RpcEnvironment
,
1770 ) -> Result
<(), Error
> {
1772 let datastore
= DataStore
::lookup_datastore(&store
)?
;
1774 let backup_group
= BackupGroup
::new(backup_type
, backup_id
);
1776 let auth_id
: Authid
= rpcenv
.get_auth_id().unwrap().parse()?
;
1778 let user_info
= CachedUserInfo
::new()?
;
1780 let privs
= user_info
.lookup_privs(&auth_id
, &["datastore", &store
]);
1782 let allowed
= if (privs
& PRIV_DATASTORE_MODIFY
) != 0 {
1783 // High-privilege user/token
1785 } else if (privs
& PRIV_DATASTORE_BACKUP
) != 0 {
1786 let owner
= datastore
.get_owner(&backup_group
)?
;
1788 match (owner
.is_token(), new_owner
.is_token()) {
1790 // API token to API token, owned by same user
1791 let owner
= owner
.user();
1792 let new_owner
= new_owner
.user();
1793 owner
== new_owner
&& Authid
::from(owner
.clone()) == auth_id
1796 // API token to API token owner
1797 Authid
::from(owner
.user().clone()) == auth_id
1798 && new_owner
== auth_id
1801 // API token owner to API token
1803 && Authid
::from(new_owner
.user().clone()) == auth_id
1806 // User to User, not allowed for unprivileged users
1815 return Err(http_err
!(UNAUTHORIZED
,
1816 "{} does not have permission to change owner of backup group '{}' to {}",
1823 if !user_info
.is_active_auth_id(&new_owner
) {
1824 bail
!("{} '{}' is inactive or non-existent",
1825 if new_owner
.is_token() {
1826 "API token".to_string()
1833 datastore
.set_owner(&backup_group
, &new_owner
, true)?
;
1839 const DATASTORE_INFO_SUBDIRS
: SubdirMap
= &[
1843 .get(&API_METHOD_CATALOG
)
1848 .post(&API_METHOD_SET_BACKUP_OWNER
)
1853 .download(&API_METHOD_DOWNLOAD_FILE
)
1858 .download(&API_METHOD_DOWNLOAD_FILE_DECODED
)
1863 .get(&API_METHOD_LIST_SNAPSHOT_FILES
)
1868 .get(&API_METHOD_GARBAGE_COLLECTION_STATUS
)
1869 .post(&API_METHOD_START_GARBAGE_COLLECTION
)
1874 .get(&API_METHOD_GET_GROUP_NOTES
)
1875 .put(&API_METHOD_SET_GROUP_NOTES
)
1880 .get(&API_METHOD_LIST_GROUPS
)
1881 .delete(&API_METHOD_DELETE_GROUP
)
1886 .get(&API_METHOD_GET_NOTES
)
1887 .put(&API_METHOD_SET_NOTES
)
1892 .post(&API_METHOD_PRUNE
)
1897 .post(&API_METHOD_PRUNE_DATASTORE
)
1900 "pxar-file-download",
1902 .download(&API_METHOD_PXAR_FILE_DOWNLOAD
)
1907 .get(&API_METHOD_GET_RRD_STATS
)
1912 .get(&API_METHOD_LIST_SNAPSHOTS
)
1913 .delete(&API_METHOD_DELETE_SNAPSHOT
)
1918 .get(&API_METHOD_STATUS
)
1921 "upload-backup-log",
1923 .upload(&API_METHOD_UPLOAD_BACKUP_LOG
)
1928 .post(&API_METHOD_VERIFY
)
1932 const DATASTORE_INFO_ROUTER
: Router
= Router
::new()
1933 .get(&list_subdirs_api_method
!(DATASTORE_INFO_SUBDIRS
))
1934 .subdirs(DATASTORE_INFO_SUBDIRS
);
1937 pub const ROUTER
: Router
= Router
::new()
1938 .get(&API_METHOD_GET_DATASTORE_LIST
)
1939 .match_all("store", &DATASTORE_INFO_ROUTER
);