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
;
30 static ref BACKUPSPEC_REGEX
: Regex
= Regex
::new(r
"^([a-zA-Z0-9_-]+\.(?:pxar|raw)):(.+)$").unwrap();
34 fn record_repository(repo
: &BackupRepository
) {
36 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
41 // usually $HOME/.cache/proxmox-backup/repo-list
42 let path
= match base
.place_cache_file("repo-list") {
47 let mut data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
49 let repo
= repo
.to_string();
51 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
53 let mut map
= serde_json
::map
::Map
::new();
57 let mut max_repo
= None
;
58 for (repo
, count
) in data
.as_object().unwrap() {
59 if map
.contains_key(repo
) { continue; }
60 if let Some(count
) = count
.as_i64() {
63 max_repo
= Some(repo
);
67 if let Some(repo
) = max_repo
{
68 map
.insert(repo
.to_owned(), json
!(max_used
));
72 if map
.len() > 10 { // store max. 10 repos
77 let new_data
= json
!(map
);
79 let _
= tools
::file_set_contents(path
, new_data
.to_string().as_bytes(), None
);
82 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
84 let mut result
= vec
![];
86 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
91 // usually $HOME/.cache/proxmox-backup/repo-list
92 let path
= match base
.place_cache_file("repo-list") {
97 let data
= tools
::file_get_json(&path
, None
).unwrap_or(json
!({}
));
99 if let Some(map
) = data
.as_object() {
100 for (repo
, _count
) in map
{
101 result
.push(repo
.to_owned());
108 fn backup_directory
<P
: AsRef
<Path
>>(
109 client
: &mut HttpClient
,
110 repo
: &BackupRepository
,
114 backup_time
: DateTime
<Local
>,
115 chunk_size
: Option
<u64>,
116 all_file_systems
: bool
,
118 ) -> Result
<(), Error
> {
120 let mut param
= json
!({
121 "archive-name": archive_name
,
122 "backup-type": "host",
123 "backup-id": backup_id
,
124 "backup-time": backup_time
.timestamp(),
127 if let Some(size
) = chunk_size
{
128 param
["chunk-size"] = size
.into();
131 let query
= tools
::json_object_to_query(param
)?
;
133 let path
= format
!("api2/json/admin/datastore/{}/pxar?{}", repo
.store(), query
);
135 let stream
= PxarBackupStream
::open(dir_path
.as_ref(), all_file_systems
, verbose
)?
;
137 let body
= Body
::wrap_stream(stream
);
139 client
.upload("application/x-proxmox-backup-pxar", body
, &path
).wait()?
;
145 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
147 let mut target = PathBuf::from(target);
149 if let Some(ext) = target.extension() {
151 bail!("got wrong file extension - expected '.fidx'");
154 target.set_extension("fidx");
157 let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
159 tools::file_chunker(file, chunk_size, |pos, chunk| {
160 index.add_chunk(pos, chunk)?;
164 index.close()?; // commit changes
170 fn strip_chunked_file_expenstions(list
: Vec
<String
>) -> Vec
<String
> {
172 let mut result
= vec
![];
174 for file
in list
.into_iter() {
175 if file
.ends_with(".didx") {
176 result
.push(file
[..file
.len()-5].to_owned());
177 } else if file
.ends_with(".fidx") {
178 result
.push(file
[..file
.len()-5].to_owned());
180 result
.push(file
); // should not happen
191 _rpcenv: &mut RpcEnvironment,
192 ) -> Result<Value, Error> {
194 let repo_url = tools::required_string_param(¶m, "repository")?;
195 let repo: BackupRepository = repo_url.parse()?;
197 let mut client = HttpClient::new(repo.host(), repo.user())?;
199 let path = format!("api2/json/admin/datastore/{}/backups", repo.store());
201 let result = client.get(&path)?;
203 record_repository(&repo);
205 // fixme: implement and use output formatter instead ..
206 let list = result["data"].as_array().unwrap();
210 let id = item["backup-id"].as_str().unwrap();
211 let btype = item["backup-type"].as_str().unwrap();
212 let epoch = item["backup-time"].as_i64().unwrap();
214 let backup_dir = BackupDir::new(btype, id, epoch);
216 let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
217 let files = strip_chunked_file_expenstions(files);
219 for filename in files {
220 let path = backup_dir.relative_path().to_str().unwrap().to_owned();
221 println!("{} | {}/{}", backup_dir.backup_time().format("%c"), path, filename);
230 fn list_backup_groups(
233 _rpcenv
: &mut RpcEnvironment
,
234 ) -> Result
<Value
, Error
> {
236 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
237 let repo
: BackupRepository
= repo_url
.parse()?
;
239 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
241 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
243 let mut result
= client
.get(&path
).wait()?
;
245 record_repository(&repo
);
247 // fixme: implement and use output formatter instead ..
248 let list
= result
["data"].as_array_mut().unwrap();
250 list
.sort_unstable_by(|a
, b
| {
251 let a_id
= a
["backup-id"].as_str().unwrap();
252 let a_backup_type
= a
["backup-type"].as_str().unwrap();
253 let b_id
= b
["backup-id"].as_str().unwrap();
254 let b_backup_type
= b
["backup-type"].as_str().unwrap();
256 let type_order
= a_backup_type
.cmp(b_backup_type
);
257 if type_order
== std
::cmp
::Ordering
::Equal
{
266 let id
= item
["backup-id"].as_str().unwrap();
267 let btype
= item
["backup-type"].as_str().unwrap();
268 let epoch
= item
["last-backup"].as_i64().unwrap();
269 let last_backup
= Local
.timestamp(epoch
, 0);
270 let backup_count
= item
["backup-count"].as_u64().unwrap();
272 let group
= BackupGroup
::new(btype
, id
);
274 let path
= group
.group_path().to_str().unwrap().to_owned();
276 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
277 let files
= strip_chunked_file_expenstions(files
);
279 println
!("{:20} | {} | {:5} | {}", path
, last_backup
.format("%c"),
280 backup_count
, tools
::join(&files
, ' '
));
290 _rpcenv
: &mut RpcEnvironment
,
291 ) -> Result
<Value
, Error
> {
293 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
294 let repo
: BackupRepository
= repo_url
.parse()?
;
296 let path
= tools
::required_string_param(¶m
, "group")?
;
297 let group
= BackupGroup
::parse(path
)?
;
299 let query
= tools
::json_object_to_query(json
!({
300 "backup-type": group
.backup_type(),
301 "backup-id": group
.backup_id(),
304 let client
= HttpClient
::new(repo
.host(), repo
.user())?
;
306 let path
= format
!("api2/json/admin/datastore/{}/snapshots?{}", repo
.store(), query
);
309 let result
= client
.get(&path
).wait()?
;
311 record_repository(&repo
);
313 // fixme: implement and use output formatter instead ..
314 let list
= result
["data"].as_array().unwrap();
318 let id
= item
["backup-id"].as_str().unwrap();
319 let btype
= item
["backup-type"].as_str().unwrap();
320 let epoch
= item
["backup-time"].as_i64().unwrap();
322 let snapshot
= BackupDir
::new(btype
, id
, epoch
);
324 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
326 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
327 let files
= strip_chunked_file_expenstions(files
);
329 println
!("{} | {} | {}", path
, snapshot
.backup_time().format("%c"), tools
::join(&files
, ' '
));
338 _rpcenv
: &mut RpcEnvironment
,
339 ) -> Result
<Value
, Error
> {
341 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
342 let repo
: BackupRepository
= repo_url
.parse()?
;
344 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
345 let snapshot
= BackupDir
::parse(path
)?
;
347 let query
= tools
::json_object_to_query(json
!({
348 "backup-type": snapshot
.group().backup_type(),
349 "backup-id": snapshot
.group().backup_id(),
350 "backup-time": snapshot
.backup_time().timestamp(),
353 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
355 let path
= format
!("api2/json/admin/datastore/{}/snapshots?{}", repo
.store(), query
);
357 let result
= client
.delete(&path
).wait()?
;
359 record_repository(&repo
);
364 fn start_garbage_collection(
367 _rpcenv
: &mut RpcEnvironment
,
368 ) -> Result
<Value
, Error
> {
370 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
371 let repo
: BackupRepository
= repo_url
.parse()?
;
373 let mut client
= HttpClient
::new(repo
.host(), repo
.user())?
;
375 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
377 let result
= client
.post(&path
, None
).wait()?
;
379 record_repository(&repo
);
384 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
386 if let Some(caps
) = BACKUPSPEC_REGEX
.captures(value
) {
387 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
389 bail
!("unable to parse directory specification '{}'", value
);
395 _rpcenv
: &mut RpcEnvironment
,
396 ) -> Result
<Value
, Error
> {
398 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
400 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
402 let repo
: BackupRepository
= repo_url
.parse()?
;
404 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
406 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
408 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| v
*1024);
410 if let Some(size
) = chunk_size_opt
{
411 verify_chunk_size(size
)?
;
414 let backup_id
= param
["host-id"].as_str().unwrap_or(&tools
::nodename());
416 let mut upload_list
= vec
![];
418 for backupspec
in backupspec_list
{
419 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
421 let stat
= match nix
::sys
::stat
::stat(filename
) {
423 Err(err
) => bail
!("unable to access '{}' - {}", filename
, err
),
426 if (stat
.st_mode
& libc
::S_IFDIR
) != 0 {
428 upload_list
.push((filename
.to_owned(), target
.to_owned()));
430 } else if (stat
.st_mode
& (libc
::S_IFREG
|libc
::S_IFBLK
)) != 0 {
431 if stat
.st_size
<= 0 { bail!("got strange file size '{}'
", stat.st_size); }
432 let _size = stat.st_size as usize;
434 panic!("implement me
");
436 //backup_image(&datastore, &file, size, &target, chunk_size)?;
438 // let idx = datastore.open_image_reader(target)?;
442 bail!("unsupported file
type (expected a directory
, file or block device
)");
446 let backup_time = Local.timestamp(Local::now().timestamp(), 0);
448 let mut client = HttpClient::new(repo.host(), repo.user())?;
450 record_repository(&repo);
452 println!("Starting backup
");
453 println!("Client name
: {}
", tools::nodename());
454 println!("Start Time
: {}
", backup_time.to_rfc3339());
456 for (filename, target) in upload_list {
457 println!("Upload '{}' to '{:?}'
as {}
", filename, repo, target);
458 backup_directory(&mut client, &repo, &filename, &target, backup_id, backup_time,
459 chunk_size_opt, all_file_systems, verbose)?;
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 subquery = tools::json_object_to_query(json!({
515 "backup
-type": group.backup_type(),
516 "backup
-id
": group.backup_id(),
519 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots?{}
", repo.store(), subquery);
520 let result = client.get(&path).wait()?;
522 let list = result["data
"].as_array().unwrap();
524 bail!("backup group '{}' does not contain any snapshots
:", path);
527 query = tools::json_object_to_query(json!({
528 "backup
-type": group.backup_type(),
529 "backup
-id
": group.backup_id(),
530 "backup
-time
": list[0]["backup
-time
"].as_i64().unwrap(),
531 "archive
-name
": archive_name,
534 let snapshot = BackupDir::parse(path)?;
536 query = tools::json_object_to_query(json!({
537 "backup
-type": snapshot.group().backup_type(),
538 "backup
-id
": snapshot.group().backup_id(),
539 "backup
-time
": snapshot.backup_time().timestamp(),
540 "archive
-name
": archive_name,
544 let target = tools::required_string_param(¶m, "target
")?;
546 if archive_name.ends_with(".pxar
") {
547 let path = format!("api2
/json
/admin
/datastore
/{}
/pxar?{}
", repo.store(), query);
549 println!("DOWNLOAD FILE {} to {}
", path, target);
551 let target = PathBuf::from(target);
552 let writer = PxarDecodeWriter::new(&target, true)?;
553 client.download(&path, Box::new(writer)).wait()?;
555 bail!("unknown file extensions
- unable to download '{}'
", archive_name);
564 _rpcenv: &mut RpcEnvironment,
565 ) -> Result<Value, Error> {
567 let repo_url = tools::required_string_param(¶m, "repository
")?;
568 let repo: BackupRepository = repo_url.parse()?;
570 let mut client = HttpClient::new(repo.host(), repo.user())?;
572 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
574 param.as_object_mut().unwrap().remove("repository
");
576 let result = client.post(&path, Some(param)).wait()?;
578 record_repository(&repo);
583 // like get, but simply ignore errors and return Null instead
584 fn try_get(repo: &BackupRepository, url: &str) -> Value {
586 let client = match HttpClient::new(repo.host(), repo.user()) {
588 _ => return Value::Null,
591 let mut resp = match client.get(url).wait() {
593 _ => return Value::Null,
596 if let Some(map) = resp.as_object_mut() {
597 if let Some(data) = map.remove("data
") {
604 fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> {
606 let repo_url = match param.get("repository
") {
611 let repo: BackupRepository = match repo_url.parse() {
619 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
621 let mut result = vec![];
623 let repo = match extract_repo(param) {
628 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
630 let data = try_get(&repo, &path);
632 if let Some(list) = data.as_array() {
634 if let (Some(backup_id), Some(backup_type)) =
635 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
637 result.push(format!("{}
/{}
", backup_type, backup_id));
645 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
647 let mut result = vec![];
649 let repo = match extract_repo(param) {
654 if arg.matches('/').count() < 2 {
655 let groups = complete_backup_group(arg, param);
656 for group in groups {
657 result.push(group.to_string());
658 result.push(format!("{}
/", group));
663 let mut parts = arg.split('/');
664 let query = tools::json_object_to_query(json!({
665 "backup
-type": parts.next().unwrap(),
666 "backup
-id
": parts.next().unwrap(),
669 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots?{}
", repo.store(), query);
671 let data = try_get(&repo, &path);
673 if let Some(list) = data.as_array() {
675 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
676 (item["backup
-id
"].as_str(), item["backup
-type"].as_str(), item["backup
-time
"].as_i64())
678 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
679 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
687 fn complete_archive_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
689 let mut result = vec![];
691 let repo = match extract_repo(param) {
696 let snapshot = match param.get("snapshot
") {
698 match BackupDir::parse(path) {
706 let query = tools::json_object_to_query(json!({
707 "backup
-type": snapshot.group().backup_type(),
708 "backup
-id
": snapshot.group().backup_id(),
709 "backup
-time
": snapshot.backup_time().timestamp(),
712 let path = format!("api2
/json
/admin
/datastore
/{}
/files?{}
", repo.store(), query);
714 let data = try_get(&repo, &path);
716 if let Some(list) = data.as_array() {
718 if let Some(filename) = item.as_str() {
719 result.push(filename.to_owned());
724 strip_chunked_file_expenstions(result)
727 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
729 let mut result = vec![];
733 result.push(size.to_string());
735 if size > 4096 { break; }
743 let repo_url_schema: Arc<Schema> = Arc::new(
744 StringSchema::new("Repository URL
.")
745 .format(BACKUP_REPO_URL.clone())
750 let backup_source_schema: Arc<Schema> = Arc::new(
751 StringSchema::new("Backup source
specification ([<label
>:<path
>]).")
752 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
756 let backup_cmd_def = CliCommand::new(
759 ObjectSchema::new("Create (host
) backup
.")
760 .required("repository
", repo_url_schema.clone())
764 "List of backup source
specifications ([<label
.ext
>:<path
>] ...)",
765 backup_source_schema,
770 BooleanSchema::new("Verbose output
.").default(false))
773 StringSchema::new("Use specified ID
for the backup group
name ('host
/<id
>'
). The
default is the system hostname
."))
776 IntegerSchema::new("Chunk size
in KB
. Must be a power of
2.")
782 .arg_param(vec!["repository
", "backupspec
"])
783 .completion_cb("repository
", complete_repository)
784 .completion_cb("backupspec
", complete_backup_source)
785 .completion_cb("chunk
-size
", complete_chunk_size);
787 let list_cmd_def = CliCommand::new(
790 ObjectSchema::new("List backup groups
.")
791 .required("repository
", repo_url_schema.clone())
793 .arg_param(vec!["repository
"])
794 .completion_cb("repository
", complete_repository);
796 let snapshots_cmd_def = CliCommand::new(
799 ObjectSchema::new("List backup snapshots
.")
800 .required("repository
", repo_url_schema.clone())
801 .required("group
", StringSchema::new("Backup group
."))
803 .arg_param(vec!["repository
", "group
"])
804 .completion_cb("group
", complete_backup_group)
805 .completion_cb("repository
", complete_repository);
807 let forget_cmd_def = CliCommand::new(
810 ObjectSchema::new("Forget (remove
) backup snapshots
.")
811 .required("repository
", repo_url_schema.clone())
812 .required("snapshot
", StringSchema::new("Snapshot path
."))
814 .arg_param(vec!["repository
", "snapshot
"])
815 .completion_cb("repository
", complete_repository)
816 .completion_cb("snapshot
", complete_group_or_snapshot);
818 let garbage_collect_cmd_def = CliCommand::new(
820 start_garbage_collection,
821 ObjectSchema::new("Start garbage collection
for a specific repository
.")
822 .required("repository
", repo_url_schema.clone())
824 .arg_param(vec!["repository
"])
825 .completion_cb("repository
", complete_repository);
827 let restore_cmd_def = CliCommand::new(
830 ObjectSchema::new("Restore backup repository
.")
831 .required("repository
", repo_url_schema.clone())
832 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
833 .required("archive
-name
", StringSchema::new("Backup archive name
."))
834 .required("target
", StringSchema::new("Target directory path
."))
836 .arg_param(vec!["repository
", "snapshot
", "archive
-name
", "target
"])
837 .completion_cb("repository
", complete_repository)
838 .completion_cb("snapshot
", complete_group_or_snapshot)
839 .completion_cb("archive
-name
", complete_archive_name)
840 .completion_cb("target
", tools::complete_file_name);
842 let prune_cmd_def = CliCommand::new(
845 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
846 ObjectSchema::new("Prune backup repository
.")
847 .required("repository
", repo_url_schema.clone())
850 .arg_param(vec!["repository
"])
851 .completion_cb("repository
", complete_repository);
853 let cmd_def = CliCommandMap::new()
854 .insert("backup
".to_owned(), backup_cmd_def.into())
855 .insert("forget
".to_owned(), forget_cmd_def.into())
856 .insert("garbage
-collect
".to_owned(), garbage_collect_cmd_def.into())
857 .insert("list
".to_owned(), list_cmd_def.into())
858 .insert("prune
".to_owned(), prune_cmd_def.into())
859 .insert("restore
".to_owned(), restore_cmd_def.into())
860 .insert("snapshots
".to_owned(), snapshots_cmd_def.into());
862 hyper::rt::run(futures::future::lazy(move || {
863 run_cli_command(cmd_def.into());