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 3C469F264 for ; Thu, 20 Jul 2023 16:34:13 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id BDDC014D5B for ; Thu, 20 Jul 2023 16:33:30 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 for ; Thu, 20 Jul 2023 16:33:28 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 5C0E441FB7 for ; Thu, 20 Jul 2023 16:33:13 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 20 Jul 2023 16:32:16 +0200 Message-Id: <20230720143236.652292-50-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230720143236.652292-1-l.wagner@proxmox.com> References: <20230720143236.652292-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.071 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v4 pve-manager 49/69] api: notification: add api routes for groups X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 20 Jul 2023 14:34:13 -0000 Signed-off-by: Lukas Wagner --- PVE/API2/Cluster/Notifications.pm | 254 ++++++++++++++++++++++++++++++ 1 file changed, 254 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index 1efebbc1..b1971911 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -62,10 +62,264 @@ __PACKAGE__->register_method ({ }, code => sub { my $result = [ + { name => 'groups' }, ]; return $result; } }); +my $group_properties = { + name => { + description => 'Name of the group.', + type => 'string', + format => 'pve-configid', + }, + 'endpoint' => { + type => 'array', + items => { + type => 'string', + format => 'pve-configid', + }, + description => 'List of included endpoints', + }, + 'comment' => { + description => 'Comment', + type => 'string', + optional => 1, + }, + filter => { + description => 'Name of the filter that should be applied.', + type => 'string', + format => 'pve-configid', + optional => 1, + }, +}; + +__PACKAGE__->register_method ({ + name => 'get_groups', + path => 'groups', + method => 'GET', + description => 'Returns a list of all groups', + protected => 1, + permissions => { + description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or" + . " 'Mapping.Audit' permissions on '/mapping/notification/'.", + user => 'all', + }, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => $group_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 $groups = [grep { + $rpcenv->check_any( + $authuser, + "/mapping/notification/$_->{name}", + $can_see_mapping_privs, + 1 + ) + } eval { + @{$config->get_groups()} + }]; + + raise_api_error($@) if ($@); + return $groups; + + } +}); + +__PACKAGE__->register_method ({ + name => 'get_group', + path => 'groups/{name}', + method => 'GET', + description => 'Return a specific group', + 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 => { + %$group_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 $group = eval { + $config->get_group($name) + }; + $group->{digest} = $config->digest(); + + raise_api_error($@) if ($@); + return $group; + } +}); + +__PACKAGE__->register_method ({ + name => 'create_group', + path => 'groups', + protected => 1, + method => 'POST', + description => 'Create a new group', + permissions => { + check => ['perm', '/mapping/notification', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => $group_properties, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + + my $name = extract_param($param, 'name'); + my $endpoint = extract_param($param, 'endpoint'); + my $comment = extract_param($param, 'comment'); + my $filter = extract_param($param, 'filter'); + + eval { + PVE::Notify::lock_config(sub { + my $config = PVE::Notify::read_config(); + + $config->add_group( + $name, + $endpoint, + $comment, + $filter, + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if ($@); + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'update_group', + path => 'groups/{name}', + protected => 1, + method => 'PUT', + description => 'Update existing group', + permissions => { + check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + %{ make_properties_optional($group_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 $endpoint = extract_param($param, 'endpoint'); + my $comment = extract_param($param, 'comment'); + my $filter = extract_param($param, 'filter'); + 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_group( + $name, + $endpoint, + $comment, + $filter, + $delete, + $digest, + ); + + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if ($@); + return; + } +}); + +__PACKAGE__->register_method ({ + name => 'delete_group', + protected => 1, + path => 'groups/{name}', + method => 'DELETE', + description => 'Remove group', + 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_group($name); + PVE::Notify::write_config($config); + }); + }; + + raise_api_error($@) if ($@); + return; + } +}); + 1; -- 2.39.2