api: notification: add api routes for sendmail endpoints

The Perl part of the API methods primarily defines the API schema,
checks for any needed priviledges and then calls the actual Rust
implementation exposed via perlmod. Any errors returned by the Rust
code are translated into PVE::Exception, so that the API call fails
with the correct HTTP error code.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>

diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm
index 55dd650d19b874afbf4de8a445e94eb3894fb94c..2d907c35a4ae97ac75f9538463f06d2008364251 100644 (file)
--- a/PVE/API2/Cluster/Notifications.pm
+++ b/PVE/API2/Cluster/Notifications.pm
@@ -80,6 +80,7 @@ __PACKAGE__->register_method ({
     },
     code => sub {
        my $result = [
+           { name => 'endpoints' },
            { name => 'groups' },
        ];
 
@@ -87,6 +88,33 @@ __PACKAGE__->register_method ({
     }
 });
 
+__PACKAGE__->register_method ({
+    name => 'endpoints_index',
+    path => 'endpoints',
+    method => 'GET',
+    description => 'Index for all available endpoint types.',
+    permissions => { user => 'all' },
+    parameters => {
+       additionalProperties => 0,
+       properties => {},
+    },
+    returns => {
+       type => 'array',
+       items => {
+           type => 'object',
+           properties => {},
+       },
+       links => [ { rel => 'child', href => '{name}' } ],
+    },
+    code => sub {
+       my $result = [
+           { name => 'sendmail' },
+       ];
+
+       return $result;
+    }
+});
+
 my $group_properties = {
     name => {
        description => 'Name of the group.',
@@ -331,4 +359,281 @@ __PACKAGE__->register_method ({
     }
 });
 
+my $sendmail_properties = {
+    name => {
+       description => 'The name of the endpoint.',
+       type => 'string',
+       format => 'pve-configid',
+    },
+    mailto => {
+       type => 'array',
+       items => {
+           type => 'string',
+           format => 'email-or-username',
+       },
+       description => 'List of email recipients',
+       optional => 1,
+    },
+    'mailto-user' => {
+       type => 'array',
+       items => {
+           type => 'string',
+           format => 'pve-userid',
+       },
+       description => 'List of users',
+       optional => 1,
+    },
+    'from-address' => {
+       description => '`From` address for the mail',
+       type => 'string',
+       optional => 1,
+    },
+    author => {
+       description => 'Author of the mail',
+       type => 'string',
+       optional => 1,
+    },
+    '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_sendmail_endpoints',
+    path => 'endpoints/sendmail',
+    method => 'GET',
+    description => 'Returns a list of all sendmail endpoints',
+    permissions => {
+       description => "Only lists entries where you have 'Mapping.Modify', 'Mapping.Use' or"
+           . " 'Mapping.Audit' permissions on '/mapping/notification/<name>'.",
+       user => 'all',
+    },
+    protected => 1,
+    parameters => {
+       additionalProperties => 0,
+       properties => {},
+    },
+    returns => {
+       type => 'array',
+       items => {
+           type => 'object',
+           properties => $sendmail_properties,
+       },
+       links => [ { rel => 'child', href => '{name}' } ],
+    },
+    code => sub {
+       my $config = PVE::Notify::read_config();
+       my $rpcenv = PVE::RPCEnvironment::get();
+
+       my $entities = eval {
+           $config->get_sendmail_endpoints();
+       };
+       raise_api_error($@) if $@;
+
+       return filter_entities_by_privs($rpcenv, $entities);
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'get_sendmail_endpoint',
+    path => 'endpoints/sendmail/{name}',
+    method => 'GET',
+    description => 'Return a specific sendmail endpoint',
+    permissions => {
+       check => ['or',
+           ['perm', '/mapping/notification/{name}', ['Mapping.Modify']],
+           ['perm', '/mapping/notification/{name}', ['Mapping.Audit']],
+       ],
+    },
+    protected => 1,
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           name => {
+               type => 'string',
+               format => 'pve-configid',
+           },
+       }
+    },
+    returns => {
+       type => 'object',
+       properties => {
+           %$sendmail_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 $endpoint = eval {
+           $config->get_sendmail_endpoint($name)
+       };
+
+       raise_api_error($@) if $@;
+       $endpoint->{digest} = $config->digest();
+
+       return $endpoint;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'create_sendmail_endpoint',
+    path => 'endpoints/sendmail',
+    protected => 1,
+    method => 'POST',
+    description => 'Create a new sendmail endpoint',
+    permissions => {
+       check => ['perm', '/mapping/notification', ['Mapping.Modify']],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => $sendmail_properties,
+    },
+    returns => { type => 'null' },
+    code => sub {
+       my ($param) = @_;
+
+       my $name = extract_param($param, 'name');
+       my $mailto = extract_param($param, 'mailto');
+       my $mailto_user = extract_param($param, 'mailto-user');
+       my $from_address = extract_param($param, 'from-address');
+       my $author = extract_param($param, 'author');
+       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_sendmail_endpoint(
+                   $name,
+                   $mailto,
+                   $mailto_user,
+                   $from_address,
+                   $author,
+                   $comment,
+                   $filter
+               );
+
+               PVE::Notify::write_config($config);
+           });
+       };
+
+       raise_api_error($@) if $@;
+       return;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'update_sendmail_endpoint',
+    path => 'endpoints/sendmail/{name}',
+    protected => 1,
+    method => 'PUT',
+    description => 'Update existing sendmail endpoint',
+    permissions => {
+       check => ['perm', '/mapping/notification/{name}', ['Mapping.Modify']],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           %{ make_properties_optional($sendmail_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 $mailto = extract_param($param, 'mailto');
+       my $mailto_user = extract_param($param, 'mailto-user');
+       my $from_address = extract_param($param, 'from-address');
+       my $author = extract_param($param, 'author');
+       my $comment = extract_param($param, 'comment');
+       my $filter = extract_param($param, 'filter');
+
+       my $delete = extract_param($param, 'delete');
+       my $digest = extract_param($param, 'digest');
+
+       eval {
+           PVE::Notify::lock_config(sub {
+               my $config = PVE::Notify::read_config();
+
+               $config->update_sendmail_endpoint(
+                   $name,
+                   $mailto,
+                   $mailto_user,
+                   $from_address,
+                   $author,
+                   $comment,
+                   $filter,
+                   $delete,
+                   $digest,
+               );
+
+               PVE::Notify::write_config($config);
+           });
+       };
+
+       raise_api_error($@) if $@;
+       return;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'delete_sendmail_endpoint',
+    protected => 1,
+    path => 'endpoints/sendmail/{name}',
+    method => 'DELETE',
+    description => 'Remove sendmail endpoint',
+    permissions => {
+       check => ['perm', '/mapping/notification', ['Mapping.Modify']],
+    },
+    parameters => {
+       additionalProperties => 0,
+       properties => {
+           name => {
+               type => 'string',
+               format => 'pve-configid',
+           },
+       }
+    },
+    returns => { type => 'null' },
+    code => sub {
+       my ($param) = @_;
+
+       eval {
+           PVE::Notify::lock_config(sub {
+               my $config = PVE::Notify::read_config();
+               $config->delete_sendmail_endpoint($param->{name});
+               PVE::Notify::write_config($config);
+           });
+       };
+
+       raise_api_error($@) if ($@);
+       return;
+    }
+});
+
 1;