public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v5 07/44] pbs-config: add module for loading notification config
Date: Tue, 23 Apr 2024 13:51:53 +0200	[thread overview]
Message-ID: <20240423115230.170113-8-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240423115230.170113-1-l.wagner@proxmox.com>

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
Tested-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 Cargo.toml                      |  3 +++
 pbs-config/Cargo.toml           |  1 +
 pbs-config/src/lib.rs           |  1 +
 pbs-config/src/notifications.rs | 41 +++++++++++++++++++++++++++++++++
 4 files changed, 46 insertions(+)
 create mode 100644 pbs-config/src/notifications.rs

diff --git a/Cargo.toml b/Cargo.toml
index 4616e476..f06aeba3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -65,6 +65,7 @@ proxmox-io = "1.0.1" # tools and client use "tokio" feature
 proxmox-lang = "1.1"
 proxmox-ldap = "0.2.1"
 proxmox-metrics = "0.3"
+proxmox-notify = "0.3"
 proxmox-openid = "0.10.0"
 proxmox-rest-server = { version = "0.5.1", features = [ "templates" ] }
 # some use "cli", some use "cli" and "server", pbs-config uses nothing
@@ -211,6 +212,7 @@ proxmox-io.workspace = true
 proxmox-lang.workspace = true
 proxmox-ldap.workspace = true
 proxmox-metrics.workspace = true
+proxmox-notify = { workspace = true, features = [ "pbs-context" ] }
 proxmox-openid.workspace = true
 proxmox-rest-server = { workspace = true, features = [ "rate-limited-stream" ] }
 proxmox-router = { workspace = true, features = [ "cli", "server"] }
@@ -257,6 +259,7 @@ proxmox-rrd.workspace = true
 #proxmox-lang = { path = "../proxmox/proxmox-lang" }
 #proxmox-ldap = { path = "../proxmox/proxmox-ldap" }
 #proxmox-metrics = { path = "../proxmox/proxmox-metrics" }
+#proxmox-notify = { path = "../proxmox/proxmox-notify" }
 #proxmox-openid = { path = "../proxmox/proxmox-openid" }
 #proxmox-rest-server = { path = "../proxmox/proxmox-rest-server" }
 #proxmox-router = { path = "../proxmox/proxmox-router" }
diff --git a/pbs-config/Cargo.toml b/pbs-config/Cargo.toml
index d11cd41e..ac639a8e 100644
--- a/pbs-config/Cargo.toml
+++ b/pbs-config/Cargo.toml
@@ -17,6 +17,7 @@ regex.workspace = true
 serde.workspace = true
 serde_json.workspace = true
 
+proxmox-notify.workspace = true
 proxmox-router = { workspace = true, default-features = false }
 proxmox-schema.workspace = true
 proxmox-section-config.workspace = true
diff --git a/pbs-config/src/lib.rs b/pbs-config/src/lib.rs
index 3cfdb2a1..20a8238d 100644
--- a/pbs-config/src/lib.rs
+++ b/pbs-config/src/lib.rs
@@ -7,6 +7,7 @@ pub mod drive;
 pub mod media_pool;
 pub mod metrics;
 pub mod network;
+pub mod notifications;
 pub mod prune;
 pub mod remote;
 pub mod sync;
diff --git a/pbs-config/src/notifications.rs b/pbs-config/src/notifications.rs
new file mode 100644
index 00000000..df327346
--- /dev/null
+++ b/pbs-config/src/notifications.rs
@@ -0,0 +1,41 @@
+use anyhow::Error;
+
+use proxmox_notify::Config;
+
+use pbs_buildcfg::configdir;
+
+use crate::{open_backup_lockfile, BackupLockGuard};
+
+/// Configuration file location for notification targets/matchers.
+pub const NOTIFICATION_CONFIG_PATH: &str = configdir!("/notifications.cfg");
+
+/// Private configuration file location for secrets - only readable by `root`.
+pub const NOTIFICATION_PRIV_CONFIG_PATH: &str = configdir!("/notifications-priv.cfg");
+
+/// Lockfile to prevent concurrent write access.
+pub const NOTIFICATION_LOCK_FILE: &str = configdir!("/.notifications.lck");
+
+/// Get exclusive lock for `notifications.cfg`
+pub fn lock_config() -> Result<BackupLockGuard, Error> {
+    open_backup_lockfile(NOTIFICATION_LOCK_FILE, None, true)
+}
+
+/// Load notification config.
+pub fn config() -> Result<Config, Error> {
+    let content =
+        proxmox_sys::fs::file_read_optional_string(NOTIFICATION_CONFIG_PATH)?.unwrap_or_default();
+
+    let priv_content = proxmox_sys::fs::file_read_optional_string(NOTIFICATION_PRIV_CONFIG_PATH)?
+        .unwrap_or_default();
+
+    Ok(Config::new(&content, &priv_content)?)
+}
+
+/// Save notification config.
+pub fn save_config(config: Config) -> Result<(), Error> {
+    let (cfg, priv_cfg) = config.write()?;
+    crate::replace_backup_config(NOTIFICATION_CONFIG_PATH, cfg.as_bytes())?;
+    crate::replace_secret_config(NOTIFICATION_PRIV_CONFIG_PATH, priv_cfg.as_bytes())?;
+
+    Ok(())
+}
-- 
2.39.2


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2024-04-23 11:53 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-23 11:51 [pbs-devel] [PATCH many v5 00/44] integrate notification system Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 01/44] notify: expose `config` module Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 02/44] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 03/44] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 04/44] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 05/44] notify: add getter for notification timestamp Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH widget-toolkit v5 06/44] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-23 17:35   ` [pbs-devel] applied: " Thomas Lamprecht
2024-04-23 11:51 ` Lukas Wagner [this message]
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 08/44] server: rename email_notifications module to notifications Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 09/44] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 10/44] buildsys: install templates for test notifications Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 11/44] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 12/44] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 13/44] api: add endpoints for notification matchers Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 14/44] api: add endpoints for sendmail targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 15/44] api: add endpoints for smtp targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 16/44] api: add endpoints for gotify targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 17/44] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 18/44] api-types: api: datatore: add notification-mode parameter Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 19/44] api-types: api: tape: " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 20/44] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 21/44] server: notifications: send prune " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 22/44] server: notifications: send verify " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 23/44] server: notifications: send sync " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 24/44] server: notifications: send update " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 25/44] server: notifications: send acme " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 26/44] server: notifications: send tape " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 27/44] ui: add notification config panel Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 28/44] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 29/44] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 30/44] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 31/44] ui: datastore options: " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 32/44] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 33/44] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 34/44] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 35/44] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 36/44] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 37/44] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 38/44] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 39/44] proxmox-backup-manager: add CLI for SMTP endpoints Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 40/44] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 41/44] docs: add documentation for notification system Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 42/44] ui: util: override default mail author for sendmail/smtp targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 43/44] ui: notifications: pull in UX improvements for match rules creation Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 44/44] api: notification: also list datastores if user has only Backup privs Lukas Wagner
2024-04-23 22:23 ` [pbs-devel] applied-series: [PATCH many v5 00/44] integrate notification system Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240423115230.170113-8-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal