From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 5E6E020EC7F for ; Tue, 23 Apr 2024 13:53:33 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 028A2306F7; Tue, 23 Apr 2024 13:53:38 +0200 (CEST) From: Lukas Wagner To: pbs-devel@lists.proxmox.com Date: Tue, 23 Apr 2024 13:52:08 +0200 Message-Id: <20240423115230.170113-23-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240423115230.170113-1-l.wagner@proxmox.com> References: <20240423115230.170113-1-l.wagner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.003 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 v5 22/44] server: notifications: send verify notifications via notification system X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" If the `notification-mode` parameter is set to `legacy-sendmail`, then we still use the new infrastructure, but don't consider the notification config and use a hard-coded sendmail endpoint directly. Signed-off-by: Lukas Wagner Tested-by: Gabriel Goller Reviewed-by: Gabriel Goller Tested-by: Maximiliano Sandoval --- debian/proxmox-backup-server.install | 4 + src/server/notifications.rs | 86 ++++++-------------- src/server/verify_job.rs | 11 +-- templates/Makefile | 4 + templates/default/verify-err-body.txt.hbs | 14 ++++ templates/default/verify-err-subject.txt.hbs | 1 + templates/default/verify-ok-body.txt.hbs | 10 +++ templates/default/verify-ok-subject.txt.hbs | 1 + 8 files changed, 62 insertions(+), 69 deletions(-) create mode 100644 templates/default/verify-err-body.txt.hbs create mode 100644 templates/default/verify-err-subject.txt.hbs create mode 100644 templates/default/verify-ok-body.txt.hbs create mode 100644 templates/default/verify-ok-subject.txt.hbs diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index 7b8183dd..dfe671a6 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -52,3 +52,7 @@ usr/share/proxmox-backup/templates/default/prune-ok-subject.txt.hbs usr/share/proxmox-backup/templates/default/test-body.txt.hbs usr/share/proxmox-backup/templates/default/test-body.html.hbs usr/share/proxmox-backup/templates/default/test-subject.txt.hbs +usr/share/proxmox-backup/templates/default/verify-err-body.txt.hbs +usr/share/proxmox-backup/templates/default/verify-ok-body.txt.hbs +usr/share/proxmox-backup/templates/default/verify-err-subject.txt.hbs +usr/share/proxmox-backup/templates/default/verify-ok-subject.txt.hbs diff --git a/src/server/notifications.rs b/src/server/notifications.rs index ea092c90..cbbb1ba9 100644 --- a/src/server/notifications.rs +++ b/src/server/notifications.rs @@ -23,38 +23,6 @@ use proxmox_notify::{Endpoint, Notification, Severity}; const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/notifications"); -const VERIFY_OK_TEMPLATE: &str = r###" - -Job ID: {{job.id}} -Datastore: {{job.store}} - -Verification successful. - - -Please visit the web interface for further details: - - - -"###; - -const VERIFY_ERR_TEMPLATE: &str = r###" - -Job ID: {{job.id}} -Datastore: {{job.store}} - -Verification failed on these snapshots/groups: - -{{#each errors}} - {{this~}} -{{/each}} - - -Please visit the web interface for further details: - - - -"###; - const SYNC_OK_TEMPLATE: &str = r###" Job ID: {{job.id}} @@ -189,9 +157,6 @@ lazy_static::lazy_static! { hb.set_strict_mode(true); hb.register_escape_fn(handlebars::no_escape); - hb.register_template_string("verify_ok_template", VERIFY_OK_TEMPLATE)?; - hb.register_template_string("verify_err_template", VERIFY_ERR_TEMPLATE)?; - hb.register_template_string("sync_ok_template", SYNC_OK_TEMPLATE)?; hb.register_template_string("sync_err_template", SYNC_ERR_TEMPLATE)?; @@ -417,8 +382,6 @@ pub fn send_gc_status( } pub fn send_verify_status( - email: &str, - notify: DatastoreNotify, job: VerificationJobConfig, result: &Result, Error>, ) -> Result<(), Error> { @@ -429,39 +392,45 @@ pub fn send_verify_status( "port": port, }); - let mut result_is_ok = false; - - let text = match result { - Ok(errors) if errors.is_empty() => { - result_is_ok = true; - HANDLEBARS.render("verify_ok_template", &data)? - } + let (template, severity) = match result { + Ok(errors) if errors.is_empty() => ("verify-ok", Severity::Info), Ok(errors) => { data["errors"] = json!(errors); - HANDLEBARS.render("verify_err_template", &data)? + ("verify-err", Severity::Error) } Err(_) => { - // aborted job - do not send any email + // aborted job - do not send any notification return Ok(()); } }; - match notify.verify { - None => { /* send notifications by default */ } - Some(notify) => { - if notify == Notify::Never || (result_is_ok && notify == Notify::Error) { + let metadata = HashMap::from([ + ("job-id".into(), job.id.clone()), + ("datastore".into(), job.store.clone()), + ("hostname".into(), proxmox_sys::nodename().into()), + ("type".into(), "verify".into()), + ]); + + let notification = Notification::from_template(severity, template, data, metadata); + + let (email, notify, mode) = lookup_datastore_notify_settings(&job.store); + match mode { + NotificationMode::LegacySendmail => { + let notify = notify.verify.unwrap_or(Notify::Always); + + if notify == Notify::Never || (result.is_ok() && notify == Notify::Error) { return Ok(()); } + + if let Some(email) = email { + send_sendmail_legacy_notification(notification, &email)?; + } + } + NotificationMode::NotificationSystem => { + send_notification(notification)?; } } - let subject = match result { - Ok(errors) if errors.is_empty() => format!("Verify Datastore '{}' successful", job.store), - _ => format!("Verify Datastore '{}' failed", job.store), - }; - - send_job_status_mail(email, &subject, &text)?; - Ok(()) } @@ -758,9 +727,6 @@ pub fn lookup_datastore_notify_settings( #[test] fn test_template_register() { - assert!(HANDLEBARS.has_template("verify_ok_template")); - assert!(HANDLEBARS.has_template("verify_err_template")); - assert!(HANDLEBARS.has_template("sync_ok_template")); assert!(HANDLEBARS.has_template("sync_err_template")); diff --git a/src/server/verify_job.rs b/src/server/verify_job.rs index fed80e5c..f3cf2277 100644 --- a/src/server/verify_job.rs +++ b/src/server/verify_job.rs @@ -23,9 +23,6 @@ pub fn do_verification_job( let outdated_after = verification_job.outdated_after; let ignore_verified_snapshots = verification_job.ignore_verified.unwrap_or(true); - let (email, notify, _) = - crate::server::lookup_datastore_notify_settings(&verification_job.store); - // FIXME encode namespace here for filter/ACL check? let job_id = format!("{}:{}", &verification_job.store, job.jobname()); let worker_type = job.jobtype().to_string(); @@ -79,12 +76,8 @@ pub fn do_verification_job( eprintln!("could not finish job state for {}: {}", job.jobtype(), err); } - if let Some(email) = email { - if let Err(err) = - crate::server::send_verify_status(&email, notify, verification_job, &result) - { - eprintln!("send verify notification failed: {}", err); - } + if let Err(err) = crate::server::send_verify_status(verification_job, &result) { + eprintln!("send verify notification failed: {err}"); } job_result diff --git a/templates/Makefile b/templates/Makefile index 1f556aba..f1adda9f 100644 --- a/templates/Makefile +++ b/templates/Makefile @@ -12,6 +12,10 @@ NOTIFICATION_TEMPLATES= \ default/test-body.txt.hbs \ default/test-body.html.hbs \ default/test-subject.txt.hbs \ + default/verify-err-body.txt.hbs \ + default/verify-ok-body.txt.hbs \ + default/verify-err-subject.txt.hbs \ + default/verify-ok-subject.txt.hbs \ all: diff --git a/templates/default/verify-err-body.txt.hbs b/templates/default/verify-err-body.txt.hbs new file mode 100644 index 00000000..d07b5ce0 --- /dev/null +++ b/templates/default/verify-err-body.txt.hbs @@ -0,0 +1,14 @@ + +Job ID: {{job.id}} +Datastore: {{job.store}} + +Verification failed on these snapshots/groups: + +{{#each errors}} + {{this~}} +{{/each}} + + +Please visit the web interface for further details: + + diff --git a/templates/default/verify-err-subject.txt.hbs b/templates/default/verify-err-subject.txt.hbs new file mode 100644 index 00000000..00a2d07f --- /dev/null +++ b/templates/default/verify-err-subject.txt.hbs @@ -0,0 +1 @@ +Verify Datastore '{{ job.store }}' failed diff --git a/templates/default/verify-ok-body.txt.hbs b/templates/default/verify-ok-body.txt.hbs new file mode 100644 index 00000000..7560582e --- /dev/null +++ b/templates/default/verify-ok-body.txt.hbs @@ -0,0 +1,10 @@ + +Job ID: {{job.id}} +Datastore: {{job.store}} + +Verification successful. + + +Please visit the web interface for further details: + + diff --git a/templates/default/verify-ok-subject.txt.hbs b/templates/default/verify-ok-subject.txt.hbs new file mode 100644 index 00000000..6020874c --- /dev/null +++ b/templates/default/verify-ok-subject.txt.hbs @@ -0,0 +1 @@ +Verify Datastore '{{ job.store }}' successful -- 2.39.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel