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)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id EC1419247E for ; Thu, 1 Feb 2024 16:37:28 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id CD42712D05 for ; Thu, 1 Feb 2024 16:36:58 +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)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Thu, 1 Feb 2024 16:36:58 +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 1810141F97 for ; Thu, 1 Feb 2024 16:36:58 +0100 (CET) From: Dominik Csapak To: pmg-devel@lists.proxmox.com Date: Thu, 1 Feb 2024 16:36:50 +0100 Message-Id: <20240201153657.1067215-5-d.csapak@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20240201153657.1067215-1-d.csapak@proxmox.com> References: <20240201153657.1067215-1-d.csapak@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.020 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. [rules.pm, ruledb.pm] Subject: [pmg-devel] [RFC PATCH pmg-api 04/11] 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: Thu, 01 Feb 2024 15:37:29 -0000 makes it easier to add new ones Signed-off-by: Dominik Csapak --- src/PMG/API2/RuleDB.pm | 22 ++--------------- src/PMG/API2/Rules.pm | 54 ++++++++++++++++++++++++++---------------- 2 files changed, 35 insertions(+), 41 deletions(-) diff --git a/src/PMG/API2/RuleDB.pm b/src/PMG/API2/RuleDB.pm index 1fddb32..928b690 100644 --- a/src/PMG/API2/RuleDB.pm +++ b/src/PMG/API2/RuleDB.pm @@ -162,30 +162,12 @@ __PACKAGE__->register_method({ permissions => { check => [ 'admin' ] }, parameters => { additionalProperties => 0, - properties => { + properties => PMG::API2::Rules::get_rule_params({ name => { description => "Rule name", type => 'string', }, - priority => { - description => "Rule priotity.", - type => 'integer', - 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 { diff --git a/src/PMG/API2/Rules.pm b/src/PMG/API2/Rules.pm index 4f8c10b..f9e69e2 100644 --- a/src/PMG/API2/Rules.pm +++ b/src/PMG/API2/Rules.pm @@ -136,6 +136,37 @@ __PACKAGE__->register_method ({ return $data; }}); +my $rule_params = { + priority => { + description => "Rule priotity.", + type => 'integer', + 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, + }, +}; + +sub get_rule_params { + my ($base) = @_; + $base //= {}; + return { + $base->%*, + $rule_params->%* + }; +} + + __PACKAGE__->register_method ({ name => 'update_config', path => 'config', @@ -146,7 +177,7 @@ __PACKAGE__->register_method ({ permissions => { check => [ 'admin' ] }, parameters => { additionalProperties => 0, - properties => { + properties => get_rule_params({ id => { description => "Rule ID.", type => 'integer', @@ -156,26 +187,7 @@ __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', - minimum => 0, - maximum => 100, - optional => 1, - }, - }, + }), }, returns => { type => "null" }, code => sub { -- 2.30.2