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