troggle/core/forms.py

import string
from datetime import date

import django.forms as forms
from django.forms import ModelForm
from django.forms.models import modelformset_factory
from django.contrib.admin.widgets import AdminDateWidget

#from tinymce.widgets import TinyMCE

from troggle.core.models.troggle import Person, PersonExpedition, Expedition, SimpleFileModel
from troggle.core.models.caves import Cave, LogbookEntry, QM, Entrance, CaveAndEntrance

'''These are all the Forms used by troggle
Some are not used and need renovating or destroying.
'''

todo = '''Remove UploadFileForm - replace by Simple variant
Re engineer Simple upload to not use a Django form object

'''

class CaveForm(ModelForm):
    '''Only those fields for which we want to override defaults are listed here
    the other fields are present on the form, but use the default presentation style
    '''
    official_name = forms.CharField(required = False, widget=forms.TextInput(attrs={'size': '45'}))
    underground_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':9}))
    explorers = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    equipment = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    survey = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    #survey = forms.CharField(required = False, widget=TinyMCE(attrs={'cols': 80, 'rows': 10}))
    kataster_status = forms.CharField(required = False)
    underground_centre_line = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    notes = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    references = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':1}))
    description_file = forms.CharField(required = False, widget=forms.TextInput(attrs={'size': '45'})) 
    survex_file = forms.CharField(required = False, label="Survex file [caves-1623/000/000.svx]", widget=forms.TextInput(attrs={'size': '45'})) 
    url = forms.CharField(required = True, label="URL [1623/000/000]", widget=forms.TextInput(attrs={'size': '45'})) 
    length = forms.CharField(required = False, label="Length (m)") 
    depth = forms.CharField(required = False, label="Depth (m)") 
    extent = forms.CharField(required = False, label="Extent (m)") 
    class Meta:
        model = Cave
        exclude = ("filename",)

    def clean(self):
        if self.cleaned_data.get("kataster_number") == "" and self.cleaned_data.get("unofficial_number") == "":
            self._errors["unofficial_number"] = self.error_class(["Either the kataster or unoffical number is required."]) 
#        if self.cleaned_data.get("kataster_number") != "" and self.cleaned_data.get("official_name") == "":
#            self._errors["official_name"] = self.error_class(["This field is required when there is a kataster number."]) 
        if self.cleaned_data.get("area") == []:
            self._errors["area"] = self.error_class(["This field is required."])
        if self.cleaned_data.get("url") and self.cleaned_data.get("url").startswith("/"):
            self._errors["url"] = self.error_class(["This field cannot start with a /."])
        return self.cleaned_data

# class VersionControlCommentForm(forms.Form):
    # '''Was appended to all forms. Not used currently
    # '''
    # description_of_change = forms.CharField(required = True, widget=forms.Textarea(attrs={'rows':2}))


class EntranceForm(ModelForm):
    '''Only those fields for which we want to override defaults are listed here
    the other fields are present on the form, but use the default presentaiton style
    '''
    name = forms.CharField(required = False, widget=forms.TextInput(attrs={'size': '45'}))
    entrance_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':9}))
    explorers = forms.CharField(required = False, widget=forms.TextInput(attrs={'size': '45'}))
    #explorers = forms.CharField(required = False, widget=TinyMCE(attrs={'cols': 80, 'rows': 10}))
    map_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':3}))
    location_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':3}))
    approach = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':3}))
    underground_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':3}))
    photo = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    marking_comment = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    findability_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    other_description = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    bearings = forms.CharField(required = False, widget=forms.Textarea(attrs={'rows':2}))
    other_station = forms.CharField(required=False) 
    tag_station = forms.CharField(required=False) 
    exact_station = forms.CharField(required=False) 
    northing = forms.CharField(required=False) 
    easting = forms.CharField(required=False)
    alt = forms.CharField(required=False, label="Altitude (m)") 
    url = forms.CharField(required = False, label="URL [usually blank]", widget=forms.TextInput(attrs={'size': '45'})) 
    class Meta:
        model = Entrance
        exclude = ("cached_primary_slug", "filename",)
    def clean(self):
        if self.cleaned_data.get("url").startswith("/"):
            self._errors["url"] = self.error_class(["This field cannot start with a /."])
        return self.cleaned_data


# This next line is called from the templates/edit_cave2.html template.
# This is sufficeint to create an entire entry for for the cave fields automatically
# http://localhost:8000/cave/new/
# using django built-in Deep magic. https://docs.djangoproject.com/en/2.2/topics/forms/modelforms/
CaveAndEntranceFormSet = modelformset_factory(CaveAndEntrance, exclude=('cave',))

class EntranceLetterForm(ModelForm):
    '''Can't see what this does at all. called twice from views.caves
    '''
    class Meta:
        model = CaveAndEntrance
        exclude = ('cave', 'entrance')

def get_name(pe):
            if pe.nickname:
                return pe.nickname
            else:
                return pe.person.first_name

class UploadFileForm(forms.Form):
    """Only called by views.others.newFile() which seems to be only about logbook files.
    """
    title = forms.CharField(max_length=50)
    file  = forms.FileField()
    #html = forms.CharField(widget=TinyMCE(attrs={'cols': 80, 'rows': 30}))
    html = forms.CharField(widget=forms.Textarea(attrs={"cols":80, "rows":20}))
    lon_utm = forms.FloatField(required=False)
    lat_utm = forms.FloatField(required=False)
    slug = forms.CharField(max_length=50)
    date = forms.DateField(required=False)
    survey_point = forms.CharField()

    # Because this has EXECUTABLE statements in its signature (the fields) they get
    # executed when this module is LOADED. Which barfs horribly.
    # so all put in an __init__ method instead pending deletion or rewriting
    def __init__(self):
        #This next line is the one that causes django.setup() to BARF LOUDLY
        caves = [cave.slug for cave in Cave.objects.all()]
        #caves.sort() # sort needs rewriting for python3
        caves = ["-----"] + caves
        cave = forms.ChoiceField([(c, c) for c in caves], required=False)
        
        entrance = forms.ChoiceField([("-----", "Please select a cave"), ], required=False) 

        expeditions = [e.year for e in Expedition.objects.all()]
        expeditions.sort()
        expeditions = ["-----"] + expeditions
        expedition = forms.ChoiceField([(e, e) for e in expeditions], required=False)  

        qm = forms.ChoiceField([("-----", "Please select a cave"), ], required=False) 
        logbookentry = forms.ChoiceField([("-----", "Please select an expedition"), ], required=False) 
        person = forms.ChoiceField([("-----", "Please select an expedition"), ], required=False) 


        
class SimpleUploadFileForm(forms.ModelForm):
    """New in April 2021
    """
    class Meta:
        model = SimpleFileModel
        fields = ('title', 'simplefile',)