-use failure::*;
-use futures::*;
+use std::collections::{HashSet, HashMap};
+use std::convert::TryFrom;
-use crate::tools;
-use crate::api2::types::*;
-use crate::api_schema::*;
-use crate::api_schema::router::*;
-//use crate::server::rest::*;
+use chrono::{TimeZone, Local};
+use anyhow::{bail, Error};
+use futures::*;
+use hyper::http::request::Parts;
+use hyper::{header, Body, Response, StatusCode};
use serde_json::{json, Value};
-use std::collections::{HashSet, HashMap};
-use chrono::{DateTime, Datelike, TimeZone, Local};
-use std::path::PathBuf;
-use std::sync::Arc;
-use proxmox::tools::{try_block, fs::file_get_contents, fs::file_set_contents};
+use proxmox::api::{
+ api, ApiResponseFuture, ApiHandler, ApiMethod, Router,
+ RpcEnvironment, RpcEnvironmentType, Permission, UserInformation};
+use proxmox::api::router::SubdirMap;
+use proxmox::api::schema::*;
+use proxmox::tools::fs::{file_get_contents, replace_file, CreateOptions};
+use proxmox::try_block;
+use proxmox::{http_err, identity, list_subdirs_api_method, sortable};
+use crate::api2::types::*;
+use crate::backup::*;
use crate::config::datastore;
+use crate::config::cached_user_info::CachedUserInfo;
-use crate::backup::*;
use crate::server::WorkerTask;
+use crate::tools;
+use crate::config::acl::{
+ PRIV_DATASTORE_AUDIT,
+ PRIV_DATASTORE_MODIFY,
+ PRIV_DATASTORE_READ,
+ PRIV_DATASTORE_PRUNE,
+ PRIV_DATASTORE_BACKUP,
+};
+
+fn check_backup_owner(store: &DataStore, group: &BackupGroup, userid: &str) -> Result<(), Error> {
+ let owner = store.get_owner(group)?;
+ if &owner != userid {
+ bail!("backup owner check failed ({} != {})", userid, owner);
+ }
+ Ok(())
+}
-use hyper::{header, Body, Response, StatusCode};
-use hyper::http::request::Parts;
-
-fn read_backup_index(store: &DataStore, backup_dir: &BackupDir) -> Result<Value, Error> {
+fn read_backup_index(store: &DataStore, backup_dir: &BackupDir) -> Result<Vec<BackupContent>, Error> {
let mut path = store.base_path();
path.push(backup_dir.relative_path());
path.push("index.json.blob");
let raw_data = file_get_contents(&path)?;
- let data = DataBlob::from_raw(raw_data)?.decode(None)?;
- let mut result: Value = serde_json::from_reader(&mut &data[..])?;
+ let index_size = raw_data.len() as u64;
+ let blob = DataBlob::from_raw(raw_data)?;
- let result = result["files"].take();
+ let manifest = BackupManifest::try_from(blob)?;
- if result == Value::Null {
- bail!("missing 'files' property in backup index {:?}", path);
+ let mut result = Vec::new();
+ for item in manifest.files() {
+ result.push(BackupContent {
+ filename: item.filename.clone(),
+ size: Some(item.size),
+ });
}
+ result.push(BackupContent {
+ filename: "index.json.blob".to_string(),
+ size: Some(index_size),
+ });
+
Ok(result)
}
group_hash
}
-fn mark_selections<F: Fn(DateTime<Local>, &BackupInfo) -> String> (
- mark: &mut HashSet<PathBuf>,
- list: &Vec<BackupInfo>,
- keep: usize,
- select_id: F,
-){
- let mut hash = HashSet::new();
- for info in list {
- let local_time = info.backup_dir.backup_time().with_timezone(&Local);
- if hash.len() >= keep as usize { break; }
- let backup_id = info.backup_dir.relative_path();
- let sel_id: String = select_id(local_time, &info);
- if !hash.contains(&sel_id) {
- hash.insert(sel_id);
- //println!(" KEEP ID {} {}", backup_id, local_time.format("%c"));
- mark.insert(backup_id);
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ type: Array,
+ description: "Returns the list of backup groups.",
+ items: {
+ type: GroupListItem,
}
- }
-}
-
+ },
+ access: {
+ permission: &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
+ true),
+ },
+)]
+/// List backup groups.
fn list_groups(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ store: String,
+ rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Vec<GroupListItem>, Error> {
- let store = param["store"].as_str().unwrap();
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
- let datastore = DataStore::lookup_datastore(store)?;
+ let datastore = DataStore::lookup_datastore(&store)?;
let backup_list = BackupInfo::list_backups(&datastore.base_path())?;
let group_hash = group_backups(backup_list);
- let mut groups = vec![];
+ let mut groups = Vec::new();
for (_group_id, mut list) in group_hash {
BackupInfo::sort_list(&mut list, false);
let info = &list[0];
+
let group = info.backup_dir.group();
- groups.push(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- "last-backup": info.backup_dir.backup_time().timestamp(),
- "backup-count": list.len() as u64,
- "files": info.files,
- }));
+ let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
+ if !list_all {
+ let owner = datastore.get_owner(group)?;
+ if owner != username { continue; }
+ }
+
+ let result_item = GroupListItem {
+ backup_type: group.backup_type().to_string(),
+ backup_id: group.backup_id().to_string(),
+ last_backup: info.backup_dir.backup_time().timestamp(),
+ backup_count: list.len() as u64,
+ files: info.files.clone(),
+ };
+ groups.push(result_item);
}
- Ok(json!(groups))
+ Ok(groups)
}
-fn list_snapshot_files (
- param: Value,
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ "backup-type": {
+ schema: BACKUP_TYPE_SCHEMA,
+ },
+ "backup-id": {
+ schema: BACKUP_ID_SCHEMA,
+ },
+ "backup-time": {
+ schema: BACKUP_TIME_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ type: Array,
+ description: "Returns the list of archive files inside a backup snapshots.",
+ items: {
+ type: BackupContent,
+ }
+ },
+ access: {
+ permission: &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
+ true),
+ },
+)]
+/// List snapshot files.
+pub fn list_snapshot_files(
+ store: String,
+ backup_type: String,
+ backup_id: String,
+ backup_time: i64,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Vec<BackupContent>, Error> {
- let store = tools::required_string_param(¶m, "store")?;
- let backup_type = tools::required_string_param(¶m, "backup-type")?;
- let backup_id = tools::required_string_param(¶m, "backup-id")?;
- let backup_time = tools::required_integer_param(¶m, "backup-time")?;
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
+ let datastore = DataStore::lookup_datastore(&store)?;
- let datastore = DataStore::lookup_datastore(store)?;
let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
+ let allowed = (user_privs & (PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ)) != 0;
+ if !allowed { check_backup_owner(&datastore, snapshot.group(), &username)?; }
+
let mut files = read_backup_index(&datastore, &snapshot)?;
let info = BackupInfo::new(&datastore.base_path(), snapshot)?;
- let file_set = files.as_array().unwrap().iter().fold(HashSet::new(), |mut acc, item| {
- acc.insert(item["filename"].as_str().unwrap().to_owned());
+ let file_set = files.iter().fold(HashSet::new(), |mut acc, item| {
+ acc.insert(item.filename.clone());
acc
});
for file in info.files {
if file_set.contains(&file) { continue; }
- files.as_array_mut().unwrap().push(json!({ "filename": file }));
+ files.push(BackupContent { filename: file, size: None });
}
Ok(files)
}
-fn delete_snapshots (
- param: Value,
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ "backup-type": {
+ schema: BACKUP_TYPE_SCHEMA,
+ },
+ "backup-id": {
+ schema: BACKUP_ID_SCHEMA,
+ },
+ "backup-time": {
+ schema: BACKUP_TIME_SCHEMA,
+ },
+ },
+ },
+ access: {
+ permission: &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_MODIFY| PRIV_DATASTORE_PRUNE,
+ true),
+ },
+)]
+/// Delete backup snapshot.
+fn delete_snapshot(
+ store: String,
+ backup_type: String,
+ backup_id: String,
+ backup_time: i64,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
+ rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let store = tools::required_string_param(¶m, "store")?;
- let backup_type = tools::required_string_param(¶m, "backup-type")?;
- let backup_id = tools::required_string_param(¶m, "backup-id")?;
- let backup_time = tools::required_integer_param(¶m, "backup-time")?;
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
- let datastore = DataStore::lookup_datastore(store)?;
+ let datastore = DataStore::lookup_datastore(&store)?;
+
+ let allowed = (user_privs & PRIV_DATASTORE_MODIFY) != 0;
+ if !allowed { check_backup_owner(&datastore, snapshot.group(), &username)?; }
datastore.remove_backup_dir(&snapshot)?;
Ok(Value::Null)
}
-fn list_snapshots (
- param: Value,
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ "backup-type": {
+ optional: true,
+ schema: BACKUP_TYPE_SCHEMA,
+ },
+ "backup-id": {
+ optional: true,
+ schema: BACKUP_ID_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ type: Array,
+ description: "Returns the list of snapshots.",
+ items: {
+ type: SnapshotListItem,
+ }
+ },
+ access: {
+ permission: &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
+ true),
+ },
+)]
+/// List backup snapshots.
+pub fn list_snapshots (
+ store: String,
+ backup_type: Option<String>,
+ backup_id: Option<String>,
+ _param: Value,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Vec<SnapshotListItem>, Error> {
- let store = tools::required_string_param(¶m, "store")?;
- let backup_type = param["backup-type"].as_str();
- let backup_id = param["backup-id"].as_str();
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
- let datastore = DataStore::lookup_datastore(store)?;
+ let datastore = DataStore::lookup_datastore(&store)?;
let base_path = datastore.base_path();
for info in backup_list {
let group = info.backup_dir.group();
- if let Some(backup_type) = backup_type {
+ if let Some(ref backup_type) = backup_type {
if backup_type != group.backup_type() { continue; }
}
- if let Some(backup_id) = backup_id {
+ if let Some(ref backup_id) = backup_id {
if backup_id != group.backup_id() { continue; }
}
- let mut result_item = json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- "backup-time": info.backup_dir.backup_time().timestamp(),
- "files": info.files,
- });
+ let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
+ if !list_all {
+ let owner = datastore.get_owner(group)?;
+ if owner != username { continue; }
+ }
+
+ let mut result_item = SnapshotListItem {
+ backup_type: group.backup_type().to_string(),
+ backup_id: group.backup_id().to_string(),
+ backup_time: info.backup_dir.backup_time().timestamp(),
+ files: info.files,
+ size: None,
+ };
if let Ok(index) = read_backup_index(&datastore, &info.backup_dir) {
let mut backup_size = 0;
- for item in index.as_array().unwrap().iter() {
- if let Some(item_size) = item["size"].as_u64() {
+ for item in index.iter() {
+ if let Some(item_size) = item.size {
backup_size += item_size;
}
}
- result_item["size"] = backup_size.into();
+ result_item.size = Some(backup_size);
}
snapshots.push(result_item);
}
- Ok(json!(snapshots))
+ Ok(snapshots)
}
-fn status(
- param: Value,
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ type: StorageStatus,
+ },
+ access: {
+ permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
+ },
+)]
+/// Get datastore status.
+pub fn status(
+ store: String,
_info: &ApiMethod,
_rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+) -> Result<StorageStatus, Error> {
- let store = param["store"].as_str().unwrap();
-
- let datastore = DataStore::lookup_datastore(store)?;
+ let datastore = DataStore::lookup_datastore(&store)?;
let base_path = datastore.base_path();
nix::errno::Errno::result(res)?;
let bsize = stat.f_bsize as u64;
- Ok(json!({
- "total": stat.f_blocks*bsize,
- "used": (stat.f_blocks-stat.f_bfree)*bsize,
- "avail": stat.f_bavail*bsize,
- }))
+
+ Ok(StorageStatus {
+ total: stat.f_blocks*bsize,
+ used: (stat.f_blocks-stat.f_bfree)*bsize,
+ avail: stat.f_bavail*bsize,
+ })
}
-fn api_method_status() -> ApiMethod {
- ApiMethod::new(
- status,
- add_common_prune_prameters(
- ObjectSchema::new("Get datastore status.")
- .required(
- "store",
- StringSchema::new("Datastore name.")
- )
- )
- )
+#[macro_export]
+macro_rules! add_common_prune_prameters {
+ ( [ $( $list1:tt )* ] ) => {
+ add_common_prune_prameters!([$( $list1 )* ] , [])
+ };
+ ( [ $( $list1:tt )* ] , [ $( $list2:tt )* ] ) => {
+ [
+ $( $list1 )*
+ (
+ "keep-daily",
+ true,
+ &IntegerSchema::new("Number of daily backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ (
+ "keep-hourly",
+ true,
+ &IntegerSchema::new("Number of hourly backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ (
+ "keep-last",
+ true,
+ &IntegerSchema::new("Number of backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ (
+ "keep-monthly",
+ true,
+ &IntegerSchema::new("Number of monthly backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ (
+ "keep-weekly",
+ true,
+ &IntegerSchema::new("Number of weekly backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ (
+ "keep-yearly",
+ true,
+ &IntegerSchema::new("Number of yearly backups to keep.")
+ .minimum(1)
+ .schema()
+ ),
+ $( $list2 )*
+ ]
+ }
}
+pub const API_RETURN_SCHEMA_PRUNE: Schema = ArraySchema::new(
+ "Returns the list of snapshots and a flag indicating if there are kept or removed.",
+ PruneListItem::API_SCHEMA
+).schema();
+
+const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
+ &ApiHandler::Sync(&prune),
+ &ObjectSchema::new(
+ "Prune the datastore.",
+ &add_common_prune_prameters!([
+ ("backup-id", false, &BACKUP_ID_SCHEMA),
+ ("backup-type", false, &BACKUP_TYPE_SCHEMA),
+ ("dry-run", true, &BooleanSchema::new(
+ "Just show what prune would do, but do not delete anything.")
+ .schema()
+ ),
+ ],[
+ ("store", false, &DATASTORE_SCHEMA),
+ ])
+ ))
+ .returns(&API_RETURN_SCHEMA_PRUNE)
+ .access(None, &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_PRUNE,
+ true)
+);
+
fn prune(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
+ rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let store = param["store"].as_str().unwrap();
-
+ let store = tools::required_string_param(¶m, "store")?;
let backup_type = tools::required_string_param(¶m, "backup-type")?;
let backup_id = tools::required_string_param(¶m, "backup-id")?;
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
+ let dry_run = param["dry-run"].as_bool().unwrap_or(false);
+
let group = BackupGroup::new(backup_type, backup_id);
- let datastore = DataStore::lookup_datastore(store)?;
+ let datastore = DataStore::lookup_datastore(&store)?;
+
+ let allowed = (user_privs & PRIV_DATASTORE_MODIFY) != 0;
+ if !allowed { check_backup_owner(&datastore, &group, &username)?; }
+
+ let prune_options = PruneOptions {
+ keep_last: param["keep-last"].as_u64(),
+ keep_hourly: param["keep-hourly"].as_u64(),
+ keep_daily: param["keep-daily"].as_u64(),
+ keep_weekly: param["keep-weekly"].as_u64(),
+ keep_monthly: param["keep-monthly"].as_u64(),
+ keep_yearly: param["keep-yearly"].as_u64(),
+ };
+
+ let worker_id = format!("{}_{}_{}", store, backup_type, backup_id);
+
+ let mut prune_result = Vec::new();
+
+ let list = group.list_backups(&datastore.base_path())?;
+
+ let mut prune_info = compute_prune_info(list, &prune_options)?;
- let mut keep_all = true;
+ prune_info.reverse(); // delete older snapshots first
- for opt in &["keep-last", "keep-daily", "keep-weekly", "keep-weekly", "keep-yearly"] {
- if !param[opt].is_null() {
- keep_all = false;
- break;
+ let keep_all = !prune_options.keeps_something();
+
+ if dry_run {
+ for (info, mut keep) in prune_info {
+ if keep_all { keep = true; }
+
+ let backup_time = info.backup_dir.backup_time();
+ let group = info.backup_dir.group();
+
+ prune_result.push(json!({
+ "backup-type": group.backup_type(),
+ "backup-id": group.backup_id(),
+ "backup-time": backup_time.timestamp(),
+ "keep": keep,
+ }));
}
+ return Ok(json!(prune_result));
}
- let worker = WorkerTask::new("prune", Some(store.to_owned()), "root@pam", true)?;
+
+ // We use a WorkerTask just to have a task log, but run synchrounously
+ let worker = WorkerTask::new("prune", Some(worker_id), "root@pam", true)?;
+
let result = try_block! {
if keep_all {
worker.log("No prune selection - keeping all files.");
- return Ok(());
} else {
- worker.log(format!("Starting prune on store {}", store));
- }
-
- let mut list = group.list_backups(&datastore.base_path())?;
-
- let mut mark = HashSet::new();
-
- BackupInfo::sort_list(&mut list, false);
-
- if let Some(keep_last) = param["keep-last"].as_u64() {
- list.iter().take(keep_last as usize).for_each(|info| {
- mark.insert(info.backup_dir.relative_path());
- });
+ worker.log(format!("retention options: {}", prune_options.cli_options_string()));
+ worker.log(format!("Starting prune on store \"{}\" group \"{}/{}\"",
+ store, backup_type, backup_id));
}
- if let Some(keep_daily) = param["keep-daily"].as_u64() {
- mark_selections(&mut mark, &list, keep_daily as usize, |local_time, _info| {
- format!("{}/{}/{}", local_time.year(), local_time.month(), local_time.day())
- });
- }
+ for (info, mut keep) in prune_info {
+ if keep_all { keep = true; }
- if let Some(keep_weekly) = param["keep-weekly"].as_u64() {
- mark_selections(&mut mark, &list, keep_weekly as usize, |local_time, _info| {
- format!("{}/{}", local_time.year(), local_time.iso_week().week())
- });
- }
+ let backup_time = info.backup_dir.backup_time();
+ let timestamp = BackupDir::backup_time_to_string(backup_time);
+ let group = info.backup_dir.group();
- if let Some(keep_monthly) = param["keep-monthly"].as_u64() {
- mark_selections(&mut mark, &list, keep_monthly as usize, |local_time, _info| {
- format!("{}/{}", local_time.year(), local_time.month())
- });
- }
- if let Some(keep_yearly) = param["keep-yearly"].as_u64() {
- mark_selections(&mut mark, &list, keep_yearly as usize, |local_time, _info| {
- format!("{}/{}", local_time.year(), local_time.year())
- });
- }
+ let msg = format!(
+ "{}/{}/{} {}",
+ group.backup_type(),
+ group.backup_id(),
+ timestamp,
+ if keep { "keep" } else { "remove" },
+ );
- let mut remove_list: Vec<BackupInfo> = list.into_iter()
- .filter(|info| !mark.contains(&info.backup_dir.relative_path())).collect();
+ worker.log(msg);
- BackupInfo::sort_list(&mut remove_list, true);
+ prune_result.push(json!({
+ "backup-type": group.backup_type(),
+ "backup-id": group.backup_id(),
+ "backup-time": backup_time.timestamp(),
+ "keep": keep,
+ }));
- for info in remove_list {
- worker.log(format!("remove {:?}", info.backup_dir));
- datastore.remove_backup_dir(&info.backup_dir)?;
+ if !(dry_run || keep) {
+ datastore.remove_backup_dir(&info.backup_dir)?;
+ }
}
Ok(())
if let Err(err) = result {
bail!("prune failed - {}", err);
- }
-
- Ok(json!(null))
-}
+ };
-pub fn add_common_prune_prameters(schema: ObjectSchema) -> ObjectSchema {
-
- schema
- .optional(
- "keep-last",
- IntegerSchema::new("Number of backups to keep.")
- .minimum(1)
- )
- .optional(
- "keep-daily",
- IntegerSchema::new("Number of daily backups to keep.")
- .minimum(1)
- )
- .optional(
- "keep-weekly",
- IntegerSchema::new("Number of weekly backups to keep.")
- .minimum(1)
- )
- .optional(
- "keep-monthly",
- IntegerSchema::new("Number of monthly backups to keep.")
- .minimum(1)
- )
- .optional(
- "keep-yearly",
- IntegerSchema::new("Number of yearly backups to keep.")
- .minimum(1)
- )
-}
-
-fn api_method_prune() -> ApiMethod {
- ApiMethod::new(
- prune,
- add_common_prune_prameters(
- ObjectSchema::new("Prune the datastore.")
- .required(
- "store",
- StringSchema::new("Datastore name.")
- )
- .required("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .required("backup-id", BACKUP_ID_SCHEMA.clone())
- )
- )
+ Ok(json!(prune_result))
}
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ schema: UPID_SCHEMA,
+ },
+ access: {
+ permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY, false),
+ },
+)]
+/// Start garbage collection.
fn start_garbage_collection(
- param: Value,
+ store: String,
_info: &ApiMethod,
rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let store = param["store"].as_str().unwrap().to_string();
-
let datastore = DataStore::lookup_datastore(&store)?;
println!("Starting garbage collection on store {}", store);
"garbage_collection", Some(store.clone()), "root@pam", to_stdout, move |worker|
{
worker.log(format!("starting garbage collection on store {}", store));
- datastore.garbage_collection(worker)
+ datastore.garbage_collection(&worker)
})?;
Ok(json!(upid_str))
}
-pub fn api_method_start_garbage_collection() -> ApiMethod {
- ApiMethod::new(
- start_garbage_collection,
- ObjectSchema::new("Start garbage collection.")
- .required("store", StringSchema::new("Datastore name."))
- )
-}
-
-fn garbage_collection_status(
- param: Value,
+#[api(
+ input: {
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ },
+ },
+ returns: {
+ type: GarbageCollectionStatus,
+ },
+ access: {
+ permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT, false),
+ },
+)]
+/// Garbage collection status.
+pub fn garbage_collection_status(
+ store: String,
_info: &ApiMethod,
_rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let store = param["store"].as_str().unwrap();
+) -> Result<GarbageCollectionStatus, Error> {
let datastore = DataStore::lookup_datastore(&store)?;
- println!("Garbage collection status on store {}", store);
-
let status = datastore.last_gc_status();
- Ok(serde_json::to_value(&status)?)
-}
-
-pub fn api_method_garbage_collection_status() -> ApiMethod {
- ApiMethod::new(
- garbage_collection_status,
- ObjectSchema::new("Garbage collection status.")
- .required("store", StringSchema::new("Datastore name."))
- )
+ Ok(status)
}
+#[api(
+ returns: {
+ description: "List the accessible datastores.",
+ type: Array,
+ items: {
+ description: "Datastore name and description.",
+ properties: {
+ store: {
+ schema: DATASTORE_SCHEMA,
+ },
+ comment: {
+ optional: true,
+ schema: SINGLE_LINE_COMMENT_SCHEMA,
+ },
+ },
+ },
+ },
+ access: {
+ permission: &Permission::Anybody,
+ },
+)]
+/// Datastore list
fn get_datastore_list(
_param: Value,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
+ rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let config = datastore::config()?;
+ let (config, _digest) = datastore::config()?;
+
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
- Ok(config.convert_to_array("store"))
+ let mut list = Vec::new();
+
+ for (store, (_, data)) in &config.sections {
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+ let allowed = (user_privs & (PRIV_DATASTORE_AUDIT| PRIV_DATASTORE_BACKUP)) != 0;
+ if allowed {
+ let mut entry = json!({ "store": store });
+ if let Some(comment) = data["comment"].as_str() {
+ entry["comment"] = comment.into();
+ }
+ list.push(entry);
+ }
+ }
+
+ Ok(list.into())
}
+#[sortable]
+pub const API_METHOD_DOWNLOAD_FILE: ApiMethod = ApiMethod::new(
+ &ApiHandler::AsyncHttp(&download_file),
+ &ObjectSchema::new(
+ "Download single raw file from backup snapshot.",
+ &sorted!([
+ ("store", false, &DATASTORE_SCHEMA),
+ ("backup-type", false, &BACKUP_TYPE_SCHEMA),
+ ("backup-id", false, &BACKUP_ID_SCHEMA),
+ ("backup-time", false, &BACKUP_TIME_SCHEMA),
+ ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA),
+ ]),
+ )
+).access(None, &Permission::Privilege(
+ &["datastore", "{store}"],
+ PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
+ true)
+);
fn download_file(
_parts: Parts,
_req_body: Body,
param: Value,
- _info: &ApiAsyncMethod,
- _rpcenv: Box<dyn RpcEnvironment>,
-) -> Result<BoxFut, Error> {
+ _info: &ApiMethod,
+ rpcenv: Box<dyn RpcEnvironment>,
+) -> ApiResponseFuture {
- let store = tools::required_string_param(¶m, "store")?;
+ async move {
+ let store = tools::required_string_param(¶m, "store")?;
+ let datastore = DataStore::lookup_datastore(store)?;
- let datastore = DataStore::lookup_datastore(store)?;
+ let username = rpcenv.get_user().unwrap();
+ let user_info = CachedUserInfo::new()?;
+ let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
- let file_name = tools::required_string_param(¶m, "file-name")?.to_owned();
+ let file_name = tools::required_string_param(¶m, "file-name")?.to_owned();
- let backup_type = tools::required_string_param(¶m, "backup-type")?;
- let backup_id = tools::required_string_param(¶m, "backup-id")?;
- let backup_time = tools::required_integer_param(¶m, "backup-time")?;
+ let backup_type = tools::required_string_param(¶m, "backup-type")?;
+ let backup_id = tools::required_string_param(¶m, "backup-id")?;
+ let backup_time = tools::required_integer_param(¶m, "backup-time")?;
- println!("Download {} from {} ({}/{}/{}/{})", file_name, store,
- backup_type, backup_id, Local.timestamp(backup_time, 0), file_name);
+ let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
- let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
+ let allowed = (user_privs & PRIV_DATASTORE_READ) != 0;
+ if !allowed { check_backup_owner(&datastore, backup_dir.group(), &username)?; }
- let mut path = datastore.base_path();
- path.push(backup_dir.relative_path());
- path.push(&file_name);
-
- let response_future = tokio::fs::File::open(path)
- .map_err(|err| http_err!(BAD_REQUEST, format!("File open failed: {}", err)))
- .and_then(move |file| {
- let payload = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
- .map_ok(|bytes| hyper::Chunk::from(bytes.freeze()));
- let body = Body::wrap_stream(payload);
-
- // fixme: set other headers ?
- futures::future::ok(Response::builder()
- .status(StatusCode::OK)
- .header(header::CONTENT_TYPE, "application/octet-stream")
- .body(body)
- .unwrap())
- });
+ println!("Download {} from {} ({}/{}/{}/{})", file_name, store,
+ backup_type, backup_id, Local.timestamp(backup_time, 0), file_name);
+
+ let mut path = datastore.base_path();
+ path.push(backup_dir.relative_path());
+ path.push(&file_name);
+
+ let file = tokio::fs::File::open(path)
+ .map_err(|err| http_err!(BAD_REQUEST, format!("File open failed: {}", err)))
+ .await?;
- Ok(Box::new(response_future))
+ let payload = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
+ .map_ok(|bytes| hyper::body::Bytes::from(bytes.freeze()));
+ let body = Body::wrap_stream(payload);
+
+ // fixme: set other headers ?
+ Ok(Response::builder()
+ .status(StatusCode::OK)
+ .header(header::CONTENT_TYPE, "application/octet-stream")
+ .body(body)
+ .unwrap())
+ }.boxed()
}
-pub fn api_method_download_file() -> ApiAsyncMethod {
- ApiAsyncMethod::new(
- download_file,
- ObjectSchema::new("Download single raw file from backup snapshot.")
- .required("store", StringSchema::new("Datastore name."))
- .required("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .required("backup-id", BACKUP_ID_SCHEMA.clone())
- .required("backup-time", BACKUP_TIME_SCHEMA.clone())
- .required("file-name", StringSchema::new("Raw file name.").format(FILENAME_FORMAT.clone()))
+#[sortable]
+pub const API_METHOD_UPLOAD_BACKUP_LOG: ApiMethod = ApiMethod::new(
+ &ApiHandler::AsyncHttp(&upload_backup_log),
+ &ObjectSchema::new(
+ "Upload the client backup log file into a backup snapshot ('client.log.blob').",
+ &sorted!([
+ ("store", false, &DATASTORE_SCHEMA),
+ ("backup-type", false, &BACKUP_TYPE_SCHEMA),
+ ("backup-id", false, &BACKUP_ID_SCHEMA),
+ ("backup-time", false, &BACKUP_TIME_SCHEMA),
+ ]),
)
-}
+).access(
+ Some("Only the backup creator/owner is allowed to do this."),
+ &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_BACKUP, false)
+);
fn upload_backup_log(
_parts: Parts,
req_body: Body,
param: Value,
- _info: &ApiAsyncMethod,
- _rpcenv: Box<dyn RpcEnvironment>,
-) -> Result<BoxFut, Error> {
-
- let store = tools::required_string_param(¶m, "store")?;
+ _info: &ApiMethod,
+ rpcenv: Box<dyn RpcEnvironment>,
+) -> ApiResponseFuture {
- let datastore = DataStore::lookup_datastore(store)?;
+ async move {
+ let store = tools::required_string_param(¶m, "store")?;
+ let datastore = DataStore::lookup_datastore(store)?;
- let file_name = "client.log.blob";
+ let file_name = "client.log.blob";
- let backup_type = tools::required_string_param(¶m, "backup-type")?;
- let backup_id = tools::required_string_param(¶m, "backup-id")?;
- let backup_time = tools::required_integer_param(¶m, "backup-time")?;
+ let backup_type = tools::required_string_param(¶m, "backup-type")?;
+ let backup_id = tools::required_string_param(¶m, "backup-id")?;
+ let backup_time = tools::required_integer_param(¶m, "backup-time")?;
- let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
+ let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
- let mut path = datastore.base_path();
- path.push(backup_dir.relative_path());
- path.push(&file_name);
+ let username = rpcenv.get_user().unwrap();
+ check_backup_owner(&datastore, backup_dir.group(), &username)?;
- if path.exists() {
- bail!("backup already contains a log.");
- }
+ let mut path = datastore.base_path();
+ path.push(backup_dir.relative_path());
+ path.push(&file_name);
- println!("Upload backup log to {}/{}/{}/{}/{}", store,
- backup_type, backup_id, BackupDir::backup_time_to_string(backup_dir.backup_time()), file_name);
-
- let resp = req_body
- .map_err(Error::from)
- .try_fold(Vec::new(), |mut acc, chunk| {
- acc.extend_from_slice(&*chunk);
- future::ok::<_, Error>(acc)
- })
- .and_then(move |data| async move {
- let blob = DataBlob::from_raw(data)?;
- // always verify CRC at server side
- blob.verify_crc()?;
- let raw_data = blob.raw_data();
- file_set_contents(&path, raw_data, None)?;
- Ok(())
- })
- .and_then(move |_| {
- future::ok(crate::server::formatter::json_response(Ok(Value::Null)))
- })
- ;
-
- Ok(Box::new(resp))
-}
+ if path.exists() {
+ bail!("backup already contains a log.");
+ }
-pub fn api_method_upload_backup_log() -> ApiAsyncMethod {
- ApiAsyncMethod::new(
- upload_backup_log,
- ObjectSchema::new("Download single raw file from backup snapshot.")
- .required("store", StringSchema::new("Datastore name."))
- .required("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .required("backup-id", BACKUP_ID_SCHEMA.clone())
- .required("backup-time", BACKUP_TIME_SCHEMA.clone())
- )
+ println!("Upload backup log to {}/{}/{}/{}/{}", store,
+ backup_type, backup_id, BackupDir::backup_time_to_string(backup_dir.backup_time()), file_name);
+
+ let data = req_body
+ .map_err(Error::from)
+ .try_fold(Vec::new(), |mut acc, chunk| {
+ acc.extend_from_slice(&*chunk);
+ future::ok::<_, Error>(acc)
+ })
+ .await?;
+
+ let blob = DataBlob::from_raw(data)?;
+ // always verify CRC at server side
+ blob.verify_crc()?;
+ let raw_data = blob.raw_data();
+ replace_file(&path, raw_data, CreateOptions::new())?;
+
+ // fixme: use correct formatter
+ Ok(crate::server::formatter::json_response(Ok(Value::Null)))
+ }.boxed()
}
-pub fn router() -> Router {
-
- let store_schema: Arc<Schema> = Arc::new(
- StringSchema::new("Datastore name.").into()
- );
-
- let datastore_info = Router::new()
- .subdir(
- "download",
- Router::new()
- .download(api_method_download_file())
- )
- .subdir(
- "upload-backup-log",
- Router::new()
- .upload(api_method_upload_backup_log())
- )
- .subdir(
- "gc",
- Router::new()
- .get(api_method_garbage_collection_status())
- .post(api_method_start_garbage_collection()))
- .subdir(
- "files",
- Router::new()
- .get(
- ApiMethod::new(
- list_snapshot_files,
- ObjectSchema::new("List snapshot files.")
- .required("store", store_schema.clone())
- .required("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .required("backup-id", BACKUP_ID_SCHEMA.clone())
- .required("backup-time", BACKUP_TIME_SCHEMA.clone())
- )
- )
- )
- .subdir(
- "groups",
- Router::new()
- .get(ApiMethod::new(
- list_groups,
- ObjectSchema::new("List backup groups.")
- .required("store", store_schema.clone()))))
- .subdir(
- "snapshots",
- Router::new()
- .get(
- ApiMethod::new(
- list_snapshots,
- ObjectSchema::new("List backup groups.")
- .required("store", store_schema.clone())
- .optional("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .optional("backup-id", BACKUP_ID_SCHEMA.clone())
- )
- )
- .delete(
- ApiMethod::new(
- delete_snapshots,
- ObjectSchema::new("Delete backup snapshot.")
- .required("store", store_schema.clone())
- .required("backup-type", BACKUP_TYPE_SCHEMA.clone())
- .required("backup-id", BACKUP_ID_SCHEMA.clone())
- .required("backup-time", BACKUP_TIME_SCHEMA.clone())
- )
- )
- )
- .subdir(
- "prune",
- Router::new()
- .post(api_method_prune())
- )
- .subdir(
- "status",
- Router::new()
- .get(api_method_status())
- )
- .list_subdirs();
-
- Router::new()
- .get(ApiMethod::new(
- get_datastore_list,
- ObjectSchema::new("Directory index.")))
- .match_all("store", datastore_info)
-}
+#[sortable]
+const DATASTORE_INFO_SUBDIRS: SubdirMap = &[
+ (
+ "download",
+ &Router::new()
+ .download(&API_METHOD_DOWNLOAD_FILE)
+ ),
+ (
+ "files",
+ &Router::new()
+ .get(&API_METHOD_LIST_SNAPSHOT_FILES)
+ ),
+ (
+ "gc",
+ &Router::new()
+ .get(&API_METHOD_GARBAGE_COLLECTION_STATUS)
+ .post(&API_METHOD_START_GARBAGE_COLLECTION)
+ ),
+ (
+ "groups",
+ &Router::new()
+ .get(&API_METHOD_LIST_GROUPS)
+ ),
+ (
+ "prune",
+ &Router::new()
+ .post(&API_METHOD_PRUNE)
+ ),
+ (
+ "snapshots",
+ &Router::new()
+ .get(&API_METHOD_LIST_SNAPSHOTS)
+ .delete(&API_METHOD_DELETE_SNAPSHOT)
+ ),
+ (
+ "status",
+ &Router::new()
+ .get(&API_METHOD_STATUS)
+ ),
+ (
+ "upload-backup-log",
+ &Router::new()
+ .upload(&API_METHOD_UPLOAD_BACKUP_LOG)
+ ),
+];
+
+const DATASTORE_INFO_ROUTER: Router = Router::new()
+ .get(&list_subdirs_api_method!(DATASTORE_INFO_SUBDIRS))
+ .subdirs(DATASTORE_INFO_SUBDIRS);
+
+
+pub const ROUTER: Router = Router::new()
+ .get(&API_METHOD_GET_DATASTORE_LIST)
+ .match_all("store", &DATASTORE_INFO_ROUTER);
projects / proxmox-backup.git / blobdiff