public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: Dominik Csapak <d.csapak@proxmox.com>
Cc: pmg-devel@lists.proxmox.com
Subject: Re: [pmg-devel] [PATCH pmg-api 04/12] api: refactor rule parameters
Date: Tue, 20 Feb 2024 12:49:31 +0100	[thread overview]
Message-ID: <20240220124931.79686d5f@rosa.proxmox.com> (raw)
In-Reply-To: <20240209125440.2572239-5-d.csapak@proxmox.com>

looks good to me - one nit inline:

On Fri,  9 Feb 2024 13:54:28 +0100
Dominik Csapak <d.csapak@proxmox.com> wrote:

> makes it easier to add new ones
> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
>  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 {





  reply	other threads:[~2024-02-20 11:50 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-09 12:54 [pmg-devel] [PATCH pmg-api/docs/gui] implement and combination and inversion of groups and objects Dominik Csapak
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 01/12] RuleCache: remove unnecessary copying of marks Dominik Csapak
2024-02-20 14:42   ` [pmg-devel] applied: " Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 02/12] RuleCache: reorganize to keep group structure Dominik Csapak
2024-02-20 14:45   ` [pmg-devel] applied: " Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 03/12] RuleCache: reorganize how we gather marks and spaminfo Dominik Csapak
2024-02-20 11:10   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 04/12] api: refactor rule parameters Dominik Csapak
2024-02-20 11:49   ` Stoiko Ivanov [this message]
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 05/12] add objectgroup attributes and/invert Dominik Csapak
2024-02-20 12:35   ` Stoiko Ivanov
2024-02-20 12:47   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 06/12] add rule attributes and/invert (for each relevant type) Dominik Csapak
2024-02-20 13:03   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 07/12] RuleCache: load rule/objectgroup attributes from database Dominik Csapak
2024-02-20 13:18   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 08/12] RuleCache: implement and/invert for when/from/to Dominik Csapak
2024-02-20 13:09   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 09/12] MailQueue: return maximum AID Dominik Csapak
2024-02-20 13:20   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 10/12] WIP: ModGroup: add possibility to explode to all targets Dominik Csapak
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 11/12] RuleCache: implement and/invert for what matches Dominik Csapak
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-api 12/12] pmgdb: extend dump output to include add/invert Dominik Csapak
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-docs 1/2] rule system: add a small section about matching rules Dominik Csapak
2024-02-20 14:47   ` [pmg-devel] applied: " Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-docs 2/2] rule system: explain new and mode and invert flag Dominik Csapak
2024-02-20 14:40   ` Stoiko Ivanov
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-gui 1/2] rules: use tree panel instead of grouping feature of the grid Dominik Csapak
2024-02-09 12:54 ` [pmg-devel] [PATCH pmg-gui 2/2] rules/objects: add mode selector dropdown Dominik Csapak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240220124931.79686d5f@rosa.proxmox.com \
    --to=s.ivanov@proxmox.com \
    --cc=d.csapak@proxmox.com \
    --cc=pmg-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal