AKSolverInterface/utils.py

+from pathlib import Path
+
+import referencing.retrieval
+from jsonschema import Draft202012Validator
+from jsonschema.protocols import Validator
+from referencing import Registry
+
+from AKPlanning import settings
+
+
+def _construct_schema_path(uri: str | Path) -> Path:
+    """Construct a schema URI.
+
+    This function also checks for unallowed directory traversals
+    out of the 'schema' subfolder.
+    """
+    schema_base_path = Path(settings.BASE_DIR).resolve()
+    uri_path = (schema_base_path / uri).resolve()
+    if not uri_path.is_relative_to(schema_base_path / "schemas"):
+        raise ValueError("Unallowed dictionary traversal")
+    return uri_path
+
+
+@referencing.retrieval.to_cached_resource()
+def retrieve_schema_from_disk(uri: str) -> str:
+    """Retrieve schemas from disk by URI."""
+    uri_path = _construct_schema_path(uri)
+    with uri_path.open("r") as ff:
+        return ff.read()
+
+
+def construct_schema_validator(schema: str | dict) -> Validator:
+    """Construct a validator for a JSON schema.
+
+    In particular, all schemas from the 'schemas' directory
+    are loaded into the registry.
+    """
+    registry = Registry(retrieve=retrieve_schema_from_disk)
+
+    if isinstance(schema, str):
+        schema_uri = str(Path("schemas") / schema)
+        schema = registry.get_or_retrieve(schema_uri).value.contents
+    return Draft202012Validator(schema=schema, registry=registry)

AKSolverInterface/views.py

+import json
+
+from django.contrib import messages
+from django.db.models import Q
+from django.db.models.query import QuerySet
+from django.shortcuts import redirect
+from django.utils.translation import gettext_lazy as _
+from django.views.generic import FormView
+
+from AKModel.metaviews.admin import (
+    AdminViewMixin,
+    EventSlugMixin,
+    IntermediateAdminView,
+)
+from AKModel.models import AK, Event
+from AKSolverInterface.forms import JSONExportControlForm, JSONScheduleImportForm
+from AKSolverInterface.serializers import ExportEventSerializer
+
+
+class AKJSONExportView(EventSlugMixin, AdminViewMixin, FormView):
+    """
+    View: Export all AK slots of this event in JSON format ordered by tracks
+    """
+
+    template_name = "admin/AKSolverInterface/ak_json_export.html"
+    model = Event
+    form_class = JSONExportControlForm
+    title = _("AK JSON Export")
+
+    def get_template_names(self):
+        if self.request.method == "POST":
+            return ["admin/AKSolverInterface/ak_json_export.html"]
+        return ["admin/AKSolverInterface/ak_json_export_control.html"]
+
+    def get_form_kwargs(self):
+        form_kwargs = super().get_form_kwargs()
+        form_kwargs["event"] = self.event
+        return form_kwargs
+
+    def form_valid(self, form):
+        context = self.get_context_data()
+        try:
+            aks_without_slot = AK.objects.filter(event=self.event, akslot__isnull=True).all()
+            if aks_without_slot.exists():
+                messages.warning(
+                    self.request,
+                    _(
+                        "The following AKs have no slot assigned to them "
+                        "and are therefore not exported: {aks_list}"
+                    ).format(
+                        aks_list=", ".join(aks_without_slot.values_list("name", flat=True))
+                    )
+                )
+
+            def _filter_slots_cb(queryset: QuerySet) -> QuerySet:
+                queryset = queryset.prefetch_related("ak")
+                if "export_tracks" in form.cleaned_data:
+                    queryset = queryset.filter(
+                        Q(ak__track__in=form.cleaned_data["export_tracks"])
+                        | Q(ak__track__isnull=True)
+                    )
+                if "export_categories" in form.cleaned_data:
+                    queryset = queryset.filter(
+                        Q(ak__category__in=form.cleaned_data["export_categories"])
+                        | Q(ak__category__isnull=True)
+                    )
+                if "export_types" in form.cleaned_data:
+                    queryset = queryset.filter(
+                        Q(ak__types__in=form.cleaned_data["export_types"])
+                        | Q(ak__types__isnull=True)
+                    )
+
+                queryset = queryset.distinct().all()
+                if not queryset.exists():
+                    messages.warning(
+                        self.request,
+                        _("No AKSlots are exported"),
+                    )
+
+                return queryset
+
+            def _filter_rooms_cb(queryset: QuerySet) -> QuerySet:
+                queryset = queryset.all()
+                if not queryset.exists():
+                    messages.warning(self.request, _("No Rooms are exported"))
+                return queryset
+
+            def _filter_participants_cb(queryset: QuerySet) -> QuerySet:
+                queryset = queryset.all()
+                if not queryset.exists():
+                    messages.warning(self.request, _("No real participants are exported"))
+                return queryset
+
+            serialized_event = ExportEventSerializer(
+                context["event"],
+                filter_slots_cb=_filter_slots_cb,
+                filter_rooms_cb=_filter_rooms_cb,
+                filter_participants_cb=_filter_participants_cb,
+                export_scheduled_aks_as_fixed=form.cleaned_data["export_scheduled_aks_as_fixed"],
+            )
+            serialized_event_data = serialized_event.data
+
+            if not serialized_event_data["timeslots"]["blocks"]:
+                messages.warning(self.request, _("No timeslots are exported"))
+            context["json_data_oneline"] = json.dumps(serialized_event_data, ensure_ascii=False)
+            context["json_data"] = json.dumps(serialized_event_data, indent=2, ensure_ascii=False)
+            context["is_valid"] = True
+        except ValueError as ex:
+            messages.add_message(
+                self.request,
+                messages.ERROR,
+                _("Exporting AKs for the solver failed! Reason: ") + str(ex),
+            )
+
+        # if serialization failed in `get_context_data` we redirect to
+        #   the status page and show a message instead
+        if not context.get("is_valid", False):
+            return redirect("admin:event_status", context["event"].slug)
+        return self.render_to_response(context)
+
+
+class AKScheduleJSONImportView(EventSlugMixin, IntermediateAdminView):
+    """
+    View: Import an AK schedule from a json file that can be pasted into this view.
+    """
+
+    template_name = "admin/AKSolverInterface/import_json.html"
+    form_class = JSONScheduleImportForm
+    title = _("AK Schedule JSON Import")
+
+    def form_valid(self, form):
+        try:
+            number_of_slots_changed = self.event.schedule_from_json(
+                form.cleaned_data["data"],
+                check_for_data_inconsistency=False, # TODO: Actually handle filtered export
+            )
+            messages.add_message(
+                self.request,
+                messages.SUCCESS,
+                _("Successfully imported {n} slot(s)").format(
+                    n=number_of_slots_changed
+                ),
+            )
+        except ValueError as ex:
+            messages.add_message(
+                self.request,
+                messages.ERROR,
+                _("Importing an AK schedule failed! Reason: ") + str(ex),
+            )
+
+        return redirect("admin:event_status", self.event.slug)

AKSubmission/admin.py

-# Register your models here.

AKSubmission/api.py

+from datetime import datetime
+
 from rest_framework import status
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
-from django.utils.datetime_safe import datetime
 
 from AKModel.models import AK
 
@@ -17,17 +18,21 @@ def ak_interest_indication_active(event, current_timestamp):
     :return: True if indication is allowed, False if not
     :rtype: Bool
     """
-    return event.active and (event.interest_start is None or (event.interest_start <= current_timestamp and (
-            event.interest_end is None or current_timestamp <= event.interest_end)))
+    return (event.active and event.interest_start is not None and event.interest_end is not None
+            and event.interest_start <= current_timestamp <= event.interest_end)
 
 
 @api_view(['POST'])
 def increment_interest_counter(request, event_slug, pk, **kwargs):
     """
     Increment interest counter for AK
