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) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 3CEE393813 for ; Tue, 20 Feb 2024 12:50:04 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 18DF76142 for ; Tue, 20 Feb 2024 12:49:34 +0100 (CET) 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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 20 Feb 2024 12:49:33 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id D1B2C43F43 for ; Tue, 20 Feb 2024 12:49:32 +0100 (CET) Date: Tue, 20 Feb 2024 12:49:31 +0100 From: Stoiko Ivanov To: Dominik Csapak Cc: pmg-devel@lists.proxmox.com Message-ID: <20240220124931.79686d5f@rosa.proxmox.com> In-Reply-To: <20240209125440.2572239-5-d.csapak@proxmox.com> References: <20240209125440.2572239-1-d.csapak@proxmox.com> <20240209125440.2572239-5-d.csapak@proxmox.com> X-Mailer: Claws Mail 4.1.1 (GTK 3.24.38; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.086 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 - URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [ruledb.pm, rules.pm] Subject: Re: [pmg-devel] [PATCH pmg-api 04/12] api: refactor rule parameters X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 20 Feb 2024 11:50:04 -0000 looks good to me - one nit inline: On Fri, 9 Feb 2024 13:54:28 +0100 Dominik Csapak wrote: > makes it easier to add new ones > > Signed-off-by: Dominik Csapak > --- > src/PMG/API2/RuleDB.pm | 20 ++++++-------------- > src/PMG/API2/Rules.pm | 41 +++++++++++++++++++++++++++-------------- > 2 files changed, 33 insertions(+), 28 deletions(-) > > diff --git a/src/PMG/API2/RuleDB.pm b/src/PMG/API2/RuleDB.pm > index 1fddb32..064e72f 100644 > --- a/src/PMG/API2/RuleDB.pm > +++ b/src/PMG/API2/RuleDB.pm > @@ -162,7 +162,7 @@ __PACKAGE__->register_method({ > permissions => { check => [ 'admin' ] }, > parameters => { > additionalProperties => 0, > - properties => { > + properties => PMG::API2::Rules::get_rule_params({ > name => { > description => "Rule name", > type => 'string', > @@ -173,19 +173,7 @@ __PACKAGE__->register_method({ > minimum => 0, > maximum => 100, > }, > - direction => { > - description => "Rule direction. Value `0` matches incoming mails, value `1` matches outgoing mails, and value `2` matches both directions.", > - type => 'integer', > - minimum => 0, > - maximum => 2, > - optional => 1, > - }, > - active => { > - description => "Flag to activate rule.", > - type => 'boolean', > - optional => 1, > - }, > - }, > + }), > }, > returns => { type => 'integer' }, > code => sub { > @@ -196,6 +184,10 @@ __PACKAGE__->register_method({ > my $rule = PMG::RuleDB::Rule->new ( > $param->{name}, $param->{priority}, $param->{active}, $param->{direction}); you could remove active and direction here, as they get set > > + for my $key (keys PMG::API2::Rules::get_rule_params()->%*) { > + $rule->{$key} = $param->{$key} if defined($param->{$key}); > + } > + here (also PMG::RuleDB::Rule::new could probably be made shorter (and the get/set methods could add an explicit 'return' but as said - only a nit and not really related. > return $rdb->save_rule($rule); > }}); > > diff --git a/src/PMG/API2/Rules.pm b/src/PMG/API2/Rules.pm > index 4f8c10b..c48370f 100644 > --- a/src/PMG/API2/Rules.pm > +++ b/src/PMG/API2/Rules.pm > @@ -136,6 +136,31 @@ __PACKAGE__->register_method ({ > return $data; > }}); > > +my $rule_params = { > + direction => { > + description => "Rule direction. Value `0` matches incoming mails, value `1` matches outgoing mails, and value `2` matches both directions.", > + type => 'integer', > + minimum => 0, > + maximum => 2, > + optional => 1, > + }, > + active => { > + description => "Flag to activate rule.", > + type => 'boolean', > + optional => 1, > + }, > +}; > + > +sub get_rule_params { > + my ($base) = @_; > + $base //= {}; > + return { > + $base->%*, > + $rule_params->%* > + }; > +} > + > + > __PACKAGE__->register_method ({ > name => 'update_config', > path => 'config', > @@ -146,7 +171,7 @@ __PACKAGE__->register_method ({ > permissions => { check => [ 'admin' ] }, > parameters => { > additionalProperties => 0, > - properties => { > + properties => get_rule_params({ > id => { > description => "Rule ID.", > type => 'integer', > @@ -156,18 +181,6 @@ __PACKAGE__->register_method ({ > type => 'string', > optional => 1, > }, > - active => { > - description => "Flag to activate rule.", > - type => 'boolean', > - optional => 1, > - }, > - direction => { > - description => "Rule direction. Value `0` matches incoming mails, value `1` matches outgoing mails, and value `2` matches both directions.", > - type => 'integer', > - minimum => 0, > - maximum => 2, > - optional => 1, > - }, > priority => { > description => "Rule priotity.", > type => 'integer', > @@ -175,7 +188,7 @@ __PACKAGE__->register_method ({ > maximum => 100, > optional => 1, > }, > - }, > + }), > }, > returns => { type => "null" }, > code => sub {