-
Notifications
You must be signed in to change notification settings - Fork 29
/
views.py
594 lines (458 loc) · 23.6 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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
from django.db.models import F, Q
from django.http import Http404
from django.shortcuts import get_object_or_404
from drf_yasg.utils import swagger_auto_schema
from pydash import get
from rest_framework import status
from rest_framework.generics import RetrieveAPIView, DestroyAPIView, ListCreateAPIView, RetrieveUpdateDestroyAPIView, \
UpdateAPIView
from rest_framework.mixins import CreateModelMixin
from rest_framework.permissions import IsAuthenticatedOrReadOnly, IsAdminUser
from rest_framework.response import Response
from rest_framework.views import APIView
from core.bundles.models import Bundle
from core.bundles.serializers import BundleSerializer
from core.common.constants import (
HEAD, INCLUDE_INVERSE_MAPPINGS_PARAM, INCLUDE_RETIRED_PARAM, ACCESS_TYPE_NONE)
from core.common.exceptions import Http409, Http400, Http405
from core.common.mixins import ListWithHeadersMixin, ConceptDictionaryMixin
from core.common.swagger_parameters import (
q_param, limit_param, sort_desc_param, page_param, exact_match_param, sort_asc_param, verbose_param,
include_facets_header, updated_since_param, include_inverse_mappings_param, include_retired_param,
compress_header, include_source_versions_param, include_collection_versions_param, cascade_method_param,
cascade_map_types_params, cascade_exclude_map_types_params, cascade_hierarchy_param, cascade_mappings_param,
include_mappings_param, cascade_levels_param)
from core.common.tasks import delete_concept, make_hierarchy
from core.common.utils import to_parent_uri_from_kwargs
from core.common.views import SourceChildCommonBaseView, SourceChildExtrasView, \
SourceChildExtraRetrieveUpdateDestroyView
from core.concepts.constants import PARENT_VERSION_NOT_LATEST_CANNOT_UPDATE_CONCEPT
from core.concepts.documents import ConceptDocument
from core.concepts.models import Concept, LocalizedText
from core.concepts.permissions import CanViewParentDictionary, CanEditParentDictionary
from core.concepts.search import ConceptSearch
from core.concepts.serializers import (
ConceptDetailSerializer, ConceptListSerializer, ConceptDescriptionSerializer, ConceptNameSerializer,
ConceptVersionDetailSerializer,
ConceptVersionListSerializer, ConceptSummarySerializer, ConceptMinimalSerializer,
ConceptChildrenSerializer, ConceptParentsSerializer)
from core.mappings.serializers import MappingListSerializer
class ConceptBaseView(SourceChildCommonBaseView):
lookup_field = 'concept'
model = Concept
queryset = Concept.objects.filter(is_active=True)
document_model = ConceptDocument
facet_class = ConceptSearch
es_fields = Concept.es_fields
default_filters = dict(is_active=True)
def get_detail_serializer(self, obj, data=None, files=None, partial=False):
return ConceptDetailSerializer(obj, data, files, partial, context=dict(request=self.request))
def get_queryset(self):
return Concept.get_base_queryset(self.params)
class ConceptListView(ConceptBaseView, ListWithHeadersMixin, CreateModelMixin):
serializer_class = ConceptListSerializer
def get_permissions(self):
if self.request.method == 'POST':
return [CanEditParentDictionary(), ]
return [CanViewParentDictionary(), ]
def get_serializer_class(self):
method = self.request.method
is_get = method == 'GET'
if is_get and self.is_brief():
return ConceptMinimalSerializer
if (is_get and self.is_verbose()) or method == 'POST':
return ConceptDetailSerializer
return ConceptListSerializer
def get_queryset(self):
is_latest_version = 'collection' not in self.kwargs and 'version' not in self.kwargs or \
get(self.kwargs, 'version') == HEAD
queryset = super().get_queryset().prefetch_related('names')
if is_latest_version:
queryset = queryset.filter(is_latest_version=True)
user = self.request.user
if get(user, 'is_anonymous'):
queryset = queryset.exclude(public_access=ACCESS_TYPE_NONE)
elif not get(user, 'is_staff'):
public_queryset = queryset.exclude(public_access=ACCESS_TYPE_NONE)
private_queryset = queryset.filter(public_access=ACCESS_TYPE_NONE)
private_queryset = private_queryset.filter(
Q(parent__user_id=user.id) | Q(parent__organization__members__id=user.id))
queryset = public_queryset.union(private_queryset)
return queryset
@swagger_auto_schema(
manual_parameters=[
q_param, limit_param, sort_desc_param, sort_asc_param, exact_match_param, page_param, verbose_param,
include_retired_param, include_inverse_mappings_param, updated_since_param,
include_facets_header, compress_header
]
)
def get(self, request, *args, **kwargs):
self.set_parent_resource(False)
if self.parent_resource:
self.check_object_permissions(request, self.parent_resource)
return self.list(request, *args, **kwargs)
def set_parent_resource(self, __pop=True):
parent_resource = None
source = self.kwargs.pop('source', None) if __pop else self.kwargs.get('source', None)
collection = self.kwargs.pop('collection', None) if __pop else self.kwargs.get('collection', None)
container_version = self.kwargs.pop('version', HEAD) if __pop else self.kwargs.get('version', HEAD)
if 'org' in self.kwargs:
filters = dict(organization__mnemonic=self.kwargs['org'])
else:
username = self.request.user.username if self.user_is_self else self.kwargs.get('user')
filters = dict(user__username=username)
if source:
from core.sources.models import Source
parent_resource = Source.get_version(source, container_version or HEAD, filters)
if collection:
from core.collections.models import Collection
parent_resource = Collection.get_version(source, container_version or HEAD, filters)
self.kwargs['parent_resource'] = self.parent_resource = parent_resource
def post(self, request, **kwargs): # pylint: disable=unused-argument
self.set_parent_resource()
if not self.parent_resource:
raise Http404()
serializer = self.get_serializer(data={
**request.data, 'parent_id': self.parent_resource.id, 'name': request.data.get('id', None)
})
if serializer.is_valid():
self.object = serializer.save()
if serializer.is_valid():
headers = self.get_success_headers(serializer.data)
serializer = ConceptDetailSerializer(self.object, context=dict(request=request))
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
class ConceptSummaryView(ConceptBaseView, RetrieveAPIView):
serializer_class = ConceptSummarySerializer
def get_object(self, queryset=None):
if 'collection' in self.kwargs:
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
queryset = self.get_queryset()
if 'concept_version' not in self.kwargs:
queryset = queryset.filter(id=F('versioned_object_id'))
instance = queryset.first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
class ConceptCollectionMembershipView(ConceptBaseView, ListWithHeadersMixin):
def get_serializer_class(self):
from core.collections.serializers import CollectionVersionListSerializer
return CollectionVersionListSerializer
def get_object(self, queryset=None):
queryset = Concept.get_base_queryset(self.params)
if 'concept_version' in self.kwargs:
instance = queryset.first()
else:
instance = queryset.filter(id=F('versioned_object_id')).first().get_latest_version()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
def get_queryset(self):
instance = self.get_object()
if not self.kwargs.get('concept_version'):
instance = instance.get_latest_version()
return instance.collection_set.filter(
organization_id=instance.parent.organization_id, user_id=instance.parent.user_id)
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class ConceptRetrieveUpdateDestroyView(ConceptBaseView, RetrieveAPIView, UpdateAPIView, DestroyAPIView):
serializer_class = ConceptDetailSerializer
def get_object(self, queryset=None):
queryset = self.get_queryset()
filters = dict(id=F('versioned_object_id'))
if 'collection' in self.kwargs:
filters = {}
queryset = queryset.order_by('id').distinct('id')
uri_param = self.request.query_params.dict().get('uri')
if uri_param:
filters.update(Concept.get_parent_and_owner_filters_from_uri(uri_param))
if queryset.count() > 1 and not uri_param:
raise Http409()
instance = queryset.filter(**filters).first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
def get_permissions(self):
if self.request.method in ['GET']:
return [CanViewParentDictionary(), ]
if self.request.method == 'DELETE' and self.is_hard_delete_requested():
return [IsAdminUser(), ]
return [CanEditParentDictionary(), ]
def update(self, request, *args, **kwargs):
self.object = self.get_object()
partial = kwargs.pop('partial', True)
self.parent_resource = self.object.parent
if self.parent_resource != self.parent_resource.head:
return Response(
{'non_field_errors': PARENT_VERSION_NOT_LATEST_CANNOT_UPDATE_CONCEPT},
status=status.HTTP_400_BAD_REQUEST
)
self.object = self.object.clone()
serializer = self.get_serializer(self.object, data=request.data, partial=partial)
success_status_code = status.HTTP_200_OK
if serializer.is_valid():
self.object = serializer.save()
if serializer.is_valid():
return Response(serializer.data, status=success_status_code)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def is_hard_delete_requested(self):
return self.request.query_params.get('hardDelete', None) in ['true', True, 'True']
def is_async_hard_delete_requested(self):
return self.request.query_params.get('async', None) in ['true', True, 'True']
def is_db_delete_requested(self):
return self.request.query_params.get('db', None) in ['true', True, 'True']
def destroy(self, request, *args, **kwargs):
is_hard_delete_requested = self.is_hard_delete_requested()
if self.is_db_delete_requested() and is_hard_delete_requested:
parent_filters = Concept.get_parent_and_owner_filters_from_kwargs(self.kwargs)
result = Concept.objects.filter(mnemonic=self.kwargs['concept'], **parent_filters).delete()
return Response(result, status=status.HTTP_204_NO_CONTENT)
concept = self.get_object()
parent = concept.parent
if is_hard_delete_requested:
if self.is_async_hard_delete_requested():
delete_concept.delay(concept.id)
return Response(status=status.HTTP_204_NO_CONTENT)
concept.delete()
parent.update_concepts_count()
return Response(status=status.HTTP_204_NO_CONTENT)
comment = request.data.get('update_comment', None) or request.data.get('comment', None)
errors = concept.retire(request.user, comment)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
parent.update_concepts_count()
return Response(status=status.HTTP_204_NO_CONTENT)
class ConceptCascadeView(ConceptBaseView):
serializer_class = BundleSerializer
def get_object(self, queryset=None):
if 'collection' in self.kwargs:
raise Http405()
queryset = self.get_queryset()
if 'concept_version' not in self.kwargs:
queryset = queryset.filter(id=F('versioned_object_id'))
instance = queryset.first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
@swagger_auto_schema(
manual_parameters=[
cascade_method_param, cascade_map_types_params, cascade_exclude_map_types_params,
cascade_hierarchy_param, cascade_mappings_param, include_mappings_param, cascade_levels_param
]
)
def get(self, request, **kwargs): # pylint: disable=unused-argument
instance = self.get_object()
bundle = Bundle(
root=instance, params=self.request.query_params, verbose=self.is_verbose()
)
bundle.cascade()
return Response(BundleSerializer(bundle).data)
class ConceptChildrenView(ConceptBaseView, ListWithHeadersMixin):
serializer_class = ConceptChildrenSerializer
def get_queryset(self):
instance = get_object_or_404(super().get_queryset(), id=F('versioned_object_id'))
self.check_object_permissions(self.request, instance)
return instance.child_concept_queryset()
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class ConceptParentsView(ConceptBaseView, ListWithHeadersMixin):
serializer_class = ConceptParentsSerializer
def get_queryset(self):
instance = get_object_or_404(super().get_queryset(), id=F('versioned_object_id'))
self.check_object_permissions(self.request, instance)
return instance.parent_concept_queryset()
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class ConceptReactivateView(ConceptBaseView, UpdateAPIView):
serializer_class = ConceptDetailSerializer
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_queryset(), id=F('versioned_object_id'))
self.check_object_permissions(self.request, instance)
return instance
def get_permissions(self):
if self.request.method in ['GET']:
return [CanViewParentDictionary(), ]
return [CanEditParentDictionary(), ]
def update(self, request, *args, **kwargs):
concept = self.get_object()
comment = request.data.get('update_comment', None) or request.data.get('comment', None)
errors = concept.unretire(request.user, comment)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
concept.parent.update_concepts_count()
return Response(status=status.HTTP_204_NO_CONTENT)
class ConceptVersionsView(ConceptBaseView, ConceptDictionaryMixin, ListWithHeadersMixin):
permission_classes = (CanViewParentDictionary,)
def get_queryset(self):
queryset = super().get_queryset()
self.check_object_permissions(self.request, queryset.first())
return queryset.exclude(id=F('versioned_object_id'))
def get_serializer_class(self):
return ConceptVersionDetailSerializer if self.is_verbose() else ConceptVersionListSerializer
@swagger_auto_schema(
manual_parameters=[
include_source_versions_param, include_collection_versions_param
]
)
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class ConceptMappingsView(ConceptBaseView, ListWithHeadersMixin):
serializer_class = MappingListSerializer
permission_classes = (CanViewParentDictionary,)
def get_queryset(self):
concept = super().get_queryset().first()
self.check_object_permissions(self.request, concept)
include_retired = self.request.query_params.get(INCLUDE_RETIRED_PARAM, False)
include_indirect_mappings = self.request.query_params.get(INCLUDE_INVERSE_MAPPINGS_PARAM, 'false') == 'true'
is_collection = 'collection' in self.kwargs
collection_version = self.kwargs.get('version', HEAD) if is_collection else None
parent_uri = to_parent_uri_from_kwargs(self.kwargs) if is_collection else None
if include_indirect_mappings:
mappings_queryset = concept.get_bidirectional_mappings_for_collection(
parent_uri, collection_version
) if is_collection else concept.get_bidirectional_mappings()
else:
mappings_queryset = concept.get_unidirectional_mappings_for_collection(
parent_uri, collection_version) if is_collection else concept.get_unidirectional_mappings()
if not include_retired:
mappings_queryset = mappings_queryset.exclude(retired=True)
return mappings_queryset
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class ConceptVersionRetrieveView(ConceptBaseView, RetrieveAPIView, DestroyAPIView):
serializer_class = ConceptVersionDetailSerializer
def get_permissions(self):
if self.request.method == 'DELETE':
return [IsAdminUser()]
return [CanViewParentDictionary(), ]
def get_object(self, queryset=None):
instance = self.get_queryset().first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
class ConceptLabelListCreateView(ConceptBaseView, ListWithHeadersMixin, ListCreateAPIView):
model = LocalizedText
parent_list_attribute = None
default_qs_sort_attr = '-created_at'
def get_permissions(self):
if self.request.method in ['GET', 'HEAD']:
return [CanViewParentDictionary()]
return [CanEditParentDictionary()]
def get_object(self, queryset=None):
instance = super().get_queryset().first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
def get_queryset(self):
if not self.parent_list_attribute:
return None
instance = self.get_object()
return getattr(instance, self.parent_list_attribute).all()
def create(self, request, **_): # pylint: disable=arguments-differ
serializer = self.get_serializer(data=request.data)
if serializer.is_valid():
instance = self.get_object()
new_version = instance.clone()
subject_label_attr = f"cloned_{self.parent_list_attribute}"
# get the current labels from the object
labels = getattr(new_version, subject_label_attr, [])
# If labels are None then we would want to initialize the labels in new_version
saved_instance = serializer.save()
labels.append(saved_instance)
setattr(new_version, subject_label_attr, labels)
new_version.comment = f'Added to {self.parent_list_attribute}: {saved_instance.name}.'
# save updated ConceptVersion into database
errors = Concept.persist_clone(new_version, request.user)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
headers = self.get_success_headers(serializer.data)
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
class ConceptLabelRetrieveUpdateDestroyView(ConceptBaseView, RetrieveUpdateDestroyAPIView):
model = LocalizedText
parent_list_attribute = None
permission_classes = (IsAuthenticatedOrReadOnly,)
default_qs_sort_attr = '-created_at'
def get_queryset(self):
if not self.parent_list_attribute:
return None
instance = self.get_resource_object()
return getattr(instance, self.parent_list_attribute).all()
def get_resource_object(self):
instance = super().get_queryset().first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
return instance
def get_object(self, queryset=None):
instance = get(self.get_resource_object(), self.parent_list_attribute).filter(id=self.kwargs['uuid']).first()
if not instance:
raise Http404()
return instance
def update(self, request, **_): # pylint: disable=arguments-differ
partial = True
instance = self.get_object()
serializer = self.get_serializer(instance, data=request.data, partial=partial)
if serializer.is_valid():
resource_instance = self.get_resource_object()
new_version = resource_instance.clone()
saved_instance = serializer.save()
subject_label_attr = f"cloned_{self.parent_list_attribute}"
labels = getattr(new_version, subject_label_attr, [])
labels.append(saved_instance)
setattr(new_version, subject_label_attr, labels)
new_version.comment = f'Updated {saved_instance.name} in {self.parent_list_attribute}.'
errors = Concept.persist_clone(new_version, request.user)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
return Response(serializer.data, status=status.HTTP_200_OK)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def delete(self, request, *args, **kwargs):
instance = self.get_object()
if instance:
resource_instance = self.get_resource_object()
new_version = resource_instance.clone()
subject_label_attr = f"cloned_{self.parent_list_attribute}"
labels = [name.clone() for name in resource_instance.names.exclude(id=instance.id)]
setattr(new_version, subject_label_attr, labels)
new_version.comment = f'Deleted {instance.name} in {self.parent_list_attribute}.'
errors = Concept.persist_clone(new_version, request.user)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
return Response(status=status.HTTP_204_NO_CONTENT)
class ConceptDescriptionListCreateView(ConceptLabelListCreateView):
serializer_class = ConceptDescriptionSerializer
parent_list_attribute = 'descriptions'
class ConceptNameListCreateView(ConceptLabelListCreateView):
serializer_class = ConceptNameSerializer
parent_list_attribute = 'names'
class ConceptNameRetrieveUpdateDestroyView(ConceptLabelRetrieveUpdateDestroyView):
parent_list_attribute = 'names'
serializer_class = ConceptNameSerializer
class ConceptDescriptionRetrieveUpdateDestroyView(ConceptLabelRetrieveUpdateDestroyView):
parent_list_attribute = 'descriptions'
serializer_class = ConceptDescriptionSerializer
class ConceptExtrasView(SourceChildExtrasView, ConceptBaseView):
serializer_class = ConceptDetailSerializer
class ConceptExtraRetrieveUpdateDestroyView(SourceChildExtraRetrieveUpdateDestroyView, ConceptBaseView):
serializer_class = ConceptDetailSerializer
model = Concept
class ConceptsHierarchyAmendAdminView(APIView): # pragma: no cover
swagger_schema = None
permission_classes = (IsAdminUser, )
@staticmethod
def post(request):
concept_map = request.data
if not concept_map:
return Response(status=status.HTTP_400_BAD_REQUEST)
result = make_hierarchy.delay(concept_map)
return Response(
dict(state=result.state, username=request.user.username, task=result.task_id, queue='default'),
status=status.HTTP_202_ACCEPTED
)