forms.py

import re

from dal import autocomplete
from django import forms
from crispy_forms.helper import FormHelper
from crispy_forms.layout import Submit, Layout, Fieldset, Div, HTML, ButtonHolder
from crispy_forms.bootstrap import Field
from .models import (
    SkosCollection,
    SkosConcept,
    SkosConceptScheme,
    ConceptSchemeTitle,
    ConceptSchemeDescription,
    ConceptSchemeSource,
    CollectionLabel,
    CollectionNote,
    CollectionSource,
    ConceptLabel,
    ConceptNote,
    ConceptSource
)
from django.forms.models import inlineformset_factory
from .custom_layout_object import Formset
from mptt.forms import TreeNodeChoiceField
from .endpoints import ENDPOINT_CHOICES


class GenericFilterFormHelper(FormHelper):
    def __init__(self, *args, **kwargs):
        super(GenericFilterFormHelper, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.form_class = 'genericFilterForm'
        self.form_method = 'GET'
        self.add_input(Submit('Filter', 'search'))


class UploadFileForm(forms.Form):
    file = forms.FileField()
    language = forms.CharField(
        max_length=3, required=True,
        help_text="Specify the main language of your vocabulary (in format ISO 639-1 or ISO 639-3)",
        widget=forms.TextInput(attrs={'placeholder': 'e.g. en'})
    )

    def __init__(self, *args, **kwargs):
        super(UploadFileForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-3'
        self.helper.field_class = 'col-md-9'
        self.helper.add_input(Submit('submit', 'upload', css_id='uploadFile'), )


def custom_name_errors(field_name):
    name_errors = {'required': f'{field_name} is required when language provided'}
    name_errors['invalid'] = 'Enter a valid value'
    return name_errors


def custom_lang_errors(field_name):
    lang_errors = {'required': f'Language is required when {field_name.lower()} provided'}
    lang_errors['invalid'] = 'Enter a valid value'
    return lang_errors


######################################################################
#   Classes  to store titles and descriptions for ConceptScheme
######################################################################


class ConceptSchemeTitleForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptSchemeTitle._meta.get_field('name').verbose_name,
        help_text=ConceptSchemeTitle._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptSchemeTitle._meta.get_field('name').verbose_name
        )
    )
    language = forms.CharField(
        required=False,
        label=ConceptSchemeTitle._meta.get_field('language').verbose_name,
        help_text=ConceptSchemeTitle._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptSchemeTitle._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptSchemeTitleForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptSchemeTitle
        exclude = ()


ConceptSchemeTitleFormSet = inlineformset_factory(
    SkosConceptScheme, ConceptSchemeTitle,
    form=ConceptSchemeTitleForm,
    fields=['name', 'language'], extra=1, can_delete=True
)


class ConceptSchemeDescriptionForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptSchemeDescription._meta.get_field('name').verbose_name,
        help_text=ConceptSchemeDescription._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptSchemeDescription._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=ConceptSchemeDescription._meta.get_field('language').verbose_name,
        help_text=ConceptSchemeDescription._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptSchemeDescription._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptSchemeDescriptionForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptSchemeDescription
        exclude = ()


ConceptSchemeDescriptionFormSet = inlineformset_factory(
    SkosConceptScheme, ConceptSchemeDescription,
    form=ConceptSchemeDescriptionForm,
    fields=['name', 'language'], extra=1, can_delete=True
)


class ConceptSchemeSourceForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptSchemeSource._meta.get_field('name').verbose_name,
        help_text=ConceptSchemeSource._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptSchemeSource._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=ConceptSchemeSource._meta.get_field('language').verbose_name,
        help_text=ConceptSchemeSource._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptSchemeSource._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptSchemeSourceForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptSchemeSource
        exclude = ()


ConceptSchemeSourceFormSet = inlineformset_factory(
    SkosConceptScheme, ConceptSchemeSource, form=ConceptSchemeSourceForm,
    fields=['name', 'language'],
    extra=1, can_delete=True
)


######################################################################
#
# SkosConceptScheme
#
######################################################################


class SkosConceptSchemeForm(forms.ModelForm):
    class Meta:
        model = SkosConceptScheme
        exclude = ['created_by', ]
        widgets = {
            'curator': autocomplete.ModelSelect2Multiple(
                url='vocabs-ac:user-autocomplete'),
        }

    def __init__(self, *args, **kwargs):
        super(SkosConceptSchemeForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'
        self.helper.layout = Layout(
            Div(
                Field('title'),
                Field('title_lang'),
                Fieldset('Add titles in other languages',
                         Formset('titles'), css_class="formset-div"),
                Fieldset('Add description',
                         Formset('descriptions'), css_class="formset-div"),
                Field('identifier', placeholder="https://example.org/vocabulary-unique-title"),
                Field('language'),
                Field('creator'),
                Field('contributor'),
                Field('publisher'),
                Field('license'),
                Field('owner'),
                Field('subject'),
                Field('relation'),
                Field('coverage'),
                Fieldset('Add source information',
                         Formset('sources'), css_class="formset-div"),
                Field('version'),
                Field('legacy_id'),
                Field('date_issued', placeholder="YYYY-MM-DD"),
                Field('curator'),
                HTML("<br>"),
                ButtonHolder(Submit('submit', 'save')),
            )
        )


class SkosConceptSchemeFormHelper(FormHelper):
    def __init__(self, *args, **kwargs):
        super(SkosConceptSchemeFormHelper, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.form_class = 'genericFilterForm'
        self.form_method = 'GET'
        self.helper.form_tag = False
        self.add_input(Submit('Filter', 'Search'))
        self.layout = Layout(
            Fieldset(
                '',
                'title',
                'creator',
                css_id="basic_search_fields"
            ),
        )


######################################################################
#   Classes  to store labels and notes for Collection
######################################################################

class CollectionLabelForm(forms.ModelForm):
    name = forms.CharField(
        label=CollectionLabel._meta.get_field('name').verbose_name,
        help_text=CollectionLabel._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=CollectionLabel._meta.get_field('name').verbose_name
        )
    )
    language = forms.CharField(
        required=False,
        label=CollectionLabel._meta.get_field('language').verbose_name,
        help_text=CollectionLabel._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=CollectionLabel._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(CollectionLabelForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = CollectionLabel
        exclude = ()


CollectionLabelFormSet = inlineformset_factory(
    SkosCollection, CollectionLabel, form=CollectionLabelForm,
    fields=['name', 'label_type', 'language'],
    extra=1, can_delete=True
)


class CollectionNoteForm(forms.ModelForm):
    name = forms.CharField(
        label=CollectionNote._meta.get_field('name').verbose_name,
        help_text=CollectionNote._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=CollectionNote._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=CollectionNote._meta.get_field('language').verbose_name,
        help_text=CollectionNote._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=CollectionNote._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(CollectionNoteForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = CollectionNote
        exclude = ()


CollectionNoteFormSet = inlineformset_factory(
    SkosCollection, CollectionNote, form=CollectionNoteForm,
    fields=['name', 'note_type', 'language'],
    extra=1, can_delete=True
)


class CollectionSourceForm(forms.ModelForm):
    name = forms.CharField(
        label=CollectionSource._meta.get_field('name').verbose_name,
        help_text=CollectionSource._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=CollectionSource._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=CollectionSource._meta.get_field('language').verbose_name,
        help_text=CollectionSource._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=CollectionSource._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(CollectionSourceForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = CollectionSource
        exclude = ()


CollectionSourceFormSet = inlineformset_factory(
    SkosCollection, CollectionSource, form=CollectionSourceForm,
    fields=['name', 'language'],
    extra=1, can_delete=True
)


######################################################################
#
# SkosCollection
#
######################################################################

class SkosCollectionForm(forms.ModelForm):
    class Meta:
        model = SkosCollection
        exclude = ['created_by', ]
        widgets = {
            'scheme': autocomplete.ModelSelect2(
                url='vocabs-ac:skosconceptscheme-autocomplete'),
        }

    def __init__(self, *args, **kwargs):
        super(SkosCollectionForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'
        self.helper.layout = Layout(
            Div(
                Field('name'),
                Field('label_lang'),
                Fieldset('Add other labels or labels in other languages',
                         Formset('labels'), css_class="formset-div"),
                Field('scheme'),
                Field('creator'),
                Field('contributor'),
                Field('legacy_id'),
                Fieldset('Add documentary note',
                         Formset('notes'), css_class="formset-div"),
                Fieldset('Add source information',
                         Formset('sources'), css_class="formset-div"),
                HTML("<br>"),
                ButtonHolder(Submit('submit', 'save')),
            )
        )


class SkosCollectionFormHelper(FormHelper):

    def __init__(self, *args, **kwargs):
        super(SkosCollectionFormHelper, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.form_class = 'genericFilterForm'
        self.form_method = 'GET'
        self.helper.form_tag = False
        self.add_input(Submit('Filter', 'Search'))
        self.layout = Layout(
            Fieldset(
                '',
                'name',
                'creator',
                'scheme',
                'has_members__pref_label',
                css_id="basic_search_fields"
            ),
        )


######################################################################
#   Classes  to store labels, notes and sources for Concept
######################################################################

class ConceptLabelForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptLabel._meta.get_field('name').verbose_name,
        help_text=ConceptLabel._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptLabel._meta.get_field('name').verbose_name
        )
    )
    language = forms.CharField(
        required=False,
        label=ConceptLabel._meta.get_field('language').verbose_name,
        help_text=ConceptLabel._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptLabel._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptLabelForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptLabel
        exclude = ()


ConceptLabelFormSet = inlineformset_factory(
    SkosConcept, ConceptLabel, form=ConceptLabelForm,
    fields=['name', 'label_type', 'language'],
    extra=1, can_delete=True
)


class ConceptNoteForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptNote._meta.get_field('name').verbose_name,
        help_text=ConceptNote._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptNote._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=ConceptNote._meta.get_field('language').verbose_name,
        help_text=ConceptNote._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptNote._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptNoteForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptNote
        exclude = ()


ConceptNoteFormSet = inlineformset_factory(
    SkosConcept, ConceptNote, form=ConceptNoteForm,
    fields=['name', 'note_type', 'language'],
    extra=1, can_delete=True
)


class ConceptSourceForm(forms.ModelForm):
    name = forms.CharField(
        label=ConceptSource._meta.get_field('name').verbose_name,
        help_text=ConceptSource._meta.get_field('name').help_text,
        error_messages=custom_name_errors(
            field_name=ConceptSource._meta.get_field('name').verbose_name
        ),
        widget=forms.Textarea
    )
    language = forms.CharField(
        required=False,
        label=ConceptSource._meta.get_field('language').verbose_name,
        help_text=ConceptSource._meta.get_field('language').help_text,
        error_messages=custom_lang_errors(
            field_name=ConceptSource._meta.get_field('name').verbose_name
        )
    )

    def __init__(self, *args, **kwargs):
        super(ConceptSourceForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'

    class Meta:
        model = ConceptSource
        exclude = ()


ConceptSourceFormSet = inlineformset_factory(
    SkosConcept, ConceptSource, form=ConceptSourceForm,
    fields=['name', 'language'],
    extra=1, can_delete=True
)


######################################################################
#
# SkosConcept
#
######################################################################

class AutocompleteCharField(forms.CharField):
    widget = autocomplete.TagSelect2(
        url='vocabs-ac:external-link-ac',
        forward=['endpoint'],
        attrs={
            'data-placeholder': 'Type at least 3 characters to get autocomplete suggestions ...',
            'data-minimum-input-length': 3,
        },
    )

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.required = False

    def to_python(self, value):
        """Normalize data to keep only URIs."""
        clean_value = ",".join(re.findall("(?P<url>https?://[^\s\,]+)", value))
        return clean_value


class SkosConceptForm(forms.ModelForm):
    broader_concept = TreeNodeChoiceField(
        queryset=SkosConcept.objects.all(),
        widget=autocomplete.ModelSelect2(
            url='vocabs-ac:skosconcept-autocomplete',
            forward=['scheme']
        ),
        help_text=SkosConcept._meta.get_field('broader_concept').help_text,
        required=False,
        label=SkosConcept._meta.get_field('broader_concept').verbose_name,
    )
    collection = forms.ModelMultipleChoiceField(
        queryset=SkosCollection.objects.all(),
        widget=autocomplete.ModelSelect2Multiple(
            url='vocabs-ac:skoscollection-autocomplete',
            forward=['scheme']
        ),
        help_text=SkosConcept._meta.get_field('collection').help_text,
        required=False,
        label=SkosConcept._meta.get_field('collection').verbose_name,
    )
    endpoint = forms.ChoiceField(
        choices=ENDPOINT_CHOICES, required=False,
        help_text="Select a service to create links to external resources<br>\
        You can also type a matching concept URI in the fields below if it is not provided by current endpoints<br>\
        In that case please note that an external concept's URI should follow the format 'http{s}://example.org/...'"
    )
    related = AutocompleteCharField(
        label=SkosConcept._meta.get_field('related').verbose_name,
        help_text=SkosConcept._meta.get_field('related').help_text
    )
    broad_match = AutocompleteCharField(
        label=SkosConcept._meta.get_field('broad_match').verbose_name,
        help_text=SkosConcept._meta.get_field('broad_match').help_text
    )
    narrow_match = AutocompleteCharField(
        label=SkosConcept._meta.get_field('narrow_match').verbose_name,
        help_text=SkosConcept._meta.get_field('narrow_match').help_text
    )
    exact_match = AutocompleteCharField(
        label=SkosConcept._meta.get_field('exact_match').verbose_name,
        help_text=SkosConcept._meta.get_field('exact_match').help_text
    )
    related_match = AutocompleteCharField(
        label=SkosConcept._meta.get_field('related_match').verbose_name,
        help_text=SkosConcept._meta.get_field('related_match').help_text
    )
    close_match = AutocompleteCharField(
        label=SkosConcept._meta.get_field('close_match').verbose_name,
        help_text=SkosConcept._meta.get_field('close_match').help_text
    )
    needs_review = forms.BooleanField(
        widget=forms.CheckboxInput, required=False,
        help_text=SkosConcept._meta.get_field('needs_review').help_text
    )

    class Meta:
        model = SkosConcept
        exclude = ['created_by', ]
        widgets = {
            'scheme': autocomplete.ModelSelect2(
                url='vocabs-ac:skosconceptscheme-autocomplete'),
        }

    def __init__(self, *args, **kwargs):
        super(SkosConceptForm, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.helper.form_tag = True
        self.helper.form_class = 'form-horizontal'
        self.helper.label_class = 'col-md-2 create-label'
        self.helper.field_class = 'col-md-10'
        self.helper.layout = Layout(
            Div(
                Field('pref_label'),
                Field('pref_label_lang'),
                Fieldset('Add other labels',
                         Formset('labels'), css_class="formset-div"),
                Field('scheme'),
                # Field('top_concept'),
                Field('collection'),
                Field('broader_concept'),
                Fieldset('Add documentary note',
                         Formset('notes'), css_class="formset-div"),
                Field('creator'),
                Field('contributor'),
                Field('notation'),
                Field('legacy_id'),
                Fieldset('Add source information',
                         Formset('sources'), css_class="formset-div"),
                Fieldset('Add semantic relationships',
                         Field('endpoint'),
                         Field('related'),
                         Field('broad_match'),
                         Field('narrow_match'),
                         Field('exact_match'),
                         Field('related_match'),
                         Field('close_match'),
                         ),
                Fieldset('Quality check',
                         Field('needs_review'),
                         ),
                HTML("<br>"),
                ButtonHolder(Submit('submit', 'save')),
            )
        )
        self.helper.render_required_fields = True


class SkosConceptFormHelper(FormHelper):
    def __init__(self, *args, **kwargs):
        super(SkosConceptFormHelper, self).__init__(*args, **kwargs)
        self.helper = FormHelper()
        self.form_class = 'genericFilterForm'
        self.form_method = 'GET'
        self.helper.form_tag = False
        self.add_input(Submit('Filter', 'Search'))
        self.layout = Layout(
            Fieldset(
                '',
                'pref_label',
                'scheme',
                'collection',
                'broader_concept',
                css_id="basic_search_fields"
            ),
        )