AKPlan/templatetags/color_gradients.py

+# gradients based on http://bsou.io/posts/color-gradients-with-python
+
+
+def hex_to_rgb(hex): #pylint: disable=redefined-builtin
+    """
+    Convert hex color to RGB color code
+    :param hex: hex encoded color
+    :type hex: str
+    :return: rgb encoded version of given color
+    :rtype: list[int]
+    """
+    # Pass 16 to the integer function for change of base
+    return [int(hex[i:i+2], 16) for i in range(1,6,2)]
+
+
+def rgb_to_hex(rgb):
+    """
+    Convert rgb color (list) to hex encoding (str)
+    :param rgb: rgb encoded color
+    :type rgb: list[int]
+    :return: hex encoded version of given color
+    :rtype: str
+    """
+    # Components need to be integers for hex to make sense
+    rgb = [int(x) for x in rgb]
+    return "#"+"".join([f"0{v:x}" if v < 16 else f"{v:x}" for v in rgb])
+
+
+def linear_blend(start_hex, end_hex, position):
+    """
+    Create a linear blend between two colors and return color code on given position of the range from 0 to 1
+    :param start_hex: hex representation of start color
+    :type start_hex: str
+    :param end_hex: hex representation of end color
+    :type end_hex: str
+    :param position: position in range from 0 to 1
+    :type position: float
+    :return: hex encoded interpolated color
+    :rtype: str
+    """
+    s = hex_to_rgb(start_hex)
+    f = hex_to_rgb(end_hex)
+    blended = [int(s[j] + position * (f[j] - s[j])) for j in range(3)]
+    return rgb_to_hex(blended)
+
+
+def darken(start_hex, amount):
+    """
+    Darken the given color by the given amount (sensitivity will be cut in half)
+
+    :param start_hex: original color
+    :type start_hex: str
+    :param amount: how much to darken (1.0 -> 50% darker)
+    :type amount: float
+    :return: darker version of color
+    :rtype: str
+    """
+    start_rbg = hex_to_rgb(start_hex)
+    darker = [int(s * (1 - amount * .5)) for s in start_rbg]
+    return rgb_to_hex(darker)

AKPlan/templatetags/tags_AKPlan.py

+from datetime import datetime
+
+from django import template
+from django.utils.formats import date_format
+
+from AKPlan.templatetags.color_gradients import darken
+from AKPlanning import settings
+
+register = template.Library()
+
+
+@register.filter
+def highlight_change_colors(akslot):
+    """
+    Adjust color to highlight recent changes if needed
+
+    :param akslot: akslot to determine color for
+    :type akslot: AKSlot
+    :return: color that should be used (either default color of the category or some kind of red)
+    :rtype: str
+    """
+    # Do not highlight in preview mode or when changes occurred before the plan was published
+    if akslot.event.plan_hidden or (akslot.event.plan_published_at is not None
+                                    and akslot.event.plan_published_at > akslot.updated):
+        return akslot.ak.category.color
+
+    seconds_since_update = akslot.seconds_since_last_update
+
+    # Last change long ago? Use default color
+    if seconds_since_update > settings.PLAN_MAX_HIGHLIGHT_UPDATE_SECONDS:
+        return akslot.ak.category.color
+
+    # Recent change? Calculate gradient blend between red and
+    recentness = seconds_since_update / settings.PLAN_MAX_HIGHLIGHT_UPDATE_SECONDS
+    return darken("#b71540", recentness)
+
+
+@register.simple_tag
+def timestamp_now(tz):
+    """
+    Get the current timestamp for the given timezone
+
+    :param tz: timezone to be used for the timestamp
+    :return: current timestamp in given timezone
+    """
+    return date_format(datetime.now().astimezone(tz), "c")

AKPlan/tests.py

-# Create your tests here.
+from django.test import TestCase
+
+from AKModel.tests.test_views import BasicViewTests
+
+
+class PlanViewTests(BasicViewTests, TestCase):
+    """
+    Tests for AKPlan
+    """
+    fixtures = ['model.json']
+    APP_NAME = 'plan'
+
+    VIEWS = [
+        ('plan_overview', {'event_slug': 'kif42'}),
+        ('plan_wall', {'event_slug': 'kif42'}),
+        ('plan_room', {'event_slug': 'kif42', 'pk': 2}),
+        ('plan_track', {'event_slug': 'kif42', 'pk': 1}),
+    ]
+
+    def test_plan_hidden(self):
+        """
+        Test correct handling of plan visibility
+        """
+        _, url = self._name_and_url(('plan_overview', {'event_slug': 'kif23'}))
+
+        self.client.logout()
+        response = self.client.get(url)
+        self.assertContains(response, "Plan is not visible (yet).",
+                            msg_prefix="Plan is visible even though it shouldn't be")
+
+        self.client.force_login(self.staff_user)
+        response = self.client.get(url)
+        self.assertNotContains(response, "Plan is not visible (yet).",
+                               msg_prefix="Plan is not visible for staff user")
+
+    def test_wall_redirect(self):
+        """
+        Test: Make sure that user is redirected from wall to overview when plan is hidden
+        """
+        _, url_wall = self._name_and_url(('plan_wall', {'event_slug': 'kif23'}))
+        _, url_plan = self._name_and_url(('plan_overview', {'event_slug': 'kif23'}))
+
+        response = self.client.get(url_wall)
+        self.assertRedirects(response, url_plan,
+                             msg_prefix=f"Redirect away from wall not working ({url_wall} -> {url_plan})")

AKPlan/urls.py

+from csp.decorators import csp_replace
+from django.urls import path, include
+
+from . import views
+
+app_name = "plan"
+
+urlpatterns = [
+    path(
+        '<slug:event_slug>/plan/',
+        include([
+            path('', views.PlanIndexView.as_view(), name='plan_overview'),
+            path('wall/', csp_replace(FRAME_ANCESTORS="*")(views.PlanScreenView.as_view()), name='plan_wall'),
+            path('room/<int:pk>/', views.PlanRoomView.as_view(), name='plan_room'),
+            path('track/<int:pk>/', views.PlanTrackView.as_view(), name='plan_track'),
+        ])
+    ),
+]

AKPlan/views.py

-# Create your views here.
+import json
+from datetime import datetime, timedelta
+
+from django.conf import settings
+from django.contrib import messages
+from django.db.models import Q
+from django.shortcuts import redirect
+from django.urls import reverse_lazy
+from django.views.generic import DetailView, ListView
+from django.utils.translation import gettext_lazy as _
+
+from AKModel.metaviews.admin import FilterByEventSlugMixin
+from AKModel.models import AKSlot, AKTrack, Room, AKType
+
+
+class PlanIndexView(FilterByEventSlugMixin, ListView):
+    """
+    Default plan view
+
+    Shows two lists of current and upcoming AKs and a graphical full plan below
+    """
+    model = AKSlot
+    template_name = "AKPlan/plan_index.html"
+    context_object_name = "akslots"
+    ordering = "start"
+    types_filter = None
+    query_string = ""
+
+    def get(self, request, *args, **kwargs):
+        if 'types' in request.GET:
+            try:
+                # Initialize types filter, has to be done here such that it is not reused across requests
+                self.types_filter = {
+                    "yes": [],
+                    "no": [],
+                    "no_set": set(),
+                    "strict": False,
+                    "empty": False,
+                }
+                # If types are given, filter the queryset accordingly
+                types_raw = request.GET['types'].split(',')
+                for t in types_raw:
+                    type_slug, type_condition = t.split(':')
+                    if type_condition in ["yes", "no"]:
+                        t = AKType.objects.get(slug=type_slug, event=self.event)
+                        self.types_filter[type_condition].append(t)
+                        if type_condition == "no":
+                            # Store slugs of excluded types in a set for faster lookup
+                            self.types_filter["no_set"].add(t.slug)
+                    else:
+                        raise ValueError(f"Unknown type condition: {type_condition}")
+                if 'strict' in request.GET:
+                    # If strict is specified and marked as "yes",
+                    # exclude all AKs that have any of the excluded types ("no"),
+                    # even if they have other types that are marked as "yes"
+                    self.types_filter["strict"] = request.GET.get('strict') == 'yes'
+                if 'empty' in request.GET:
+                    # If empty is specified and marked as "yes", include AKs that have no types at all
+                    self.types_filter["empty"] = request.GET.get('empty') == 'yes'
+                # Will be used for generating a link to the wall view with the same filter
+                self.query_string = request.GET.urlencode(safe=",:")
+            except (ValueError, AKType.DoesNotExist):
+                # Display an error message if the types parameter is malformed
+                messages.add_message(request, messages.ERROR, _("Invalid type filter"))
+                self.types_filter = None
+        s = super().get(request, *args, **kwargs)
+        return s
+
+    def get_queryset(self):
+        # Ignore slots not scheduled yet
+        qs = (super().get_queryset().filter(start__isnull=False).
+                select_related('event', 'ak', 'room', 'ak__category', 'ak__event'))
+                # Need to prefetch both event and ak__event
+                # since django is not aware that the two are always the same
+
+        # Apply type filter if necessary
+        if self.types_filter:
+            # Either include all AKs with the given types or without any types at all
+            if self.types_filter["empty"]:
+                qs = qs.filter(Q(ak__types__in=self.types_filter["yes"]) | Q(ak__types__isnull=True)).distinct()
+            # Or only those with the given types
+            else:
+                qs = qs.filter(ak__types__in=self.types_filter["yes"]).distinct()
+            # Afterwards, if strict, exclude all AKs that have any of the excluded types,
+            # even though they were included by the previous filter
+            if self.types_filter["strict"]:
+                qs = qs.exclude(ak__types__in=self.types_filter["no"]).distinct()
+        return qs
+
+    def get_context_data(self, *, object_list=None, **kwargs):
+        context = super().get_context_data(object_list=object_list, **kwargs)
+
+        context["event"] = self.event
+
+        current_timestamp = datetime.now().astimezone(self.event.timezone)
+
+        context["akslots_now"] = []
+        context["akslots_next"] = []
+        rooms = set()
+        buildings = set()
+
+        # Get list of current and next slots
+        for akslot in context["akslots"]:
+            self._process_slot(akslot)
+            # Construct a list of all rooms used by these slots on the fly
+            if akslot.room is not None:
+                rooms.add(akslot.room)
+                # Store buildings for hierarchical view
+                if akslot.room.location != '':
+                    buildings.add(akslot.room.location)
+
+            # Recent AKs: Started but not ended yet
+            if akslot.start <= current_timestamp <= akslot.end:
+                context["akslots_now"].append(akslot)
+            # Next AKs: Not started yet, list will be filled in order until threshold is reached
+            elif akslot.start > current_timestamp:
+                if len(context["akslots_next"]) < settings.PLAN_MAX_NEXT_AKS:
+                    context["akslots_next"].append(akslot)
+
+        # Sort list of rooms by title
+        context["rooms"] = sorted(rooms, key=lambda x: x.title)
+        if settings.PLAN_SHOW_HIERARCHY:
+            context["buildings"] = sorted(buildings)
+
+        context["tracks"] = self.event.aktrack_set.all()
+
+        # Pass query string to template for generating a matching wall link
+        context["query_string"] = self.query_string
+
+        # Generate a list of all types and their current selection state for graphic filtering
+        types = [{"name": t.name, "slug": t.slug, "state": True} for t in self.event.aktype_set.all()]
+        if len(types) > 0:
+            context["type_filtering_active"] = True
+            if self.types_filter:
+                for t in types:
+                    if t["slug"] in self.types_filter["no_set"]:
+                        t["state"] = False
+            # Pass type list as well as filter state for strict filtering and empty types to the template
+            context["types"] = json.dumps(types)
+            context["types_filter_strict"] = False
+            context["types_filter_empty"] = False
+            if self.types_filter:
+                context["types_filter_empty"] = self.types_filter["empty"]
+                context["types_filter_strict"] = self.types_filter["strict"]#
+        else:
+            context["type_filtering_active"] = False
+
+        return context
+
+    def _process_slot(self, akslot):
+        """
+        Function to be called for each slot when looping over the slots
+        (meant to be overridden in inherited views)
+
+        :param akslot: current slot
+        :type akslot: AKSlot
+        """
+
+
+class PlanScreenView(PlanIndexView):
+    """
+    Plan view optimized for screens and projectors
+
+    This again shows current and upcoming AKs as well as a graphical plan,
+    but no navigation elements and trys to use the available space as best as possible
+    such that no scrolling is needed.
+
+    The view contains a frontend functionality for auto-reload.
+    """
+    template_name = "AKPlan/plan_wall.html"
+
+    def get(self, request, *args, **kwargs):
+        s = super().get(request, *args, **kwargs)
+        # Don't show wall when event is not active -> redirect to normal schedule
+        if not self.event.active or (self.event.plan_hidden and not request.user.is_staff):
+            return redirect(reverse_lazy("plan:plan_overview", kwargs={"event_slug": self.event.slug}))
+        return s
+
+    # pylint: disable=attribute-defined-outside-init
+    def get_queryset(self):
+        now = datetime.now().astimezone(self.event.timezone)
+        # Wall during event: Adjust, show only parts in the future
+        if self.event.start < now < self.event.end:
+            # Determine interesting range (some hours ago until some hours in the future as specified in the settings)
+            self.start = now - timedelta(hours=settings.PLAN_WALL_HOURS_RETROSPECT)
+        else:
+            self.start = self.event.start
+        self.end = self.event.end
+
+        # Restrict AK slots to relevant ones
+        # This will automatically filter all rooms not needed for the selected range in the orginal get_context method
+        return super().get_queryset().filter(start__gt=self.start)
+
+    def get_context_data(self, *, object_list=None, **kwargs):
+        # Find the earliest hour AKs start and end (handle 00:00 as 24:00)
+        self.earliest_start_hour = 23
+        self.latest_end_hour = 1
+        context = super().get_context_data(object_list=object_list, **kwargs)
+        context["start"] = self.start
+        context["end"] = self.event.end
+        context["earliest_start_hour"] = self.earliest_start_hour
+        context["latest_end_hour"] = self.latest_end_hour
+        return context
+
+    def _process_slot(self, akslot):
+        start_hour = akslot.start.astimezone(self.event.timezone).hour
+        if start_hour < self.earliest_start_hour:
+            # Use hour - 1 to improve visibility of date change
+            self.earliest_start_hour = max(start_hour - 1, 0)
+        end_hour = akslot.end.astimezone(self.event.timezone).hour
+        # Special case: AK starts before but ends after midnight -- show until midnight
+        if end_hour < start_hour:
+            self.latest_end_hour = 24
+        elif end_hour > self.latest_end_hour:
+            # Always use hour + 1, since AK may end at :xy and not always at :00
+            self.latest_end_hour = min(end_hour + 1, 24)
+
+
+class PlanRoomView(FilterByEventSlugMixin, DetailView):
+    """
+    Plan view for a single room
+    """
+    template_name = "AKPlan/plan_room.html"
+    model = Room
+    context_object_name = "room"
+
+    def get_context_data(self, *, object_list=None, **kwargs):
+        context = super().get_context_data(object_list=object_list, **kwargs)
+        # Restrict AKSlot list to the given room
+        # while joining AK, room and category information to reduce the amount of necessary SQL queries
+        context["slots"] = AKSlot.objects.filter(room=context['room']).select_related('ak', 'ak__category', 'ak__track')
+        return context
+
+
+class PlanTrackView(FilterByEventSlugMixin, DetailView):
+    """
+    Plan view for a single track
+    """
+    template_name = "AKPlan/plan_track.html"
+    model = AKTrack
+    context_object_name = "track"
+
+    def get_context_data(self, *, object_list=None, **kwargs):
+        context = super().get_context_data(object_list=object_list, **kwargs)
+        # Restrict AKSlot list to given track
+        # while joining AK, room and category information to reduce the amount of necessary SQL queries
+        context["slots"] = AKSlot.objects. \
+            filter(event=self.event, ak__track=context['track']). \
+            select_related('ak', 'room', 'ak__category')
+        return context

