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 4/5] api: statistics: make email a parameter
Date: Fri, 15 Jan 2021 10:46:24 +0100	[thread overview]
Message-ID: <20210115094626.25440-5-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20210115094626.25440-1-s.ivanov@proxmox.com>

This patch adds additional endpoints for the detailed contact, sender
and receiver statistics.

instead of passing the e-mail address as path component it is taken
as explicit parameter.

the idea follows a similar change for the user blocklists in
e8d909c11faeb5a4f84f39ef50e0eaf8ea65046d

sadly the path-prefix without pattern (/contact, /sender, /receiver)
is already used (for the list of e-mail addresses), thus the
alternative paths /contacts, /senders/, /receivers are introduced
to maintain backward compatibility.

The new api calls allow the statistics to be displayed for addresses
containing '/' in their localpart, once this is permitted in our api
schema.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
 src/PMG/API2/Statistics.pm | 137 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 134 insertions(+), 3 deletions(-)

diff --git a/src/PMG/API2/Statistics.pm b/src/PMG/API2/Statistics.pm
index ffddbbe..e09d746 100644
--- a/src/PMG/API2/Statistics.pm
+++ b/src/PMG/API2/Statistics.pm
@@ -44,6 +44,7 @@ __PACKAGE__->register_method ({
 
 	return [
 	    { name => "contact" },
+	    { name => "contacts" },
 	    { name => "domains" },
 	    { name => "mail" },
 	    { name => "mailcount" },
@@ -52,8 +53,10 @@ __PACKAGE__->register_method ({
 	    { name => "maildistribution" },
 	    { name => "spamscores" },
 	    { name => "sender" },
+	    { name => "senders" },
 	    { name => "rblcount" },
 	    { name => "receiver" },
+	    { name => "receivers" },
 	    { name => "virus" },
 	];
     }});
@@ -312,11 +315,54 @@ sub get_detail_statistics {
     return $res;
 }
 
+__PACKAGE__->register_method ({
+    name => 'contactdetails_base',
+    path => 'contacts',
+    method => 'GET',
+    description => "Detailed Contact Statistics.",
+    permissions => { check => [ 'admin', 'qmanager', 'audit'] },
+    parameters => {
+	additionalProperties => 0,
+	properties => $default_properties->({
+	    contact => get_standard_option('pmg-email-address', {
+		description => "Contact email address.",
+	    }),
+	    filter => {
+		description => "Sender address filter.",
+		type => 'string',
+		maxLength => 512,
+		optional => 1,
+	    },
+	    orderby => $api_properties->{orderby},
+	}),
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		%detail_return_properties,
+		sender => {
+		    description => "Sender email.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return get_detail_statistics('contact', $param);
+    }});
+
+
+# FIXME: remove for PMG 7.0 - addresses can contain stuff like '/' which breaks
+# API path resolution, thus we replaced it by above "un-templated" call
 __PACKAGE__->register_method ({
     name => 'contactdetails',
     path => 'contact/{contact}',
     method => 'GET',
-    description => "Detailed Contact Statistics.",
+    description => "Detailed Contact Statistics. DEPRECATED: use /statistics/contacts instead.",
     permissions => { check => [ 'admin', 'qmanager', 'audit'] },
     parameters => {
 	additionalProperties => 0,
@@ -416,11 +462,54 @@ __PACKAGE__->register_method ({
 	return $res;
     }});
 
+__PACKAGE__->register_method ({
+    name => 'senderdetails_base',
+    path => 'senders',
+    method => 'GET',
+    description => "Detailed Sender Statistics.",
+    permissions => { check => [ 'admin', 'qmanager', 'audit'] },
+    parameters => {
+	additionalProperties => 0,
+	properties => $default_properties->({
+	    sender => get_standard_option('pmg-email-address', {
+		description => "Sender email address.",
+	    }),
+	    filter => {
+		description => "Receiver address filter.",
+		type => 'string',
+		maxLength => 512,
+		optional => 1,
+	    },
+	    orderby => $api_properties->{orderby},
+	}),
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		%detail_return_properties,
+		receiver => {
+		    description => "Receiver email.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return get_detail_statistics('sender', $param);
+    }});
+
+
+# FIXME: remove for PMG 7.0 - addresses can contain stuff like '/' which breaks
+# API path resolution, thus we replaced it by above "un-templated" call
 __PACKAGE__->register_method ({
     name => 'senderdetails',
     path => 'sender/{sender}',
     method => 'GET',
-    description => "Detailed Sender Statistics.",
+    description => "Detailed Sender Statistics. DEPRECATED: use /statistics/senders instead.",
     permissions => { check => [ 'admin', 'qmanager', 'audit'] },
     parameters => {
 	additionalProperties => 0,
@@ -528,11 +617,53 @@ __PACKAGE__->register_method ({
 	return $res;
     }});
 
+__PACKAGE__->register_method ({
+    name => 'receiverdetails_base',
+    path => 'receivers',
+    method => 'GET',
+    description => "Detailed Receiver Statistics.",
+    permissions => { check => [ 'admin', 'qmanager', 'audit'] },
+    parameters => {
+	additionalProperties => 0,
+	properties => $default_properties->({
+	    receiver => get_standard_option('pmg-email-address', {
+		description => "Receiver email address.",
+	    }),
+	    filter => {
+		description => "Sender address filter.",
+		type => 'string',
+		maxLength => 512,
+		optional => 1,
+	    },
+	    orderby => $api_properties->{orderby},
+	}),
+    },
+    returns => {
+	type => 'array',
+	items => {
+	    type => "object",
+	    properties => {
+		%detail_return_properties,
+		sender => {
+		    description => "Sender email.",
+		    type => 'string',
+		},
+	    },
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	return get_detail_statistics('receiver', $param);
+    }});
+
+# FIXME: remove for PMG 7.0 - addresses can contain stuff like '/' which breaks
+# API path resolution, thus we replaced it by above "un-templated" call
 __PACKAGE__->register_method ({
     name => 'receiverdetails',
     path => 'receiver/{receiver}',
     method => 'GET',
-    description => "Detailed Receiver Statistics.",
+    description => "Detailed Receiver Statistics. DEPRECATED: use /statistics/receivers instead.",
     permissions => { check => [ 'admin', 'qmanager', 'audit'] },
     parameters => {
 	additionalProperties => 0,
-- 
2.20.1





  parent reply	other threads:[~2021-01-15  9:46 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-15  9:46 [pmg-devel] [PATCH pmg-api/pmg-gui] allow / in local part of pmg-email-address Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 1/5] api: statistics: remove unneeded RESTEnvironment Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 2/5] api: statistics: refactor return for detail calls Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 3/5] api: statistics: refactor " Stoiko Ivanov
2021-01-15  9:46 ` Stoiko Ivanov [this message]
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 5/5] utils: allow '/' inside email address localpart Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-gui 1/1] statistics: use new api call for detailed stats Stoiko Ivanov

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=20210115094626.25440-5-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