-
Notifications
You must be signed in to change notification settings - Fork 27
/
views.py
277 lines (221 loc) · 11.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
from django.db.models import F
from django.http import QueryDict
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 DestroyAPIView, UpdateAPIView, RetrieveAPIView, ListAPIView, \
RetrieveUpdateDestroyAPIView
from rest_framework.mixins import CreateModelMixin
from rest_framework.response import Response
from core.common.constants import HEAD, NOT_FOUND, MUST_SPECIFY_EXTRA_PARAM_IN_BODY
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_retired_param
)
from core.common.views import SourceChildCommonBaseView
from core.concepts.permissions import CanEditParentDictionary, CanViewParentDictionary
from core.mappings.constants import COULD_NOT_FIND_MAPPING_TO_RETIRE, COULD_NOT_FIND_MAPPING_TO_UPDATE, \
PARENT_VERSION_NOT_LATEST_CANNOT_UPDATE_MAPPING
from core.mappings.documents import MappingDocument
from core.mappings.models import Mapping
from core.mappings.search import MappingSearch
from core.mappings.serializers import MappingDetailSerializer, MappingListSerializer
class MappingBaseView(SourceChildCommonBaseView):
lookup_field = 'mapping'
model = Mapping
queryset = Mapping.objects.filter(is_active=True)
document_model = MappingDocument
facet_class = MappingSearch
es_fields = {
'last_update': {'sortable': True, 'filterable': False, 'facet': False, 'default': 'desc'},
'concept': {'sortable': False, 'filterable': True, 'facet': False, 'exact': True},
'from_concept': {'sortable': False, 'filterable': True, 'facet': False, 'exact': True},
'to_concept': {'sortable': False, 'filterable': True, 'facet': False, 'exact': True},
'retired': {'sortable': False, 'filterable': True, 'facet': True},
'map_type': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'source': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'collection': {'sortable': False, 'filterable': True, 'facet': True},
'owner': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'owner_type': {'sortable': False, 'filterable': True, 'facet': True},
'concept_source': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'from_concept_source': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'to_concept_source': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'concept_owner': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'from_concept_owner': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'to_concept_owner': {'sortable': False, 'filterable': True, 'facet': True, 'exact': True},
'concept_owner_type': {'sortable': False, 'filterable': True, 'facet': True},
'from_concept_owner_type': {'sortable': False, 'filterable': True, 'facet': True},
'to_concept_owner_type': {'sortable': False, 'filterable': True, 'facet': True},
}
@staticmethod
def get_detail_serializer(obj, data=None, files=None, partial=False):
return MappingDetailSerializer(obj, data, files, partial)
def get_queryset(self):
return Mapping.get_base_queryset(self.params)
class MappingListView(MappingBaseView, ListWithHeadersMixin, CreateModelMixin):
serializer_class = MappingListSerializer
def get_permissions(self):
if self.request.method == 'POST':
return [CanEditParentDictionary(), ]
return [CanViewParentDictionary(), ]
def get_serializer_class(self):
if (self.request.method == 'GET' and self.is_verbose(self.request)) or self.request.method == 'POST':
return MappingDetailSerializer
return MappingListSerializer
def get_queryset(self):
is_latest_version = 'collection' not in self.kwargs
queryset = super().get_queryset()
if is_latest_version:
queryset = queryset.filter(is_latest_version=True)
return queryset.select_related(
'parent__organization', 'parent__user', 'from_concept__parent', 'to_concept__parent', 'to_source',
'versioned_object',
)
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def set_parent_resource(self):
from core.sources.models import Source
source = self.kwargs.pop('source', None)
source_version = self.kwargs.pop('version', HEAD)
parent_resource = None
if 'org' in self.kwargs:
filters = dict(organization__mnemonic=self.kwargs['org'])
else:
filters = dict(user__username=self.kwargs['user'])
if source:
parent_resource = Source.get_version(source, source_version, filters)
self.kwargs['parent_resource'] = self.parent_resource = parent_resource
def post(self, request, **kwargs): # pylint: disable=unused-argument
self.set_parent_resource()
data = request.data.dict() if isinstance(request.data, QueryDict) else request.data
serializer = self.get_serializer(data={
**data, 'parent_id': self.parent_resource.id
})
if serializer.is_valid():
self.object = serializer.save()
if serializer.is_valid():
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 MappingRetrieveUpdateDestroyView(MappingBaseView, RetrieveAPIView, UpdateAPIView, DestroyAPIView):
serializer_class = MappingDetailSerializer
def get_object(self, queryset=None):
return get_object_or_404(self.get_queryset(), is_latest_version=True)
def get_permissions(self):
if self.request.method in ['GET']:
return [CanViewParentDictionary(), ]
return [CanEditParentDictionary(), ]
def update(self, request, *args, **kwargs):
self.object = self.get_object()
partial = kwargs.pop('partial', True)
if self.object is None:
return Response(
{'non_field_errors': COULD_NOT_FIND_MAPPING_TO_UPDATE}, status=status.HTTP_404_NOT_FOUND
)
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_MAPPING},
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 destroy(self, request, *args, **kwargs):
mapping = self.get_object()
if not mapping:
return Response(
dict(non_field_errors=COULD_NOT_FIND_MAPPING_TO_RETIRE),
status=status.HTTP_404_NOT_FOUND
)
comment = request.data.get('update_comment', None) or request.data.get('comment', None)
errors = mapping.retire(request.user, comment)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
return Response(status=status.HTTP_204_NO_CONTENT)
class MappingVersionsView(MappingBaseView, ConceptDictionaryMixin, ListWithHeadersMixin):
permission_classes = (CanViewParentDictionary,)
def get_queryset(self):
return super().get_queryset().exclude(id=F('versioned_object_id'))
def get_serializer_class(self):
return MappingDetailSerializer if self.is_verbose(self.request) else MappingListSerializer
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class MappingVersionRetrieveView(MappingBaseView, RetrieveAPIView):
serializer_class = MappingDetailSerializer
permission_classes = (CanViewParentDictionary,)
def get_object(self, queryset=None):
return get_object_or_404(self.get_queryset())
class MappingVersionListAllView(MappingBaseView, ListWithHeadersMixin):
permission_classes = (CanViewParentDictionary,)
def get_serializer_class(self):
if self.is_verbose(self.request):
return MappingDetailSerializer
return MappingListSerializer
def get_queryset(self):
return Mapping.global_listing_queryset(
self.get_filter_params(), self.request.user
).select_related(
'parent__organization', 'parent__user',
)
@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, updated_since_param,
include_facets_header
]
)
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
class MappingExtrasBaseView(MappingBaseView):
default_qs_sort_attr = '-created_at'
def get_object(self, queryset=None):
return self.get_queryset().filter(is_latest_version=True).first()
class MappingExtrasView(MappingExtrasBaseView, ListAPIView):
permission_classes = (CanViewParentDictionary,)
serializer_class = MappingDetailSerializer
def list(self, request, *args, **kwargs):
return Response(get(self.get_object(), 'extras', {}))
class MappingExtraRetrieveUpdateDestroyView(MappingExtrasBaseView, RetrieveUpdateDestroyAPIView):
serializer_class = MappingDetailSerializer
def get_permissions(self):
if self.request.method in ['GET', 'HEAD']:
return [CanViewParentDictionary()]
return [CanEditParentDictionary()]
def retrieve(self, request, *args, **kwargs):
key = kwargs.get('extra')
instance = self.get_object()
extras = get(instance, 'extras', {})
if key in extras:
return Response({key: extras[key]})
return Response(dict(detail=NOT_FOUND), status=status.HTTP_404_NOT_FOUND)
def update(self, request, **kwargs):
key = kwargs.get('extra')
value = request.data.get(key)
if not value:
return Response([MUST_SPECIFY_EXTRA_PARAM_IN_BODY.format(key)], status=status.HTTP_400_BAD_REQUEST)
new_version = self.get_object().clone()
new_version.extras[key] = value
new_version.comment = 'Updated extras: %s=%s.' % (key, value)
errors = Mapping.persist_clone(new_version, request.user)
if errors:
return Response(errors, status=status.HTTP_400_BAD_REQUEST)
return Response({key: value})
def delete(self, request, *args, **kwargs):
key = kwargs.get('extra')
new_version = self.get_object().clone()
if key in new_version.extras:
del new_version.extras[key]
new_version.comment = 'Deleted extra %s.' % key
errors = Mapping.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)
return Response(dict(detail=NOT_FOUND), status=status.HTTP_404_NOT_FOUND)