AKPlanning/locale/de_DE/LC_MESSAGES/django.po

@@ -2,13 +2,13 @@
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-# 
+#
 #, fuzzy
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2019-10-29 14:50+0000\n"
+"POT-Creation-Date: 2023-08-16 16:30+0200\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,10 +17,10 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: AKPlanning/settings.py:126
+#: AKPlanning/settings.py:148
 msgid "German"
 msgstr "Deutsch"
 
-#: AKPlanning/settings.py:127
+#: AKPlanning/settings.py:149
 msgid "English"
 msgstr "Englisch"

AKPlanning/settings.py

@@ -10,10 +10,10 @@ For the full list of settings and their values, see
 https://docs.djangoproject.com/en/2.2/ref/settings/
 """
 
+import decimal
 import os
-from django.utils.translation import gettext_lazy as _
-
 
+from django.utils.translation import gettext_lazy as _
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 from split_settings.tools import optional, include
 
@@ -38,17 +38,31 @@ INSTALLED_APPS = [
     'AKSubmission.apps.AksubmissionConfig',
     'AKScheduling.apps.AkschedulingConfig',
     'AKPlan.apps.AkplanConfig',
-    'django.contrib.admin',
+    'AKOnline.apps.AkonlineConfig',
+    'AKPreference.apps.AkpreferenceConfig',
+    'AKSolverInterface.apps.AksolverinterfaceConfig',
+    'AKModel.apps.AKAdminConfig',
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    'bootstrap4',
-    'fontawesome',
+    'debug_toolbar',
+    'django_bootstrap5',
+    'fontawesomefree',
+    'fontawesome_6',
+    'timezone_field',
+    'rest_framework',
+    'simple_history',
+    'registration',
+    'django_tex',
+    'compressor',
+    'docs',
 ]
 
 MIDDLEWARE = [
+    'django.middleware.gzip.GZipMiddleware',
+    'debug_toolbar.middleware.DebugToolbarMiddleware',
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.locale.LocaleMiddleware',
@@ -56,7 +70,9 @@ MIDDLEWARE = [
     'django.middleware.csrf.CsrfViewMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
+    'csp.middleware.CSPMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'simple_history.middleware.HistoryRequestMiddleware',
 ]
 
 ROOT_URLCONF = 'AKPlanning.urls'
@@ -77,10 +93,20 @@ TEMPLATES = [
             ],
         },
     },
+    {
+        'NAME': 'tex',
+        'BACKEND': 'django_tex.engine.TeXEngine',
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'environment': 'AKModel.environment.improved_tex_environment',
+        },
+    },
 ]
 
 WSGI_APPLICATION = 'AKPlanning.wsgi.application'
 
+DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
+
 # Database
 # https://docs.djangoproject.com/en/2.2/ref/settings/#databases
 
@@ -118,8 +144,6 @@ TIME_ZONE = 'UTC'
 
 USE_I18N = True
 
-USE_L10N = True
-
 USE_TZ = True
 
 LANGUAGES = [
@@ -127,6 +151,11 @@ LANGUAGES = [
     ('en', _('English')),
 ]
 
+INTERNAL_IPS = ['127.0.0.1', '::1']
+
+LATEX_INTERPRETER = 'lualatex'
+LATEX_RUN_COUNT = 2
+
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/2.2/howto/static-files/
 
@@ -136,16 +165,38 @@ STATICFILES_DIRS = (
     'static_common',
 )
 
+STATICFILES_FINDERS = (
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+    'compressor.finders.CompressorFinder',
+)
+
 # Settings for Bootstrap
-BOOTSTRAP4 = {
-    # Use custom CSS
-    "css_url": {
-        "href": STATIC_URL + "common/css/bootstrap.css",
+BOOTSTRAP5 = {
+    "javascript_url": {
+        "url": STATIC_URL + "common/vendor/bootstrap/bootstrap-5.0.2.bundle.min.js",
     },
 }
 
 # Settings for FontAwesome
-FONTAWESOME_CSS_URL = "//cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/all.css"
+FONTAWESOME_6_CSS_URL = STATIC_URL + "fontawesomefree/css/all.min.css"
+FONTAWESOME_6_PREFIX = "fa"
+
+# Compressor and minifier config
+COMPRESS_ENABLED = True
+COMPRESS_CSS_HASHING_METHOD = 'content'
+COMPRESS_PRECOMPILERS = (
+    ('text/x-scss', 'django_libsass.SassCompiler'),
+)
+COMPRESS_FILTERS = {
+    'css': [
+        'compressor.filters.css_default.CssAbsoluteFilter',
+        'compressor.filters.cssmin.rCSSMinFilter',
+    ],
+    'js': [
+        'compressor.filters.jsmin.JSMinFilter',
+    ]
+}
 
 # Treat wishes as seperate category in submission views?
 WISHES_AS_CATEGORY = True
@@ -156,4 +207,48 @@ FOOTER_INFO = {
     "impress_url": ""
 }
 
+# How many AKs should be visible as next AKs
+PLAN_MAX_NEXT_AKS = 10
+# Specify range of plan for screen/projector view
+PLAN_WALL_HOURS_RETROSPECT = 3
+# Should the plan use a hierarchy of buildings and rooms?
+PLAN_SHOW_HIERARCHY = True
+# For which time (in seconds) should changes of akslots be highlighted in plan?
+PLAN_MAX_HIGHLIGHT_UPDATE_SECONDS = 2 * 60 * 60
+
+# Show feed of recent changes in dashboard
+DASHBOARD_SHOW_RECENT = True
+# How many entries max?
+DASHBOARD_RECENT_MAX = 25
+# How many events should be featured in the dashboard
+# (active events will always be featured, even if their number is higher than this threshold)
+DASHBOARD_MAX_FEATURED_EVENTS = 3
+
+# In the export to the solver we need to calculate the integer number
+# of discrete time slots covered by an AK. This is done by rounding
+# the 'exact' number up. To avoid 'overshooting' by 1
+# due to FLOP inaccuracies, we subtract this small epsilon before rounding.
+EXPORT_CEIL_OFFSET_EPS = decimal.Decimal(1e-4)
+
+# Registration/login behavior
+SIMPLE_BACKEND_REDIRECT_URL = "/user/"
+LOGIN_REDIRECT_URL = SIMPLE_BACKEND_REDIRECT_URL
+
+# Content Security Policy
+CSP_DEFAULT_SRC = ("'self'",)
+CSP_SCRIPT_SRC = ("'self'", "'unsafe-inline'", "'unsafe-eval'")
+CSP_STYLE_SRC = ("'self'", "'unsafe-inline'", "fonts.googleapis.com")
+CSP_IMG_SRC = ("'self'", "data:")
+CSP_FRAME_SRC = ("'self'", )
+CSP_FONT_SRC = ("'self'", "data:", "fonts.gstatic.com")
+
+# Emails
+SEND_MAILS = True
+EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+
+# Documentation
+
+DOCS_ROOT = os.path.join(BASE_DIR, 'docs/_build/html')
+DOCS_ACCESS = 'public'
+
 include(optional("settings/*.py"))

AKPlanning/settings_ci.py

+# noinspection PyUnresolvedReferences
+from AKPlanning.settings import *
+
+DEBUG = False
+SECRET_KEY = '+7#&=$grg7^x62m#3cuv)k$)tqx!xkj_o&y9sm)@@sgj7_7-!+'
+
+SESSION_COOKIE_SECURE = True
+CSRF_COOKIE_SECURE = True
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.mysql',
+        'HOST': 'mysql',
+        'NAME': 'test',
+        'USER': 'django',
+        'PASSWORD': 'mysql',
+        'OPTIONS': {
+            'init_command': "SET sql_mode='STRICT_TRANS_TABLES'",
+        },
+        'TEST': {
+            'NAME': 'tests',
+            'CHARSET': "utf8mb4",
+            'COLLATION': 'utf8mb4_unicode_ci',
+        },
+    }
+}
+
+TEST_RUNNER = 'xmlrunner.extra.djangotestrunner.XMLTestRunner'
+TEST_OUTPUT_FILE_NAME = 'unit.xml'

AKPlanning/settings_production.py

@@ -25,7 +25,7 @@ CSRF_COOKIE_SECURE = True
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.mysql',
-        'HOST': 'localhost',
+        'HOST': getattr(secrets, "DB_HOST", "localhost"),
         'NAME': secrets.DB_NAME,
         'USER': secrets.DB_USER,
         'PASSWORD': secrets.DB_PASSWORD,
@@ -35,4 +35,8 @@ DATABASES = {
     }
 }
 
+### EMAILS ###
+SEND_MAILS = True
+EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
+
 # TODO: caching

AKPlanning/settings_secrets.py.sample

@@ -6,4 +6,7 @@ DB_NAME = ''
 
 DB_USER = ''
 
-DB_PASSWORD = ''
\ No newline at end of file
+DB_PASSWORD = ''
+
+# Optional, if not set, localhost is assumed
+# DB_HOST = ''

AKPlanning/urls.py

-"""AKPlanning URL Configuration
+"""
+AKPlanning URL Configuration
 
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/2.2/topics/http/urls/
@@ -13,12 +14,28 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
+import debug_toolbar
+from django.apps import apps
 from django.contrib import admin
-from django.urls import path, include
+from django.urls import path, include, re_path
 
 urlpatterns = [
     path('admin/', admin.site.urls),
-    path('', include('AKSubmission.urls', namespace='submit')),
-    path('', include('AKDashboard.urls', namespace='dashboard')),
+    re_path(r'^docs/', include('docs.urls')),
+    path('accounts/', include('django.contrib.auth.urls')),
+    path('accounts/', include('registration.backends.simple.urls')),
+    path('', include('AKModel.urls', namespace='model')),
     path('i18n/', include('django.conf.urls.i18n')),
+    path('__debug__/', include(debug_toolbar.urls)),
 ]
+
+# Load URLs dynamically (only if components are active)
+if apps.is_installed("AKSubmission"):
+    urlpatterns.append(path('', include('AKSubmission.urls', namespace='submit')))
+if apps.is_installed("AKDashboard"):
+    urlpatterns.append(path('', include('AKDashboard.urls', namespace='dashboard')))
+if apps.is_installed("AKPlan"):
+    urlpatterns.append(path('', include('AKPlan.urls', namespace='plan')))
+if apps.is_installed("AKPreference"):
+    urlpatterns.append(path('', include('AKPreference.urls', namespace='poll')))

AKPreference/admin.py

+from django import forms
+from django.contrib import admin
+
+from AKPreference.models import AKPreference, EventParticipant
+from AKModel.admin import PrepopulateWithNextActiveEventMixin
+from AKModel.models import AK
+
+@admin.register(EventParticipant)
+class EventParticipantAdmin(PrepopulateWithNextActiveEventMixin, admin.ModelAdmin):
+    """
+    Admin interface for EventParticipant
+    """
+    model = EventParticipant
+    list_display = ['name', 'institution', 'event']
+    list_filter = ['event', 'institution']
+    list_editable = []
+    ordering = ['name']
+
+
+class AKPreferenceAdminForm(forms.ModelForm):
+    """
+    Adapted admin form for AK preferences for usage in :class:`AKPreferenceAdmin`)
+    """
+    class Meta:
+        widgets = {
+            'participant': forms.Select,
+            'ak': forms.Select,
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # Filter possible values for foreign keys & m2m when event is specified
+        if hasattr(self.instance, "event") and self.instance.event is not None:
+            self.fields["participant"].queryset = EventParticipant.objects.filter(event=self.instance.event)
+            self.fields["ak"].queryset = AK.objects.filter(event=self.instance.event)
+
+
+@admin.register(AKPreference)
+class AKPreferenceAdmin(PrepopulateWithNextActiveEventMixin, admin.ModelAdmin):
+    """
+    Admin interface for AK preferences.
+    Uses an adapted form (see :class:`AKPreferenceAdminForm`)
+    """
+    model = AKPreference
+    form = AKPreferenceAdminForm
+    list_display = ['preference', 'participant', 'ak', 'event']
+    list_filter = ['event', 'ak', 'participant']
+    list_editable = []
+    ordering = ['participant', 'preference', 'ak']

AKPreference/apps.py

+from django.apps import AppConfig
+
+
+class AkpreferenceConfig(AppConfig):
+    """
+    App configuration (default, only specifies name of the app)
+    """
+
+    name = "AKPreference"

AKPreference/forms.py

+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from AKModel.availability.forms import AvailabilitiesFormMixin
+from AKModel.availability.models import Availability
+from AKModel.models import AKRequirement
+from AKPreference.models import EventParticipant
+
+
+class EventParticipantForm(AvailabilitiesFormMixin, forms.ModelForm):
+    """Form to add EventParticipants"""
+
+    required_css_class = "required"
+
+    class Meta:
+        model = EventParticipant
+        fields = [
+            "name",
+            "institution",
+            "requirements",
+            "event",
+        ]
+        widgets = {
+            "requirements": forms.CheckboxSelectMultiple,
+            "event": forms.HiddenInput,
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.initial = {**self.initial, **kwargs["initial"]}
+
+        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")
+
+    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 len(availabilities) == 0:
+            availabilities.append(
+                Availability.with_event_length(event=self.cleaned_data["event"])
+            )
+        return availabilities

AKPreference/locale/de_DE/LC_MESSAGES/django.po

+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2025-06-13 23:58+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"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: AKPreference/templates/AKPreference/poll.html:11
+#: AKPreference/templates/AKPreference/poll_not_configured.html:7
+msgid "AKs"
+msgstr "AKs"
+
+#: AKPreference/templates/AKPreference/poll.html:11
+msgid "Preferences"
+msgstr "Präferenzen"
+
+#: AKPreference/templates/AKPreference/poll.html:34
+#: AKPreference/templates/AKPreference/poll.html:41
+msgid "AK Preferences"
+msgstr "AK-Präferenzen"
+
+#: AKPreference/templates/AKPreference/poll.html:47
+msgid "Your preferences"
+msgstr "Deine Präferenzen"
+
+#: AKPreference/templates/AKPreference/poll.html:49
+msgid "Please enter your preferences."
+msgstr "Trage bitte deine Präferenzen zu den AKs ein."
+
+#: AKPreference/templates/AKPreference/poll.html:68
+#: AKPreference/templates/AKPreference/poll.html:82
+msgid "Intends to submit a resolution"
+msgstr "Beabsichtigt eine Resolution einzureichen"
+
+#: AKPreference/templates/AKPreference/poll.html:73
+msgid "Description"
+msgstr "Beschreibung"
+
+#: AKPreference/templates/AKPreference/poll.html:78
+msgid "Responsible"
+msgstr "Verantwortlich"
+
+#: AKPreference/templates/AKPreference/poll.html:93
+msgid "Submit"
+msgstr "Eintragen"
+
+#: AKPreference/templates/AKPreference/poll.html:97
+msgid "Reset Form"
+msgstr "Formular leeren"
+
+#: AKPreference/templates/AKPreference/poll.html:101
+msgid "Cancel"
+msgstr "Abbrechen"
+
+#: AKPreference/templates/AKPreference/poll_base.html:13
+msgid "Write to organizers of this event for questions and comments"
+msgstr "Fragen oder Kommentare? Schreib den Orgas dieses Events eine Mail"
+
+#: AKPreference/templates/AKPreference/poll_not_configured.html:7
+#: AKPreference/templates/AKPreference/poll_not_configured.html:11
+msgid "AK Preference Poll"
+msgstr "Abfrage von AK-Präferenzen"
+
+#: AKPreference/templates/AKPreference/poll_not_configured.html:20
+msgid ""
+"System is not yet configured for AK preference polling. Please try again "
+"later."
+msgstr ""
+"Das System ist bisher nicht für die Erfassung von AK-Präferenzen "
+"konfiguriert. Bitte versuche es später wieder."
+
+#: AKPreference/views.py:18
+msgid "AK preferences were registered successfully"
+msgstr "AK-Präferenzen erfolgreich registriert"
+
+#: AKPreference/views.py:113
+msgid ""
+"Something went wrong. Your preferences were not saved. Please try again or "
+"contact the organizers."
+msgstr ""
+"Etwas ging schief. Deine Präferenzen konnten nicht gespeichert werden. "
+"Versuche es bitte erneut oder kontaktiere die Orgas."

AKPreference/migrations/0001_initial.py

+# Generated by Django 5.2.1 on 2025-06-14 18:57
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("AKModel", "0067_eventparticipant_requirements_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="EventParticipant",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        blank=True,
+                        help_text="Name to identify a participant by (in case of questions from the organizers)",
+                        max_length=64,
+                        verbose_name="Nickname",
+                    ),
+                ),
+                (
+                    "institution",
+                    models.CharField(
+                        blank=True,
+                        help_text="Uni etc.",
+                        max_length=128,
+                        verbose_name="Institution",
+                    ),
+                ),
+                (
+                    "event",
+                    models.ForeignKey(
+                        help_text="Associated event",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="AKModel.event",
+                        verbose_name="Event",
+                    ),
+                ),
+                (
+                    "requirements",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="Participant's Requirements",
+                        to="AKModel.akrequirement",
+                        verbose_name="Requirements",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Participant",
+                "verbose_name_plural": "Participants",
+                "ordering": ["name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="AKPreference",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "preference",
+                    models.PositiveSmallIntegerField(
+                        choices=[
+                            (0, "Ignore"),
+                            (1, "Interested"),
+                            (2, "Great interest"),
+                            (3, "Required"),
+                        ],
+                        default=0,
+                        help_text="Preference level for the AK",
+                        verbose_name="Preference",
+                    ),
+                ),
+                (
+                    "timestamp",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="Time of creation",
+                        verbose_name="Timestamp",
+                    ),
+                ),
+                (
+                    "ak",
+                    models.ForeignKey(
+                        help_text="AK this preference belongs to",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="AKModel.ak",
+                        verbose_name="AK",
+                    ),
+                ),
+                (
+                    "event",
+                    models.ForeignKey(
+                        help_text="Associated event",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="AKModel.event",
+                        verbose_name="Event",
+                    ),
+                ),
+                (
+                    "participant",
+                    models.ForeignKey(
+                        help_text="Participant this preference belongs to",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="AKPreference.eventparticipant",
+                        verbose_name="Participant",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "AK Preference",
+                "verbose_name_plural": "AK Preferences",
+                "ordering": ["-timestamp"],
+                "unique_together": {("event", "participant", "ak")},
+            },
+        ),
+    ]

AKPreference/models.py

+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from AKModel.models import AK, AKRequirement, Event
+
+
+class EventParticipant(models.Model):
+    """ A participant describes a person taking part in an event."""
+
+    class Meta:
+        verbose_name = _('Participant')
+        verbose_name_plural = _('Participants')
+        ordering = ['name']
+
+    name = models.CharField(max_length=64, blank=True, verbose_name=_('Nickname'),
+                            help_text=_('Name to identify a participant by (in case of questions from the organizers)'))
+    institution = models.CharField(max_length=128, blank=True, verbose_name=_('Institution'), help_text=_('Uni etc.'))
+
+    event = models.ForeignKey(to=Event, on_delete=models.CASCADE, verbose_name=_('Event'),
+                              help_text=_('Associated event'))
+
+    requirements = models.ManyToManyField(to=AKRequirement, blank=True, verbose_name=_('Requirements'),
+                                          help_text=_("Participant's Requirements"))
+
+    def __str__(self) -> str:
+        string = _("Anonymous {pk}").format(pk=self.pk) if not self.name else self.name
+        if self.institution:
+            string += f" ({self.institution})"
+        return string
+
+    @property
+    def availabilities(self):
+        """
+        Get all availabilities associated to this EventParticipant
+        :return: availabilities
+        :rtype: QuerySet[Availability]
+        """
+        return "Availability".objects.filter(participant=self)
+
+    def get_time_constraints(self) -> list[str]:
+        """Construct list of required time constraint labels."""
+        # local import to prevent cyclic import
+        # pylint: disable=import-outside-toplevel
+        from AKModel.availability.models import Availability
+
+        avails = self.availabilities.all()
+        participant_required_prefs = AKPreference.objects.filter(
+            event=self.event,
+            participant=self,
+            preference=AKPreference.PreferenceLevel.REQUIRED,
+        )
+
+        if (
+            avails
+            and not Availability.is_event_covered(self.event, avails)
+            and participant_required_prefs.exists()
+        ):
+            # participant has restricted availability and is actually required for AKs
+            return [f"availability-participant-{self.pk}"]
+
+        return []
+
+    def get_room_constraints(self) -> list[str]:
+        """Construct list of required room constraint labels."""
+        return list(self.requirements.values_list("name", flat=True).order_by())
+
+    @property
+    def export_preferences(self):
+        """Preferences of this participant with positive score."""
+        return (
+            AKPreference.objects
+            .filter(
+                participant=self, preference__gt=0
+            )
+            .order_by()
+            .select_related('ak')
+            .prefetch_related('ak__akslot_set')
+        )
+
+
+class AKPreference(models.Model):
+    """Model representing the preference of a participant to an AK."""
+
+    class Meta:
+        verbose_name = _('AK Preference')
+        verbose_name_plural = _('AK Preferences')
+        unique_together = [['event', 'participant', 'ak']]
+        ordering = ["-timestamp"]
+
+    event = models.ForeignKey(to=Event, on_delete=models.CASCADE, verbose_name=_('Event'),
+                              help_text=_('Associated event'))
+
+    participant = models.ForeignKey(to=EventParticipant, on_delete=models.CASCADE, verbose_name=_('Participant'),
+                              help_text=_('Participant this preference belongs to'))
+
+    ak = models.ForeignKey(to=AK, on_delete=models.CASCADE, verbose_name=_('AK'),
+                           help_text=_('AK this preference belongs to'))
+
+    class PreferenceLevel(models.IntegerChoices):
+        """
+        Possible preference values
+        """
+        IGNORE = 0, _('Ignore')
+        PREFER = 1, _('Interested')
+        STRONG_PREFER = 2, _("Great interest")
+        REQUIRED = 3, _("Required")
+
+    preference = models.PositiveSmallIntegerField(verbose_name=_('Preference'), choices=PreferenceLevel.choices,
+                                             help_text=_('Preference level for the AK'),
+                                             blank=False,
+                                             default=PreferenceLevel.IGNORE)
+
+    timestamp = models.DateTimeField(auto_now_add=True, verbose_name=_('Timestamp'), help_text=_('Time of creation'))
+
+    def __str__(self) -> str:
+        return f"Preference {self.get_preference_display()} [of '{self.participant}' for AK '{self.ak}']"
+
+    @property
+    def required(self) -> bool:
+        """Whether this preference is a 'REQUIRED'"""
+        return self.preference == self.PreferenceLevel.REQUIRED
+
+    @property
+    def preference_score(self) -> int:
+        """Score of this preference for the solver"""
+        return self.preference if self.preference != self.PreferenceLevel.REQUIRED else -1

AKPreference/serializers.py

+from rest_framework import serializers
+
+from AKModel.models import AKSlot
+from AKModel.serializers import StringListField
+from AKPreference.models import AKPreference, EventParticipant
+
+class ExportAKPreferenceSerializer(serializers.ModelSerializer):
+    """Export serializer for AKPreference objects.
+
+    Used to serialize AKPreference objects for the export to a solver.
+    Part of the implementation of the format of the KoMa solver:
+    https://github.com/Die-KoMa/ak-plan-optimierung/wiki/Input-&-output-format#input--output-format
+    """
+
+    class Meta:
+        model = AKPreference
+        fields = ["required", "preference_score"]
+        read_only_fields = ["required", "preference_score"]
+
+
+class ExportAKPreferencePerSlotSerializer(serializers.BaseSerializer):
+    """Export serializer to associate AKPreferences with the AK's AKSlot objects.
+
+    The AKPreference model stores the preference per AK object.
+    The solver however needs the serialization to be *per AKSlot*, i.e.
+    we need to 'repeat' all preferences for each slot of an AK.
+
+    Part of the implementation of the format of the KoMa solver:
+    https://github.com/Die-KoMa/ak-plan-optimierung/wiki/Input-&-output-format#input--output-format
+    """
+
+    def create(self, validated_data):
+        raise ValueError("`ExportAKPreferencePerSlotSerializer` is read-only.")
+
+    def to_internal_value(self, data):
+        raise ValueError("`ExportAKPreferencePerSlotSerializer` is read-only.")
+
+    def update(self, instance, validated_data):
+        raise ValueError("`ExportAKPreferencePerSlotSerializer` is read-only.")
+
+    def to_representation(self, instance):
+        preference_queryset = instance
+
+        def _insert_akslot_id(serialization_dict: dict, slot: AKSlot) -> dict:
+            """Insert id of the slot into the dict and return it."""
+
+            # The naming scheme of the solver is confusing.
+            # Our 'AKSlot' corresponds to the 'AK' of the solver,
+            # so `ak_id` is the id of the corresponding AKSlot.
+            serialization_dict["ak_id"] = slot.pk
+            return serialization_dict
+
+        return_lst = []
+        for pref in preference_queryset:
+            pref_serialization = ExportAKPreferenceSerializer(pref).data
+            return_lst.extend([
+                _insert_akslot_id(pref_serialization, slot)
+                for slot in pref.ak.akslot_set.all()
+            ])
+        return return_lst
+
+
+class ExportParticipantInfoSerializer(serializers.ModelSerializer):
+    """Serializer of EventParticipant objects for the 'info' field.
+
+    Used in `ExportParticipantSerializer` to serialize EventParticipant objects
+    for the export to a solver. Part of the implementation of the
+    format of the KoMa solver:
+    https://github.com/Die-KoMa/ak-plan-optimierung/wiki/Input-&-output-format#input--output-format
+    """
+    name = serializers.CharField(source="__str__")
+
+    class Meta:
+        model = EventParticipant
+        fields = ["name"]
+        read_only_fields = ["name"]
+
+
+class ExportParticipantSerializer(serializers.ModelSerializer):
+    """Export serializer for EventParticipant objects.
+
+    Used to serialize EventParticipant objects for the export to a solver.
+    Part of the implementation of the format of the KoMa solver:
+    https://github.com/Die-KoMa/ak-plan-optimierung/wiki/Input-&-output-format#input--output-format
+    """
+
+    room_constraints = StringListField(source="get_room_constraints")
+    time_constraints = StringListField(source="get_time_constraints")
+    preferences = ExportAKPreferencePerSlotSerializer(source="export_preferences")
+    info = ExportParticipantInfoSerializer(source="*")
+
+    class Meta:
+        model = EventParticipant
+        fields = ["id", "info", "room_constraints", "time_constraints", "preferences"]
+        read_only_fields = ["id", "info", "room_constraints", "time_constraints", "preferences"]