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 v4 pve-manager 52/69] api: notification: add api routes for filters
Date: Mon, 24 Jul 2023 15:56:27 +0200 [thread overview]
Message-ID: <6sbzwrne6qwkgw5ea5l573n3y34zbjdycmhdqzmtp64yipapf7@ecdg44meoymy> (raw)
In-Reply-To: <20230720143236.652292-53-l.wagner@proxmox.com>
And the eval{} parts once more here ;-)
On Thu, Jul 20, 2023 at 04:32:19PM +0200, Lukas Wagner wrote:
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
> PVE/API2/Cluster/Notifications.pm | 263 ++++++++++++++++++++++++++++++
> 1 file changed, 263 insertions(+)
>
> diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm
> index 8f0b6429..e358573c 100644
> --- a/PVE/API2/Cluster/Notifications.pm
> +++ b/PVE/API2/Cluster/Notifications.pm
> @@ -76,6 +76,7 @@ __PACKAGE__->register_method ({
> code => sub {
> my $result = [
> { name => 'endpoints' },
> + { name => 'filters' },
> { name => 'groups' },
> ];
>
> @@ -908,4 +909,266 @@ __PACKAGE__->register_method ({
> return;
> }
> });
> +
> +my $filter_properties = {
> + name => {
> + description => 'Name of the endpoint.',
> + type => 'string',
> + format => 'pve-configid',
> + },
> + 'min-severity' => {
> + type => 'string',
> + description => 'Minimum severity to match',
> + optional => 1,
> + enum => [qw(info notice warning error)],
> + },
> + mode => {
> + type => 'string',
> + description => "Choose between 'and' and 'or' for when multiple properties are specified",
> + optional => 1,
> + enum => [qw(and or)],
> + default => 'and',
> + },
> + 'invert-match' => {
> + type => 'boolean',
> + description => 'Invert match of the whole filter',
> + optional => 1,
> + },
> + 'comment' => {
> + description => 'Comment',
> + type => 'string',
> + optional => 1,
> + },
> +};
> +
> +__PACKAGE__->register_method ({
> + name => 'get_filters',
> + path => 'filters',
> + method => 'GET',
> + description => 'Returns a list of all filters',
> + protected => 1,
> + permissions => {
> + description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or"
> + . " 'Mapping.Audit' permissions on '/mapping/notification/<name>'.",
> + user => 'all',
> + },
> + parameters => {
> + additionalProperties => 0,
> + properties => {},
> + },
> + returns => {
> + type => 'array',
> + items => {
> + type => 'object',
> + properties => $filter_properties,
> + },
> + links => [ { rel => 'child', href => '{name}' } ],
> + },
> + code => sub {
> + my $config = PVE::Notify::read_config();
> + my $rpcenv = PVE::RPCEnvironment::get();
> + my $authuser = $rpcenv->get_user();
> + my $can_see_mapping_privs = ['Mapping.Modify', 'Mapping.Use', 'Mapping.Audit'];
> +
> + my $filters = [grep {
> + $rpcenv->check_any(
> + $authuser,
> + "/mapping/notification/$_->{name}",
> + $can_see_mapping_privs,
> + 1
> + )
> + } eval {
Here.
> + @{$config->get_filters()}
> + }];
> +
> + raise_api_error($@) if ($@);
> + return $filters;
> + }
> +});
> +
> +__PACKAGE__->register_method ({
> + name => 'get_filter',
> + path => 'filters/{name}',
> + method => 'GET',
> + description => 'Return a specific filter',
> + protected => 1,
> + permissions => {
> + check => ['or',
> + ['perm', '/mapping/notification/{name}', ['Mapping.Modify']],
> + ['perm', '/mapping/notification/{name}', ['Mapping.Audit']],
> + ],
> + },
> + parameters => {
> + additionalProperties => 0,
> + properties => {
> + name => {
> + type => 'string',
> + format => 'pve-configid',
> + },
> + }
> + },
> + returns => {
> + type => 'object',
> + properties => {
> + %$filter_properties,
> + digest => get_standard_option('pve-config-digest'),
> + },
> + },
> + code => sub {
> + my ($param) = @_;
> + my $name = extract_param($param, 'name');
> +
> + my $config = PVE::Notify::read_config();
> +
> + my $filter = eval {
> + $config->get_filter($name)
> + };
> + $filter->{digest} = $config->digest();
here
> +
> + raise_api_error($@) if ($@);
> + return $filter;
> + }
> +});
> +
> +__PACKAGE__->register_method ({
> + name => 'create_filter',
> + path => 'filters',
> + protected => 1,
> + method => 'POST',
> + description => 'Create a new filter',
> + protected => 1,
> + permissions => {
> + check => ['perm', '/mapping/notification', ['Mapping.Modify']],
> + },
> + parameters => {
> + additionalProperties => 0,
> + properties => $filter_properties,
> + },
> + returns => { type => 'null' },
> + code => sub {
> + my ($param) = @_;
> +
> + my $name = extract_param($param, 'name');
> + my $min_severity = extract_param($param, 'min-severity');
> + my $mode = extract_param($param, 'mode');
> + my $invert_match = extract_param($param, 'invert-match');
> + my $comment = extract_param($param, 'comment');
> +
> + eval {
> + PVE::Notify::lock_config(sub {
> + my $config = PVE::Notify::read_config();
> +
> + $config->add_filter(
> + $name,
> + $min_severity,
> + $mode,
> + $invert_match,
> + $comment,
> + );
> +
> + PVE::Notify::write_config($config);
> + });
> + };
> +
> + raise_api_error($@) if ($@);
> + return;
> + }
> +});
> +
> +__PACKAGE__->register_method ({
> + name => 'update_filter',
> + path => 'filters/{name}',
> + protected => 1,
> + method => 'PUT',
> + description => 'Update existing filter',
> + permissions => {
> + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']],
> + },
> + parameters => {
> + additionalProperties => 0,
> + properties => {
> + %{ make_properties_optional($filter_properties) },
> + delete => {
> + type => 'array',
> + items => {
> + type => 'string',
> + format => 'pve-configid',
> + },
> + optional => 1,
> + description => 'A list of settings you want to delete.',
> + },
> + digest => get_standard_option('pve-config-digest'),
> + },
> + },
> + returns => { type => 'null' },
> + code => sub {
> + my ($param) = @_;
> +
> + my $name = extract_param($param, 'name');
> + my $min_severity = extract_param($param, 'min-severity');
> + my $mode = extract_param($param, 'mode');
> + my $invert_match = extract_param($param, 'invert-match');
> + my $comment = extract_param($param, 'comment');
> + my $digest = extract_param($param, 'digest');
> + my $delete = extract_param($param, 'delete');
> +
> + eval {
> + PVE::Notify::lock_config(sub {
> + my $config = PVE::Notify::read_config();
> +
> + $config->update_filter(
> + $name,
> + $min_severity,
> + $mode,
> + $invert_match,
> + $comment,
> + $delete,
> + $digest,
> + );
> +
> + PVE::Notify::write_config($config);
> + });
> + };
> +
> + raise_api_error($@) if ($@);
> + return;
> + }
> +});
> +
> +__PACKAGE__->register_method ({
> + name => 'delete_filter',
> + protected => 1,
> + path => 'filters/{name}',
> + method => 'DELETE',
> + description => 'Remove filter',
> + permissions => {
> + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']],
> + },
> + parameters => {
> + additionalProperties => 0,
> + properties => {
> + name => {
> + type => 'string',
> + format => 'pve-configid',
> + },
> + }
> + },
> + returns => { type => 'null' },
> + code => sub {
> + my ($param) = @_;
> + my $name = extract_param($param, 'name');
> +
> + eval {
> + PVE::Notify::lock_config(sub {
> + my $config = PVE::Notify::read_config();
> + $config->delete_filter($name);
> + PVE::Notify::write_config($config);
> + });
> + };
> +
> + raise_api_error($@) if ($@);
> + return;
> + }
> +});
> +
> 1;
> --
> 2.39.2
next prev parent reply other threads:[~2023-07-24 13:56 UTC|newest]
Thread overview: 84+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-20 14:31 [pve-devel] [PATCH v4 many 00/69] fix #4156: introduce new notification system Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 01/69] section-config: derive Clone for SectionConfigData Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 02/69] schema: add schema/format for comments Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 03/69] add proxmox-notify crate Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 04/69] notify: preparation for the first endpoint plugin Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 05/69] notify: preparation for the API Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 06/69] notify: api: add API for sending notifications/testing endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 07/69] notify: add sendmail plugin Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 08/69] notify: api: add API for sendmail endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 09/69] notify: add gotify endpoint Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 10/69] notify: api: add API for gotify endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 11/69] notify: add notification groups Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 12/69] notify: api: add API for groups Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 13/69] notify: add notification filter mechanism Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 14/69] notify: api: add API for filters Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 15/69] notify: add template rendering Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 16/69] notify: add example for " Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 17/69] notify: add context Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 18/69] notify: sendmail: allow users as recipients Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 19/69] notify: sendmail: query default author/mailfrom from context Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 20/69] notify: gotify: add proxy support Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 21/69] notify: api: allow to query entities referenced by filter/target Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 22/69] notify: on deletion, check if a filter/endp. is still used by anything Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 23/69] notify: ensure that filter/group/endpoint names are unique Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 24/69] notify: additional logging when sending a notification Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox 25/69] notify: add debian packaging Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 26/69] add PVE::RS::Notify module Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 27/69] notify: add api for sending notifications/testing endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 28/69] notify: add api for notification groups Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 29/69] notify: add api for sendmail endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 30/69] notify: add api for gotify endpoints Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 31/69] notify: add api for notification filters Lukas Wagner
2023-07-20 14:31 ` [pve-devel] [PATCH v4 proxmox-perl-rs 32/69] notify: sendmail: support the `mailto-user` parameter Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-perl-rs 33/69] notify: implement context for getting default author/mailfrom Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-perl-rs 34/69] notify: add context for getting http_proxy from datacenter.cfg Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-perl-rs 35/69] notify: add wrapper for `get_referenced_entities` Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-cluster 36/69] cluster files: add notifications.cfg Lukas Wagner
2023-07-24 13:02 ` [pve-devel] partially-applied: " Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-cluster 37/69] datacenter: add APT/fencing/replication notification configuration Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-cluster 38/69] add libpve-notify-perl package Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-guest-common 39/69] vzdump: add config options for new notification backend Lukas Wagner
2023-07-24 13:30 ` [pve-devel] partially-applied: " Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-common 40/69] JSONSchema: increase maxLength of config-digest to 64 Lukas Wagner
2023-07-24 9:56 ` [pve-devel] applied: " Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-ha-manager 41/69] manager: send notifications via new notification module Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 42/69] test: fix names of .PHONY targets Lukas Wagner
2023-07-24 13:59 ` Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 43/69] d/control: add dependency to `libpve-notify-perl` Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 44/69] vzdump: send notifications via new notification module Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 45/69] test: rename mail_test.pl to vzdump_notification_test.pl Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 46/69] api: apt: send notification via new notification module Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 47/69] api: replication: send notifications " Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 48/69] api: prepare api handler module for notification config Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 49/69] api: notification: add api routes for groups Lukas Wagner
2023-07-24 13:54 ` Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 50/69] api: notification: add api routes for sendmail endpoints Lukas Wagner
2023-07-24 13:55 ` Wolfgang Bumiller
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 51/69] api: notification: add api routes for gotify endpoints Lukas Wagner
2023-07-24 13:55 ` Wolfgang Bumiller
2023-07-25 9:02 ` Thomas Lamprecht
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 52/69] api: notification: add api routes for filters Lukas Wagner
2023-07-24 13:56 ` Wolfgang Bumiller [this message]
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 53/69] api: notification: allow fetching notification targets Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 54/69] api: notification: allow to test targets Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 55/69] api: notification: disallow removing targets if they are used Lukas Wagner
2023-07-24 13:50 ` Wolfgang Bumiller
2023-07-24 14:09 ` Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 56/69] ui: backup: allow to select notification target for jobs Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 57/69] ui: backup: adapt backup job details to new notification params Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 58/69] ui: backup: allow to set notification-target for one-off backups Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 59/69] ui: allow to configure notification event -> target mapping Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 60/69] ui: add notification target configuration panel Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 61/69] ui: perm path: add ACL paths for notifications, usb and pci mappings Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 62/69] ui: perm path: increase width of the perm path selector combobox Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-manager 63/69] ui: dc: remove notify key from datacenter option view Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-widget-toolkit 64/69] notification: add gui for sendmail notification endpoints Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-widget-toolkit 65/69] notification: add gui for gotify " Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-widget-toolkit 66/69] notification: add gui for notification groups Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-widget-toolkit 67/69] notification: allow to select filter for notification targets Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 proxmox-widget-toolkit 68/69] notification: add ui for managing notification filters Lukas Wagner
2023-07-20 14:32 ` [pve-devel] [PATCH v4 pve-docs 69/69] add documentation for the new notification system Lukas Wagner
2023-07-24 9:07 ` [pve-devel] partially-applied: [PATCH v4 many 00/69] fix #4156: introduce " Wolfgang Bumiller
2023-07-24 9:20 ` [pve-devel] " Thomas Lamprecht
2023-07-24 9:23 ` [pve-devel] partially-applied: " Wolfgang Bumiller
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=6sbzwrne6qwkgw5ea5l573n3y34zbjdycmhdqzmtp64yipapf7@ecdg44meoymy \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox