[pbs-devel] [PATCH proxmox-backup v2 05/10] notifications: add type for prune notification template data
Lukas Wagner
l.wagner at proxmox.com
Thu Mar 27 15:55:28 CET 2025
This commit adds a separate type for the data passed to this type of
notification template. Also we make sure that we do not expose any
non-primitive types to the template renderer, any data
needed in the template is mapped into the new dedicated
template data type.
This ensures that any changes in types defined in other places
do not leak into the template rendering process by accident.
This commit also tries to unify the style and naming of template
variables.
Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
src/server/notifications/mod.rs | 50 +++++++++++++--------
src/server/notifications/template_data.rs | 28 ++++++++++++
templates/default/prune-err-body.txt.hbs | 6 +--
templates/default/prune-err-subject.txt.hbs | 2 +-
templates/default/prune-ok-body.txt.hbs | 6 +--
templates/default/prune-ok-subject.txt.hbs | 2 +-
6 files changed, 68 insertions(+), 26 deletions(-)
diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs
index ba55e2b1..e0dd92d2 100644
--- a/src/server/notifications/mod.rs
+++ b/src/server/notifications/mod.rs
@@ -25,7 +25,7 @@ mod template_data;
use template_data::{
AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData,
- PackageUpdatesTemplateData,
+ PackageUpdatesTemplateData, PruneErrTemplateData, PruneOkTemplateData,
};
/// Initialize the notification system by setting context in proxmox_notify
@@ -259,22 +259,6 @@ pub fn send_prune_status(
jobname: &str,
result: &Result<(), Error>,
) -> Result<(), Error> {
- let (fqdn, port) = get_server_url();
- let mut data = json!({
- "jobname": jobname,
- "store": store,
- "fqdn": fqdn,
- "port": port,
- });
-
- let (template, severity) = match result {
- Ok(()) => ("prune-ok", Severity::Info),
- Err(err) => {
- data["error"] = err.to_string().into();
- ("prune-err", Severity::Error)
- }
- };
-
let metadata = HashMap::from([
("job-id".into(), jobname.to_string()),
("datastore".into(), store.into()),
@@ -282,7 +266,37 @@ pub fn send_prune_status(
("type".into(), "prune".into()),
]);
- let notification = Notification::from_template(severity, template, data, metadata);
+ let notification = match result {
+ Ok(()) => {
+ let template_data = PruneOkTemplateData {
+ common: CommonData::new(),
+ datastore: store.to_string(),
+ job_id: jobname.to_string(),
+ };
+
+ Notification::from_template(
+ Severity::Info,
+ "prune-ok",
+ serde_json::to_value(template_data)?,
+ metadata,
+ )
+ }
+ Err(err) => {
+ let template_data = PruneErrTemplateData {
+ common: CommonData::new(),
+ datastore: store.to_string(),
+ job_id: jobname.to_string(),
+ error: format!("{err:#}"),
+ };
+
+ Notification::from_template(
+ Severity::Error,
+ "prune-err",
+ serde_json::to_value(template_data)?,
+ metadata,
+ )
+ }
+ };
let (email, notify, mode) = lookup_datastore_notify_settings(store);
match mode {
diff --git a/src/server/notifications/template_data.rs b/src/server/notifications/template_data.rs
index 60f4eba2..32c8ce17 100644
--- a/src/server/notifications/template_data.rs
+++ b/src/server/notifications/template_data.rs
@@ -180,3 +180,31 @@ impl PackageUpdatesTemplateData {
}
}
}
+
+/// Template data for the prune-ok template.
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct PruneOkTemplateData {
+ /// Common properties.
+ #[serde(flatten)]
+ pub common: CommonData,
+ /// The datastore.
+ pub datastore: String,
+ /// The ID of the job.
+ pub job_id: String,
+}
+
+/// Template data for the prune-err template.
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct PruneErrTemplateData {
+ /// Common properties.
+ #[serde(flatten)]
+ pub common: CommonData,
+ /// The datastore.
+ pub datastore: String,
+ /// The ID of the job.
+ pub job_id: String,
+ /// The error that occured during the prune job.
+ pub error: String,
+}
diff --git a/templates/default/prune-err-body.txt.hbs b/templates/default/prune-err-body.txt.hbs
index 0973c3d9..4ea8d7a9 100644
--- a/templates/default/prune-err-body.txt.hbs
+++ b/templates/default/prune-err-body.txt.hbs
@@ -1,10 +1,10 @@
-Job ID: {{jobname}}
-Datastore: {{store}}
+Job ID: {{job-id}}
+Datastore: {{datastore}}
Pruning failed: {{error}}
Please visit the web interface for further details:
-<https://{{fqdn}}:{{port}}/#pbsServerAdministration:tasks>
+<{{base-url}}/#pbsServerAdministration:tasks>
diff --git a/templates/default/prune-err-subject.txt.hbs b/templates/default/prune-err-subject.txt.hbs
index 836ae722..6af35ea0 100644
--- a/templates/default/prune-err-subject.txt.hbs
+++ b/templates/default/prune-err-subject.txt.hbs
@@ -1 +1 @@
-Pruning datastore '{{ store }}' failed
+Pruning datastore '{{datastore}}' failed
diff --git a/templates/default/prune-ok-body.txt.hbs b/templates/default/prune-ok-body.txt.hbs
index b7e449e3..9e119c0e 100644
--- a/templates/default/prune-ok-body.txt.hbs
+++ b/templates/default/prune-ok-body.txt.hbs
@@ -1,10 +1,10 @@
-Job ID: {{jobname}}
-Datastore: {{store}}
+Job ID: {{job-id}}
+Datastore: {{datastore}}
Pruning successful.
Please visit the web interface for further details:
-<https://{{fqdn}}:{{port}}/#DataStore-{{store}}>
+<{{base-url}}/#DataStore-{{datastore}}>
diff --git a/templates/default/prune-ok-subject.txt.hbs b/templates/default/prune-ok-subject.txt.hbs
index 3227a062..25a854ad 100644
--- a/templates/default/prune-ok-subject.txt.hbs
+++ b/templates/default/prune-ok-subject.txt.hbs
@@ -1 +1 @@
-Pruning datastore '{{ store }}' successful
+Pruning datastore '{{datastore}}' successful
--
2.39.5
More information about the pbs-devel
mailing list