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 D47899B36F for ; Wed, 24 May 2023 15:58:35 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3F4111F830 for ; Wed, 24 May 2023 15:57:42 +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 ; Wed, 24 May 2023 15:57:39 +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 6D7BD46E5F for ; Wed, 24 May 2023 15:57:35 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Wed, 24 May 2023 15:56:43 +0200 Message-Id: <20230524135649.934881-37-l.wagner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230524135649.934881-1-l.wagner@proxmox.com> References: <20230524135649.934881-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.155 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 v2 pve-manager 36/42] api: prepare api handler module for notification config 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: Wed, 24 May 2023 13:58:35 -0000 Signed-off-by: Lukas Wagner --- PVE/API2/Cluster.pm | 7 ++ PVE/API2/Cluster/Makefile | 1 + PVE/API2/Cluster/Notifications.pm | 134 ++++++++++++++++++++++++++++++ 3 files changed, 142 insertions(+) create mode 100644 PVE/API2/Cluster/Notifications.pm diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm index 2e942368..c19a03c4 100644 --- a/PVE/API2/Cluster.pm +++ b/PVE/API2/Cluster.pm @@ -28,6 +28,7 @@ use PVE::API2::Cluster::BackupInfo; use PVE::API2::Cluster::Ceph; use PVE::API2::Cluster::Jobs; use PVE::API2::Cluster::MetricServer; +use PVE::API2::Cluster::Notifications; use PVE::API2::ClusterConfig; use PVE::API2::Firewall::Cluster; use PVE::API2::HAConfig; @@ -51,6 +52,11 @@ __PACKAGE__->register_method ({ path => 'metrics', }); +__PACKAGE__->register_method ({ + subclass => "PVE::API2::Cluster::Notifications", + path => 'notifications', +}); + __PACKAGE__->register_method ({ subclass => "PVE::API2::ClusterConfig", path => 'config', @@ -141,6 +147,7 @@ __PACKAGE__->register_method ({ { name => 'jobs' }, { name => 'log' }, { name => 'metrics' }, + { name => 'notifications' }, { name => 'nextid' }, { name => 'options' }, { name => 'replication' }, diff --git a/PVE/API2/Cluster/Makefile b/PVE/API2/Cluster/Makefile index 8d306507..8bd65d3e 100644 --- a/PVE/API2/Cluster/Makefile +++ b/PVE/API2/Cluster/Makefile @@ -5,6 +5,7 @@ include ../../../defines.mk PERLSOURCE= \ BackupInfo.pm \ MetricServer.pm \ + Notifications.pm \ Jobs.pm \ Ceph.pm diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm new file mode 100644 index 00000000..7d3bf53d --- /dev/null +++ b/PVE/API2/Cluster/Notifications.pm @@ -0,0 +1,134 @@ +package PVE::API2::Cluster::Notifications; + +use warnings; +use strict; + +use Storable qw(dclone); +use JSON; + +use PVE::Tools qw(extract_param); +use PVE::JSONSchema qw(get_standard_option); +use PVE::RESTHandler; +use PVE::Notify; + +use base qw(PVE::RESTHandler); + +sub make_properties_optional { + my ($properties) = @_; + $properties = dclone($properties); + + for my $key (keys %$properties) { + $properties->{$key}->{optional} = 1 if $key ne 'name'; + } + + return $properties; +} + +sub raise_api_error { + my ($api_error) = @_; + + my $msg = "$api_error->{message}\n"; + my $exc = PVE::Exception->new($msg, code => $api_error->{code}); + + my (undef, $filename, $line) = caller; + + $exc->{filename} = $filename; + $exc->{line} = $line; + + die $exc; +} + +__PACKAGE__->register_method ({ + name => 'index', + path => '', + method => 'GET', + description => 'Notifications index.', + permissions => { user => 'all' }, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => {}, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $result = [ + { name => 'endpoints' }, + ]; + + return $result; + } +}); + + +__PACKAGE__->register_method ({ + name => 'endpoints_index', + path => 'endpoints', + method => 'GET', + description => 'Notifications index.', + permissions => { user => 'all' }, + parameters => { + additionalProperties => 0, + properties => {}, + }, + returns => { + type => 'array', + items => { + type => 'object', + properties => {}, + }, + links => [ { rel => 'child', href => '{name}' } ], + }, + code => sub { + my $result = [ + { name => 'test' }, + ]; + + return $result; + } +}); + +__PACKAGE__->register_method ({ + name => 'test_endpoint', + path => 'endpoints/test/{name}', + protected => 1, + method => 'POST', + description => 'Send notification', + permissions => { + # Let's assume that 'testing an endpoint' should be allowed for users + # who are also allowed to modify the notification configuration. + check => ['perm', '/', ['Sys.Modify']], + }, + parameters => { + additionalProperties => 0, + properties => { + name => { + description => 'Name of the endpoint', + type => 'string', + format => 'pve-configid' + }, + }, + }, + returns => { type => 'null' }, + code => sub { + my ($param) = @_; + my $name = extract_param($param, 'name'); + + my $config = PVE::Notify::read_config(); + + eval { + $config->test_endpoint($name); + }; + + raise_api_error($@) if ($@); + + return; + } +}); + +1; -- 2.30.2