diff --git a/api/api.py b/api/api.py
index d9523bcadd5d8e11579c794966ccbb5999ca4020..d06974a76c79eb7d1da90f1a9fd5fd25adeb9c38 100644
--- a/api/api.py
+++ b/api/api.py
@@ -19,6 +19,7 @@ from handlers import containerhandler
from handlers import collectionshandler
from handlers import searchhandler
from handlers import schemahandler
+from handlers import reporthandler
log = config.log
@@ -252,6 +253,7 @@ routes = [
webapp2.Route(_format(r'/api/search/files'), searchhandler.SearchHandler, handler_method='get_datatree', name='es_data', methods=['GET']),
webapp2.Route(_format(r'/api/search/<cont_name:{cont_name_re}>'), searchhandler.SearchHandler, name='es_proxy', methods=['GET']),
webapp2.Route(_format(r'/api/schemas/<schema:{schema_re}>'), schemahandler.SchemaHandler, name='schemas', methods=['GET']),
+ webapp2.Route(r'/api/report/<report_type:site|project>', reporthandler.ReportHandler, methods=['GET']),
]
diff --git a/api/handlers/reporthandler.py b/api/handlers/reporthandler.py
new file mode 100644
index 0000000000000000000000000000000000000000..52347e5150d5b855a825b703807be7d0c75bd027
--- /dev/null
+++ b/api/handlers/reporthandler.py
@@ -0,0 +1,259 @@
+import json
+import bson
+import dateutil
+import copy
+
+from .. import base
+from .. import config
+from .. import util
+
+log = config.log
+
+EIGHTEEN_YEARS_IN_SEC = 18 * 365.25 * 24 * 60 * 60
+
+class APIReportException(Exception):
+ pass
+
+class ReportHandler(base.RequestHandler):
+
+ def __init__(self, request=None, response=None):
+ super(ReportHandler, self).__init__(request, response)
+
+ def get(self, report_type, **kwargs):
+ report = None
+ if report_type == 'site':
+ report = SiteReport()
+
+ elif report_type == 'project':
+ project_list = self.request.GET.getall('projects')
+ start_date = self.get_param('start_date')
+ end_date = self.get_param('end_date')
+
+ if len(project_list) < 1:
+ self.abort(400, 'List of projects requried for Project Report')
+ if start_date is not None:
+ start_date = dateutil.parser.parse(self.get_param('start_date'))
+ if end_date is not None:
+ end_date = dateutil.parser.parse(self.get_param('end_date'))
+ if end_date is not None and start_date is not None and end_date < start_date:
+ self.abort(400, 'End date {} is before start date {}'.format(end_date, start_date))
+
+ report = ProjectReport(map(bson.ObjectId, project_list),
+ start_date=start_date,
+ end_date=end_date)
+
+ else:
+ # They should never even get this far because of filtering in api.py
+ self.abort(400, 'The report type {} is not supported'.format(report_type))
+
+ if self.superuser_request or report.user_can_generate(self.uid):
+ return report.build()
+ else:
+ self.abort(403, 'User {} does not have required permissions to generate report'.format(self.uid))
+
+
+def _get_result(output):
+ """
+ Helper function for extracting mongo aggregation results
+
+ Given the output of a mongo aggregation call, checks 'ok' field
+ If not 1.0 or 'result' field does not exist, throws APIReportException
+ """
+
+ if output.get('ok', 0) is not 1.0:
+ result = output.get('result')
+ if result is not None:
+ return result[0] if len(result) > 0 else {}
+
+ raise APIReportException
+
+class Report(object):
+
+ def user_can_generate(self, uid):
+ """
+ Check if user has required permissions to generate report
+ """
+ raise NotImplementedError()
+
+ def build(self):
+ """
+ Build and return a json report
+ """
+ raise NotImplementedError()
+
+
+class SiteReport(Report):
+ """
+ Report of statistics about the site, generated by Site Managers
+
+ Report includes:
+ - number of groups
+ - number of projects per group
+ - number of sessions per group
+ """
+
+ def user_can_generate(self, uid):
+ """
+ User generating report must be superuser
+ """
+ if config.db.users.count({'_id': uid, 'root': True}) > 0:
+ return True
+ return False
+
+ def build(self):
+ report = {}
+
+ groups = config.db.groups.find({})
+ report['group_count'] = groups.count()
+ report['groups'] = []
+
+ for g in groups:
+ group = {}
+ group['name'] = g.get('name')
+
+ project_ids = [p['_id'] for p in config.db.projects.find({'group': g['_id']}, [])]
+ group['project_count'] = len(project_ids)
+
+ group['session_count'] = config.db.sessions.count({'project': {'$in': project_ids}})
+ report['groups'].append(group)
+
+ return report
+
+
+class ProjectReport(Report):
+ """
+ Report of statistics about a list of projects, generated by
+ Project Admins or Group Admins. Will only include a sessions
+ created in date range (inclusive) when provided by the client.
+
+ Report includes:
+ - Project Name
+ - Group Name
+ - Project Admin(s)
+ - Number of Sessions
+ - Unique Subjects
+ - Male Subjects
+ - Female Subjects
+ - Other Subjects
+ - Subjects with sex type Other
+ - Subjects under 18
+ - Subjects over 18
+ """
+
+ def __init__(self, projects, start_date=None, end_date=None):
+ """
+ Initialize a Project Report
+
+ :projects: a list of project ObjectIds
+ :start_date: ISO formatted timestamp
+ :end_date: ISO formatted timestamp
+ """
+
+ super(ProjectReport, self).__init__()
+ self.projects = projects
+ self.start_date = start_date
+ self.end_date = end_date
+
+ def user_can_generate(self, uid):
+ """
+ User generating report must be admin on all
+ """
+ perm_count = config.db.projects.count({'_id': {'$in': self.projects},
+ 'permissions._id': uid,
+ 'permissions.access': 'admin'})
+ if perm_count == len(self.projects):
+ return True
+ return False
+
+ def _base_query(self, pid):
+ base_query = {'project': pid}
+
+ if self.start_date is not None or self.end_date is not None:
+ base_query['created'] = {}
+ if self.start_date is not None:
+ base_query['created']['$gte'] = self.start_date
+ if self.end_date is not None:
+ base_query['created']['$lte'] = self.end_date
+
+ return base_query
+
+ def build(self):
+ report = {}
+ report['projects'] = []
+
+ projects = config.db.projects.find({'_id': {'$in': self.projects}})
+ for p in projects:
+ project = {}
+ project['name'] = p.get('label')
+ project['group_name'] = p.get('group')
+
+ # Create list of project admins
+ admins = []
+ for perm in p.get('permissions', []):
+ if perm.get('access') == 'admin':
+ admins.append(perm.get('_id'))
+ admin_objs = config.db.users.find({'_id': {'$in': admins}})
+ project['admins'] = map(lambda x: x.get('firstname','')+' '+x.get('lastname',''), admin_objs)
+
+ base_query = self._base_query(p['_id'])
+ project['session_count'] = config.db.sessions.count(base_query)
+
+ # Count subjects
+ # Any stats on subjects require an aggregation to group by subject._id
+ subject_q = copy.deepcopy(base_query)
+ subject_q['subject._id'] = {'$ne': None}
+ log.debug(subject_q)
+
+ pipeline = [
+ {'$match': subject_q},
+ {'$group': {'_id': '$subject._id'}},
+ {'$group': {'_id': 1, 'count': { '$sum': 1 }}}
+ ]
+
+ result = _get_result(config.db.command('aggregate', 'sessions', pipeline=pipeline))
+ project['subjects_count'] = result.get('count', 0)
+
+
+ # Count subjects by sex
+ # Use first sex reporting for subjects with multiple entries
+ sex_q = copy.deepcopy(subject_q)
+ sex_q['subject.sex'] = {'$ne': None}
+
+ pipeline = [
+ {'$match': sex_q},
+ {'$group': {'_id': '$subject._id', 'sex': {'$first': '$subject.sex'}}},
+ {'$project': {'_id': 1, 'female': {'$cond': [{'$eq': ['$sex', 'female']}, 1, 0]},
+ 'male': {'$cond': [{'$eq': ['$sex', 'male']}, 1, 0]},
+ 'other': {'$cond': [{'$eq': ['$sex', 'other']}, 1, 0]}}},
+ {'$group': {'_id': 1, 'female': {'$sum': '$female'},
+ 'male': {'$sum': '$male'},
+ 'other': {'$sum': '$other'}}}
+ ]
+ result = _get_result(config.db.command('aggregate', 'sessions', pipeline=pipeline))
+
+ project['female_count'] = result.get('female',0)
+ project['males_count'] = result.get('male',0)
+ project['other_count'] = result.get('other',0)
+
+
+ # Count subjects by age group
+ # Age is taken as an average over all subject entries
+ age_q = copy.deepcopy(subject_q)
+ age_q['subject.age'] = {'$gt': 0}
+
+ pipeline = [
+ {'$match': age_q},
+ {'$group': {'_id': '$subject._id', 'age': { '$avg': '$subject.age'}}},
+ {'$project': {'_id': 1, 'over_18': {'$cond': [{'$gte': ['$age', EIGHTEEN_YEARS_IN_SEC]}, 1, 0]},
+ 'under_18': {'$cond': [{'$lt': ['$age', EIGHTEEN_YEARS_IN_SEC]}, 1, 0]}}},
+ {'$group': {'_id': 1, 'over_18': {'$sum': '$over_18'}, 'under_18': {'$sum': '$under_18'}}}
+ ]
+ result = _get_result(config.db.command('aggregate', 'sessions', pipeline=pipeline))
+
+ project['over_18_count'] = result.get('over_18',0)
+ project['under_18_count'] = result.get('under_18',0)
+
+
+ report['projects'].append(project)
+
+ return report