cleanup firewall service implementation

[pve-firewall.git] / src / PVE / API2 / Firewall / Groups.pm

diff --git a/src/PVE/API2/Firewall/Groups.pm b/src/PVE/API2/Firewall/Groups.pm
index 0a6126afa0105642eb937e6c21f2aeec733872b9..9e4d08a4f260dd31e0a28268bff4ecc2c680379d 100644 (file)
--- a/src/PVE/API2/Firewall/Groups.pm
+++ b/src/PVE/API2/Firewall/Groups.pm
@@ -3,6 +3,7 @@ package PVE::API2::Firewall::Groups;
 use strict;
 use warnings;
 use PVE::JSONSchema qw(get_standard_option);
+use PVE::Exception qw(raise raise_param_exc);
 
 use PVE::Firewall;
 use PVE::API2::Firewall::Rules;
@@ -11,6 +12,25 @@ use Data::Dumper; # fixme: remove
 
 use base qw(PVE::RESTHandler);
 
+my $get_security_group_list = sub {
+    my ($cluster_conf) = @_;
+
+    my $res = [];
+    foreach my $group (keys %{$cluster_conf->{groups}}) {
+       my $data = { 
+           group => $group,
+       };
+       if (my $comment = $cluster_conf->{group_comments}->{$group}) {
+           $data->{comment} = $comment;
+       }
+       push @$res, $data;
+    }
+
+    my ($list, $digest) = PVE::Firewall::copy_list_with_digest($res);
+
+    return wantarray ? ($list, $digest) : $list;
+};
+
 __PACKAGE__->register_method({
     name => 'list_security_groups',
     path => '',
@@ -18,28 +38,29 @@ __PACKAGE__->register_method({
     description => "List security groups.",
     parameters => {
        additionalProperties => 0,
+       properties => {},
     },
     returns => {
        type => 'array',
        items => {
            type => "object",
            properties => { 
-               name => get_standard_option('pve-security-group-name'),
+               group => get_standard_option('pve-security-group-name'),
+               digest => get_standard_option('pve-config-digest', { optional => 0} ),
+               comment => { 
+                   type => 'string',
+                   optional => 1,
+               }
            },
        },
-       links => [ { rel => 'child', href => "{name}" } ],
+       links => [ { rel => 'child', href => "{group}" } ],
     },
     code => sub {
        my ($param) = @_;
 
        my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
 
-       my $res = [];
-       foreach my $group (keys %{$cluster_conf->{groups}}) {
-           push @$res, { name => $group, count => scalar(@{$cluster_conf->{groups}->{$group}}) };
-       }
-
-       return $res;
+       return &$get_security_group_list($cluster_conf);
     }});
 
 __PACKAGE__->register_method({
@@ -51,11 +72,16 @@ __PACKAGE__->register_method({
     parameters => {
        additionalProperties => 0,
        properties => { 
-           name => get_standard_option('pve-security-group-name'),
+           group => get_standard_option('pve-security-group-name'),
+           comment => {
+               type => 'string',
+               optional => 1,
+           },
            rename => get_standard_option('pve-security-group-name', {
-               description => "Rename an existing security group.",
+               description => "Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.",
                optional => 1,
            }),
+           digest => get_standard_option('pve-config-digest'),
        },
     },
     returns => { type => 'null' },
@@ -64,18 +90,27 @@ __PACKAGE__->register_method({
 
        my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
 
-       foreach my $name (keys %{$cluster_conf->{groups}}) {
-           raise_param_exc({ name => "Security group '$name' already exists" }) 
-               if $name eq $param->{name};
-       }
-
        if ($param->{rename}) {
-           raise_param_exc({ name => "Security group '$param->{rename}' does not exists" }) 
+           my (undef, $digest) = &$get_security_group_list($cluster_conf);
+           PVE::Tools::assert_if_modified($digest, $param->{digest});
+
+           raise_param_exc({ group => "Security group '$param->{rename}' does not exists" }) 
                if !$cluster_conf->{groups}->{$param->{rename}};
+
            my $data = delete $cluster_conf->{groups}->{$param->{rename}};
-           $cluster_conf->{groups}->{$param->{name}} = $data;
+           $cluster_conf->{groups}->{$param->{group}} = $data;
+           if (my $comment = delete $cluster_conf->{group_comments}->{$param->{rename}}) {
+               $cluster_conf->{group_comments}->{$param->{group}} = $comment;
+           }
+           $cluster_conf->{group_comments}->{$param->{group}} = $param->{comment} if defined($param->{comment});
        } else {
-           $cluster_conf->{groups}->{$param->{name}} = [];
+           foreach my $name (keys %{$cluster_conf->{groups}}) {
+               raise_param_exc({ group => "Security group '$name' already exists" }) 
+                   if $name eq $param->{group};
+           }
+
+           $cluster_conf->{groups}->{$param->{group}} = [];
+           $cluster_conf->{group_comments}->{$param->{group}} = $param->{comment} if defined($param->{comment});
        }
 
        PVE::Firewall::save_clusterfw_conf($cluster_conf);
@@ -83,18 +118,18 @@ __PACKAGE__->register_method({
        return undef;
     }});
 
-
 __PACKAGE__->register_method({
     name => 'delete_security_group',
-    path => '{name}',
+    path => '{group}',
     method => 'DELETE',
     description => "Delete security group.",
     protected => 1,
     parameters => {
        additionalProperties => 0,
        properties => { 
-           name => get_standard_option('pve-security-group-name'),
-       }
+           group => get_standard_option('pve-security-group-name'),
+           digest => get_standard_option('pve-config-digest'),
+       },
     },
     returns => { type => 'null' },
     code => sub {
@@ -102,12 +137,15 @@ __PACKAGE__->register_method({
            
        my $cluster_conf = PVE::Firewall::load_clusterfw_conf();
 
-       return undef if !$cluster_conf->{groups}->{$param->{name}};
+       return undef if !$cluster_conf->{groups}->{$param->{group}};
+
+       my (undef, $digest) = &$get_security_group_list($cluster_conf);
+       PVE::Tools::assert_if_modified($digest, $param->{digest});
 
-       die "Security group '$param->{name}' is not empty\n" 
-           if scalar(@{$cluster_conf->{groups}->{$param->{name}}});
+       die "Security group '$param->{group}' is not empty\n" 
+           if scalar(@{$cluster_conf->{groups}->{$param->{group}}});
 
-       delete $cluster_conf->{groups}->{$param->{name}};
+       delete $cluster_conf->{groups}->{$param->{group}};
 
        PVE::Firewall::save_clusterfw_conf($cluster_conf);