From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <d.csapak@proxmox.com>
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 0C502BFD7F
 for <pmg-devel@lists.proxmox.com>; Tue,  9 Jan 2024 14:59:39 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id DA7331808F
 for <pmg-devel@lists.proxmox.com>; Tue,  9 Jan 2024 14:59:08 +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 <pmg-devel@lists.proxmox.com>; Tue,  9 Jan 2024 14:59:07 +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 A95D149040
 for <pmg-devel@lists.proxmox.com>; Tue,  9 Jan 2024 14:59:07 +0100 (CET)
From: Dominik Csapak <d.csapak@proxmox.com>
To: pmg-devel@lists.proxmox.com
Date: Tue,  9 Jan 2024 14:59:04 +0100
Message-Id: <20240109135906.66200-5-d.csapak@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20240109135906.66200-1-d.csapak@proxmox.com>
References: <20240109135906.66200-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 -
Subject: [pmg-devel] [PATCH pmg-api 4/4] fix #2430: ruledb disclaimer: make
 separator configurable
X-BeenThere: pmg-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Mail Gateway development discussion
 <pmg-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/>
List-Post: <mailto:pmg-devel@lists.proxmox.com>
List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 09 Jan 2024 13:59:39 -0000

add a new 'add-separator' property (default true) that controls if the
'--' separator is added.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 src/PMG/RuleDB/Disclaimer.pm | 39 ++++++++++++++++++++++++++----------
 1 file changed, 28 insertions(+), 11 deletions(-)

diff --git a/src/PMG/RuleDB/Disclaimer.pm b/src/PMG/RuleDB/Disclaimer.pm
index 95e8b31..d7ccb03 100644
--- a/src/PMG/RuleDB/Disclaimer.pm
+++ b/src/PMG/RuleDB/Disclaimer.pm
@@ -49,7 +49,7 @@ If this e-mail or attached files contain information which do not relate to our
 _EOD_
 
 sub new {
-    my ($type, $value, $ogroup, $top) = @_;
+    my ($type, $value, $ogroup, $top, $separator) = @_;
 
     my $class = ref($type) || $type;
 
@@ -59,6 +59,7 @@ sub new {
 
     $self->{value} = $value;
     $self->{top} = $top;
+    $self->{separator} = $separator;
 
     return $self;
 }
@@ -76,14 +77,16 @@ sub load_attr {
     $sth->execute($id);
 
     my $top = 0;
+    my $separator = 1;
 
     while (my $ref = $sth->fetchrow_hashref()) {
 	$top = $ref->{value} if $ref->{name} eq 'top';
+	$separator = $ref->{value} if $ref->{name} eq 'separator';
     }
 
     $sth->finish();
 
-    my $obj = $class->new(decode('UTF-8', $value), $ogroup, $top);
+    my $obj = $class->new(decode('UTF-8', $value), $ogroup, $top, $separator);
 
     $obj->{id} = $id;
 
@@ -110,9 +113,11 @@ sub save {
 	    "UPDATE Object SET Value = ? WHERE ID = ?",
 	    undef, $value, $self->{id});
 
-	$ruledb->{dbh}->do(
-	    "DELETE FROM Attribut WHERE Name = ? and Object_ID = ?",
-	    undef, 'top',  $self->{id});
+	for my $prop (qw(top separator)) {
+	    $ruledb->{dbh}->do(
+		"DELETE FROM Attribut WHERE Name = ? and Object_ID = ?",
+		undef, $prop,  $self->{id});
+	}
     } else {
 	# insert
 
@@ -125,10 +130,12 @@ sub save {
 	$self->{id} = PMG::Utils::lastid($ruledb->{dbh}, 'object_id_seq');
     }
 
-    if (defined($self->{top})) {
-	$ruledb->{dbh}->do(
-	    "INSERT INTO Attribut (Value, Name, Object_ID) VALUES (?, ?, ?)",
-	    undef, $self->{top}, 'top',  $self->{id});
+    for my $prop (qw(top separator)) {
+	if (defined($self->{$prop})) {
+	    $ruledb->{dbh}->do(
+		"INSERT INTO Attribut (Value, Name, Object_ID) VALUES (?, ?, ?)",
+		undef, $self->{$prop}, $prop,  $self->{id});
+	}
     }
 
     return $self->{id};
@@ -227,10 +234,11 @@ sub execute {
     foreach my $ta (@$subgroups) {
 	my ($tg, $entity) = (@$ta[0], @$ta[1]);
 	my $html;
+	my $separator = $self->{separator} ? '<br>--<br>' : '<br>';
 	if ($self->{top}) {
-	    $html = PMG::Utils::subst_values ($self->{value}, $vars) . "<br>--<br>";
+	    $html = PMG::Utils::subst_values ($self->{value}, $vars) . $separator;
 	} else {
-	    $html = "<br>--<br>" . PMG::Utils::subst_values ($self->{value}, $vars);
+	    $html = $separator . PMG::Utils::subst_values ($self->{value}, $vars);
 	}
 
 	my $text = "";
@@ -271,6 +279,13 @@ sub properties {
 	    optional => 1,
 	    default => 0,
 	},
+	'add-separator' => {
+	    description => "If set to 1, adds a '--' separator between the disclaimer and the".
+		" content. Set to 0 to prevent that.",
+	    type => 'boolean',
+	    optional => 1,
+	    default => 1,
+	},
     };
 }
 
@@ -280,6 +295,7 @@ sub get {
     return {
 	disclaimer => $self->{value},
 	top => $self->{top},
+	'add-separator' => $self->{separator},
     };
 }
 
@@ -288,6 +304,7 @@ sub update {
 
     $self->{value} = $param->{disclaimer};
     $self->{top} = $param->{top};
+    $self->{separator} = $param->{'add-separator'};
 }
 
 1;
-- 
2.30.2