]>
Commit | Line | Data |
---|---|---|
bf78f708 DM |
1 | //! Datastore Management |
2 | ||
0d08fcee | 3 | use std::collections::HashSet; |
d33d8f4e DC |
4 | use std::ffi::OsStr; |
5 | use std::os::unix::ffi::OsStrExt; | |
cad540e9 | 6 | |
6ef9bb59 | 7 | use anyhow::{bail, format_err, Error}; |
9e47c0a5 | 8 | use futures::*; |
cad540e9 WB |
9 | use hyper::http::request::Parts; |
10 | use hyper::{header, Body, Response, StatusCode}; | |
15e9b4ed | 11 | use serde_json::{json, Value}; |
7c667013 | 12 | use tokio_stream::wrappers::ReceiverStream; |
15e9b4ed | 13 | |
bb34b589 DM |
14 | use proxmox::api::{ |
15 | api, ApiResponseFuture, ApiHandler, ApiMethod, Router, | |
e7cb4dc5 WB |
16 | RpcEnvironment, RpcEnvironmentType, Permission |
17 | }; | |
b2362a12 | 18 | use proxmox::api::router::{ReturnType, SubdirMap}; |
cad540e9 | 19 | use proxmox::api::schema::*; |
60f9a6ea | 20 | use proxmox::tools::fs::{replace_file, CreateOptions}; |
9ea4bce4 | 21 | use proxmox::{http_err, identity, list_subdirs_api_method, sortable}; |
e18a6c9e | 22 | |
2e219481 | 23 | use pxar::accessor::aio::Accessor; |
d33d8f4e DC |
24 | use pxar::EntryKind; |
25 | ||
cad540e9 | 26 | use crate::api2::types::*; |
431cc7b1 | 27 | use crate::api2::node::rrd::create_value_from_rrd; |
227501c0 | 28 | use crate::api2::helpers; |
e5064ba6 | 29 | use crate::backup::*; |
cad540e9 | 30 | use crate::config::datastore; |
54552dda | 31 | use crate::config::cached_user_info::CachedUserInfo; |
2e219481 | 32 | use crate::pxar::create_zip; |
54552dda | 33 | |
4fdf5ddf | 34 | use crate::server::{jobstate::Job, WorkerTask}; |
804f6143 DC |
35 | use crate::tools::{ |
36 | self, | |
804f6143 DC |
37 | AsyncChannelWriter, AsyncReaderStream, WrappedReaderStream, |
38 | }; | |
39 | ||
d00e1a21 DM |
40 | use crate::config::acl::{ |
41 | PRIV_DATASTORE_AUDIT, | |
54552dda | 42 | PRIV_DATASTORE_MODIFY, |
d00e1a21 DM |
43 | PRIV_DATASTORE_READ, |
44 | PRIV_DATASTORE_PRUNE, | |
54552dda | 45 | PRIV_DATASTORE_BACKUP, |
09f6a240 | 46 | PRIV_DATASTORE_VERIFY, |
d00e1a21 | 47 | }; |
1629d2ad | 48 | |
bff85572 | 49 | fn check_priv_or_backup_owner( |
e7cb4dc5 WB |
50 | store: &DataStore, |
51 | group: &BackupGroup, | |
e6dc35ac | 52 | auth_id: &Authid, |
bff85572 FG |
53 | required_privs: u64, |
54 | ) -> Result<(), Error> { | |
55 | let user_info = CachedUserInfo::new()?; | |
56 | let privs = user_info.lookup_privs(&auth_id, &["datastore", store.name()]); | |
57 | ||
58 | if privs & required_privs == 0 { | |
59 | let owner = store.get_owner(group)?; | |
60 | check_backup_owner(&owner, auth_id)?; | |
61 | } | |
62 | Ok(()) | |
63 | } | |
64 | ||
65 | fn check_backup_owner( | |
66 | owner: &Authid, | |
67 | auth_id: &Authid, | |
e7cb4dc5 | 68 | ) -> Result<(), Error> { |
bff85572 FG |
69 | let correct_owner = owner == auth_id |
70 | || (owner.is_token() && &Authid::from(owner.user().clone()) == auth_id); | |
71 | if !correct_owner { | |
e6dc35ac | 72 | bail!("backup owner check failed ({} != {})", auth_id, owner); |
54552dda DM |
73 | } |
74 | Ok(()) | |
75 | } | |
76 | ||
e7cb4dc5 WB |
77 | fn read_backup_index( |
78 | store: &DataStore, | |
79 | backup_dir: &BackupDir, | |
80 | ) -> Result<(BackupManifest, Vec<BackupContent>), Error> { | |
8c70e3eb | 81 | |
ff86ef00 | 82 | let (manifest, index_size) = store.load_manifest(backup_dir)?; |
8c70e3eb | 83 | |
09b1f7b2 DM |
84 | let mut result = Vec::new(); |
85 | for item in manifest.files() { | |
86 | result.push(BackupContent { | |
87 | filename: item.filename.clone(), | |
f28d9088 | 88 | crypt_mode: Some(item.crypt_mode), |
09b1f7b2 DM |
89 | size: Some(item.size), |
90 | }); | |
8c70e3eb DM |
91 | } |
92 | ||
09b1f7b2 | 93 | result.push(BackupContent { |
96d65fbc | 94 | filename: MANIFEST_BLOB_NAME.to_string(), |
882c0823 FG |
95 | crypt_mode: match manifest.signature { |
96 | Some(_) => Some(CryptMode::SignOnly), | |
97 | None => Some(CryptMode::None), | |
98 | }, | |
09b1f7b2 DM |
99 | size: Some(index_size), |
100 | }); | |
4f1e40a2 | 101 | |
70030b43 | 102 | Ok((manifest, result)) |
8c70e3eb DM |
103 | } |
104 | ||
1c090810 DC |
105 | fn get_all_snapshot_files( |
106 | store: &DataStore, | |
107 | info: &BackupInfo, | |
70030b43 DM |
108 | ) -> Result<(BackupManifest, Vec<BackupContent>), Error> { |
109 | ||
110 | let (manifest, mut files) = read_backup_index(&store, &info.backup_dir)?; | |
1c090810 DC |
111 | |
112 | let file_set = files.iter().fold(HashSet::new(), |mut acc, item| { | |
113 | acc.insert(item.filename.clone()); | |
114 | acc | |
115 | }); | |
116 | ||
117 | for file in &info.files { | |
118 | if file_set.contains(file) { continue; } | |
f28d9088 WB |
119 | files.push(BackupContent { |
120 | filename: file.to_string(), | |
121 | size: None, | |
122 | crypt_mode: None, | |
123 | }); | |
1c090810 DC |
124 | } |
125 | ||
70030b43 | 126 | Ok((manifest, files)) |
1c090810 DC |
127 | } |
128 | ||
b31c8019 DM |
129 | #[api( |
130 | input: { | |
131 | properties: { | |
132 | store: { | |
133 | schema: DATASTORE_SCHEMA, | |
134 | }, | |
135 | }, | |
136 | }, | |
137 | returns: { | |
138 | type: Array, | |
139 | description: "Returns the list of backup groups.", | |
140 | items: { | |
141 | type: GroupListItem, | |
142 | } | |
143 | }, | |
bb34b589 | 144 | access: { |
54552dda DM |
145 | permission: &Permission::Privilege( |
146 | &["datastore", "{store}"], | |
147 | PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, | |
148 | true), | |
bb34b589 | 149 | }, |
b31c8019 DM |
150 | )] |
151 | /// List backup groups. | |
b2362a12 | 152 | pub fn list_groups( |
b31c8019 | 153 | store: String, |
54552dda | 154 | rpcenv: &mut dyn RpcEnvironment, |
b31c8019 | 155 | ) -> Result<Vec<GroupListItem>, Error> { |
812c6f87 | 156 | |
e6dc35ac | 157 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda | 158 | let user_info = CachedUserInfo::new()?; |
e6dc35ac | 159 | let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]); |
54552dda | 160 | |
b31c8019 | 161 | let datastore = DataStore::lookup_datastore(&store)?; |
0d08fcee FG |
162 | let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0; |
163 | ||
164 | let backup_groups = BackupInfo::list_backup_groups(&datastore.base_path())?; | |
165 | ||
166 | let group_info = backup_groups | |
167 | .into_iter() | |
168 | .fold(Vec::new(), |mut group_info, group| { | |
169 | let owner = match datastore.get_owner(&group) { | |
170 | Ok(auth_id) => auth_id, | |
171 | Err(err) => { | |
1ed02257 FG |
172 | eprintln!("Failed to get owner of group '{}/{}' - {}", |
173 | &store, | |
174 | group, | |
175 | err); | |
0d08fcee FG |
176 | return group_info; |
177 | }, | |
178 | }; | |
179 | if !list_all && check_backup_owner(&owner, &auth_id).is_err() { | |
180 | return group_info; | |
181 | } | |
182 | ||
183 | let snapshots = match group.list_backups(&datastore.base_path()) { | |
184 | Ok(snapshots) => snapshots, | |
185 | Err(_) => { | |
186 | return group_info; | |
187 | }, | |
188 | }; | |
189 | ||
190 | let backup_count: u64 = snapshots.len() as u64; | |
191 | if backup_count == 0 { | |
192 | return group_info; | |
193 | } | |
194 | ||
195 | let last_backup = snapshots | |
196 | .iter() | |
197 | .fold(&snapshots[0], |last, curr| { | |
198 | if curr.is_finished() | |
199 | && curr.backup_dir.backup_time() > last.backup_dir.backup_time() { | |
200 | curr | |
201 | } else { | |
202 | last | |
203 | } | |
204 | }) | |
205 | .to_owned(); | |
206 | ||
207 | group_info.push(GroupListItem { | |
208 | backup_type: group.backup_type().to_string(), | |
209 | backup_id: group.backup_id().to_string(), | |
210 | last_backup: last_backup.backup_dir.backup_time(), | |
211 | owner: Some(owner), | |
212 | backup_count, | |
213 | files: last_backup.files, | |
214 | }); | |
215 | ||
216 | group_info | |
217 | }); | |
812c6f87 | 218 | |
0d08fcee | 219 | Ok(group_info) |
812c6f87 | 220 | } |
8f579717 | 221 | |
09b1f7b2 DM |
222 | #[api( |
223 | input: { | |
224 | properties: { | |
225 | store: { | |
226 | schema: DATASTORE_SCHEMA, | |
227 | }, | |
228 | "backup-type": { | |
229 | schema: BACKUP_TYPE_SCHEMA, | |
230 | }, | |
231 | "backup-id": { | |
232 | schema: BACKUP_ID_SCHEMA, | |
233 | }, | |
234 | "backup-time": { | |
235 | schema: BACKUP_TIME_SCHEMA, | |
236 | }, | |
237 | }, | |
238 | }, | |
239 | returns: { | |
240 | type: Array, | |
241 | description: "Returns the list of archive files inside a backup snapshots.", | |
242 | items: { | |
243 | type: BackupContent, | |
244 | } | |
245 | }, | |
bb34b589 | 246 | access: { |
54552dda DM |
247 | permission: &Permission::Privilege( |
248 | &["datastore", "{store}"], | |
249 | PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, | |
250 | true), | |
bb34b589 | 251 | }, |
09b1f7b2 DM |
252 | )] |
253 | /// List snapshot files. | |
ea5f547f | 254 | pub fn list_snapshot_files( |
09b1f7b2 DM |
255 | store: String, |
256 | backup_type: String, | |
257 | backup_id: String, | |
258 | backup_time: i64, | |
01a13423 | 259 | _info: &ApiMethod, |
54552dda | 260 | rpcenv: &mut dyn RpcEnvironment, |
09b1f7b2 | 261 | ) -> Result<Vec<BackupContent>, Error> { |
01a13423 | 262 | |
e6dc35ac | 263 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
09b1f7b2 | 264 | let datastore = DataStore::lookup_datastore(&store)?; |
54552dda | 265 | |
e0e5b442 | 266 | let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?; |
01a13423 | 267 | |
bff85572 | 268 | check_priv_or_backup_owner(&datastore, snapshot.group(), &auth_id, PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ)?; |
54552dda | 269 | |
d7c24397 | 270 | let info = BackupInfo::new(&datastore.base_path(), snapshot)?; |
01a13423 | 271 | |
70030b43 DM |
272 | let (_manifest, files) = get_all_snapshot_files(&datastore, &info)?; |
273 | ||
274 | Ok(files) | |
01a13423 DM |
275 | } |
276 | ||
68a6a0ee DM |
277 | #[api( |
278 | input: { | |
279 | properties: { | |
280 | store: { | |
281 | schema: DATASTORE_SCHEMA, | |
282 | }, | |
283 | "backup-type": { | |
284 | schema: BACKUP_TYPE_SCHEMA, | |
285 | }, | |
286 | "backup-id": { | |
287 | schema: BACKUP_ID_SCHEMA, | |
288 | }, | |
289 | "backup-time": { | |
290 | schema: BACKUP_TIME_SCHEMA, | |
291 | }, | |
292 | }, | |
293 | }, | |
bb34b589 | 294 | access: { |
54552dda DM |
295 | permission: &Permission::Privilege( |
296 | &["datastore", "{store}"], | |
297 | PRIV_DATASTORE_MODIFY| PRIV_DATASTORE_PRUNE, | |
298 | true), | |
bb34b589 | 299 | }, |
68a6a0ee DM |
300 | )] |
301 | /// Delete backup snapshot. | |
bf78f708 | 302 | pub fn delete_snapshot( |
68a6a0ee DM |
303 | store: String, |
304 | backup_type: String, | |
305 | backup_id: String, | |
306 | backup_time: i64, | |
6f62c924 | 307 | _info: &ApiMethod, |
54552dda | 308 | rpcenv: &mut dyn RpcEnvironment, |
6f62c924 DM |
309 | ) -> Result<Value, Error> { |
310 | ||
e6dc35ac | 311 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda | 312 | |
e0e5b442 | 313 | let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?; |
68a6a0ee | 314 | let datastore = DataStore::lookup_datastore(&store)?; |
6f62c924 | 315 | |
bff85572 | 316 | check_priv_or_backup_owner(&datastore, snapshot.group(), &auth_id, PRIV_DATASTORE_MODIFY)?; |
54552dda | 317 | |
c9756b40 | 318 | datastore.remove_backup_dir(&snapshot, false)?; |
6f62c924 DM |
319 | |
320 | Ok(Value::Null) | |
321 | } | |
322 | ||
fc189b19 DM |
323 | #[api( |
324 | input: { | |
325 | properties: { | |
326 | store: { | |
327 | schema: DATASTORE_SCHEMA, | |
328 | }, | |
329 | "backup-type": { | |
330 | optional: true, | |
331 | schema: BACKUP_TYPE_SCHEMA, | |
332 | }, | |
333 | "backup-id": { | |
334 | optional: true, | |
335 | schema: BACKUP_ID_SCHEMA, | |
336 | }, | |
337 | }, | |
338 | }, | |
339 | returns: { | |
340 | type: Array, | |
341 | description: "Returns the list of snapshots.", | |
342 | items: { | |
343 | type: SnapshotListItem, | |
344 | } | |
345 | }, | |
bb34b589 | 346 | access: { |
54552dda DM |
347 | permission: &Permission::Privilege( |
348 | &["datastore", "{store}"], | |
349 | PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, | |
350 | true), | |
bb34b589 | 351 | }, |
fc189b19 DM |
352 | )] |
353 | /// List backup snapshots. | |
f24fc116 | 354 | pub fn list_snapshots ( |
54552dda DM |
355 | store: String, |
356 | backup_type: Option<String>, | |
357 | backup_id: Option<String>, | |
358 | _param: Value, | |
184f17af | 359 | _info: &ApiMethod, |
54552dda | 360 | rpcenv: &mut dyn RpcEnvironment, |
fc189b19 | 361 | ) -> Result<Vec<SnapshotListItem>, Error> { |
184f17af | 362 | |
e6dc35ac | 363 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda | 364 | let user_info = CachedUserInfo::new()?; |
e6dc35ac | 365 | let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]); |
184f17af | 366 | |
0d08fcee FG |
367 | let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0; |
368 | ||
54552dda | 369 | let datastore = DataStore::lookup_datastore(&store)?; |
184f17af | 370 | |
c0977501 | 371 | let base_path = datastore.base_path(); |
184f17af | 372 | |
0d08fcee FG |
373 | let groups = match (backup_type, backup_id) { |
374 | (Some(backup_type), Some(backup_id)) => { | |
375 | let mut groups = Vec::with_capacity(1); | |
376 | groups.push(BackupGroup::new(backup_type, backup_id)); | |
377 | groups | |
378 | }, | |
379 | (Some(backup_type), None) => { | |
380 | BackupInfo::list_backup_groups(&base_path)? | |
381 | .into_iter() | |
382 | .filter(|group| group.backup_type() == backup_type) | |
383 | .collect() | |
384 | }, | |
385 | (None, Some(backup_id)) => { | |
386 | BackupInfo::list_backup_groups(&base_path)? | |
387 | .into_iter() | |
388 | .filter(|group| group.backup_id() == backup_id) | |
389 | .collect() | |
390 | }, | |
391 | _ => BackupInfo::list_backup_groups(&base_path)?, | |
392 | }; | |
54552dda | 393 | |
0d08fcee | 394 | let info_to_snapshot_list_item = |group: &BackupGroup, owner, info: BackupInfo| { |
79c53595 FG |
395 | let backup_type = group.backup_type().to_string(); |
396 | let backup_id = group.backup_id().to_string(); | |
0d08fcee | 397 | let backup_time = info.backup_dir.backup_time(); |
1c090810 | 398 | |
79c53595 | 399 | match get_all_snapshot_files(&datastore, &info) { |
70030b43 | 400 | Ok((manifest, files)) => { |
70030b43 DM |
401 | // extract the first line from notes |
402 | let comment: Option<String> = manifest.unprotected["notes"] | |
403 | .as_str() | |
404 | .and_then(|notes| notes.lines().next()) | |
405 | .map(String::from); | |
406 | ||
035c40e6 FG |
407 | let fingerprint = match manifest.fingerprint() { |
408 | Ok(fp) => fp, | |
409 | Err(err) => { | |
410 | eprintln!("error parsing fingerprint: '{}'", err); | |
411 | None | |
412 | }, | |
413 | }; | |
414 | ||
79c53595 FG |
415 | let verification = manifest.unprotected["verify_state"].clone(); |
416 | let verification: Option<SnapshotVerifyState> = match serde_json::from_value(verification) { | |
3b2046d2 TL |
417 | Ok(verify) => verify, |
418 | Err(err) => { | |
419 | eprintln!("error parsing verification state : '{}'", err); | |
420 | None | |
421 | } | |
422 | }; | |
423 | ||
0d08fcee FG |
424 | let size = Some(files.iter().map(|x| x.size.unwrap_or(0)).sum()); |
425 | ||
79c53595 FG |
426 | SnapshotListItem { |
427 | backup_type, | |
428 | backup_id, | |
429 | backup_time, | |
430 | comment, | |
431 | verification, | |
035c40e6 | 432 | fingerprint, |
79c53595 FG |
433 | files, |
434 | size, | |
435 | owner, | |
436 | } | |
1c090810 DC |
437 | }, |
438 | Err(err) => { | |
439 | eprintln!("error during snapshot file listing: '{}'", err); | |
79c53595 | 440 | let files = info |
70030b43 | 441 | .files |
0d08fcee | 442 | .into_iter() |
44288184 FG |
443 | .map(|filename| BackupContent { |
444 | filename, | |
70030b43 DM |
445 | size: None, |
446 | crypt_mode: None, | |
447 | }) | |
79c53595 FG |
448 | .collect(); |
449 | ||
450 | SnapshotListItem { | |
451 | backup_type, | |
452 | backup_id, | |
453 | backup_time, | |
454 | comment: None, | |
455 | verification: None, | |
035c40e6 | 456 | fingerprint: None, |
79c53595 FG |
457 | files, |
458 | size: None, | |
459 | owner, | |
460 | } | |
1c090810 | 461 | }, |
0d08fcee FG |
462 | } |
463 | }; | |
184f17af | 464 | |
0d08fcee FG |
465 | groups |
466 | .iter() | |
467 | .try_fold(Vec::new(), |mut snapshots, group| { | |
468 | let owner = match datastore.get_owner(group) { | |
469 | Ok(auth_id) => auth_id, | |
470 | Err(err) => { | |
471 | eprintln!("Failed to get owner of group '{}/{}' - {}", | |
472 | &store, | |
473 | group, | |
474 | err); | |
475 | return Ok(snapshots); | |
476 | }, | |
477 | }; | |
478 | ||
479 | if !list_all && check_backup_owner(&owner, &auth_id).is_err() { | |
480 | return Ok(snapshots); | |
481 | } | |
482 | ||
483 | let group_backups = group.list_backups(&datastore.base_path())?; | |
484 | ||
485 | snapshots.extend( | |
486 | group_backups | |
487 | .into_iter() | |
488 | .map(|info| info_to_snapshot_list_item(&group, Some(owner.clone()), info)) | |
489 | ); | |
490 | ||
491 | Ok(snapshots) | |
492 | }) | |
184f17af DM |
493 | } |
494 | ||
fdfcb74d | 495 | fn get_snapshots_count(store: &DataStore, filter_owner: Option<&Authid>) -> Result<Counts, Error> { |
16f9f244 | 496 | let base_path = store.base_path(); |
fdfcb74d | 497 | let groups = BackupInfo::list_backup_groups(&base_path)?; |
16f9f244 | 498 | |
fdfcb74d FG |
499 | groups.iter() |
500 | .filter(|group| { | |
501 | let owner = match store.get_owner(&group) { | |
502 | Ok(owner) => owner, | |
503 | Err(err) => { | |
1ed02257 FG |
504 | eprintln!("Failed to get owner of group '{}/{}' - {}", |
505 | store.name(), | |
506 | group, | |
507 | err); | |
fdfcb74d FG |
508 | return false; |
509 | }, | |
510 | }; | |
14e08625 | 511 | |
fdfcb74d FG |
512 | match filter_owner { |
513 | Some(filter) => check_backup_owner(&owner, filter).is_ok(), | |
514 | None => true, | |
515 | } | |
516 | }) | |
517 | .try_fold(Counts::default(), |mut counts, group| { | |
518 | let snapshot_count = group.list_backups(&base_path)?.len() as u64; | |
519 | ||
520 | let type_count = match group.backup_type() { | |
521 | "ct" => counts.ct.get_or_insert(Default::default()), | |
522 | "vm" => counts.vm.get_or_insert(Default::default()), | |
523 | "host" => counts.host.get_or_insert(Default::default()), | |
524 | _ => counts.other.get_or_insert(Default::default()), | |
525 | }; | |
14e08625 | 526 | |
fdfcb74d FG |
527 | type_count.groups += 1; |
528 | type_count.snapshots += snapshot_count; | |
16f9f244 | 529 | |
fdfcb74d FG |
530 | Ok(counts) |
531 | }) | |
16f9f244 DC |
532 | } |
533 | ||
1dc117bb DM |
534 | #[api( |
535 | input: { | |
536 | properties: { | |
537 | store: { | |
538 | schema: DATASTORE_SCHEMA, | |
539 | }, | |
98afc7b1 FG |
540 | verbose: { |
541 | type: bool, | |
542 | default: false, | |
543 | optional: true, | |
544 | description: "Include additional information like snapshot counts and GC status.", | |
545 | }, | |
1dc117bb | 546 | }, |
98afc7b1 | 547 | |
1dc117bb DM |
548 | }, |
549 | returns: { | |
14e08625 | 550 | type: DataStoreStatus, |
1dc117bb | 551 | }, |
bb34b589 | 552 | access: { |
54552dda | 553 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true), |
bb34b589 | 554 | }, |
1dc117bb DM |
555 | )] |
556 | /// Get datastore status. | |
ea5f547f | 557 | pub fn status( |
1dc117bb | 558 | store: String, |
98afc7b1 | 559 | verbose: bool, |
0eecf38f | 560 | _info: &ApiMethod, |
fdfcb74d | 561 | rpcenv: &mut dyn RpcEnvironment, |
14e08625 | 562 | ) -> Result<DataStoreStatus, Error> { |
1dc117bb | 563 | let datastore = DataStore::lookup_datastore(&store)?; |
14e08625 | 564 | let storage = crate::tools::disks::disk_usage(&datastore.base_path())?; |
fdfcb74d FG |
565 | let (counts, gc_status) = if verbose { |
566 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; | |
567 | let user_info = CachedUserInfo::new()?; | |
568 | ||
569 | let store_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]); | |
570 | let filter_owner = if store_privs & PRIV_DATASTORE_AUDIT != 0 { | |
571 | None | |
572 | } else { | |
573 | Some(&auth_id) | |
574 | }; | |
575 | ||
576 | let counts = Some(get_snapshots_count(&datastore, filter_owner)?); | |
577 | let gc_status = Some(datastore.last_gc_status()); | |
578 | ||
579 | (counts, gc_status) | |
580 | } else { | |
581 | (None, None) | |
98afc7b1 | 582 | }; |
16f9f244 | 583 | |
14e08625 DC |
584 | Ok(DataStoreStatus { |
585 | total: storage.total, | |
586 | used: storage.used, | |
587 | avail: storage.avail, | |
588 | gc_status, | |
589 | counts, | |
590 | }) | |
0eecf38f DM |
591 | } |
592 | ||
c2009e53 DM |
593 | #[api( |
594 | input: { | |
595 | properties: { | |
596 | store: { | |
597 | schema: DATASTORE_SCHEMA, | |
598 | }, | |
599 | "backup-type": { | |
600 | schema: BACKUP_TYPE_SCHEMA, | |
601 | optional: true, | |
602 | }, | |
603 | "backup-id": { | |
604 | schema: BACKUP_ID_SCHEMA, | |
605 | optional: true, | |
606 | }, | |
607 | "backup-time": { | |
608 | schema: BACKUP_TIME_SCHEMA, | |
609 | optional: true, | |
610 | }, | |
611 | }, | |
612 | }, | |
613 | returns: { | |
614 | schema: UPID_SCHEMA, | |
615 | }, | |
616 | access: { | |
09f6a240 | 617 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_VERIFY | PRIV_DATASTORE_BACKUP, true), |
c2009e53 DM |
618 | }, |
619 | )] | |
620 | /// Verify backups. | |
621 | /// | |
622 | /// This function can verify a single backup snapshot, all backup from a backup group, | |
623 | /// or all backups in the datastore. | |
624 | pub fn verify( | |
625 | store: String, | |
626 | backup_type: Option<String>, | |
627 | backup_id: Option<String>, | |
628 | backup_time: Option<i64>, | |
629 | rpcenv: &mut dyn RpcEnvironment, | |
630 | ) -> Result<Value, Error> { | |
631 | let datastore = DataStore::lookup_datastore(&store)?; | |
632 | ||
09f6a240 | 633 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
8ea00f6e | 634 | let worker_id; |
c2009e53 DM |
635 | |
636 | let mut backup_dir = None; | |
637 | let mut backup_group = None; | |
133042b5 | 638 | let mut worker_type = "verify"; |
c2009e53 DM |
639 | |
640 | match (backup_type, backup_id, backup_time) { | |
641 | (Some(backup_type), Some(backup_id), Some(backup_time)) => { | |
4ebda996 | 642 | worker_id = format!("{}:{}/{}/{:08X}", store, backup_type, backup_id, backup_time); |
e0e5b442 | 643 | let dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
09f6a240 FG |
644 | |
645 | check_priv_or_backup_owner(&datastore, dir.group(), &auth_id, PRIV_DATASTORE_VERIFY)?; | |
646 | ||
c2009e53 | 647 | backup_dir = Some(dir); |
133042b5 | 648 | worker_type = "verify_snapshot"; |
c2009e53 DM |
649 | } |
650 | (Some(backup_type), Some(backup_id), None) => { | |
4ebda996 | 651 | worker_id = format!("{}:{}/{}", store, backup_type, backup_id); |
c2009e53 | 652 | let group = BackupGroup::new(backup_type, backup_id); |
09f6a240 FG |
653 | |
654 | check_priv_or_backup_owner(&datastore, &group, &auth_id, PRIV_DATASTORE_VERIFY)?; | |
655 | ||
c2009e53 | 656 | backup_group = Some(group); |
133042b5 | 657 | worker_type = "verify_group"; |
c2009e53 DM |
658 | } |
659 | (None, None, None) => { | |
8ea00f6e | 660 | worker_id = store.clone(); |
c2009e53 | 661 | } |
5a718dce | 662 | _ => bail!("parameters do not specify a backup group or snapshot"), |
c2009e53 DM |
663 | } |
664 | ||
39735609 | 665 | let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI; |
c2009e53 DM |
666 | |
667 | let upid_str = WorkerTask::new_thread( | |
133042b5 | 668 | worker_type, |
44288184 | 669 | Some(worker_id), |
09f6a240 | 670 | auth_id.clone(), |
e7cb4dc5 WB |
671 | to_stdout, |
672 | move |worker| { | |
9c26a3d6 | 673 | let verify_worker = crate::backup::VerifyWorker::new(worker.clone(), datastore); |
adfdc369 | 674 | let failed_dirs = if let Some(backup_dir) = backup_dir { |
adfdc369 | 675 | let mut res = Vec::new(); |
f6b1d1cc | 676 | if !verify_backup_dir( |
9c26a3d6 | 677 | &verify_worker, |
f6b1d1cc | 678 | &backup_dir, |
f6b1d1cc | 679 | worker.upid().clone(), |
d771a608 | 680 | None, |
f6b1d1cc | 681 | )? { |
adfdc369 DC |
682 | res.push(backup_dir.to_string()); |
683 | } | |
684 | res | |
c2009e53 | 685 | } else if let Some(backup_group) = backup_group { |
7e25b9aa | 686 | let failed_dirs = verify_backup_group( |
9c26a3d6 | 687 | &verify_worker, |
63d9aca9 | 688 | &backup_group, |
7e25b9aa | 689 | &mut StoreProgress::new(1), |
f6b1d1cc | 690 | worker.upid(), |
d771a608 | 691 | None, |
63d9aca9 DM |
692 | )?; |
693 | failed_dirs | |
c2009e53 | 694 | } else { |
09f6a240 FG |
695 | let privs = CachedUserInfo::new()? |
696 | .lookup_privs(&auth_id, &["datastore", &store]); | |
697 | ||
698 | let owner = if privs & PRIV_DATASTORE_VERIFY == 0 { | |
699 | Some(auth_id) | |
700 | } else { | |
701 | None | |
702 | }; | |
703 | ||
9c26a3d6 | 704 | verify_all_backups(&verify_worker, worker.upid(), owner, None)? |
c2009e53 | 705 | }; |
3984a5fd | 706 | if !failed_dirs.is_empty() { |
a4fa3fc2 | 707 | worker.log("Failed to verify the following snapshots/groups:"); |
adfdc369 DC |
708 | for dir in failed_dirs { |
709 | worker.log(format!("\t{}", dir)); | |
710 | } | |
1ffe0301 | 711 | bail!("verification failed - please check the log for details"); |
c2009e53 DM |
712 | } |
713 | Ok(()) | |
e7cb4dc5 WB |
714 | }, |
715 | )?; | |
c2009e53 DM |
716 | |
717 | Ok(json!(upid_str)) | |
718 | } | |
719 | ||
255f378a DM |
720 | #[macro_export] |
721 | macro_rules! add_common_prune_prameters { | |
552c2259 DM |
722 | ( [ $( $list1:tt )* ] ) => { |
723 | add_common_prune_prameters!([$( $list1 )* ] , []) | |
724 | }; | |
725 | ( [ $( $list1:tt )* ] , [ $( $list2:tt )* ] ) => { | |
255f378a | 726 | [ |
552c2259 | 727 | $( $list1 )* |
255f378a | 728 | ( |
552c2259 | 729 | "keep-daily", |
255f378a | 730 | true, |
49ff1092 | 731 | &PRUNE_SCHEMA_KEEP_DAILY, |
255f378a | 732 | ), |
102d8d41 DM |
733 | ( |
734 | "keep-hourly", | |
735 | true, | |
49ff1092 | 736 | &PRUNE_SCHEMA_KEEP_HOURLY, |
102d8d41 | 737 | ), |
255f378a | 738 | ( |
552c2259 | 739 | "keep-last", |
255f378a | 740 | true, |
49ff1092 | 741 | &PRUNE_SCHEMA_KEEP_LAST, |
255f378a DM |
742 | ), |
743 | ( | |
552c2259 | 744 | "keep-monthly", |
255f378a | 745 | true, |
49ff1092 | 746 | &PRUNE_SCHEMA_KEEP_MONTHLY, |
255f378a DM |
747 | ), |
748 | ( | |
552c2259 | 749 | "keep-weekly", |
255f378a | 750 | true, |
49ff1092 | 751 | &PRUNE_SCHEMA_KEEP_WEEKLY, |
255f378a DM |
752 | ), |
753 | ( | |
754 | "keep-yearly", | |
755 | true, | |
49ff1092 | 756 | &PRUNE_SCHEMA_KEEP_YEARLY, |
255f378a | 757 | ), |
552c2259 | 758 | $( $list2 )* |
255f378a DM |
759 | ] |
760 | } | |
0eecf38f DM |
761 | } |
762 | ||
db1e061d DM |
763 | pub const API_RETURN_SCHEMA_PRUNE: Schema = ArraySchema::new( |
764 | "Returns the list of snapshots and a flag indicating if there are kept or removed.", | |
660a3489 | 765 | &PruneListItem::API_SCHEMA |
db1e061d DM |
766 | ).schema(); |
767 | ||
b2362a12 | 768 | pub const API_METHOD_PRUNE: ApiMethod = ApiMethod::new( |
0ab08ac9 | 769 | &ApiHandler::Sync(&prune), |
255f378a | 770 | &ObjectSchema::new( |
0ab08ac9 DM |
771 | "Prune the datastore.", |
772 | &add_common_prune_prameters!([ | |
773 | ("backup-id", false, &BACKUP_ID_SCHEMA), | |
774 | ("backup-type", false, &BACKUP_TYPE_SCHEMA), | |
3b03abfe DM |
775 | ("dry-run", true, &BooleanSchema::new( |
776 | "Just show what prune would do, but do not delete anything.") | |
777 | .schema() | |
778 | ), | |
0ab08ac9 | 779 | ],[ |
66c49c21 | 780 | ("store", false, &DATASTORE_SCHEMA), |
0ab08ac9 | 781 | ]) |
db1e061d | 782 | )) |
b2362a12 | 783 | .returns(ReturnType::new(false, &API_RETURN_SCHEMA_PRUNE)) |
db1e061d | 784 | .access(None, &Permission::Privilege( |
54552dda DM |
785 | &["datastore", "{store}"], |
786 | PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_PRUNE, | |
787 | true) | |
788 | ); | |
255f378a | 789 | |
bf78f708 | 790 | pub fn prune( |
83b7db02 DM |
791 | param: Value, |
792 | _info: &ApiMethod, | |
54552dda | 793 | rpcenv: &mut dyn RpcEnvironment, |
83b7db02 DM |
794 | ) -> Result<Value, Error> { |
795 | ||
54552dda | 796 | let store = tools::required_string_param(¶m, "store")?; |
9fdc3ef4 DM |
797 | let backup_type = tools::required_string_param(¶m, "backup-type")?; |
798 | let backup_id = tools::required_string_param(¶m, "backup-id")?; | |
799 | ||
e6dc35ac | 800 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda | 801 | |
3b03abfe DM |
802 | let dry_run = param["dry-run"].as_bool().unwrap_or(false); |
803 | ||
9fdc3ef4 DM |
804 | let group = BackupGroup::new(backup_type, backup_id); |
805 | ||
54552dda DM |
806 | let datastore = DataStore::lookup_datastore(&store)?; |
807 | ||
bff85572 | 808 | check_priv_or_backup_owner(&datastore, &group, &auth_id, PRIV_DATASTORE_MODIFY)?; |
83b7db02 | 809 | |
9e3f0088 DM |
810 | let prune_options = PruneOptions { |
811 | keep_last: param["keep-last"].as_u64(), | |
102d8d41 | 812 | keep_hourly: param["keep-hourly"].as_u64(), |
9e3f0088 DM |
813 | keep_daily: param["keep-daily"].as_u64(), |
814 | keep_weekly: param["keep-weekly"].as_u64(), | |
815 | keep_monthly: param["keep-monthly"].as_u64(), | |
816 | keep_yearly: param["keep-yearly"].as_u64(), | |
817 | }; | |
8f579717 | 818 | |
4ebda996 | 819 | let worker_id = format!("{}:{}/{}", store, backup_type, backup_id); |
503995c7 | 820 | |
dda70154 DM |
821 | let mut prune_result = Vec::new(); |
822 | ||
823 | let list = group.list_backups(&datastore.base_path())?; | |
824 | ||
825 | let mut prune_info = compute_prune_info(list, &prune_options)?; | |
826 | ||
827 | prune_info.reverse(); // delete older snapshots first | |
828 | ||
829 | let keep_all = !prune_options.keeps_something(); | |
830 | ||
831 | if dry_run { | |
832 | for (info, mut keep) in prune_info { | |
833 | if keep_all { keep = true; } | |
834 | ||
835 | let backup_time = info.backup_dir.backup_time(); | |
836 | let group = info.backup_dir.group(); | |
837 | ||
838 | prune_result.push(json!({ | |
839 | "backup-type": group.backup_type(), | |
840 | "backup-id": group.backup_id(), | |
6a7be83e | 841 | "backup-time": backup_time, |
dda70154 DM |
842 | "keep": keep, |
843 | })); | |
844 | } | |
845 | return Ok(json!(prune_result)); | |
846 | } | |
847 | ||
848 | ||
163e9bbe | 849 | // We use a WorkerTask just to have a task log, but run synchrounously |
44288184 | 850 | let worker = WorkerTask::new("prune", Some(worker_id), auth_id, true)?; |
dda70154 | 851 | |
f1539300 SR |
852 | if keep_all { |
853 | worker.log("No prune selection - keeping all files."); | |
854 | } else { | |
855 | worker.log(format!("retention options: {}", prune_options.cli_options_string())); | |
856 | worker.log(format!("Starting prune on store \"{}\" group \"{}/{}\"", | |
857 | store, backup_type, backup_id)); | |
858 | } | |
3b03abfe | 859 | |
f1539300 SR |
860 | for (info, mut keep) in prune_info { |
861 | if keep_all { keep = true; } | |
dda70154 | 862 | |
f1539300 SR |
863 | let backup_time = info.backup_dir.backup_time(); |
864 | let timestamp = info.backup_dir.backup_time_string(); | |
865 | let group = info.backup_dir.group(); | |
3b03abfe | 866 | |
3b03abfe | 867 | |
f1539300 SR |
868 | let msg = format!( |
869 | "{}/{}/{} {}", | |
870 | group.backup_type(), | |
871 | group.backup_id(), | |
872 | timestamp, | |
873 | if keep { "keep" } else { "remove" }, | |
874 | ); | |
875 | ||
876 | worker.log(msg); | |
877 | ||
878 | prune_result.push(json!({ | |
879 | "backup-type": group.backup_type(), | |
880 | "backup-id": group.backup_id(), | |
881 | "backup-time": backup_time, | |
882 | "keep": keep, | |
883 | })); | |
884 | ||
885 | if !(dry_run || keep) { | |
886 | if let Err(err) = datastore.remove_backup_dir(&info.backup_dir, false) { | |
887 | worker.warn( | |
888 | format!( | |
889 | "failed to remove dir {:?}: {}", | |
890 | info.backup_dir.relative_path(), err | |
891 | ) | |
892 | ); | |
8f0b4c1f | 893 | } |
8f579717 | 894 | } |
f1539300 | 895 | } |
dd8e744f | 896 | |
f1539300 | 897 | worker.log_result(&Ok(())); |
83b7db02 | 898 | |
dda70154 | 899 | Ok(json!(prune_result)) |
83b7db02 DM |
900 | } |
901 | ||
dfc58d47 DM |
902 | #[api( |
903 | input: { | |
904 | properties: { | |
905 | store: { | |
906 | schema: DATASTORE_SCHEMA, | |
907 | }, | |
908 | }, | |
909 | }, | |
910 | returns: { | |
911 | schema: UPID_SCHEMA, | |
912 | }, | |
bb34b589 | 913 | access: { |
54552dda | 914 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY, false), |
bb34b589 | 915 | }, |
dfc58d47 DM |
916 | )] |
917 | /// Start garbage collection. | |
bf78f708 | 918 | pub fn start_garbage_collection( |
dfc58d47 | 919 | store: String, |
6049b71f | 920 | _info: &ApiMethod, |
dd5495d6 | 921 | rpcenv: &mut dyn RpcEnvironment, |
6049b71f | 922 | ) -> Result<Value, Error> { |
15e9b4ed | 923 | |
3e6a7dee | 924 | let datastore = DataStore::lookup_datastore(&store)?; |
e6dc35ac | 925 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
15e9b4ed | 926 | |
4fdf5ddf DC |
927 | let job = Job::new("garbage_collection", &store) |
928 | .map_err(|_| format_err!("garbage collection already running"))?; | |
15e9b4ed | 929 | |
39735609 | 930 | let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI; |
15e9b4ed | 931 | |
4fdf5ddf DC |
932 | let upid_str = crate::server::do_garbage_collection_job(job, datastore, &auth_id, None, to_stdout) |
933 | .map_err(|err| format_err!("unable to start garbage collection job on datastore {} - {}", store, err))?; | |
0f778e06 DM |
934 | |
935 | Ok(json!(upid_str)) | |
15e9b4ed DM |
936 | } |
937 | ||
a92830dc DM |
938 | #[api( |
939 | input: { | |
940 | properties: { | |
941 | store: { | |
942 | schema: DATASTORE_SCHEMA, | |
943 | }, | |
944 | }, | |
945 | }, | |
946 | returns: { | |
947 | type: GarbageCollectionStatus, | |
bb34b589 DM |
948 | }, |
949 | access: { | |
950 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT, false), | |
951 | }, | |
a92830dc DM |
952 | )] |
953 | /// Garbage collection status. | |
5eeea607 | 954 | pub fn garbage_collection_status( |
a92830dc | 955 | store: String, |
6049b71f | 956 | _info: &ApiMethod, |
dd5495d6 | 957 | _rpcenv: &mut dyn RpcEnvironment, |
a92830dc | 958 | ) -> Result<GarbageCollectionStatus, Error> { |
691c89a0 | 959 | |
f2b99c34 DM |
960 | let datastore = DataStore::lookup_datastore(&store)?; |
961 | ||
f2b99c34 | 962 | let status = datastore.last_gc_status(); |
691c89a0 | 963 | |
a92830dc | 964 | Ok(status) |
691c89a0 DM |
965 | } |
966 | ||
bb34b589 | 967 | #[api( |
30fb6025 DM |
968 | returns: { |
969 | description: "List the accessible datastores.", | |
970 | type: Array, | |
9b93c620 | 971 | items: { type: DataStoreListItem }, |
30fb6025 | 972 | }, |
bb34b589 | 973 | access: { |
54552dda | 974 | permission: &Permission::Anybody, |
bb34b589 DM |
975 | }, |
976 | )] | |
977 | /// Datastore list | |
bf78f708 | 978 | pub fn get_datastore_list( |
6049b71f DM |
979 | _param: Value, |
980 | _info: &ApiMethod, | |
54552dda | 981 | rpcenv: &mut dyn RpcEnvironment, |
455e5f71 | 982 | ) -> Result<Vec<DataStoreListItem>, Error> { |
15e9b4ed | 983 | |
d0187a51 | 984 | let (config, _digest) = datastore::config()?; |
15e9b4ed | 985 | |
e6dc35ac | 986 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda DM |
987 | let user_info = CachedUserInfo::new()?; |
988 | ||
30fb6025 | 989 | let mut list = Vec::new(); |
54552dda | 990 | |
30fb6025 | 991 | for (store, (_, data)) in &config.sections { |
e6dc35ac | 992 | let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]); |
54552dda | 993 | let allowed = (user_privs & (PRIV_DATASTORE_AUDIT| PRIV_DATASTORE_BACKUP)) != 0; |
30fb6025 | 994 | if allowed { |
455e5f71 FG |
995 | list.push( |
996 | DataStoreListItem { | |
997 | store: store.clone(), | |
998 | comment: data["comment"].as_str().map(String::from), | |
999 | } | |
1000 | ); | |
30fb6025 | 1001 | } |
54552dda DM |
1002 | } |
1003 | ||
44288184 | 1004 | Ok(list) |
15e9b4ed DM |
1005 | } |
1006 | ||
0ab08ac9 DM |
1007 | #[sortable] |
1008 | pub const API_METHOD_DOWNLOAD_FILE: ApiMethod = ApiMethod::new( | |
1009 | &ApiHandler::AsyncHttp(&download_file), | |
1010 | &ObjectSchema::new( | |
1011 | "Download single raw file from backup snapshot.", | |
1012 | &sorted!([ | |
66c49c21 | 1013 | ("store", false, &DATASTORE_SCHEMA), |
0ab08ac9 DM |
1014 | ("backup-type", false, &BACKUP_TYPE_SCHEMA), |
1015 | ("backup-id", false, &BACKUP_ID_SCHEMA), | |
1016 | ("backup-time", false, &BACKUP_TIME_SCHEMA), | |
4191018c | 1017 | ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA), |
0ab08ac9 DM |
1018 | ]), |
1019 | ) | |
54552dda DM |
1020 | ).access(None, &Permission::Privilege( |
1021 | &["datastore", "{store}"], | |
1022 | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, | |
1023 | true) | |
1024 | ); | |
691c89a0 | 1025 | |
bf78f708 | 1026 | pub fn download_file( |
9e47c0a5 DM |
1027 | _parts: Parts, |
1028 | _req_body: Body, | |
1029 | param: Value, | |
255f378a | 1030 | _info: &ApiMethod, |
54552dda | 1031 | rpcenv: Box<dyn RpcEnvironment>, |
bb084b9c | 1032 | ) -> ApiResponseFuture { |
9e47c0a5 | 1033 | |
ad51d02a DM |
1034 | async move { |
1035 | let store = tools::required_string_param(¶m, "store")?; | |
ad51d02a | 1036 | let datastore = DataStore::lookup_datastore(store)?; |
f14a8c9a | 1037 | |
e6dc35ac | 1038 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
54552dda | 1039 | |
ad51d02a | 1040 | let file_name = tools::required_string_param(¶m, "file-name")?.to_owned(); |
9e47c0a5 | 1041 | |
ad51d02a DM |
1042 | let backup_type = tools::required_string_param(¶m, "backup-type")?; |
1043 | let backup_id = tools::required_string_param(¶m, "backup-id")?; | |
1044 | let backup_time = tools::required_integer_param(¶m, "backup-time")?; | |
9e47c0a5 | 1045 | |
e0e5b442 | 1046 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
54552dda | 1047 | |
bff85572 | 1048 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?; |
54552dda | 1049 | |
abdb9763 | 1050 | println!("Download {} from {} ({}/{})", file_name, store, backup_dir, file_name); |
9e47c0a5 | 1051 | |
ad51d02a DM |
1052 | let mut path = datastore.base_path(); |
1053 | path.push(backup_dir.relative_path()); | |
1054 | path.push(&file_name); | |
1055 | ||
ba694720 | 1056 | let file = tokio::fs::File::open(&path) |
8aa67ee7 WB |
1057 | .await |
1058 | .map_err(|err| http_err!(BAD_REQUEST, "File open failed: {}", err))?; | |
ad51d02a | 1059 | |
db0cb9ce | 1060 | let payload = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new()) |
44288184 | 1061 | .map_ok(|bytes| bytes.freeze()) |
ba694720 DC |
1062 | .map_err(move |err| { |
1063 | eprintln!("error during streaming of '{:?}' - {}", &path, err); | |
1064 | err | |
1065 | }); | |
ad51d02a | 1066 | let body = Body::wrap_stream(payload); |
9e47c0a5 | 1067 | |
ad51d02a DM |
1068 | // fixme: set other headers ? |
1069 | Ok(Response::builder() | |
1070 | .status(StatusCode::OK) | |
1071 | .header(header::CONTENT_TYPE, "application/octet-stream") | |
1072 | .body(body) | |
1073 | .unwrap()) | |
1074 | }.boxed() | |
9e47c0a5 DM |
1075 | } |
1076 | ||
6ef9bb59 DC |
1077 | #[sortable] |
1078 | pub const API_METHOD_DOWNLOAD_FILE_DECODED: ApiMethod = ApiMethod::new( | |
1079 | &ApiHandler::AsyncHttp(&download_file_decoded), | |
1080 | &ObjectSchema::new( | |
1081 | "Download single decoded file from backup snapshot. Only works if it's not encrypted.", | |
1082 | &sorted!([ | |
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), | |
1088 | ]), | |
1089 | ) | |
1090 | ).access(None, &Permission::Privilege( | |
1091 | &["datastore", "{store}"], | |
1092 | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, | |
1093 | true) | |
1094 | ); | |
1095 | ||
bf78f708 | 1096 | pub fn download_file_decoded( |
6ef9bb59 DC |
1097 | _parts: Parts, |
1098 | _req_body: Body, | |
1099 | param: Value, | |
1100 | _info: &ApiMethod, | |
1101 | rpcenv: Box<dyn RpcEnvironment>, | |
1102 | ) -> ApiResponseFuture { | |
1103 | ||
1104 | async move { | |
1105 | let store = tools::required_string_param(¶m, "store")?; | |
1106 | let datastore = DataStore::lookup_datastore(store)?; | |
1107 | ||
e6dc35ac | 1108 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
6ef9bb59 DC |
1109 | |
1110 | let file_name = tools::required_string_param(¶m, "file-name")?.to_owned(); | |
1111 | ||
1112 | let backup_type = tools::required_string_param(¶m, "backup-type")?; | |
1113 | let backup_id = tools::required_string_param(¶m, "backup-id")?; | |
1114 | let backup_time = tools::required_integer_param(¶m, "backup-time")?; | |
1115 | ||
e0e5b442 | 1116 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
6ef9bb59 | 1117 | |
bff85572 | 1118 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?; |
6ef9bb59 | 1119 | |
2d55beec | 1120 | let (manifest, files) = read_backup_index(&datastore, &backup_dir)?; |
6ef9bb59 | 1121 | for file in files { |
f28d9088 | 1122 | if file.filename == file_name && file.crypt_mode == Some(CryptMode::Encrypt) { |
6ef9bb59 DC |
1123 | bail!("cannot decode '{}' - is encrypted", file_name); |
1124 | } | |
1125 | } | |
1126 | ||
1127 | println!("Download {} from {} ({}/{})", file_name, store, backup_dir, file_name); | |
1128 | ||
1129 | let mut path = datastore.base_path(); | |
1130 | path.push(backup_dir.relative_path()); | |
1131 | path.push(&file_name); | |
1132 | ||
1133 | let extension = file_name.rsplitn(2, '.').next().unwrap(); | |
1134 | ||
1135 | let body = match extension { | |
1136 | "didx" => { | |
1137 | let index = DynamicIndexReader::open(&path) | |
1138 | .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?; | |
2d55beec FG |
1139 | let (csum, size) = index.compute_csum(); |
1140 | manifest.verify_file(&file_name, &csum, size)?; | |
6ef9bb59 | 1141 | |
14f6c9cb | 1142 | let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None); |
6ef9bb59 | 1143 | let reader = AsyncIndexReader::new(index, chunk_reader); |
f386f512 | 1144 | Body::wrap_stream(AsyncReaderStream::new(reader) |
6ef9bb59 DC |
1145 | .map_err(move |err| { |
1146 | eprintln!("error during streaming of '{:?}' - {}", path, err); | |
1147 | err | |
1148 | })) | |
1149 | }, | |
1150 | "fidx" => { | |
1151 | let index = FixedIndexReader::open(&path) | |
1152 | .map_err(|err| format_err!("unable to read fixed index '{:?}' - {}", &path, err))?; | |
1153 | ||
2d55beec FG |
1154 | let (csum, size) = index.compute_csum(); |
1155 | manifest.verify_file(&file_name, &csum, size)?; | |
1156 | ||
14f6c9cb | 1157 | let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None); |
6ef9bb59 | 1158 | let reader = AsyncIndexReader::new(index, chunk_reader); |
f386f512 | 1159 | Body::wrap_stream(AsyncReaderStream::with_buffer_size(reader, 4*1024*1024) |
6ef9bb59 DC |
1160 | .map_err(move |err| { |
1161 | eprintln!("error during streaming of '{:?}' - {}", path, err); | |
1162 | err | |
1163 | })) | |
1164 | }, | |
1165 | "blob" => { | |
1166 | let file = std::fs::File::open(&path) | |
8aa67ee7 | 1167 | .map_err(|err| http_err!(BAD_REQUEST, "File open failed: {}", err))?; |
6ef9bb59 | 1168 | |
2d55beec FG |
1169 | // FIXME: load full blob to verify index checksum? |
1170 | ||
6ef9bb59 DC |
1171 | Body::wrap_stream( |
1172 | WrappedReaderStream::new(DataBlobReader::new(file, None)?) | |
1173 | .map_err(move |err| { | |
1174 | eprintln!("error during streaming of '{:?}' - {}", path, err); | |
1175 | err | |
1176 | }) | |
1177 | ) | |
1178 | }, | |
1179 | extension => { | |
1180 | bail!("cannot download '{}' files", extension); | |
1181 | }, | |
1182 | }; | |
1183 | ||
1184 | // fixme: set other headers ? | |
1185 | Ok(Response::builder() | |
1186 | .status(StatusCode::OK) | |
1187 | .header(header::CONTENT_TYPE, "application/octet-stream") | |
1188 | .body(body) | |
1189 | .unwrap()) | |
1190 | }.boxed() | |
1191 | } | |
1192 | ||
552c2259 | 1193 | #[sortable] |
0ab08ac9 DM |
1194 | pub const API_METHOD_UPLOAD_BACKUP_LOG: ApiMethod = ApiMethod::new( |
1195 | &ApiHandler::AsyncHttp(&upload_backup_log), | |
255f378a | 1196 | &ObjectSchema::new( |
54552dda | 1197 | "Upload the client backup log file into a backup snapshot ('client.log.blob').", |
552c2259 | 1198 | &sorted!([ |
66c49c21 | 1199 | ("store", false, &DATASTORE_SCHEMA), |
255f378a | 1200 | ("backup-type", false, &BACKUP_TYPE_SCHEMA), |
0ab08ac9 | 1201 | ("backup-id", false, &BACKUP_ID_SCHEMA), |
255f378a | 1202 | ("backup-time", false, &BACKUP_TIME_SCHEMA), |
552c2259 | 1203 | ]), |
9e47c0a5 | 1204 | ) |
54552dda DM |
1205 | ).access( |
1206 | Some("Only the backup creator/owner is allowed to do this."), | |
1207 | &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_BACKUP, false) | |
1208 | ); | |
9e47c0a5 | 1209 | |
bf78f708 | 1210 | pub fn upload_backup_log( |
07ee2235 DM |
1211 | _parts: Parts, |
1212 | req_body: Body, | |
1213 | param: Value, | |
255f378a | 1214 | _info: &ApiMethod, |
54552dda | 1215 | rpcenv: Box<dyn RpcEnvironment>, |
bb084b9c | 1216 | ) -> ApiResponseFuture { |
07ee2235 | 1217 | |
ad51d02a DM |
1218 | async move { |
1219 | let store = tools::required_string_param(¶m, "store")?; | |
ad51d02a | 1220 | let datastore = DataStore::lookup_datastore(store)?; |
07ee2235 | 1221 | |
96d65fbc | 1222 | let file_name = CLIENT_LOG_BLOB_NAME; |
07ee2235 | 1223 | |
ad51d02a DM |
1224 | let backup_type = tools::required_string_param(¶m, "backup-type")?; |
1225 | let backup_id = tools::required_string_param(¶m, "backup-id")?; | |
1226 | let backup_time = tools::required_integer_param(¶m, "backup-time")?; | |
07ee2235 | 1227 | |
e0e5b442 | 1228 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
07ee2235 | 1229 | |
e6dc35ac | 1230 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
bff85572 FG |
1231 | let owner = datastore.get_owner(backup_dir.group())?; |
1232 | check_backup_owner(&owner, &auth_id)?; | |
54552dda | 1233 | |
ad51d02a DM |
1234 | let mut path = datastore.base_path(); |
1235 | path.push(backup_dir.relative_path()); | |
1236 | path.push(&file_name); | |
07ee2235 | 1237 | |
ad51d02a DM |
1238 | if path.exists() { |
1239 | bail!("backup already contains a log."); | |
1240 | } | |
e128d4e8 | 1241 | |
ad51d02a | 1242 | println!("Upload backup log to {}/{}/{}/{}/{}", store, |
6a7be83e | 1243 | backup_type, backup_id, backup_dir.backup_time_string(), file_name); |
ad51d02a DM |
1244 | |
1245 | let data = req_body | |
1246 | .map_err(Error::from) | |
1247 | .try_fold(Vec::new(), |mut acc, chunk| { | |
1248 | acc.extend_from_slice(&*chunk); | |
1249 | future::ok::<_, Error>(acc) | |
1250 | }) | |
1251 | .await?; | |
1252 | ||
39f18b30 DM |
1253 | // always verify blob/CRC at server side |
1254 | let blob = DataBlob::load_from_reader(&mut &data[..])?; | |
1255 | ||
1256 | replace_file(&path, blob.raw_data(), CreateOptions::new())?; | |
ad51d02a DM |
1257 | |
1258 | // fixme: use correct formatter | |
1259 | Ok(crate::server::formatter::json_response(Ok(Value::Null))) | |
1260 | }.boxed() | |
07ee2235 DM |
1261 | } |
1262 | ||
5b1cfa01 DC |
1263 | #[api( |
1264 | input: { | |
1265 | properties: { | |
1266 | store: { | |
1267 | schema: DATASTORE_SCHEMA, | |
1268 | }, | |
1269 | "backup-type": { | |
1270 | schema: BACKUP_TYPE_SCHEMA, | |
1271 | }, | |
1272 | "backup-id": { | |
1273 | schema: BACKUP_ID_SCHEMA, | |
1274 | }, | |
1275 | "backup-time": { | |
1276 | schema: BACKUP_TIME_SCHEMA, | |
1277 | }, | |
1278 | "filepath": { | |
1279 | description: "Base64 encoded path.", | |
1280 | type: String, | |
1281 | } | |
1282 | }, | |
1283 | }, | |
1284 | access: { | |
1285 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, true), | |
1286 | }, | |
1287 | )] | |
1288 | /// Get the entries of the given path of the catalog | |
bf78f708 | 1289 | pub fn catalog( |
5b1cfa01 DC |
1290 | store: String, |
1291 | backup_type: String, | |
1292 | backup_id: String, | |
1293 | backup_time: i64, | |
1294 | filepath: String, | |
5b1cfa01 | 1295 | rpcenv: &mut dyn RpcEnvironment, |
227501c0 | 1296 | ) -> Result<Vec<ArchiveEntry>, Error> { |
5b1cfa01 DC |
1297 | let datastore = DataStore::lookup_datastore(&store)?; |
1298 | ||
e6dc35ac | 1299 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
5b1cfa01 | 1300 | |
e0e5b442 | 1301 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
5b1cfa01 | 1302 | |
bff85572 | 1303 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?; |
5b1cfa01 | 1304 | |
9238cdf5 FG |
1305 | let file_name = CATALOG_NAME; |
1306 | ||
2d55beec | 1307 | let (manifest, files) = read_backup_index(&datastore, &backup_dir)?; |
9238cdf5 FG |
1308 | for file in files { |
1309 | if file.filename == file_name && file.crypt_mode == Some(CryptMode::Encrypt) { | |
1310 | bail!("cannot decode '{}' - is encrypted", file_name); | |
1311 | } | |
1312 | } | |
1313 | ||
5b1cfa01 DC |
1314 | let mut path = datastore.base_path(); |
1315 | path.push(backup_dir.relative_path()); | |
9238cdf5 | 1316 | path.push(file_name); |
5b1cfa01 DC |
1317 | |
1318 | let index = DynamicIndexReader::open(&path) | |
1319 | .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?; | |
1320 | ||
2d55beec FG |
1321 | let (csum, size) = index.compute_csum(); |
1322 | manifest.verify_file(&file_name, &csum, size)?; | |
1323 | ||
14f6c9cb | 1324 | let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None); |
5b1cfa01 DC |
1325 | let reader = BufferedDynamicReader::new(index, chunk_reader); |
1326 | ||
1327 | let mut catalog_reader = CatalogReader::new(reader); | |
5b1cfa01 | 1328 | |
5279ee74 | 1329 | let path = if filepath != "root" && filepath != "/" { |
227501c0 DC |
1330 | base64::decode(filepath)? |
1331 | } else { | |
1332 | vec![b'/'] | |
1333 | }; | |
5b1cfa01 | 1334 | |
227501c0 | 1335 | helpers::list_dir_content(&mut catalog_reader, &path) |
5b1cfa01 DC |
1336 | } |
1337 | ||
d33d8f4e DC |
1338 | #[sortable] |
1339 | pub const API_METHOD_PXAR_FILE_DOWNLOAD: ApiMethod = ApiMethod::new( | |
1340 | &ApiHandler::AsyncHttp(&pxar_file_download), | |
1341 | &ObjectSchema::new( | |
1ffe0301 | 1342 | "Download single file from pxar file of a backup snapshot. Only works if it's not encrypted.", |
d33d8f4e DC |
1343 | &sorted!([ |
1344 | ("store", false, &DATASTORE_SCHEMA), | |
1345 | ("backup-type", false, &BACKUP_TYPE_SCHEMA), | |
1346 | ("backup-id", false, &BACKUP_ID_SCHEMA), | |
1347 | ("backup-time", false, &BACKUP_TIME_SCHEMA), | |
1348 | ("filepath", false, &StringSchema::new("Base64 encoded path").schema()), | |
1349 | ]), | |
1350 | ) | |
1351 | ).access(None, &Permission::Privilege( | |
1352 | &["datastore", "{store}"], | |
1353 | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, | |
1354 | true) | |
1355 | ); | |
1356 | ||
bf78f708 | 1357 | pub fn pxar_file_download( |
d33d8f4e DC |
1358 | _parts: Parts, |
1359 | _req_body: Body, | |
1360 | param: Value, | |
1361 | _info: &ApiMethod, | |
1362 | rpcenv: Box<dyn RpcEnvironment>, | |
1363 | ) -> ApiResponseFuture { | |
1364 | ||
1365 | async move { | |
1366 | let store = tools::required_string_param(¶m, "store")?; | |
1367 | let datastore = DataStore::lookup_datastore(&store)?; | |
1368 | ||
e6dc35ac | 1369 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
d33d8f4e DC |
1370 | |
1371 | let filepath = tools::required_string_param(¶m, "filepath")?.to_owned(); | |
1372 | ||
1373 | let backup_type = tools::required_string_param(¶m, "backup-type")?; | |
1374 | let backup_id = tools::required_string_param(¶m, "backup-id")?; | |
1375 | let backup_time = tools::required_integer_param(¶m, "backup-time")?; | |
1376 | ||
e0e5b442 | 1377 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
d33d8f4e | 1378 | |
bff85572 | 1379 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?; |
d33d8f4e | 1380 | |
d33d8f4e | 1381 | let mut components = base64::decode(&filepath)?; |
3984a5fd | 1382 | if !components.is_empty() && components[0] == b'/' { |
d33d8f4e DC |
1383 | components.remove(0); |
1384 | } | |
1385 | ||
d8d8af98 | 1386 | let mut split = components.splitn(2, |c| *c == b'/'); |
9238cdf5 | 1387 | let pxar_name = std::str::from_utf8(split.next().unwrap())?; |
0dfce17a | 1388 | let file_path = split.next().unwrap_or(b"/"); |
2d55beec | 1389 | let (manifest, files) = read_backup_index(&datastore, &backup_dir)?; |
9238cdf5 FG |
1390 | for file in files { |
1391 | if file.filename == pxar_name && file.crypt_mode == Some(CryptMode::Encrypt) { | |
1392 | bail!("cannot decode '{}' - is encrypted", pxar_name); | |
1393 | } | |
1394 | } | |
d33d8f4e | 1395 | |
9238cdf5 FG |
1396 | let mut path = datastore.base_path(); |
1397 | path.push(backup_dir.relative_path()); | |
1398 | path.push(pxar_name); | |
d33d8f4e DC |
1399 | |
1400 | let index = DynamicIndexReader::open(&path) | |
1401 | .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?; | |
1402 | ||
2d55beec FG |
1403 | let (csum, size) = index.compute_csum(); |
1404 | manifest.verify_file(&pxar_name, &csum, size)?; | |
1405 | ||
14f6c9cb | 1406 | let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None); |
d33d8f4e DC |
1407 | let reader = BufferedDynamicReader::new(index, chunk_reader); |
1408 | let archive_size = reader.archive_size(); | |
1409 | let reader = LocalDynamicReadAt::new(reader); | |
1410 | ||
1411 | let decoder = Accessor::new(reader, archive_size).await?; | |
1412 | let root = decoder.open_root().await?; | |
2e219481 | 1413 | let path = OsStr::from_bytes(file_path).to_os_string(); |
d33d8f4e | 1414 | let file = root |
2e219481 DC |
1415 | .lookup(&path).await? |
1416 | .ok_or_else(|| format_err!("error opening '{:?}'", path))?; | |
d33d8f4e | 1417 | |
804f6143 DC |
1418 | let body = match file.kind() { |
1419 | EntryKind::File { .. } => Body::wrap_stream( | |
1420 | AsyncReaderStream::new(file.contents().await?).map_err(move |err| { | |
1421 | eprintln!("error during streaming of file '{:?}' - {}", filepath, err); | |
1422 | err | |
1423 | }), | |
1424 | ), | |
1425 | EntryKind::Hardlink(_) => Body::wrap_stream( | |
1426 | AsyncReaderStream::new(decoder.follow_hardlink(&file).await?.contents().await?) | |
1427 | .map_err(move |err| { | |
1428 | eprintln!( | |
1429 | "error during streaming of hardlink '{:?}' - {}", | |
2e219481 | 1430 | path, err |
804f6143 DC |
1431 | ); |
1432 | err | |
1433 | }), | |
1434 | ), | |
1435 | EntryKind::Directory => { | |
1436 | let (sender, receiver) = tokio::sync::mpsc::channel(100); | |
804f6143 | 1437 | let channelwriter = AsyncChannelWriter::new(sender, 1024 * 1024); |
2e219481 DC |
1438 | crate::server::spawn_internal_task( |
1439 | create_zip(channelwriter, decoder, path.clone(), false) | |
1440 | ); | |
7c667013 | 1441 | Body::wrap_stream(ReceiverStream::new(receiver).map_err(move |err| { |
2e219481 | 1442 | eprintln!("error during streaming of zip '{:?}' - {}", path, err); |
d33d8f4e | 1443 | err |
804f6143 DC |
1444 | })) |
1445 | } | |
1446 | other => bail!("cannot download file of type {:?}", other), | |
1447 | }; | |
d33d8f4e DC |
1448 | |
1449 | // fixme: set other headers ? | |
1450 | Ok(Response::builder() | |
1451 | .status(StatusCode::OK) | |
1452 | .header(header::CONTENT_TYPE, "application/octet-stream") | |
1453 | .body(body) | |
1454 | .unwrap()) | |
1455 | }.boxed() | |
1456 | } | |
1457 | ||
1a0d3d11 DM |
1458 | #[api( |
1459 | input: { | |
1460 | properties: { | |
1461 | store: { | |
1462 | schema: DATASTORE_SCHEMA, | |
1463 | }, | |
1464 | timeframe: { | |
1465 | type: RRDTimeFrameResolution, | |
1466 | }, | |
1467 | cf: { | |
1468 | type: RRDMode, | |
1469 | }, | |
1470 | }, | |
1471 | }, | |
1472 | access: { | |
1473 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true), | |
1474 | }, | |
1475 | )] | |
1476 | /// Read datastore stats | |
bf78f708 | 1477 | pub fn get_rrd_stats( |
1a0d3d11 DM |
1478 | store: String, |
1479 | timeframe: RRDTimeFrameResolution, | |
1480 | cf: RRDMode, | |
1481 | _param: Value, | |
1482 | ) -> Result<Value, Error> { | |
1483 | ||
431cc7b1 DC |
1484 | create_value_from_rrd( |
1485 | &format!("datastore/{}", store), | |
1a0d3d11 DM |
1486 | &[ |
1487 | "total", "used", | |
c94e1f65 DM |
1488 | "read_ios", "read_bytes", |
1489 | "write_ios", "write_bytes", | |
1490 | "io_ticks", | |
1a0d3d11 DM |
1491 | ], |
1492 | timeframe, | |
1493 | cf, | |
1494 | ) | |
1495 | } | |
1496 | ||
912b3f5b DM |
1497 | #[api( |
1498 | input: { | |
1499 | properties: { | |
1500 | store: { | |
1501 | schema: DATASTORE_SCHEMA, | |
1502 | }, | |
1503 | "backup-type": { | |
1504 | schema: BACKUP_TYPE_SCHEMA, | |
1505 | }, | |
1506 | "backup-id": { | |
1507 | schema: BACKUP_ID_SCHEMA, | |
1508 | }, | |
1509 | "backup-time": { | |
1510 | schema: BACKUP_TIME_SCHEMA, | |
1511 | }, | |
1512 | }, | |
1513 | }, | |
1514 | access: { | |
1401f4be | 1515 | permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true), |
912b3f5b DM |
1516 | }, |
1517 | )] | |
1518 | /// Get "notes" for a specific backup | |
bf78f708 | 1519 | pub fn get_notes( |
912b3f5b DM |
1520 | store: String, |
1521 | backup_type: String, | |
1522 | backup_id: String, | |
1523 | backup_time: i64, | |
1524 | rpcenv: &mut dyn RpcEnvironment, | |
1525 | ) -> Result<String, Error> { | |
1526 | let datastore = DataStore::lookup_datastore(&store)?; | |
1527 | ||
e6dc35ac | 1528 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
e0e5b442 | 1529 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
912b3f5b | 1530 | |
1401f4be | 1531 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_AUDIT)?; |
912b3f5b | 1532 | |
883aa6d5 | 1533 | let (manifest, _) = datastore.load_manifest(&backup_dir)?; |
912b3f5b | 1534 | |
883aa6d5 | 1535 | let notes = manifest.unprotected["notes"] |
912b3f5b DM |
1536 | .as_str() |
1537 | .unwrap_or(""); | |
1538 | ||
1539 | Ok(String::from(notes)) | |
1540 | } | |
1541 | ||
1542 | #[api( | |
1543 | input: { | |
1544 | properties: { | |
1545 | store: { | |
1546 | schema: DATASTORE_SCHEMA, | |
1547 | }, | |
1548 | "backup-type": { | |
1549 | schema: BACKUP_TYPE_SCHEMA, | |
1550 | }, | |
1551 | "backup-id": { | |
1552 | schema: BACKUP_ID_SCHEMA, | |
1553 | }, | |
1554 | "backup-time": { | |
1555 | schema: BACKUP_TIME_SCHEMA, | |
1556 | }, | |
1557 | notes: { | |
1558 | description: "A multiline text.", | |
1559 | }, | |
1560 | }, | |
1561 | }, | |
1562 | access: { | |
b728a69e FG |
1563 | permission: &Permission::Privilege(&["datastore", "{store}"], |
1564 | PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_BACKUP, | |
1565 | true), | |
912b3f5b DM |
1566 | }, |
1567 | )] | |
1568 | /// Set "notes" for a specific backup | |
bf78f708 | 1569 | pub fn set_notes( |
912b3f5b DM |
1570 | store: String, |
1571 | backup_type: String, | |
1572 | backup_id: String, | |
1573 | backup_time: i64, | |
1574 | notes: String, | |
1575 | rpcenv: &mut dyn RpcEnvironment, | |
1576 | ) -> Result<(), Error> { | |
1577 | let datastore = DataStore::lookup_datastore(&store)?; | |
1578 | ||
e6dc35ac | 1579 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
e0e5b442 | 1580 | let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?; |
912b3f5b | 1581 | |
b728a69e | 1582 | check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_MODIFY)?; |
912b3f5b | 1583 | |
1a374fcf SR |
1584 | datastore.update_manifest(&backup_dir,|manifest| { |
1585 | manifest.unprotected["notes"] = notes.into(); | |
1586 | }).map_err(|err| format_err!("unable to update manifest blob - {}", err))?; | |
912b3f5b DM |
1587 | |
1588 | Ok(()) | |
1589 | } | |
1590 | ||
72be0eb1 | 1591 | #[api( |
4940012d | 1592 | input: { |
72be0eb1 DW |
1593 | properties: { |
1594 | store: { | |
1595 | schema: DATASTORE_SCHEMA, | |
1596 | }, | |
1597 | "backup-type": { | |
1598 | schema: BACKUP_TYPE_SCHEMA, | |
1599 | }, | |
1600 | "backup-id": { | |
1601 | schema: BACKUP_ID_SCHEMA, | |
1602 | }, | |
1603 | "new-owner": { | |
e6dc35ac | 1604 | type: Authid, |
72be0eb1 DW |
1605 | }, |
1606 | }, | |
4940012d FG |
1607 | }, |
1608 | access: { | |
bff85572 FG |
1609 | permission: &Permission::Anybody, |
1610 | description: "Datastore.Modify on whole datastore, or changing ownership between user and a user's token for owned backups with Datastore.Backup" | |
4940012d | 1611 | }, |
72be0eb1 DW |
1612 | )] |
1613 | /// Change owner of a backup group | |
bf78f708 | 1614 | pub fn set_backup_owner( |
72be0eb1 DW |
1615 | store: String, |
1616 | backup_type: String, | |
1617 | backup_id: String, | |
e6dc35ac | 1618 | new_owner: Authid, |
bff85572 | 1619 | rpcenv: &mut dyn RpcEnvironment, |
72be0eb1 DW |
1620 | ) -> Result<(), Error> { |
1621 | ||
1622 | let datastore = DataStore::lookup_datastore(&store)?; | |
1623 | ||
1624 | let backup_group = BackupGroup::new(backup_type, backup_id); | |
1625 | ||
bff85572 FG |
1626 | let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?; |
1627 | ||
72be0eb1 DW |
1628 | let user_info = CachedUserInfo::new()?; |
1629 | ||
bff85572 FG |
1630 | let privs = user_info.lookup_privs(&auth_id, &["datastore", &store]); |
1631 | ||
1632 | let allowed = if (privs & PRIV_DATASTORE_MODIFY) != 0 { | |
1633 | // High-privilege user/token | |
1634 | true | |
1635 | } else if (privs & PRIV_DATASTORE_BACKUP) != 0 { | |
1636 | let owner = datastore.get_owner(&backup_group)?; | |
1637 | ||
1638 | match (owner.is_token(), new_owner.is_token()) { | |
1639 | (true, true) => { | |
1640 | // API token to API token, owned by same user | |
1641 | let owner = owner.user(); | |
1642 | let new_owner = new_owner.user(); | |
1643 | owner == new_owner && Authid::from(owner.clone()) == auth_id | |
1644 | }, | |
1645 | (true, false) => { | |
1646 | // API token to API token owner | |
1647 | Authid::from(owner.user().clone()) == auth_id | |
1648 | && new_owner == auth_id | |
1649 | }, | |
1650 | (false, true) => { | |
1651 | // API token owner to API token | |
1652 | owner == auth_id | |
1653 | && Authid::from(new_owner.user().clone()) == auth_id | |
1654 | }, | |
1655 | (false, false) => { | |
1656 | // User to User, not allowed for unprivileged users | |
1657 | false | |
1658 | }, | |
1659 | } | |
1660 | } else { | |
1661 | false | |
1662 | }; | |
1663 | ||
1664 | if !allowed { | |
1665 | return Err(http_err!(UNAUTHORIZED, | |
1666 | "{} does not have permission to change owner of backup group '{}' to {}", | |
1667 | auth_id, | |
1668 | backup_group, | |
1669 | new_owner, | |
1670 | )); | |
1671 | } | |
1672 | ||
e6dc35ac FG |
1673 | if !user_info.is_active_auth_id(&new_owner) { |
1674 | bail!("{} '{}' is inactive or non-existent", | |
1675 | if new_owner.is_token() { | |
1676 | "API token".to_string() | |
1677 | } else { | |
1678 | "user".to_string() | |
1679 | }, | |
1680 | new_owner); | |
72be0eb1 DW |
1681 | } |
1682 | ||
1683 | datastore.set_owner(&backup_group, &new_owner, true)?; | |
1684 | ||
1685 | Ok(()) | |
1686 | } | |
1687 | ||
552c2259 | 1688 | #[sortable] |
255f378a | 1689 | const DATASTORE_INFO_SUBDIRS: SubdirMap = &[ |
5b1cfa01 DC |
1690 | ( |
1691 | "catalog", | |
1692 | &Router::new() | |
1693 | .get(&API_METHOD_CATALOG) | |
1694 | ), | |
72be0eb1 DW |
1695 | ( |
1696 | "change-owner", | |
1697 | &Router::new() | |
1698 | .post(&API_METHOD_SET_BACKUP_OWNER) | |
1699 | ), | |
255f378a DM |
1700 | ( |
1701 | "download", | |
1702 | &Router::new() | |
1703 | .download(&API_METHOD_DOWNLOAD_FILE) | |
1704 | ), | |
6ef9bb59 DC |
1705 | ( |
1706 | "download-decoded", | |
1707 | &Router::new() | |
1708 | .download(&API_METHOD_DOWNLOAD_FILE_DECODED) | |
1709 | ), | |
255f378a DM |
1710 | ( |
1711 | "files", | |
1712 | &Router::new() | |
09b1f7b2 | 1713 | .get(&API_METHOD_LIST_SNAPSHOT_FILES) |
255f378a DM |
1714 | ), |
1715 | ( | |
1716 | "gc", | |
1717 | &Router::new() | |
1718 | .get(&API_METHOD_GARBAGE_COLLECTION_STATUS) | |
1719 | .post(&API_METHOD_START_GARBAGE_COLLECTION) | |
1720 | ), | |
1721 | ( | |
1722 | "groups", | |
1723 | &Router::new() | |
b31c8019 | 1724 | .get(&API_METHOD_LIST_GROUPS) |
255f378a | 1725 | ), |
912b3f5b DM |
1726 | ( |
1727 | "notes", | |
1728 | &Router::new() | |
1729 | .get(&API_METHOD_GET_NOTES) | |
1730 | .put(&API_METHOD_SET_NOTES) | |
1731 | ), | |
255f378a DM |
1732 | ( |
1733 | "prune", | |
1734 | &Router::new() | |
1735 | .post(&API_METHOD_PRUNE) | |
1736 | ), | |
d33d8f4e DC |
1737 | ( |
1738 | "pxar-file-download", | |
1739 | &Router::new() | |
1740 | .download(&API_METHOD_PXAR_FILE_DOWNLOAD) | |
1741 | ), | |
1a0d3d11 DM |
1742 | ( |
1743 | "rrd", | |
1744 | &Router::new() | |
1745 | .get(&API_METHOD_GET_RRD_STATS) | |
1746 | ), | |
255f378a DM |
1747 | ( |
1748 | "snapshots", | |
1749 | &Router::new() | |
fc189b19 | 1750 | .get(&API_METHOD_LIST_SNAPSHOTS) |
68a6a0ee | 1751 | .delete(&API_METHOD_DELETE_SNAPSHOT) |
255f378a DM |
1752 | ), |
1753 | ( | |
1754 | "status", | |
1755 | &Router::new() | |
1756 | .get(&API_METHOD_STATUS) | |
1757 | ), | |
1758 | ( | |
1759 | "upload-backup-log", | |
1760 | &Router::new() | |
1761 | .upload(&API_METHOD_UPLOAD_BACKUP_LOG) | |
1762 | ), | |
c2009e53 DM |
1763 | ( |
1764 | "verify", | |
1765 | &Router::new() | |
1766 | .post(&API_METHOD_VERIFY) | |
1767 | ), | |
255f378a DM |
1768 | ]; |
1769 | ||
ad51d02a | 1770 | const DATASTORE_INFO_ROUTER: Router = Router::new() |
255f378a DM |
1771 | .get(&list_subdirs_api_method!(DATASTORE_INFO_SUBDIRS)) |
1772 | .subdirs(DATASTORE_INFO_SUBDIRS); | |
1773 | ||
1774 | ||
1775 | pub const ROUTER: Router = Router::new() | |
bb34b589 | 1776 | .get(&API_METHOD_GET_DATASTORE_LIST) |
255f378a | 1777 | .match_all("store", &DATASTORE_INFO_ROUTER); |