[pve-devel] [PATCH v2 pve-manager 38/42] api: add api routes for sendmail endpoints

[Lukas Wagner]

Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
---
 PVE/API2/Cluster/Notifications.pm | 293 ++++++++++++++++++++++++++++++
 1 file changed, 293 insertions(+)

diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm
index 74538554..53e447ad 100644
--- a/PVE/API2/Cluster/Notifications.pm
+++ b/PVE/API2/Cluster/Notifications.pm
@@ -87,6 +87,7 @@ __PACKAGE__->register_method ({
     },
     code => sub {
 	my $result = [
+	    { name => 'sendmail' },
 	    { name => 'test' },
 	];
 
@@ -382,4 +383,296 @@ __PACKAGE__->register_method ({
 	return;
     }
 });
+
+my $sendmail_properties = {
+    name => {
+	description => 'The name of the endpoint.',
+	type => 'string',
+	format => 'pve-configid',
+    },
+    recipient => {
+	type => 'array',
+	items => {
+	    type => 'string',
+	    format => 'email',
+	},
+	description => 'List of email recipients',
+    },
+    '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 => 'Filter to apply',
+	type => 'string',
+	format => 'pve-configid',
+	optional => 1,
+    },
+};
+
+my $sendmail_create_properties = {
+    name => {
+	type => 'string',
+	format => 'pve-configid',
+	description => 'The name of the endpoint.',
+    },
+    recipient => {
+	type => 'string',
+	format => 'email-list',
+	description => 'List of email recipients',
+    },
+    '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 => 'Filter to apply',
+	type => 'string',
+	format => 'pve-configid',
+	optional => 1,
+    },
+};
+
+# when updating, every property (except for 'name') becomes optional
+my $sendmail_update_properties = make_properties_optional($sendmail_create_properties);
+
+__PACKAGE__->register_method ({
+    name => 'get_sendmail_endpoints',
+    path => 'endpoints/sendmail',
+    method => 'GET',
+    description => 'Returns a list of all sendmail endpoints',
+    permissions => {
+	check => ['perm', '/', ['Sys.Audit']],
+    },
+    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 $endpoints = eval {
+	    $config->get_sendmail_endpoints()
+	};
+
+	raise_api_error($@) if ($@);
+	return $endpoints;
+
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'get_sendmail_endpoint',
+    path => 'endpoints/sendmail/{name}',
+    method => 'GET',
+    description => 'Return a specific sendmail endpoint',
+    permissions => {
+	check => ['perm', '/', ['Sys.Audit']],
+    },
+    protected => 1,
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    name => {
+		type => 'string',
+		format => 'pve-configid',
+	    },
+	}
+    },
+    returns => {
+	type => 'object',
+	properties => $sendmail_properties,
+    },
+    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 ($@);
+	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', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => $sendmail_create_properties,
+    },
+    returns => { type => 'null' },
+    code => sub {
+	my ($param) = @_;
+
+	my $name = extract_param($param, 'name');
+	my $recipient = extract_param($param, 'recipient');
+	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');
+
+
+	PVE::Notify::lock_config(sub {
+	    my $config = PVE::Notify::read_config();
+
+	    my $recipient_list = [PVE::Tools::split_list($recipient)];
+
+	    $config->add_sendmail_endpoint(
+		$name,
+		$recipient_list,
+		$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', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    %$sendmail_update_properties,
+	    delete => {
+		type => 'string',
+		format => 'pve-configid-list',
+		description => 'A list of settings you want to delete.',
+		maxLength => 4096,
+		optional => 1,
+	    },
+	    digest => get_standard_option('pve-config-digest'),
+
+	}
+    },
+    returns => { type => 'null' },
+    code => sub {
+	my ($param) = @_;
+
+	my $name = extract_param($param, 'name');
+	my $recipient = extract_param($param, 'recipient');
+	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');
+
+	if (defined $delete) {
+	    $delete = [PVE::Tools::split_list($delete)];
+	}
+
+	if (defined $recipient) {
+	    $recipient = [PVE::Tools::split_list($recipient)];
+	}
+
+	PVE::Notify::lock_config(sub {
+	    my $config = PVE::Notify::read_config();
+
+	    $config->update_sendmail_endpoint(
+		$name,
+		$recipient,
+		$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', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    name => {
+		type => 'string',
+		format => 'pve-configid',
+	    },
+	}
+    },
+    returns => { type => 'null' },
+    code => sub {
+	my ($param) = @_;
+
+	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;
-- 
2.30.2