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