From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 5E9CE1FF165
for <inbox@lore.proxmox.com>; Thu, 27 Mar 2025 15:55:49 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id ADA32FD6B;
Thu, 27 Mar 2025 15:55:42 +0100 (CET)
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Thu, 27 Mar 2025 15:55:27 +0100
Message-Id: <20250327145533.274348-5-l.wagner@proxmox.com>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250327145533.274348-1-l.wagner@proxmox.com>
References: <20250327145533.274348-1-l.wagner@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.012 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: [pbs-devel] [PATCH proxmox-backup v2 04/10] notifications: add type
for APT notification template data
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>
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@proxmox.com>
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
src/server/notifications/mod.rs | 23 ++++++-----
src/server/notifications/template_data.rs | 41 ++++++++++++++++++-
.../default/package-updates-body.txt.hbs | 8 ++--
.../default/package-updates-subject.txt.hbs | 2 +-
4 files changed, 57 insertions(+), 17 deletions(-)
diff --git a/src/server/notifications/mod.rs b/src/server/notifications/mod.rs
index a2730d71..ba55e2b1 100644
--- a/src/server/notifications/mod.rs
+++ b/src/server/notifications/mod.rs
@@ -23,7 +23,10 @@ const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/noti
mod template_data;
-use template_data::{AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData};
+use template_data::{
+ AcmeErrTemplateData, CommonData, GcErrTemplateData, GcOkTemplateData,
+ PackageUpdatesTemplateData,
+};
/// Initialize the notification system by setting context in proxmox_notify
pub fn init() -> Result<(), Error> {
@@ -464,23 +467,21 @@ fn get_server_url() -> (String, usize) {
}
pub fn send_updates_available(updates: &[&APTUpdateInfo]) -> Result<(), Error> {
- let (fqdn, port) = get_server_url();
let hostname = proxmox_sys::nodename().to_string();
- let data = json!({
- "fqdn": fqdn,
- "hostname": &hostname,
- "port": port,
- "updates": updates,
- });
-
let metadata = HashMap::from([
("hostname".into(), hostname),
("type".into(), "package-updates".into()),
]);
- let notification =
- Notification::from_template(Severity::Info, "package-updates", data, metadata);
+ let template_data = PackageUpdatesTemplateData::new(updates);
+
+ let notification = Notification::from_template(
+ Severity::Info,
+ "package-updates",
+ serde_json::to_value(template_data)?,
+ metadata,
+ );
send_notification(notification)?;
Ok(())
diff --git a/src/server/notifications/template_data.rs b/src/server/notifications/template_data.rs
index c3e31367..60f4eba2 100644
--- a/src/server/notifications/template_data.rs
+++ b/src/server/notifications/template_data.rs
@@ -1,4 +1,4 @@
-use pbs_api_types::GarbageCollectionStatus;
+use pbs_api_types::{APTUpdateInfo, GarbageCollectionStatus};
use serde::Serialize;
// NOTE: For some of these types, the `XyzOkTemplateData` and `XyzErrTemplateData`
@@ -141,3 +141,42 @@ pub struct AcmeErrTemplateData {
/// The error that occured when trying to request the certificate.
pub error: String,
}
+
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+/// A single package which can be upgraded.
+pub struct UpgradablePackage {
+ /// The name of the package.
+ package_name: String,
+ /// The new version which can be installed.
+ available_version: String,
+ /// The currently installed version.
+ installed_version: String,
+}
+
+/// Template data for the package-updates template.
+#[derive(Serialize)]
+#[serde(rename_all = "kebab-case")]
+pub struct PackageUpdatesTemplateData {
+ /// Common properties.
+ #[serde(flatten)]
+ pub common: CommonData,
+ pub available_updates: Vec<UpgradablePackage>,
+}
+
+impl PackageUpdatesTemplateData {
+ /// Create new a new instance.
+ pub fn new(updates: &[&APTUpdateInfo]) -> Self {
+ Self {
+ common: CommonData::new(),
+ available_updates: updates
+ .iter()
+ .map(|info| UpgradablePackage {
+ package_name: info.package.clone(),
+ available_version: info.version.clone(),
+ installed_version: info.old_version.clone(),
+ })
+ .collect(),
+ }
+ }
+}
diff --git a/templates/default/package-updates-body.txt.hbs b/templates/default/package-updates-body.txt.hbs
index 62f9c7c4..cf69ae69 100644
--- a/templates/default/package-updates-body.txt.hbs
+++ b/templates/default/package-updates-body.txt.hbs
@@ -1,8 +1,8 @@
Proxmox Backup Server has the following updates available:
-{{#each updates }}
- {{Package}}: {{OldVersion}} -> {{Version~}}
-{{/each }}
+{{#each available-updates}}
+ {{this.package-name}}: {{this.installed-version}} -> {{this.available-version~}}
+{{/each}}
To upgrade visit the web interface:
-<https://{{fqdn}}:{{port}}/#pbsServerAdministration:updates>
+<{{base-url}}/#pbsServerAdministration:updates>
diff --git a/templates/default/package-updates-subject.txt.hbs b/templates/default/package-updates-subject.txt.hbs
index c8a775d5..556a67b8 100644
--- a/templates/default/package-updates-subject.txt.hbs
+++ b/templates/default/package-updates-subject.txt.hbs
@@ -1 +1 @@
-New software packages available ({{ hostname }})
+New software packages available ({{hostname}})
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel