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::catar::encoder::*;
18 //use proxmox_backup::backup::datastore::*;
20 use serde_json
::{json, Value}
;
24 use xdg
::BaseDirectories
;
26 use lazy_static
::lazy_static
;
29 static ref BACKUPSPEC_REGEX
: Regex
= Regex
::new(r
"^([a-zA-Z0-9_-]+\.(?:catar|raw)):(.+)$").unwrap();
33 fn record_repository(repo
: &BackupRepository
) {
35 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
40 // usually $HOME/.cache/proxmox-backup/repo-list
41 let path
= match base
.place_cache_file("repo-list") {
46 let mut data
= tools
::file_get_json(&path
).unwrap_or(json
!({}
));
48 let repo
= repo
.to_string();
50 data
[&repo
] = json
!{ data[&repo].as_i64().unwrap_or(0) + 1 }
;
52 let mut map
= serde_json
::map
::Map
::new();
56 let mut max_repo
= None
;
57 for (repo
, count
) in data
.as_object().unwrap() {
58 if map
.contains_key(repo
) { continue; }
59 if let Some(count
) = count
.as_i64() {
62 max_repo
= Some(repo
);
66 if let Some(repo
) = max_repo
{
67 map
.insert(repo
.to_owned(), json
!(max_used
));
71 if map
.len() > 10 { // store max. 10 repos
76 let new_data
= json
!(map
);
78 let _
= tools
::file_set_contents(path
, new_data
.to_string().as_bytes(), None
);
81 fn complete_repository(_arg
: &str, _param
: &HashMap
<String
, String
>) -> Vec
<String
> {
83 let mut result
= vec
![];
85 let base
= match BaseDirectories
::with_prefix("proxmox-backup") {
90 // usually $HOME/.cache/proxmox-backup/repo-list
91 let path
= match base
.place_cache_file("repo-list") {
96 let data
= tools
::file_get_json(&path
).unwrap_or(json
!({}
));
98 if let Some(map
) = data
.as_object() {
99 for (repo
, _count
) in map
{
100 result
.push(repo
.to_owned());
107 fn backup_directory
<P
: AsRef
<Path
>>(
108 client
: &mut HttpClient
,
109 repo
: &BackupRepository
,
113 backup_time
: DateTime
<Local
>,
114 chunk_size
: Option
<u64>,
115 all_file_systems
: bool
,
117 ) -> Result
<(), Error
> {
119 let mut param
= json
!({
120 "archive-name": archive_name
,
121 "backup-type": "host",
122 "backup-id": backup_id
,
123 "backup-time": backup_time
.timestamp(),
126 if let Some(size
) = chunk_size
{
127 param
["chunk-size"] = size
.into();
130 let query
= tools
::json_object_to_query(param
)?
;
132 let path
= format
!("api2/json/admin/datastore/{}/catar?{}", repo
.store(), query
);
134 let stream
= CaTarBackupStream
::open(dir_path
.as_ref(), all_file_systems
, verbose
)?
;
136 let body
= Body
::wrap_stream(stream
);
138 client
.upload("application/x-proxmox-backup-catar", body
, &path
)?
;
144 fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
146 let mut target = PathBuf::from(target);
148 if let Some(ext) = target.extension() {
150 bail!("got wrong file extension - expected '.fidx'");
153 target.set_extension("fidx");
156 let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
158 tools::file_chunker(file, chunk_size, |pos, chunk| {
159 index.add_chunk(pos, chunk)?;
163 index.close()?; // commit changes
169 fn strip_chunked_file_expenstions(list
: Vec
<String
>) -> Vec
<String
> {
171 let mut result
= vec
![];
173 for file
in list
.into_iter() {
174 if file
.ends_with(".didx") {
175 result
.push(file
[..file
.len()-5].to_owned());
176 } else if file
.ends_with(".fidx") {
177 result
.push(file
[..file
.len()-5].to_owned());
179 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
)?
;
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
);
227 fn list_backup_groups(
230 _rpcenv
: &mut RpcEnvironment
,
231 ) -> Result
<Value
, Error
> {
233 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
234 let repo
: BackupRepository
= repo_url
.parse()?
;
236 let mut client
= HttpClient
::new(repo
.host(), repo
.user());
238 let path
= format
!("api2/json/admin/datastore/{}/groups", repo
.store());
240 let mut result
= client
.get(&path
)?
;
242 record_repository(&repo
);
244 // fixme: implement and use output formatter instead ..
245 let list
= result
["data"].as_array_mut().unwrap();
247 list
.sort_unstable_by(|a
, b
| {
248 let a_id
= a
["backup-id"].as_str().unwrap();
249 let a_backup_type
= a
["backup-type"].as_str().unwrap();
250 let b_id
= b
["backup-id"].as_str().unwrap();
251 let b_backup_type
= b
["backup-type"].as_str().unwrap();
253 let type_order
= a_backup_type
.cmp(b_backup_type
);
254 if type_order
== std
::cmp
::Ordering
::Equal
{
263 let id
= item
["backup-id"].as_str().unwrap();
264 let btype
= item
["backup-type"].as_str().unwrap();
265 let epoch
= item
["last-backup"].as_i64().unwrap();
266 let last_backup
= Local
.timestamp(epoch
, 0);
267 let backup_count
= item
["backup-count"].as_u64().unwrap();
269 let group
= BackupGroup
::new(btype
, id
);
271 let path
= group
.group_path().to_str().unwrap().to_owned();
273 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
274 let files
= strip_chunked_file_expenstions(files
);
276 println
!("{:20} | {} | {:5} | {}", path
, last_backup
.format("%c"),
277 backup_count
, tools
::join(&files
, ' '
));
287 _rpcenv
: &mut RpcEnvironment
,
288 ) -> Result
<Value
, Error
> {
290 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
291 let repo
: BackupRepository
= repo_url
.parse()?
;
293 let path
= tools
::required_string_param(¶m
, "group")?
;
294 let group
= BackupGroup
::parse(path
)?
;
296 let query
= tools
::json_object_to_query(json
!({
297 "backup-type": group
.backup_type(),
298 "backup-id": group
.backup_id(),
301 let mut client
= HttpClient
::new(repo
.host(), repo
.user());
303 let path
= format
!("api2/json/admin/datastore/{}/snapshots?{}", repo
.store(), query
);
306 let result
= client
.get(&path
)?
;
308 record_repository(&repo
);
310 // fixme: implement and use output formatter instead ..
311 let list
= result
["data"].as_array().unwrap();
315 let id
= item
["backup-id"].as_str().unwrap();
316 let btype
= item
["backup-type"].as_str().unwrap();
317 let epoch
= item
["backup-time"].as_i64().unwrap();
319 let snapshot
= BackupDir
::new(btype
, id
, epoch
);
321 let path
= snapshot
.relative_path().to_str().unwrap().to_owned();
323 let files
= item
["files"].as_array().unwrap().iter().map(|v
| v
.as_str().unwrap().to_owned()).collect();
324 let files
= strip_chunked_file_expenstions(files
);
326 println
!("{} | {} | {}", path
, snapshot
.backup_time().format("%c"), tools
::join(&files
, ' '
));
335 _rpcenv
: &mut RpcEnvironment
,
336 ) -> Result
<Value
, Error
> {
338 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
339 let repo
: BackupRepository
= repo_url
.parse()?
;
341 let path
= tools
::required_string_param(¶m
, "snapshot")?
;
342 let snapshot
= BackupDir
::parse(path
)?
;
344 let query
= tools
::json_object_to_query(json
!({
345 "backup-type": snapshot
.group().backup_type(),
346 "backup-id": snapshot
.group().backup_id(),
347 "backup-time": snapshot
.backup_time().timestamp(),
350 let mut client
= HttpClient
::new(repo
.host(), repo
.user());
352 let path
= format
!("api2/json/admin/datastore/{}/snapshots?{}", repo
.store(), query
);
354 let result
= client
.delete(&path
)?
;
356 record_repository(&repo
);
361 fn start_garbage_collection(
364 _rpcenv
: &mut RpcEnvironment
,
365 ) -> Result
<Value
, Error
> {
367 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
368 let repo
: BackupRepository
= repo_url
.parse()?
;
370 let mut client
= HttpClient
::new(repo
.host(), repo
.user());
372 let path
= format
!("api2/json/admin/datastore/{}/gc", repo
.store());
374 let result
= client
.post(&path
)?
;
376 record_repository(&repo
);
381 fn parse_backupspec(value
: &str) -> Result
<(&str, &str), Error
> {
383 if let Some(caps
) = BACKUPSPEC_REGEX
.captures(value
) {
384 return Ok((caps
.get(1).unwrap().as_str(), caps
.get(2).unwrap().as_str()));
386 bail
!("unable to parse directory specification '{}'", value
);
392 _rpcenv
: &mut RpcEnvironment
,
393 ) -> Result
<Value
, Error
> {
395 let repo_url
= tools
::required_string_param(¶m
, "repository")?
;
397 let backupspec_list
= tools
::required_array_param(¶m
, "backupspec")?
;
399 let repo
: BackupRepository
= repo_url
.parse()?
;
401 let all_file_systems
= param
["all-file-systems"].as_bool().unwrap_or(false);
403 let verbose
= param
["verbose"].as_bool().unwrap_or(false);
405 let chunk_size_opt
= param
["chunk-size"].as_u64().map(|v
| v
*1024);
407 if let Some(size
) = chunk_size_opt
{
408 verify_chunk_size(size
)?
;
411 let backup_id
= param
["host-id"].as_str().unwrap_or(&tools
::nodename());
413 let mut upload_list
= vec
![];
415 for backupspec
in backupspec_list
{
416 let (target
, filename
) = parse_backupspec(backupspec
.as_str().unwrap())?
;
418 let stat
= match nix
::sys
::stat
::stat(filename
) {
420 Err(err
) => bail
!("unable to access '{}' - {}", filename
, err
),
423 if (stat
.st_mode
& libc
::S_IFDIR
) != 0 {
425 upload_list
.push((filename
.to_owned(), target
.to_owned()));
427 } else if (stat
.st_mode
& (libc
::S_IFREG
|libc
::S_IFBLK
)) != 0 {
428 if stat
.st_size
<= 0 { bail!("got strange file size '{}'
", stat.st_size); }
429 let _size = stat.st_size as usize;
431 panic!("implement me
");
433 //backup_image(&datastore, &file, size, &target, chunk_size)?;
435 // let idx = datastore.open_image_reader(target)?;
439 bail!("unsupported file
type (expected a directory
, file or block device
)");
443 let backup_time = Local.timestamp(Local::now().timestamp(), 0);
445 let mut client = HttpClient::new(repo.host(), repo.user());
447 client.login()?; // login before starting backup
449 record_repository(&repo);
451 println!("Starting backup
");
452 println!("Client name
: {}
", tools::nodename());
453 println!("Start Time
: {}
", backup_time.to_rfc3339());
455 for (filename, target) in upload_list {
456 println!("Upload '{}' to '{:?}'
as {}
", filename, repo, target);
457 backup_directory(&mut client, &repo, &filename, &target, backup_id, backup_time,
458 chunk_size_opt, all_file_systems, verbose)?;
461 let end_time = Local.timestamp(Local::now().timestamp(), 0);
462 let elapsed = end_time.signed_duration_since(backup_time);
463 println!("Duration
: {}
", elapsed);
465 println!("End Time
: {}
", end_time.to_rfc3339());
470 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
472 let mut result = vec![];
474 let data: Vec<&str> = arg.splitn(2, ':').collect();
477 result.push(String::from("root
.catar
:/"));
478 result.push(String::from("etc
.catar
:/etc
"));
482 let files = tools::complete_file_name(data[1], param);
485 result.push(format!("{}
:{}
", data[0], file));
494 _rpcenv: &mut RpcEnvironment,
495 ) -> Result<Value, Error> {
497 let repo_url = tools::required_string_param(¶m, "repository
")?;
498 let repo: BackupRepository = repo_url.parse()?;
500 let archive_name = tools::required_string_param(¶m, "archive
-name
")?;
502 let mut client = HttpClient::new(repo.host(), repo.user());
504 client.login()?; // login before starting
506 record_repository(&repo);
508 let path = tools::required_string_param(¶m, "snapshot
")?;
512 if path.matches('/').count() == 1 {
513 let group = BackupGroup::parse(path)?;
515 let subquery = tools::json_object_to_query(json!({
516 "backup
-type": group.backup_type(),
517 "backup
-id
": group.backup_id(),
520 let path = format!("api2
/json
/admin
/datastore
/{}
/snapshots?{}
", repo.store(), subquery);
521 let result = client.get(&path)?;
523 let list = result["data
"].as_array().unwrap();
525 bail!("backup group '{}' does not contain any snapshots
:", path);
528 query = tools::json_object_to_query(json!({
529 "backup
-type": group.backup_type(),
530 "backup
-id
": group.backup_id(),
531 "backup
-time
": list[0]["backup
-time
"].as_i64().unwrap(),
532 "archive
-name
": archive_name,
535 let snapshot = BackupDir::parse(path)?;
537 query = tools::json_object_to_query(json!({
538 "backup
-type": snapshot.group().backup_type(),
539 "backup
-id
": snapshot.group().backup_id(),
540 "backup
-time
": snapshot.backup_time().timestamp(),
541 "archive
-name
": archive_name,
545 let target = tools::required_string_param(¶m, "target
")?;
547 if archive_name.ends_with(".catar
") {
548 let path = format!("api2
/json
/admin
/datastore
/{}
/catar?{}
", repo.store(), query);
550 println!("DOWNLOAD FILE {} to {}
", path, target);
552 let target = PathBuf::from(target);
553 let writer = CaTarBackupWriter::new(&target, true)?;
554 client.download(&path, Box::new(writer))?;
556 bail!("unknown file extensions
- unable to download '{}'
", archive_name);
565 _rpcenv: &mut RpcEnvironment,
566 ) -> Result<Value, Error> {
568 let repo_url = tools::required_string_param(¶m, "repository
")?;
569 let repo: BackupRepository = repo_url.parse()?;
571 let mut client = HttpClient::new(repo.host(), repo.user());
573 let path = format!("api2
/json
/admin
/datastore
/{}
/prune
", repo.store());
575 param.as_object_mut().unwrap().remove("repository
");
577 let result = client.post_json(&path, param)?;
579 record_repository(&repo);
584 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
586 let mut result = vec![];
588 let repo_url = match param.get("repository
") {
593 let repo: BackupRepository = match repo_url.parse() {
598 let mut client = HttpClient::new(repo.host(), repo.user());
600 let path = format!("api2
/json
/admin
/datastore
/{}
/groups
", repo.store());
602 let resp = match client.try_get(&path) {
607 if let Some(list) = resp["data
"].as_array() {
609 if let (Some(backup_id), Some(backup_type)) =
610 (item["backup
-id
"].as_str(), item["backup
-type"].as_str())
612 result.push(format!("{}
/{}
", backup_type, backup_id));
620 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
622 let mut result = vec![];
626 result.push(size.to_string());
628 if size > 4096 { break; }
636 let repo_url_schema: Arc<Schema> = Arc::new(
637 StringSchema::new("Repository URL
.")
638 .format(BACKUP_REPO_URL.clone())
643 let backup_source_schema: Arc<Schema> = Arc::new(
644 StringSchema::new("Backup source
specification ([<label
>:<path
>]).")
645 .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
649 let backup_cmd_def = CliCommand::new(
652 ObjectSchema::new("Create (host
) backup
.")
653 .required("repository
", repo_url_schema.clone())
657 "List of backup source
specifications ([<label
.ext
>:<path
>] ...)",
658 backup_source_schema,
663 BooleanSchema::new("Verbose output
.").default(false))
666 StringSchema::new("Use specified ID
for the backup group
name ('host
/<id
>'
). The
default is the system hostname
."))
669 IntegerSchema::new("Chunk size
in KB
. Must be a power of
2.")
675 .arg_param(vec!["repository
", "backupspec
"])
676 .completion_cb("repository
", complete_repository)
677 .completion_cb("backupspec
", complete_backup_source)
678 .completion_cb("chunk
-size
", complete_chunk_size);
680 let list_cmd_def = CliCommand::new(
683 ObjectSchema::new("List backup groups
.")
684 .required("repository
", repo_url_schema.clone())
686 .arg_param(vec!["repository
"])
687 .completion_cb("repository
", complete_repository);
689 let snapshots_cmd_def = CliCommand::new(
692 ObjectSchema::new("List backup snapshots
.")
693 .required("repository
", repo_url_schema.clone())
694 .required("group
", StringSchema::new("Backup group
."))
696 .arg_param(vec!["repository
", "group
"])
697 .completion_cb("group
", complete_backup_group)
698 .completion_cb("repository
", complete_repository);
700 let forget_cmd_def = CliCommand::new(
703 ObjectSchema::new("Forget (remove
) backup snapshots
.")
704 .required("repository
", repo_url_schema.clone())
705 .required("snapshot
", StringSchema::new("Snapshot path
."))
707 .arg_param(vec!["repository
", "snapshot
"])
708 .completion_cb("repository
", complete_repository);
710 let garbage_collect_cmd_def = CliCommand::new(
712 start_garbage_collection,
713 ObjectSchema::new("Start garbage collection
for a specific repository
.")
714 .required("repository
", repo_url_schema.clone())
716 .arg_param(vec!["repository
"])
717 .completion_cb("repository
", complete_repository);
719 let restore_cmd_def = CliCommand::new(
722 ObjectSchema::new("Restore backup repository
.")
723 .required("repository
", repo_url_schema.clone())
724 .required("snapshot
", StringSchema::new("Group
/Snapshot path
."))
725 .required("archive
-name
", StringSchema::new("Backup archive name
."))
726 .required("target
", StringSchema::new("Target directory path
."))
728 .arg_param(vec!["repository
", "snapshot
", "archive
-name
", "target
"])
729 .completion_cb("repository
", complete_repository);
731 let prune_cmd_def = CliCommand::new(
734 proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
735 ObjectSchema::new("Prune backup repository
.")
736 .required("repository
", repo_url_schema.clone())
739 .arg_param(vec!["repository
"])
740 .completion_cb("repository
", complete_repository);
742 let cmd_def = CliCommandMap::new()
743 .insert("backup
".to_owned(), backup_cmd_def.into())
744 .insert("forget
".to_owned(), forget_cmd_def.into())
745 .insert("garbage
-collect
".to_owned(), garbage_collect_cmd_def.into())
746 .insert("list
".to_owned(), list_cmd_def.into())
747 .insert("prune
".to_owned(), prune_cmd_def.into())
748 .insert("restore
".to_owned(), restore_cmd_def.into())
749 .insert("snapshots
".to_owned(), snapshots_cmd_def.into());
751 run_cli_command(cmd_def.into());