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