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