-
Notifications
You must be signed in to change notification settings - Fork 0
/
views.py
576 lines (490 loc) · 20 KB
/
views.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
import os
from pathlib import Path
from zipfile import ZipFile, BadZipFile
import logging
from base64 import b64encode
from django.views import static
from rest_framework import viewsets, status
from rest_framework.decorators import detail_route, list_route
from rest_framework.response import Response
from rest_framework.renderers import StaticHTMLRenderer
from rest_framework.pagination import LimitOffsetPagination
from rest_framework.authentication import (
TokenAuthentication
)
from django.conf import settings
from django.core.files import File
from ..models import (
Envelope,
EnvelopeFile,
BaseWorkflow,
Obligation,
Country,
UploadToken,
QAJob,
)
from ..serializers import (
EnvelopeSerializer,
EnvelopeFileSerializer, CreateEnvelopeFileSerializer,
NestedEnvelopeWorkflowSerializer,
NestedUploadTokenSerializer,
QAJobSerializer,
)
from .. import permissions
from reportek.core.utils import path_parts
from reportek.core.qa import RemoteQA
from reportek.core.utils import fully_qualify_url
log = logging.getLogger('reportek.workflows')
info = log.info
debug = log.debug
warn = log.warning
error = log.error
class EnvelopeResultsSetPagination(LimitOffsetPagination):
default_limit = 20
max_limit = 100
class EnvelopeViewSet(viewsets.ModelViewSet):
queryset = Envelope.objects.all().prefetch_related('files')
serializer_class = EnvelopeSerializer
authentication_classes = viewsets.ModelViewSet.authentication_classes + [TokenAuthentication]
permission_classes = (permissions.IsAuthenticated, )
pagination_class = EnvelopeResultsSetPagination
@detail_route(methods=['post'])
def transition(self, request, pk):
"""
Initiates a transition, expects `transition_name` in the POST data.
"""
envelope = self.get_object()
workflow = envelope.workflow
transition_name = request.data.get('transition_name')
def make_response(with_error=None):
response = {
'transition': transition_name,
'current_state': workflow.current_state,
}
if with_error:
response['error'] = with_error
return response
try:
workflow.start_transition(transition_name)
except BaseWorkflow.TransitionDoesNotExist as err:
return Response(
make_response(with_error=str(err)),
status=status.HTTP_400_BAD_REQUEST
)
except BaseWorkflow.TransitionNotAvailable as err:
return Response(
make_response(with_error=str(err)),
status=status.HTTP_406_NOT_ACCEPTABLE
)
except Exception as err:
return Response(
make_response(with_error=str(err)),
status=status.HTTP_500_INTERNAL_SERVER_ERROR
)
return Response(make_response())
@detail_route(methods=['get'])
def history(self, request, pk):
"""
Returns an evelope's transition history.
"""
envelope = self.get_object()
workflow = envelope.workflow
return Response(
{
ev.timestamp.isoformat(): {
'transition': ev.transition,
'from_state': ev.from_state,
'to_state': ev.to_state
}
for ev in workflow.history.all()
}
)
@list_route(methods=['get'])
def status(self, request):
"""
Returns a paginated list of envelopes matching the provided params:
- `country`: an ISO country code (multiple occurences allowed)
- `obligation`: an obligation id (multiple occurences allowed)
- `finalized`: 0/1 flag indicating envelope finalization status
"""
countries = request.query_params.getlist('country')
obligations = request.query_params.getlist('obligation')
finalized = request.query_params.get('finalized')
envelopes = Envelope.objects.prefetch_related('files')
if countries:
countries = Country.objects.filter(iso__in=countries).all()
envelopes = envelopes.filter(country__in=countries)
if obligations:
obligation_ids = []
for o in obligations:
try:
obligation_ids.append(int(o))
except ValueError:
pass
obligations = Obligation.objects.filter(pk__in=obligation_ids).all()
obligation_groups = set([o.group for o in obligations])
envelopes = envelopes.filter(obligation_group__in=obligation_groups)
if finalized is not None:
try:
finalized = bool(int(finalized))
envelopes = envelopes.filter(finalized=finalized)
except ValueError:
pass
envelopes = envelopes.order_by(
'country',
'obligation_group',
'-updated_at'
)
page = self.paginate_queryset(envelopes)
if page is not None:
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
serializer = self.get_serializer(envelopes, many=True)
return Response(serializer.data)
@detail_route(methods=['get'])
def feedback(self, request, pk):
"""
Returns a paginated list of completed QA jobs for the envelope's files.
"""
envelope = self.get_object()
qa_jobs = QAJob.objects.filter(completed=True, envelope_file__envelope=envelope)
page = self.paginate_queryset(qa_jobs)
if page is not None:
serializer = QAJobSerializer(page, many=True, context={'request': request})
return self.get_paginated_response(serializer.data)
serializer = QAJobSerializer(qa_jobs, many=True, context={'request': request})
return Response(serializer.data)
class EnvelopeFileViewSet(viewsets.ModelViewSet):
queryset = EnvelopeFile.objects.all()
permission_classes = (permissions.IsAuthenticated, )
def get_serializer_class(self):
if self.request.method == "POST":
return CreateEnvelopeFileSerializer
return EnvelopeFileSerializer
def get_queryset(self):
return super().get_queryset().filter(
envelope_id=self.kwargs['envelope_pk']
)
def perform_create(self, serializer):
serializer.save(
envelope_id=self.kwargs['envelope_pk']
)
@detail_route(methods=['get', 'head'], renderer_classes=(StaticHTMLRenderer,))
def download(self, request, envelope_pk, pk):
envelope_file = self.get_object()
_file = envelope_file.file
relpath = _file.name
if relpath is None or relpath == '':
return Response(status=status.HTTP_404_NOT_FOUND)
if settings.DEBUG:
response = static.serve(
request,
path=relpath,
document_root=_file.storage.location)
else:
# this does "X-Sendfile" on nginx, see
# https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/
response = Response(
headers={
'X-Accel-Redirect': _file.storage.url(relpath)
}
)
return response
@detail_route(methods=['get'])
def qa_scripts(self, request, envelope_pk, pk):
"""
Returns the list of available QA rules for one particular schema,
as list of dicts with the keys:
`id`
`title`
`last_updated`
`max_size`
"""
envelope_file = self.get_object()
remote_qa = RemoteQA(
envelope_file.envelope.obligation_group.qa_xmlrpc_uri
)
if envelope_file.xml_schema is None:
scripts = []
else:
scripts = remote_qa.get_scripts(envelope_file.xml_schema)
return Response(scripts)
@detail_route(methods=['post'])
def run_qa_script(self, request, envelope_pk, pk):
"""
Runs the QA script with id POST-ed as ``script_id`` against the
XML file, and returns the result as dict with the keys:
`content-type`
`result`
`feedback_status`
`feedback_message`
"""
script_id = request.data.get('script_id')
envelope_file = self.get_object()
remote_qa = RemoteQA(
envelope_file.envelope.obligation_group.qa_xmlrpc_uri
)
file_url = fully_qualify_url(envelope_file.get_api_download_url())
return Response(remote_qa.run_script(file_url, str(script_id)))
@detail_route(methods=['get'])
def feedback(self, request, envelope_pk, pk):
"""
Returns the QA feedback, if any, for the envelope file.
"""
envelope_file = self.get_object()
qa_jobs = QAJob.objects.filter(completed=True, envelope_file=envelope_file)
serializer = QAJobSerializer(qa_jobs, many=True, context={'request': request})
return Response(serializer.data)
class EnvelopeWorkflowViewSet(viewsets.ModelViewSet):
queryset = BaseWorkflow.objects.all()
serializer_class = NestedEnvelopeWorkflowSerializer
permission_classes = (permissions.IsAuthenticated, )
class UploadTokenViewSet(viewsets.ModelViewSet):
queryset = UploadToken.objects.all()
serializer_class = NestedUploadTokenSerializer
permission_classes = (permissions.IsAuthenticated,)
def create(self, request, envelope_pk):
"""
Creates an ``UploadToken`` for the envelope.
Used by `tusd` uploads server for user/envelope correlation.
Upload tokens cannot be issued for finalized envelopes.
Returns::
{
'token': <base64 encoded token>
}
"""
envelope = Envelope.objects.get(pk=envelope_pk)
if envelope.finalized:
return Response(
{'error': 'envelope is finalized'},
status=status.HTTP_400_BAD_REQUEST
)
token = envelope.upload_tokens.create(user=request.user)
response = {
'token': token.token
}
# Include base64 encoded token in development environments
if settings.DEBUG:
response['token_base64'] = b64encode(token.token.encode())
return Response(response)
def list(self, request, envelope_pk):
"""
Returns the tokens issued for a given envelope.
"""
queryset = UploadToken.objects.filter(envelope=envelope_pk)
serializer = self.serializer_class(queryset, many=True, context={'request': request})
return Response(serializer.data)
class UploadHookView(viewsets.ViewSet):
"""
Handles upload notifications for tusd hooks:
- ``pre-create``
- ``post-create``
- ``post-finish``
- ``post-terminate``
- ``post-receive``
"""
@staticmethod
def handle_pre_create(request):
"""
Handles a pre-create notification from `tusd`.
Sets the file name on the token.
Returns an OK response only if:
- the upload `token` the `MetaData` field is validated
- the token's user is authenticated
- a `filename` field is present in `MetaData`
"""
info(f'UPLOAD pre-create: {request.data}')
meta_data = request.data.get('MetaData', {})
tok = meta_data.get('token', '')
filename = meta_data.get('filename')
try:
token = UploadToken.objects.get(token=tok)
if token.has_expired():
token.delete()
error('UPLOAD denied: EXPIRED TOKEN')
return Response(
{'error': 'expired token'},
status=status.HTTP_400_BAD_REQUEST
)
# TODO Validate user access to envelope when roles are in place
if not token.user.is_authenticated():
error(f'UPLOAD denied on envelope "{token.envelope}" '
f'for "{token.user}": NOT ALLOWED')
return Response(
{'error': 'user not authenticated'},
status=status.HTTP_403_FORBIDDEN
)
if filename is None:
error(f'UPLOAD denied on envelope "{token.envelope}" '
f'for "{token.user}": filename is missing')
return Response(
{'error': 'filename not in MetaData'},
status=status.HTTP_400_BAD_REQUEST
)
if not EnvelopeFile.has_valid_extension(filename, include_archives=True):
error(f'UPLOAD denied on envelope "{token.envelope}" '
f'for "{token.user}": bad file extension')
return Response(
{'error': 'bad file extension'},
status=status.HTTP_400_BAD_REQUEST
)
token.filename = filename
token.save()
info(f'UPLOAD authorized on envelope "{token.envelope}" for "{token.user}"')
except UploadToken.DoesNotExist:
error('UPLOAD denied: INVALID TOKEN')
return Response(
{'error': 'invalid token'},
status=status.HTTP_400_BAD_REQUEST
)
return Response()
@staticmethod
def handle_post_receive(request):
"""
Handles a post-receive notification from `tusd`.
Currently has no side-effects, exists only to avoid
'hook not implemented' errors in `tusd`.
"""
info(f'UPLOAD post-receive: {request.data}')
return Response()
@staticmethod
def handle_post_create(request):
"""
Handles a post-create notification from `tusd`.
Sets the newly issued tus ID on the token.
"""
info(f'UPLOAD post-create: {request.data}')
meta_data = request.data.get('MetaData', {})
tok = meta_data.get('token', '')
try:
token = UploadToken.objects.get(token=tok)
token.tus_id = request.data.get('ID')
token.save()
except UploadToken.DoesNotExist:
error('UPLOAD denied: INVALID TOKEN')
return Response(
{'error': 'invalid token'},
status=status.HTTP_400_BAD_REQUEST
)
return Response()
@staticmethod
def handle_post_finish(request):
"""
Handles a post-finish notification from `tusd`.
The uploaded file is used to create an EnvelopeFile, or replace its
underlying file on disk if one with the same name exists.
Archives (only ZIPs currently) are extracted *without* directory structure.
If setting ``ARCHIVE_PATH_PREFIX`` is ``True`` (default), the files are saved with
a prefix of '_'-separated path components, i.e. 'dir1/dir2/file.xml' becomes
'dir1_dir2_file.xml'.
"""
info(f'UPLOAD post-finish: {request.data}')
meta_data = request.data.get('MetaData', {})
tok = meta_data.get('token', '')
# filename presence was enforced during pre-create
file_name = meta_data['filename']
file_ext = file_name.split('.')[-1].lower()
try:
token = UploadToken.objects.get(token=tok)
# TODO Validate user access to envelope when roles are in place
if not token.user.is_authenticated():
error(f'UPLOAD denied on envelope "{token.envelope}" '
f'for "{token.user}": NOT ALLOWED')
return Response(
{'error': 'user not authenticated'},
status=status.HTTP_403_FORBIDDEN
)
file_path = os.path.join(
settings.TUSD_UPLOADS_DIR,
f'{request.data.get("ID")}.bin'
)
file_path = Path(file_path).resolve()
if not file_path.is_file():
raise FileNotFoundError
# Regular files
if file_ext not in settings.ALLOWED_UPLOADS_ARCHIVE_EXTENSIONS:
envelope_file, is_new = EnvelopeFile.get_or_create(
token.envelope,
file_name
)
if not is_new:
token.envelope.delete_disk_file(file_name)
envelope_file.file.save(file_name, File(file_path.open()))
if file_ext == 'xml':
envelope_file.xml_schema = envelope_file.extract_xml_schema()
envelope_file.save()
# Archives, currently zip only
elif file_ext == 'zip':
try:
with ZipFile(file_path) as up_zip:
for zip_member in up_zip.namelist():
member_info = up_zip.getinfo(zip_member)
# Skip directories and files with non-allowed extensions
if member_info.is_dir() or not EnvelopeFile.has_valid_extension(member_info.filename):
continue
if not settings.ARCHIVE_PATH_PREFIX:
member_name = os.path.basename(zip_member)
else:
member_name = '_'.join([p.replace(' ', '') for p in path_parts(zip_member)])
member_ext = member_name.split('.')[-1].lower()
envelope_file, is_new = EnvelopeFile.get_or_create(
token.envelope,
member_name
)
if not is_new:
token.envelope.delete_disk_file(member_name)
with up_zip.open(zip_member) as member_file:
envelope_file.file.save(member_name, member_file)
if member_ext == 'xml':
envelope_file.xml_schema = envelope_file.extract_xml_schema()
envelope_file.save()
except BadZipFile:
error(f'UPLOAD Bad ZIP file: "{file_path}"')
return Response(
{'error': 'bad zip file'},
status=status.HTTP_400_BAD_REQUEST
)
# Finally, remove the token
token.delete()
except UploadToken.DoesNotExist:
error(f'UPLOAD denied on envelope "{token.envelope}" '
f'for "{token.user}": INVALID TOKEN')
return Response(
{'error': 'invalid token'},
status=status.HTTP_400_BAD_REQUEST
)
except FileNotFoundError:
error(f'UPLOAD file does not exist: "{file_path}"')
return Response(
{'error': 'file not found'},
status=status.HTTP_400_BAD_REQUEST
)
return Response()
@staticmethod
def handle_post_terminate(request):
"""
Handles a post-terminate notification from `tusd`.
Deletes the token issued for the upload.
"""
info(f'UPLOAD post-terminate: {request.data}')
meta_data = request.data.get('MetaData', {})
tok = meta_data.get('token', '')
try:
token = UploadToken.objects.get(token=tok)
token.delete()
except UploadToken.DoesNotExist:
warn('UPLOAD could not find token to delete on post-terminate.')
return Response()
def create(self, request):
"""
Dispatches notifications from `tusd` to appropriate handler.
"""
# Original header name sent by tusd is `Hook-Name`, Django mangles it
hook_name = self.request.META.get('HTTP_HOOK_NAME')
try:
return getattr(self, f'handle_{hook_name.replace("-", "_")}')(request)
except AttributeError:
return Response(
{'hook_not_supported': hook_name},
status=status.HTTP_400_BAD_REQUEST
)