forms.py 16 KB
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
# -*- coding: utf-8 -*-

from django.core.exceptions import ValidationError
from django.forms import Textarea, TextInput, ModelMultipleChoiceField, \
    ModelChoiceField, ModelForm, Form, CharField, SelectMultiple, Select, \
    TypedMultipleChoiceField, HiddenInput, IntegerField, ChoiceField, NumberInput
from django.utils.translation import ugettext_lazy as _

from common.forms import disable_field
from common.util import GroupDict
from dictionary.models import Lexeme, Inflection, Vocabulary, CrossReference, \
    Qualifier, LexemeAttributeValue
from patterns.models import Pattern


# ze StackOverflow, http://stackoverflow.com/questions/3737116/
class QualifiersField(ModelMultipleChoiceField):
    def __init__(self, **kwargs):
        super(QualifiersField, self).__init__(
            Qualifier.objects.none(), **kwargs)
        self.to_field_name = None  # ?

    def set_qualifiers(self, user, qualified=None, types=None):
        # if qualified and qualified.id:
        #     if lexeme:
        #         vocabularies = lexeme.editable_vocabularies(user)
        #     else:
        #         vocabularies = qualified.editable_vocabularies(user)
        #     qualifiers = Qualifier.objects.filter(vocabulary__in=vocabularies)
        # else:
        qualifiers = Qualifier.editable_qualifiers(user)
        if types:
            qualifiers = qualifiers.filter(type__in=types)
        if not qualifiers:
            disable_field(self)
            return
        self.queryset = queryset = qualifiers.order_by('vocabulary', 'label')
        queryset = queryset.select_related('vocabulary')
        if qualified and qualified.pk:
            initial_qualifiers = qualified.qualifiers.all() & qualifiers
            self.initial = initial_qualifiers

        q_lists = GroupDict()
        for qualifier in queryset:
            q_lists.add(
                qualifier.vocabulary.id, (qualifier.id, qualifier.label))
        self.choices = sorted(q_lists.iteritems())


class QualifierField(ModelChoiceField):
    def __init__(self, **kwargs):
        qualifiers = Qualifier.objects.all()
        super(QualifierField, self).__init__(qualifiers, **kwargs)
        self.set_qualifiers(qualifiers)

    def set_qualifiers(self, qualifiers):
        if not qualifiers:
            disable_field(self)
            return
        qualifiers = qualifiers.select_related('vocabulary').order_by(
            'vocabulary', 'label')

        q_lists = GroupDict()
        for qualifier in qualifiers:
            q_lists.add(
                qualifier.vocabulary.id, (qualifier.id, qualifier.label))
        self.choices = sorted(q_lists.iteritems())


class LexemeEditForm(ModelForm):
    vocabularies = ModelMultipleChoiceField(
        queryset=Vocabulary.objects.none(), required=False)
    style_qualifiers = QualifiersField(
        required=False, label=_(u'styl. qual.'),
        widget=SelectMultiple(attrs={'class': 'qualifiers'}))
    scope_qualifiers = QualifiersField(
        required=False, label=_(u'scope qual.'),
        widget=SelectMultiple(attrs={'class': 'qualifiers'}))
    new_owner = ModelChoiceField(
        queryset=Vocabulary.objects.none(), required=False)

    def __init__(self, user, editable=True, **kwargs):
        super(LexemeEditForm, self).__init__(**kwargs)
        editable_vocabs = Vocabulary.editable_vocabularies(user)
        instance = getattr(self, 'instance', None)
        other_editable_vocabs = editable_vocabs.exclude(
            pk=instance.owner_vocabulary.pk)
        self.fields['entry'].required = True
        self.fields['new_owner'].queryset = editable_vocabs
        self.fields['vocabularies'].queryset = other_editable_vocabs
        self.fields['vocabularies'].initial = instance.visible_vocabularies(
            user)
        owner_choices = editable_vocabs.values_list('id', 'id')
        self.fields['new_owner'].choices = owner_choices
        if instance and instance.id:
            self.fields['new_owner'].initial = instance.owner_vocabulary
        if other_editable_vocabs.count() == 0:
            disable_field(self.fields['vocabularies'])
        self.fields['style_qualifiers'].set_qualifiers(
            user, instance, types=[Qualifier.TYPE_STYLE])
        self.fields['scope_qualifiers'].set_qualifiers(
            user, instance, types=[Qualifier.TYPE_SCOPE])
        if not editable and instance and instance.id:
            for name, field in self.fields.iteritems():
                if not name.endswith('qualifiers') and name != 'vocabularies':
                    disable_field(field)

    def clean_entry(self):
        entry = self.cleaned_data['entry']
        if ' ' in entry:
            raise ValidationError(_(u'space is not allowed in entry'))
        return entry

    def clean_comment(self):
        data = self.cleaned_data['comment']
        return data.replace('\r', '')

    class Meta:
        model = Lexeme
        fields = (
            'part_of_speech',
            'entry',
            'pronunciation',
            'valence',
            'status',
            'gloss',
            'note',
            'comment',
            'source',
            'borrowing_source',
            'freq',
            'qualifiers_dor',
            # 'qualifiers_style',
            # 'qualifiers_scope',
            'specialist',
            'extended_note',
        )
        widgets = {
            'comment': Textarea(attrs={'cols': 40, 'rows': 5}),
            'extended_note': Textarea(attrs={'cols': 40, 'rows': 5}),
            'gloss': TextInput(attrs={'size': 40}),
            'note': TextInput(attrs={'size': 40}),
            'freq': NumberInput(attrs={'min': 0}),
            'pronunciation': TextInput(attrs={'size': 40}),
            'valence': TextInput(attrs={'size': 40}),
            'source': TextInput(attrs={'size': 40}),
            'qualifiers_dor': TextInput(attrs={'size': 40}),
            'qualifiers_style': TextInput(attrs={'size': 40}),
            'qualifiers_scope': TextInput(attrs={'size': 40}),
        }


# abstract
class LexemeAttributeForm(Form):
    def __init__(self, attribute, required=True, **kwargs):
        super(LexemeAttributeForm, self).__init__(**kwargs)
        self.fields['value'].label = attribute.multilingual_name.translation()
        self.fields['value'].required = attribute.required and required
        self.fields['value'].widget.attrs['data-attr_id'] = attribute.id


class LexemeOpenAttributeForm(LexemeAttributeForm):
    value = CharField(
        widget=TextInput(attrs={
            'size': 40,
            'class': 'extra-attr open-attr',
        }))

    def __init__(self, attribute, initial_value=None, **kwargs):
        assert not attribute.closed and not attribute.multiple
        super(LexemeOpenAttributeForm, self).__init__(attribute, **kwargs)
        if initial_value is not None:
            self.fields['value'].initial = initial_value.value


class LexemeClosedAttributeForm(LexemeAttributeForm):
    value = ModelChoiceField(
        queryset=LexemeAttributeValue.objects.none(),
        widget=Select(attrs={
            'class': 'extra-attr closed-attr',
        }))

    def __init__(self, attribute, initial_value=None, **kwargs):
        assert attribute.closed and not attribute.multiple
        super(LexemeClosedAttributeForm, self).__init__(attribute, **kwargs)
        self.fields['value'].queryset = attribute.values
        self.fields['value'].initial = initial_value


class LexemeMultipleAttributeForm(LexemeAttributeForm):
    value = ModelMultipleChoiceField(
        queryset=LexemeAttributeValue.objects.none(),
        widget=SelectMultiple(attrs={
            'class': 'extra-attr multiple-attr',
        }))

    def __init__(self, attribute, initial_value=None, **kwargs):
        assert attribute.closed and attribute.multiple
        super(LexemeMultipleAttributeForm, self).__init__(attribute, **kwargs)
        self.fields['value'].queryset = attribute.values
        self.fields['value'].initial = initial_value
        self.fields['value'].help_text = ''


class InflectionEditForm(ModelForm):
    pattern_name = CharField(widget=TextInput(
        attrs={'class': 'pattern', 'size': '10'}), label=_(u'Pattern'))
    qualifiers = QualifiersField(
        required=False, label=_(u'Qual.'),
        widget=SelectMultiple(attrs={'class': 'inflection-qualifiers'}))
    inflection_type = CharField(
        widget=HiddenInput(attrs={'class': 'inflection-it'}), label=u'')

    def __init__(self, part_of_speech, user, editable=True, index=None,
                 **kwargs):
        super(InflectionEditForm, self).__init__(**kwargs)
        if part_of_speech.inflection_type_id != 'subst':
            self.fields['gender'].widget = HiddenInput()
            self.fields['gender'].label = ''
        instance = getattr(self, 'instance', None)
        self.fields['inflection_type'].initial = \
            part_of_speech.inflection_type_id
        self.fields['qualifiers'].set_qualifiers(
            user, instance, types=[Qualifier.TYPE_STYLE, Qualifier.TYPE_FORM])
        if instance and instance.id:
            self.fields['pattern_name'].initial = instance.pattern.name
            if not editable:
                for name, field in self.fields.iteritems():
                    if name != 'qualifiers':
                        disable_field(field)
        self.index = index

    def clean(self):
        cleaned_data = self.cleaned_data
        if 'pattern_name' in cleaned_data:
            try:
                pattern = Pattern.objects.get(name=cleaned_data['pattern_name'])
            except Pattern.DoesNotExist:
                raise ValidationError(_(u'Incorrect pattern name.'))
            it = cleaned_data['inflection_type']
            if pattern.type.inflection_type_id != it:
                raise ValidationError(
                    _(u'The pattern doesn\'t match the part of speech'))
            genders = pattern.genders.all()
            if genders and cleaned_data['gender'] not in genders:
                raise ValidationError(
                    _(u'Pattern %(pattern)s isn’t marked for use with nouns '
                      u'of gender %(gender)s. If you are sure that it’s '
                      u'appropriate here, edit the pattern or contact someone '
                      u'with sufficient permissions.') % {
                        'pattern': pattern.name,
                        'gender': cleaned_data['gender']
                    })
            cleaned_data['pattern'] = pattern
        return cleaned_data

    def save(self, *args, **kwargs):
        inflection = self.instance
        inflection.pattern = self.cleaned_data['pattern']
        if self.index:
            inflection.index = self.index
        super(InflectionEditForm, self).save(*args, **kwargs)
        inflection.save()
        return inflection

    class Meta:
        model = Inflection
        fields = ['gender', 'pronunciation']
        widgets = {
            'gender': Select(attrs={'class': 'gender'}),
            'pronunciation': TextInput(
                attrs={'class': 'inflection-pronunciation-field'}),
        }


class ClassificationForm(Form):
    values = TypedMultipleChoiceField(
        choices=[], empty_value=None, coerce=int,
        widget=SelectMultiple(attrs={'class': 'classification-values'}))

    def __init__(self, classification, editable=True, values=None,
                 required=True, **kwargs):
        super(ClassificationForm, self).__init__(**kwargs)
        self.fields['values'].label = \
            classification.multilingual_name.translation()
        self.fields['values'].choices = classification.make_choices()
        self.fields['values'].required = required
        if values:
            self.fields['values'].initial = [value.pk for value in values]
        if not editable:
            for _name, field in self.fields.iteritems():
                disable_field(field)


