[pmg-devel] [PATCH pmg-api 4/5] api: statistics: make email a parameter

[Stoiko Ivanov]

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 at 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