public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH pmg-api 2/5] ruledb: add deprecation warnings for unused actions
Date: Wed,  9 Nov 2022 19:27:25 +0100	[thread overview]
Message-ID: <20221109182728.629576-3-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20221109182728.629576-1-s.ivanov@proxmox.com>

* ReportSpam
* Attach
* Counter

are all still present since (at least) the release of PMG 5.0, but
were never exposed in the API/GUI.

All of them in their current form don't seem to fit well nowadays, or
their functionality was taken over by some other Action:
* Attach - the functionality is currently present in the Notify action
  (attach original mail)
* Counter - without a matching What object simply increasing a counter
  by one in the database serves no purpose
* ReportSpam - sending potentially sensitive mail automatically to the
  public SpamAssassin project does not seem to fit well nowadays

Instead of dropping them right away - this patch adds logging when
they are encountered while loading or when they are run, to keep
backwards-compatibility for users who have very long-running PMG
instances (not sure if the actions were ever used in the pre git-days
of PMG)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
 src/PMG/RuleDB.pm            | 14 +++++++++++++-
 src/PMG/RuleDB/Attach.pm     |  7 +++++++
 src/PMG/RuleDB/Counter.pm    |  5 +++++
 src/PMG/RuleDB/ReportSpam.pm |  5 +++++
 4 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/src/PMG/RuleDB.pm b/src/PMG/RuleDB.pm
index faed404..895acc6 100644
--- a/src/PMG/RuleDB.pm
+++ b/src/PMG/RuleDB.pm
@@ -289,7 +289,14 @@ sub load_objectgroups {
 sub get_object {
     my ($self, $otype) = @_;
 
-     my $obj;
+    my $obj;
+
+    # FIXME: remove deprecated types and files with PMG 8.0
+    my $deprecated_types = {
+	4004 => "Attach",
+	4008 => "ReportSpam",
+	4999 => "Counter",
+    };
 
     # WHO OBJECTS
     if ($otype == PMG::RuleDB::Domain::otype()) {
@@ -386,9 +393,14 @@ sub get_object {
 	    die "proxmox: unknown object type: ERROR";
     }
 
+    if ( grep( $_ == $otype, keys %$deprecated_types)) {
+	syslog('warning', "proxmox: deprecated object of type %s found!",
+	    $deprecated_types->{$otype});
+    }
     return $obj;
 }
 
+# FIXME: remove with PMG 8.0
 sub load_counters_data {
     my ($self) = @_;
 
diff --git a/src/PMG/RuleDB/Attach.pm b/src/PMG/RuleDB/Attach.pm
index 78b2749..cdb9d89 100644
--- a/src/PMG/RuleDB/Attach.pm
+++ b/src/PMG/RuleDB/Attach.pm
@@ -1,10 +1,14 @@
 package PMG::RuleDB::Attach;
 
+# FIXME: remove with PMG 8.0
+
 use strict;
 use warnings;
 use DBI;
 use Digest::SHA;
 
+use PVE::SafeSyslog;
+
 use PMG::Utils;
 use PMG::ModGroup;
 use PMG::RuleDB::Object;
@@ -84,6 +88,9 @@ sub execute {
     my ($self, $queue, $ruledb, $mod_group, $targets,
 	$msginfo, $vars, $marks) = @_;
 
+    syslog('warning', "%s: deprecated action 'Attach' will be removed with PMG 8.0.",
+	   $queue->{logid},);
+
     my $subgroups = $mod_group->subgroups($targets);
 
     foreach my $ta (@$subgroups) {
diff --git a/src/PMG/RuleDB/Counter.pm b/src/PMG/RuleDB/Counter.pm
index 9872ab0..6c7721b 100644
--- a/src/PMG/RuleDB/Counter.pm
+++ b/src/PMG/RuleDB/Counter.pm
@@ -1,5 +1,7 @@
 package PMG::RuleDB::Counter;
 
+# FIXME: remove with PMG 8.0
+
 use strict;
 use warnings;
 use DBI;
@@ -87,6 +89,9 @@ sub execute {
     my ($self, $queue, $ruledb, $mod_group, $targets, 
 	$msginfo, $vars, $marks) = @_;
 
+    syslog('warning', "%s: deprecated action 'Counter' will be removed with PMG 8.0.",
+	   $queue->{logid},);
+
     eval {
 	$ruledb->{dbh}->begin_work;
 	
diff --git a/src/PMG/RuleDB/ReportSpam.pm b/src/PMG/RuleDB/ReportSpam.pm
index e0ac004..c8ae9bd 100644
--- a/src/PMG/RuleDB/ReportSpam.pm
+++ b/src/PMG/RuleDB/ReportSpam.pm
@@ -1,5 +1,7 @@
 package PMG::RuleDB::ReportSpam;
 
+# FIXME: remove with PMG 8.0
+
 use strict;
 use warnings;
 use DBI;
@@ -85,6 +87,9 @@ sub execute {
     my ($self, $queue, $ruledb, $mod_group, $targets, 
 	$msginfo, $vars, $marks) = @_;
 
+    syslog('warning', "%s: deprecated action 'Attach' will be removed with PMG 8.0.",
+	   $queue->{logid},);
+
     my $rulename = $vars->{RULE} // 'unknown';
 
     my $subgroups = $mod_group->subgroups($targets);
-- 
2.30.2





  parent reply	other threads:[~2022-11-09 18:28 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-09 18:27 [pmg-devel] [PATCH pmg-api 0/5] ruledb - improve experience for non-ascii tests and mails Stoiko Ivanov
2022-11-09 18:27 ` [pmg-devel] [PATCH pmg-api 1/5] ruledb: modfield: properly encode field after variable substitution Stoiko Ivanov
2022-11-11 13:56   ` [pmg-devel] applied: " Thomas Lamprecht
2022-11-09 18:27 ` Stoiko Ivanov [this message]
2022-11-14 16:02   ` [pmg-devel] [PATCH pmg-api 2/5] ruledb: add deprecation warnings for unused actions Dominik Csapak
2022-11-15 14:32   ` [pmg-devel] applied: " Thomas Lamprecht
2022-11-09 18:27 ` [pmg-devel] [PATCH pmg-api 3/5] fix #2541 ruledb: encode relevant values as utf-8 in database Stoiko Ivanov
2022-11-14 14:36   ` Dominik Csapak
2022-11-09 18:27 ` [pmg-devel] [PATCH pmg-api 4/5] ruledb: encode e-mail addresses for syslog Stoiko Ivanov
2022-11-14 14:49   ` Dominik Csapak
2022-11-09 18:27 ` [pmg-devel] [PATCH pmg-api 5/5] partially fix #2465: handle smtputf8 addresses in the rule-system Stoiko Ivanov
2022-11-14 16:03   ` Dominik Csapak
2022-11-14 16:02 ` [pmg-devel] [PATCH pmg-api 0/5] ruledb - improve experience for non-ascii tests and mails 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=20221109182728.629576-3-s.ivanov@proxmox.com \
    --to=s.ivanov@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