-use failure::*;
-use nix::unistd::{fork, ForkResult, pipe};
-use std::os::unix::io::RawFd;
-use chrono::{Local, Utc, TimeZone};
-use std::path::{Path, PathBuf};
use std::collections::{HashSet, HashMap};
use std::ffi::OsStr;
-use std::io::{Write, Seek, SeekFrom};
+use std::io::{self, Write, Seek, SeekFrom};
use std::os::unix::fs::OpenOptionsExt;
+use std::os::unix::io::RawFd;
+use std::path::{Path, PathBuf};
+use std::pin::Pin;
+use std::sync::{Arc, Mutex};
+use std::task::{Context, Poll};
+use anyhow::{bail, format_err, Error};
+use chrono::{Local, DateTime, Utc, TimeZone};
+use futures::future::FutureExt;
+use futures::select;
+use futures::stream::{StreamExt, TryStreamExt};
+use nix::unistd::{fork, ForkResult, pipe};
+use serde_json::{json, Value};
+use tokio::signal::unix::{signal, SignalKind};
+use tokio::sync::mpsc;
+use xdg::BaseDirectories;
+
+use pathpatterns::{MatchEntry, MatchType, PatternFlag};
use proxmox::{sortable, identity};
-use proxmox::tools::fs::{file_get_contents, file_get_json, file_set_contents, image_size};
+use proxmox::tools::fs::{file_get_contents, file_get_json, replace_file, CreateOptions, image_size};
+use proxmox::sys::linux::tty;
use proxmox::api::{ApiHandler, ApiMethod, RpcEnvironment};
use proxmox::api::schema::*;
use proxmox::api::cli::*;
+use proxmox::api::api;
use proxmox_backup::tools;
use proxmox_backup::api2::types::*;
use proxmox_backup::client::*;
use proxmox_backup::backup::*;
-use proxmox_backup::pxar::{ self, catalog::* };
-
-//use proxmox_backup::backup::image_index::*;
-//use proxmox_backup::config::datastore;
-//use proxmox_backup::pxar::encoder::*;
-//use proxmox_backup::backup::datastore::*;
-
-use serde_json::{json, Value};
-//use hyper::Body;
-use std::sync::{Arc, Mutex};
-//use regex::Regex;
-use xdg::BaseDirectories;
+use proxmox_backup::pxar::catalog::*;
-use futures::*;
-use tokio::sync::mpsc;
+const ENV_VAR_PBS_FINGERPRINT: &str = "PBS_FINGERPRINT";
+const ENV_VAR_PBS_PASSWORD: &str = "PBS_PASSWORD";
-proxmox::api::const_regex! {
- BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$";
-}
const REPO_URL_SCHEMA: Schema = StringSchema::new("Repository URL.")
.format(&BACKUP_REPO_URL)
.max_length(256)
.schema();
+const KEYFILE_SCHEMA: Schema = StringSchema::new(
+ "Path to encryption key. All data will be encrypted using this key.")
+ .schema();
+
+const CHUNK_SIZE_SCHEMA: Schema = IntegerSchema::new(
+ "Chunk size in KB. Must be a power of 2.")
+ .minimum(64)
+ .maximum(4096)
+ .default(4096)
+ .schema();
+
fn get_default_repository() -> Option<String> {
std::env::var("PBS_REPOSITORY").ok()
}
let new_data = json!(map);
- let _ = file_set_contents(path, new_data.to_string().as_bytes(), None);
+ let _ = replace_file(path, new_data.to_string().as_bytes(), CreateOptions::new());
}
fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
result
}
+fn connect(server: &str, userid: &str) -> Result<HttpClient, Error> {
+
+ let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
+
+ use std::env::VarError::*;
+ let password = match std::env::var(ENV_VAR_PBS_PASSWORD) {
+ Ok(p) => Some(p),
+ Err(NotUnicode(_)) => bail!(format!("{} contains bad characters", ENV_VAR_PBS_PASSWORD)),
+ Err(NotPresent) => None,
+ };
+
+ let options = HttpClientOptions::new()
+ .prefix(Some("proxmox-backup".to_string()))
+ .password(password)
+ .interactive(true)
+ .fingerprint(fingerprint)
+ .fingerprint_cache(true)
+ .ticket_cache(true);
+
+ HttpClient::new(server, userid, options)
+}
+
+async fn view_task_result(
+ client: HttpClient,
+ result: Value,
+ output_format: &str,
+) -> Result<(), Error> {
+ let data = &result["data"];
+ if output_format == "text" {
+ if let Some(upid) = data.as_str() {
+ display_task_log(client, upid, true).await?;
+ }
+ } else {
+ format_and_print_result(&data, &output_format);
+ }
+
+ Ok(())
+}
+
+async fn api_datastore_list_snapshots(
+ client: &HttpClient,
+ store: &str,
+ group: Option<BackupGroup>,
+) -> Result<Value, Error> {
+
+ let path = format!("api2/json/admin/datastore/{}/snapshots", store);
+
+ let mut args = json!({});
+ if let Some(group) = group {
+ args["backup-type"] = group.backup_type().into();
+ args["backup-id"] = group.backup_id().into();
+ }
+
+ let mut result = client.get(&path, Some(args)).await?;
+
+ Ok(result["data"].take())
+}
+
+async fn api_datastore_latest_snapshot(
+ client: &HttpClient,
+ store: &str,
+ group: BackupGroup,
+) -> Result<(String, String, DateTime<Utc>), Error> {
+
+ let list = api_datastore_list_snapshots(client, store, Some(group.clone())).await?;
+ let mut list: Vec<SnapshotListItem> = serde_json::from_value(list)?;
+
+ if list.is_empty() {
+ bail!("backup group {:?} does not contain any snapshots.", group.group_path());
+ }
+
+ list.sort_unstable_by(|a, b| b.backup_time.cmp(&a.backup_time));
+
+ let backup_time = Utc.timestamp(list[0].backup_time, 0);
+
+ Ok((group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time))
+}
+
+
async fn backup_directory<P: AsRef<Path>>(
client: &BackupWriter,
dir_path: P,
verbose: bool,
skip_lost_and_found: bool,
crypt_config: Option<Arc<CryptConfig>>,
- catalog: Arc<Mutex<CatalogWriter<SenderWriter>>>,
+ catalog: Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
+ exclude_pattern: Vec<MatchEntry>,
+ entries_max: usize,
) -> Result<BackupStats, Error> {
- let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), device_set, verbose, skip_lost_and_found, catalog)?;
+ let pxar_stream = PxarBackupStream::open(
+ dir_path.as_ref(),
+ device_set,
+ verbose,
+ skip_lost_and_found,
+ catalog,
+ exclude_pattern,
+ entries_max,
+ )?;
let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
let (mut tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
// spawn chunker inside a separate task so that it can run parallel
tokio::spawn(async move {
- let _ = tx.send_all(&mut chunk_stream).await;
+ while let Some(v) = chunk_stream.next().await {
+ let _ = tx.send(v).await;
+ }
});
let stats = client
let file = tokio::fs::File::open(path).await?;
- let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
+ let stream = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
.map_err(Error::from);
let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
Ok(stats)
}
-fn strip_server_file_expenstion(name: &str) -> String {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// List backup groups.
+async fn list_backup_groups(param: Value) -> Result<Value, Error> {
- if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
- name[..name.len()-5].to_owned()
- } else {
- name.to_owned() // should not happen
- }
-}
-
-fn list_backup_groups(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ let output_format = get_output_format(¶m);
let repo = extract_repository_from_value(¶m)?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
- let mut result = async_main(async move {
- client.get(&path, None).await
- })?;
+ let mut result = client.get(&path, None).await?;
record_repository(&repo);
- // fixme: implement and use output formatter instead ..
- let list = result["data"].as_array_mut().unwrap();
-
- list.sort_unstable_by(|a, b| {
- let a_id = a["backup-id"].as_str().unwrap();
- let a_backup_type = a["backup-type"].as_str().unwrap();
- let b_id = b["backup-id"].as_str().unwrap();
- let b_backup_type = b["backup-type"].as_str().unwrap();
-
- let type_order = a_backup_type.cmp(b_backup_type);
- if type_order == std::cmp::Ordering::Equal {
- a_id.cmp(b_id)
- } else {
- type_order
- }
- });
-
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
-
- let mut result = vec![];
-
- for item in list {
+ let render_group_path = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ let group = BackupGroup::new(item.backup_type, item.backup_id);
+ Ok(group.group_path().to_str().unwrap().to_owned())
+ };
- let id = item["backup-id"].as_str().unwrap();
- let btype = item["backup-type"].as_str().unwrap();
- let epoch = item["last-backup"].as_i64().unwrap();
- let last_backup = Utc.timestamp(epoch, 0);
- let backup_count = item["backup-count"].as_u64().unwrap();
+ let render_last_backup = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.last_backup);
+ Ok(snapshot.relative_path().to_str().unwrap().to_owned())
+ };
- let group = BackupGroup::new(btype, id);
+ let render_files = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ Ok(tools::format::render_backup_file_list(&item.files))
+ };
- let path = group.group_path().to_str().unwrap().to_owned();
+ let options = default_table_format_options()
+ .sortby("backup-type", false)
+ .sortby("backup-id", false)
+ .column(ColumnConfig::new("backup-id").renderer(render_group_path).header("group"))
+ .column(
+ ColumnConfig::new("last-backup")
+ .renderer(render_last_backup)
+ .header("last snapshot")
+ .right_align(false)
+ )
+ .column(ColumnConfig::new("backup-count"))
+ .column(ColumnConfig::new("files").renderer(render_files));
- let files = item["files"].as_array().unwrap().iter()
- .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
+ let mut data: Value = result["data"].take();
- if output_format == "text" {
- println!(
- "{:20} | {} | {:5} | {}",
- path,
- BackupDir::backup_time_to_string(last_backup),
- backup_count,
- tools::join(&files, ' '),
- );
- } else {
- result.push(json!({
- "backup-type": btype,
- "backup-id": id,
- "last-backup": epoch,
- "backup-count": backup_count,
- "files": files,
- }));
- }
- }
+ let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_LIST_GROUPS;
- if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
+ format_and_print_result_full(&mut data, info, &output_format, &options);
Ok(Value::Null)
}
-fn list_snapshots(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ group: {
+ type: String,
+ description: "Backup group.",
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// List backup snapshots.
+async fn list_snapshots(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
-
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let output_format = get_output_format(¶m);
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
+ let client = connect(repo.host(), repo.user())?;
- let mut args = json!({});
- if let Some(path) = param["group"].as_str() {
- let group = BackupGroup::parse(path)?;
- args["backup-type"] = group.backup_type().into();
- args["backup-id"] = group.backup_id().into();
- }
+ let group = if let Some(path) = param["group"].as_str() {
+ Some(BackupGroup::parse(path)?)
+ } else {
+ None
+ };
- let result = async_main(async move {
- client.get(&path, Some(args)).await
- })?;
+ let mut data = api_datastore_list_snapshots(&client, repo.store(), group).await?;
record_repository(&repo);
- let list = result["data"].as_array().unwrap();
-
- let mut result = vec![];
-
- for item in list {
-
- let id = item["backup-id"].as_str().unwrap();
- let btype = item["backup-type"].as_str().unwrap();
- let epoch = item["backup-time"].as_i64().unwrap();
-
- let snapshot = BackupDir::new(btype, id, epoch);
+ let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: SnapshotListItem = serde_json::from_value(record.to_owned())?;
+ let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time);
+ Ok(snapshot.relative_path().to_str().unwrap().to_owned())
+ };
- let path = snapshot.relative_path().to_str().unwrap().to_owned();
+ let render_files = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: SnapshotListItem = serde_json::from_value(record.to_owned())?;
+ Ok(tools::format::render_backup_file_list(&item.files))
+ };
- let files = item["files"].as_array().unwrap().iter()
- .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
+ let options = default_table_format_options()
+ .sortby("backup-type", false)
+ .sortby("backup-id", false)
+ .sortby("backup-time", false)
+ .column(ColumnConfig::new("backup-id").renderer(render_snapshot_path).header("snapshot"))
+ .column(ColumnConfig::new("size"))
+ .column(ColumnConfig::new("files").renderer(render_files))
+ ;
- if output_format == "text" {
- let size_str = if let Some(size) = item["size"].as_u64() {
- size.to_string()
- } else {
- String::from("-")
- };
- println!("{} | {} | {}", path, size_str, tools::join(&files, ' '));
- } else {
- let mut data = json!({
- "backup-type": btype,
- "backup-id": id,
- "backup-time": epoch,
- "files": files,
- });
- if let Some(size) = item["size"].as_u64() {
- data["size"] = size.into();
- }
- result.push(data);
- }
- }
+ let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_LIST_SNAPSHOTS;
- if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
+ format_and_print_result_full(&mut data, info, &output_format, &options);
Ok(Value::Null)
}
-fn forget_snapshots(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Snapshot path.",
+ },
+ }
+ }
+)]
+/// Forget (remove) backup snapshots.
+async fn forget_snapshots(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let path = tools::required_string_param(¶m, "snapshot")?;
let snapshot = BackupDir::parse(path)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let mut client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = async_main(async move {
- client.delete(&path, Some(json!({
- "backup-type": snapshot.group().backup_type(),
- "backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
- }))).await
- })?;
+ let result = client.delete(&path, Some(json!({
+ "backup-type": snapshot.group().backup_type(),
+ "backup-id": snapshot.group().backup_id(),
+ "backup-time": snapshot.backup_time().timestamp(),
+ }))).await?;
record_repository(&repo);
Ok(result)
}
-fn api_login(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Try to login. If successful, store ticket.
+async fn api_login(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
- async_main(async move { client.login().await })?;
+ let client = connect(repo.host(), repo.user())?;
+ client.login().await?;
record_repository(&repo);
Ok(Value::Null)
}
-fn api_logout(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Logout (delete stored ticket).
+fn api_logout(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- delete_ticket_info(repo.host(), repo.user())?;
+ delete_ticket_info("proxmox-backup", repo.host(), repo.user())?;
Ok(Value::Null)
}
-fn dump_catalog(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Snapshot path.",
+ },
+ }
+ }
+)]
+/// Dump catalog.
+async fn dump_catalog(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let crypt_config = match keyfile {
None => None,
Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
Some(Arc::new(CryptConfig::new(key)?))
}
};
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
-
- async_main(async move {
- let client = BackupReader::start(
- client,
- crypt_config.clone(),
- repo.store(),
- &snapshot.group().backup_type(),
- &snapshot.group().backup_id(),
- snapshot.backup_time(),
- true,
- ).await?;
+ let client = connect(repo.host(), repo.user())?;
- let manifest = client.download_manifest().await?;
+ let client = BackupReader::start(
+ client,
+ crypt_config.clone(),
+ repo.store(),
+ &snapshot.group().backup_type(),
+ &snapshot.group().backup_id(),
+ snapshot.backup_time(),
+ true,
+ ).await?;
- let index = client.download_dynamic_index(&manifest, CATALOG_NAME).await?;
+ let manifest = client.download_manifest().await?;
- let most_used = index.find_most_used_chunks(8);
+ let index = client.download_dynamic_index(&manifest, CATALOG_NAME).await?;
- let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
+ let most_used = index.find_most_used_chunks(8);
- let mut reader = BufferedDynamicReader::new(index, chunk_reader);
+ let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
- let mut catalogfile = std::fs::OpenOptions::new()
- .write(true)
- .read(true)
- .custom_flags(libc::O_TMPFILE)
- .open("/tmp")?;
+ let mut reader = BufferedDynamicReader::new(index, chunk_reader);
- std::io::copy(&mut reader, &mut catalogfile)
- .map_err(|err| format_err!("unable to download catalog - {}", err))?;
+ let mut catalogfile = std::fs::OpenOptions::new()
+ .write(true)
+ .read(true)
+ .custom_flags(libc::O_TMPFILE)
+ .open("/tmp")?;
- catalogfile.seek(SeekFrom::Start(0))?;
+ std::io::copy(&mut reader, &mut catalogfile)
+ .map_err(|err| format_err!("unable to download catalog - {}", err))?;
- let mut catalog_reader = CatalogReader::new(catalogfile);
+ catalogfile.seek(SeekFrom::Start(0))?;
- catalog_reader.dump()?;
+ let mut catalog_reader = CatalogReader::new(catalogfile);
- record_repository(&repo);
+ catalog_reader.dump()?;
- Ok::<(), Error>(())
- })?;
+ record_repository(&repo);
Ok(Value::Null)
}
-fn list_snapshot_files(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Snapshot path.",
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// List snapshot files.
+async fn list_snapshot_files(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let path = tools::required_string_param(¶m, "snapshot")?;
let snapshot = BackupDir::parse(path)?;
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
+ let output_format = get_output_format(¶m);
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/files", repo.store());
- let mut result = async_main(async move {
- client.get(&path, Some(json!({
- "backup-type": snapshot.group().backup_type(),
- "backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
- }))).await
- })?;
+ let mut result = client.get(&path, Some(json!({
+ "backup-type": snapshot.group().backup_type(),
+ "backup-id": snapshot.group().backup_id(),
+ "backup-time": snapshot.backup_time().timestamp(),
+ }))).await?;
record_repository(&repo);
- let list: Value = result["data"].take();
+ let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_LIST_SNAPSHOT_FILES;
- if output_format == "text" {
- for item in list.as_array().unwrap().iter() {
- println!(
- "{} {}",
- strip_server_file_expenstion(item["filename"].as_str().unwrap()),
- item["size"].as_u64().unwrap_or(0),
- );
- }
- } else {
- format_and_print_result(&list, &output_format);
- }
+ let mut data: Value = result["data"].take();
+
+ let options = default_table_format_options();
+
+ format_and_print_result_full(&mut data, info, &output_format, &options);
Ok(Value::Null)
}
-fn start_garbage_collection(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ },
+ },
+)]
+/// Start garbage collection for a specific repository.
+async fn start_garbage_collection(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let output_format = get_output_format(¶m);
+
+ let mut client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
- let result = async_main(async move { client.post(&path, None).await })?;
+ let result = client.post(&path, None).await?;
record_repository(&repo);
- Ok(result)
-}
+ view_task_result(client, result, &output_format).await?;
-fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
-
- if let Some(caps) = (BACKUPSPEC_REGEX.regex_obj)().captures(value) {
- return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
- }
- bail!("unable to parse directory specification '{}'", value);
+ Ok(Value::Null)
}
fn spawn_catalog_upload(
crypt_config: Option<Arc<CryptConfig>>,
) -> Result<
(
- Arc<Mutex<CatalogWriter<SenderWriter>>>,
+ Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
tokio::sync::oneshot::Receiver<Result<BackupStats, Error>>
), Error>
{
- let (catalog_tx, catalog_rx) = mpsc::channel(10); // allow to buffer 10 writes
- let catalog_stream = catalog_rx.map_err(Error::from);
+ let (catalog_tx, catalog_rx) = std::sync::mpsc::sync_channel(10); // allow to buffer 10 writes
+ let catalog_stream = crate::tools::StdChannelStream(catalog_rx);
let catalog_chunk_size = 512*1024;
let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size));
- let catalog = Arc::new(Mutex::new(CatalogWriter::new(SenderWriter::new(catalog_tx))?));
+ let catalog = Arc::new(Mutex::new(CatalogWriter::new(crate::tools::StdChannelWriter::new(catalog_tx))?));
let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel();
Ok((catalog, catalog_result_rx))
}
-fn create_backup(
+#[api(
+ input: {
+ properties: {
+ backupspec: {
+ type: Array,
+ description: "List of backup source specifications ([<label.ext>:<path>] ...)",
+ items: {
+ schema: BACKUP_SOURCE_SCHEMA,
+ }
+ },
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "include-dev": {
+ description: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
+ optional: true,
+ items: {
+ type: String,
+ description: "Path to file.",
+ }
+ },
+ keyfile: {
+ schema: KEYFILE_SCHEMA,
+ optional: true,
+ },
+ "skip-lost-and-found": {
+ type: Boolean,
+ description: "Skip lost+found directory.",
+ optional: true,
+ },
+ "backup-type": {
+ schema: BACKUP_TYPE_SCHEMA,
+ optional: true,
+ },
+ "backup-id": {
+ schema: BACKUP_ID_SCHEMA,
+ optional: true,
+ },
+ "backup-time": {
+ schema: BACKUP_TIME_SCHEMA,
+ optional: true,
+ },
+ "chunk-size": {
+ schema: CHUNK_SIZE_SCHEMA,
+ optional: true,
+ },
+ "exclude": {
+ type: Array,
+ description: "List of paths or patterns for matching files to exclude.",
+ optional: true,
+ items: {
+ type: String,
+ description: "Path or match pattern.",
+ }
+ },
+ "entries-max": {
+ type: Integer,
+ description: "Max number of entries to hold in memory.",
+ optional: true,
+ default: proxmox_backup::pxar::ENCODER_MAX_ENTRIES as isize,
+ },
+ "verbose": {
+ type: Boolean,
+ description: "Verbose output.",
+ optional: true,
+ },
+ }
+ }
+)]
+/// Create (host) backup.
+async fn create_backup(
param: Value,
_info: &ApiMethod,
_rpcenv: &mut dyn RpcEnvironment,
let include_dev = param["include-dev"].as_array();
+ let entries_max = param["entries-max"].as_u64()
+ .unwrap_or(proxmox_backup::pxar::ENCODER_MAX_ENTRIES as u64);
+
+ let empty = Vec::new();
+ let exclude_args = param["exclude"].as_array().unwrap_or(&empty);
+
+ let mut pattern_list = Vec::with_capacity(exclude_args.len());
+ for entry in exclude_args {
+ let entry = entry.as_str().ok_or_else(|| format_err!("Invalid pattern string slice"))?;
+ pattern_list.push(
+ MatchEntry::parse_pattern(entry, PatternFlag::PATH_NAME, MatchType::Exclude)
+ .map_err(|err| format_err!("invalid exclude pattern entry: {}", err))?
+ );
+ }
+
let mut devices = if all_file_systems { None } else { Some(HashSet::new()) };
if let Some(include_dev) = include_dev {
let mut upload_list = vec![];
- enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE };
-
- let mut upload_catalog = false;
-
for backupspec in backupspec_list {
- let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
+ let spec = parse_backup_specification(backupspec.as_str().unwrap())?;
+ let filename = &spec.config_string;
+ let target = &spec.archive_name;
use std::os::unix::fs::FileTypeExt;
.map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?;
let file_type = metadata.file_type();
- let extension = target.rsplit('.').next()
- .ok_or_else(|| format_err!("missing target file extenion '{}'", target))?;
-
- match extension {
- "pxar" => {
+ match spec.spec_type {
+ BackupSpecificationType::PXAR => {
if !file_type.is_dir() {
bail!("got unexpected file type (expected directory)");
}
- upload_list.push((BackupType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
- upload_catalog = true;
+ upload_list.push((BackupSpecificationType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
}
- "img" => {
-
+ BackupSpecificationType::IMAGE => {
if !(file_type.is_file() || file_type.is_block_device()) {
bail!("got unexpected file type (expected file or block device)");
}
if size == 0 { bail!("got zero-sized file '{}'", filename); }
- upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
+ upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
}
- "conf" => {
+ BackupSpecificationType::CONFIG => {
if !file_type.is_file() {
bail!("got unexpected file type (expected regular file)");
}
- upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
+ upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
}
- "log" => {
+ BackupSpecificationType::LOGFILE => {
if !file_type.is_file() {
bail!("got unexpected file type (expected regular file)");
}
- upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
- }
- _ => {
- bail!("got unknown archive extension '{}'", extension);
+ upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
}
}
}
let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0);
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
record_repository(&repo);
println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
let (crypt_config, rsa_encrypted_key) = match keyfile {
None => (None, None),
Some(path) => {
- let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
let crypt_config = CryptConfig::new(key)?;
}
};
- async_main(async move {
- let client = BackupWriter::start(
- client,
- repo.store(),
- backup_type,
- &backup_id,
- backup_time,
- verbose,
- ).await?;
-
- let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
- let mut manifest = BackupManifest::new(snapshot);
-
- let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
-
- for (backup_type, filename, target, size) in upload_list {
- match backup_type {
- BackupType::CONFIG => {
- println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
- let stats = client
- .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
- .await?;
- manifest.add_file(target, stats.size, stats.csum);
- }
- BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
- println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target);
- let stats = client
- .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
- .await?;
- manifest.add_file(target, stats.size, stats.csum);
- }
- BackupType::PXAR => {
- println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
- catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
- let stats = backup_directory(
- &client,
- &filename,
- &target,
- chunk_size_opt,
- devices.clone(),
- verbose,
- skip_lost_and_found,
- crypt_config.clone(),
- catalog.clone(),
- ).await?;
- manifest.add_file(target, stats.size, stats.csum);
- catalog.lock().unwrap().end_directory()?;
- }
- BackupType::IMAGE => {
- println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
- let stats = backup_image(
- &client,
- &filename,
- &target,
- size,
- chunk_size_opt,
- verbose,
- crypt_config.clone(),
- ).await?;
- manifest.add_file(target, stats.size, stats.csum);
+ let client = BackupWriter::start(
+ client,
+ repo.store(),
+ backup_type,
+ &backup_id,
+ backup_time,
+ verbose,
+ ).await?;
+
+ let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp());
+ let mut manifest = BackupManifest::new(snapshot);
+
+ let mut catalog = None;
+ let mut catalog_result_tx = None;
+
+ for (backup_type, filename, target, size) in upload_list {
+ match backup_type {
+ BackupSpecificationType::CONFIG => {
+ println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
+ let stats = client
+ .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
+ .await?;
+ manifest.add_file(target, stats.size, stats.csum)?;
+ }
+ BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
+ println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target);
+ let stats = client
+ .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
+ .await?;
+ manifest.add_file(target, stats.size, stats.csum)?;
+ }
+ BackupSpecificationType::PXAR => {
+ // start catalog upload on first use
+ if catalog.is_none() {
+ let (cat, res) = spawn_catalog_upload(client.clone(), crypt_config.clone())?;
+ catalog = Some(cat);
+ catalog_result_tx = Some(res);
}
+ let catalog = catalog.as_ref().unwrap();
+
+ println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
+ catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
+ let stats = backup_directory(
+ &client,
+ &filename,
+ &target,
+ chunk_size_opt,
+ devices.clone(),
+ verbose,
+ skip_lost_and_found,
+ crypt_config.clone(),
+ catalog.clone(),
+ pattern_list.clone(),
+ entries_max as usize,
+ ).await?;
+ manifest.add_file(target, stats.size, stats.csum)?;
+ catalog.lock().unwrap().end_directory()?;
+ }
+ BackupSpecificationType::IMAGE => {
+ println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
+ let stats = backup_image(
+ &client,
+ &filename,
+ &target,
+ size,
+ chunk_size_opt,
+ verbose,
+ crypt_config.clone(),
+ ).await?;
+ manifest.add_file(target, stats.size, stats.csum)?;
}
}
+ }
- // finalize and upload catalog
- if upload_catalog {
- let mutex = Arc::try_unwrap(catalog)
- .map_err(|_| format_err!("unable to get catalog (still used)"))?;
- let mut catalog = mutex.into_inner().unwrap();
+ // finalize and upload catalog
+ if let Some(catalog) = catalog {
+ let mutex = Arc::try_unwrap(catalog)
+ .map_err(|_| format_err!("unable to get catalog (still used)"))?;
+ let mut catalog = mutex.into_inner().unwrap();
- catalog.finish()?;
+ catalog.finish()?;
- drop(catalog); // close upload stream
+ drop(catalog); // close upload stream
+ if let Some(catalog_result_rx) = catalog_result_tx {
let stats = catalog_result_rx.await??;
-
- manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum);
+ manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum)?;
}
+ }
- if let Some(rsa_encrypted_key) = rsa_encrypted_key {
- let target = "rsa-encrypted.key";
- println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
- let stats = client
- .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
- .await?;
- manifest.add_file(format!("{}.blob", target), stats.size, stats.csum);
-
- // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
- /*
- let mut buffer2 = vec![0u8; rsa.size() as usize];
- let pem_data = file_get_contents("master-private.pem")?;
- let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
- let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
- println!("TEST {} {:?}", len, buffer2);
- */
- }
+ if let Some(rsa_encrypted_key) = rsa_encrypted_key {
+ let target = "rsa-encrypted.key";
+ println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
+ let stats = client
+ .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
+ .await?;
+ manifest.add_file(format!("{}.blob", target), stats.size, stats.csum)?;
+
+ // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
+ /*
+ let mut buffer2 = vec![0u8; rsa.size() as usize];
+ let pem_data = file_get_contents("master-private.pem")?;
+ let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
+ let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
+ println!("TEST {} {:?}", len, buffer2);
+ */
+ }
- // create manifest (index.json)
- let manifest = manifest.into_json();
+ // create manifest (index.json)
+ let manifest = manifest.into_json();
- println!("Upload index.json to '{:?}'", repo);
- let manifest = serde_json::to_string_pretty(&manifest)?.into();
- client
- .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
- .await?;
+ println!("Upload index.json to '{:?}'", repo);
+ let manifest = serde_json::to_string_pretty(&manifest)?.into();
+ client
+ .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true)
+ .await?;
- client.finish().await?;
+ client.finish().await?;
- let end_time = Local::now();
- let elapsed = end_time.signed_duration_since(start_time);
- println!("Duration: {}", elapsed);
+ let end_time = Local::now();
+ let elapsed = end_time.signed_duration_since(start_time);
+ println!("Duration: {}", elapsed);
- println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
+ println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
- Ok(Value::Null)
- })
+ Ok(Value::Null)
}
fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
result
}
-fn restore(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
- async_main(restore_do(param))
-}
-
fn dump_image<W: Write>(
client: Arc<BackupReader>,
crypt_config: Option<Arc<CryptConfig>>,
Ok(())
}
-async fn restore_do(param: Value) -> Result<Value, Error> {
+fn parse_archive_type(name: &str) -> (String, ArchiveType) {
+ if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
+ (name.into(), archive_type(name).unwrap())
+ } else if name.ends_with(".pxar") {
+ (format!("{}.didx", name), ArchiveType::DynamicIndex)
+ } else if name.ends_with(".img") {
+ (format!("{}.fidx", name), ArchiveType::FixedIndex)
+ } else {
+ (format!("{}.blob", name), ArchiveType::Blob)
+ }
+}
+
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Group/Snapshot path.",
+ },
+ "archive-name": {
+ description: "Backup archive name.",
+ type: String,
+ },
+ target: {
+ type: String,
+ description: r###"Target directory path. Use '-' to write to standard output.
+
+We do not extraxt '.pxar' archives when writing to standard output.
+
+"###
+ },
+ "allow-existing-dirs": {
+ type: Boolean,
+ description: "Do not fail if directories already exists.",
+ optional: true,
+ },
+ keyfile: {
+ schema: KEYFILE_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Restore backup repository.
+async fn restore(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let verbose = param["verbose"].as_bool().unwrap_or(false);
let archive_name = tools::required_string_param(¶m, "archive-name")?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
record_repository(&repo);
let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
let group = BackupGroup::parse(path)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.get(&path, Some(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))).await?;
-
- let list = result["data"].as_array().unwrap();
- if list.is_empty() {
- bail!("backup group '{}' does not contain any snapshots:", path);
- }
-
- let epoch = list[0]["backup-time"].as_i64().unwrap();
- let backup_time = Utc.timestamp(epoch, 0);
- (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
+ api_datastore_latest_snapshot(&client, repo.store(), group).await?
} else {
let snapshot = BackupDir::parse(path)?;
(snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
let crypt_config = match keyfile {
None => None,
Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
Some(Arc::new(CryptConfig::new(key)?))
}
};
- let server_archive_name = if archive_name.ends_with(".pxar") {
- format!("{}.didx", archive_name)
- } else if archive_name.ends_with(".img") {
- format!("{}.fidx", archive_name)
- } else {
- format!("{}.blob", archive_name)
- };
-
let client = BackupReader::start(
client,
crypt_config.clone(),
let manifest = client.download_manifest().await?;
- if server_archive_name == MANIFEST_BLOB_NAME {
+ let (archive_name, archive_type) = parse_archive_type(archive_name);
+
+ if archive_name == MANIFEST_BLOB_NAME {
let backup_index_data = manifest.into_json().to_string();
if let Some(target) = target {
- file_set_contents(target, backup_index_data.as_bytes(), None)?;
+ replace_file(target, backup_index_data.as_bytes(), CreateOptions::new())?;
} else {
let stdout = std::io::stdout();
let mut writer = stdout.lock();
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".blob") {
+ } else if archive_type == ArchiveType::Blob {
- let mut reader = client.download_blob(&manifest, &server_archive_name).await?;
+ let mut reader = client.download_blob(&manifest, &archive_name).await?;
if let Some(target) = target {
let mut writer = std::fs::OpenOptions::new()
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".didx") {
+ } else if archive_type == ArchiveType::DynamicIndex {
- let index = client.download_dynamic_index(&manifest, &server_archive_name).await?;
+ let index = client.download_dynamic_index(&manifest, &archive_name).await?;
let most_used = index.find_most_used_chunks(8);
let mut reader = BufferedDynamicReader::new(index, chunk_reader);
if let Some(target) = target {
-
- let feature_flags = pxar::flags::DEFAULT;
- let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags);
- decoder.set_callback(move |path| {
- if verbose {
- eprintln!("{:?}", path);
- }
- Ok(())
- });
- decoder.set_allow_existing_dirs(allow_existing_dirs);
-
- decoder.restore(Path::new(target), &Vec::new())?;
+ proxmox_backup::pxar::extract_archive(
+ pxar::decoder::Decoder::from_std(reader)?,
+ Path::new(target),
+ &[],
+ proxmox_backup::pxar::Flags::DEFAULT,
+ allow_existing_dirs,
+ |path| {
+ if verbose {
+ println!("{:?}", path);
+ }
+ },
+ )
+ .map_err(|err| format_err!("error extracting archive - {}", err))?;
} else {
let mut writer = std::fs::OpenOptions::new()
.write(true)
std::io::copy(&mut reader, &mut writer)
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".fidx") {
+ } else if archive_type == ArchiveType::FixedIndex {
- let index = client.download_fixed_index(&manifest, &server_archive_name).await?;
+ let index = client.download_fixed_index(&manifest, &archive_name).await?;
let mut writer = if let Some(target) = target {
std::fs::OpenOptions::new()
};
dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?;
-
- } else {
- bail!("unknown archive file extension (expected .pxar of .img)");
}
Ok(Value::Null)
}
-fn upload_log(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Group/Snapshot path.",
+ },
+ logfile: {
+ type: String,
+ description: "The path to the log file you want to upload.",
+ },
+ keyfile: {
+ schema: KEYFILE_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Upload backup log file.
+async fn upload_log(param: Value) -> Result<Value, Error> {
let logfile = tools::required_string_param(¶m, "logfile")?;
let repo = extract_repository_from_value(¶m)?;
let snapshot = tools::required_string_param(¶m, "snapshot")?;
let snapshot = BackupDir::parse(snapshot)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let mut client = connect(repo.host(), repo.user())?;
let keyfile = param["keyfile"].as_str().map(PathBuf::from);
let crypt_config = match keyfile {
None => None,
Some(path) => {
- let (key, _created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, _created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
let crypt_config = CryptConfig::new(key)?;
Some(Arc::new(crypt_config))
}
let body = hyper::Body::from(raw_data);
- async_main(async move {
- client.upload("application/octet-stream", body, &path, Some(args)).await
- })
+ client.upload("application/octet-stream", body, &path, Some(args)).await
}
-fn prune(
- mut param: Value,
+const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
+ &ApiHandler::Async(&prune),
+ &ObjectSchema::new(
+ "Prune a backup repository.",
+ &proxmox_backup::add_common_prune_prameters!([
+ ("dry-run", true, &BooleanSchema::new(
+ "Just show what prune would do, but do not delete anything.")
+ .schema()),
+ ("group", false, &StringSchema::new("Backup group.").schema()),
+ ], [
+ ("output-format", true, &OUTPUT_FORMAT),
+ (
+ "quiet",
+ true,
+ &BooleanSchema::new("Minimal output - only show removals.")
+ .schema()
+ ),
+ ("repository", true, &REPO_URL_SCHEMA),
+ ])
+ )
+);
+
+fn prune<'a>(
+ param: Value,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ _rpcenv: &'a mut dyn RpcEnvironment,
+) -> proxmox::api::ApiFuture<'a> {
+ async move {
+ prune_async(param).await
+ }.boxed()
+}
+async fn prune_async(mut param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let mut client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
let group = tools::required_string_param(¶m, "group")?;
let group = BackupGroup::parse(group)?;
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
+
+ let output_format = get_output_format(¶m);
+
+ let quiet = param["quiet"].as_bool().unwrap_or(false);
param.as_object_mut().unwrap().remove("repository");
param.as_object_mut().unwrap().remove("group");
param.as_object_mut().unwrap().remove("output-format");
+ param.as_object_mut().unwrap().remove("quiet");
param["backup-type"] = group.backup_type().into();
param["backup-id"] = group.backup_id().into();
- async_main(async {
- let result = client.post(&path, Some(param)).await?;
+ let mut result = client.post(&path, Some(param)).await?;
- record_repository(&repo);
+ record_repository(&repo);
- let data = &result["data"];
- if output_format == "text" {
- if let Some(upid) = data.as_str() {
- display_task_log(client, upid, true).await?;
- }
- } else {
- format_and_print_result(&data, &output_format);
- }
+ let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: PruneListItem = serde_json::from_value(record.to_owned())?;
+ let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time);
+ Ok(snapshot.relative_path().to_str().unwrap().to_owned())
+ };
+
+ let render_prune_action = |v: &Value, _record: &Value| -> Result<String, Error> {
+ Ok(match v.as_bool() {
+ Some(true) => "keep",
+ Some(false) => "remove",
+ None => "unknown",
+ }.to_string())
+ };
+
+ let options = default_table_format_options()
+ .sortby("backup-type", false)
+ .sortby("backup-id", false)
+ .sortby("backup-time", false)
+ .column(ColumnConfig::new("backup-id").renderer(render_snapshot_path).header("snapshot"))
+ .column(ColumnConfig::new("backup-time").renderer(tools::format::render_epoch).header("date"))
+ .column(ColumnConfig::new("keep").renderer(render_prune_action).header("action"))
+ ;
+
+ let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_PRUNE;
+
+ let mut data = result["data"].take();
+
+ if quiet {
+ let list: Vec<Value> = data.as_array().unwrap().iter().filter(|item| {
+ item["keep"].as_bool() == Some(false)
+ }).map(|v| v.clone()).collect();
+ data = list.into();
+ }
- Ok::<_, Error>(())
- })?;
+ format_and_print_result_full(&mut data, info, &output_format, &options);
Ok(Value::Null)
}
-fn status(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Get repository status.
+async fn status(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
+ let output_format = get_output_format(¶m);
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/status", repo.store());
- let result = async_main(async move { client.get(&path, None).await })?;
- let data = &result["data"];
+ let mut result = client.get(&path, None).await?;
+ let mut data = result["data"].take();
record_repository(&repo);
- if output_format == "text" {
- let total = data["total"].as_u64().unwrap();
- let used = data["used"].as_u64().unwrap();
- let avail = data["avail"].as_u64().unwrap();
+ let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
+ let v = v.as_u64().unwrap();
+ let total = record["total"].as_u64().unwrap();
let roundup = total/200;
+ let per = ((v+roundup)*100)/total;
+ let info = format!(" ({} %)", per);
+ Ok(format!("{} {:>8}", v, info))
+ };
- println!(
- "total: {} used: {} ({} %) available: {}",
- total,
- used,
- ((used+roundup)*100)/total,
- avail,
- );
- } else {
- format_and_print_result(data, &output_format);
- }
+ let options = default_table_format_options()
+ .noheader(true)
+ .column(ColumnConfig::new("total").renderer(render_total_percentage))
+ .column(ColumnConfig::new("used").renderer(render_total_percentage))
+ .column(ColumnConfig::new("avail").renderer(render_total_percentage));
+
+ let schema = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_STATUS;
+
+ format_and_print_result_full(&mut data, schema, &output_format, &options);
Ok(Value::Null)
}
// like get, but simply ignore errors and return Null instead
async fn try_get(repo: &BackupRepository, url: &str) -> Value {
- let client = match HttpClient::new(repo.host(), repo.user(), None) {
+ let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
+ let password = std::env::var(ENV_VAR_PBS_PASSWORD).ok();
+
+ let options = HttpClientOptions::new()
+ .prefix(Some("proxmox-backup".to_string()))
+ .password(password)
+ .interactive(false)
+ .fingerprint(fingerprint)
+ .fingerprint_cache(true)
+ .ticket_cache(true);
+
+ let client = match HttpClient::new(repo.host(), repo.user(), options) {
Ok(v) => v,
_ => return Value::Null,
};
}
fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_backup_group_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
}
async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
}
fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_group_or_snapshot_do(arg, param).await })
+ proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
}
async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
}
fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_backup_snapshot_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
}
async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
}
fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_server_file_name_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
}
async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
complete_server_file_name(arg, param)
.iter()
- .map(|v| strip_server_file_expenstion(&v))
+ .map(|v| tools::format::strip_server_file_expenstion(&v))
.collect()
}
complete_server_file_name(arg, param)
.iter()
.filter_map(|v| {
- let name = strip_server_file_expenstion(&v);
+ let name = tools::format::strip_server_file_expenstion(&v);
if name.ends_with(".pxar") {
Some(name)
} else {
}
// If we're on a TTY, query the user for a password
- if crate::tools::tty::stdin_isatty() {
- return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?);
+ if tty::stdin_isatty() {
+ return Ok(tty::read_password("Encryption Key Password: ")?);
}
bail!("no password input mechanism available");
if kdf == "scrypt" {
// always read passphrase from tty
- if !crate::tools::tty::stdin_isatty() {
+ if !tty::stdin_isatty() {
bail!("unable to read passphrase - no tty");
}
- let password = crate::tools::tty::read_password("Encryption Key Password: ")?;
+ let password = tty::read_and_verify_password("Encryption Key Password: ")?;
let key_config = encrypt_key_with_passphrase(&key, &password)?;
let target_path = master_pubkey_path()?;
- file_set_contents(&target_path, &pem_data, None)?;
+ replace_file(&target_path, &pem_data, CreateOptions::new())?;
println!("Imported public master key to {:?}", target_path);
) -> Result<Value, Error> {
// we need a TTY to query the new password
- if !crate::tools::tty::stdin_isatty() {
+ if !tty::stdin_isatty() {
bail!("unable to create master key - no tty");
}
let rsa = openssl::rsa::Rsa::generate(4096)?;
let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
- let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?;
- let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
- if new_pw != verify_pw {
- bail!("Password verification fail!");
- }
-
- if new_pw.len() < 5 {
- bail!("Password is too short!");
- }
+ let password = String::from_utf8(tty::read_and_verify_password("Master Key Password: ")?)?;
let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
let filename_pub = "master-public.pem";
println!("Writing public master key to {}", filename_pub);
- file_set_contents(filename_pub, pub_key.as_slice(), None)?;
+ replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
let cipher = openssl::symm::Cipher::aes_256_cbc();
- let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
+ let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
let filename_priv = "master-private.pem";
println!("Writing private master key to {}", filename_priv);
- file_set_contents(filename_priv, priv_key.as_slice(), None)?;
+ replace_file(filename_priv, priv_key.as_slice(), CreateOptions::new())?;
Ok(Value::Null)
}
let kdf = param["kdf"].as_str().unwrap_or("scrypt");
// we need a TTY to query the new password
- if !crate::tools::tty::stdin_isatty() {
+ if !tty::stdin_isatty() {
bail!("unable to change passphrase - no tty");
}
- let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, created) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
if kdf == "scrypt" {
- let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?;
- let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
-
- if new_pw != verify_pw {
- bail!("Password verification fail!");
- }
-
- if new_pw.len() < 5 {
- bail!("Password is too short!");
- }
+ let password = tty::read_and_verify_password("New Password: ")?;
- let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
+ let mut new_key_config = encrypt_key_with_passphrase(&key, &password)?;
new_key_config.created = created; // keep original value
store_key_config(&path, true, new_key_config)?;
const KDF_SCHEMA: Schema =
StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.")
- .format(&ApiStringFormat::Enum(&["scrypt", "none"]))
+ .format(&ApiStringFormat::Enum(&[
+ EnumEntry::new("scrypt", "SCrypt"),
+ EnumEntry::new("none", "Do not encrypt the key")]))
.default("scrypt")
.schema();
.completion_cb("path", tools::complete_file_name);
CliCommandMap::new()
- .insert("create".to_owned(), key_create_cmd_def.into())
- .insert("create-master-key".to_owned(), key_create_master_key_cmd_def.into())
- .insert("import-master-pubkey".to_owned(), key_import_master_pubkey_cmd_def.into())
- .insert("change-passphrase".to_owned(), key_change_passphrase_cmd_def.into())
+ .insert("create", key_create_cmd_def)
+ .insert("create-master-key", key_create_master_key_cmd_def)
+ .insert("import-master-pubkey", key_import_master_pubkey_cmd_def)
+ .insert("change-passphrase", key_change_passphrase_cmd_def)
}
fn mount(
if verbose {
// This will stay in foreground with debug output enabled as None is
// passed for the RawFd.
- return async_main(mount_do(param, None));
+ return proxmox_backup::tools::runtime::main(mount_do(param, None));
}
// Process should be deamonized.
Ok(ForkResult::Child) => {
nix::unistd::close(pipe.0).unwrap();
nix::unistd::setsid().unwrap();
- async_main(mount_do(param, Some(pipe.1)))
+ proxmox_backup::tools::runtime::main(mount_do(param, Some(pipe.1)))
}
Err(_) => bail!("failed to daemonize process"),
}
}
+use proxmox_backup::client::RemoteChunkReader;
+/// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
+/// async use!
+///
+/// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
+/// so that we can properly access it from multiple threads simultaneously while not issuing
+/// duplicate simultaneous reads over http.
+struct BufferedDynamicReadAt {
+ inner: Mutex<BufferedDynamicReader<RemoteChunkReader>>,
+}
+
+impl BufferedDynamicReadAt {
+ fn new(inner: BufferedDynamicReader<RemoteChunkReader>) -> Self {
+ Self {
+ inner: Mutex::new(inner),
+ }
+ }
+}
+
+impl pxar::accessor::ReadAt for BufferedDynamicReadAt {
+ fn poll_read_at(
+ self: Pin<&Self>,
+ _cx: &mut Context,
+ buf: &mut [u8],
+ offset: u64,
+ ) -> Poll<io::Result<usize>> {
+ use std::io::Read;
+ tokio::task::block_in_place(move || {
+ let mut reader = self.inner.lock().unwrap();
+ reader.seek(SeekFrom::Start(offset))?;
+ Poll::Ready(Ok(reader.read(buf)?))
+ })
+ }
+}
+
async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let archive_name = tools::required_string_param(¶m, "archive-name")?;
let target = tools::required_string_param(¶m, "target")?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
record_repository(&repo);
let path = tools::required_string_param(¶m, "snapshot")?;
let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
let group = BackupGroup::parse(path)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.get(&path, Some(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))).await?;
-
- let list = result["data"].as_array().unwrap();
- if list.is_empty() {
- bail!("backup group '{}' does not contain any snapshots:", path);
- }
-
- let epoch = list[0]["backup-time"].as_i64().unwrap();
- let backup_time = Utc.timestamp(epoch, 0);
- (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
+ api_datastore_latest_snapshot(&client, repo.store(), group).await?
} else {
let snapshot = BackupDir::parse(path)?;
(snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
let crypt_config = match keyfile {
None => None,
Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
Some(Arc::new(CryptConfig::new(key)?))
}
};
let most_used = index.find_most_used_chunks(8);
let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
let reader = BufferedDynamicReader::new(index, chunk_reader);
- let decoder = pxar::Decoder::new(reader)?;
+ let archive_size = reader.archive_size();
+ let reader: proxmox_backup::pxar::fuse::Reader =
+ Arc::new(BufferedDynamicReadAt::new(reader));
+ let decoder = proxmox_backup::pxar::fuse::Accessor::new(reader, archive_size).await?;
let options = OsStr::new("ro,default_permissions");
- let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none())
- .map_err(|err| format_err!("pxar mount failed: {}", err))?;
- // Mount the session but not call fuse deamonize as this will cause
- // issues with the runtime after the fork
- let deamonize = false;
- session.mount(&Path::new(target), deamonize)?;
+ let session = proxmox_backup::pxar::fuse::Session::mount(
+ decoder,
+ &options,
+ false,
+ Path::new(target),
+ )
+ .map_err(|err| format_err!("pxar mount failed: {}", err))?;
if let Some(pipe) = pipe {
nix::unistd::chdir(Path::new("/")).unwrap();
- // Finish creation of deamon by redirecting filedescriptors.
+ // Finish creation of daemon by redirecting filedescriptors.
let nullfd = nix::fcntl::open(
"/dev/null",
nix::fcntl::OFlag::O_RDWR,
nix::unistd::close(pipe).unwrap();
}
- let multithreaded = true;
- session.run_loop(multithreaded)?;
+ let mut interrupt = signal(SignalKind::interrupt())?;
+ select! {
+ res = session.fuse() => res?,
+ _ = interrupt.recv().fuse() => {
+ // exit on interrupted
+ }
+ }
} else {
bail!("unknown archive file extension (expected .pxar)");
}
Ok(Value::Null)
}
-fn catalog_shell(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
- async_main(catalog_shell_async(param))
-}
-
-async fn catalog_shell_async(param: Value) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ "snapshot": {
+ type: String,
+ description: "Group/Snapshot path.",
+ },
+ "archive-name": {
+ type: String,
+ description: "Backup archive name.",
+ },
+ "repository": {
+ optional: true,
+ schema: REPO_URL_SCHEMA,
+ },
+ "keyfile": {
+ optional: true,
+ type: String,
+ description: "Path to encryption key.",
+ },
+ },
+ },
+)]
+/// Shell to interactively inspect and restore snapshots.
+async fn catalog_shell(param: Value) -> Result<(), Error> {
let repo = extract_repository_from_value(¶m)?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(repo.host(), repo.user())?;
let path = tools::required_string_param(¶m, "snapshot")?;
let archive_name = tools::required_string_param(¶m, "archive-name")?;
let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
let group = BackupGroup::parse(path)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.get(&path, Some(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))).await?;
-
- let list = result["data"].as_array().unwrap();
- if list.is_empty() {
- bail!("backup group '{}' does not contain any snapshots:", path);
- }
-
- let epoch = list[0]["backup-time"].as_i64().unwrap();
- let backup_time = Utc.timestamp(epoch, 0);
- (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
+ api_datastore_latest_snapshot(&client, repo.store(), group).await?
} else {
let snapshot = BackupDir::parse(path)?;
(snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
let crypt_config = match keyfile {
None => None,
Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?;
+ let (key, _) = load_and_decrypt_key(&path, &get_encryption_key_password)?;
Some(Arc::new(CryptConfig::new(key)?))
}
};
let most_used = index.find_most_used_chunks(8);
let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used);
let reader = BufferedDynamicReader::new(index, chunk_reader);
- let mut decoder = pxar::Decoder::new(reader)?;
- decoder.set_callback(|path| {
- println!("{:?}", path);
- Ok(())
- });
+ let archive_size = reader.archive_size();
+ let reader: proxmox_backup::pxar::fuse::Reader =
+ Arc::new(BufferedDynamicReadAt::new(reader));
+ let decoder = proxmox_backup::pxar::fuse::Accessor::new(reader, archive_size).await?;
let tmpfile = client.download(CATALOG_NAME, tmpfile).await?;
let index = DynamicIndexReader::new(tmpfile)
catalog_reader,
&server_archive_name,
decoder,
- )?;
+ ).await?;
println!("Starting interactive shell");
- state.shell()?;
+ state.shell().await?;
record_repository(&repo);
- Ok(Value::Null)
+ Ok(())
}
fn catalog_mgmt_cli() -> CliCommandMap {
-
- #[sortable]
- const API_METHOD_SHELL: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&catalog_shell),
- &ObjectSchema::new(
- "Shell to interactively inspect and restore snapshots.",
- &sorted!([
- ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()),
- ("archive-name", false, &StringSchema::new("Backup archive name.").schema()),
- ("repository", true, &REPO_URL_SCHEMA),
- ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()),
- ]),
- )
- );
-
- let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_SHELL)
+ let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_CATALOG_SHELL)
.arg_param(&["snapshot", "archive-name"])
.completion_cb("repository", complete_repository)
.completion_cb("archive-name", complete_pxar_archive_name)
.completion_cb("snapshot", complete_group_or_snapshot);
- #[sortable]
- const API_METHOD_DUMP_CATALOG: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&dump_catalog),
- &ObjectSchema::new(
- "Dump catalog.",
- &sorted!([
- ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
- ("repository", true, &REPO_URL_SCHEMA),
- ]),
- )
- );
-
let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG)
.arg_param(&["snapshot"])
.completion_cb("repository", complete_repository)
.completion_cb("snapshot", complete_backup_snapshot);
CliCommandMap::new()
- .insert("dump".to_owned(), catalog_dump_cmd_def.into())
- .insert("shell".to_owned(), catalog_shell_cmd_def.into())
+ .insert("dump", catalog_dump_cmd_def)
+ .insert("shell", catalog_shell_cmd_def)
}
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ limit: {
+ description: "The maximal number of tasks to list.",
+ type: Integer,
+ optional: true,
+ minimum: 1,
+ maximum: 1000,
+ default: 50,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ all: {
+ type: Boolean,
+ description: "Also list stopped tasks.",
+ optional: true,
+ },
+ }
+ }
+)]
+/// List running server tasks for this repo user
+async fn task_list(param: Value) -> Result<Value, Error> {
-fn main() {
+ let output_format = get_output_format(¶m);
- const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new("Backup source specification ([<label>:<path>]).")
- .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX))
- .schema();
+ let repo = extract_repository_from_value(¶m)?;
+ let client = connect(repo.host(), repo.user())?;
- #[sortable]
- const API_METHOD_CREATE_BACKUP: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&create_backup),
- &ObjectSchema::new(
- "Create (host) backup.",
- &sorted!([
- (
- "backupspec",
- false,
- &ArraySchema::new(
- "List of backup source specifications ([<label.ext>:<path>] ...)",
- &BACKUP_SOURCE_SCHEMA,
- ).min_length(1).schema()
- ),
- (
- "repository",
- true,
- &REPO_URL_SCHEMA
- ),
- (
- "include-dev",
- true,
- &ArraySchema::new(
- "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
- &StringSchema::new("Path to file.").schema()
- ).schema()
- ),
- (
- "keyfile",
- true,
- &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema()
- ),
- (
- "verbose",
- true,
- &BooleanSchema::new("Verbose output.")
- .default(false)
- .schema()
- ),
- (
- "skip-lost-and-found",
- true,
- &BooleanSchema::new("Skip lost+found directory")
- .default(false)
- .schema()
- ),
- (
- "backup-type",
- true,
- &BACKUP_TYPE_SCHEMA,
- ),
- (
- "backup-id",
- true,
- &BACKUP_ID_SCHEMA
- ),
- (
- "backup-time",
- true,
- &BACKUP_TIME_SCHEMA
- ),
- (
- "chunk-size",
- true,
- &IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
- .minimum(64)
- .maximum(4096)
- .default(4096)
- .schema()
- ),
- ]),
- )
- );
+ let limit = param["limit"].as_u64().unwrap_or(50) as usize;
+ let running = !param["all"].as_bool().unwrap_or(false);
+
+ let args = json!({
+ "running": running,
+ "start": 0,
+ "limit": limit,
+ "userfilter": repo.user(),
+ "store": repo.store(),
+ });
+
+ let mut result = client.get("api2/json/nodes/localhost/tasks", Some(args)).await?;
+ let mut data = result["data"].take();
+
+ let schema = &proxmox_backup::api2::node::tasks::API_RETURN_SCHEMA_LIST_TASKS;
+
+ let options = default_table_format_options()
+ .column(ColumnConfig::new("starttime").right_align(false).renderer(tools::format::render_epoch))
+ .column(ColumnConfig::new("endtime").right_align(false).renderer(tools::format::render_epoch))
+ .column(ColumnConfig::new("upid"))
+ .column(ColumnConfig::new("status").renderer(tools::format::render_task_status));
+
+ format_and_print_result_full(&mut data, schema, &output_format, &options);
+
+ Ok(Value::Null)
+}
+
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ upid: {
+ schema: UPID_SCHEMA,
+ },
+ }
+ }
+)]
+/// Display the task log.
+async fn task_log(param: Value) -> Result<Value, Error> {
+
+ let repo = extract_repository_from_value(¶m)?;
+ let upid = tools::required_string_param(¶m, "upid")?;
+
+ let client = connect(repo.host(), repo.user())?;
+
+ display_task_log(client, upid, true).await?;
+
+ Ok(Value::Null)
+}
+
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ upid: {
+ schema: UPID_SCHEMA,
+ },
+ }
+ }
+)]
+/// Try to stop a specific task.
+async fn task_stop(param: Value) -> Result<Value, Error> {
+
+ let repo = extract_repository_from_value(¶m)?;
+ let upid_str = tools::required_string_param(¶m, "upid")?;
+
+ let mut client = connect(repo.host(), repo.user())?;
+
+ let path = format!("api2/json/nodes/localhost/tasks/{}", upid_str);
+ let _ = client.delete(&path, None).await?;
+
+ Ok(Value::Null)
+}
+
+fn task_mgmt_cli() -> CliCommandMap {
+
+ let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST)
+ .completion_cb("repository", complete_repository);
+
+ let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG)
+ .arg_param(&["upid"]);
+
+ let task_stop_cmd_def = CliCommand::new(&API_METHOD_TASK_STOP)
+ .arg_param(&["upid"]);
+
+ CliCommandMap::new()
+ .insert("log", task_log_cmd_def)
+ .insert("list", task_list_cmd_def)
+ .insert("stop", task_stop_cmd_def)
+}
+
+fn main() {
let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
.arg_param(&["backupspec"])
.completion_cb("keyfile", tools::complete_file_name)
.completion_cb("chunk-size", complete_chunk_size);
- #[sortable]
- const API_METHOD_UPLOAD_LOG: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&upload_log),
- &ObjectSchema::new(
- "Upload backup log file.",
- &sorted!([
- (
- "snapshot",
- false,
- &StringSchema::new("Snapshot path.").schema()
- ),
- (
- "logfile",
- false,
- &StringSchema::new("The path to the log file you want to upload.").schema()
- ),
- (
- "repository",
- true,
- &REPO_URL_SCHEMA
- ),
- (
- "keyfile",
- true,
- &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema()
- ),
- ]),
- )
- );
-
let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG)
.arg_param(&["snapshot", "logfile"])
.completion_cb("snapshot", complete_backup_snapshot)
.completion_cb("keyfile", tools::complete_file_name)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_LIST_BACKUP_GROUPS: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&list_backup_groups),
- &ObjectSchema::new(
- "List backup groups.",
- &sorted!([
- ("repository", true, &REPO_URL_SCHEMA),
- ("output-format", true, &OUTPUT_FORMAT),
- ]),
- )
- );
-
let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_LIST_SNAPSHOTS: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&list_snapshots),
- &ObjectSchema::new(
- "List backup snapshots.",
- &sorted!([
- ("group", true, &StringSchema::new("Backup group.").schema()),
- ("repository", true, &REPO_URL_SCHEMA),
- ("output-format", true, &OUTPUT_FORMAT),
- ]),
- )
- );
-
let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS)
.arg_param(&["group"])
.completion_cb("group", complete_backup_group)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_FORGET_SNAPSHOTS: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&forget_snapshots),
- &ObjectSchema::new(
- "Forget (remove) backup snapshots.",
- &sorted!([
- ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
- ("repository", true, &REPO_URL_SCHEMA),
- ]),
- )
- );
-
let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS)
.arg_param(&["snapshot"])
.completion_cb("repository", complete_repository)
.completion_cb("snapshot", complete_backup_snapshot);
- #[sortable]
- const API_METHOD_START_GARBAGE_COLLECTION: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&start_garbage_collection),
- &ObjectSchema::new(
- "Start garbage collection for a specific repository.",
- &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
- )
- );
-
let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_RESTORE: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&restore),
- &ObjectSchema::new(
- "Restore backup repository.",
- &sorted!([
- ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()),
- ("archive-name", false, &StringSchema::new("Backup archive name.").schema()),
- (
- "target",
- false,
- &StringSchema::new(
- r###"Target directory path. Use '-' to write to stdandard output.
-
-We do not extraxt '.pxar' archives when writing to stdandard output.
-
-"###
- ).schema()
- ),
- (
- "allow-existing-dirs",
- true,
- &BooleanSchema::new("Do not fail if directories already exists.")
- .default(false)
- .schema()
- ),
- ("repository", true, &REPO_URL_SCHEMA),
- ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()),
- (
- "verbose",
- true,
- &BooleanSchema::new("Verbose output.")
- .default(false)
- .schema()
- ),
- ]),
- )
- );
-
let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
.arg_param(&["snapshot", "archive-name", "target"])
.completion_cb("repository", complete_repository)
.completion_cb("archive-name", complete_archive_name)
.completion_cb("target", tools::complete_file_name);
- #[sortable]
- const API_METHOD_LIST_SNAPSHOT_FILES: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&list_snapshot_files),
- &ObjectSchema::new(
- "List snapshot files.",
- &sorted!([
- ("snapshot", false, &StringSchema::new("Snapshot path.").schema()),
- ("repository", true, &REPO_URL_SCHEMA),
- ("output-format", true, &OUTPUT_FORMAT),
- ]),
- )
- );
-
let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES)
.arg_param(&["snapshot"])
.completion_cb("repository", complete_repository)
.completion_cb("snapshot", complete_backup_snapshot);
- const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&prune),
- &ObjectSchema::new(
- "Prune backup repository.",
- &proxmox_backup::add_common_prune_prameters!([
- ("dry-run", true, &BooleanSchema::new(
- "Just show what prune would do, but do not delete anything.")
- .schema()),
- ("group", false, &StringSchema::new("Backup group.").schema()),
- ], [
- ("output-format", true, &OUTPUT_FORMAT),
- ("repository", true, &REPO_URL_SCHEMA),
- ])
- )
- );
-
let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
.arg_param(&["group"])
.completion_cb("group", complete_backup_group)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_STATUS: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&status),
- &ObjectSchema::new(
- "Get repository status.",
- &sorted!([
- ("repository", true, &REPO_URL_SCHEMA),
- ("output-format", true, &OUTPUT_FORMAT),
- ]),
- )
- );
-
let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_API_LOGIN: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&api_login),
- &ObjectSchema::new(
- "Try to login. If successful, store ticket.",
- &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
- )
- );
-
let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
.completion_cb("repository", complete_repository);
- #[sortable]
- const API_METHOD_API_LOGOUT: ApiMethod = ApiMethod::new(
- &ApiHandler::Sync(&api_logout),
- &ObjectSchema::new(
- "Logout (delete stored ticket).",
- &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]),
- )
- );
-
let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
.completion_cb("repository", complete_repository);
let cmd_def = CliCommandMap::new()
- .insert("backup".to_owned(), backup_cmd_def.into())
- .insert("upload-log".to_owned(), upload_log_cmd_def.into())
- .insert("forget".to_owned(), forget_cmd_def.into())
- .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
- .insert("list".to_owned(), list_cmd_def.into())
- .insert("login".to_owned(), login_cmd_def.into())
- .insert("logout".to_owned(), logout_cmd_def.into())
- .insert("prune".to_owned(), prune_cmd_def.into())
- .insert("restore".to_owned(), restore_cmd_def.into())
- .insert("snapshots".to_owned(), snapshots_cmd_def.into())
- .insert("files".to_owned(), files_cmd_def.into())
- .insert("status".to_owned(), status_cmd_def.into())
- .insert("key".to_owned(), key_mgmt_cli().into())
- .insert("mount".to_owned(), mount_cmd_def.into())
- .insert("catalog".to_owned(), catalog_mgmt_cli().into());
-
- run_cli_command(cmd_def.into());
-}
-
-fn async_main<F: Future>(fut: F) -> <F as Future>::Output {
- let rt = tokio::runtime::Runtime::new().unwrap();
- let ret = rt.block_on(fut);
- rt.shutdown_now();
- ret
+ .insert("backup", backup_cmd_def)
+ .insert("upload-log", upload_log_cmd_def)
+ .insert("forget", forget_cmd_def)
+ .insert("garbage-collect", garbage_collect_cmd_def)
+ .insert("list", list_cmd_def)
+ .insert("login", login_cmd_def)
+ .insert("logout", logout_cmd_def)
+ .insert("prune", prune_cmd_def)
+ .insert("restore", restore_cmd_def)
+ .insert("snapshots", snapshots_cmd_def)
+ .insert("files", files_cmd_def)
+ .insert("status", status_cmd_def)
+ .insert("key", key_mgmt_cli())
+ .insert("mount", mount_cmd_def)
+ .insert("catalog", catalog_mgmt_cli())
+ .insert("task", task_mgmt_cli());
+
+ let rpcenv = CliEnvironment::new();
+ run_cli_command(cmd_def, rpcenv, Some(|future| {
+ proxmox_backup::tools::runtime::main(future)
+ }));
}