1 extern crate proxmox_backup
;
4 //use std::os::unix::io::AsRawFd;
5 use chrono
::{DateTime, Local, TimeZone}
;
6 use std
::path
::{Path, PathBuf}
;
7 use std
::collections
::HashMap
;
9 use proxmox_backup
::tools
;
10 use proxmox_backup
::cli
::*;
11 use proxmox_backup
::api_schema
::*;
12 use proxmox_backup
::api_schema
::router
::*;
13 use proxmox_backup
::client
::*;
14 use proxmox_backup
::backup
::*;
15 //use proxmox_backup::backup::image_index::*;
16 //use proxmox_backup::config::datastore;
17 //use proxmox_backup::pxar::encoder::*;
18 //use proxmox_backup::backup::datastore::*;
20 use serde_json
::{json, Value}
;
24 use xdg
::BaseDirectories
;
26 use lazy_static
::lazy_static
;
28 use tokio
::sync
::mpsc
;
31 static ref BACKUPSPEC_REGEX
: Regex
= Regex
::new(r
"^([a-zA-Z0-9_-]+\.(?:pxar|raw)):(.+)$").unwrap();
35 fn record_repository(repo
: &BackupRepository
) {
37 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
42 // usually $HOME/.cache/proxmox-backup/repo-list
43 let path
= match base
.place_cache_file("repo-list") {
48 let mut data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
50 let repo
= repo
.to_string();
52 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
54 let mut map
= serde_json
::map
::Map
::new();
58 let mut max_repo
= None
;
59 for (repo
, count
) in data
.as_object().unwrap() {
60 if map
.contains_key(repo
) { continue; }
61 if let Some(count
) = count
.as_i64() {
64 max_repo
= Some(repo
);
68 if let Some(repo
) = max_repo
{
69 map
.insert(repo
.to_owned(), json
!(max_used
));
73 if map
.len() > 10 { // store max. 10 repos
78 let new_data
= json
!(map
);
80 let _
= tools
::file_set_contents(path
, new_data
.to_string().as_bytes(), None
);
83 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
85 let mut result
= vec
![];
87 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
92 // usually $HOME/.cache/proxmox-backup/repo-list
93 let path
= match base
.place_cache_file("repo-list") {
98 let data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
100 if let Some(map
) = data
.as_object() {
101 for (repo
, _count
) in map
{
102 result
.push(repo
.to_owned());
109 fn backup_directory
<P
: AsRef
<Path
>>(
110 client
: &BackupClient
,
113 chunk_size
: Option
<u64>,
114 all_file_systems
: bool
,
116 ) -> Result
<(), Error
> {
118 if let Some(_size
) = chunk_size
{
122 let pxar_stream
= PxarBackupStream
::open(dir_path
.as_ref(), all_file_systems
, verbose
)?
;
123 let chunk_stream
= ChunkStream
::new(pxar_stream
);
125 let (tx
, rx
) = mpsc
::channel(10); // allow to buffer 10 chunks
128 .map_err(Error
::from
)
129 .and_then(|x
| x
); // flatten
131 // spawn chunker inside a separate task so that it can run parallel
133 tx
.send_all(chunk_stream
.then(|r
| Ok(r
)))
134 .map_err(|e
| {}
).map(|_
| ())
137 client
.upload_stream(archive_name
, stream
, "dynamic", None
).wait()?
;
143 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
145 let mut target = PathBuf::from(target);
147 if let Some(ext) = target.extension() {
149 bail!("got wrong file extension - expected '.fidx'");
152 target.set_extension("fidx");
155 let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
157 tools::file_chunker(file, chunk_size, |pos, chunk| {
158 index.add_chunk(pos, chunk)?;
162 index.close()?; // commit changes
168 fn strip_chunked_file_expenstions(list
: Vec
<String
>) -> Vec
<String
> {
170 let mut result
= vec
![];
172 for file
in list
.into_iter() {
173 if file
.ends_with(".didx") {
174 result
.push(file
[..file
.len()-5].to_owned());
175 } else if file
.ends_with(".fidx") {
176 result
.push(file
[..file
.len()-5].to_owned());
178 result
.push(file
); // should not happen
189 _rpcenv: &mut RpcEnvironment,
190 ) -> Result<Value, Error> {
192 let repo_url = tools::required_string_param(¶m, "repository")?;
193 let repo: BackupRepository = repo_url.parse()?;
195 let mut client = HttpClient::new(repo.host(), repo.user())?;
197 let path = format!("api2/json/admin/datastore/{}/backups", repo.store());
199 let result = client.get(&path, None)?;
201 record_repository(&repo);
203 // fixme: implement and use output formatter instead ..
204 let list = result["data"].as_array().unwrap();
208 let id = item["backup-id"].as_str().unwrap();
209 let btype = item["backup-type"].as_str().unwrap();
210 let epoch = item["backup-time"].as_i64().unwrap();
212 let backup_dir = BackupDir::new(btype, id, epoch);
214 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
215 let files = strip_chunked_file_expenstions(files);
217 for filename in files {
218 let path = backup_dir.relative_path().to_str().unwrap().to_owned();
219 println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename);
228 fn list_backup_groups(
231 _rpcenv
: &mut RpcEnvironment
,
232 ) -> Result
<Value
, Error
> {
234 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
235 let repo
: BackupRepository
= repo_url
.parse()?
;
237 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
239 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
241 let mut result
= client
.get(&path
, None
).wait()?
;
243 record_repository(&repo
);
245 // fixme: implement and use output formatter instead ..
246 let list
= result
["data"].as_array_mut().unwrap();
248 list
.sort_unstable_by(|a
, b
| {
249 let a_id
= a
["backup-id"].as_str().unwrap();
250 let a_backup_type
= a
["backup-type"].as_str().unwrap();
251 let b_id
= b
["backup-id"].as_str().unwrap();
252 let b_backup_type
= b
["backup-type"].as_str().unwrap();
254 let type_order
= a_backup_type
.cmp(b_backup_type
);
255 if type_order
== std
::cmp
::Ordering
::Equal
{
264 let id
= item
["backup-id"].as_str().unwrap();
265 let btype
= item
["backup-type"].as_str().unwrap();
266 let epoch
= item
["last-backup"].as_i64().unwrap();
267 let last_backup
= Local
.timestamp(epoch
, 0);
268 let backup_count
= item
["backup-count"].as_u64().unwrap();
270 let group
= BackupGroup
::new(btype
, id
);
272 let path
= group
.group_path().to_str().unwrap().to_owned();
274 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
275 let files
= strip_chunked_file_expenstions(files
);
277 println
!("{:20} | {} | {:5} | {}", path
, last_backup
.format("%c"),
278 backup_count
, tools
::join(&files
, ' '
));
288 _rpcenv
: &mut RpcEnvironment
,
289 ) -> Result
<Value
, Error
> {
291 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
292 let repo
: BackupRepository
= repo_url
.parse()?
;
294 let path
= tools
::required_string_param(¶m
, "group")?
;
295 let group
= BackupGroup
::parse(path
)?
;
297 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
299 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
301 let result
= client
.get(&path
, Some(json
!({
302 "backup-type": group
.backup_type(),
303 "backup-id": group
.backup_id(),
306 record_repository(&repo
);
308 // fixme: implement and use output formatter instead ..
309 let list
= result
["data"].as_array().unwrap();
313 let id
= item
["backup-id"].as_str().unwrap();
314 let btype
= item
["backup-type"].as_str().unwrap();
315 let epoch
= item
["backup-time"].as_i64().unwrap();
317 let snapshot
= BackupDir
::new(btype
, id
, epoch
);
319 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
321 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
322 let files
= strip_chunked_file_expenstions(files
);
324 println
!("{} | {} | {}", path
, snapshot
.backup_time().format("%c"), tools
::join(&files
, ' '
));
333 _rpcenv
: &mut RpcEnvironment
,
334 ) -> Result
<Value
, Error
> {
336 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
337 let repo
: BackupRepository
= repo_url
.parse()?
;
339 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
340 let snapshot
= BackupDir
::parse(path
)?
;
342 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
344 let path
= format
!("api2/json/admin/datastore/{}/snapshots", repo
.store());
346 let result
= client
.delete(&path
, Some(json
!({
347 "backup-type": snapshot
.group().backup_type(),
348 "backup-id": snapshot
.group().backup_id(),
349 "backup-time": snapshot
.backup_time().timestamp(),
352 record_repository(&repo
);
357 fn start_garbage_collection(
360 _rpcenv
: &mut RpcEnvironment
,
361 ) -> Result
<Value
, Error
> {
363 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
364 let repo
: BackupRepository
= repo_url
.parse()?
;
366 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
368 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
370 let result
= client
.post(&path
, None
).wait()?
;
372 record_repository(&repo
);
377 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
379 if let Some(caps
) = BACKUPSPEC_REGEX
.captures(value
) {
380 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
382 bail
!("unable to parse directory specification '{}'", value
);
388 _rpcenv
: &mut RpcEnvironment
,
389 ) -> Result
<Value
, Error
> {
391 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
393 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
395 let repo
: BackupRepository
= repo_url
.parse()?
;
397 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
399 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
401 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| v
*1024);
403 if let Some(size
) = chunk_size_opt
{
404 verify_chunk_size(size
)?
;
407 let backup_id
= param
["host-id"].as_str().unwrap_or(&tools
::nodename());
409 let mut upload_list
= vec
![];
411 for backupspec
in backupspec_list
{
412 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
414 use std
::os
::unix
::fs
::FileTypeExt
;
416 let metadata
= match std
::fs
::metadata(filename
) {
418 Err(err
) => bail
!("unable to access '{}' - {}", filename
, err
),
420 let file_type
= metadata
.file_type();
422 if file_type
.is_dir() {
424 upload_list
.push((filename
.to_owned(), target
.to_owned()));
426 } else if file_type
.is_file() || file_type
.is_block_device() {
428 let size
= tools
::image_size(&PathBuf
::from(filename
))?
;
430 if size
== 0 { bail!("got zero-sized file '{}'
", filename); }
432 panic!("implement me
");
434 //backup_image(&datastore, &file, size, &target, chunk_size)?;
436 // let idx = datastore.open_image_reader(target)?;
440 bail!("unsupported file
type (expected a directory
, file or block device
)");
444 let backup_time = Local.timestamp(Local::now().timestamp(), 0);
446 let client = HttpClient::new(repo.host(), repo.user())?;
447 record_repository(&repo);
449 println!("Starting backup
");
450 println!("Client name
: {}
", tools::nodename());
451 println!("Start Time
: {}
", backup_time.to_rfc3339());
453 let client = client.start_backup(repo.store(), "host
", &backup_id, verbose).wait()?;
455 for (filename, target) in upload_list {
456 println!("Upload '{}' to '{:?}'
as {}
", filename, repo, target);
457 backup_directory(&client, &filename, &target, chunk_size_opt, all_file_systems, verbose)?;
460 client.finish().wait()?;
462 let end_time = Local.timestamp(Local::now().timestamp(), 0);
463 let elapsed = end_time.signed_duration_since(backup_time);
464 println!("Duration
: {}
", elapsed);
466 println!("End Time
: {}
", end_time.to_rfc3339());
471 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
473 let mut result = vec![];
475 let data: Vec<&str> = arg.splitn(2, ':').collect();
478 result.push(String::from("root
.pxar
:/"));
479 result.push(String::from("etc
.pxar
:/etc
"));
483 let files = tools::complete_file_name(data[1], param);
486 result.push(format!("{}
:{}
", data[0], file));
495 _rpcenv: &mut RpcEnvironment,
496 ) -> Result<Value, Error> {
498 let repo_url = tools::required_string_param(¶m, "repository
")?;
499 let repo: BackupRepository = repo_url.parse()?;
501 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
503 let mut client = HttpClient::new(repo.host(), repo.user())?;
505 record_repository(&repo);
507 let path = tools::required_string_param(¶m, "snapshot
")?;
511 if path.matches('/').count() == 1 {
512 let group = BackupGroup::parse(path)?;
514 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots
", repo.store());
515 let result = client.get(&path, Some(json!({
516 "backup
-type": group.backup_type(),
517 "backup
-id
": group.backup_id(),
520 let list = result["data
"].as_array().unwrap();
522 bail!("backup group '{}' does not contain any snapshots
:", path);
525 query = tools::json_object_to_query(json!({
526 "backup
-type": group.backup_type(),
527 "backup
-id
": group.backup_id(),
528 "backup
-time
": list[0]["backup
-time
"].as_i64().unwrap(),
529 "archive
-name
": archive_name,
532 let snapshot = BackupDir::parse(path)?;
534 query = tools::json_object_to_query(json!({
535 "backup
-type": snapshot.group().backup_type(),
536 "backup
-id
": snapshot.group().backup_id(),
537 "backup
-time
": snapshot.backup_time().timestamp(),
538 "archive
-name
": archive_name,
542 let target = tools::required_string_param(¶m, "target
")?;
544 if archive_name.ends_with(".pxar
") {
545 let path = format!("api2
/json
/admin
/datastore
/{}
/pxar?{}
", repo.store(), query);
547 println!("DOWNLOAD FILE {} to {}
", path, target);
549 let target = PathBuf::from(target);
550 let writer = PxarDecodeWriter::new(&target, true)?;
551 client.download(&path, Box::new(writer)).wait()?;
553 bail!("unknown file extensions
- unable to download '{}'
", archive_name);
562 _rpcenv: &mut RpcEnvironment,
563 ) -> Result<Value, Error> {
565 let repo_url = tools::required_string_param(¶m, "repository
")?;
566 let repo: BackupRepository = repo_url.parse()?;
568 let mut client = HttpClient::new(repo.host(), repo.user())?;
570 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
572 param.as_object_mut().unwrap().remove("repository
");
574 let result = client.post(&path, Some(param)).wait()?;
576 record_repository(&repo);
581 // like get, but simply ignore errors and return Null instead
582 fn try_get(repo: &BackupRepository, url: &str) -> Value {
584 let client = match HttpClient::new(repo.host(), repo.user()) {
586 _ => return Value::Null,
589 let mut resp = match client.get(url, None).wait() {
591 _ => return Value::Null,
594 if let Some(map) = resp.as_object_mut() {
595 if let Some(data) = map.remove("data
") {
602 fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> {
604 let repo_url = match param.get("repository
") {
609 let repo: BackupRepository = match repo_url.parse() {
617 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
619 let mut result = vec![];
621 let repo = match extract_repo(param) {
626 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
628 let data = try_get(&repo, &path);
630 if let Some(list) = data.as_array() {
632 if let (Some(backup_id), Some(backup_type)) =
633 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
635 result.push(format!("{}
/{}
", backup_type, backup_id));
643 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
645 let mut result = vec![];
647 let repo = match extract_repo(param) {
652 if arg.matches('/').count() < 2 {
653 let groups = complete_backup_group(arg, param);
654 for group in groups {
655 result.push(group.to_string());
656 result.push(format!("{}
/", group));
661 let mut parts = arg.split('/');
662 let query = tools::json_object_to_query(json!({
663 "backup
-type": parts.next().unwrap(),
664 "backup
-id
": parts.next().unwrap(),
667 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots?{}
", repo.store(), query);
669 let data = try_get(&repo, &path);
671 if let Some(list) = data.as_array() {
673 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
674 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
676 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
677 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
685 fn complete_archive_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
687 let mut result = vec![];
689 let repo = match extract_repo(param) {
694 let snapshot = match param.get("snapshot
") {
696 match BackupDir::parse(path) {
704 let query = tools::json_object_to_query(json!({
705 "backup
-type": snapshot.group().backup_type(),
706 "backup
-id
": snapshot.group().backup_id(),
707 "backup
-time
": snapshot.backup_time().timestamp(),
710 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
712 let data = try_get(&repo, &path);
714 if let Some(list) = data.as_array() {
716 if let Some(filename) = item.as_str() {
717 result.push(filename.to_owned());
722 strip_chunked_file_expenstions(result)
725 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
727 let mut result = vec![];
731 result.push(size.to_string());
733 if size > 4096 { break; }
741 let repo_url_schema: Arc<Schema> = Arc::new(
742 StringSchema::new("Repository URL
.")
743 .format(BACKUP_REPO_URL.clone())
748 let backup_source_schema: Arc<Schema> = Arc::new(
749 StringSchema::new("Backup source
specification ([<label
>:<path
>]).")
750 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
754 let backup_cmd_def = CliCommand::new(
757 ObjectSchema::new("Create (host
) backup
.")
758 .required("repository
", repo_url_schema.clone())
762 "List of backup source
specifications ([<label
.ext
>:<path
>] ...)",
763 backup_source_schema,
768 BooleanSchema::new("Verbose output
.").default(false))
771 StringSchema::new("Use specified ID
for the backup group
name ('host
/<id
>'
). The
default is the system hostname
."))
774 IntegerSchema::new("Chunk size
in KB
. Must be a power of
2.")
780 .arg_param(vec!["repository
", "backupspec
"])
781 .completion_cb("repository
", complete_repository)
782 .completion_cb("backupspec
", complete_backup_source)
783 .completion_cb("chunk
-size
", complete_chunk_size);
785 let list_cmd_def = CliCommand::new(
788 ObjectSchema::new("List backup groups
.")
789 .required("repository
", repo_url_schema.clone())
791 .arg_param(vec!["repository
"])
792 .completion_cb("repository
", complete_repository);
794 let snapshots_cmd_def = CliCommand::new(
797 ObjectSchema::new("List backup snapshots
.")
798 .required("repository
", repo_url_schema.clone())
799 .required("group
", StringSchema::new("Backup group
."))
801 .arg_param(vec!["repository
", "group
"])
802 .completion_cb("group
", complete_backup_group)
803 .completion_cb("repository
", complete_repository);
805 let forget_cmd_def = CliCommand::new(
808 ObjectSchema::new("Forget (remove
) backup snapshots
.")
809 .required("repository
", repo_url_schema.clone())
810 .required("snapshot
", StringSchema::new("Snapshot path
."))
812 .arg_param(vec!["repository
", "snapshot
"])
813 .completion_cb("repository
", complete_repository)
814 .completion_cb("snapshot
", complete_group_or_snapshot);
816 let garbage_collect_cmd_def = CliCommand::new(
818 start_garbage_collection,
819 ObjectSchema::new("Start garbage collection
for a specific repository
.")
820 .required("repository
", repo_url_schema.clone())
822 .arg_param(vec!["repository
"])
823 .completion_cb("repository
", complete_repository);
825 let restore_cmd_def = CliCommand::new(
828 ObjectSchema::new("Restore backup repository
.")
829 .required("repository
", repo_url_schema.clone())
830 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
831 .required("archive
-name
", StringSchema::new("Backup archive name
."))
832 .required("target
", StringSchema::new("Target directory path
."))
834 .arg_param(vec!["repository
", "snapshot
", "archive
-name
", "target
"])
835 .completion_cb("repository
", complete_repository)
836 .completion_cb("snapshot
", complete_group_or_snapshot)
837 .completion_cb("archive
-name
", complete_archive_name)
838 .completion_cb("target
", tools::complete_file_name);
840 let prune_cmd_def = CliCommand::new(
843 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
844 ObjectSchema::new("Prune backup repository
.")
845 .required("repository
", repo_url_schema.clone())
848 .arg_param(vec!["repository
"])
849 .completion_cb("repository
", complete_repository);
851 let cmd_def = CliCommandMap::new()
852 .insert("backup
".to_owned(), backup_cmd_def.into())
853 .insert("forget
".to_owned(), forget_cmd_def.into())
854 .insert("garbage
-collect
".to_owned(), garbage_collect_cmd_def.into())
855 .insert("list
".to_owned(), list_cmd_def.into())
856 .insert("prune
".to_owned(), prune_cmd_def.into())
857 .insert("restore
".to_owned(), restore_cmd_def.into())
858 .insert("snapshots
".to_owned(), snapshots_cmd_def.into());
860 hyper::rt::run(futures::future::lazy(move || {
861 run_cli_command(cmd_def.into());