[pmg-devel] [PATCH pmg-api v3 1/2] api: statistics: add common method for details

[Stoiko Ivanov]

This patch changes adds a new method, which yields the detail statistics
for a particular address.

Depending on the provided type argument it returns the same information as
the contact/sender/receiver detail calls.

This allows the statistics to be displayed for addresses containing
'/' in their localpart, once this is permitted in our api schema.

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

By adding a new API method we can eventually drop the old methods with 7.0

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

diff --git a/src/PMG/API2/Statistics.pm b/src/PMG/API2/Statistics.pm
index 72bfeb5..7de6d78 100644
--- a/src/PMG/API2/Statistics.pm
+++ b/src/PMG/API2/Statistics.pm
@@ -44,6 +44,7 @@ __PACKAGE__->register_method ({
 
 	return [
 	    { name => "contact" },
+	    { name => "detail" },
 	    { name => "domains" },
 	    { name => "mail" },
 	    { name => "mailcount" },
@@ -322,6 +323,62 @@ sub get_detail_statistics {
     return $res;
 }
 
+__PACKAGE__->register_method ({
+    name => 'detailstats',
+    path => 'detail',
+    method => 'GET',
+    description => "Detailed Statistics.",
+    permissions => { check => [ 'admin', 'qmanager', 'audit'] },
+    parameters => {
+	additionalProperties => 0,
+	properties => $default_properties->({
+	    type => {
+		description => "Type of statistics",
+		type => 'string',
+		enum => [ 'contact', 'sender', 'receiver' ],
+	    },
+	    address => get_standard_option('pmg-email-address', {
+		description => "Email address.",
+	    }),
+	    filter => {
+		description => "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. (for contact and receiver statistics)",
+		    type => 'string',
+		    optional => 1,
+		},
+		receiver => {
+		    description => "Receiver email. (for sender statistics)",
+		    type => 'string',
+		    optional => 1,
+		},
+	    }),
+	},
+    },
+    code => sub {
+	my ($param) = @_;
+
+	my $type = $param->{type};
+	$param->{$type} = $param->{address};
+
+	return get_detail_statistics($param->{type}, $param);
+    }});
+
+# FIXME: change for PMG 7.0 - remove support for providing addresses as path
+# addresses can contain '/' which breaks API path resolution - hardcode
+# 'detail' for the path pattern.
 __PACKAGE__->register_method ({
     name => 'contactdetails',
     path => 'contact/{contact}',
@@ -425,6 +482,9 @@ __PACKAGE__->register_method ({
 	return $res;
     }});
 
+# FIXME: change for PMG 7.0 - remove support for providing addresses as path
+# addresses can contain '/' which breaks API path resolution - hardcode
+# 'detail' for the path pattern.
 __PACKAGE__->register_method ({
     name => 'senderdetails',
     path => 'sender/{sender}',
@@ -536,6 +596,9 @@ __PACKAGE__->register_method ({
 	return $res;
     }});
 
+# FIXME: change for PMG 7.0 - remove support for providing addresses as path
+# addresses can contain '/' which breaks API path resolution - hardcode
+# 'detail' for the path pattern.
 __PACKAGE__->register_method ({
     name => 'receiverdetails',
     path => 'receiver/{receiver}',
-- 
2.20.1