-
Notifications
You must be signed in to change notification settings - Fork 31
/
views.py
1281 lines (1003 loc) · 49.9 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
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import logging
from celery_once import AlreadyQueued
from django.conf import settings
from django.db import IntegrityError
from django.db.models import Q
from django.http import Http404
from django.shortcuts import get_object_or_404
from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema
from pydash import get
from rest_framework import status
from rest_framework.exceptions import PermissionDenied
from rest_framework.generics import (
RetrieveAPIView, DestroyAPIView, UpdateAPIView, ListAPIView,
CreateAPIView)
from rest_framework.permissions import IsAuthenticated, IsAdminUser
from rest_framework.response import Response
from rest_framework.views import APIView
from core.client_configs.views import ResourceClientConfigsView
from core.collections.constants import (
INCLUDE_REFERENCES_PARAM, HEAD_OF_CONCEPT_ADDED_TO_COLLECTION,
HEAD_OF_MAPPING_ADDED_TO_COLLECTION, CONCEPT_ADDED_TO_COLLECTION_FMT, MAPPING_ADDED_TO_COLLECTION_FMT,
DELETE_FAILURE, DELETE_SUCCESS, NO_MATCH, VERSION_ALREADY_EXISTS,
SOURCE_MAPPINGS,
UNKNOWN_REFERENCE_ADDED_TO_COLLECTION_FMT)
from core.collections.documents import CollectionDocument
from core.collections.models import Collection, CollectionReference
from core.collections.search import CollectionFacetedSearch
from core.collections.serializers import (
CollectionDetailSerializer, CollectionListSerializer,
CollectionCreateSerializer, CollectionReferenceSerializer, CollectionVersionDetailSerializer,
CollectionVersionListSerializer, CollectionVersionExportSerializer, CollectionSummaryDetailSerializer,
CollectionVersionSummaryDetailSerializer, CollectionReferenceDetailSerializer, ExpansionSerializer,
ExpansionDetailSerializer, ReferenceExpressionResolveSerializer, CollectionMinimalSerializer,
CollectionSummaryFieldDistributionSerializer, CollectionSummaryVerboseSerializer,
CollectionVersionSummaryFieldDistributionSerializer, CollectionVersionSummaryVerboseSerializer,
CollectionVersionMinimalSerializer)
from core.collections.utils import is_version_specified
from core.common.constants import (
HEAD, RELEASED_PARAM, PROCESSING_PARAM, OK_MESSAGE,
ACCESS_TYPE_NONE, INCLUDE_RETIRED_PARAM, INCLUDE_INVERSE_MAPPINGS_PARAM, ALL)
from core.common.exceptions import Http409, Http405
from core.common.mixins import (
ConceptDictionaryCreateMixin, ListWithHeadersMixin, ConceptDictionaryUpdateMixin,
ConceptContainerExportMixin,
ConceptContainerProcessingMixin)
from core.common.permissions import (
CanViewConceptDictionary, CanEditConceptDictionary, HasAccessToVersionedObject,
CanViewConceptDictionaryVersion
)
from core.common.serializers import TaskSerializer
from core.common.swagger_parameters import q_param, compress_header, page_param, verbose_param, \
include_facets_header, sort_asc_param, sort_desc_param, updated_since_param, include_retired_param, limit_param, \
canonical_url_param
from core.common.tasks import add_references, export_collection, delete_collection, index_expansion_concepts, \
index_expansion_mappings
from core.common.utils import compact_dict_by_values, parse_boolean_query_param
from core.common.views import BaseAPIView, BaseLogoView, ConceptContainerExtraRetrieveUpdateDestroyView, TaskMixin
from core.concepts.documents import ConceptDocument
from core.concepts.models import Concept
from core.concepts.search import ConceptFacetedSearch
from core.mappings.documents import MappingDocument
from core.mappings.models import Mapping
from core.mappings.search import MappingFacetedSearch
from core.toggles.models import Toggle
logger = logging.getLogger('oclapi')
class CollectionBaseView(BaseAPIView):
lookup_field = 'collection'
pk_field = 'mnemonic'
model = Collection
permission_classes = (CanViewConceptDictionary,)
queryset = Collection.objects.filter(is_active=True)
def verify_scope(self):
has_owner_scope = self.has_owner_scope()
has_no_kwargs = self.has_no_kwargs()
if not self.user_is_self:
if has_no_kwargs:
if self.request.method not in ['GET', 'HEAD']:
raise Http404()
elif not has_owner_scope:
raise Http404()
def set_parent_resource(self):
from core.orgs.models import Organization
from core.users.models import UserProfile
org = self.kwargs.get('org', None)
user = self.kwargs.get('user', None)
if not user and self.user_is_self:
user = self.request.user.username
parent_resource = None
if org:
parent_resource = Organization.objects.filter(mnemonic=org).first()
if user:
parent_resource = UserProfile.objects.filter(username=user).first()
self.kwargs['parent_resource'] = self.parent_resource = parent_resource
def get_serializer_context(self):
context = super().get_serializer_context()
context.update({'request': self.request, INCLUDE_REFERENCES_PARAM: self.should_include_references()})
return context
def get_detail_serializer(self, obj):
return CollectionDetailSerializer(obj)
def get_filter_params(self, default_version_to_head=True):
query_params = self.request.query_params.dict()
version = query_params.get('version', None) or self.kwargs.get('version', None)
if not version and default_version_to_head:
version = HEAD
kwargs = self.kwargs.copy()
if self.user_is_self and self.request.user.is_authenticated:
kwargs['user'] = self.request.user.username
return {
**query_params.copy(), **kwargs,
'version': version, 'include_references': self.should_include_references()
}
def get_queryset(self):
return self.get_base_queryset()
def get_base_queryset(self):
queryset = Collection.get_base_queryset(
compact_dict_by_values(self.get_filter_params())
).select_related(
'user', 'organization'
)
if self.is_verbose():
queryset = queryset.select_related('created_by', 'updated_by')
return queryset
def should_include_references(self):
return self.request.query_params.get(INCLUDE_REFERENCES_PARAM, 'false').lower() == 'true'
class CollectionVersionBaseView(CollectionBaseView):
def get_filter_params(self, default_version_to_head=False):
return super().get_filter_params(default_version_to_head)
class CollectionListView(CollectionBaseView, ConceptDictionaryCreateMixin, ListWithHeadersMixin):
serializer_class = CollectionListSerializer
is_searchable = True
es_fields = Collection.es_fields
document_model = CollectionDocument
facet_class = CollectionFacetedSearch
default_filters = {'version': HEAD}
def apply_filters(self, queryset):
return queryset
def get_queryset(self):
queryset = super().get_queryset()
queryset = self.apply_filters(queryset)
user = self.request.user
if get(user, 'is_staff'):
return queryset
if get(user, 'is_anonymous'):
return queryset.exclude(public_access=ACCESS_TYPE_NONE)
public_queryset = queryset.exclude(public_access=ACCESS_TYPE_NONE)
private_queryset = queryset.filter(public_access=ACCESS_TYPE_NONE)
private_queryset = private_queryset.filter(Q(user_id=user.id) | Q(organization__members__id=user.id))
return public_queryset.union(private_queryset)
def get_serializer_class(self):
if self.is_brief():
return CollectionMinimalSerializer
if self.request.method == 'GET' and self.is_verbose():
return CollectionDetailSerializer
if self.request.method == 'POST':
return CollectionCreateSerializer
return CollectionListSerializer
@swagger_auto_schema(
manual_parameters=[
q_param, limit_param, sort_desc_param, sort_asc_param, page_param, verbose_param,
include_retired_param, updated_since_param, canonical_url_param, include_facets_header, compress_header
]
)
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def get_csv_rows(self, queryset=None): # pragma: no cover
if not queryset:
queryset = self.get_queryset()
values = queryset.values('mnemonic', 'name', 'full_name', 'collection_type', 'description', 'default_locale',
'supported_locales', 'website', 'external_id', 'updated_at', 'updated_by', 'uri')
for value in values:
value['Owner'] = Collection.objects.get(uri=value['uri']).parent.mnemonic
value['Collection ID'] = value.pop('mnemonic')
value['Collection Name'] = value.pop('name')
value['Collection Full Name'] = value.pop('full_name')
value['Collection Type'] = value.pop('collection_type')
value['Description'] = value.pop('description')
value['Default Locale'] = value.pop('default_locale')
value['Supported Locales'] = ",".join(value.pop('supported_locales'))
value['Website'] = value.pop('website')
value['External ID'] = value.pop('external_id')
value['Last Updated'] = value.pop('updated_at')
value['Updated By'] = value.pop('updated_by')
value['URI'] = value.pop('uri')
values.field_names.extend([
'Owner', 'Collection ID', 'Collection Name', 'Collection Full Name', 'Collection Type', 'Description',
'Default Locale', 'Supported Locales', 'Website', 'External ID', 'Last Updated', 'Updated By', 'URI'
])
del values.field_names[0:12]
return values
class CollectionLogoView(CollectionBaseView, BaseLogoView):
serializer_class = CollectionDetailSerializer
def get_permissions(self):
if self.request.method in ['GET', 'HEAD']:
return [CanViewConceptDictionary()]
return [IsAuthenticated(), CanEditConceptDictionary()]
class CollectionRetrieveUpdateDestroyView(
CollectionBaseView, ConceptDictionaryUpdateMixin, RetrieveAPIView, TaskMixin
):
serializer_class = CollectionDetailSerializer
def get_object(self, queryset=None):
instance = self.get_queryset().filter(is_active=True).order_by('-created_at').first()
if not instance:
raise Http404()
self.check_object_permissions(self.request, instance)
if not get(settings, 'TEST_MODE', False):
if instance.should_set_active_concepts:
instance.update_concepts_count()
if instance.should_set_active_mappings:
instance.update_mappings_count()
for version in instance.versions.exclude(id=instance.id):
if version.should_set_active_concepts:
version.update_concepts_count()
if version.should_set_active_mappings:
version.update_mappings_count()
if Toggle.get('CHECKSUMS_TOGGLE'):
instance.get_checksums()
for version in instance.versions:
version.get_checksums()
return instance
def get_permissions(self):
if self.request.method in ['GET', 'HEAD']:
return [CanViewConceptDictionary()]
return [IsAuthenticated(), CanEditConceptDictionary()]
def delete(self, request, *args, **kwargs): # pylint: disable=unused-argument
collection = self.get_object()
result = self.perform_task(delete_collection, (collection.id, ))
if isinstance(result, Response):
return result
if result is True:
return Response({'detail': DELETE_SUCCESS}, status=status.HTTP_204_NO_CONTENT)
return Response({'detail': get(result, 'messages', [DELETE_FAILURE])}, status=status.HTTP_400_BAD_REQUEST)
class CollectionReferenceView(CollectionBaseView, RetrieveAPIView, DestroyAPIView):
serializer_class = CollectionReferenceDetailSerializer
def get_permissions(self):
if self.request.method == 'DELETE':
return [IsAuthenticated(), CanViewConceptDictionary()]
return [CanViewConceptDictionary()]
def get_object(self, queryset=None):
collection = super().get_queryset().filter(is_active=True).order_by('-created_at').first()
if not collection:
raise Http404()
if self.request.method == 'DELETE' and not collection.is_head:
raise Http405()
self.check_object_permissions(self.request, collection)
reference = CollectionReference.objects.filter(id=self.kwargs.get('reference')).first()
if not reference:
raise Http404()
return reference
def destroy(self, request, *args, **kwargs): # pylint: disable=unused-argument
reference = self.get_object()
collection = reference.collection
if collection.expansion_uri:
collection.expansion.delete_references(reference)
reference.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
class CollectionReferenceAbstractResourcesView(CollectionBaseView, ListWithHeadersMixin):
def get_queryset(self):
collection = super().get_queryset().filter(is_active=True).order_by('-created_at').first()
if not collection:
raise Http404()
self.check_object_permissions(self.request, collection)
reference = CollectionReference.objects.filter(id=self.kwargs.get('reference')).first()
if not reference:
raise Http404()
return reference
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
# Right now only for testing/debugging
class CollectionReferenceResolveView(CollectionReferenceAbstractResourcesView): # pragma: no cover
def get_serializer_class(self):
from core.sources.serializers import SourceVersionListSerializer
return SourceVersionListSerializer
def get(self, request, *args, **kwargs):
reference = self.get_queryset()
system_version = reference.resolve_system_version
valueset_versions = reference.resolve_valueset_versions
data = []
if system_version:
from core.sources.serializers import SourceVersionListSerializer
data.append(SourceVersionListSerializer(system_version).data)
if valueset_versions:
data += CollectionVersionListSerializer(valueset_versions, many=True).data
return Response(data)
class CollectionReferenceConceptsView(CollectionReferenceAbstractResourcesView):
is_searchable = True
document_model = ConceptDocument
es_fields = Concept.es_fields
facet_class = ConceptFacetedSearch
def get_serializer_class(self):
from core.concepts.serializers import ConceptVersionDetailSerializer, ConceptVersionListSerializer
return ConceptVersionDetailSerializer if self.is_verbose() else ConceptVersionListSerializer
def get_queryset(self):
return super().get_queryset().concepts
class CollectionReferenceMappingsView(CollectionReferenceAbstractResourcesView):
is_searchable = True
document_model = MappingDocument
es_fields = Mapping.es_fields
facet_class = MappingFacetedSearch
def get_serializer_class(self):
from core.mappings.serializers import MappingVersionDetailSerializer, MappingVersionListSerializer
return MappingVersionDetailSerializer if self.is_verbose() else MappingVersionListSerializer
def get_queryset(self):
return super().get_queryset().mappings
class CollectionReferencesView(
CollectionBaseView, ConceptDictionaryUpdateMixin, RetrieveAPIView, DestroyAPIView, ListWithHeadersMixin,
TaskMixin
):
def get_serializer_class(self):
if self.is_verbose():
return CollectionReferenceDetailSerializer
return CollectionReferenceSerializer
def get_permissions(self):
if self.request.method in ['GET', 'HEAD']:
return [CanViewConceptDictionary()]
return [CanEditConceptDictionary()]
def get_object(self, queryset=None):
instance = super().get_queryset().filter(is_active=True).order_by('-created_at').first()
if not instance:
raise Http404(NO_MATCH)
self.check_object_permissions(self.request, instance)
return instance
def get_queryset(self):
search_query = self.request.query_params.get('q', '')
sort = self.request.query_params.get('search_sort', 'ASC')
if sort == 'ASC':
sort = ''
else:
sort = '-'
instance = self.get_object()
queryset = instance.references
if search_query:
queryset = queryset.filter(expression__icontains=search_query).order_by(sort + 'expression')
else:
queryset = queryset.order_by('-id')
return queryset
def retrieve(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
@swagger_auto_schema(request_body=openapi.Schema(
type=openapi.TYPE_OBJECT,
properties={
'expressions': openapi.Schema(
type=openapi.TYPE_ARRAY,
items=openapi.Items(type=openapi.TYPE_STRING),
uniqueItems=True,
description='Expressions List from References, or * for ALL'
)
}
))
def delete(self, request, *args, **kwargs):
return super().delete(request, *args, **kwargs)
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
expressions = request.data.get("references") or request.data.get("expressions")
reference_ids = request.data.get("ids")
if not expressions and not reference_ids:
return Response(status=status.HTTP_400_BAD_REQUEST)
if self.should_cascade_mappings() and expressions != ALL and expressions:
expressions += instance.get_cascaded_mapping_uris_from_concept_expressions(expressions)
if expressions:
instance.delete_references(expressions)
if reference_ids:
references = instance.references.filter(id__in=reference_ids)
if instance.expansion_uri:
instance.expansion.delete_references(references)
references.delete()
return Response({'message': OK_MESSAGE}, status=status.HTTP_204_NO_CONTENT)
def update(self, request, *args, **kwargs): # pylint: disable=too-many-locals,unused-argument # Fixme: Sny
collection = self.get_object()
cascade = request.data.get('cascade', None) or self.request.query_params.get('cascade', '').lower()
transform = self.request.query_params.get('transformReferences', '').lower()
task_args = (self.request.user.id, request.data.get('data'), collection.id, cascade, transform)
result = self.perform_task(add_references, task_args)
if isinstance(result, Response):
return result
added_references_ids, errors = result
added_references = CollectionReference.objects.filter(
id__in=added_references_ids) if added_references_ids else []
added_expressions = set()
added_original_expressions = set()
for reference in added_references:
added_expressions.add(reference.expression)
if reference.cascade and reference.transform:
added_expression = reference.expression or reference.original_expression
else:
added_expression = reference.original_expression or reference.expression
added_original_expressions.add(added_expression)
if errors:
for expression in errors:
added_original_expressions.add(expression)
response = []
for expression in added_original_expressions:
response_item = self.create_response_item(added_expressions, errors, expression)
if response_item:
response.append(response_item)
return Response(response, status=status.HTTP_200_OK)
def should_cascade_mappings(self):
return self.request.query_params.get('cascade', '').lower() == SOURCE_MAPPINGS
def create_response_item(self, added_expressions, errors, expression):
adding_expression_failed = len(errors) > 0 and expression in errors
if adding_expression_failed:
return self.create_error_message(errors, expression)
return self.create_success_message(added_expressions, expression)
def create_success_message(self, added_expressions, expression):
message = self.select_update_message(expression)
references = list(filter(lambda expr: expr.startswith(expression), added_expressions))
if len(references) < 1:
return None
return {
'added': True,
'expression': references[0],
'message': message
}
@staticmethod
def create_error_message(errors, expression):
error_message = errors.get(expression, {})
return {
'added': False,
'expression': expression,
'message': error_message
}
def select_update_message(self, expression):
adding_head_version = not is_version_specified(expression)
expression_parts = expression.split('/')
resource_type = get(expression_parts, '5')
if adding_head_version:
return self.adding_to_head_message_by_type(resource_type)
resource_name = get(expression_parts, '6')
return self.version_added_message_by_type(resource_name, self.parent_resource.name, resource_type)
@staticmethod
def adding_to_head_message_by_type(resource_type):
if resource_type == 'concepts':
return HEAD_OF_CONCEPT_ADDED_TO_COLLECTION
if resource_type == 'mappings':
return HEAD_OF_MAPPING_ADDED_TO_COLLECTION
return UNKNOWN_REFERENCE_ADDED_TO_COLLECTION_FMT.format('')
@staticmethod
def version_added_message_by_type(resource_name, collection_name, resource_type):
if resource_type == 'concepts':
return CONCEPT_ADDED_TO_COLLECTION_FMT.format(resource_name, collection_name)
if resource_type == 'mappings':
return MAPPING_ADDED_TO_COLLECTION_FMT.format(resource_name, collection_name)
return UNKNOWN_REFERENCE_ADDED_TO_COLLECTION_FMT.format(collection_name)
class CollectionVersionReferencesView(CollectionVersionBaseView, ListWithHeadersMixin):
def get_serializer_class(self):
if self.is_verbose():
return CollectionReferenceDetailSerializer
return CollectionReferenceSerializer
def get(self, request, *args, **kwargs):
query_params = self.request.query_params
search_query = query_params.get('q', '')
sort = query_params.get('search_sort', 'ASC')
object_version = self.get_queryset().first()
if not object_version:
raise Http404()
references = object_version.references.filter(expression__icontains=search_query)
self.object_list = references if sort == 'ASC' else list(reversed(references))
return self.list(request, *args, **kwargs)
class CollectionVersionListView(CollectionVersionBaseView, CreateAPIView, ListWithHeadersMixin):
released_filter = None
processing_filter = None
default_qs_sort_attr = '-created_at'
def get_serializer_class(self):
if self.request.method in ['GET', 'HEAD'] and self.is_verbose():
return CollectionVersionDetailSerializer
if self.request.method == 'POST':
return CollectionCreateSerializer
if self.is_brief():
return CollectionVersionMinimalSerializer
return CollectionVersionListSerializer
def get(self, request, *args, **kwargs):
self.released_filter = parse_boolean_query_param(request, RELEASED_PARAM, self.released_filter)
self.processing_filter = parse_boolean_query_param(request, PROCESSING_PARAM, self.processing_filter)
return self.list(request, *args, **kwargs)
def create(self, request, *args, **kwargs):
head_object = self.get_queryset().first()
version = request.data.pop('id', None)
payload = {
"mnemonic": head_object.mnemonic, "id": head_object.mnemonic, "name": head_object.name, **request.data,
"organization_id": head_object.organization_id, "user_id": head_object.user_id,
'version': version
}
serializer = self.get_serializer(data=payload)
if serializer.is_valid():
try:
instance = serializer.create_version(payload)
if serializer.is_valid():
serializer = CollectionDetailSerializer(instance, context={'request': request})
return Response(serializer.data, status=status.HTTP_201_CREATED)
except IntegrityError as ex:
return Response(
{
'error': str(ex),
'detail': VERSION_ALREADY_EXISTS.format(version)
},
status=status.HTTP_409_CONFLICT
)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def get_queryset(self):
queryset = super().get_queryset()
if self.released_filter is not None:
queryset = queryset.filter(released=self.released_filter)
return queryset.order_by('-created_at')
class CollectionLatestVersionRetrieveUpdateView(CollectionVersionBaseView, RetrieveAPIView, UpdateAPIView):
serializer_class = CollectionVersionDetailSerializer
permission_classes = (CanViewConceptDictionaryVersion,)
def get_object(self, queryset=None):
obj = self.get_queryset().first()
if not obj:
raise Http404
self.check_object_permissions(self.request, obj)
return obj
def get_queryset(self):
queryset = super().get_queryset().filter(released=True)
return queryset.order_by('-created_at')
def update(self, request, *args, **kwargs):
self.object = self.get_object()
head = self.object.head
if not head:
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
serializer = self.get_serializer(self.object, data=request.data, partial=True)
if serializer.is_valid():
self.object = serializer.save(force_update=True)
if serializer.is_valid():
serializer = CollectionVersionDetailSerializer(self.object, context={'request': request})
return Response(serializer.data, status=status.HTTP_200_OK)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
class CollectionVersionRetrieveUpdateDestroyView(CollectionBaseView, RetrieveAPIView, UpdateAPIView, TaskMixin):
serializer_class = CollectionVersionDetailSerializer
def get_permissions(self):
if self.request.method == 'GET':
return [CanViewConceptDictionaryVersion()]
return [HasAccessToVersionedObject()]
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_queryset())
self.check_object_permissions(self.request, instance)
if not get(settings, 'TEST_MODE', False):
if instance.should_set_active_concepts:
instance.update_concepts_count()
if instance.should_set_active_mappings:
instance.update_mappings_count()
return instance
def update(self, request, *args, **kwargs):
self.object = self.get_object()
head = self.object.head
if not head:
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
serializer = self.get_serializer(self.object, data=request.data, partial=True)
if serializer.is_valid():
self.object = serializer.save(force_update=True)
if serializer.is_valid():
return Response(serializer.data, status=status.HTTP_200_OK)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
def delete(self, _, **kwargs): # pylint: disable=unused-argument
result = self.perform_task(delete_collection, (self.get_object().id,))
if isinstance(result, Response):
return result
if result is True:
return Response({'detail': DELETE_SUCCESS}, status=status.HTTP_204_NO_CONTENT)
return Response({'detail': get(result, 'messages', [DELETE_FAILURE])}, status=status.HTTP_400_BAD_REQUEST)
class CollectionVersionExpansionsView(CollectionBaseView, ListWithHeadersMixin, CreateAPIView):
sync = False
def get_serializer_class(self):
if self.is_verbose():
return ExpansionDetailSerializer
return ExpansionSerializer
def get_response_serializer_class(self):
return ExpansionSerializer
def get_permissions(self):
if self.request.method == 'GET':
return [CanViewConceptDictionaryVersion()]
return [HasAccessToVersionedObject()]
def get_queryset(self):
instance = get_object_or_404(super().get_queryset())
self.check_object_permissions(self.request, instance)
return instance.expansions.all()
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
return instance
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def create(self, request, *args, **kwargs):
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
version = self.get_object()
user = request.user
expansion = version.cascade_children_to_expansion(
expansion_data={**serializer.validated_data, 'created_by_id': user.id, 'updated_by_id': user.id},
index=True,
sync=self.sync
)
headers = self.get_success_headers(serializer.validated_data)
return Response(self.get_response_serializer_class()(expansion).data, status=status.HTTP_201_CREATED,
headers=headers)
class CollectionVersionExpansionBaseView(CollectionBaseView):
serializer_class = ExpansionSerializer
def get_permissions(self):
if self.request.method == 'GET':
return [CanViewConceptDictionaryVersion()]
return [HasAccessToVersionedObject()]
def get_object(self, queryset=None):
expansion = self.get_queryset().first()
if not expansion:
raise Http404()
return expansion
def get_queryset(self):
version = get_object_or_404(super().get_queryset())
self.check_object_permissions(self.request, version)
self.request.instance = version
return version.expansions.filter(mnemonic=self.kwargs.get('expansion'))
class CollectionVersionExpansionView(CollectionVersionExpansionBaseView, RetrieveAPIView, DestroyAPIView):
serializer_class = ExpansionDetailSerializer
permission_classes = (CanViewConceptDictionary, )
def destroy(self, request, *args, **kwargs): # pylint: disable=unused-argument
obj = self.get_object()
if obj.is_default:
return Response({'errors': ['Cannot delete default expansion']}, status=status.HTTP_400_BAD_REQUEST)
obj.delete()
return Response(status=status.HTTP_204_NO_CONTENT)
class CollectionVersionExpansionChildrenView(CollectionVersionExpansionBaseView, ListWithHeadersMixin):
def get_queryset(self):
expansion = super().get_queryset().first()
if not expansion:
raise Http404()
return expansion
def get(self, request, *args, **kwargs):
self.get_queryset()
return self.list(request, *args, **kwargs)
class CollectionVersionExpansionConceptsView(CollectionVersionExpansionChildrenView):
is_searchable = True
document_model = ConceptDocument
es_fields = Concept.es_fields
facet_class = ConceptFacetedSearch
def get_serializer_class(self):
from core.concepts.serializers import ConceptDetailSerializer, ConceptListSerializer
return ConceptDetailSerializer if self.is_verbose() else ConceptListSerializer
def get_queryset(self):
return super().get_queryset().concepts.filter()
class CollectionVersionExpansionMappingsView(CollectionVersionExpansionChildrenView):
is_searchable = True
document_model = MappingDocument
es_fields = Mapping.es_fields
facet_class = MappingFacetedSearch
def get_serializer_class(self):
from core.mappings.serializers import MappingDetailSerializer, MappingListSerializer
return MappingDetailSerializer if self.is_verbose() else MappingListSerializer
def get_queryset(self):
return super().get_queryset().mappings.filter()
class ExpansionResourcesIndexView(CollectionVersionExpansionBaseView):
serializer_class = TaskSerializer
permission_classes = (IsAdminUser, )
resource = None
def post(self, request, *args, **kwargs): # pylint: disable=unused-argument
expansion = self.get_object()
try:
if self.resource == 'concepts':
result = index_expansion_concepts.delay(expansion.id)
else:
result = index_expansion_mappings.delay(expansion.id)
except AlreadyQueued:
return Response({'detail': 'Already Queued'}, status=status.HTTP_409_CONFLICT)
return Response(
{'state': result.state, 'username': self.request.user.username, 'task': result.task_id, 'queue': 'default'},
status=status.HTTP_202_ACCEPTED
)
class ExpansionConceptsIndexView(ExpansionResourcesIndexView):
resource = 'concepts'
class ExpansionMappingsIndexView(ExpansionResourcesIndexView):
resource = 'mappings'
class CollectionVersionConceptsView(CollectionBaseView, ListWithHeadersMixin):
is_searchable = True
document_model = ConceptDocument
es_fields = Concept.es_fields
facet_class = ConceptFacetedSearch
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
self.request.instance = instance
return instance.expansion
def get_serializer_class(self):
return Concept.get_serializer_class(verbose=self.is_verbose(), version=True, brief=self.is_brief())
def get_queryset(self):
expansion = self.get_object()
queryset = Concept.objects.none()
if expansion:
queryset = expansion.concepts.filter()
return queryset
def get(self, request, *args, **kwargs):
self.get_object() # to set instance on request for references
return self.list(request, *args, **kwargs)
class CollectionVersionConceptRetrieveView(CollectionBaseView, RetrieveAPIView):
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
expansion = instance.expansion
if not expansion:
raise Http404()
self.request.instance = instance
concepts = expansion.concepts.filter(mnemonic=self.kwargs['concept'])
if 'concept_version' in self.kwargs:
concepts = concepts.filter(version=self.kwargs['concept_version'])
uri_param = self.request.query_params.dict().get('uri')
if uri_param:
concepts = concepts.filter(**Concept.get_parent_and_owner_filters_from_uri(uri_param))
count = concepts.count()
if count == 0:
raise Http404()
if count > 1 and not uri_param:
raise Http409()
return concepts.first()
def get_serializer_class(self):
from core.concepts.serializers import ConceptVersionDetailSerializer
return ConceptVersionDetailSerializer
class CollectionVersionExpansionConceptRetrieveView(CollectionBaseView, RetrieveAPIView):
def get_object(self, queryset=None):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
expansion = instance.expansions.filter(mnemonic=self.kwargs['expansion']).first()
if not expansion:
raise Http404()
self.request.instance = instance
concepts = expansion.concepts.filter(mnemonic=self.kwargs['concept'])
if 'concept_version' in self.kwargs:
concepts = concepts.filter(version=self.kwargs['concept_version'])
uri_param = self.request.query_params.dict().get('uri')
if uri_param:
concepts = concepts.filter(**Concept.get_parent_and_owner_filters_from_uri(uri_param))
count = concepts.count()
if count == 0:
raise Http404()
if count > 1 and not uri_param:
raise Http409()
return concepts.first()
def get_serializer_class(self):
from core.concepts.serializers import ConceptVersionDetailSerializer
return ConceptVersionDetailSerializer
class CollectionVersionConceptMappingsView(CollectionBaseView, ListWithHeadersMixin):
def get_queryset(self):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
expansion = instance.expansion
if not expansion:
raise Http404()
self.request.instance = instance
concepts = expansion.concepts.filter(mnemonic=self.kwargs['concept'])
if 'concept_version' in self.kwargs:
concepts = concepts.filter(version=self.kwargs['concept_version'])
uri_param = self.request.query_params.dict().get('uri')
if uri_param:
concepts = concepts.filter(**Concept.get_parent_and_owner_filters_from_uri(uri_param))
count = concepts.count()
if count == 0:
raise Http404()
if count > 1 and not uri_param:
raise Http409()
concept = concepts.first()
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'
mappings_queryset = expansion.get_mappings_for_concept(
concept=concept, include_indirect=include_indirect_mappings)
if not include_retired:
mappings_queryset = mappings_queryset.exclude(retired=True)
return mappings_queryset
def get_serializer_class(self):
return Mapping.get_serializer_class(verbose=self.is_verbose(), version=True, brief=self.is_brief())
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class CollectionVersionExpansionConceptMappingsView(CollectionBaseView, ListWithHeadersMixin):
def get_queryset(self):
instance = get_object_or_404(self.get_base_queryset())
self.check_object_permissions(self.request, instance)
expansion = instance.expansions.filter(mnemonic=self.kwargs['expansion']).first()
if not expansion:
raise Http404()
self.request.instance = instance
concepts = expansion.concepts.filter(mnemonic=self.kwargs['concept'])
if 'concept_version' in self.kwargs:
concepts = concepts.filter(version=self.kwargs['concept_version'])
uri_param = self.request.query_params.dict().get('uri')
if uri_param:
concepts = concepts.filter(**Concept.get_parent_and_owner_filters_from_uri(uri_param))
count = concepts.count()
if count == 0: