-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathmodels.py
executable file
·4317 lines (3495 loc) · 193 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
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
from colorfield.fields import ColorField
from django.db.models import Q
from django.db import models
from django.conf import settings
from django.utils.encoding import escape_uri_path
from django.contrib.auth.models import User
from django.dispatch import receiver
from django.db.models.signals import post_save, pre_delete, m2m_changed
from django.utils.translation import gettext_noop, gettext_lazy as _, gettext
from django.forms.utils import ValidationError
from django.forms.models import model_to_dict
from django.core.exceptions import ObjectDoesNotExist, MultipleObjectsReturned
from django.db import DatabaseError, IntegrityError
from django.db.transaction import TransactionManagementError
from django.core.files import File
from tagging.models import TaggedItem, Tag
import re
import copy
import os
import json
from collections import OrderedDict
from datetime import datetime, date
from signbank.settings.base import FIELDS, DEFAULT_KEYWORDS_LANGUAGE, \
WRITABLE_FOLDER, DATASET_METADATA_DIRECTORY, ECV_FOLDER
from signbank.dictionary.translate_choice_list import choicelist_queryset_to_translated_dict
# -*- coding: utf-8 -*-
def get_default_language_id():
language = Language.objects.get(**DEFAULT_KEYWORDS_LANGUAGE)
if language is not None:
return language.id
return None
class FieldChoiceForeignKey(models.ForeignKey):
"""
Extend ForeignKey to also hold field_choice_category
"""
def __init__(self, *args, **kwargs):
self.field_choice_category = "---"
if 'field_choice_category' in kwargs:
self.field_choice_category = kwargs.pop('field_choice_category')
super().__init__(*args, **kwargs)
class FieldChoice(models.Model):
# field categories
ABSORIFING = 'AbsOriFing'
ABSORIPALM = 'AbsOriPalm'
APERTURE = 'Aperture'
CONTACTTYPE = 'ContactType'
DOMINANTHANDFLEXION = 'DominantHandFlexion'
DOMINANTHANDSELECTEDFINGERS = 'DominantHandSelectedFingers'
FINGERSELECTION = 'FingerSelection'
HANDEDNESS = 'Handedness'
HANDSHAPECHANGE = 'HandshapeChange'
ICONICITY = 'iconicity'
JOINTCONFIGURATION = 'JointConfiguration'
LOCATION = 'Location'
MINORLOCATION = 'MinorLocation'
MORPHEMETYPE = 'MorphemeType'
MORPHOLOGYTYPE = 'MorphologyType'
MOVEMENTDIR = 'MovementDir'
MOVEMENTMAN = 'MovementMan'
MOVEMENTSHAPE = 'MovementShape'
NAMEDENTITY = 'NamedEntity'
NOTETYPE = 'NoteType'
ORICHANGE = 'OriChange'
OTHERMEDIATYPE = 'OtherMediaType'
PATHONPATH = 'PathOnPath'
QUANTITY = 'Quantity'
RELORILOC = 'RelOriLoc'
RELORIMOV = 'RelOriMov'
RELATARTIC = 'RelatArtic'
SPREADING = 'Spreading'
THUMB = 'Thumb'
VALENCE = 'Valence'
WORDCLASS = 'WordClass'
SENTENCETYPE = 'SentenceType'
FIELDCHOICE_FIELDS = [
(ABSORIFING, 'AbsOriFing'),
(ABSORIPALM, 'AbsOriPalm'),
(APERTURE, 'Aperture'),
(CONTACTTYPE, 'ContactType'),
(DOMINANTHANDFLEXION, 'DominantHandFlexion'),
(DOMINANTHANDSELECTEDFINGERS, 'DominantHandSelectedFingers'),
(FINGERSELECTION, 'FingerSelection'),
(HANDEDNESS, 'Handedness'),
(ICONICITY, 'iconicity'),
(HANDSHAPECHANGE, 'HandshapeChange'),
(JOINTCONFIGURATION, 'JointConfiguration'),
(LOCATION, 'Location'),
(MINORLOCATION, 'MinorLocation'),
(MORPHEMETYPE, 'MorphemeType'),
(MORPHOLOGYTYPE, 'MorphologyType'),
(MOVEMENTDIR, 'MovementDir'),
(MOVEMENTMAN, 'MovementMan'),
(MOVEMENTSHAPE, 'MovementShape'),
(NAMEDENTITY, 'NamedEntity'),
(NOTETYPE, 'NoteType'),
(ORICHANGE, 'OriChange'),
(OTHERMEDIATYPE, 'OtherMediaType'),
(PATHONPATH, 'PathOnPath'),
(QUANTITY, 'Quantity'),
(RELORILOC, 'RelOriLoc'),
(RELORIMOV, 'RelOriMov'),
(RELATARTIC, 'RelatArtic'),
(SPREADING, 'Spreading'),
(THUMB, 'Thumb'),
(VALENCE, 'Valence'),
(WORDCLASS, 'WordClass'),
(SENTENCETYPE, 'SentenceType')
]
field = models.CharField(max_length=50, choices=FIELDCHOICE_FIELDS)
name = models.CharField(max_length=50)
machine_value = models.IntegerField(
help_text="The actual numeric value stored in the database. Created automatically.")
field_color = ColorField(default='ffffff')
def __str__(self):
name = self.field + ': ' + self.name + ' (' + str(self.machine_value) + ')'
return name
class Meta:
ordering = ['machine_value']
class Translation(models.Model):
"""A spoken language translation of signs"""
gloss = models.ForeignKey("Gloss", on_delete=models.CASCADE)
language = models.ForeignKey("Language", on_delete=models.CASCADE)
translation = models.ForeignKey("Keyword", on_delete=models.CASCADE)
index = models.IntegerField("Index", default=1)
orderIndex = models.IntegerField(_("Sense Index"), default=1)
def __str__(self):
if self.translation and self.translation.text:
return self.gloss.idgloss + ' (' + self.translation.text + ')'
else:
return self.gloss.idgloss
class Meta:
unique_together = (("gloss", "language", "translation", "orderIndex"),)
ordering = ['gloss', 'index']
class Admin:
list_display = ['gloss', 'translation']
search_fields = ['gloss__idgloss']
class Keyword(models.Model):
"""A keyword that is a possible translation equivalent of a sign"""
def __str__(self):
return self.text
text = models.CharField(max_length=100, unique=True)
class Meta:
ordering = ['text']
class Admin:
search_fields = ['text']
class Definition(models.Model):
"""An English text associated with a gloss. It's called a note in the web interface"""
def __str__(self):
return str(self.gloss) + "/" + str(self.role)
gloss = models.ForeignKey("Gloss", on_delete=models.CASCADE)
text = models.TextField()
role = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.NOTETYPE},
field_choice_category=FieldChoice.NOTETYPE,
verbose_name=_("Note Type"), related_name="definition")
count = models.IntegerField(default=3)
published = models.BooleanField(default=True)
class Meta:
ordering = ['gloss', 'role', 'count']
class Admin:
list_display = ['gloss', 'role', 'count', 'text']
list_filter = ['role']
search_fields = ['gloss__idgloss']
@classmethod
def get_field_names(cls):
fields = cls._meta.get_fields(include_hidden=True)
return [field.name for field in fields if field.concrete]
@classmethod
def get_field(cls, field):
field = cls._meta.get_field(field)
return field
def get_role_display(self):
return self.role.name if self.role else '-'
def note_text(self):
stripped_text = self.text.strip()
if '\n' in stripped_text:
# this function is used for displaying notes in the CSV update
# this makes mysterious differences in old and new values visible
stripped_text = stripped_text.replace('\n', '<br>')
return stripped_text
def note_tuple(self):
return self.get_role_display(), str(self.published), str(self.count), self.note_text()
class SignLanguage(models.Model):
"""A sign language name"""
class Meta:
ordering = ['name']
name = models.CharField(max_length=20)
description = models.TextField()
def __str__(self):
return self.name
class Dialect(models.Model):
"""A dialect name - a regional dialect of a given Language"""
class Meta:
ordering = ['signlanguage', 'name']
signlanguage = models.ForeignKey(SignLanguage, on_delete=models.CASCADE)
name = models.CharField(max_length=20)
description = models.TextField()
def __str__(self):
return self.signlanguage.name + "/" + self.name
class SemanticField(models.Model):
machine_value = models.IntegerField(_("Machine value"), primary_key=True)
name = models.CharField(max_length=20, unique=True)
field_color = ColorField(default='ffffff')
description = models.TextField(null=True, blank=True)
def __str__(self):
return self.name
class DerivationHistory(models.Model):
machine_value = models.IntegerField(_("Machine value"), primary_key=True)
name = models.CharField(max_length=20, unique=True)
field_color = ColorField(default='ffffff')
description = models.TextField(null=True, blank=True)
def __str__(self):
return self.name
class RelationToForeignSign(models.Model):
"""Defines a relationship to another sign in another language (often a loan)"""
def __str__(self):
return str(self.gloss) + "/" + str(self.other_lang) + ',' + str(self.other_lang_gloss)
gloss = models.ForeignKey("Gloss", on_delete=models.CASCADE)
loan = models.BooleanField("Loan Sign", default=False)
other_lang = models.CharField("Related Language", max_length=20)
other_lang_gloss = models.CharField("Gloss in related language", max_length=50)
class Meta:
ordering = ['gloss', 'loan', 'other_lang', 'other_lang_gloss']
class Admin:
list_display = ['gloss', 'loan', 'other_lang', 'other_lang_gloss']
list_filter = ['other_lang']
search_fields = ['gloss__idgloss']
class Handshape(models.Model):
machine_value = models.IntegerField(_("Machine value"), primary_key=True)
name = models.CharField(max_length=50)
field_color = ColorField(default='ffffff')
hsNumSel = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.QUANTITY},
field_choice_category=FieldChoice.QUANTITY,
verbose_name=_("Quantity"),
related_name="quantity")
hsFingSel = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.FINGERSELECTION},
field_choice_category=FieldChoice.FINGERSELECTION,
verbose_name=_("Finger selection"),
related_name="finger_selection")
hsFingSel2 = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.FINGERSELECTION},
field_choice_category=FieldChoice.FINGERSELECTION,
verbose_name=_("Finger selection 2"),
related_name="finger_selection_2")
hsFingConf = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.JOINTCONFIGURATION},
field_choice_category=FieldChoice.JOINTCONFIGURATION,
verbose_name=_("Finger configuration"),
related_name="finger_configuration")
hsFingConf2 = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.JOINTCONFIGURATION},
field_choice_category=FieldChoice.JOINTCONFIGURATION,
verbose_name=_("Finger configuration 2"),
related_name="finger_configuration_2")
hsAperture = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.APERTURE},
field_choice_category=FieldChoice.APERTURE,
verbose_name=_("Aperture"),
related_name="aperture")
hsThumb = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.THUMB},
field_choice_category=FieldChoice.THUMB,
verbose_name=_("Thumb"),
related_name="thumb")
hsSpread = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.SPREADING},
field_choice_category=FieldChoice.SPREADING,
verbose_name=_("Spreading"),
related_name="spreading")
hsFingUnsel = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.FINGERSELECTION},
field_choice_category=FieldChoice.FINGERSELECTION,
verbose_name=_("Unselected fingers"),
related_name="unselected_fingers")
fsT = models.BooleanField(_("T"), null=True, default=False)
fsI = models.BooleanField(_("I"), null=True, default=False)
fsM = models.BooleanField(_("M"), null=True, default=False)
fsR = models.BooleanField(_("R"), null=True, default=False)
fsP = models.BooleanField(_("P"), null=True, default=False)
fs2T = models.BooleanField(_("T2"), null=True, default=False)
fs2I = models.BooleanField(_("I2"), null=True, default=False)
fs2M = models.BooleanField(_("M2"), null=True, default=False)
fs2R = models.BooleanField(_("R2"), null=True, default=False)
fs2P = models.BooleanField(_("P2"), null=True, default=False)
ufT = models.BooleanField(_("Tu"), null=True, default=False)
ufI = models.BooleanField(_("Iu"), null=True, default=False)
ufM = models.BooleanField(_("Mu"), null=True, default=False)
ufR = models.BooleanField(_("Ru"), null=True, default=False)
ufP = models.BooleanField(_("Pu"), null=True, default=False)
def __str__(self):
name = 'Handshape: ' + self.name + ' (' + str(self.machine_value) + ')'
return name
def field_labels(self):
"""Return the dictionary of field labels for use in a template"""
d = dict()
for f in self._meta.fields:
try:
d[f.name] = _(self._meta.get_field(f.name).verbose_name)
except KeyError:
d[f.name] = _(self._meta.get_field(f.name).name)
for f in self._meta.many_to_many:
field = self._meta.get_field(f.name)
if hasattr(field, 'verbose_name'):
d[f.name] = _(field.verbose_name)
else:
d[f.name] = _(field.name)
return d
@classmethod
def get_field_names(cls):
fields = cls._meta.get_fields(include_hidden=True)
return [field.name for field in fields if field.concrete]
@classmethod
def get_field(cls, field):
field = cls._meta.get_field(field)
return field
def get_image_path(self, check_existence=True):
"""Returns the path within the writable and static folder"""
foldername = str(self.machine_value) + '/'
filename_without_extension = 'handshape_' + str(self.machine_value)
dir_path = settings.WRITABLE_FOLDER + settings.HANDSHAPE_IMAGE_DIRECTORY + '/' + foldername
if check_existence:
try:
for filename in os.listdir(dir_path):
if not re.match(r'.*_\d+$', filename):
existing_file_without_extension = os.path.splitext(filename)[0]
if filename_without_extension == existing_file_without_extension:
return settings.HANDSHAPE_IMAGE_DIRECTORY + '/' + foldername + '/' + filename
except OSError:
return None
else:
return settings.HANDSHAPE_IMAGE_DIRECTORY + '/' + foldername + '/' + filename_without_extension
def get_fingerSelection_display(self):
selection = ''
if self.fsT:
selection += 'T'
if self.fsI:
selection += 'I'
if self.fsM:
selection += 'M'
if self.fsR:
selection += 'R'
if self.fsP:
selection += 'P'
return selection
def set_fingerSelection_display(self):
# set the Boolean fields corresponding to the Finger Selection pattern stored in hsFingSel
try:
fieldSelectionMatch = FieldChoice.objects.filter(field='FingerSelection',
machine_value=self.hsFingSel.machine_value)
except:
print('set_fingerSelection failed for: ', self)
return
if not fieldSelectionMatch:
# no finger selection
return
# get the pattern, only one match is returned, in a list because of filter
fingerSelectionPattern = fieldSelectionMatch[0].name
self.fsT = 'T' in fingerSelectionPattern
self.fsI = 'I' in fingerSelectionPattern
self.fsM = 'M' in fingerSelectionPattern
self.fsR = 'R' in fingerSelectionPattern
self.fsP = 'P' in fingerSelectionPattern
return
def get_fingerSelection2_display(self):
selection = ''
if self.fs2T:
selection += 'T'
if self.fs2I:
selection += 'I'
if self.fs2M:
selection += 'M'
if self.fs2R:
selection += 'R'
if self.fs2P:
selection += 'P'
return selection
def set_fingerSelection2_display(self):
# set the Boolean fields corresponding to the Finger Selection pattern stored in hsFingSel2
try:
fieldSelectionMatch = FieldChoice.objects.filter(field='FingerSelection',
machine_value=self.hsFingSel2.machine_value)
except:
print('set_fingerSelection2 failed for: ', self)
return
if not fieldSelectionMatch:
# no finger selection
return
# get the pattern, only one match is returned, in a list because of filter
fingerSelectionPattern = fieldSelectionMatch[0].name
self.fs2T = 'T' in fingerSelectionPattern
self.fs2I = 'I' in fingerSelectionPattern
self.fs2M = 'M' in fingerSelectionPattern
self.fs2R = 'R' in fingerSelectionPattern
self.fs2P = 'P' in fingerSelectionPattern
return
def get_unselectedFingers_display(self):
selection = ''
if self.ufT:
selection += 'T'
if self.ufI:
selection += 'I'
if self.ufM:
selection += 'M'
if self.ufR:
selection += 'R'
if self.ufP:
selection += 'P'
return selection
def set_unselectedFingers_display(self):
# set the Boolean fields corresponding to the Finger Selection pattern stored in hsFingUnsel
try:
fieldSelectionMatch = FieldChoice.objects.filter(field='FingerSelection',
machine_value=self.hsFingUnsel.machine_value)
except:
print('set_unselectedFingers failed for: ', self)
return
if not fieldSelectionMatch:
# no finger selection
return
# get the pattern, only one match is returned, in a list because of filter
fingerSelectionPattern = fieldSelectionMatch[0].name
self.ufT = 'T' in fingerSelectionPattern
self.ufI = 'I' in fingerSelectionPattern
self.ufM = 'M' in fingerSelectionPattern
self.ufR = 'R' in fingerSelectionPattern
self.ufP = 'P' in fingerSelectionPattern
return
def count_selected_fingers(self):
count_selected_fingers = 0
if self.fsT:
count_selected_fingers += 1
if self.fsI:
count_selected_fingers += 1
if self.fsM:
count_selected_fingers += 1
if self.fsR:
count_selected_fingers += 1
if self.fsP:
count_selected_fingers += 1
return count_selected_fingers
class Language(models.Model):
"""A written language, used for translations in written languages."""
name = models.CharField(max_length=50)
language_code_2char = models.CharField(max_length=7, unique=False, null=False, blank=False, help_text=_(
"""Language code (2 characters long) of a written language. This also includes codes of the form zh-Hans, cf. IETF BCP 47"""))
language_code_3char = models.CharField(max_length=3, unique=False, null=False, blank=False, help_text=_(
"""ISO 639-3 language code (3 characters long) of a written language."""))
description = models.TextField(null=True, blank=True)
class Meta:
ordering = ['-id']
def __str__(self):
return self.name
class ExampleSentence(models.Model):
"""An example sentence belongs to one or more sense(s)"""
sentenceType = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.SENTENCETYPE},
field_choice_category=FieldChoice.SENTENCETYPE,
verbose_name=_("Sentence Type"), related_name="sentence_type")
negative = models.BooleanField(default=False)
@classmethod
def get_field_names(cls):
fields = cls._meta.get_fields(include_hidden=True)
return [field.name for field in fields if field.concrete]
@classmethod
def get_field(cls, field):
field = cls._meta.get_field(field)
return field
def get_dataset(self):
return self.senses.first().glosses.first().lemma.dataset
def get_examplestc_translations_dict_with(self):
translations = {}
for dataset_translation_language in self.get_dataset().translation_languages.all():
if self.examplesentencetranslation_set.filter(language = dataset_translation_language).count() == 1:
translations[str(dataset_translation_language)] = str(self.examplesentencetranslation_set.all().get(language = dataset_translation_language))
else:
translations[str(dataset_translation_language)] = ""
return translations
def get_examplestc_translations_dict_without(self):
return {k: v for k, v in self.get_examplestc_translations_dict_with().items() if v}
def get_examplestc_translations(self):
return [k+": "+v for k,v in self.get_examplestc_translations_dict_without().items()]
def get_type(self):
return self.sentenceType.name if self.sentenceType else ''
def get_video_path(self):
try:
examplevideo = self.examplevideo_set.get(version=0)
return str(examplevideo.videofile)
except ObjectDoesNotExist:
return ''
except MultipleObjectsReturned:
# Just return the first
examplevideos = self.examplevideo_set.filter(version=0)
return str(examplevideos[0].videofile)
def get_video(self):
"""Return the video object for this gloss or None if no video available"""
video_path = self.get_video_path()
filepath = os.path.join(settings.WRITABLE_FOLDER, video_path)
if os.path.exists(filepath.encode('utf-8')):
return video_path
else:
return ''
def has_video(self):
"""Test to see if the video for this sign is present"""
return self.get_video() not in ['', None]
def add_video(self, user, videofile, recorded):
# Preventing circular import
from signbank.video.models import ExampleVideo, ExampleVideoHistory, get_sentence_video_file_path
# Create a new ExampleVideo object
if isinstance(videofile, File) or videofile.content_type == 'django.core.files.uploadedfile.InMemoryUploadedFile':
video = ExampleVideo(examplesentence=self)
# Backup the existing video objects stored in the database
existing_videos = ExampleVideo.objects.filter(examplesentence=self)
for video_object in existing_videos:
video_object.reversion(revert=False)
# Create a ExampleVideoHistory object
video_file_full_path = os.path.join(WRITABLE_FOLDER, get_sentence_video_file_path(video, str(videofile)))
examplevideohistory = ExampleVideoHistory(action="upload", examplesentence=self, actor=user,
uploadfile=videofile, goal_location=video_file_full_path)
examplevideohistory.save()
video.videofile.save(get_sentence_video_file_path(video, str(videofile)), videofile)
else:
return ExampleVideo(examplesentence=self)
video.save()
video.ch_own_mod_video()
# video.make_small_video()
return video
def __str__(self):
return " | ".join(self.get_examplestc_translations())
class ExampleSentenceTranslation(models.Model):
"""A sentence translation belongs to one example sentence"""
text = models.TextField()
examplesentence = models.ForeignKey(ExampleSentence, on_delete=models.CASCADE)
language = models.ForeignKey("Language", on_delete=models.CASCADE)
def __str__(self):
return self.text
class SenseTranslation(models.Model):
"""A sense translation belongs to a sense"""
translations = models.ManyToManyField(Translation)
language = models.ForeignKey("Language", on_delete=models.CASCADE)
def get_translations(self):
return ", ".join([t.translation.text.strip() for t in self.translations.all()])
def get_translations_return(self):
return "\n".join([t.translation.text.strip() for t in self.translations.all()])
def get_translations_list(self):
return [t.translation.text.strip() for t in self.translations.all()]
def __str__(self):
return self.get_translations()
class Sense(models.Model):
"""A sense belongs to a gloss and consists of a set of translation(s)"""
senseTranslations = models.ManyToManyField(SenseTranslation)
exampleSentences = models.ManyToManyField(ExampleSentence,
through = 'SenseExamplesentence',
related_name = 'senses',
verbose_name = _(u'Example sentences'),
help_text = _(u'Examplesentences in this Sense')
)
def get_dataset(self):
return self.glosses.first().lemma.dataset
def get_example_sentences(self):
"""Return the example sentences for this sense for every language as one string
This is called by the admin"""
glosssense = GlossSense.objects.filter(sense=self).first()
if not glosssense:
# this method returns a string
return ""
example_sentences_per_language = dict()
for language in glosssense.gloss.lemma.dataset.translation_languages.all():
example_sentences_per_language[language.name] = []
example_sentences = self.exampleSentences.all()
for es in example_sentences:
estrans = es.examplesentencetranslation_set.all()
for est in estrans:
example_sentences_per_language[est.language.name].append(est.text)
result_sentences = []
for language, sentences in example_sentences_per_language.items():
if not sentences:
continue
comma_separated_sentences = ', '.join(sentences)
language_plus_sentences = language + ': ' + comma_separated_sentences
result_sentences.append(language_plus_sentences)
result = ', '.join(result_sentences)
return result
def get_sense_translations_dict_with(self, join_char='', exclude_empty=False):
"""Return the translations for this sense for every dataset language as a
dictionary of text separated by join_char
if exclude_empty is True, languages with no translations are omitted from the dictionary"""
sense_translations_per_language = dict()
glosssense = GlossSense.objects.filter(sense=self).first()
if not glosssense:
return sense_translations_per_language
# languages_lookup is used in a later step to retrieve the language name
# for efficiency to avoid creating lazy sql queries in the template,
# values are retrieved below, however for the language, the language id is retrieved
# as a value, this is then mapped back to language.name which is used in the template
# and retrieved dynamically to get the name of the language in the interface language
languages_lookup = dict()
for language in glosssense.gloss.lemma.dataset.translation_languages.all():
languages_lookup[language.id] = language.name
sense_translations = self.senseTranslations.all().order_by('-language__id', 'translations').exclude(
translations__translation__text__isnull=True).values('language', 'translations__translation__text')
for sense_translation in sense_translations:
language = languages_lookup[sense_translation['language']]
trans = sense_translation['translations__translation__text']
if language not in sense_translations_per_language.keys():
if trans:
sense_translations_per_language[language] = []
if not trans and not exclude_empty:
sense_translations_per_language[language] = []
continue
sense_translations_per_language[language].append(trans)
if join_char:
for language in sense_translations_per_language.keys():
translations_list = sense_translations_per_language[language]
sense_translations_per_language[language] = join_char.join(translations_list)
return sense_translations_per_language
def get_sense_translations_dict_without_return(self):
"""Get a dict of the translations separated by '\n' for this sense ONLY for languages where they are present"""
return self.get_sense_translations_dict_with('\n', exclude_empty=True)
def get_sense_translations_dict_without(self):
"""Get a dict of the translations separated by ', ' for this sense ONLY for languages where they are present"""
return self.get_sense_translations_dict_with(', ', exclude_empty=True)
def get_sense_translations_dict_without_list(self):
"""Get a dict of the translations as list for this sense ONLY for languages where they are present"""
return self.get_sense_translations_dict_with('', exclude_empty=True)
def get_sense_translations(self):
"""Get a list of the translations for this sense ONLY for languages where they are present
This is called by the Admin and is formatted as such"""
sense_translations = self.get_sense_translations_dict_with(', ', exclude_empty=True)
return [k+": "+v for k, v in sense_translations.items()]
def has_examplesentence_with_video(self):
"""Return true if any of the example sentences has a video"""
for examplesentence in self.exampleSentences.all():
if examplesentence.has_video():
return True
return False
def get_senses_with_similar_sensetranslations_dict(self, gloss_detail_view):
"""Return a list of senses with sensetranslations that have the same string as this sense"""
this_dataset = self.get_dataset()
similar_senses = []
senses_done_pk = []
# Find the translations in current sense
similar_translations = Translation.objects.filter(sensetranslation__sense=self)
for translation in similar_translations:
# check in which other senses the translation is present
# use a separate variable since the senses_done_pk is being updated
other_senses = Sense.objects.filter(senseTranslations__translations__translation__text=translation.translation.text,
glosssense__gloss__lemma__dataset=this_dataset).exclude(
pk=self.pk).exclude(pk__in=senses_done_pk).exclude(
glosssense__gloss=gloss_detail_view)
for sense in other_senses:
senses_done_pk.append(sense.pk)
sensedict = {}
for language in self.get_dataset().translation_languages.all():
if sense.senseTranslations.filter(language=language).exists():
sensedict[str(language)] = sense.senseTranslations.get(language=language).get_translations()
else:
sensedict[str(language)] = ""
sensedict['inglosses'] = [(str(gloss), str(gloss.pk)) for gloss in sense.glosses.all()]
sensedict['sentence_count'] = sense.exampleSentences.count()
similar_senses.append(sensedict)
return sorted(similar_senses, key=lambda d: d['inglosses'])
def ordered_examplesentences(self):
"""Return a properly ordered set of examplesentences"""
return self.exampleSentences.order_by('senseexamplesentence')
def reorder_examplesentences(self):
"""when an examplesentence is deleted, they should be reordered"""
for sentence_i, sentence in enumerate(self.ordered_examplesentences().all()):
sensesentence = SenseExamplesentence.objects.all().get(sense=self, examplesentence=sentence)
sensesentence.order = sentence_i+1
sensesentence.save()
def __str__(self):
"""Return the string representation of the sense, separated by | for every sensetranslation"""
str_sense = []
this_sense_translations = self.senseTranslations.all()
if not this_sense_translations:
return ""
for sensetranslation in this_sense_translations:
translations = sensetranslation.translations.all()
if not translations:
continue
str_translations = []
for translation in translations:
this_translation = translation.translation.text
if not this_translation:
continue
str_translations.append(this_translation)
joined_translations = ', '.join(str_translations)
str_sense.append(joined_translations)
return " | ".join(str_sense)
class SenseExamplesentence(models.Model):
"""An examplesentence belongs to one or multiple senses"""
sense = models.ForeignKey(Sense, on_delete=models.CASCADE)
examplesentence = models.ForeignKey(ExampleSentence, on_delete=models.CASCADE)
order = models.IntegerField(
verbose_name = _(u'Order'),
help_text = _(u'What order to display this examplesentence within the sense.'),
default = 1
)
class Meta:
db_table = 'dictionary_sense_exampleSentences'
unique_together = ['sense', 'examplesentence']
verbose_name = _(u"Sense exampleSentence")
verbose_name_plural = _(u"Sense exampleSentences")
ordering = ['order',]
def __unicode__(self):
return "Example sentence: " + str(self.examplesentence) + " is a member of " + str(self.sense) + (" in position %d" % self.order)
@receiver(m2m_changed, sender=SenseExamplesentence)
def post_remove_examplesentence_reorder(sender, instance, **kwargs):
instance.reorder_examplesentences()
class Gloss(models.Model):
class Meta:
verbose_name_plural = "Glosses"
# ordering: for Lemma View in the Gloss List View, we need to have glosses in the same Lemma Group sorted
ordering = ['lemma']
permissions = (('update_video', "Can Update Video"),
('search_gloss', 'Can Search/View Full Gloss Details'),
('export_csv', 'Can export sign details as CSV'),
('export_ecv', 'Can create an ECV export file of Signbank'),
('can_publish', 'Can publish signs and definitions'),
('can_delete_unpublished', 'Can delete unpub signs or defs'),
('can_delete_published', 'Can delete pub signs and defs'),
('view_advanced_properties', 'Include all properties in sign details'),
)
def __str__(self):
return self.idgloss
def display_handedness(self):
return self.handedness.name if self.handedness else self.handedness
def display_domhndsh(self):
return self.domhndsh.name if self.domhndsh else self.domhndsh
def display_subhndsh(self):
return self.subhndsh.name if self.subhndsh else self.subhndsh
def display_locprim(self):
return self.locprim.name if self.locprim else self.locprim
def field_labels(self):
"""Return the dictionary of field labels for use in a template"""
d = dict()
for f in self._meta.fields:
try:
d[f.name] = _(self._meta.get_field(f.name).verbose_name)
except KeyError:
d[f.name] = _(self._meta.get_field(f.name).name)
for f in self._meta.many_to_many:
field = self._meta.get_field(f.name)
if hasattr(field, 'verbose_name'):
d[f.name] = _(field.verbose_name)
else:
d[f.name] = _(field.name)
return d
@classmethod
def get_field_names(cls):
fields = cls._meta.get_fields(include_hidden=True)
return [field.name for field in fields if field.concrete]
@classmethod
def get_field(cls, field):
field = cls._meta.get_field(field)
return field
archived = models.BooleanField(_("Archived"), default=False)
lemma = models.ForeignKey("LemmaIdgloss", null=True, on_delete=models.SET_NULL)
# languages that this gloss is part of
signlanguage = models.ManyToManyField(SignLanguage)
# these language fields are subsumed by the language field above
bsltf = models.BooleanField(_("BSL sign"), null=True, blank=True)
asltf = models.BooleanField(_("ASL sign"), null=True, blank=True)
# these fields should be reviewed - do we put them in another class too?
aslgloss = models.CharField(_("ASL gloss"), blank=True, max_length=50) # American Sign Language gloss
asloantf = models.BooleanField(_("ASL loan sign"), null=True, blank=True)
# loans from british sign language
bslgloss = models.CharField(_("BSL gloss"), max_length=50, blank=True)
bslloantf = models.BooleanField(_("BSL loan sign"), null=True, blank=True)
useInstr = models.CharField(_("Annotation instructions"), max_length=50, blank=True)
rmrks = models.CharField(_("Remarks"), max_length=50, blank=True)
########
# one or more regional dialects that this gloss is used in
dialect = models.ManyToManyField(Dialect)
blend = models.CharField(_("Blend of"), max_length=100, null=True, blank=True) # This field type is a guess.
blendtf = models.BooleanField(_("Blend"), null=True, blank=True)
compound = models.CharField(_("Compound of"), max_length=100, blank=True) # This field type is a guess.
comptf = models.BooleanField(_("Compound"), null=True, blank=True)
# Phonology fields
handedness = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.HANDEDNESS},
field_choice_category=FieldChoice.HANDEDNESS,
verbose_name=_("Handedness"),
related_name="handedness")
weakdrop = models.BooleanField(_("Weak Drop"), null=True, blank=True)
weakprop = models.BooleanField(_("Weak Prop"), null=True, blank=True)
domhndsh = models.ForeignKey(Handshape, on_delete=models.SET_NULL, null=True,
verbose_name=_("Strong Hand"),
related_name="strong_hand")
subhndsh = models.ForeignKey(Handshape, on_delete=models.SET_NULL, null=True,
verbose_name=_("Weak Hand"),
related_name="weak_hand")
# Support for handshape etymology
domhndsh_number = models.BooleanField(_("Strong hand number"), null=True, blank=True)
domhndsh_letter = models.BooleanField(_("Strong hand letter"), null=True, blank=True)
subhndsh_number = models.BooleanField(_("Weak hand number"), null=True, blank=True)
subhndsh_letter = models.BooleanField(_("Weak hand letter"), null=True, blank=True)
final_domhndsh = models.ForeignKey(Handshape, on_delete=models.SET_NULL, null=True,
verbose_name=_("Final Dominant Handshape"),
related_name="final_dominant_handshape")
final_subhndsh = models.ForeignKey(Handshape, on_delete=models.SET_NULL, null=True,
verbose_name=_("Final Subordinate Handshape"),
related_name="final_subordinate_handshape")
locprim = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.LOCATION},
field_choice_category=FieldChoice.LOCATION,
verbose_name=_("Location"),
related_name="location")
final_loc = FieldChoiceForeignKey(FieldChoice, on_delete=models.SET_NULL, null=True,
limit_choices_to={'field': FieldChoice.LOCATION},