[pbs-devel] [PATCH proxmox-backup v3 13/42] api: add endpoints for notification matchers
Lukas Wagner
l.wagner at proxmox.com
Mon Apr 22 09:50:01 CEST 2024
These endpoints require Sys.Audit/Sys.Modify permissions on
/system/notifications.
Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
Tested-by: Gabriel Goller <g.goller at proxmox.com>
Reviewed-by: Gabriel Goller <g.goller at proxmox.com>
---
src/api2/config/notifications/matchers.rs | 170 ++++++++++++++++++++++
src/api2/config/notifications/mod.rs | 6 +-
2 files changed, 175 insertions(+), 1 deletion(-)
create mode 100644 src/api2/config/notifications/matchers.rs
diff --git a/src/api2/config/notifications/matchers.rs b/src/api2/config/notifications/matchers.rs
new file mode 100644
index 00000000..fba1859c
--- /dev/null
+++ b/src/api2/config/notifications/matchers.rs
@@ -0,0 +1,170 @@
+use anyhow::Error;
+use serde_json::Value;
+
+use proxmox_notify::matcher::{DeleteableMatcherProperty, MatcherConfig, MatcherConfigUpdater};
+use proxmox_notify::schema::ENTITY_NAME_SCHEMA;
+use proxmox_router::{Permission, Router, RpcEnvironment};
+use proxmox_schema::api;
+
+use pbs_api_types::{PRIV_SYS_AUDIT, PRIV_SYS_MODIFY, PROXMOX_CONFIG_DIGEST_SCHEMA};
+
+#[api(
+ protected: true,
+ input: {
+ properties: {},
+ },
+ returns: {
+ description: "List of matchers.",
+ type: Array,
+ items: { type: MatcherConfig },
+ },
+ access: {
+ permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
+ },
+)]
+/// List all notification matchers.
+pub fn list_matchers(
+ _param: Value,
+ _rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Vec<MatcherConfig>, Error> {
+ let config = pbs_config::notifications::config()?;
+
+ let matchers = proxmox_notify::api::matcher::get_matchers(&config)?;
+
+ Ok(matchers)
+}
+
+#[api(
+ protected: true,
+ input: {
+ properties: {
+ name: {
+ schema: ENTITY_NAME_SCHEMA,
+ }
+ },
+ },
+ returns: { type: MatcherConfig },
+ access: {
+ permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
+ },
+)]
+/// Get a notification matcher.
+pub fn get_matcher(name: String, rpcenv: &mut dyn RpcEnvironment) -> Result<MatcherConfig, Error> {
+ let config = pbs_config::notifications::config()?;
+ let matcher = proxmox_notify::api::matcher::get_matcher(&config, &name)?;
+
+ rpcenv["digest"] = hex::encode(config.digest()).into();
+
+ Ok(matcher)
+}
+
+#[api(
+ protected: true,
+ input: {
+ properties: {
+ matcher: {
+ type: MatcherConfig,
+ flatten: true,
+ }
+ },
+ },
+ access: {
+ permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
+ },
+)]
+/// Add a new notification matcher.
+pub fn add_matcher(matcher: MatcherConfig, _rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> {
+ let _lock = pbs_config::notifications::lock_config()?;
+ let mut config = pbs_config::notifications::config()?;
+
+ proxmox_notify::api::matcher::add_matcher(&mut config, matcher)?;
+
+ pbs_config::notifications::save_config(config)?;
+ Ok(())
+}
+
+#[api(
+ protected: true,
+ input: {
+ properties: {
+ name: {
+ schema: ENTITY_NAME_SCHEMA,
+ },
+ updater: {
+ type: MatcherConfigUpdater,
+ flatten: true,
+ },
+ delete: {
+ description: "List of properties to delete.",
+ type: Array,
+ optional: true,
+ items: {
+ type: DeleteableMatcherProperty,
+ }
+ },
+ digest: {
+ optional: true,
+ schema: PROXMOX_CONFIG_DIGEST_SCHEMA,
+ },
+ },
+ },
+ access: {
+ permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
+ },
+)]
+/// Update notification matcher.
+pub fn update_matcher(
+ name: String,
+ updater: MatcherConfigUpdater,
+ delete: Option<Vec<DeleteableMatcherProperty>>,
+ digest: Option<String>,
+ _rpcenv: &mut dyn RpcEnvironment,
+) -> Result<(), Error> {
+ let _lock = pbs_config::notifications::lock_config()?;
+ let mut config = pbs_config::notifications::config()?;
+ let digest = digest.map(hex::decode).transpose()?;
+
+ proxmox_notify::api::matcher::update_matcher(
+ &mut config,
+ &name,
+ updater,
+ delete.as_deref(),
+ digest.as_deref(),
+ )?;
+
+ pbs_config::notifications::save_config(config)?;
+ Ok(())
+}
+
+#[api(
+ protected: true,
+ input: {
+ properties: {
+ name: {
+ schema: ENTITY_NAME_SCHEMA,
+ }
+ },
+ },
+ access: {
+ permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
+ },
+)]
+/// Delete notification matcher.
+pub fn delete_matcher(name: String, _rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> {
+ let _lock = pbs_config::notifications::lock_config()?;
+ let mut config = pbs_config::notifications::config()?;
+ proxmox_notify::api::matcher::delete_matcher(&mut config, &name)?;
+
+ pbs_config::notifications::save_config(config)?;
+ Ok(())
+}
+
+const ITEM_ROUTER: Router = Router::new()
+ .get(&API_METHOD_GET_MATCHER)
+ .put(&API_METHOD_UPDATE_MATCHER)
+ .delete(&API_METHOD_DELETE_MATCHER);
+
+pub const ROUTER: Router = Router::new()
+ .get(&API_METHOD_LIST_MATCHERS)
+ .post(&API_METHOD_ADD_MATCHER)
+ .match_all("name", &ITEM_ROUTER);
diff --git a/src/api2/config/notifications/mod.rs b/src/api2/config/notifications/mod.rs
index f75e3910..361dc593 100644
--- a/src/api2/config/notifications/mod.rs
+++ b/src/api2/config/notifications/mod.rs
@@ -2,10 +2,14 @@ use proxmox_router::list_subdirs_api_method;
use proxmox_router::{Router, SubdirMap};
use proxmox_sortable_macro::sortable;
+mod matchers;
mod targets;
#[sortable]
-const SUBDIRS: SubdirMap = &sorted!([("targets", &targets::ROUTER),]);
+const SUBDIRS: SubdirMap = &sorted!([
+ ("targets", &targets::ROUTER),
+ ("matchers", &matchers::ROUTER),
+]);
pub const ROUTER: Router = Router::new()
.get(&list_subdirs_api_method!(SUBDIRS))
--
2.39.2
More information about the pbs-devel
mailing list