+
+    This view either returns an HTTP 200 if the counter was incremented,
+    an HTTP 403 if indicating interest is currently not allowed,
+    or an HTTP 404 if there is no matching AK for the given primary key and event slug.
     """
     try:
-        ak = AK.objects.get(pk=pk)
+        ak = AK.objects.get(pk=pk, event__slug=event_slug)
         # Check whether interest indication is currently allowed
         current_timestamp = datetime.now().astimezone(ak.event.timezone)
         if ak_interest_indication_active(ak.event, current_timestamp):

AKSubmission/apps.py

@@ -2,4 +2,7 @@ from django.apps import AppConfig
 
 
 class AksubmissionConfig(AppConfig):
+    """
+    App configuration (default, only specifies name of the app)
+    """
     name = 'AKSubmission'

AKSubmission/forms.py

+"""
+Submission-specific forms
+"""
+
 import itertools
 import re
 
@@ -7,10 +11,21 @@ from django.utils.translation import gettext_lazy as _
 
 from AKModel.availability.forms import AvailabilitiesFormMixin
 from AKModel.availability.models import Availability
-from AKModel.models import AK, AKOwner, AKCategory, AKRequirement, AKSlot, AKOrgaMessage, Event
+from AKModel.models import AK, AKCategory, AKOrgaMessage, AKOwner, AKRequirement, AKSlot, AKType
 
 
 class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
+    """
+    Base form to add and edit AKs
+
+    Contains suitable widgets for the different data types, restricts querysets (e.g., of requirements) to entries
+    belonging to the event this AK belongs to.
+    Prepares initial slot creation (by accepting multiple input formats and a list of slots to generate),
+    automatically generate short names and wiki links if necessary
+
+    Will be modified/used by :class:`AKSubmissionForm` (that allows to add slots and excludes links)
+    and :class:`AKWishForm`
+    """
     required_css_class = 'required'
     split_string = re.compile('[,;]')
 
@@ -18,11 +33,13 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
         model = AK
         fields = ['name',
                   'short_name',
-                  'link',
                   'protocol_link',
                   'owners',
                   'description',
+                  'goal',
+                  'info',
                   'category',
+                  'types',
                   'reso',
                   'present',
                   'requirements',
@@ -34,6 +51,7 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
 
         widgets = {
             'requirements': forms.CheckboxSelectMultiple,
+            'types': forms.CheckboxSelectMultiple,
             'event': forms.HiddenInput,
         }
 
@@ -47,7 +65,14 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
         self.fields["prerequisites"].widget.attrs = {'class': 'chosen-select'}
 
         self.fields['category'].queryset = AKCategory.objects.filter(event=self.initial.get('event'))
+        self.fields['types'].queryset = AKType.objects.filter(event=self.initial.get('event'))
+        # Don't ask for types if there are no types configured for this event
+        if self.fields['types'].queryset.count() == 0:
+            self.fields.pop('types')
         self.fields['requirements'].queryset = AKRequirement.objects.filter(event=self.initial.get('event'))
+        # Don't ask for requirements if there are no requirements configured for this event
+        if self.fields['requirements'].queryset.count() == 0:
+            self.fields.pop('requirements')
         self.fields['prerequisites'].queryset = AK.objects.filter(event=self.initial.get('event')).exclude(
             pk=self.instance.pk)
         self.fields['conflicts'].queryset = AK.objects.filter(event=self.initial.get('event')).exclude(
@@ -57,7 +82,14 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
 
     @staticmethod
     def _clean_duration(duration):
-        # Handle different duration formats (h:mm and decimal comma instead of point)
+        """
+        Clean/convert input format for the duration(s) of the slot(s)
+
+        Handle different duration formats (h:mm and decimal comma instead of point)
+
+        :param duration: raw input, either with ":", "," or "."
+        :return: normalized duration (point-separated hour float)
+        """
         if ":" in duration:
             h, m = duration.split(":")
             duration = int(h) + int(m) / 60
@@ -65,40 +97,47 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
             duration = float(duration.replace(",", "."))
 
         try:
-            float(duration)
-        except ValueError:
+            duration = float(duration)
+        except ValueError as exc:
             raise ValidationError(
                 _('"%(duration)s" is not a valid duration'),
                 code='invalid',
                 params={'duration': duration},
-            )
+            ) from exc
 
         return duration
 
     def clean(self):
+        """
+        Normalize/clean inputs
+
+        Generate a (not yet used) short name if field was left blank,
+        create a list of normalized slot durations
+
+        :return: cleaned inputs
+        """
         cleaned_data = super().clean()
 
         # Generate short name if not given
         short_name = self.cleaned_data["short_name"]
         if len(short_name) == 0:
             short_name = self.cleaned_data['name']
+            # First try to split AK name at positions with semantic value (e.g., where the full name is separated
+            # by a ':'), if not possible, do a hard cut at the maximum specified length
             short_name = short_name.partition(':')[0]
             short_name = short_name.partition(' - ')[0]
             short_name = short_name.partition(' (')[0]
             short_name = short_name[:AK._meta.get_field('short_name').max_length]
+            # Check whether this short name already exists...
             for i in itertools.count(1):
+                # ...and either use it...
                 if not AK.objects.filter(short_name=short_name, event=self.cleaned_data["event"]).exists():
                     break
+                # ... or postfix a number starting at 1 and growing until an unused short name is found
                 digits = len(str(i))
-                short_name = '{}-{}'.format(short_name[:-(digits + 1)], i)
+                short_name = f'{short_name[:-(digits + 1)]}-{i}'
             cleaned_data["short_name"] = short_name
 
-        # Generate wiki link
-        if self.cleaned_data["event"].base_url:
-            link = self.cleaned_data["event"].base_url + self.cleaned_data["name"].replace(" ", "_")
-            # Truncate links longer than 200 characters (default length of URL fields in django)
-            self.cleaned_data["link"] = link[:200]
-
         # Get durations from raw durations field
         if "durations" in cleaned_data:
             cleaned_data["durations"] = [self._clean_duration(d) for d in self.cleaned_data["durations"].split()]
@@ -106,35 +145,63 @@ class AKForm(AvailabilitiesFormMixin, forms.ModelForm):
 
 
 class AKSubmissionForm(AKForm):
+    """
+    Form for Submitting new AKs
+
+    Is a special variant of :class:`AKForm` that does not allow to manually edit wiki and protocol links and enforces
+    the generation of at least one slot.
+    """
     class Meta(AKForm.Meta):
-        exclude = ['link', 'protocol_link']
+        # Exclude fields again that were previously included in the parent class
+        exclude = ['link', 'protocol_link'] #pylint: disable=modelform-uses-exclude
+        widgets = AKForm.Meta.widgets | {
+            'types': forms.CheckboxSelectMultiple(attrs={'checked' : 'checked'}),
+        }
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        # Add field for durations
+        # Add field for durations (cleaning will be handled by parent class)
         self.fields["durations"] = forms.CharField(
             widget=forms.Textarea,
             label=_("Duration(s)"),
             help_text=_(
-                "Enter at least one planned duration (in hours). If your AK should have multiple slots, use multiple lines"),
-            initial=
-            self.initial.get('event').default_slot
+                "Enter at least one planned duration (in hours). "
+                "If your AK should have multiple slots, use multiple lines"),
+            initial=self.initial.get('event').default_slot
         )
 
     def clean_availabilities(self):
+        """
+        Automatically improve availabilities entered.
+        If the user did not specify availabilities assume the full event duration is possible
+        :return: cleaned availabilities
+        (either user input or one availability for the full length of the event if user input was empty)
+        """
         availabilities = super().clean_availabilities()
-        # If the user did not specify availabilities assume the full event duration is possible
         if len(availabilities) == 0:
             availabilities.append(Availability.with_event_length(event=self.cleaned_data["event"]))
         return availabilities
 
 
 class AKWishForm(AKForm):
+    """
+    Form for submitting or editing wishes
+
+    Is a special variant of :class:`AKForm` that does not allow to specify owner(s) or
+    manually edit wiki and protocol links
+    """
     class Meta(AKForm.Meta):
-        exclude = ['owners', 'link', 'protocol_link']
+        # Exclude fields again that were previously included in the parent class
+        exclude = ['owners', 'link', 'protocol_link'] #pylint: disable=modelform-uses-exclude
+        widgets = AKForm.Meta.widgets | {
+            'types': forms.CheckboxSelectMultiple(attrs={'checked': 'checked'}),
+        }
 
 
 class AKOwnerForm(forms.ModelForm):
+    """
+    Form to create/edit AK owners
+    """
     required_css_class = 'required'
 
     class Meta:
@@ -146,6 +213,9 @@ class AKOwnerForm(forms.ModelForm):
 
 
 class AKDurationForm(forms.ModelForm):
+    """
+    Form to add an additional slot to a given AK
+    """
     class Meta:
         model = AKSlot
         fields = ['duration', 'ak', 'event']
@@ -156,6 +226,9 @@ class AKDurationForm(forms.ModelForm):
 
 
 class AKOrgaMessageForm(forms.ModelForm):
+    """
+    Form to create a confidential message to the organizers  belonging to a given AK
+    """
     class Meta:
         model = AKOrgaMessage
         fields = ['ak', 'text', 'event']
@@ -164,14 +237,3 @@ class AKOrgaMessageForm(forms.ModelForm):
             'event': forms.HiddenInput,
             'text': forms.Textarea,
         }
-
-
-class AKAddSlotForm(forms.Form):
-    start = forms.CharField(label=_("Start"), disabled=True)
-    end = forms.CharField(label=_("End"), disabled=True)
-    duration = forms.CharField(label=_("Duration"), disabled=True)
-    room = forms.IntegerField(label=_("Room"), disabled=True)
-
-    def __init__(self, event):
-        super().__init__()
-        self.fields['ak'] = forms.ModelChoiceField(event.ak_set.all(), label=_("AK"))

AKSubmission/locale/de_DE/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-15 20:03+0200\n"
+"POT-Creation-Date: 2025-06-24 11:10+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,16 +17,16 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: AKSubmission/forms.py:71
+#: AKSubmission/forms.py:103
 #, python-format
 msgid "\"%(duration)s\" is not a valid duration"
 msgstr "\"%(duration)s\" ist keine gültige Dauer"
 
-#: AKSubmission/forms.py:117
+#: AKSubmission/forms.py:166
 msgid "Duration(s)"
 msgstr "Dauer(n)"
 
-#: AKSubmission/forms.py:119
+#: AKSubmission/forms.py:168
 msgid ""
 "Enter at least one planned duration (in hours). If your AK should have "
 "multiple slots, use multiple lines"
@@ -34,33 +34,6 @@ msgstr ""
 "Mindestens eine geplante Dauer (in Stunden) angeben. Wenn der AK mehrere "
 "Slots haben soll, mehrere Zeilen verwenden"
 
-#: AKSubmission/forms.py:170
-#: AKSubmission/templates/AKSubmission/ak_detail.html:309
-msgid "Start"
-msgstr "Start"
-
-#: AKSubmission/forms.py:171
-#: AKSubmission/templates/AKSubmission/ak_detail.html:310
-msgid "End"
-msgstr "Ende"
-
-#: AKSubmission/forms.py:172
-#: AKSubmission/templates/AKSubmission/ak_detail.html:239
-#: AKSubmission/templates/AKSubmission/akslot_delete.html:35
-msgid "Duration"
-msgstr "Dauer"
-
-#: AKSubmission/forms.py:173
-#: AKSubmission/templates/AKSubmission/ak_detail.html:241
-msgid "Room"
-msgstr "Raum"
-
-#: AKSubmission/forms.py:177
-#: AKSubmission/templates/AKSubmission/ak_history.html:11
-#: AKSubmission/templates/AKSubmission/akslot_delete.html:31
-msgid "AK"
-msgstr "AK"
-
 #: AKSubmission/templates/AKSubmission/ak_detail.html:22
 #: AKSubmission/templates/AKSubmission/ak_edit.html:13
 #: AKSubmission/templates/AKSubmission/ak_history.html:16
@@ -73,164 +46,194 @@ msgstr "AK"
 #: AKSubmission/templates/AKSubmission/submission_not_configured.html:11
 #: AKSubmission/templates/AKSubmission/submission_overview.html:7
 #: AKSubmission/templates/AKSubmission/submission_overview.html:11
-#: AKSubmission/templates/AKSubmission/submission_overview.html:36
-#: AKSubmission/templates/AKSubmission/submit_new.html:31
+#: AKSubmission/templates/AKSubmission/submission_overview.html:40
+#: AKSubmission/templates/AKSubmission/submit_new.html:39
 #: AKSubmission/templates/AKSubmission/submit_new_wish.html:13
 msgid "AK Submission"
 msgstr "AK-Eintragung"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:77
+#: AKSubmission/templates/AKSubmission/ak_detail.html:125
 #: AKSubmission/templates/AKSubmission/ak_interest_script.html:50
 msgid "Interest indication currently not allowed. Sorry."
 msgstr "Interessenangabe aktuell nicht erlaubt. Sorry."
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:79
+#: AKSubmission/templates/AKSubmission/ak_detail.html:127
 #: AKSubmission/templates/AKSubmission/ak_interest_script.html:52
 msgid "Could not save your interest. Sorry."
 msgstr "Interesse konnte nicht gespeichert werden. Sorry."
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:100
+#: AKSubmission/templates/AKSubmission/ak_detail.html:148
 msgid "Interest"
 msgstr "Interesse"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:102
-#: AKSubmission/templates/AKSubmission/ak_table.html:55
+#: AKSubmission/templates/AKSubmission/ak_detail.html:150
+#: AKSubmission/templates/AKSubmission/ak_table.html:65
 msgid "Show Interest"
 msgstr "Interesse bekunden"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:108
-#: AKSubmission/templates/AKSubmission/ak_table.html:46
+#: AKSubmission/templates/AKSubmission/ak_detail.html:156
+#: AKSubmission/templates/AKSubmission/ak_table.html:56
 msgid "Open external link"
 msgstr "Externen Link öffnen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:113
+#: AKSubmission/templates/AKSubmission/ak_detail.html:161
 msgid "Open protocol link"
 msgstr "Protokolllink öffnen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:118
+#: AKSubmission/templates/AKSubmission/ak_detail.html:166
 #: AKSubmission/templates/AKSubmission/ak_history.html:19
 #: AKSubmission/templates/AKSubmission/ak_history.html:31
 msgid "History"
 msgstr "Versionsgeschichte"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:121
+#: AKSubmission/templates/AKSubmission/ak_detail.html:169
 #: AKSubmission/templates/AKSubmission/akmessage_add.html:8
 #: AKSubmission/templates/AKSubmission/akmessage_add.html:16
 #: AKSubmission/templates/AKSubmission/akmessage_add.html:22
 msgid "Add confidential message to organizers"
 msgstr "Sende eine private Nachricht an das Organisationsteam"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:124
-#: AKSubmission/templates/AKSubmission/ak_detail.html:269
+#: AKSubmission/templates/AKSubmission/ak_detail.html:172
+#: AKSubmission/templates/AKSubmission/ak_detail.html:334
 #: AKSubmission/templates/AKSubmission/ak_edit.html:16
-#: AKSubmission/templates/AKSubmission/ak_table.html:51
+#: AKSubmission/templates/AKSubmission/ak_table.html:61
 msgid "Edit"
 msgstr "Bearbeiten"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:129
+#: AKSubmission/templates/AKSubmission/ak_detail.html:177
 #: AKSubmission/templates/AKSubmission/ak_history.html:31
-#: AKSubmission/templates/AKSubmission/ak_table.html:34
+#: AKSubmission/templates/AKSubmission/ak_table.html:37
 msgid "AK Wish"
 msgstr "AK-Wunsch"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:136
+#: AKSubmission/templates/AKSubmission/ak_detail.html:186
 #, python-format
 msgid ""
-"\n"
-"                        This AK currently takes place for another "
-"%(featured_slot_remaining)s minute(s) in %(room)s.\n"
-"                        &nbsp;\n"
-"                    "
+"This AK currently takes place for another <span v-"
+"html=\"timeUntilEnd\">%(featured_slot_remaining)s</span> minute(s) in "
+"%(room)s.&nbsp;"
 msgstr ""
-"\n"
-"                        Dieser AK findet noch %(featured_slot_remaining)s "
-"Minute(n) in %(room)s statt.&nbsp;\n"
+"Dieser AK findet noch <span v-"
+"html=\"timeUntilEnd\">%(featured_slot_remaining)s</span> Minute(n) in "
+"%(room)s statt.&nbsp;\n"
 "                    "
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:142
+#: AKSubmission/templates/AKSubmission/ak_detail.html:190
 #, python-format
 msgid ""
-"\n"
-"                        This AK starts in %(featured_slot_remaining)s "
-"minute(s) in %(room)s.&nbsp;\n"
-"                    "
+"This AK starts in <span v-"
+"html=\"timeUntilStart\">%(featured_slot_remaining)s</span> minute(s) in "
+"%(room)s.&nbsp;"
 msgstr ""
-"\n"
-"                        This AK beginnt in %(featured_slot_remaining)s "
-"Minute(n) in %(room)s.&nbsp;\n"
+"Dieser AK beginnt in <span v-"
+"html=\"timeUntilStart\">%(featured_slot_remaining)s</span> Minute(n) in "
+"%(room)s.&nbsp;\n"
 "                    "
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:149
-#: AKSubmission/templates/AKSubmission/ak_detail.html:277
+#: AKSubmission/templates/AKSubmission/ak_detail.html:195
+#: AKSubmission/templates/AKSubmission/ak_detail.html:342
 msgid "Go to virtual room"
 msgstr "Zum virtuellen Raum"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:158
+#: AKSubmission/templates/AKSubmission/ak_detail.html:206
 #: AKSubmission/templates/AKSubmission/ak_table.html:10
 msgid "Who?"
 msgstr "Wer?"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:164
+#: AKSubmission/templates/AKSubmission/ak_detail.html:212
 #: AKSubmission/templates/AKSubmission/ak_history.html:36
 #: AKSubmission/templates/AKSubmission/ak_table.html:11
 msgid "Category"
 msgstr "Kategorie"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:171
+#: AKSubmission/templates/AKSubmission/ak_detail.html:219
+#: AKSubmission/templates/AKSubmission/ak_list.html:24
+#: AKSubmission/templates/AKSubmission/ak_table.html:13
+msgid "Types"
+msgstr "Typen"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:229
 #: AKSubmission/templates/AKSubmission/ak_history.html:37
 msgid "Track"
 msgstr "Track"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:177
-#, fuzzy
-#| msgid "Present results of this AK"
+#: AKSubmission/templates/AKSubmission/ak_detail.html:235
 msgid "Present this AK"
-msgstr "Die Ergebnisse dieses AKs vorstellen"
+msgstr "Diesen AK vorstellen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:182
+#: AKSubmission/templates/AKSubmission/ak_detail.html:241
 msgid "(Category Default)"
 msgstr "(Kategorievoreinstellung)"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:188
+#: AKSubmission/templates/AKSubmission/ak_detail.html:247
 msgid "Reso intention?"
 msgstr "Resoabsicht?"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:195
+#: AKSubmission/templates/AKSubmission/ak_detail.html:254
 msgid "Requirements"
 msgstr "Anforderungen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:208
+#: AKSubmission/templates/AKSubmission/ak_detail.html:267
 msgid "Conflicting AKs"
 msgstr "AK-Konflikte"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:216
+#: AKSubmission/templates/AKSubmission/ak_detail.html:275
 msgid "Prerequisite AKs"
 msgstr "Vorausgesetzte AKs"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:224
+#: AKSubmission/templates/AKSubmission/ak_detail.html:283
 msgid "Notes"
 msgstr "Notizen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:237
+#: AKSubmission/templates/AKSubmission/ak_detail.html:290
+msgid "Brief Description:"
+msgstr "Kurzbeschreibung:"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:291
+msgid "Design/Goal:"
+msgstr "Art/Ziel:"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:293
+msgid "Further Info:"
+msgstr "Weitere Infos:"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:302
 msgid "When?"
 msgstr "Wann?"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:272
+#: AKSubmission/templates/AKSubmission/ak_detail.html:304
+#: AKSubmission/templates/AKSubmission/akslot_delete.html:35
+msgid "Duration"
+msgstr "Dauer"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:306
+msgid "Room"
+msgstr "Raum"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:337
 msgid "Delete"
 msgstr "Löschen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:283
+#: AKSubmission/templates/AKSubmission/ak_detail.html:348
 msgid "Schedule"
 msgstr "Schedule"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:295
+#: AKSubmission/templates/AKSubmission/ak_detail.html:360
 msgid "Add another slot"
 msgstr "Einen neuen AK-Slot hinzufügen"
 
-#: AKSubmission/templates/AKSubmission/ak_detail.html:305
+#: AKSubmission/templates/AKSubmission/ak_detail.html:370
 msgid "Possible Times"
 msgstr "Mögliche Zeiten"
 
+#: AKSubmission/templates/AKSubmission/ak_detail.html:374
+msgid "Start"
+msgstr "Start"
+
+#: AKSubmission/templates/AKSubmission/ak_detail.html:375
+msgid "End"
+msgstr "Ende"
+
 #: AKSubmission/templates/AKSubmission/ak_edit.html:8
 #: AKSubmission/templates/AKSubmission/ak_history.html:11
 #: AKSubmission/templates/AKSubmission/ak_overview.html:8
@@ -242,7 +245,7 @@ msgstr "Mögliche Zeiten"
 #: AKSubmission/templates/AKSubmission/akslot_delete.html:7
 #: AKSubmission/templates/AKSubmission/submission_not_configured.html:7
 #: AKSubmission/templates/AKSubmission/submission_overview.html:7
-#: AKSubmission/templates/AKSubmission/submission_overview.html:40
+#: AKSubmission/templates/AKSubmission/submission_overview.html:44
 #: AKSubmission/templates/AKSubmission/submit_new.html:9
 #: AKSubmission/templates/AKSubmission/submit_new_wish.html:7
 msgid "AKs"
@@ -260,6 +263,11 @@ msgstr ""
 "Person hinzufügen, die noch nicht in der Liste ist. Ungespeicherte "
 "Änderungen in diesem Formular gehen verloren."
 
+#: AKSubmission/templates/AKSubmission/ak_history.html:11
+#: AKSubmission/templates/AKSubmission/akslot_delete.html:31
+msgid "AK"
+msgstr "AK"
+
 #: AKSubmission/templates/AKSubmission/ak_history.html:27
 msgid "Back"
 msgstr "Zurück"
@@ -274,16 +282,16 @@ msgid "Time"
 msgstr "Zeit"
 
 #: AKSubmission/templates/AKSubmission/ak_history.html:48
-#: AKSubmission/templates/AKSubmission/ak_table.html:25
+#: AKSubmission/templates/AKSubmission/ak_table.html:28
 msgid "Present results of this AK"
 msgstr "Die Ergebnisse dieses AKs vorstellen"
 
 #: AKSubmission/templates/AKSubmission/ak_history.html:52
-#: AKSubmission/templates/AKSubmission/ak_table.html:29
+#: AKSubmission/templates/AKSubmission/ak_table.html:32
 msgid "Intends to submit a resolution"
 msgstr "Beabsichtigt eine Resolution einzureichen"
 
-#: AKSubmission/templates/AKSubmission/ak_list.html:6 AKSubmission/views.py:42
+#: AKSubmission/templates/AKSubmission/ak_list.html:6 AKSubmission/views.py:82
 msgid "All AKs"
 msgstr "Alle AKs"
 
@@ -299,11 +307,12 @@ msgstr "AK-Liste"
 msgid "Add AK"
 msgstr "AK hinzufügen"
 
-#: AKSubmission/templates/AKSubmission/ak_table.html:42
+#: AKSubmission/templates/AKSubmission/ak_table.html:52
+#: AKSubmission/templates/AKSubmission/ak_table.html:77
 msgid "Details"
 msgstr "Details"
 
-#: AKSubmission/templates/AKSubmission/ak_table.html:66
+#: AKSubmission/templates/AKSubmission/ak_table.html:88
 msgid "There are no AKs in this category yet"
 msgstr "Es gibt noch keine AKs in dieser Kategorie"
 
@@ -314,7 +323,7 @@ msgstr "Senden"
 #: AKSubmission/templates/AKSubmission/akmessage_add.html:31
 #: AKSubmission/templates/AKSubmission/akowner_create_update.html:26
 #: AKSubmission/templates/AKSubmission/akslot_add_update.html:29
-#: AKSubmission/templates/AKSubmission/submit_new.html:52
+#: AKSubmission/templates/AKSubmission/submit_new.html:63
 msgid "Reset Form"
 msgstr "Formular leeren"
 
@@ -322,7 +331,7 @@ msgstr "Formular leeren"
 #: AKSubmission/templates/AKSubmission/akowner_create_update.html:30
 #: AKSubmission/templates/AKSubmission/akslot_add_update.html:33
 #: AKSubmission/templates/AKSubmission/akslot_delete.html:45
-#: AKSubmission/templates/AKSubmission/submit_new.html:56
+#: AKSubmission/templates/AKSubmission/submit_new.html:67
 msgid "Cancel"
 msgstr "Abbrechen"
 
@@ -366,129 +375,153 @@ msgstr ""
 "Das System ist bisher nicht für Eintragen und Anzeige von AKs konfiguriert. "
 "Bitte versuche es später wieder."
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:44
+#: AKSubmission/templates/AKSubmission/submission_overview.html:48
 msgid ""
 "On this page you can see a list of current AKs, change them and add new ones."
 msgstr ""
 "Auf dieser Seite kannst du eine Liste von aktuellen AKs sehen, diese "
 "bearbeiten und neue hinzufügen."
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:52
+#: AKSubmission/templates/AKSubmission/submission_overview.html:56
 #: AKSubmission/templates/AKSubmission/submit_new_wish.html:7
 #: AKSubmission/templates/AKSubmission/submit_new_wish.html:14
 #: AKSubmission/templates/AKSubmission/submit_new_wish.html:18
 msgid "New AK Wish"
 msgstr "Neuer AK-Wunsch"
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:56
+#: AKSubmission/templates/AKSubmission/submission_overview.html:60
 msgid "Who"
 msgstr "Wer"
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:59
+#: AKSubmission/templates/AKSubmission/submission_overview.html:63
 msgid "I do not own AKs yet"
 msgstr "Ich leite bisher keine AKs"
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:67
+#: AKSubmission/templates/AKSubmission/submission_overview.html:71
 #: AKSubmission/templates/AKSubmission/submit_new.html:9
-#: AKSubmission/templates/AKSubmission/submit_new.html:34
-#: AKSubmission/templates/AKSubmission/submit_new.html:41
+#: AKSubmission/templates/AKSubmission/submit_new.html:42
+#: AKSubmission/templates/AKSubmission/submit_new.html:49
 msgid "New AK"
 msgstr "Neuer AK"
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:73
+#: AKSubmission/templates/AKSubmission/submission_overview.html:77
 msgid "Edit Person Info"
 msgstr "Personen-Info bearbeiten"
 
-#: AKSubmission/templates/AKSubmission/submission_overview.html:81
+#: AKSubmission/templates/AKSubmission/submission_overview.html:85
 msgid "This event is not active. You cannot add or change AKs"
 msgstr ""
 "Dieses Event is nicht aktiv. Es können keine AKs hinzugefügt oder bearbeitet "
 "werden"
 
-#: AKSubmission/templates/AKSubmission/submit_new.html:48
+#: AKSubmission/templates/AKSubmission/submit_new.html:30
+msgid ""
+"This is used for presentation slides among other things, and will be "
+"truncated to 200 characters for that purpose."
+msgstr ""
+"Dieses Feld wird unter anderen für Präsentationsfolien verwendet und zu "
+"diesem Zweck auf 200 Zeichen limitiert."
+
+#: AKSubmission/templates/AKSubmission/submit_new.html:59
 msgid "Submit"
 msgstr "Eintragen"
 
-#: AKSubmission/views.py:73
+#: AKSubmission/templates/AKSubmission/submit_new.html:77
+msgid "Continue with that name?"
+msgstr "Mit dem Namen fortfahren?"
+
+#: AKSubmission/templates/AKSubmission/submit_new.html:81
+
+msgid ""
+"Your AK name (or short name) starts with or contains the word \"AK\"."
+"<br><br>This is not recommended, as it makes the names longer, and may "
+"create an inconsistent style. The tool will ensure that one always know that "
+"a title belongs to an AK even without that prefix.<br><br>Do you still want "
+"to use that name?"
+msgstr ""
+" Der Name (oder Kurzname) des AKs beginnt mit dem Wort "
+"\"AK\" oder enthält es.<br><br>"
+"Das ist nicht empfohlen, weil es den Namen länger macht "
+"und zu einem inkonsistenten Stil führen kann."
+"Das AK-Tool wird dafür sorgen, dass man immer weiß, dass "
+"der Titel zu einem AK gehört, auch ohne diesen Prefix.<br><br>"
+"Möchtest du den Namen trotzdem verwenden?"
+
+#: AKSubmission/templates/AKSubmission/submit_new.html:85
+msgid "Change name"
+msgstr "Namen ändern"
+
+#: AKSubmission/templates/AKSubmission/submit_new.html:87
+msgid "Proceed with saving"
+msgstr "Mit dem Speichern fortfahren"
+
+#: AKSubmission/views.py:125
 msgid "Wishes"
 msgstr "Wünsche"
 
-#: AKSubmission/views.py:73
+#: AKSubmission/views.py:125
 msgid "AKs one would like to have"
 msgstr ""
 "AKs die sich gewünscht wurden, aber bei denen noch nicht klar ist, wer sie "
 "macht. Falls du dir das vorstellen kannst, trag dich einfach ein"
 
-#: AKSubmission/views.py:93
+#: AKSubmission/views.py:167
 msgid "Currently planned AKs"
 msgstr "Aktuell geplante AKs"
 
-#: AKSubmission/views.py:186
+#: AKSubmission/views.py:337
 msgid "Event inactive. Cannot create or update."
 msgstr "Event inaktiv. Hinzufügen/Bearbeiten nicht möglich."
 
-#: AKSubmission/views.py:202
+#: AKSubmission/views.py:362
 msgid "AK successfully created"
 msgstr "AK erfolgreich angelegt"
 
-#: AKSubmission/views.py:252
+#: AKSubmission/views.py:436
 msgid "AK successfully updated"
 msgstr "AK erfolgreich aktualisiert"
 
-#: AKSubmission/views.py:290
+#: AKSubmission/views.py:487
 #, python-brace-format
 msgid "Added '{owner}' as new owner of '{ak.name}'"
 msgstr "'{owner}' als neue Leitung von '{ak.name}' hinzugefügt"
 
-#: AKSubmission/views.py:333
-msgid "Person Info successfully updated"
-msgstr "Personen-Info erfolgreich aktualisiert"
-
-#: AKSubmission/views.py:355
+#: AKSubmission/views.py:590
 msgid "No user selected"
 msgstr "Keine Person ausgewählt"
 
-#: AKSubmission/views.py:382
+#: AKSubmission/views.py:606
+msgid "Person Info successfully updated"
+msgstr "Personen-Info erfolgreich aktualisiert"
+
+#: AKSubmission/views.py:642
 msgid "AK Slot successfully added"
 msgstr "AK-Slot erfolgreich angelegt"
 
-#: AKSubmission/views.py:395
+#: AKSubmission/views.py:661
 msgid "You cannot edit a slot that has already been scheduled"
 msgstr "Bereits geplante AK-Slots können nicht mehr bearbeitet werden"
 
-#: AKSubmission/views.py:405
+#: AKSubmission/views.py:671
 msgid "AK Slot successfully updated"
 msgstr "AK-Slot erfolgreich aktualisiert"
 
-#: AKSubmission/views.py:417
+#: AKSubmission/views.py:689
 msgid "You cannot delete a slot that has already been scheduled"
 msgstr "Bereits geplante AK-Slots können nicht mehr gelöscht werden"
 
-#: AKSubmission/views.py:427
+#: AKSubmission/views.py:699
 msgid "AK Slot successfully deleted"
 msgstr "AK-Slot erfolgreich angelegt"
 
-#: AKSubmission/views.py:434
+#: AKSubmission/views.py:711
 msgid "Messages"
 msgstr "Nachrichten"
 
-#: AKSubmission/views.py:444
+#: AKSubmission/views.py:721
 msgid "Delete all messages"
 msgstr "Alle Nachrichten löschen"
 
-#: AKSubmission/views.py:467
+#: AKSubmission/views.py:748
 msgid "Message to organizers successfully saved"
 msgstr "Nachricht an die Organisator*innen erfolgreich gespeichert"
-
-#~ msgid ""
-#~ "Due to technical reasons, the link you entered was truncated to a length "
-#~ "of 200 characters"
-#~ msgstr ""
-#~ "Aus technischen Gründen wurde der eingegebeneLink auf eine Länge von 200 "
-#~ "Zeichen gekürzt"
-
-#~ msgid "Interest saved"
-#~ msgstr "Interesse gespeichert"
-
-#~ msgid "Present AK results"
-#~ msgstr "AK-Ergebnisse vorstellen"

AKSubmission/models.py

@@ -3,14 +3,15 @@ from django.conf import settings
 from django.core.mail import EmailMessage
 from django.db.models.signals import post_save
 from django.dispatch import receiver
-from django.urls import reverse_lazy
 
 from AKModel.models import AKOrgaMessage, AKSlot
 
 
 @receiver(post_save, sender=AKOrgaMessage)
-def orga_message_saved_handler(sender, instance: AKOrgaMessage, created, **kwargs):
-    # React to newly created Orga message by sending an email
+def orga_message_saved_handler(sender, instance: AKOrgaMessage, created, **kwargs): # pylint: disable=unused-argument
+    """
+    React to newly created Orga message by sending an email
+    """
 
     if created and settings.SEND_MAILS:
         host = 'https://' + settings.ALLOWED_HOSTS[0] if len(settings.ALLOWED_HOSTS) > 0 else 'http://127.0.0.1:8000'
@@ -26,10 +27,12 @@ def orga_message_saved_handler(sender, instance: AKOrgaMessage, created, **kwarg
 
 
 @receiver(post_save, sender=AKSlot)
-def slot_created_handler(sender, instance: AKSlot, created, **kwargs):
-    # React to slots that are created after the plan was already published by sending an email
-
-    if created and settings.SEND_MAILS and apps.is_installed("AKPlan") and not instance.event.plan_hidden and instance.room is None and instance.start is None:
+def slot_created_handler(sender, instance: AKSlot, created, **kwargs): # pylint: disable=unused-argument
+    """
+    React to slots that are created after the plan was already published by sending an email
+    """
+    if created and settings.SEND_MAILS and apps.is_installed("AKPlan") \
+            and not instance.event.plan_hidden and instance.room is None and instance.start is None: # pylint: disable=too-many-boolean-expressions,line-too-long
         host = 'https://' + settings.ALLOWED_HOSTS[0] if len(settings.ALLOWED_HOSTS) > 0 else 'http://127.0.0.1:8000'
         url = f"{host}{instance.ak.detail_url}"
 

AKSubmission/templates/AKSubmission/ak_detail.html

@@ -27,6 +27,55 @@
     {% block imports %}
         {% include "AKPlan/plan_akslot.html" %}
 
+        <script type="module">
+            const {createApp} = Vue
+
+            function getCurrentTimestamp() {
+                return Date.now() / 1000
+            }
+
+            createApp({
+                delimiters: ["[[", "]]"],
+                data() {
+                    return {
+                        featuredSlot: "{% if featured_slot %}true{% else %}false{% endif %}",
+                        timer: null,
+                        now: getCurrentTimestamp(),
+                        akStart: "{{ featured_slot.start | date:'U' }}",
+                        akEnd: "{{ featured_slot.end | date:'U' }}",
+                        showBoxWithoutJS: false,
+                    }
+                },
+                computed: {
+                    showFeatured() {
+                        return this.featuredSlot && this.now < this.akEnd
+                    },
+                    isBefore() {
+                        return this.featuredSlot && this.now < this.akStart
+                    },
+                    isDuring() {
+                        return this.featuredSlot && this.akStart < this.now && this.now < this.akEnd
+                    },
+                    timeUntilStart() {
+                        return Math.ceil((this.akStart - this.now) / 60)
+                    },
+                    timeUntilEnd() {
+                        return Math.floor((this.akEnd - this.now) / 60)
+                    }
+                },
+                mounted: function () {
+                    if (this.featuredSlot) {
+                        this.timer = setInterval(() => {
+                            this.now = getCurrentTimestamp()
+                        }, 10000)
+                    }
+                },
+                beforeUnmount() {
+                    clearInterval(this.timer)
+                }
+            }).mount('#app')
+        </script>
+
         <script>
             document.addEventListener('DOMContentLoaded', function () {
                 // CSRF Protection/Authentication
@@ -65,8 +114,7 @@
                     $.ajax({
                         url: "{% url "model:AK-list" event_slug=event.slug %}" + ak_id + "/indicate-interest/",
                         type: 'POST',
-                            data: {
-                            },
+                        data: {},
                         success: function (response) {
                             btn.html('{% fa6_icon 'check' 'fas' %}');
                             btn.off('click');
@@ -128,21 +176,23 @@
 
     <h2>{% if ak.wish %}{% trans "AK Wish" %}: {% endif %}{{ ak.name }}</h2>
 
+    <div id="app">
         {# Show current or upcoming slot featured in a box on top of the plage #}
         {% if featured_slot_type != "NONE" %}
-        <div class="card border-success mt-3 mb-3">
+            <div class="card border-success mt-3 mb-3" v-show="showFeatured">
                 <div class="card-body font-weight-bold">
-                {% if featured_slot_type == "CURRENT" %}
-                    {% blocktrans with room=featured_slot.room %}
-                        This AK currently takes place for another {{ featured_slot_remaining }} minute(s) in {{ room }}.
-                        &nbsp;
-                    {% endblocktrans %}
-
-                {% elif featured_slot_type == "UPCOMING" %}
-                    {% blocktrans with room=featured_slot.room %}
-                        This AK starts in {{ featured_slot_remaining }} minute(s) in {{ room }}.&nbsp;
-                    {% endblocktrans %}
-                {% endif %}
+                    <span v-show="isDuring"
+                          style="{% if not featured_slot_type == "CURRENT" %}display:none;{% endif %}">
+                        {% blocktrans with room=featured_slot.room %}This AK currently takes place for another
+                            <span v-html="timeUntilEnd">{{ featured_slot_remaining }}</span> minute(s) in {{ room }}.
+                            &nbsp;{% endblocktrans %}
+                    </span>
+                    <span v-show="isBefore"
+                          style="{% if not featured_slot_type == "UPCOMING" %}display:none;{% endif %}">
+                        {% blocktrans with room=featured_slot.room %}This AK starts in
+                            <span v-html="timeUntilStart">{{ featured_slot_remaining }}</span> minute(s) in {{ room }}.
+                            &nbsp;{% endblocktrans %}
+                    </span>
 
                     {% if "AKOnline"|check_app_installed and featured_slot.room.virtual and featured_slot.room.virtual.url != '' %}
                         <a class="btn btn-success" target="_parent" href="{{ featured_slot.room.virtual.url }}">
@@ -152,6 +202,8 @@
                 </div>
             </div>
         {% endif %}
+    </div>
+
 
     <table class="table table-borderless">
         <tr>
@@ -166,6 +218,16 @@
                 {% category_linked_badge ak.category ak.event.slug %}
             </td>
         </tr>
+        {% if ak.types.count > 0 %}
+            <tr>
+                <td>{% trans "Types" %}</td>
+                <td>
+                    {% for type in ak.types.all %}
+                        <span class="badge bg-info">{{ type }}</span>
+                    {% endfor %}
+                </td>
+            </tr>
+        {% endif %}
         {% if ak.track %}
             <tr>
                 <td>{% trans 'Track' %}</td>
@@ -179,7 +241,8 @@
                     {% if ak.present != None %}
                         {{ ak.present | bool_symbol }}
                     {% else %}
-                        {{ ak.category.present_by_default | bool_symbol }} <span class="text-muted">{% trans "(Category Default)" %}</span>
+                        {{ ak.category.present_by_default | bool_symbol }}
+                        <span class="text-muted">{% trans "(Category Default)" %}</span>
                     {% endif %}
                 </td>
             </tr>
@@ -227,7 +290,13 @@
         {% endif %}
     </table>
 
-    <p style="margin-top: 30px;margin-bottom: 30px;">{{ ak.description|linebreaks }}</p>
+    <div class="mt-4 mb-4">
+        <p><strong>{% trans "Brief Description:" %}</strong>{{ ak.description|linebreaks }}</p>
+        <p><strong>{% trans "Design/Goal:" %}</strong>{{ ak.goal|linebreaks }}</p>
+        {% if ak.info %}
+            <p><strong>{% trans "Further Info:" %}</strong>{{ ak.info|linebreaks }}</p>
+        {% endif %}
+    </div>
 
     {% if not ak.wish %}
         <table class="table">

AKSubmission/templates/AKSubmission/ak_list.html

@@ -18,6 +18,19 @@
                 </div>
             </li>
         {% endif %}
+        {% if show_types %}
+            <li class="nav-item dropdown">
+                <a class="nav-link dropdown-toggle" data-bs-toggle="dropdown" href="#" role="button" aria-haspopup="true"
+                   aria-expanded="false">{% trans "Types" %}</a>
+                <div class="dropdown-menu" style="">
+                    {% for type in event.aktype_set.all %}
+                        <a class="dropdown-item"
+                           href="{% url 'submit:ak_list_by_type' event_slug=event.slug type_slug=type.slug %}">
+                            {{ type }}</a>
+                    {% endfor %}
+                </div>
+            </li>
+        {% endif %}
     </ul>
 </div>
 

AKSubmission/templates/AKSubmission/ak_table.html

@@ -9,6 +9,9 @@
         <th>{% trans "Name" %}</th>
         <th>{% trans "Who?" %}</th>
         <th>{% trans 'Category' %}</th>
+        {% if show_types %}
+            <th>{% trans 'Types' %}</th>
+        {% endif %}
         <th></th>
     </tr>
     </thead>
@@ -37,6 +40,13 @@
                 {% endif %}
             </td>
             <td>{% category_linked_badge ak.category event.slug %}</td>
+            {% if show_types %}
+                <td>
+                    {% for aktype in ak.types.all %}
+                        {% type_linked_badge aktype event.slug %}
+                    {% endfor %}
+                </td>
+            {% endif %}
             <td class="text-end" style="white-space: nowrap;">
                 <a href="{{ ak.detail_url }}" data-bs-toggle="tooltip"
                    title="{% trans 'Details' %}"
@@ -53,13 +63,25 @@
                     {% if interest_indication_active %}
                         <span data-ak_id="{{ ak.pk }}" data-bs-toggle="tooltip"
                               title="{% trans 'Show Interest' %}"
-                           class="btn btn-primary btn-interest" style="cursor: pointer">{% fa6_icon 'thumbs-up' 'fas' %}</span>
+                              class="btn btn-primary btn-interest"
+                              style="cursor: pointer">{% fa6_icon 'thumbs-up' 'fas' %}</span>
                     {% endif %}
                 {% endif %}
             </td>
         </tr>
         <tr>
-            <td colspan="5" class="small">{{ ak.description|linebreaks }}</td>
+        <tr>
+            <td colspan="5" class="small">
+                <div class="d-block d-md-none">
+                    <details>
+                        <summary>{% trans "Details" %}</summary>
+                        {{ ak.description|linebreaks }}
+                    </details>
+                </div>
+                <div class="d-none d-md-block">
+                    {{ ak.description|linebreaks }}
+                </div>
+            </td>
         </tr>
     {% empty %}
         <tr>

AKSubmission/templates/AKSubmission/submission_overview.html

@@ -26,6 +26,10 @@
         .select2-selection {
           height: 34px !important;
         }
+
+        .select2-container {
+            width: 300px!important;
+        }
     </style>
 
     {% include "AKSubmission/ak_interest_script.html" %}

AKSubmission/templates/AKSubmission/submit_new.html

@@ -23,6 +23,14 @@
             );
         });
     </script>
+
+
+    <style>
+        #id_description_helptext::after {
+            content: " ({% trans "This is used for presentation slides among other things, and will be truncated to 200 characters for that purpose." %})";
+            color: #6c757d;
+        }
+    </style>
 {% endblock %}
 
 {% block breadcrumbs %}
@@ -40,9 +48,12 @@
     {% block headline %}
         <h2>{% trans 'New AK' %}</h2>
     {% endblock %}
-    <form method="POST" class="post-form">{% csrf_token %}
+    <div id="app">
+        <form method="POST" class="post-form" id="formAK" @submit.prevent="handleSubmit">{% csrf_token %}
             {% block form_contents %}
-            {% bootstrap_form form %}
+                {#  Generate form, but make sure availabilities are always at the bottom #}
+                {% bootstrap_form form exclude='availabilities' %}
+                {% bootstrap_field form.availabilities form_group_class="" %}
             {% endblock %}
             <button type="submit" class="save btn btn-primary float-end">
                 {% fa6_icon "check" 'fas' %} {% trans "Submit" %}
@@ -56,6 +67,32 @@
                 {% fa6_icon "times" 'fas' %} {% trans "Cancel" %}
             </a>
         </form>
+
+        {# Modal for confirmation #}
+        <div class="modal fade" id="akWarningModal" tabindex="-1" aria-labelledby="akWarningModalLabel"
+             aria-hidden="true">
+            <div class="modal-dialog">
+                <div class="modal-content">
+                    <div class="modal-header">
+                        <h5 class="modal-title" id="akWarningModalLabel">{% trans "Continue with that name?" %}</h5>
+                        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Schließen"></button>
+                    </div>
+                    <div class="modal-body">
+                        {% blocktrans %}Your AK name (or short name) starts with or contains the word "AK".<br><br>This
+                            is not recommended, as it makes the names longer, and may create an inconsistent style. The
+                            tool will ensure that one always know that a title belongs to an AK even without that
+                            prefix.<br><br>Do you still want to use that name?{% endblocktrans %}
+                    </div>
+                    <div class="modal-footer">
+                        <button type="button" class="btn btn-primary"
+                                data-bs-dismiss="modal">{% trans "Change name" %}</button>
+                        <button type="button" class="btn btn-warning"
+                                @click="proceedSubmit">{% trans "Proceed with saving" %}</button>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
 {% endblock %}
 
 {% block bottom_script %}

AKSubmission/templates/AKSubmission/type_linked_badge.html

+<a href="{% url 'submit:ak_list_by_type' event_slug=event_slug type_slug=type.slug %}">
+    <span class="badge bg-info">{{ type }}</span>
+</a>

AKSubmission/templatetags/tags_AKSubmission.py

@@ -6,6 +6,11 @@ register = template.Library()
 
 @register.filter
 def bool_symbol(bool_val):
+    """
+    Show a nice icon instead of the string true/false
+    :param bool_val: boolean value to iconify
+    :return: check or times icon depending on the value
+    """
     if bool_val:
         return fa6_icon("check", "fas")
     return fa6_icon("times", "fas")
@@ -13,14 +18,45 @@ def bool_symbol(bool_val):
 
 @register.inclusion_tag("AKSubmission/tracks_list.html")
 def track_list(tracks, event_slug):
+    """
+    Generate a clickable list of tracks (one badge per track) based upon the tracks_list template
+
+    :param tracks: tracks to consider
+    :param event_slug: slug of this event, required for link creation
+    :return: html fragment containing track links
+    """
     return {"tracks": tracks, "event_slug": event_slug}
 
 
 @register.inclusion_tag("AKSubmission/category_list.html")
 def category_list(categories, event_slug):
+    """
+    Generate a clickable list of categories (one badge per category) based upon the category_list template
+
+    :param categories: categories to consider
+    :param event_slug: slug of this event, required for link creation
+    :return: html fragment containing category links
+    """
     return {"categories": categories, "event_slug": event_slug}
 
 
 @register.inclusion_tag("AKSubmission/category_linked_badge.html")
 def category_linked_badge(category, event_slug):
+    """
+    Generate a clickable category badge based upon the category_linked_badge template
+    :param category: category to show/link
+    :param event_slug: slug of this event, required for link creation
+    :return: html fragment containing badge
+    """
     return {"category": category, "event_slug": event_slug}
+
+
+@register.inclusion_tag("AKSubmission/type_linked_badge.html")
+def type_linked_badge(ak_type, event_slug):
+    """
+    Generate a clickable type badge based upon the type_linked_badge template
+    :param ak_type: type to show/link
+    :param event_slug: slug of this event, required for link creation
+    :return: html fragment containing badge
+    """
+    return {"type": ak_type, "event_slug": event_slug}

AKSubmission/tests.py

-from datetime import timedelta
+from datetime import datetime, timedelta
 
 from django.test import TestCase
 from django.urls import reverse_lazy
-from django.utils.datetime_safe import datetime
 
 from AKModel.models import AK, AKSlot, Event
-from AKModel.tests import BasicViewTests
+from AKModel.tests.test_views import BasicViewTests
+from AKSubmission.forms import AKSubmissionForm
 
 
 class ModelViewTests(BasicViewTests, TestCase):
+    """
+    Testcases for AKSubmission app.
+
+    This extends :class:`BasicViewTests` for standard view and edit testcases
+    that are specified in this class as VIEWS and EDIT_TESTCASES.
+
+    Additionally several additional testcases, in particular to test the API
+    and the dispatching for owner selection and editing are specified.
+    """
     fixtures = ['model.json']
 
     VIEWS = [
@@ -47,24 +56,27 @@ class ModelViewTests(BasicViewTests, TestCase):
         """
         self.client.logout()
 
-        view_name_with_prefix, url = self._name_and_url(('akslot_edit', {'event_slug': 'kif42', 'pk': 1}))
+        _, url = self._name_and_url(('akslot_edit', {'event_slug': 'kif42', 'pk': 1}))
         response = self.client.get(url)
         self.assertEqual(response.status_code, 302,
                          msg=f"AK Slot editing ({url}) possible even though slot was already scheduled")
         self._assert_message(response, "You cannot edit a slot that has already been scheduled")
 
-        view_name_with_prefix, url = self._name_and_url(('akslot_delete', {'event_slug': 'kif42', 'pk': 1}))
+        _, url = self._name_and_url(('akslot_delete', {'event_slug': 'kif42', 'pk': 1}))
         response = self.client.get(url)
         self.assertEqual(response.status_code, 302,
                          msg=f"AK Slot deletion ({url}) possible even though slot was already scheduled")
         self._assert_message(response, "You cannot delete a slot that has already been scheduled")
 
     def test_slot_creation_deletion(self):
+        """
+        Test creation and deletion of slots in frontend
+        """
         ak_args = {'event_slug': 'kif42', 'pk': 1}
         redirect_url = reverse_lazy(f"{self.APP_NAME}:ak_detail", kwargs=ak_args)
 
+        # Create a valid slot -> Redirect to AK detail page, message to user
         count_slots = AK.objects.get(pk=1).akslot_set.count()
-
         create_url = reverse_lazy(f"{self.APP_NAME}:akslot_add", kwargs=ak_args)
         response = self.client.post(create_url, {'ak': 1, 'event': 2, 'duration': 1.5})
         self.assertRedirects(response, redirect_url, status_code=302, target_status_code=200,
@@ -75,6 +87,8 @@ class ModelViewTests(BasicViewTests, TestCase):
         # Get primary key of newly created Slot
         slot_pk = AK.objects.get(pk=1).akslot_set.order_by('pk').last().pk
 
+        # Edit the recently created slot: Make sure view is accessible, post change
+        # -> redirect to detail page, duration updated
         edit_url = reverse_lazy(f"{self.APP_NAME}:akslot_edit", kwargs={'event_slug': 'kif42', 'pk': slot_pk})
         response = self.client.get(edit_url)
         self.assertEqual(response.status_code, 200, msg=f"Cant open edit view for newly created slot ({edit_url})")
@@ -84,6 +98,8 @@ class ModelViewTests(BasicViewTests, TestCase):
         self.assertEqual(AKSlot.objects.get(pk=slot_pk).duration, 2,
                          msg="Slot was not correctly changed")
 
+        # Delete recently created slot: Make sure view is accessible, post deletion
+        # -> redirect to detail page, slot deleted, message to user
         deletion_url = reverse_lazy(f"{self.APP_NAME}:akslot_delete", kwargs={'event_slug': 'kif42', 'pk': slot_pk})
         response = self.client.get(deletion_url)
         self.assertEqual(response.status_code, 200,
@@ -95,55 +111,78 @@ class ModelViewTests(BasicViewTests, TestCase):
         self.assertEqual(AK.objects.get(pk=1).akslot_set.count(), count_slots, msg="AK still has to many slots")
 
     def test_ak_owner_editing(self):
-        # Test editing of new user
+        """
+        Test dispatch of user editing requests
+        """
         edit_url = reverse_lazy(f"{self.APP_NAME}:akowner_edit_dispatch", kwargs={'event_slug': 'kif42'})
 
         base_url = reverse_lazy(f"{self.APP_NAME}:submission_overview", kwargs={'event_slug': 'kif42'})
+
+        # Empty form/no user selected -> start page
         response = self.client.post(edit_url, {'owner_id': -1})
         self.assertRedirects(response, base_url, status_code=302, target_status_code=200,
                              msg_prefix="Did not redirect to start page even though no user was selected")
         self._assert_message(response, "No user selected")
 
+        # Correct selection -> user edit page for that user
         edit_redirect_url = reverse_lazy(f"{self.APP_NAME}:akowner_edit", kwargs={'event_slug': 'kif42', 'slug': 'a'})
         response = self.client.post(edit_url, {'owner_id': 1})
         self.assertRedirects(response, edit_redirect_url, status_code=302, target_status_code=200,
                              msg_prefix=f"Dispatch redirect failed (should go to {edit_redirect_url})")
 
     def test_ak_owner_selection(self):
+        """
+        Test dispatch of owner selection requests
+        """
         select_url = reverse_lazy(f"{self.APP_NAME}:akowner_select", kwargs={'event_slug': 'kif42'})
-
         create_url = reverse_lazy(f"{self.APP_NAME}:akowner_create", kwargs={'event_slug': 'kif42'})
+
+        # Empty user selection -> create a new user view
         response = self.client.post(select_url, {'owner_id': -1})
         self.assertRedirects(response, create_url, status_code=302, target_status_code=200,
                              msg_prefix="Did not redirect to user create view even though no user was specified")
 
+        # Valid user selected -> redirect to view that allows to add a new AK with this user as owner
         add_redirect_url = reverse_lazy(f"{self.APP_NAME}:submit_ak", kwargs={'event_slug': 'kif42', 'owner_slug': 'a'})
         response = self.client.post(select_url, {'owner_id': 1})
         self.assertRedirects(response, add_redirect_url, status_code=302, target_status_code=200,
-                    msg_prefix=f"Dispatch redirect to ak submission page failed (should go to {add_redirect_url})")
+                             msg_prefix=f"Dispatch redirect to ak submission page failed "
+                                        f"(should go to {add_redirect_url})")
 
     def test_orga_message_submission(self):
+        """
+        Test submission and storing of direct confident messages to organizers
+        """
         form_url = reverse_lazy(f"{self.APP_NAME}:akmessage_add", kwargs={'event_slug': 'kif42', 'pk': 1})
         detail_url = reverse_lazy(f"{self.APP_NAME}:ak_detail", kwargs={'event_slug': 'kif42', 'pk': 1})
 
         count_messages = AK.objects.get(pk=1).akorgamessage_set.count()
 
+        # Test that submission view is accessible
         response = self.client.get(form_url)
         self.assertEqual(response.status_code, 200, msg="Could not load message form view")
+
+        # Test submission itself and the following redirect -> AK detail page
         response = self.client.post(form_url, {'ak': 1, 'event': 2, 'text': 'Test message text'})
         self.assertRedirects(response, detail_url, status_code=302, target_status_code=200,
                              msg_prefix=f"Did not trigger redirect to ak detail page ({detail_url})")
+
+        # Make sure message was correctly saved in database and user is notified about that
         self._assert_message(response, "Message to organizers successfully saved")
         self.assertEqual(AK.objects.get(pk=1).akorgamessage_set.count(), count_messages + 1,
                          msg="Message was not correctly saved")
 
     def test_interest_api(self):
+        """
+        Test interest indicating API (access, functionality)
+        """
         interest_api_url = "/kif42/api/ak/1/indicate-interest/"
 
         ak = AK.objects.get(pk=1)
         event = Event.objects.get(slug='kif42')
         ak_interest_counter = ak.interest_counter
 
+        # Check Access method (only POST)
         response = self.client.get(interest_api_url)
         self.assertEqual(response.status_code, 405, "Should not be accessible via GET")
 
@@ -151,6 +190,7 @@ class ModelViewTests(BasicViewTests, TestCase):
         event.interest_end = datetime.now().astimezone(event.timezone) + timedelta(minutes=+10)
         event.save()
 
+        # Test correct indication -> HTTP 200, counter increased
         response = self.client.post(interest_api_url)
         self.assertEqual(response.status_code, 200, f"API end point not working ({interest_api_url})")
         self.assertEqual(AK.objects.get(pk=1).interest_counter, ak_interest_counter + 1, "Counter was not increased")
@@ -158,31 +198,79 @@ class ModelViewTests(BasicViewTests, TestCase):
         event.interest_end = datetime.now().astimezone(event.timezone) + timedelta(minutes=-2)
         event.save()
 
+        # Test indication outside of indication window -> HTTP 403, counter not increased
         response = self.client.post(interest_api_url)
         self.assertEqual(response.status_code, 403,
-                    "API end point still reachable even though interest indication window ended ({interest_api_url})")
+                         "API end point still reachable even though interest indication window ended "
+                         "({interest_api_url})")
         self.assertEqual(AK.objects.get(pk=1).interest_counter, ak_interest_counter + 1,
                          "Counter was increased even though interest indication window ended")
 
+        # Test call for non-existing AK -> HTTP 403
         invalid_interest_api_url = "/kif42/api/ak/-1/indicate-interest/"
         response = self.client.post(invalid_interest_api_url)
         self.assertEqual(response.status_code, 404, f"Invalid URL reachable ({interest_api_url})")
 
     def test_adding_of_unknown_user(self):
+        """
+        Test adding of a previously not existing owner to an AK
+        """
+        # Pre-Check: AK detail page existing?
         detail_url = reverse_lazy(f"{self.APP_NAME}:ak_detail", kwargs={'event_slug': 'kif42', 'pk': 1})
         response = self.client.get(detail_url)
         self.assertEqual(response.status_code, 200, msg="Could not load ak detail view")
 
+        # Make sure AK detail page contains a link to add a new owner
         edit_url = reverse_lazy(f"{self.APP_NAME}:ak_edit", kwargs={'event_slug': 'kif42', 'pk': 1})
         response = self.client.get(edit_url)
         self.assertEqual(response.status_code, 200, msg="Could not load ak detail view")
         self.assertContains(response, "Add person not in the list yet",
                             msg_prefix="Link to add unknown user not contained")
 
+        # Check adding of a new owner by posting an according request
+        # -> Redirect to AK detail page, message to user, owners list updated
         self.assertEqual(AK.objects.get(pk=1).owners.count(), 1)
-        add_new_user_to_ak_url = reverse_lazy(f"{self.APP_NAME}:akowner_create", kwargs={'event_slug': 'kif42'}) + f"?add_to_existing_ak=1"
-        response = self.client.post(add_new_user_to_ak_url, {'name': 'New test owner', 'event': Event.get_by_slug('kif42').pk})
+        add_new_user_to_ak_url = reverse_lazy(f"{self.APP_NAME}:akowner_create", kwargs={'event_slug': 'kif42'}) \
+                                 + "?add_to_existing_ak=1"
+        response = self.client.post(add_new_user_to_ak_url,
+                                    {'name': 'New test owner', 'event': Event.get_by_slug('kif42').pk})
         self.assertRedirects(response, detail_url,
                              msg_prefix=f"No correct redirect: {add_new_user_to_ak_url} (POST) -> {detail_url}")
         self._assert_message(response, "Added 'New test owner' as new owner of 'Test AK Inhalt'")
         self.assertEqual(AK.objects.get(pk=1).owners.count(), 2)
+
+    def test_visibility_requirements_in_submission_form(self):
+        """
+        Test visibility of requirements field in submission form
+        """
+        event = Event.get_by_slug('kif42')
+        form = AKSubmissionForm(data={'name': 'Test AK', 'event': event}, instance=None, initial={"event": event})
+        self.assertIn('requirements', form.fields,
+                      msg="Requirements field not present in form even though event has requirements")
+
+        event2 = Event.objects.create(name='Event without requirements',
+                                      slug='no_req',
+                                      start=datetime.now().astimezone(event.timezone),
+                                      end=datetime.now().astimezone(event.timezone),
+                                      active=True)
+        form2 = AKSubmissionForm(data={'name': 'Test AK', 'event': event2}, instance=None, initial={"event": event2})
+        self.assertNotIn('requirements', form2.fields,
+                         msg="Requirements field should not be present for events without requirements")
+
+    def test_visibility_types_in_submission_form(self):
+        """
+        Test visibility of types field in submission form
+        """
+        event = Event.get_by_slug('kif42')
+        form = AKSubmissionForm(data={'name': 'Test AK', 'event': event}, instance=None, initial={"event": event})
+        self.assertIn('types', form.fields,
+                      msg="Requirements field not present in form even though event has requirements")
+
+        event2 = Event.objects.create(name='Event without types',
+                                      slug='no_types',
+                                      start=datetime.now().astimezone(event.timezone),
+                                      end=datetime.now().astimezone(event.timezone),
+                                      active=True)
+        form2 = AKSubmissionForm(data={'name': 'Test AK', 'event': event2}, instance=None, initial={"event": event2})
+        self.assertNotIn('types', form2.fields,
+                         msg="Requirements field should not be present for events without types")

AKSubmission/urls.py

@@ -19,6 +19,7 @@ urlpatterns = [
             path('aks/', views.AKOverviewView.as_view(), name='ak_list'),
             path('aks/category/<int:category_pk>/', views.AKListByCategoryView.as_view(), name='ak_list_by_category'),
             path('aks/track/<int:track_pk>/', views.AKListByTrackView.as_view(), name='ak_list_by_track'),
+            path('aks/type/<slug:type_slug>/', views.AKListByTypeView.as_view(), name='ak_list_by_type'),
             path('owner/', views.AKOwnerCreateView.as_view(), name='akowner_create'),
             path('new/', views.AKOwnerSelectDispatchView.as_view(), name='akowner_select'),
             path('owner/edit/', views.AKOwnerEditDispatchView.as_view(), name='akowner_edit_dispatch'),

AKSubmission/views.py

-from datetime import timedelta
+from abc import ABC, abstractmethod
+from datetime import datetime, timedelta
 from math import floor
 
 from django.apps import apps
@@ -7,43 +8,88 @@ from django.contrib import messages
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404, redirect
 from django.urls import reverse_lazy
-from django.utils.datetime_safe import datetime
 from django.utils.translation import gettext_lazy as _
 from django.views import View
-from django.views.generic import ListView, DetailView, CreateView, UpdateView, DeleteView, TemplateView
+from django.views.generic import CreateView, DeleteView, DetailView, ListView, TemplateView, UpdateView
 
 from AKModel.availability.models import Availability
 from AKModel.metaviews import status_manager
-from AKModel.metaviews.status import TemplateStatusWidget
-from AKModel.models import AK, AKCategory, AKOwner, AKSlot, AKTrack, AKOrgaMessage
 from AKModel.metaviews.admin import EventSlugMixin, FilterByEventSlugMixin
+from AKModel.metaviews.status import TemplateStatusWidget
+from AKModel.models import AK, AKCategory, AKOrgaMessage, AKOwner, AKSlot, AKTrack, AKType
 from AKSubmission.api import ak_interest_indication_active
-from AKSubmission.forms import AKWishForm, AKOwnerForm, AKSubmissionForm, AKDurationForm, AKOrgaMessageForm, \
-    AKForm
+from AKSubmission.forms import AKDurationForm, AKForm, AKOrgaMessageForm, AKOwnerForm, AKSubmissionForm, AKWishForm
 
 
 class SubmissionErrorNotConfiguredView(EventSlugMixin, TemplateView):
+    """
+    View to show when submission is not correctly configured yet for this event
+    and hence the submission component cannot be used already.
+    """
     template_name = "AKSubmission/submission_not_configured.html"
 
 
 class AKOverviewView(FilterByEventSlugMixin, ListView):
+    """
+    View: Show a tabbed list of AKs belonging to this event split by categories
+
+    Wishes show up in between of the other AKs in the category they belong to.
+    In contrast to :class:`SubmissionOverviewView` that inherits from this view,
+    on this view there is no form to add new AKs or edit owners.
+
+    Since the inherited version of this view will have a slightly different behaviour,
+    this view contains multiple methods that can be overriden for this adaption.
+    """
     model = AKCategory
     context_object_name = "categories"
     template_name = "AKSubmission/ak_overview.html"
     wishes_as_category = False
 
-    def filter_aks(self, context, category):
-        return category.ak_set.select_related('event').prefetch_related('owners').all()
+    def filter_aks(self, context, category):  # pylint: disable=unused-argument
+        """
+        Filter which AKs to display based on the given context and category
+
+        In the default case, all AKs of that category are returned (including wishes)
+
+        :param context: context of the view
+        :param category: category to filter the AK list for
+        :return: filtered list of AKs for the given category
+        :rtype: QuerySet[AK]
+        """
+        # Use prefetching and relation selection/joining to reduce the amount of necessary queries
+        return category.ak_set.select_related('event').prefetch_related('owners').prefetch_related('types').all()
 
     def get_active_category_name(self, context):
+        """
+        Get the category name to display by default/before further user interaction
+
+        In the default case, simply the first category (the one with the lowest ID for this event) is used
+
+        :param context: context of the view
+        :return: name of the default category
+        :rtype: str
+        """
         return context["categories_with_aks"][0][0].name
 
-    def get_table_title(self, context):
+    def get_table_title(self, context):  # pylint: disable=unused-argument
+        """
+        Specify the title above the AK list/table in this view
+
+        :param context: context of the view
+        :return: title to use
+        :rtype: str
+        """
         return _("All AKs")
 
     def get(self, request, *args, **kwargs):
+        """
+        Handle GET request
+
+        Overriden to allow checking for correct configuration and
+        redirect to error page if necessary (see :class:`SubmissionErrorNotConfiguredView`)
+        """
         self._load_event()
-        self.object_list = self.get_queryset()
+        self.object_list = self.get_queryset()  # pylint: disable=attribute-defined-outside-init
 
         # No categories yet? Redirect to configuration error page
         if self.object_list.count() == 0:
@@ -55,10 +101,16 @@ class AKOverviewView(FilterByEventSlugMixin, ListView):
     def get_context_data(self, *, object_list=None, **kwargs):
         context = super().get_context_data(object_list=object_list, **kwargs)
 
+        # ==========================================================
         # Sort AKs into different lists (by their category)
+        # ==========================================================
         ak_wishes = []
         categories_with_aks = []
 
+        # Loop over categories, load AKs (while filtering them if necessary) and create a list of (category, aks)-tuples
+        # Depending on the setting of self.wishes_as_category, wishes are either included
+        # or added to a special "Wish"-Category that is created on-the-fly to provide consistent handling in the
+        # template (without storing it in the database)
         for category in context["categories"]:
             aks_for_category = []
             for ak in self.filter_aks(context, category):
@@ -76,7 +128,11 @@ class AKOverviewView(FilterByEventSlugMixin, ListView):
         context["active_category"] = self.get_active_category_name(context)
         context['table_title'] = self.get_table_title(context)
 
+        context['show_types'] = self.event.aktype_set.count() > 0
+
+        # ==========================================================
         # Display interest indication button?
+        # ==========================================================
         current_timestamp = datetime.now().astimezone(self.event.timezone)
         context['interest_indication_active'] = ak_interest_indication_active(self.event, current_timestamp)
 
@@ -84,12 +140,30 @@ class AKOverviewView(FilterByEventSlugMixin, ListView):
 
 
 class SubmissionOverviewView(AKOverviewView):
+    """
+    View: List of AKs and possibility to add AKs or adapt owner information
+
+    Main/start view of the component.
+
+    This view inherits from :class:`AKOverviewView`, but treats wishes as separate category if requested in the settings
+    and handles the change actions mentioned above.
+    """
     model = AKCategory
     context_object_name = "categories"
     template_name = "AKSubmission/submission_overview.html"
+
+    # this mainly steers the different handling of wishes
+    # since the code for that is already included in the parent class
     wishes_as_category = settings.WISHES_AS_CATEGORY
 
     def get_table_title(self, context):
+        """
+        Specify the title above the AK list/table in this view
+
+        :param context: context of the view
+        :return: title to use
+        :rtype: str
+        """
         return _("Currently planned AKs")
 
     def get_context_data(self, *, object_list=None, **kwargs):
@@ -102,33 +176,108 @@ class SubmissionOverviewView(AKOverviewView):
 
 
 class AKListByCategoryView(AKOverviewView):
+    """
+    View: List of only the AKs belonging to a certain category.
+
+    This view inherits from :class:`AKOverviewView`, but produces only one list instead of a tabbed one.
+    """
+
     def dispatch(self, request, *args, **kwargs):
+        # Override dispatching
+        # Needed to handle the checking whether the category exists
+        # noinspection PyAttributeOutsideInit
+        # pylint: disable=attribute-defined-outside-init
         self.category = get_object_or_404(AKCategory, pk=kwargs['category_pk'])
         return super().dispatch(request, *args, **kwargs)
 
     def get_active_category_name(self, context):
+        """
+        Get the category name to display by default/before further user interaction
+
+        In this case, this will be the name of the category specified via pk
+
+        :param context: context of the view
+        :return: name of the category
+        :rtype: str
+        """
         return self.category.name
 
 
 class AKListByTrackView(AKOverviewView):
+    """
+    View: List of only the AKs belonging to a certain track.
+
+    This view inherits from :class:`AKOverviewView` and there will be one list per category
+    -- but only AKs of a certain given track will be included in them.
+    """
+
     def dispatch(self, request, *args, **kwargs):
-        self.track = get_object_or_404(AKTrack, pk=kwargs['track_pk'])
+        # Override dispatching
+        # Needed to handle the checking whether the track exists
+
+        self.track = get_object_or_404(AKTrack, pk=kwargs['track_pk'])  # pylint: disable=attribute-defined-outside-init
         return super().dispatch(request, *args, **kwargs)
 
     def filter_aks(self, context, category):
-        return category.ak_set.filter(track=self.track)
+        """
+        Filter which AKs to display based on the given context and category
+
+        In this case, the list is further restricted by the track
+
+        :param context: context of the view
+        :param category: category to filter the AK list for
+        :return: filtered list of AKs for the given category
+        :rtype: QuerySet[AK]
+        """
+        return super().filter_aks(context, category).filter(track=self.track)
 
     def get_table_title(self, context):
         return f"{_('AKs with Track')} = {self.track.name}"
 
 
+class AKListByTypeView(AKOverviewView):
+    """
+    View: List of only the AKs belonging to a certain type.
+
+    This view inherits from :class:`AKOverviewView` and there will be one list per category
+    -- but only AKs of a certain given type will be included in them.
+    """
+
+    def dispatch(self, request, *args, **kwargs):
+        # Override dispatching
+        # Needed to handle the checking whether the type exists
+
+        self.type = get_object_or_404(AKType, slug=kwargs['type_slug'])  # pylint: disable=attribute-defined-outside-init
+        return super().dispatch(request, *args, **kwargs)
+
+    def filter_aks(self, context, category):
+        """
+        Filter which AKs to display based on the given context and category
+
+        In this case, the list is further restricted by the type
+
+        :param context: context of the view
+        :param category: category to filter the AK list for
+        :return: filtered list of AKs for the given category
+        :rtype: QuerySet[AK]
+        """
+        return super().filter_aks(context, category).filter(types=self.type)
+
+    def get_table_title(self, context):
+        return f"{_('AKs with Type')} = {self.type.name}"
+
+
 class AKDetailView(EventSlugMixin, DetailView):
+    """
+    View: AK Details
+    """
     model = AK
     context_object_name = "ak"
     template_name = "AKSubmission/ak_detail.html"
 
     def get_queryset(self):
-        return super().get_queryset().select_related('event').prefetch_related('owners')
+        # Get information about the AK and do some query optimization
+        return super().get_queryset().select_related('event').prefetch_related('owners', 'akslot_set')
 
     def get_context_data(self, *, object_list=None, **kwargs):
         context = super().get_context_data(object_list=object_list, **kwargs)
@@ -163,29 +312,35 @@ class AKDetailView(EventSlugMixin, DetailView):
 
 
 class AKHistoryView(EventSlugMixin, DetailView):
+    """
+    View: Show history of a given AK
+    """
     model = AK
     context_object_name = "ak"
     template_name = "AKSubmission/ak_history.html"
 
 
-class AKListView(FilterByEventSlugMixin, ListView):
-    model = AK
-    context_object_name = "AKs"
-    template_name = "AKSubmission/ak_overview.html"
-    table_title = ""
-
-    def get_context_data(self, *, object_list=None, **kwargs):
-        context = super().get_context_data(object_list=object_list, **kwargs)
-        context['categories'] = AKCategory.objects.filter(event=self.event)
-        context['tracks'] = AKTrack.objects.filter(event=self.event)
-        return context
-
-
 class EventInactiveRedirectMixin:
+    """
+    Mixin that will cause a redirect when actions are performed on an inactive event.
+    Will add a message explaining why the action was not performed to the user
+    and then redirect to start page of the submission component
+    """
+
     def get_error_message(self):
+        """
+        Error message to display after redirect (can be adjusted by this method)
+
+        :return: error message
+        :rtype: str
+        """
         return _("Event inactive. Cannot create or update.")
 
     def get(self, request, *args, **kwargs):
+        """
+        Override GET request handling
+        Will either perform the redirect including the message creation or continue with the planned dispatching
+        """
         s = super().get(request, *args, **kwargs)
         if not self.event.active:
             messages.add_message(self.request, messages.ERROR, self.get_error_message())
@@ -194,6 +349,11 @@ class EventInactiveRedirectMixin:
 
 
 class AKAndAKWishSubmissionView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
+    """
+    View: Submission form for AKs and Wishes
+
+    Base view, will be used by :class:`AKSubmissionView` and :class:`AKWishSubmissionView`
+    """
     model = AK
     template_name = 'AKSubmission/submit_new.html'
     form_class = AKSubmissionForm
@@ -221,7 +381,15 @@ class AKAndAKWishSubmissionView(EventSlugMixin, EventInactiveRedirectMixin, Crea
 
 
 class AKSubmissionView(AKAndAKWishSubmissionView):
+    """
+    View: AK submission form
+
+    Extends :class:`AKAndAKWishSubmissionView`
+    """
+
     def get_initial(self):
+        # Load initial values for the form
+        # Used to directly add the first owner and the event this AK will belong to
         initials = super(AKAndAKWishSubmissionView, self).get_initial()
         initials['owners'] = [AKOwner.get_by_slug(self.event, self.kwargs['owner_slug'])]
         initials['event'] = self.event
@@ -234,33 +402,54 @@ class AKSubmissionView(AKAndAKWishSubmissionView):
 
 
 class AKWishSubmissionView(AKAndAKWishSubmissionView):
+    """
+    View: Wish submission form
+
+    Extends :class:`AKAndAKWishSubmissionView`
+    """
     template_name = 'AKSubmission/submit_new_wish.html'
     form_class = AKWishForm
 
     def get_initial(self):
+        # Load initial values for the form
+        # Used to directly select the event this AK will belong to
         initials = super(AKAndAKWishSubmissionView, self).get_initial()
         initials['event'] = self.event
         return initials
 
 
 class AKEditView(EventSlugMixin, EventInactiveRedirectMixin, UpdateView):
+    """
+    View: Update an AK
+
+    This allows to change most fields of an AK as specified in :class:`AKSubmission.forms.AKForm`,
+    including the availabilities.
+    It will also handle the change from AK to wish and vice versa (triggered by adding or removing owners)
+    and automatically create or delete (unscheduled) slots
+    """
     model = AK
     template_name = 'AKSubmission/ak_edit.html'
     form_class = AKForm
 
     def get_success_url(self):
+        # Redirection after successfully saving to detail page of AK where also a success message is displayed
         messages.add_message(self.request, messages.SUCCESS, _("AK successfully updated"))
         return self.object.detail_url
 
     def form_valid(self, form):
+        # Handle valid form submission
+
+        # Only save when event is active, otherwise redirect
         if not form.cleaned_data["event"].active:
             messages.add_message(self.request, messages.ERROR, self.get_error_message())
             return redirect(reverse_lazy('submit:submission_overview',
                                          kwargs={'event_slug': form.cleaned_data["event"].slug}))
 
+        # Remember owner count before saving to know whether the AK changed its state between AK and wish
         previous_owner_count = self.object.owners.count()
 
-        super_form_valid = super().form_valid(form)
+        # Perform saving and redirect handling by calling default/parent implementation of form_valid
+        redirect_response = super().form_valid(form)
 
         # Did this AK change from wish to AK or vice versa?
         new_owner_count = self.object.owners.count()
@@ -273,15 +462,23 @@ class AKEditView(EventSlugMixin, EventInactiveRedirectMixin, UpdateView):
             # Delete all unscheduled slots
             self.object.akslot_set.filter(start__isnull=True).delete()
 
-        return super_form_valid
+        # Redirect to success url
+        return redirect_response
 
 
 class AKOwnerCreateView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
+    """
+    View: Create a new owner
+    """
     model = AKOwner
     template_name = 'AKSubmission/akowner_create_update.html'
     form_class = AKOwnerForm
 
     def get_success_url(self):
+        # The redirect url depends on the source this view was called from:
+
+        # Called from an existing AK? Add the new owner as an owner of that AK, notify the user and redirect to detail
+        # page of that AK
         if "add_to_existing_ak" in self.request.GET:
             ak_pk = self.request.GET['add_to_existing_ak']
             ak = get_object_or_404(AK, pk=ak_pk)
@@ -289,15 +486,20 @@ class AKOwnerCreateView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
             messages.add_message(self.request, messages.SUCCESS,
                                  _("Added '{owner}' as new owner of '{ak.name}'").format(owner=self.object, ak=ak))
             return ak.detail_url
+
+        # Called from the submission overview? Offer the user to create a new AK with the recently created owner
+        # prefilled as owner of that AK in the creation form
         return reverse_lazy('submit:submit_ak',
                             kwargs={'event_slug': self.kwargs['event_slug'], 'owner_slug': self.object.slug})
 
     def get_initial(self):
-        initials = super(AKOwnerCreateView, self).get_initial()
+        # Set the event in the (hidden) event field in the form based on the URL this view was called with
+        initials = super().get_initial()
         initials['event'] = self.event
         return initials
 
     def form_valid(self, form):
+        # Prevent changes if event is not active
         if not form.cleaned_data["event"].active:
             messages.add_message(self.request, messages.ERROR, self.get_error_message())
             return redirect(reverse_lazy('submit:submission_overview',
@@ -305,29 +507,97 @@ class AKOwnerCreateView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
         return super().form_valid(form)
 
 
-class AKOwnerSelectDispatchView(EventSlugMixin, View):
+class AKOwnerDispatchView(ABC, EventSlugMixin, View):
+    """
+    Base view: Dispatch to correct view based upon
+
+    Will be used by :class:`AKOwnerSelectDispatchView` and :class:`AKOwnerEditDispatchView` to handle button clicks for
+    "New AK" and "Edit Person Info" in submission overview based upon the selection in the owner dropdown field
+    """
+
+    @abstractmethod
+    def get_new_owner_redirect(self, event_slug):
+        """
+        Get redirect when user selected "I do not own AKs yet"
+
+        :param event_slug: slug of the event, needed for constructing redirect
+        :return: redirect to perform
+        :rtype: HttpResponseRedirect
+        """
+
+    @abstractmethod
+    def get_valid_owner_redirect(self, event_slug, owner):
         """
-    This view only serves as redirect to prepopulate the owners field in submission create view
+        Get redirect when user selected "I do not own AKs yet"
+
+        :param event_slug: slug of the event, needed for constructing redirect
+        :param owner: owner to perform the dispatching for
+        :return: redirect to perform
+        :rtype: HttpResponseRedirect
         """
 
     def post(self, request, *args, **kwargs):
+        # This view is solely meant to handle POST requests
+        # Perform dispatching based on the submitted owner_id
+
+        # No owner_id? Redirect to submission overview view
         if "owner_id" not in request.POST:
             return redirect('submit:submission_overview', event_slug=kwargs['event_slug'])
         owner_id = request.POST["owner_id"]
 
+        # Special owner_id "-1" (value of "I do not own AKs yet)? Redirect to owner creation view
         if owner_id == "-1":
-            return HttpResponseRedirect(
-                reverse_lazy('submit:akowner_create', kwargs={'event_slug': kwargs['event_slug']}))
+            return self.get_new_owner_redirect(kwargs['event_slug'])
 
+        # Normal owner_id given? Check vor validity and redirect to AK submission page with that owner prefilled
+        # or display a 404 error page if no owner for the given id can be found. The latter should only happen when the
+        # user manipulated the value before sending or when the owner was deleted in backend and the user did not
+        # reload the dropdown between deletion and sending the dispatch request
         owner = get_object_or_404(AKOwner, pk=request.POST["owner_id"])
-        return HttpResponseRedirect(
-            reverse_lazy('submit:submit_ak', kwargs={'event_slug': kwargs['event_slug'], 'owner_slug': owner.slug}))
+        return self.get_valid_owner_redirect(kwargs['event_slug'], owner)
 
     def get(self, request, *args, **kwargs):
+        # This view should never be called with GET, perform a redirect to overview in that case
         return redirect('submit:submission_overview', event_slug=kwargs['event_slug'])
 
 
-class AKOwnerEditView(FilterByEventSlugMixin, EventSlugMixin, UpdateView):
+class AKOwnerSelectDispatchView(AKOwnerDispatchView):
+    """
+    View: Handle submission from the owner selection dropdown in submission overview for AK creation
+    ("New AK" button)
+
+    This view will perform redirects depending on the selection in the owner dropdown field.
+    Based upon the abstract base view :class:`AKOwnerDispatchView`.
+    """
+
+    def get_new_owner_redirect(self, event_slug):
+        return redirect('submit:akowner_create', event_slug=event_slug)
+
+    def get_valid_owner_redirect(self, event_slug, owner):
+        return redirect('submit:submit_ak', event_slug=event_slug, owner_slug=owner.slug)
+
+
+class AKOwnerEditDispatchView(AKOwnerDispatchView):
+    """
+    View: Handle submission from the owner selection dropdown in submission overview for owner editing
+    ("Edit Person Info" button)
+
+    This view will perform redirects depending on the selection in the owner dropdown field.
+    Based upon the abstract base view :class:`AKOwnerDispatchView`.
+    """
+
+    def get_new_owner_redirect(self, event_slug):
+        messages.add_message(self.request, messages.WARNING, _("No user selected"))
+        return redirect('submit:submission_overview', event_slug)
+
+    def get_valid_owner_redirect(self, event_slug, owner):
+        return redirect('submit:akowner_edit', event_slug=event_slug, slug=owner.slug)
+
+
+class AKOwnerEditView(FilterByEventSlugMixin, EventSlugMixin, EventInactiveRedirectMixin, UpdateView):
+    """
+    View: Edit an owner
+    """
     model = AKOwner
     template_name = "AKSubmission/akowner_create_update.html"
     form_class = AKOwnerForm
@@ -337,6 +607,7 @@ class AKOwnerEditView(FilterByEventSlugMixin, EventSlugMixin, UpdateView):
         return reverse_lazy('submit:submission_overview', kwargs={'event_slug': self.kwargs['event_slug']})
 
     def form_valid(self, form):
+        # Prevent updating if event is not active
         if not form.cleaned_data["event"].active:
             messages.add_message(self.request, messages.ERROR, self.get_error_message())
             return redirect(reverse_lazy('submit:submission_overview',
@@ -344,36 +615,19 @@ class AKOwnerEditView(FilterByEventSlugMixin, EventSlugMixin, UpdateView):
         return super().form_valid(form)
 
 
-class AKOwnerEditDispatchView(EventSlugMixin, View):
-    """
-    This view only serves as redirect choose the correct edit view
+class AKSlotAddView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
     """
+    View: Add an additional slot to an AK
+    The user has to select the duration of the slot in this view
 
-    def post(self, request, *args, **kwargs):
-        if "owner_id" not in request.POST:
-            return redirect('submit:submission_overview', event_slug=kwargs['event_slug'])
-        owner_id = request.POST["owner_id"]
-
-        if owner_id == "-1":
-            messages.add_message(self.request, messages.WARNING, _("No user selected"))
-            return HttpResponseRedirect(
-                reverse_lazy('submit:submission_overview', kwargs={'event_slug': kwargs['event_slug']}))
-
-        owner = get_object_or_404(AKOwner, pk=request.POST["owner_id"])
-        return HttpResponseRedirect(
-            reverse_lazy('submit:akowner_edit', kwargs={'event_slug': kwargs['event_slug'], 'slug': owner.slug}))
-
-    def get(self, request, *args, **kwargs):
-        return redirect('submit:submission_overview', event_slug=kwargs['event_slug'])
-
-
-class AKSlotAddView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
+    The view will only process the request when the event is active (as steered by :class:`EventInactiveRedirectMixin`)
+    """
     model = AKSlot
     form_class = AKDurationForm
     template_name = "AKSubmission/akslot_add_update.html"
 
     def get_initial(self):
-        initials = super(AKSlotAddView, self).get_initial()
+        initials = super().get_initial()
         initials['event'] = self.event
         initials['ak'] = get_object_or_404(AK, pk=self.kwargs['pk'])
         initials['duration'] = self.event.default_slot
@@ -390,6 +644,12 @@ class AKSlotAddView(EventSlugMixin, EventInactiveRedirectMixin, CreateView):
 
 
 class AKSlotEditView(EventSlugMixin, EventInactiveRedirectMixin, UpdateView):
+    """
+    View: Update the duration of an AK slot
+
+    The view will only process the request when the event is active (as steered by :class:`EventInactiveRedirectMixin`)
+    and only slots that are not scheduled yet may be changed
+    """
     model = AKSlot
     form_class = AKDurationForm
     template_name = "AKSubmission/akslot_add_update.html"
@@ -413,6 +673,12 @@ class AKSlotEditView(EventSlugMixin, EventInactiveRedirectMixin, UpdateView):
 
 
 class AKSlotDeleteView(EventSlugMixin, EventInactiveRedirectMixin, DeleteView):
+    """
+    View: Delete an AK slot
+
+    The view will only process the request when the event is active (as steered by :class:`EventInactiveRedirectMixin`)
+    and only slots that are not scheduled yet may be deleted
+    """
     model = AKSlot
     template_name = "AKSubmission/akslot_delete.html"
 
@@ -436,6 +702,11 @@ class AKSlotDeleteView(EventSlugMixin, EventInactiveRedirectMixin, DeleteView):
 
 @status_manager.register(name="event_ak_messages")
 class EventAKMessagesWidget(TemplateStatusWidget):
+    """
+    Status page widget: AK Messages
+
+    A widget to display information about AK-related messages sent to organizers for the given event
+    """
     required_context_type = "event"
     title = _("Messages")
     template_name = "admin/AKModel/render_ak_messages.html"
@@ -454,12 +725,16 @@ class EventAKMessagesWidget(TemplateStatusWidget):
 
 
 class AKAddOrgaMessageView(EventSlugMixin, CreateView):
+    """
+    View: Form to create a (confidential) message to the organizers as defined in
+    :class:`AKSubmission.forms.AKOrgaMessageForm`
+    """
     model = AKOrgaMessage
     form_class = AKOrgaMessageForm
     template_name = "AKSubmission/akmessage_add.html"
 
     def get_initial(self):
-        initials = super(AKAddOrgaMessageView, self).get_initial()
+        initials = super().get_initial()
         initials['ak'] = get_object_or_404(AK, pk=self.kwargs['pk'])
         initials['event'] = initials['ak'].event
         return initials

CONTRIBUTING.md

@@ -61,7 +61,7 @@ Provide more context by answering these questions:
 
 Include details about your configuration and environment:
 
-* **Which version (commit)) are you using?**
+* **Which version (commit) are you using?**
 * **What's the OS you're using**?
 
 ### Suggesting Enhancements