From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 3D35369841 for ; Wed, 24 Feb 2021 19:31:30 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3B09C2CF48 for ; Wed, 24 Feb 2021 19:31:30 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 123742CEE4 for ; Wed, 24 Feb 2021 19:31:27 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id C0AD2462EE for ; Wed, 24 Feb 2021 19:31:26 +0100 (CET) From: Stoiko Ivanov To: pmg-devel@lists.proxmox.com Date: Wed, 24 Feb 2021 19:31:00 +0100 Message-Id: <20210224183109.29014-4-s.ivanov@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210224183109.29014-1-s.ivanov@proxmox.com> References: <20210224183109.29014-1-s.ivanov@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.308 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [conf.in, backup.pm, backup-notification.tt, job.pm, pbsconfig.pm] URIBL_SBL 0.644 Contains an URL's NS IP listed in the Spamhaus SBL blocklist [backup.pm] URIBL_SBL_A 0.1 Contains URL's A record listed in the Spamhaus SBL blocklist [backup.pm] Subject: [pmg-devel] [PATCH pmg-api 3/5] backup: fix #3146 add email notifications X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 24 Feb 2021 18:31:30 -0000 this patch addresses the missing email notification for scheduled backup related tasks, which we have in all our other products, for our mail product. the parameter names are inspired by PBS' datastore config. it uses the templateing system for the notification, because this results in less code and a bit of added flexibility for the users. the recipient address is currently hardcoded to the admin address in pmg.conf as we also send the (admin) pmgreport there, and I did not want to overengineer this (even more). Signed-off-by: Stoiko Ivanov --- src/Makefile | 3 ++- src/PMG/API2/PBS/Job.pm | 40 +++++++++++++++++++++------- src/PMG/Backup.pm | 31 +++++++++++++++++++++ src/PMG/PBSConfig.pm | 7 +++++ src/templates/backup-notification.tt | 19 +++++++++++++ 5 files changed, 89 insertions(+), 11 deletions(-) create mode 100644 src/templates/backup-notification.tt diff --git a/src/Makefile b/src/Makefile index 9d5c335..0ad805d 100644 --- a/src/Makefile +++ b/src/Makefile @@ -42,7 +42,8 @@ TEMPLATES = \ freshclam.conf.in \ clamd.conf.in \ postgresql.conf.in \ - pg_hba.conf.in + pg_hba.conf.in \ + backup-notification.tt TEMPLATES_FILES = $(addprefix templates/, ${TEMPLATES}) diff --git a/src/PMG/API2/PBS/Job.pm b/src/PMG/API2/PBS/Job.pm index 2387422..279afbc 100644 --- a/src/PMG/API2/PBS/Job.pm +++ b/src/PMG/API2/PBS/Job.pm @@ -273,6 +273,13 @@ __PACKAGE__->register_method ({ optional => 1, default => 1, }, + notify => { + description => "Specify when to notify via e-mail", + type => 'string', + enum => [ 'always', 'error', 'never' ], + optional => 1, + default => 'error', + }, }, }, returns => { type => "string" }, @@ -292,6 +299,7 @@ __PACKAGE__->register_method ({ die "PBS remote '$remote' is disabled\n" if $remote_config->{disable}; $param->{statistic} //= $remote_config->{'include-statistics'} // 1; + my $notify = $param->{notify} // $remote_config->{notify} // 'never'; my $pbs = PVE::PBSClient->new($remote_config, $remote, $conf->{secret_dir}); my $backup_dir = "/var/lib/pmg/backup/current"; @@ -299,30 +307,42 @@ __PACKAGE__->register_method ({ my $worker = sub { my $upid = shift; - print "starting update of current backup state\n"; + my $log = "starting update of current backup state\n"; - -d $backup_dir || mkdir $backup_dir; - PMG::Backup::pmg_backup($backup_dir, $param->{statistic}); + eval { + -d $backup_dir || mkdir $backup_dir; + PMG::Backup::pmg_backup($backup_dir, $param->{statistic}); - $pbs->backup_fs_tree($backup_dir, $node, 'pmgbackup'); + $pbs->backup_fs_tree($backup_dir, $node, 'pmgbackup'); - rmtree $backup_dir; + rmtree $backup_dir; + }; + my $err = $@; + $log .= $err if $err; - print "backup finished\n"; + $log .= "backup finished\n"; my $group = "host/$node"; if (defined(my $prune_opts = $conf->prune_options($remote))) { - print "starting prune of $group\n"; - my $res = $pbs->prune_group(undef, $prune_opts, $group); + $log .= "starting prune of $group\n"; + my $res = eval { $pbs->prune_group(undef, $prune_opts, $group) }; + $log .= $@ if $@; + $err //= $@ if $@; foreach my $pruned (@$res){ my $time = strftime("%FT%TZ", gmtime($pruned->{'backup-time'})); my $snap = $pruned->{'backup-type'} . '/' . $pruned->{'backup-id'} . '/' . $time; - print "pruned snapshot: $snap\n"; + $log .= "pruned snapshot: $snap\n"; } - print "prune finished\n"; + $log .= "prune finished\n"; } + PMG::Backup::send_backup_notification($notify, $remote, $log, $err); + + die "$err\n" if $err; + + print $log; + return; }; diff --git a/src/PMG/Backup.pm b/src/PMG/Backup.pm index 303bbb4..1883d02 100644 --- a/src/PMG/Backup.pm +++ b/src/PMG/Backup.pm @@ -5,6 +5,7 @@ use warnings; use Data::Dumper; use File::Basename; use File::Path; +use POSIX qw(strftime); use PVE::JSONSchema qw(get_standard_option); use PVE::Tools; @@ -376,4 +377,34 @@ sub pmg_restore { die $err if $err; } +sub send_backup_notification { + my ($when, $target, $log, $err) = @_; + + return if $when eq 'never'; + return if ($when eq 'error' && !$err); + + my $cfg = PMG::Config->new(); + my $email = $cfg->get ('admin', 'email'); + die "no admin email configured\n" if !$email; + + my $nodename = PVE::INotify::nodename(); + my $fqdn = PVE::Tools::get_fqdn($nodename); + + + my $vars = { + hostname => $nodename, + fqdn => $fqdn, + date => strftime("%F", localtime()), + target => $target, + log => $log, + err => $err, + }; + + my $tt = PMG::Config::get_template_toolkit(); + + my $mailfrom = "Proxmox Mail Gateway "; + PMG::Utils::finalize_report($tt, 'backup-notification.tt', $vars, $mailfrom, $email); + +} + 1; diff --git a/src/PMG/PBSConfig.pm b/src/PMG/PBSConfig.pm index 29cff22..965d162 100644 --- a/src/PMG/PBSConfig.pm +++ b/src/PMG/PBSConfig.pm @@ -90,6 +90,12 @@ sub properties { description => "Username or API token ID on the Proxmox Backup Server" }), fingerprint => get_standard_option('fingerprint-sha256'), + notify => { + description => "Specify when to notify via e-mail", + type => 'string', + enum => [ 'always', 'error', 'never' ], + optional => 1, + }, 'include-statistics' => { description => "Include statistics in scheduled backups", type => 'boolean', @@ -107,6 +113,7 @@ sub options { username => { optional => 1 }, password => { optional => 1 }, fingerprint => { optional => 1 }, + notify => { optional => 1 }, 'include-statistics' => { optional => 1 }, 'keep-last' => { optional => 1 }, 'keep-hourly' => { optional => 1 }, diff --git a/src/templates/backup-notification.tt b/src/templates/backup-notification.tt new file mode 100644 index 0000000..3f956b0 --- /dev/null +++ b/src/templates/backup-notification.tt @@ -0,0 +1,19 @@ +[%- IF err -%] +[%- SET titleprefix = "Backup failed" -%] +[%- ELSE %] +[%- SET titleprefix = "Backup successful" -%] +[%- END -%] +[%- IF target -%] +[%- SET titlesuffix = "to ${target} - ($fqdn)" -%] +[%- ELSE %] +[%- SET titlesuffix = "($fqdn)" -%] +[%- END -%] + + + [% titleprefix %] [% titlesuffix %] + + + Detailed backup logs:

+ 
[% log %]
+ + -- 2.20.1