/
admin.py
291 lines (249 loc) · 12.1 KB
/
admin.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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
import calendar
import csv
import datetime
import httplib
import urlparse
try:
import json
except ImportError:
import simplejson as json
import dateutil
from django.db import IntegrityError
from django.conf import settings
from django.http import HttpResponsePermanentRedirect, HttpResponse
from django.views.generic import View
from django.db.models.query import QuerySet
from django.shortcuts import get_object_or_404
from django_conneg.views import JSONView, HTMLView, JSONPView, TextView
from django_conneg.http import HttpResponseSeeOther
from django_conneg.support import login_required
import pytz
import openorg_timeseries
from openorg_timeseries import forms
from openorg_timeseries.models import TimeSeries
class ErrorView(HTMLView, JSONPView, TextView):
_force_fallback_format = 'json'
def dispatch(self, request, context, template_name):
template_name = (template_name, 'timeseries-admin/error')
return self.render(request, context, template_name)
class TimeSeriesView(JSONView):
_error = staticmethod(ErrorView.as_view())
_default_format = 'json'
def error(self, status_code, **kwargs):
return self._error(self.request,
dict(status_code=status_code, **kwargs),
'timeseries-admin/error')
def lacking_privilege(self, action):
return self._error(self.request,
{'status_code': httplib.FORBIDDEN,
'error': 'lacking-privilege',
'message': 'The authenticated user lacks the necessary privilege to %s' % action},
'timeseries-admin/error-lacking-privilege')
def invalid_json(self, exception):
return self._error(self.request,
{'status_code': httplib.BAD_REQUEST,
'error': 'invalid-json',
'message': 'Could not parse request body as JSON',
'detail': unicode(exception)},
'timeseries-admin/error-invalid-json')
def bad_request(self, error, message):
return self._error(self.request,
{'status_code': httplib.BAD_REQUEST,
'error': error,
'message': message},
'timeseries-admin/error-bad-request')
_json_indent = 2
def simplify(self, value):
if isinstance(value, datetime.datetime):
return 1000 * calendar.timegm(value.astimezone(pytz.utc).timetuple())
if isinstance(value, QuerySet):
return map(self.simplify, value)
if isinstance(value, TimeSeries):
data = {
'_url': value.get_absolute_url(),
'slug': value.slug,
'title': value.title,
'notes': value.notes,
'is_virtual': value.is_virtual,
}
if value.is_virtual:
data['equation'] = value.equation
else:
data['config'] = value.config
return self.simplify(data)
else:
return super(TimeSeriesView, self).simplify(value)
def filtered_dict(self, d, keys):
return dict((k, d.get(k)) for k in keys)
class ListView(TimeSeriesView, HTMLView, JSONPView):
@login_required
def dispatch(self, request):
return super(ListView, self).dispatch(request)
def get(self, request):
series = TimeSeries.objects.all().order_by('slug')
series = [s for s in series if request.user.has_perm('view_timeseries', s)]
context = {
'series': series,
'server': {'name': 'openorg_timeseries.admin',
'version': openorg_timeseries.__version__},
}
return self.render(request, context, 'timeseries-admin/index')
def post(self, request):
if not request.user.has_perm('openorg_timeseries.add_timeseries'):
return self.lacking_privilege('create a new time-series')
if request.META.get('CONTENT_TYPE') != 'application/json':
return self.bad_request('wrong-content-type', 'Content-Type must be "application/json"')
try:
data = json.load(request)
except ValueError, e:
return self._error.invalid_json(request, e)
time_series = TimeSeries()
fields = TimeSeries.common_fields + (('equation' if data.get('is_virtual') else 'config'),)
for key in fields:
try:
setattr(time_series, key, data[key])
except KeyError:
return self.error(httplib.BAD_REQUEST,
error='missing-field',
field=key,
message='Field "%s" was missing.' % key)
try:
time_series.save()
except IntegrityError:
# A time-series already exists with the desired slug
return self.error(httplib.CONFLICT,
error='already-exists',
message='A time-series already exists with the slug %r.' % time_series.slug)
for perm in ('view_timeseries', 'append_timeseries', 'change_timeseries', 'delete_timeseries'):
request.user.grant(perm, time_series)
return self.render(request,
{'status_code': 201,
'additional_headers': {'Location': request.build_absolute_uri(time_series.get_absolute_url())}},
'timeseries-admin/index-created')
class CreateView(HTMLView):
def common(self, request):
return {
'form': forms.NewTimeSeriesForm(request.POST or None),
'archive_formset': forms.ArchiveFormSet(request.POST or None),
}
@login_required
def dispatch(self, request):
if not request.user.has_perm('openorg_timeseries.add_timeseries'):
return self._error.lacking_privilege(request, 'create a new time-series')
super(CreateView, self).dispatch(request, self.common(request))
def get(self, request, context):
return self.render(request, context, 'timeseries-admin/create')
def post(self, request, context):
form, archive_formset = context['form'], context['archive_formset']
if not (form.is_valid() and archive_formset.is_valid()):
return self.render(request, context, 'timeseries-admin/create')
time_series = TimeSeries(**self.filtered_dict(form.cleaned_data,
TimeSeries.field_groups['common']))
if time_series.is_virtual:
for k in TimeSeries.field_groups['virtual']:
setattr(time_series, k, form.cleaned_data.get(k))
else:
config = self.filtered_dict(form.cleanded_data, TimeSeries.field_groups['config'])
config['archives'] = [f.cleaned_data for f in archive_formset.forms if f.is_valid() and f.cleaned_data]
time_series.config = config
time_series.save()
return HttpResponseSeeOther(time_series.get_absolute_url())
class SecureView(View):
force_https = getattr(settings, 'FORCE_ADMIN_HTTPS', True)
def dispatch(self, request, *args, **kwargs):
if self.force_https and not (settings.DEBUG or request.is_secure()):
url = urlparse.urlparse(request.build_absolute_uri())
url = urlparse.urlunparse(('https',) + url[1:])
return HttpResponsePermanentRedirect(url)
return super(SecureView, self).dispatch(request, *args, **kwargs)
class DetailView(TimeSeriesView, HTMLView):
def common(self, request, slug):
context = {
'series': get_object_or_404(TimeSeries, slug=slug),
}
if not request.user.get_perms(context['series']):
return self.lacking_privilege('view this time-series')
context['form'] = forms.TimeSeriesForm(request.POST or None,
instance=context['series'])
return context
def get(self, request, slug):
context = self.common(request, slug)
return self.render(request, context, 'timeseries/admin-detail')
def post(self, request, slug):
context = self.common(request, slug)
series = context['series']
if request.META.get('CONTENT_TYPE') == 'application/json':
try:
request.json_data = json.load(request)
except ValueError, e:
return self.invalid_json(e)
else:
request.json_data = None
context = {}
try:
readings = self.get_readings(request)
except ValueError, e:
return self.error(httplib.BAD_REQUEST, type='value-error', message=e.args[0])
if readings and series.is_virtual:
return self.bad_request("append-to-virtual", "You cannot append readings to a virtual time-series")
if readings and not request.user.has_perm('append_timeseries', series):
return self.lacking_privilege("append to this time-series")
elif readings:
context['readings'] = {'count': len(readings)}
series.append(readings)
editable_fields = ('title', 'notes')
if request.json_data and any(f in request.json_data for f in editable_fields):
context['updated'] = []
if not request.user.has_perm('change_timeseries', series):
return self.lacking_privilege("modify this time-series")
for f in editable_fields:
if f in request.json_data:
if not isinstance(request.json_data[f], unicode):
return self.bad_request("type-error", "Field '%s' must be a string" % f)
setattr(series, f, request.json_data[f])
context['updated'].append(f)
series.save()
return self.render(request, context, 'timeseries-admin/detail-post')
def get_readings(self, request):
readings = []
if request.json_data and 'readings' in request.json_data:
if not isinstance(request.json_data['readings'], list):
raise ValueError('"readings" member should be a list.')
for i, reading in enumerate(request.json_data['readings']):
try:
if isinstance(reading, dict):
reading = reading['ts'], reading['val']
elif isinstance(reading, list) and len(reading) == 2:
pass
else:
raise ValueError("Reading %i must be either an object with 'ts' and 'val' members, or a two-element list." % i)
readings.append(reading)
except KeyError, e:
raise ValueError("Reading %i was missing a '%s' member" % (i, e.args[0]))
except ValueError, e:
raise ValueError("Reading %i: %s" % (i, e.args[0]))
elif request.META.get('CONTENT_TYPE') == 'text/csv':
reader = csv.reader(request)
for i, row in enumerate(reader):
if len(row) != 2:
raise ValueError("Row %i doesn't have two columns" % i)
row[1] = float(row[1])
readings.append(row)
parsed_readings = []
for reading in readings:
if isinstance(reading[0], basestring):
ts = dateutil.parser.parse(reading[0])
elif isinstance(reading[0], (int, float)):
ts = pytz.utc.localize(datetime.datetime.utcfromtimestamp(reading[0] / 1000))
if not ts.tzinfo:
raise ValueError("Timestamp in reading %i is missing a timezone part.")
parsed_readings.append((ts, reading[1]))
return parsed_readings
def append_readings(self, request, slug, readings):
pass
def delete(self, request, slug):
context = self.common(request, slug)
if not request.user.has_perm('delete_timeseries', context['series']):
return self._error.lacking_privilege(request, 'delete this time-series')
context['series'].delete()
return HttpResponse('', status=httplib.NO_CONTENT)