tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dcd75edb72
proxmox-backup/src/server/email_notifications.rs

355 lines
8.9 KiB
Rust
Raw Normal View History

send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
use anyhow::Error;
use serde_json::json;
use handlebars::{Handlebars, Helper, Context, RenderError, RenderContext, Output, HelperResult};
use proxmox::tools::email::sendmail;
use crate::{
config::verify::VerificationJobConfig,
send sync job status emails
2020-10-29 11:07:46 +00:00
config::sync::SyncJobConfig,
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
api2::types::{
api: apt: implement support to send notification email on new updates again, base idea copied off PVE, but, we safe the information about which pending version we send a mail out already in a separate object, to keep the api return type APTUpdateInfo clean. This also makes a few things a bit easier, as we can update the package status without saving/restoring the notify information. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:09:21 +00:00
APTUpdateInfo,
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
GarbageCollectionStatus,
api: apt: implement support to send notification email on new updates again, base idea copied off PVE, but, we safe the information about which pending version we send a mail out already in a separate object, to keep the api return type APTUpdateInfo clean. This also makes a few things a bit easier, as we can update the package status without saving/restoring the notify information. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:09:21 +00:00
Userid,
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
},
tools::format::HumanByte,
};
const GC_OK_TEMPLATE: &str = r###"
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
Datastore: {{datastore}}
Task ID: {{status.upid}}
Index file count: {{status.index-file-count}}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
Removed garbage: {{human-bytes status.removed-bytes}}
Removed chunks: {{status.removed-chunks}}
cleanup: fix wording in GC status emails
2020-10-31 06:55:30 +00:00
Removed bad chunks: {{status.removed-bad}}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
cleanup: fix wording in GC status emails
2020-10-31 06:55:30 +00:00
Leftover bad chunks: {{status.still-bad}}
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
Pending removals: {{human-bytes status.pending-bytes}} (in {{status.pending-chunks}} chunks)
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
Original Data usage: {{human-bytes status.index-data-bytes}}
cleanup: fix wording in GC status emails
2020-10-31 06:55:30 +00:00
On-Disk usage: {{human-bytes status.disk-bytes}} ({{relative-percentage status.disk-bytes status.index-data-bytes}})
On-Disk chunks: {{status.disk-chunks}}
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
Deduplication Factor: {{deduplication-factor}}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
Garbage collection successful.
"###;
const GC_ERR_TEMPLATE: &str = r###"
Datastore: {{datastore}}
Garbage collection failed: {{error}}
"###;
const VERIFY_OK_TEMPLATE: &str = r###"
Job ID: {{job.id}}
Datastore: {{job.store}}
Verification successful.
"###;
const VERIFY_ERR_TEMPLATE: &str = r###"
Job ID: {{job.id}}
Datastore: {{job.store}}
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
Verification failed on these snapshots:
{{#each errors}}
{{this}}
{{/each}}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
"###;
send sync job status emails
2020-10-29 11:07:46 +00:00
const SYNC_OK_TEMPLATE: &str = r###"
Job ID: {{job.id}}
Datastore: {{job.store}}
Remote: {{job.remote}}
Remote Store: {{job.remote-store}}
Synchronization successful.
"###;
const SYNC_ERR_TEMPLATE: &str = r###"
Job ID: {{job.id}}
Datastore: {{job.store}}
Remote: {{job.remote}}
Remote Store: {{job.remote-store}}
Synchronization failed: {{error}}
"###;
api: apt: implement support to send notification email on new updates again, base idea copied off PVE, but, we safe the information about which pending version we send a mail out already in a separate object, to keep the api return type APTUpdateInfo clean. This also makes a few things a bit easier, as we can update the package status without saving/restoring the notify information. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:09:21 +00:00
const PACKAGE_UPDATES_TEMPLATE: &str = r###"
Proxmox Backup Server has the following updates available:
{{#each updates }}
{{Package}}: {{OldVersion}} -> {{Version~}}
{{/each }}
To upgrade visit the webinderface: <https://{{fqdn}}:{{port}}/#pbsServerAdministration:updates>
"###;
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
lazy_static::lazy_static!{
static ref HANDLEBARS: Handlebars<'static> = {
let mut hb = Handlebars::new();
hb.set_strict_mode(true);
hb.register_helper("human-bytes", Box::new(handlebars_humam_bytes_helper));
hb.register_helper("relative-percentage", Box::new(handlebars_relative_percentage_helper));
hb.register_template_string("gc_ok_template", GC_OK_TEMPLATE).unwrap();
hb.register_template_string("gc_err_template", GC_ERR_TEMPLATE).unwrap();
hb.register_template_string("verify_ok_template", VERIFY_OK_TEMPLATE).unwrap();
hb.register_template_string("verify_err_template", VERIFY_ERR_TEMPLATE).unwrap();
send sync job status emails
2020-10-29 11:07:46 +00:00
hb.register_template_string("sync_ok_template", SYNC_OK_TEMPLATE).unwrap();
hb.register_template_string("sync_err_template", SYNC_ERR_TEMPLATE).unwrap();
api: apt: implement support to send notification email on new updates again, base idea copied off PVE, but, we safe the information about which pending version we send a mail out already in a separate object, to keep the api return type APTUpdateInfo clean. This also makes a few things a bit easier, as we can update the package status without saving/restoring the notify information. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:09:21 +00:00
hb.register_template_string("package_update_template", PACKAGE_UPDATES_TEMPLATE).unwrap();
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
hb
};
}
fn send_job_status_mail(
email: &str,
subject: &str,
text: &str,
) -> Result<(), Error> {
// Note: OX has serious problems displaying text mails,
// so we include html as well
send_job_status_mail: corectly escape html characters
2020-10-29 10:22:08 +00:00
let html = format!("<html><body><pre>\n{}\n<pre>", handlebars::html_escape(text));
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
let nodename = proxmox::tools::nodename();
let author = format!("Proxmox Backup Server - {}", nodename);
sendmail(
&[email],
&subject,
Some(&text),
Some(&html),
None,
Some(&author),
)?;
Ok(())
}
pub fn send_gc_status(
email: &str,
datastore: &str,
status: &GarbageCollectionStatus,
result: &Result<(), Error>,
) -> Result<(), Error> {
let text = match result {
Ok(()) => {
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
let deduplication_factor = if status.disk_bytes > 0 {
(status.index_data_bytes as f64)/(status.disk_bytes as f64)
} else {
1.0
};
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
let data = json!({
"status": status,
"datastore": datastore,
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
"deduplication-factor": format!("{:.2}", deduplication_factor),
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
});
garbage_collection: log deduplication factor
2020-10-29 09:37:43 +00:00
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
HANDLEBARS.render("gc_ok_template", &data)?
}
Err(err) => {
let data = json!({
"error": err.to_string(),
"datastore": datastore,
});
HANDLEBARS.render("gc_err_template", &data)?
}
};
let subject = match result {
Ok(()) => format!(
"Garbage Collect Datastore '{}' successful",
datastore,
),
Err(_) => format!(
"Garbage Collect Datastore '{}' failed",
datastore,
),
};
send_job_status_mail(email, &subject, &text)?;
Ok(())
}
pub fn send_verify_status(
email: &str,
job: VerificationJobConfig,
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
result: &Result<Vec<String>, Error>,
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
) -> Result<(), Error> {
let text = match result {
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
Ok(errors) if errors.is_empty() => {
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
let data = json!({ "job": job });
HANDLEBARS.render("verify_ok_template", &data)?
}
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
Ok(errors) => {
let data = json!({ "job": job, "errors": errors });
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
HANDLEBARS.render("verify_err_template", &data)?
}
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
Err(_) => {
trivial: fix typo in comment Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:29:34 +00:00
// aborted job - do not send any email
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
return Ok(());
}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
};
let subject = match result {
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
Ok(errors) if errors.is_empty() => format!(
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
"Verify Datastore '{}' successful",
job.store,
),
verify: improve code reuse, fix filter function Try to reuse verify_all_backups(), because this function has better logging and well defined snaphot order.
2020-10-28 11:58:15 +00:00
_ => format!(
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
"Verify Datastore '{}' failed",
job.store,
),
};
send_job_status_mail(email, &subject, &text)?;
Ok(())
}
send sync job status emails
2020-10-29 11:07:46 +00:00
pub fn send_sync_status(
email: &str,
job: &SyncJobConfig,
result: &Result<(), Error>,
) -> Result<(), Error> {
let text = match result {
Ok(()) => {
let data = json!({ "job": job });
HANDLEBARS.render("sync_ok_template", &data)?
}
Err(err) => {
let data = json!({ "job": job, "error": err.to_string() });
HANDLEBARS.render("sync_err_template", &data)?
}
};
let subject = match result {
Ok(()) => format!(
"Sync remote '{}' datastore '{}' successful",
job.remote,
job.remote_store,
),
Err(_) => format!(
"Sync remote '{}' datastore '{}' failed",
job.remote,
job.remote_store,
),
};
send_job_status_mail(email, &subject, &text)?;
Ok(())
}
api: apt: implement support to send notification email on new updates again, base idea copied off PVE, but, we safe the information about which pending version we send a mail out already in a separate object, to keep the api return type APTUpdateInfo clean. This also makes a few things a bit easier, as we can update the package status without saving/restoring the notify information. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-10-31 20:09:21 +00:00
pub fn send_updates_available(
updates: &Vec<&APTUpdateInfo>,
) -> Result<(), Error> {
// update mails always go to the root@pam configured email..
if let Some(email) = lookup_user_email(Userid::root_userid()) {
let nodename = proxmox::tools::nodename();
let subject = format!("New software packages available ({})", nodename);
let text = HANDLEBARS.render("package_update_template", &json!({
"fqdn": nix::sys::utsname::uname().nodename(), // FIXME: add get_fqdn helper like PVE?
"port": 8007, // user will surely request that they can change this
"updates": updates,
}))?;
send_job_status_mail(&email, &subject, &text)?;
}
Ok(())
}
send notification mails for GC and verify jobs
2020-10-27 12:36:56 +00:00
/// Lookup users email address
///
/// For "backup@pam", this returns the address from "root@pam".
pub fn lookup_user_email(userid: &Userid) -> Option<String> {
use crate::config::user::{self, User};
if userid == Userid::backup_userid() {
return lookup_user_email(Userid::root_userid());
}
if let Ok(user_config) = user::cached_config() {
if let Ok(user) = user_config.lookup::<User>("user", userid.as_str()) {
return user.email.clone();
}
}
None
}
// Handlerbar helper functions
fn handlebars_humam_bytes_helper(
h: &Helper,
_: &Handlebars,
_: &Context,
_rc: &mut RenderContext,
out: &mut dyn Output
) -> HelperResult {
let param = h.param(0).map(|v| v.value().as_u64())
.flatten()
.ok_or(RenderError::new("human-bytes: param not found"))?;
out.write(&HumanByte::from(param).to_string())?;
Ok(())
}
fn handlebars_relative_percentage_helper(
h: &Helper,
_: &Handlebars,
_: &Context,
_rc: &mut RenderContext,
out: &mut dyn Output
) -> HelperResult {
let param0 = h.param(0).map(|v| v.value().as_f64())
.flatten()
.ok_or(RenderError::new("relative-percentage: param0 not found"))?;
let param1 = h.param(1).map(|v| v.value().as_f64())
.flatten()
.ok_or(RenderError::new("relative-percentage: param1 not found"))?;
if param1 == 0.0 {
out.write("-")?;
} else {
out.write(&format!("{:.2}%", (param0*100.0)/param1))?;
}
Ok(())
}
Reference in New Issue Copy Permalink