all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Wolfgang Bumiller <w.bumiller@proxmox.com>
To: Lukas Wagner <l.wagner@proxmox.com>
Cc: pve-devel@lists.proxmox.com
Subject: Re: [pve-devel] [PATCH v3 pve-cluster 36/66] add libpve-notify-perl package
Date: Wed, 19 Jul 2023 14:27:39 +0200	[thread overview]
Message-ID: <lmx4xz2pr3ava67tndtoxgtnnhtykofjnftukfvl2omh3mbv6s@t2z5azlxy5wu> (raw)
In-Reply-To: <20230717150051.710464-37-l.wagner@proxmox.com>

On Mon, Jul 17, 2023 at 05:00:21PM +0200, Lukas Wagner wrote:
> The package contains the  PVE::Notify. It is a very thin wrapper
> around the Proxmox::RS::Notify module, feeding the configuration
> from the new 'notifications.cfg' and 'priv/notifications.cfg' files
> into it.
> 
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
>  debian/control                    |   9 ++
>  debian/libpve-notify-perl.docs    |   1 +
>  debian/libpve-notify-perl.install |   1 +
>  src/PVE/Makefile                  |   2 +-
>  src/PVE/Notify.pm                 | 145 ++++++++++++++++++++++++++++++
>  5 files changed, 157 insertions(+), 1 deletion(-)
>  create mode 100644 debian/libpve-notify-perl.docs
>  create mode 100644 debian/libpve-notify-perl.install
>  create mode 100644 src/PVE/Notify.pm
> 
> diff --git a/debian/control b/debian/control
> index f1c13cb..77d7f8b 100644
> --- a/debian/control
> +++ b/debian/control
> @@ -85,3 +85,12 @@ Breaks: pve-cluster (<= 6.0-7),
>  Replaces: pve-cluster (<= 6.0-7),
>  Description: Proxmox Virtual Environment cluster Perl API modules.
>   This package contains the API2 endpoints and CLI binary 'pvecm'.
> +
> +Package: libpve-notify-perl
> +Architecture: all
> +Pre-Depends: ${misc:Pre-Depends},
> +Depends: libpve-cluster-perl (= ${binary:Version}),
> +         libpve-rs-perl (>= 0.7.1),
> +         ${misc:Depends},
> +         ${perl:Depends},
> +Description: Notify helper module
> diff --git a/debian/libpve-notify-perl.docs b/debian/libpve-notify-perl.docs
> new file mode 100644
> index 0000000..8696672
> --- /dev/null
> +++ b/debian/libpve-notify-perl.docs
> @@ -0,0 +1 @@
> +debian/SOURCE
> diff --git a/debian/libpve-notify-perl.install b/debian/libpve-notify-perl.install
> new file mode 100644
> index 0000000..b590d07
> --- /dev/null
> +++ b/debian/libpve-notify-perl.install
> @@ -0,0 +1 @@
> +usr/share/perl5/PVE/Notify.pm
> diff --git a/src/PVE/Makefile b/src/PVE/Makefile
> index 10291a6..ac4a9ce 100644
> --- a/src/PVE/Makefile
> +++ b/src/PVE/Makefile
> @@ -11,7 +11,7 @@ PVE_VENDORARCH=$(DESTDIR)/$(PERL_VENDORARCH)/auto/PVE/IPCC
>  PERL_DOC_INC_DIRS:=..
>  
>  SUBDIRS=Cluster CLI API2
> -SOURCES=IPCC.pm Cluster.pm Corosync.pm RRD.pm DataCenterConfig.pm SSHInfo.pm
> +SOURCES=IPCC.pm Cluster.pm Corosync.pm RRD.pm DataCenterConfig.pm Notify.pm SSHInfo.pm
>  
>  all:
>  
> diff --git a/src/PVE/Notify.pm b/src/PVE/Notify.pm
> new file mode 100644
> index 0000000..a3bcfbb
> --- /dev/null
> +++ b/src/PVE/Notify.pm
> @@ -0,0 +1,145 @@
> +package PVE::Notify;
> +
> +use strict;
> +use warnings;
> +
> +use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_lock_file cfs_write_file);
> +use PVE::RS::Notify;
> +
> +cfs_register_file(
> +    'notifications.cfg',
> +    \&parse_notification_config,
> +    \&write_notification_config,
> +);
> +
> +cfs_register_file(
> +    'priv/notifications.cfg',
> +    \&parse_notification_config,
> +    \&write_notification_config,
> +);
> +
> +my $mail_to_root_target = 'mail-to-root';
> +
> +sub parse_notification_config {
> +    my ($filename, $raw) = @_;
> +
> +    $raw = '' if !defined($raw);
> +    return $raw;
> +}
> +
> +sub write_notification_config {
> +    my ($filename, $config) = @_;
> +    return $config;
> +}
> +
> +sub lock_config {
> +    my ($code, $timeout) = @_;
> +
> +    cfs_lock_file('notifications.cfg', $timeout, sub {
> +	cfs_lock_file('priv/notifications.cfg', $timeout, $code);
> +	die $@ if $@;
> +    });
> +    die $@ if $@;
> +}
> +
> +sub read_config {
> +    my $config = cfs_read_file('notifications.cfg');
> +    my $priv_config = cfs_read_file('priv/notifications.cfg');
> +
> +    my $notification_config = PVE::RS::Notify->parse_config($config, $priv_config);
> +
> +    eval {
> +	# This target should always be available...
> +	$notification_config->add_sendmail_endpoint(
> +	    $mail_to_root_target,
> +	    undef,
> +	    ['root@pam'],
> +	    undef,
> +	    undef,
> +	    'Send mail to root@pam\'s email address'
> +	);
> +    };
> +
> +    return $notification_config;
> +}
> +
> +sub write_config {
> +    my ($notification_config) = @_;
> +
> +    eval {
> +	# ... but don't persist it to the config.
> +	# Rationale: If it is in the config, the user might think
> +	# that it can be changed by editing the configuration there.
> +	# However, since we always add it in `read_config`, any changes
> +	# will be implicitly overridden by the default.
> +
> +	# If users want's to change the configuration, they are supposed to
> +	# create a new sendmail endpoint.
> +	$notification_config->delete_sendmail_endpoint($mail_to_root_target);
> +    };
> +
> +    my ($config, $priv_config) = $notification_config->write_config();
> +    cfs_write_file('notifications.cfg', $config);
> +    cfs_write_file('priv/notifications.cfg', $priv_config);
> +}
> +
> +sub default_target {
> +    return $mail_to_root_target;
> +}
> +
> +sub notify {
> +    my ($target, $severity, $title, $message, $properties, $config) = @_;
> +    _send_notification($target, $severity, $title, $message, $properties, $config);
> +}
> +
> +sub info {
> +    my ($target, $title, $message, $properties, $config) = @_;
> +    _send_notification($target, 'info', $title, $message, $properties, $config);
> +}
> +
> +sub notice {
> +    my ($target, $title, $message, $properties, $config) = @_;
> +    _send_notification($target, 'notice', $title, $message, $properties, $config);
> +}
> +
> +sub warning {
> +    my ($target, $title, $message, $properties, $config) = @_;
> +    _send_notification($target, 'warning', $title, $message, $properties, $config);
> +}
> +
> +sub error {
> +    my ($target, $title, $message, $properties, $config) = @_;
> +    _send_notification($target, 'error', $title, $message, $properties, $config);
> +}
> +
> +sub _send_notification {

^ do we need this accessible to the outside? If not, you could move it
above its users and turn it into a `my sub`.

> +    my ($target, $severity, $title, $message, $properties, $config) = @_;
> +    $config = read_config() if !defined($config);
> +    my ($module, $file, $line) = caller(1);
> +
> +    # Augment properties with the source code location of the notify call
> +    my $props_with_source = {
> +	%$properties,
> +	source => {
> +	    module => $module,
> +	    file => $file,
> +	    line => $line,
> +	}
> +    };
> +
> +    $config->send($target, $severity, $title, $message, $props_with_source);
> +}
> +
> +sub check_may_use_target {
> +    my ($target, $rpcenv) = @_;
> +    my $user = $rpcenv->get_user();
> +
> +    my $config = read_config();
> +    my $entities = $config->get_referenced_entities($target);
> +
> +    for my $entity (@$entities) {
> +	$rpcenv->check($user, "/mapping/notification/$entity", [ 'Mapping.Use' ]);
> +    }
> +}
> +
> +1;
> \ No newline at end of file

