From 5b23a707071d75d86399719455315503948a9a7f Mon Sep 17 00:00:00 2001 From: Lukas Wagner Date: Tue, 23 Apr 2024 13:52:09 +0200 Subject: [PATCH] server: notifications: send sync notifications via notification system 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 Signed-off-by: Thomas Lamprecht --- debian/proxmox-backup-server.install | 4 + src/api2/pull.rs | 10 +- src/server/notifications.rs | 102 ++++++--------------- templates/Makefile | 4 + templates/default/sync-err-body.txt.hbs | 14 +++ templates/default/sync-err-subject.txt.hbs | 5 + templates/default/sync-ok-body.txt.hbs | 14 +++ templates/default/sync-ok-subject.txt.hbs | 5 + 8 files changed, 76 insertions(+), 82 deletions(-) create mode 100644 templates/default/sync-err-body.txt.hbs create mode 100644 templates/default/sync-err-subject.txt.hbs create mode 100644 templates/default/sync-ok-body.txt.hbs create mode 100644 templates/default/sync-ok-subject.txt.hbs diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index dfe671a6..86e2b543 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -49,6 +49,10 @@ usr/share/proxmox-backup/templates/default/prune-err-body.txt.hbs usr/share/proxmox-backup/templates/default/prune-ok-body.txt.hbs usr/share/proxmox-backup/templates/default/prune-err-subject.txt.hbs usr/share/proxmox-backup/templates/default/prune-ok-subject.txt.hbs +usr/share/proxmox-backup/templates/default/sync-err-body.txt.hbs +usr/share/proxmox-backup/templates/default/sync-ok-body.txt.hbs +usr/share/proxmox-backup/templates/default/sync-err-subject.txt.hbs +usr/share/proxmox-backup/templates/default/sync-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 diff --git a/src/api2/pull.rs b/src/api2/pull.rs index 7fe2267a..5d02510c 100644 --- a/src/api2/pull.rs +++ b/src/api2/pull.rs @@ -114,8 +114,6 @@ pub fn do_sync_job( bail!("can't sync to same datastore"); } - let (email, notify, _) = crate::server::lookup_datastore_notify_settings(&sync_job.store); - let upid_str = WorkerTask::spawn( &worker_type, Some(job_id.clone()), @@ -194,12 +192,8 @@ pub fn do_sync_job( } } - if let Some(email) = email { - if let Err(err) = - crate::server::send_sync_status(&email, notify, &sync_job2, &result) - { - eprintln!("send sync notification failed: {}", err); - } + if let Err(err) = crate::server::send_sync_status(&sync_job2, &result) { + eprintln!("send sync notification failed: {err}"); } result diff --git a/src/server/notifications.rs b/src/server/notifications.rs index cbbb1ba9..5f854e4c 100644 --- a/src/server/notifications.rs +++ b/src/server/notifications.rs @@ -23,44 +23,6 @@ use proxmox_notify::{Endpoint, Notification, Severity}; const SPOOL_DIR: &str = concatcp!(pbs_buildcfg::PROXMOX_BACKUP_STATE_DIR, "/notifications"); -const SYNC_OK_TEMPLATE: &str = r###" - -Job ID: {{job.id}} -Datastore: {{job.store}} -{{#if job.remote~}} -Remote: {{job.remote}} -Remote Store: {{job.remote-store}} -{{else~}} -Local Source Store: {{job.remote-store}} -{{/if}} -Synchronization successful. - - -Please visit the web interface for further details: - - - -"###; - -const SYNC_ERR_TEMPLATE: &str = r###" - -Job ID: {{job.id}} -Datastore: {{job.store}} -{{#if job.remote~}} -Remote: {{job.remote}} -Remote Store: {{job.remote-store}} -{{else~}} -Local Source Store: {{job.remote-store}} -{{/if}} -Synchronization failed: {{error}} - - -Please visit the web interface for further details: - - - -"###; - const PACKAGE_UPDATES_TEMPLATE: &str = r###" Proxmox Backup Server has the following updates available: {{#each updates }} @@ -157,9 +119,6 @@ lazy_static::lazy_static! { hb.set_strict_mode(true); hb.register_escape_fn(handlebars::no_escape); - hb.register_template_string("sync_ok_template", SYNC_OK_TEMPLATE)?; - hb.register_template_string("sync_err_template", SYNC_ERR_TEMPLATE)?; - hb.register_template_string("tape_backup_ok_template", TAPE_BACKUP_OK_TEMPLATE)?; hb.register_template_string("tape_backup_err_template", TAPE_BACKUP_ERR_TEMPLATE)?; @@ -485,21 +444,7 @@ pub fn send_prune_status( Ok(()) } -pub fn send_sync_status( - email: &str, - notify: DatastoreNotify, - job: &SyncJobConfig, - result: &Result<(), Error>, -) -> Result<(), Error> { - match notify.sync { - None => { /* send notifications by default */ } - Some(notify) => { - if notify == Notify::Never || (result.is_ok() && notify == Notify::Error) { - return Ok(()); - } - } - } - +pub fn send_sync_status(job: &SyncJobConfig, result: &Result<(), Error>) -> Result<(), Error> { let (fqdn, port) = get_server_url(); let mut data = json!({ "job": job, @@ -507,28 +452,40 @@ pub fn send_sync_status( "port": port, }); - let text = match result { - Ok(()) => HANDLEBARS.render("sync_ok_template", &data)?, + let (template, severity) = match result { + Ok(()) => ("sync-ok", Severity::Info), Err(err) => { data["error"] = err.to_string().into(); - HANDLEBARS.render("sync_err_template", &data)? + ("sync-err", Severity::Error) } }; - let tmp_src_string; - let source_str = if let Some(remote) = &job.remote { - tmp_src_string = format!("Sync remote '{}'", remote); - &tmp_src_string - } else { - "Sync local" - }; + let metadata = HashMap::from([ + ("job-id".into(), job.id.clone()), + ("datastore".into(), job.store.clone()), + ("hostname".into(), proxmox_sys::nodename().into()), + ("type".into(), "sync".into()), + ]); - let subject = match result { - Ok(()) => format!("{} datastore '{}' successful", source_str, job.remote_store,), - Err(_) => format!("{} datastore '{}' failed", source_str, job.remote_store,), - }; + let notification = Notification::from_template(severity, template, data, metadata); - send_job_status_mail(email, &subject, &text)?; + let (email, notify, mode) = lookup_datastore_notify_settings(&job.store); + match mode { + NotificationMode::LegacySendmail => { + let notify = notify.prune.unwrap_or(Notify::Error); + + 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)?; + } + } Ok(()) } @@ -727,9 +684,6 @@ pub fn lookup_datastore_notify_settings( #[test] fn test_template_register() { - assert!(HANDLEBARS.has_template("sync_ok_template")); - assert!(HANDLEBARS.has_template("sync_err_template")); - assert!(HANDLEBARS.has_template("tape_backup_ok_template")); assert!(HANDLEBARS.has_template("tape_backup_err_template")); diff --git a/templates/Makefile b/templates/Makefile index f1adda9f..41cdd2da 100644 --- a/templates/Makefile +++ b/templates/Makefile @@ -9,6 +9,10 @@ NOTIFICATION_TEMPLATES= \ default/prune-ok-body.txt.hbs \ default/prune-err-subject.txt.hbs \ default/prune-ok-subject.txt.hbs \ + default/sync-err-body.txt.hbs \ + default/sync-ok-body.txt.hbs \ + default/sync-err-subject.txt.hbs \ + default/sync-ok-subject.txt.hbs \ default/test-body.txt.hbs \ default/test-body.html.hbs \ default/test-subject.txt.hbs \ diff --git a/templates/default/sync-err-body.txt.hbs b/templates/default/sync-err-body.txt.hbs new file mode 100644 index 00000000..a56d9d22 --- /dev/null +++ b/templates/default/sync-err-body.txt.hbs @@ -0,0 +1,14 @@ +Job ID: {{job.id}} +Datastore: {{job.store}} +{{#if job.remote~}} +Remote: {{job.remote}} +Remote Store: {{job.remote-store}} +{{else~}} +Local Source Store: {{job.remote-store}} +{{/if}} +Synchronization failed: {{error}} + + +Please visit the web interface for further details: + + diff --git a/templates/default/sync-err-subject.txt.hbs b/templates/default/sync-err-subject.txt.hbs new file mode 100644 index 00000000..a1464802 --- /dev/null +++ b/templates/default/sync-err-subject.txt.hbs @@ -0,0 +1,5 @@ +{{#if job.remote~}} +Sync remote '{{ job.remote }}' datastore '{{ job.remote-store }}' failed +{{else~}} +Sync local datastore '{{ job.remote-store }}' failed +{{/if}} diff --git a/templates/default/sync-ok-body.txt.hbs b/templates/default/sync-ok-body.txt.hbs new file mode 100644 index 00000000..25c4b33b --- /dev/null +++ b/templates/default/sync-ok-body.txt.hbs @@ -0,0 +1,14 @@ +Job ID: {{job.id}} +Datastore: {{job.store}} +{{#if job.remote~}} +Remote: {{job.remote}} +Remote Store: {{job.remote-store}} +{{else~}} +Local Source Store: {{job.remote-store}} +{{/if}} +Synchronization successful. + + +Please visit the web interface for further details: + + diff --git a/templates/default/sync-ok-subject.txt.hbs b/templates/default/sync-ok-subject.txt.hbs new file mode 100644 index 00000000..76616b5c --- /dev/null +++ b/templates/default/sync-ok-subject.txt.hbs @@ -0,0 +1,5 @@ +{{#if job.remote~}} +Sync remote '{{ job.remote }}' datastore '{{ job.remote-store }}' successful +{{else~}} +Sync local datastore '{{ job.remote-store }}' successful +{{/if}}