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 BD0C9B97FF for ; Mon, 11 Dec 2023 13:51:08 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D9263162CE for ; Mon, 11 Dec 2023 13:50:13 +0100 (CET) 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 ; Mon, 11 Dec 2023 13:50:11 +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 719AA4539D for ; Mon, 11 Dec 2023 13:50:09 +0100 (CET) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Mon, 11 Dec 2023 13:49:46 +0100 Message-Id: <20231211124955.211219-13-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231211124955.211219-1-l.wagner@proxmox.com> References: <20231211124955.211219-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.006 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 pve-manager 12/21] api: notification: add API for getting known metadata fields/values 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: Mon, 11 Dec 2023 12:51:08 -0000 This new API route returns known notification metadata fields and a list of known possible values. This will be used by the UI to provide suggestions when adding/modifying match rules. Signed-off-by: Lukas Wagner --- PVE/API2/Cluster/Notifications.pm | 152 ++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm index 68fdda2a..16548bec 100644 --- a/PVE/API2/Cluster/Notifications.pm +++ b/PVE/API2/Cluster/Notifications.pm @@ -79,12 +79,164 @@ __PACKAGE__->register_method ({ { name => 'endpoints' }, { name => 'matchers' }, { name => 'targets' }, + { name => 'fields' }, + { name => 'values' }, ]; return $result; } }); +__PACKAGE__->register_method ({ + name => 'get_fields', + path => 'fields', + method => 'GET', + description => 'Returns known notification metadata fields and their known values', + permissions => { + check => ['or', + ['perm', '/mapping/notifications', ['Mapping.Modify']], + ['perm', '/mapping/notifications', ['Mapping.Audit']], + ], + }, + protected => 1, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => { + name => { + description => 'Name of the field.', + type => 'string', + }, + }, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + # TODO: Adapt this API handler once we have a 'notification registry' + + my $result = [ + { name => 'type' }, + { name => 'hostname' }, + { name => 'backup-job' }, + { name => 'replication-job' }, + ]; + + return $result; + } +}); + +__PACKAGE__->register_method ({ + name => 'get_field_values', + path => 'values', + method => 'GET', + description => 'Returns known notification metadata fields and their known values', + permissions => { + check => ['or', + ['perm', '/mapping/notifications', ['Mapping.Modify']], + ['perm', '/mapping/notifications', ['Mapping.Audit']], + ], + }, + protected => 1, + parameters => { + additionalProperties => 0, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => { + 'value' => { + description => 'Notification metadata value known by the system.', + type => 'string' + }, + 'comment' => { + description => 'Additional comment for this value.', + type => 'string', + optional => 1, + }, + 'field' => { + description => 'Field this value belongs to.', + type => 'string', + optional => 1, + }, + 'internal' => { + description => 'Set if "value" was generated by the system and can' + . ' safely be used as base for translations.', + type => 'boolean', + optional => 1, + }, + }, + }, + }, + code => sub { + # TODO: Adapt this API handler once we have a 'notification registry' + my $rpcenv = PVE::RPCEnvironment::get(); + my $user = $rpcenv->get_user(); + + my $values = [ + { + value => 'package-updates', + internal => 1, + field => 'type', + }, + { + value => 'fencing', + internal => 1, + field => 'type', + }, + { + value => 'replication', + internal => 1, + field => 'type', + }, + { + value => 'vzdump', + internal => 1, + field => 'type', + }, + { + value => 'system-mail', + internal => 1, + field => 'type', + }, + ]; + + # Here we need a manual permission check. + if ($rpcenv->check($user, "/", ["Sys.Audit"], 1)) { + for my $backup_job (@{PVE::API2::Backup->index({})}) { + push @$values, { + value => $backup_job->{id}, + comment => $backup_job->{comment}, + field => 'backup-job' + }; + } + } + # The API call returns only returns jobs for which the user + # has adequate permissions. + for my $sync_job (@{PVE::API2::ReplicationConfig->index({})}) { + push @$values, { + value => $sync_job->{id}, + comment => $sync_job->{comment}, + field => 'replication-job' + }; + } + + for my $node (@{PVE::Cluster::get_nodelist()}) { + push @$values, { + value => $node, + field => 'hostname', + } + } + + return $values; + } +}); + __PACKAGE__->register_method ({ name => 'endpoints_index', path => 'endpoints', -- 2.39.2