-
Notifications
You must be signed in to change notification settings - Fork 31
/
models.py
431 lines (356 loc) · 16.7 KB
/
models.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
import json
from django.core.exceptions import ValidationError
from django.db import models, transaction
from django.db.models import UniqueConstraint
from django.utils import timezone
from rest_framework.test import APIRequestFactory
from core.collections.constants import (
COLLECTION_TYPE, EXPRESSION_INVALID, CONCEPTS_EXPRESSIONS,
MAPPINGS_EXPRESSIONS,
REFERENCE_ALREADY_EXISTS, CONCEPT_FULLY_SPECIFIED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE,
CONCEPT_PREFERRED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE, ALL_SYMBOL, COLLECTION_VERSION_TYPE)
from core.collections.utils import is_concept, is_mapping
from core.common.constants import (
DEFAULT_REPOSITORY_TYPE, ACCESS_TYPE_VIEW, ACCESS_TYPE_EDIT
)
from core.common.models import ConceptContainerModel
from core.common.utils import reverse_resource, is_valid_uri, drop_version
from core.concepts.constants import LOCALES_FULLY_SPECIFIED
from core.concepts.models import Concept
from core.concepts.views import ConceptListView
from core.mappings.models import Mapping
from core.mappings.views import MappingListView
class Collection(ConceptContainerModel):
OBJECT_TYPE = COLLECTION_TYPE
OBJECT_VERSION_TYPE = COLLECTION_VERSION_TYPE
class Meta:
db_table = 'collections'
constraints = [
UniqueConstraint(
fields=['mnemonic', 'version', 'organization'],
name="org_collection_unique",
condition=models.Q(user=None),
),
UniqueConstraint(
fields=['mnemonic', 'version', 'user'],
name="user_collection_unique",
condition=models.Q(organization=None),
)
]
collection_type = models.TextField(blank=True)
preferred_source = models.TextField(blank=True)
repository_type = models.TextField(default=DEFAULT_REPOSITORY_TYPE, blank=True)
custom_resources_linked_source = models.TextField(blank=True)
concepts = models.ManyToManyField('concepts.Concept', blank=True, related_name='collection_set')
mappings = models.ManyToManyField('mappings.Mapping', blank=True, related_name='collection_set')
references = models.ManyToManyField('collections.CollectionReference', blank=True, related_name='collections')
immutable = models.BooleanField(default=False)
@classmethod
def get_base_queryset(cls, params):
collection = params.pop('collection', None)
contains_uri = params.pop('contains', None)
include_references = params.pop('include_references', None) in [True, 'true']
queryset = super().get_base_queryset(params)
if collection:
queryset = queryset.filter(cls.get_iexact_or_criteria('mnemonic', collection))
if contains_uri:
queryset = queryset.filter(
references__expression=contains_uri, public_access__in=[ACCESS_TYPE_EDIT, ACCESS_TYPE_VIEW]
)
if include_references:
queryset = queryset.prefetch_related('references')
return queryset
@property
def collection(self):
return self.mnemonic
@staticmethod
def get_resource_url_kwarg():
return 'collection'
@property
def versions_url(self):
return reverse_resource(self, 'collection-version-list')
def update_version_data(self, obj=None):
super().update_version_data(obj)
if not obj:
obj = self.get_latest_version()
if obj:
self.collection_type = obj.collection_type
self.custom_resources_linked_source = obj.custom_resources_linked_source
self.repository_type = obj.repository_type
self.preferred_source = obj.preferred_source
def add_concept(self, concept):
self.concepts.add(concept)
def add_mapping(self, mapping):
self.mappings.add(mapping)
def get_concepts(self, start=None, end=None):
""" Use for efficient iteration over paginated concepts. Note that any filter will be applied only to concepts
from the given range. If you need to filter on all concepts, use get_concepts() without args.
"""
concepts = self.concepts.all()
if start and end:
concepts = concepts[start:end]
return concepts
def fill_data_from_reference(self, reference):
self.references.add(reference)
if reference.concepts:
self.concepts.add(*reference.concepts)
if reference.mappings:
self.mappings.add(*reference.mappings)
self.save() # update counts
def validate(self, reference):
reference.full_clean()
if reference.without_version in [reference.without_version for reference in self.references.all()]:
raise ValidationError({reference.expression: [REFERENCE_ALREADY_EXISTS]})
if self.is_openmrs_schema:
if reference.concepts and reference.concepts.count() == 0:
return
concept = reference.concepts[0]
self.check_concept_uniqueness_in_collection_and_locale_by_name_attribute(
concept, attribute='type__in', value=LOCALES_FULLY_SPECIFIED,
error_message=CONCEPT_FULLY_SPECIFIED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE
)
self.check_concept_uniqueness_in_collection_and_locale_by_name_attribute(
concept, attribute='locale_preferred', value=True,
error_message=CONCEPT_PREFERRED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE
)
def check_concept_uniqueness_in_collection_and_locale_by_name_attribute(
self, concept, attribute, value, error_message
):
other_concepts_in_collection = self.concepts
if not other_concepts_in_collection.exists():
return
matching_names_in_concept = dict()
names = concept.names.filter(**{attribute: value})
for name in names:
validation_error = dict(names=[error_message])
# making sure names in the submitted concept meet the same rule
name_key = name.locale + name.name
if name_key in matching_names_in_concept:
raise ValidationError(validation_error)
matching_names_in_concept[name_key] = True
if other_concepts_in_collection.filter(names__name=name.name, names__locale=name.locale).exists():
raise ValidationError(validation_error)
@staticmethod
def __get_children_uris(url, view_klass):
view = view_klass.as_view()
request = APIRequestFactory().get(url)
response = view(request)
response.render()
data = json.loads(response.content)
return [child['url'] for child in data]
def __get_expressions_from(self, expressions, url, view_klass):
if expressions == ALL_SYMBOL:
return self.__get_children_uris(url, view_klass)
return expressions
@staticmethod
def __get_children_list_url(child_type, host_url, data):
return "{host_url}{uri}{child_type}?q={search_term}&limit=0".format(
host_url=host_url, uri=data.get('uri'), child_type=child_type, search_term=data.get('search_term', '')
)
@transaction.atomic
def add_expressions(self, data, host_url, user, cascade_mappings=False):
expressions = data.get('expressions', [])
concept_expressions = data.get('concepts', [])
mapping_expressions = data.get('mappings', [])
expressions.extend(
self.__get_expressions_from(
concept_expressions, self.__get_children_list_url('concepts', host_url, data), ConceptListView
)
)
expressions.extend(
self.__get_expressions_from(
mapping_expressions, self.__get_children_list_url('mappings', host_url, data), MappingListView
)
)
if cascade_mappings:
all_related_mappings = self.get_all_related_mappings(expressions)
expressions += all_related_mappings
return self.add_references_in_bulk(expressions, user)
def add_references_in_bulk(self, expressions, user=None): # pylint: disable=too-many-locals # Fixme: Sny
errors = {}
collection_version = self.head
new_expressions = set(expressions)
new_versionless_expressions = {drop_version(expression): expression for expression in new_expressions}
for reference in collection_version.references.all():
existing_versionless_expression = reference.without_version
if existing_versionless_expression in new_versionless_expressions:
existing_expression = new_versionless_expressions[existing_versionless_expression]
new_expressions.discard(existing_expression)
errors[existing_expression] = [REFERENCE_ALREADY_EXISTS]
added_references = list()
for expression in new_expressions:
ref = CollectionReference(expression=expression)
try:
ref.clean()
ref.save()
except Exception as ex:
errors[expression] = ex.messages if hasattr(ex, 'messages') else ex
continue
added = False
if ref.concepts:
if self.is_openmrs_schema:
for concept in ref.concepts:
try:
self.check_concept_uniqueness_in_collection_and_locale_by_name_attribute(
concept, attribute='type__in', value=LOCALES_FULLY_SPECIFIED,
error_message=CONCEPT_FULLY_SPECIFIED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE
)
self.check_concept_uniqueness_in_collection_and_locale_by_name_attribute(
concept, attribute='locale_preferred', value=True,
error_message=CONCEPT_PREFERRED_NAME_UNIQUE_PER_COLLECTION_AND_LOCALE
)
except Exception as ex:
errors[expression] = ex.messages if hasattr(ex, 'messages') else ex
continue
collection_version.add_concept(concept)
added = True
else:
collection_version.concepts.add(*ref.concepts.all())
added = True
if ref.mappings:
collection_version.mappings.add(*ref.mappings.all())
added = True
if added:
collection_version.references.add(ref)
self.references.add(ref)
added_references.append(ref)
if user and user.is_authenticated:
collection_version.updated_by = user
self.updated_by = user
collection_version.save()
self.save()
return added_references, errors
def add_references(self, expressions, user=None):
errors = {}
for expression in expressions:
reference = CollectionReference(expression=expression)
try:
self.validate(reference)
reference.save()
except Exception as ex:
errors[expression] = ex.messages if hasattr(ex, 'messages') else ex
continue
head = self.head
ref_hash = {'col_reference': reference}
error = Collection.persist_changes(head, user, **ref_hash)
if error:
errors[expression] = error
return errors
@classmethod
def persist_changes(cls, obj, updated_by, **kwargs):
col_reference = kwargs.pop('col_reference', False)
errors = super().persist_changes(obj, updated_by, **kwargs)
if col_reference and not errors:
obj.fill_data_from_reference(col_reference)
return errors
def seed_references(self):
head = self.head
if head:
references = CollectionReference.objects.bulk_create(
[CollectionReference(expression=ref.expression) for ref in head.references.all()]
)
self.references.set(references)
@staticmethod
def is_validation_necessary():
return False
def delete_references(self, expressions):
head = self.head
head.concepts.set(head.concepts.exclude(uri__in=expressions))
head.mappings.set(head.mappings.exclude(uri__in=expressions))
head.references.set(head.references.exclude(expression__in=expressions))
from core.concepts.documents import ConceptDocument
from core.mappings.documents import MappingDocument
ConceptDocument().update(Concept.objects.filter(uri__in=expressions))
MappingDocument().update(Mapping.objects.filter(uri__in=expressions))
@staticmethod
def __get_children_from_expressions(expressions):
concepts = Concept.objects.filter(uri__in=expressions)
mappings = Mapping.objects.filter(uri__in=expressions)
return concepts, mappings
def get_all_related_mappings(self, expressions):
all_related_mappings = []
unversioned_mappings = []
concept_expressions = []
for expression in expressions:
if is_mapping(expression):
unversioned_mappings.append(drop_version(expression))
elif is_concept(expression):
concept_expressions.append(expression)
for concept_expression in concept_expressions:
ref = CollectionReference(expression=concept_expression)
try:
self.validate(ref)
all_related_mappings += ref.get_related_mappings(unversioned_mappings)
except: # pylint: disable=bare-except
continue
return all_related_mappings
class CollectionReference(models.Model):
class Meta:
db_table = 'collection_references'
concepts = None
mappings = None
original_expression = None
id = models.BigAutoField(primary_key=True)
internal_reference_id = models.CharField(max_length=255, null=True, blank=True)
expression = models.TextField()
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
last_resolved_at = models.DateTimeField(default=timezone.now)
@staticmethod
def get_concept_heads_from_expression(expression):
return Concept.get_latest_versions_for_queryset(Concept.from_uri_queryset(expression))
@staticmethod
def diff(ctx, _from):
prev_expressions = map(lambda r: r.expression, _from)
return filter(lambda ref: ref.expression not in prev_expressions, ctx)
@property
def without_version(self):
return drop_version(self.expression)
@property
def is_valid_expression(self):
return is_valid_uri(self.expression) and self.expression.count('/') >= 7
@property
def reference_type(self):
reference = None
if is_concept(self.expression):
reference = CONCEPTS_EXPRESSIONS
if is_mapping(self.expression):
reference = MAPPINGS_EXPRESSIONS
return reference
def get_concepts(self):
return Concept.from_uri_queryset(self.expression)
def get_mappings(self):
return Mapping.from_uri_queryset(self.expression)
def clean(self):
self.original_expression = str(self.expression)
if not self.is_valid_expression:
raise ValidationError(dict(detail=[EXPRESSION_INVALID]))
self.create_entities_from_expressions()
def save(self, force_insert=False, force_update=False, using=None, update_fields=None):
if not self.internal_reference_id and self.id:
self.internal_reference_id = str(self.id)
super().save(force_insert, force_update, using, update_fields)
def create_entities_from_expressions(self):
__is_concept = is_concept(self.expression)
__is_mapping = is_mapping(self.expression)
if __is_concept:
self.concepts = self.get_concepts()
elif __is_mapping:
self.mappings = self.get_mappings()
if (not self.concepts or not self.concepts.exists()) and (not self.mappings or not self.mappings.exists()):
raise ValidationError({'detail': [EXPRESSION_INVALID]})
if __is_concept:
self.expression = self.concepts.first().uri
elif __is_mapping:
self.expression = self.mappings.first().uri
def get_related_mappings(self, exclude_mapping_uris):
mappings = []
concepts = self.get_concepts()
if concepts.exists():
for concept in concepts:
mappings = list(
concept.get_unidirectional_mappings().exclude(
uri__in=exclude_mapping_uris
).values_list('uri', flat=True)
)
return mappings