-
Notifications
You must be signed in to change notification settings - Fork 5
/
reports.py
191 lines (164 loc) · 7.84 KB
/
reports.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
#
# report methods
#
import os
import csv
import codecs
import models
import datetime
import logging
import webapp2
import json
import re
import hashlib
import jinja2
import gsdata
import bqutil
import auth
import traceback
import local_config
from models import CustomReport
from jinja2 import Template
from collections import defaultdict, OrderedDict
from stats import DataStats
from datatable import DataTableField
from datasource import DataSource
from auth import auth_required, auth_and_role_required
from templates import JINJA_ENVIRONMENT
from google.appengine.api import memcache
mem = memcache.Client()
class Reports(object):
'''
This class is meant to be mixed-in
'''
def custom_report_container(self, is_authorized_for_custom_report, **pdata):
'''
Return object which acts like a dict and can be used to generate HTML fragment as container for specified custom report.
pdata = parameter data for custom report (also goes into authorization check)
'''
other = self
class CRContainer(dict):
def __init__(self, *args, **kwargs):
self.immediate_view = False
self.do_no_embed = False # prevent report from rendering as embedded (need for custom_reports.html)
self.force_embed = False
self.do_always_show = False # overrides hiding which happens in require_file handling
super(CRContainer, self).__init__(*args, **kwargs)
@property
def immediate(self):
self.immediate_view = True
return self
@property
def always_show(self):
self.do_always_show = True
return self
@property
def embed(self):
self.force_embed = True
return self
@property
def no_embed(self):
self.do_no_embed = True
return self
@property
def parameter(self):
crc = self
class ParameterSetter(dict):
def __getitem__(self, parameter_name):
class ParameterValue(dict):
def __getitem__(self, parameter_value):
logging.info("CRContainer setting parameter %s = %s" % (parameter_name, parameter_value))
pdata[parameter_name] = parameter_value
return crc
return ParameterValue()
return ParameterSetter()
def __getitem__(self, report_name):
try:
crm = other.get_custom_report_metadata(report_name)
err = None
except Exception as err:
crm = None
if not crm:
logging.info("No custom report '%s' found, err=%s" % (report_name, err))
return "Missing custom report %s" % report_name
# check access authorization
# logging.info('[crc] checking auth for report %s, pdata=%s' % (crm.name, pdata))
auth_ok, msg = is_authorized_for_custom_report(crm, pdata)
if not auth_ok:
return "" # return empty string if not authorized
# logging.info('[cr] name=%s, title=%s' % (crm.name, crm.title)) # debugging
title = JINJA_ENVIRONMENT.from_string(crm.title)
try:
title_rendered = title.render(pdata)
except Exception as err:
logging.error('[cr] Failed to render report %s title %s' % (crm.name, crm.title))
title = crm.title
parameters = {x:v for x,v in pdata.items() if v is not None}
parameters['orgname'] = other.ORGNAME
parameters['dashboard_mode'] = other.MODE # 'mooc' or '' (empty meaning residential, non-mooc)
parameters['course_report'] = other.get_course_report_dataset()
parameters['course_report_org'] = other.get_course_report_dataset(force_use_org=True)
parameters['orgname'] = other.ORGNAME
if 'require_table' in (crm.meta_info or []):
dataset = None
table = crm.meta_info['require_table']
if '{' in table:
try:
table = table.format(**parameters)
except Exception as err:
logging.error("Cannot substitute for parameters in require_table=%s, err=%s" % (table, err))
if '.' in table:
(dataset, table) = table.split('.', 1)
else:
course_id = parameters.get('course_id')
if course_id:
try:
dataset = bqutil.course_id2dataset(course_id, use_dataset_latest=other.use_dataset_latest())
except Exception as err:
logging.error("failed to get dataset for course_id=%s" % course_id)
raise
else:
logging.info("Suppressing report %s because dataset not specifid in require_table %s" % (title, table))
dataset = None
if dataset is not None:
try:
tinfo = bqutil.get_bq_table_info(dataset, table) or None
except Exception as err:
tinfo = None
if not "Not Found" in str(err):
logging.error(err)
logging.error(traceback.format_exc())
if not tinfo:
logging.info("Suppressing report %s because %s.%s doesn't exist" % (title, dataset, table))
return ""
else:
logging.info("Skipping require_table check")
report_id = hashlib.sha224("%s %s" % (crm.name, json.dumps(pdata))).hexdigest()
if crm.description:
try:
crm.description = crm.description.format(**parameters)
except Exception as err:
logging.info('[cr] %s cannot format description %s' % (crm.name, crm.description))
if self.do_no_embed and 'embedded' in (crm.meta_info or {}):
crm.meta_info.pop('embedded')
if self.force_embed:
crm.meta_info['embedded'] = True
if self.do_always_show:
crm.meta_info['always_show'] = True
template = JINJA_ENVIRONMENT.get_template('custom_report_container.html')
data = {'is_staff': other.is_superuser(),
'report': crm,
'report_params': json.dumps(parameters),
'report_is_staff': pdata.get('staff'),
'report_meta_info': json.dumps(crm.meta_info or {}),
'immediate_view': json.dumps(self.immediate_view),
'do_embed' : (crm.meta_info or {}).get('embedded') or self.force_embed,
'always_show': self.do_always_show,
'title': title_rendered,
'id': report_id,
}
self.immediate_view = False # return to non-immediate view by default
self.do_no_embed = False # return to default
self.force_embed = False # return to default
return template.render(data)
return CRContainer()