class CrossReferenceForm(ModelForm):
    entry = CharField(label=_(u'entry'), widget=TextInput(attrs={
        'class': 'entry',
        'size': 12,
    }))
    homonym_number = IntegerField(
        label=_(u'hom.'),
        widget=TextInput(attrs={
            'class': 'homonym-number',
            'readonly': 'readonly',
            'size': 1,
        }))

    def __init__(self, lexeme=None, pos=None, **kwargs):
        super(CrossReferenceForm, self).__init__(**kwargs)
        if lexeme is not None:
            if pos is None:
                pos = lexeme.part_of_speech
            crtypes = pos.crtype_to.all()
            type_choices = crtypes.values_list('pk', 'desc')
            self.fields['type'].widget.choices = type_choices
            self.fields['from_lexeme'].initial = lexeme.pk

    def clean(self):
        cleaned_data = self.cleaned_data
        from_lexeme = cleaned_data.get('from_lexeme')
        entry = cleaned_data.get('entry')
        hom = cleaned_data.get('homonym_number')
        cr_type = cleaned_data.get('type')
        try:
            to_lexeme = Lexeme.objects.get(
                entry=entry, homonym_number=hom, part_of_speech=cr_type.to_pos)
        except Lexeme.DoesNotExist:
            raise ValidationError(_(u'Chosen lexeme doesn\'t exist.'))
        except Lexeme.MultipleObjectsReturned:
            # jeśli się zdarzy, to jest niespójność w danych
            raise ValidationError(_(u'Ambiguous homonym number!'))
        if from_lexeme and to_lexeme and cr_type:
            if cr_type.from_pos != from_lexeme.part_of_speech:
                raise ValidationError(
                    _(u'Incorrect part of speech in cross-reference.'))
        cleaned_data['to_lexeme'] = to_lexeme
        return cleaned_data

    def save(self, commit=True):
        cr = super(CrossReferenceForm, self).save(False)
        cr.to_lexeme = self.cleaned_data['to_lexeme']
        if commit:
            cr.save()
        return cr

    class Meta:
        model = CrossReference
        fields = ['type', 'from_lexeme']
        widgets = {
            'type': Select(attrs={'class': 'type'}),
            'from_lexeme': HiddenInput(),
        }


# dynamic actions

ADD_REMOVE_CHOICES = (
    ('add', _(u'Add')),
    ('remove', _(u'Remove')),
)


class StatusActionForm(Form):
    action = ChoiceField(
        choices=[('set', _(u'set'))], label=u'',
        widget=Select(attrs={'class': 'action-choice'}))


class StatusValueForm(Form):
    value = ChoiceField(
        choices=Lexeme.STATUS_CHOICES, label=u'',
        widget=Select(attrs={'class': 'value-choice'}))

    def __init__(self, request, **kwargs):
        super(StatusValueForm, self).__init__(**kwargs)


class UsingVocabularyActionForm(Form):
    action = ChoiceField(
        choices=ADD_REMOVE_CHOICES, label=u'',
        widget=Select(attrs={'class': 'action-choice'}))


class VocabularyValueForm(Form):
    value = ModelChoiceField(
        queryset=Vocabulary.objects.none(), label=u'',
        widget=Select(attrs={'class': 'value-choice'}))

    def __init__(self, request, **kwargs):
        super(VocabularyValueForm, self).__init__(**kwargs)
        self.fields['value'].queryset = Vocabulary.editable_vocabularies(
            request.user)


class LexemeQualifierActionForm(Form):
    action = ChoiceField(
        choices=ADD_REMOVE_CHOICES, label=u'',
        widget=Select(attrs={'class': 'action-choice'}))


class LexemeQualifierValueForm(Form):
    value = QualifierField(
        label=u'', widget=Select(attrs={'class': 'value-choice'}))

    def __init__(self, request, **kwargs):
        super(LexemeQualifierValueForm, self).__init__(**kwargs)
        self.fields['value'].set_qualifiers(
            Qualifier.editable_qualifiers(request.user))


ACTION_FIELDS = (
    (
        'status',
        (_(u'Status'), StatusActionForm, StatusValueForm)
    ),
    (
        'using_vocabulary',
        (_(u'Using dictionary'), UsingVocabularyActionForm,
         VocabularyValueForm)
    ),
    (
        'lexeme_qualifier',
        (
            _(u'Lexeme qualifier'),
            LexemeQualifierActionForm, LexemeQualifierValueForm
        )
    ),
)


class ActionFieldForm(Form):
    field = ChoiceField(
        choices=[(id, data[0]) for id, data in ACTION_FIELDS], label=u'',
        widget=Select(attrs={'class': 'field-choice'}))