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