[pve-devel] [PATCH v2 pve-manager 40/42] api: add api routes for notification filters

[Lukas Wagner]

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

diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm
index 823e8107..61deb9b3 100644
--- a/PVE/API2/Cluster/Notifications.pm
+++ b/PVE/API2/Cluster/Notifications.pm
@@ -59,6 +59,7 @@ __PACKAGE__->register_method ({
     code => sub {
 	my $result = [
 	    { name => 'endpoints' },
+	    { name => 'filters' },
 	    { name => 'channels' },
 	];
 
@@ -932,4 +933,330 @@ __PACKAGE__->register_method ({
 	return;
     }
 });
+
+my $filter_properties = {
+    name => {
+	description => 'Name of the endpoint.',
+	type => 'string',
+	format => 'pve-configid',
+    },
+    'min-severity' => {
+	type => 'string',
+	description => 'Minimum severity to match',
+	optional => 1,
+	enum => [qw(info notice warning error)],
+    },
+    'sub-filter' => {
+	type => 'array',
+	items => {
+	    type => 'string',
+	    format => 'pve-configid',
+	},
+	description => 'List of sub-filters',
+	optional => 1,
+    },
+    mode => {
+	type => 'string',
+	description => "Choose between 'and' and 'or' for when multiple properties are specified",
+	optional => 1,
+    },
+    'match-property' => {
+	type => 'array',
+	items => {
+	    type => 'string',
+	},
+	description => 'Properties to match (exact match)',
+	optional => 1,
+    },
+    'invert-match' => {
+	type => 'boolean',
+	description => 'Invert match of the whole filter',
+	optional => 1,
+    },
+    'comment' => {
+	description => 'Comment',
+	type        => 'string',
+	optional    => 1,
+    },
+};
+
+my $filter_create_properties = {
+    name => {
+	description => 'Name of the filter.',
+	type => 'string',
+	format => 'pve-configid',
+    },
+    'min-severity' => {
+	type => 'string',
+	description => 'Minimum severity to match',
+	optional => 1,
+	enum => [qw(info notice warning error)],
+    },
+    'sub-filter' => {
+	type => 'string',
+	format => 'pve-configid-list',
+	description => 'List of sub-filters',
+	optional => 1,
+    },
+    mode => {
+	type => 'string',
+	description => "Choose between 'and' and 'or' for when multiple properties are specified",
+	optional => 1,
+	enum => [qw(and or)],
+    },
+    'match-property' => {
+	type => 'string',
+	format => 'string-list',
+	description => 'Properties to match (exact match)',
+	optional => 1,
+    },
+    'invert-match' => {
+	type => 'boolean',
+	description => 'Invert match of the whole filter',
+	optional => 1,
+    },
+    'comment' => {
+	description => 'Comment',
+	type        => 'string',
+	optional    => 1,
+    },
+};
+
+# when updating, every property (except for 'name') becomes optional
+my $filter_update_properties = make_properties_optional($filter_create_properties);
+
+__PACKAGE__->register_method ({
+    name => 'get_filters',
+    path => 'filters',
+    method => 'GET',
+    description => 'Returns a list of all filters',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/', ['Sys.Audit']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {},
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => 'object',
+	    properties => {
+		%$filter_properties,
+	    },
+	},
+	links => [ { rel => 'child', href => '{name}' } ],
+    },
+    code => sub {
+	my $config = PVE::Notify::read_config();
+	my $filters = eval {
+	    $config->get_filters()
+	};
+
+	raise_api_error($@) if ($@);
+	return $filters;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'get_fiter',
+    path => 'filters/{name}',
+    method => 'GET',
+    description => 'Return a specific filter',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/', ['Sys.Audit']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    name => {
+		type => 'string',
+		format => 'pve-configid',
+	    },
+	}
+    },
+    returns => {
+	type => 'object',
+	properties => {
+	    %$filter_properties,
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+	my $name = extract_param($param, 'name');
+
+	my $config = PVE::Notify::read_config();
+
+	my $filter = eval {
+	    $config->get_filter($name)
+	};
+
+	raise_api_error($@) if ($@);
+	return $filter;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'create_filter',
+    path => 'filters',
+    protected => 1,
+    method => 'POST',
+    description => 'Create a new filter',
+    protected => 1,
+    permissions => {
+	check => ['perm', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => $filter_create_properties,
+    },
+    returns => { type => 'null' },
+    code => sub {
+	my ($param) = @_;
+
+	my $name = extract_param($param, 'name');
+	my $min_severity = extract_param($param, 'min-severity');
+	my $sub_filter = extract_param($param, 'sub-filter');
+	my $mode = extract_param($param, 'mode');
+	my $invert_match = extract_param($param, 'invert-match');
+	my $match_property = extract_param($param, 'match-property');
+	my $comment = extract_param($param, 'comment');
+
+	if (defined $sub_filter) {
+	    $sub_filter = [PVE::Tools::split_list($sub_filter)];
+	}
+
+	if (defined $match_property) {
+	    $match_property = [PVE::Tools::split_list($match_property)];
+	}
+
+	PVE::Notify::lock_config(sub {
+	    my $config = PVE::Notify::read_config();
+
+	    $config->add_filter(
+		$name,
+		$min_severity,
+		$sub_filter,
+		$mode,
+		$match_property,
+		$invert_match,
+		$comment,
+	    );
+
+	    PVE::Notify::write_config($config);
+	});
+
+	raise_api_error($@) if ($@);
+	return;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'update_filter',
+    path => 'filters/{name}',
+    protected => 1,
+    method => 'PUT',
+    description => 'Update existing filter',
+    permissions => {
+	check => ['perm', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    %$filter_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 $min_severity = extract_param($param, 'min-severity');
+	my $sub_filter = extract_param($param, 'sub-filter');
+	my $mode = extract_param($param, 'mode');
+	my $invert_match = extract_param($param, 'invert-match');
+	my $comment = extract_param($param, 'comment');
+	my $digest = extract_param($param, 'digest');
+	my $match_property = extract_param($param, 'match-property');
+	my $delete = extract_param($param, 'delete');
+
+	if (defined $sub_filter) {
+	    $sub_filter = [PVE::Tools::split_list($sub_filter)];
+	}
+
+	if (defined $match_property) {
+	    $match_property = [PVE::Tools::split_list($match_property)];
+	}
+
+	if (defined $delete) {
+	    $delete = [PVE::Tools::split_list($delete)];
+	}
+
+	PVE::Notify::lock_config(sub {
+	    my $config = PVE::Notify::read_config();
+
+	    $config->update_filter(
+		$name,
+		$min_severity,
+		$sub_filter,
+		$mode,
+		$match_property,
+		$invert_match,
+		$comment,
+		$delete,
+		$digest,
+	    );
+
+	    PVE::Notify::write_config($config);
+	});
+
+	raise_api_error($@) if ($@);
+	return;
+    }
+});
+
+__PACKAGE__->register_method ({
+    name => 'delete_filter',
+    protected => 1,
+    path => 'filters/{name}',
+    method => 'DELETE',
+    description => 'Remove filter',
+    permissions => {
+	check => ['perm', '/', ['Sys.Modify']],
+    },
+    parameters => {
+	additionalProperties => 0,
+	properties => {
+	    name => {
+		type => 'string',
+		format => 'pve-configid',
+	    },
+	}
+    },
+    returns => { type => 'null' },
+    code => sub {
+	my ($param) = @_;
+	my $name = extract_param($param, 'name');
+
+	PVE::Notify::lock_config(sub {
+	    my $config = PVE::Notify::read_config();
+	    $config->delete_filter($name);
+	    PVE::Notify::write_config($config);
+	});
+
+	raise_api_error($@) if ($@);
+	return;
+    }
+});
+
 1;
-- 
2.30.2