^ your editor has some kind of disease ;-)




  reply	other threads:[~2023-07-19 12:27 UTC|newest]

Thread overview: 114+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-17 14:59 [pve-devel] [PATCH v3 many 00/66] fix #4156: introduce new notification system Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 01/66] add proxmox-notify crate Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 02/66] notify: preparation for the first endpoint plugin Lukas Wagner
2023-07-17 15:48   ` Maximiliano Sandoval
2023-07-18  7:19     ` Lukas Wagner
2023-07-18 10:13       ` Wolfgang Bumiller
2023-07-18 11:54   ` Wolfgang Bumiller
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 03/66] notify: preparation for the API Lukas Wagner
2023-07-18 12:02   ` Wolfgang Bumiller
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 04/66] notify: api: add API for sending notifications/testing endpoints Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 05/66] notify: add sendmail plugin Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 06/66] notify: api: add API for sendmail endpoints Lukas Wagner
2023-07-18 12:36   ` Wolfgang Bumiller
2023-07-19 11:51     ` Lukas Wagner
2023-07-19 12:09       ` Wolfgang Bumiller
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 07/66] notify: add gotify endpoint Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 08/66] notify: api: add API for gotify endpoints Lukas Wagner
2023-07-18 12:44   ` Wolfgang Bumiller
2023-07-18 13:19     ` Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 09/66] notify: add notification groups Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 10/66] notify: api: add API for groups Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 11/66] notify: add notification filter mechanism Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 12/66] notify: api: add API for filters Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 13/66] notify: add template rendering Lukas Wagner
2023-07-17 14:59 ` [pve-devel] [PATCH v3 proxmox 14/66] notify: add example for " Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 15/66] notify: add context Lukas Wagner
2023-07-18 12:57   ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 16/66] notify: sendmail: allow users as recipients Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 17/66] notify: sendmail: query default author/mailfrom from context Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 18/66] notify: gotify: add proxy support Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 19/66] notify: api: allow to query entities referenced by filter/target Lukas Wagner
2023-07-18 13:02   ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 20/66] notify: on deletion, check if a filter/endp. is still used by anything Lukas Wagner
2023-07-18 13:20   ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 21/66] notify: ensure that filter/group/endpoint names are unique Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 22/66] notify: additional logging when sending a notification Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox 23/66] notify: add debian packaging Lukas Wagner
2023-07-18 13:25   ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 24/66] add PVE::RS::Notify module Lukas Wagner
2023-07-19 10:10   ` Wolfgang Bumiller
2023-07-19 10:23     ` Wolfgang Bumiller
2023-07-19 10:37       ` Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 25/66] notify: add api for sending notifications/testing endpoints Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 26/66] notify: add api for notification groups Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 27/66] notify: add api for sendmail endpoints Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 28/66] notify: add api for gotify endpoints Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 29/66] notify: add api for notification filters Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 30/66] notify: sendmail: support the `mailto-user` parameter Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 31/66] notify: implement context for getting default author/mailfrom Lukas Wagner
2023-07-19 11:15   ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 32/66] notify: add context for getting http_proxy from datacenter.cfg Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-perl-rs 33/66] notify: add wrapper for `get_referenced_entities` Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-cluster 34/66] cluster files: add notifications.cfg Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-cluster 35/66] datacenter: add APT/fencing/replication notification configuration Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-cluster 36/66] add libpve-notify-perl package Lukas Wagner
2023-07-19 12:27   ` Wolfgang Bumiller [this message]
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-guest-common 37/66] vzdump: add config options for new notification backend Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-common 38/66] JSONSchema: increase maxLength of config-digest to 64 Lukas Wagner
2023-07-19 12:31   ` Wolfgang Bumiller
2023-07-19 12:41   ` Fiona Ebner
2023-07-19 12:49     ` Wolfgang Bumiller
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-ha-manager 39/66] manager: send notifications via new notification module Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 40/66] test: fix names of .PHONY targets Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 41/66] d/control: add dependency to `libpve-notify-perl` Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 42/66] vzdump: send notifications via new notification module Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 43/66] test: rename mail_test.pl to vzdump_notification_test.pl Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 44/66] api: apt: send notification via new notification module Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 45/66] api: replication: send notifications " Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 46/66] api: prepare api handler module for notification config Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 47/66] api: notification: add api routes for groups Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 48/66] api: notification: add api routes for sendmail endpoints Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 49/66] api: notification: add api routes for gotify endpoints Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 50/66] api: notification: add api routes for filters Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 51/66] api: notification: allow fetching notification targets Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 52/66] api: notification: allow to test targets Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 53/66] api: notification: disallow removing targets if they are used Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 54/66] ui: backup: allow to select notification target for jobs Lukas Wagner
2023-07-19 12:20   ` Dominik Csapak
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 55/66] ui: backup: adapt backup job details to new notification params Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 56/66] ui: backup: allow to set notification-target for one-off backups Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 57/66] ui: allow to configure notification event -> target mapping Lukas Wagner
2023-07-19 12:45   ` Dominik Csapak
2023-07-19 15:25     ` Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 58/66] ui: add notification target configuration panel Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 59/66] ui: perm path: load notification target/filter acl entries Lukas Wagner
2023-07-19 12:53   ` Dominik Csapak
2023-07-20  7:46     ` Lukas Wagner
2023-07-20  7:54       ` Dominik Csapak
2023-07-20  8:22         ` Lukas Wagner
2023-07-20  8:29           ` Fiona Ebner
2023-07-20  9:26             ` Maximiliano Sandoval
2023-07-20 15:02               ` Thomas Lamprecht
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-manager 60/66] ui: perm path: increase width of the perm path selector combobox Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-widget-toolkit 61/66] notification: add gui for sendmail notification endpoints Lukas Wagner
2023-07-19 13:25   ` Dominik Csapak
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-widget-toolkit 62/66] notification: add gui for gotify " Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-widget-toolkit 63/66] notification: add gui for notification groups Lukas Wagner
2023-07-19 13:32   ` Dominik Csapak
2023-07-20 12:31     ` Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-widget-toolkit 64/66] notification: allow to select filter for notification targets Lukas Wagner
2023-07-17 15:00 ` [pve-devel] [PATCH v3 proxmox-widget-toolkit 65/66] notification: add ui for managing notification filters Lukas Wagner
2023-07-19 13:53   ` Dominik Csapak
2023-07-17 15:00 ` [pve-devel] [PATCH v3 pve-docs 66/66] add documentation for the new notification system Lukas Wagner
2023-07-18 12:34 ` [pve-devel] [PATCH v3 many 00/66] fix #4156: introduce " Dominik Csapak
2023-07-18 13:14   ` Lukas Wagner
2023-07-18 13:58     ` Dominik Csapak
2023-07-18 14:07       ` Lukas Wagner
2023-07-18 14:37   ` Thomas Lamprecht
2023-07-19 13:13     ` Lukas Wagner
2023-07-19  8:40   ` Lukas Wagner
2023-07-19  9:54     ` Wolfgang Bumiller
2023-07-18 13:27 ` Wolfgang Bumiller
2023-07-19 12:11 ` Wolfgang Bumiller
2023-07-19 12:17   ` Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=lmx4xz2pr3ava67tndtoxgtnnhtykofjnftukfvl2omh3mbv6s@t2z5azlxy5wu \
    --to=w.bumiller@proxmox.com \
    --cc=l.wagner@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal