-
Notifications
You must be signed in to change notification settings - Fork 27
/
models.py
519 lines (428 loc) · 18.8 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
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
from django.conf import settings
from django.core.exceptions import ValidationError
from django.db import models, IntegrityError, transaction
from django.db.models import F
from pydash import get, compact
from core.common.constants import TEMP, ISO_639_1, INCLUDE_RETIRED_PARAM
from core.common.mixins import SourceChildMixin
from core.common.models import VersionedModel
from core.common.utils import reverse_resource, parse_updated_since_param
from core.concepts.constants import CONCEPT_TYPE, LOCALES_FULLY_SPECIFIED, LOCALES_SHORT, LOCALES_SEARCH_INDEX_TERM, \
CONCEPT_WAS_RETIRED, CONCEPT_IS_ALREADY_RETIRED, CONCEPT_IS_ALREADY_NOT_RETIRED, CONCEPT_WAS_UNRETIRED, \
PERSIST_CLONE_ERROR, PERSIST_CLONE_SPECIFY_USER_ERROR, ALREADY_EXISTS
from core.concepts.mixins import ConceptValidationMixin
class LocalizedText(models.Model):
class Meta:
db_table = 'localized_texts'
id = models.BigAutoField(primary_key=True)
internal_reference_id = models.CharField(max_length=255, null=True, blank=True)
external_id = models.TextField(null=True, blank=True)
name = models.TextField()
type = models.TextField(null=True, blank=True)
locale = models.TextField()
locale_preferred = models.BooleanField(default=False)
created_at = models.DateTimeField(auto_now_add=True)
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 clone(self):
return LocalizedText(
external_id=self.external_id,
name=self.name,
type=self.type,
locale=self.locale,
locale_preferred=self.locale_preferred
)
@classmethod
def build(cls, params, used_as='name'):
instance = None
if used_as == 'name':
instance = cls.build_name(params)
if used_as == 'description':
instance = cls.build_description(params)
return instance
@classmethod
def build_name(cls, params):
return LocalizedText(
**{**params, 'type': params.pop('name_type', params.pop('type', None))}
)
@classmethod
def build_description(cls, params):
return LocalizedText(
**{
**params,
'type': params.pop('description_type', params.pop('type', None)),
'name': params.pop('description', params.pop('name', None)),
}
)
@property
def is_fully_specified(self):
return self.type in LOCALES_FULLY_SPECIFIED
@property
def is_short(self):
return self.type in LOCALES_SHORT
@property
def is_search_index_term(self):
return self.type in LOCALES_SEARCH_INDEX_TERM
class Concept(ConceptValidationMixin, SourceChildMixin, VersionedModel): # pylint: disable=too-many-public-methods
class Meta:
db_table = 'concepts'
unique_together = ('mnemonic', 'version', 'parent')
external_id = models.TextField(null=True, blank=True)
concept_class = models.TextField()
datatype = models.TextField()
names = models.ManyToManyField(LocalizedText, related_name='name_locales')
descriptions = models.ManyToManyField(LocalizedText, related_name='description_locales')
comment = models.TextField(null=True, blank=True)
parent = models.ForeignKey('sources.Source', related_name='concepts_set', on_delete=models.CASCADE)
sources = models.ManyToManyField('sources.Source', related_name='concepts')
versioned_object = models.ForeignKey(
'self', related_name='versions_set', null=True, blank=True, on_delete=models.CASCADE
)
OBJECT_TYPE = CONCEPT_TYPE
ALREADY_RETIRED = CONCEPT_IS_ALREADY_RETIRED
ALREADY_NOT_RETIRED = CONCEPT_IS_ALREADY_NOT_RETIRED
WAS_RETIRED = CONCEPT_WAS_RETIRED
WAS_UNRETIRED = CONCEPT_WAS_UNRETIRED
@property
def concept(self): # for url kwargs
return self.mnemonic # pragma: no cover
@staticmethod
def get_resource_url_kwarg():
return 'concept'
@staticmethod
def get_version_url_kwarg():
return 'concept_version'
@property
def display_name(self):
return get(self.preferred_locale, 'name')
@property
def display_locale(self):
return get(self.preferred_locale, 'locale')
@property
def preferred_locale(self):
return self.__get_parent_default_locale_name() or self.__get_parent_supported_locale_name() or \
self.__get_system_default_locale() or self.__get_preferred_locale() or self.__get_last_created_locale()
def __get_system_default_locale(self):
system_default_locale = settings.DEFAULT_LOCALE
return get(
self.__names_qs(dict(locale=system_default_locale, locale_preferred=True), 'created_at', 'desc'), '0'
) or get(
self.__names_qs(dict(locale=system_default_locale), 'created_at', 'desc'), '0'
)
def __get_parent_default_locale_name(self):
parent_default_locale = self.parent.default_locale
return get(
self.__names_qs(dict(locale=parent_default_locale, locale_preferred=True), 'created_at', 'desc'), '0'
) or get(
self.__names_qs(dict(locale=parent_default_locale), 'created_at', 'desc'), '0'
)
def __get_parent_supported_locale_name(self):
parent_supported_locales = self.parent.supported_locales
return get(
self.__names_qs(dict(locale__in=parent_supported_locales, locale_preferred=True), 'created_at', 'desc'), '0'
) or get(
self.__names_qs(dict(locale__in=parent_supported_locales), 'created_at', 'desc'), '0'
)
def __get_last_created_locale(self):
return get(self.__names_qs(dict(), 'created_at', 'desc'), '0')
def __get_preferred_locale(self):
return get(
self.__names_qs(dict(locale_preferred=True), 'created_at', 'desc'), '0'
)
def __names_qs(self, filters, order_by=None, order='desc'):
if getattr(self, '_prefetched_objects_cache', None) and \
'names' in self._prefetched_objects_cache: # pragma: no cover
return self.__names_from_prefetched_object_cache(filters, order_by, order)
return self.__names_from_db(filters, order_by, order)
def __names_from_db(self, filters, order_by=None, order='desc'):
names = self.names.filter(
**filters
)
if order_by:
if order:
order_by = '-' + order_by if order.lower() == 'desc' else order_by
names = names.order_by(order_by)
return names
def __names_from_prefetched_object_cache(self, filters, order_by=None, order='desc'): # pragma: no cover
def is_eligible(name):
return all([get(name, key) == value for key, value in filters.items()])
names = list(filter(is_eligible, self.names.all()))
if order_by:
names = sorted(names, key=lambda name: get(name, order_by), reverse=(order.lower() == 'desc'))
return names
@property
def default_name_locales(self):
return self.get_default_locales(self.names)
@property
def default_description_locales(self):
return self.get_default_locales(self.descriptions)
@staticmethod
def get_default_locales(locales):
return locales.filter(locale=settings.DEFAULT_LOCALE)
@property
def names_for_default_locale(self):
return list(self.default_name_locales.values_list('name', flat=True))
@property
def descriptions_for_default_locale(self):
return list(self.default_description_locales.values_list('name', flat=True))
@property
def iso_639_1_locale(self):
return get(self.__names_qs(dict(type=ISO_639_1)), '0.name')
@property
def custom_validation_schema(self):
return get(self, 'parent.custom_validation_schema')
@property
def versions_url(self):
return reverse_resource(self, 'concept-version-list')
@property
def all_names(self):
return list(self.names.values_list('name', flat=True))
@property
def saved_unsaved_descriptions(self):
unsaved_descriptions = get(self, 'cloned_descriptions', [])
if self.id:
return compact([*list(self.descriptions.all()), *unsaved_descriptions])
return unsaved_descriptions
@property
def saved_unsaved_names(self):
unsaved_names = get(self, 'cloned_names', [])
if self.id:
return compact([*list(self.names.all()), *unsaved_names])
return unsaved_names
@classmethod
def get_base_queryset(cls, params): # pylint: disable=too-many-branches
queryset = cls.objects.filter(is_active=True)
user = params.get('user', None)
org = params.get('org', None)
collection = params.get('collection', None)
source = params.get('source', None)
container_version = params.get('version', None)
concept = params.get('concept', None)
concept_version = params.get('concept_version', None)
is_latest = params.get('is_latest', None)
include_retired = params.get(INCLUDE_RETIRED_PARAM, False)
updated_since = parse_updated_since_param(params)
if collection:
queryset = queryset.filter(collection_set__mnemonic__in=collection.split(','))
if user:
queryset = queryset.filter(collection_set__user__username__in=user.split(','))
if org:
queryset = queryset.filter(collection_set__organization__mnemonic__in=org.split(','))
if container_version:
queryset = queryset.filter(collection_set__version__in=container_version.split(','))
if source:
queryset = queryset.filter(sources__mnemonic__in=source.split(','))
if user:
queryset = queryset.filter(parent__user__username__in=user.split(','))
if org:
queryset = queryset.filter(parent__organization__mnemonic__in=org.split(','))
if container_version:
queryset = queryset.filter(sources__version__in=container_version.split(','))
if concept:
queryset = queryset.filter(mnemonic__iexact=concept)
if concept_version:
queryset = queryset.filter(version__in=concept_version.split(','))
if is_latest:
queryset = queryset.filter(is_latest_version=True)
if not include_retired:
queryset = queryset.filter(retired=False)
if updated_since:
queryset = queryset.filter(updated_at__gte=updated_since)
return queryset.distinct()
def clone(self):
concept_version = Concept(
mnemonic=self.mnemonic,
version=TEMP,
public_access=self.public_access,
external_id=self.external_id,
concept_class=self.concept_class,
datatype=self.datatype,
retired=self.retired,
released=self.released,
extras=self.extras or dict(),
parent=self.parent,
is_latest_version=self.is_latest_version,
parent_id=self.parent_id,
versioned_object_id=self.versioned_object_id,
)
concept_version.cloned_names = self.__clone_name_locales()
concept_version.cloned_descriptions = self.__clone_description_locales()
return concept_version
@classmethod
def version_for_concept(cls, concept, version_label, parent_version=None):
version = concept.clone()
version.version = version_label
version.created_by_id = concept.created_by_id
version.updated_by_id = concept.updated_by_id
if parent_version:
version.parent = parent_version
version.released = False
return version
@classmethod
def create_initial_version(cls, concept, **kwargs):
initial_version = cls.version_for_concept(concept, TEMP)
initial_version.save(**kwargs)
initial_version.version = initial_version.id
initial_version.released = True
initial_version.is_latest_version = True
initial_version.save()
return initial_version
def set_locales(self):
if not self.id:
return # pragma: no cover
names = get(self, 'cloned_names', [])
descriptions = get(self, 'cloned_descriptions', [])
for name in names:
name.save()
for desc in descriptions:
desc.save()
self.names.set(names)
self.descriptions.set(descriptions)
def remove_locales(self):
self.names.all().delete()
self.descriptions.all().delete()
def __clone_name_locales(self):
return self.__clone_locales(self.names)
def __clone_description_locales(self):
return self.__clone_locales(self.descriptions)
@staticmethod
def __clone_locales(locales):
return [locale.clone() for locale in locales.all()]
def is_existing_in_parent(self):
return self.parent.concepts_set.filter(mnemonic__iexact=self.mnemonic).exists()
@classmethod
def persist_new(cls, data, user=None, create_initial_version=True):
names = [
name if isinstance(name, LocalizedText) else LocalizedText.build(
name
) for name in data.pop('names', []) or []
]
descriptions = [
desc if isinstance(desc, LocalizedText) else LocalizedText.build(
desc, 'description'
) for desc in data.pop('descriptions', []) or []
]
concept = Concept(**data)
concept.version = TEMP
if user:
concept.created_by = concept.updated_by = user
concept.errors = dict()
if concept.is_existing_in_parent():
concept.errors = dict(__all__=[ALREADY_EXISTS])
return concept
try:
concept.cloned_names = names
concept.cloned_descriptions = descriptions
concept.full_clean()
concept.save()
concept.versioned_object_id = concept.id
concept.version = str(concept.id)
concept.is_latest_version = not create_initial_version
concept.save()
concept.set_locales()
parent_resource = concept.parent
parent_resource_head = parent_resource.head
if create_initial_version:
initial_version = cls.create_initial_version(concept)
initial_version.set_locales()
initial_version.sources.set([parent_resource, parent_resource_head])
concept.sources.set([parent_resource, parent_resource_head])
parent_resource.save()
parent_resource_head.save()
except ValidationError as ex:
concept.errors.update(ex.message_dict)
except IntegrityError as ex:
concept.errors.update(dict(__all__=ex.args))
return concept
def update_versioned_object(self):
concept = self.versioned_object
concept.extras = self.extras
concept.names.set(self.names.all())
concept.descriptions.set(self.descriptions.all())
concept.concept_class = self.concept_class
concept.datatype = self.datatype
concept.retired = self.retired
concept.save()
@classmethod
def persist_clone(cls, obj, user=None, **kwargs): # pylint: disable=too-many-statements
errors = dict()
if not user:
errors['version_created_by'] = PERSIST_CLONE_SPECIFY_USER_ERROR
return errors
obj.created_by = user
obj.updated_by = user
obj.version = TEMP
parent = obj.parent
parent_head = parent.head
persisted = False
latest_version = None
try:
with transaction.atomic():
cls.pause_indexing()
obj.is_latest_version = True
obj.save(**kwargs)
obj.version = str(obj.id)
obj.save()
if obj.id:
obj.set_locales()
obj.clean() # clean here to validate locales that can only be saved after obj is saved
obj.update_versioned_object()
versioned_object = obj.versioned_object
latest_version = versioned_object.versions.exclude(id=obj.id).filter(is_latest_version=True).first()
latest_version.is_latest_version = False
latest_version.save()
obj.sources.set(compact([parent, parent_head]))
persisted = True
cls.resume_indexing()
def index_all():
parent.save()
parent_head.save()
latest_version.save()
obj.save()
transaction.on_commit(index_all)
except ValidationError as err:
errors.update(err.message_dict)
finally:
cls.resume_indexing()
if not persisted:
if latest_version:
latest_version.is_latest_version = True
latest_version.save()
if obj.id:
obj.remove_locales()
obj.sources.remove(parent_head)
obj.delete()
errors['non_field_errors'] = [PERSIST_CLONE_ERROR]
return errors
def get_unidirectional_mappings(self):
concept = self
if self.is_versioned_object:
concept = self.get_latest_version()
if not concept:
from core.mappings.models import Mapping
return Mapping.objects.none()
return concept.mappings_from.filter(parent_id=self.parent_id, id=F('versioned_object_id'))
def get_indirect_mappings(self):
concept = self
if self.is_versioned_object:
concept = self.get_latest_version()
if not concept:
from core.mappings.models import Mapping
return Mapping.objects.none()
return concept.mappings_to.filter(parent_id=concept.parent_id, id=F('versioned_object_id'))
def get_bidirectional_mappings(self):
queryset = self.get_unidirectional_mappings() | self.get_indirect_mappings()
return queryset.distinct()
@staticmethod
def get_latest_versions_for_queryset(concepts_qs):
"""Takes any concepts queryset and returns queryset of latest_version of each of those concepts"""
if concepts_qs is None or not concepts_qs.exists():
return Concept.objects.none()
criteria_fields = list(concepts_qs.values('parent_id', 'mnemonic'))
criterion = [models.Q(**attrs, is_latest_version=True) for attrs in criteria_fields]
query = criterion.pop()
for criteria in criterion:
query |= criteria
return Concept.objects.filter(query)