Add questionnaires (#1559)

Co-authored-by: Felix Rindt <[email protected]>
Co-authored-by: Julian Baumann <[email protected]>

Author: 3 people

ephios/core/signals.py

@@ -26,6 +26,7 @@
 - ``HTML_SHIFT_INFO``: Add HTML to the event detail page shift box. Comes with a ``shift`` kwarg.
 - ``HTML_HOMEPAGE_INFO``: Add HTML to the homepage content area.
 - ``HTML_PERSONAL_DATA_PAGE``: Add HTML to the settings "personal data" page of the logged-in user.
+- ``HTML_DISPOSITION_PARTICIPATION``: Add HTML to the expandable details view of a participation form in the disposition view. Comes with a ``participation`` kwarg.
 """
 
 HTML_HEAD = sys.intern("head")
@@ -34,6 +35,7 @@
 HTML_SHIFT_INFO = sys.intern("shift_info")
 HTML_HOMEPAGE_INFO = sys.intern("homepage_info")
 HTML_PERSONAL_DATA_PAGE = sys.intern("personal_data_page")
+HTML_DISPOSITION_PARTICIPATION = sys.intern("disposition_participation")
 
 
 register_consequence_handlers = PluginSignal()
@@ -103,6 +105,21 @@
 """
 
 
+shift_action = PluginSignal()
+"""
+This signal is sent out to collect additional actions that managers can perform on on a shift. For
+each action, a button will be displayed in the shift card next to the disposition button. Receivers
+of the signal will receive the ``shift`` and ``request`` and are expected to return an array of
+``{label: str, url: str}`` dicts, representing the available actions.
+The buttons will only be shown to responsibles of the respective shift.
+"""
+
+shift_copy = PluginSignal()
+"""
+This signal is set out after a shift got copied to allow plugins to copy related data as well.
+Receivers will receive the original ``shift`` and a list of the created ``copies``.
+"""
+
 shift_forms = PluginSignal()
 """
 This signal is sent out to get a list of form instances to show on the shift create and update views.
@@ -111,6 +128,59 @@
 If all forms are valid, `save` will be called on your form.
 """
 
+signup_form_fields = PluginSignal()
+"""
+This signal is sent out to get a list of form fields to show on the signup view, especially to collect
+user input for shift structures. Receivers will receive the ``shift``, ``participant``, ``participation``,
+and ``signup_choice`` and should return a dict in the form ``{ 'fieldname1': { 
+    'label':, ...,
+    'help_text':, ...,
+    'default': ...,
+    'required': ...,  # meaning a non-Falsey value must be provided
+    'form_class': ..., 
+    'form_kwargs': ..., 
+    'serializer_class': ..., 
+    'serializer_kwargs': ...,
+    }, 'fieldname2: { ... } }``.
+``label`` (only form), ``help_text`` (only form), ``default`` (only form, as ``initial``), and ``required``
+(form and serializer) will be applied to the kwargs dicts for convenience. Values specified directly
+as kwarg have precedence.
+"""
+
+
+def collect_signup_form_fields(shift, participant, participation, signup_choice):
+    responses = signup_form_fields.send(
+        sender=None,
+        shift=shift,
+        participant=participant,
+        participation=participation,
+        signup_choice=signup_choice,
+    )
+    for _, additional_fields in responses:
+        for fieldname, field in additional_fields.items():
+            yield fieldname, {
+                **field,
+                "form_kwargs": {
+                    "label": field["label"],
+                    "help_text": field.get("help_text", ""),
+                    "initial": field["default"],
+                    "required": field["required"],
+                    **field["form_kwargs"],
+                },
+                "serializer_kwargs": {
+                    "required": field["required"],
+                    **field["serializer_kwargs"],
+                },
+            }
+
+
+signup_save = PluginSignal()
+"""
+This signal is sent out to when a signup is created or modified to allow plugins to handle additional
+user input. Receivers will receive the ``shift``, ``participant``, ``participation``, ``signup_choice``,
+and ``cleaned_data``.
+"""
+
 register_notification_types = PluginSignal()
 """
 This signal is sent out to get all notification types that can be sent out to a user or participant.
@@ -150,7 +220,7 @@
 will contain a list of event ids on which the action should be performed.
 """
 
-event_action = PluginSignal()
+event_menu = PluginSignal()
 """
 This signal is sent out to get a list of actions that a user can perform on a single event. The actions are
 displayed in the dropdown menu on the event detail view.
@@ -276,6 +346,20 @@ def update_last_run_periodic_call(sender, **kwargs):
     LastRunPeriodicCall.set_last_call(timezone.now())
 
 
+@receiver(signup_form_fields, dispatch_uid="ephios.core.signals.provide_structure_form_fields")
+def provide_structure_form_fields(
+    sender, shift, participant, participation, signup_choice, **kwargs
+):
+    return shift.structure.get_signup_form_fields(participant, participation, signup_choice)
+
+
+@receiver(signup_save, dispatch_uid="ephios.core.signals.structure_signup_save")
+def structure_signup_save(
+    sender, shift, participant, participation, signup_choice, cleaned_data, **kwargs
+):
+    shift.structure.save_signup(participant, participation, signup_choice, cleaned_data)
+
+
 periodic_signal.connect(
     send_participation_finished, dispatch_uid="ephios.core.signals.send_participation_finished"
 )

ephios/core/signup/disposition.py

@@ -1,4 +1,5 @@
 from django import forms
+from django.db import transaction
 from django.http import Http404
 from django.shortcuts import redirect
 from django.utils.functional import cached_property
@@ -23,6 +24,7 @@
     ResponsibleParticipationStateChangeNotification,
 )
 from ephios.core.signup.forms import BaseParticipationForm
+from ephios.extra.database import OF_SELF
 from ephios.extra.mixins import CustomPermissionRequiredMixin
 
 
@@ -166,9 +168,12 @@ def post(self, request, *args, **kwargs):
         )
         if form.is_valid():
             user: UserProfile = form.cleaned_data["user"]
-            instance = shift.signup_flow.get_or_create_participation_for(user.as_participant())
-            instance.state = AbstractParticipation.States.GETTING_DISPATCHED
-            instance.save()
+            with transaction.atomic():
+                # lock user row in case to avoid duplicate participation objects
+                UserProfile.objects.select_for_update(of=OF_SELF).get(pk=user.pk)
+                instance = shift.signup_flow.get_or_create_participation_for(user.as_participant())
+                instance.state = AbstractParticipation.States.GETTING_DISPATCHED
+                instance.save()
 
             DispositionParticipationFormset = get_disposition_formset(
                 self.object.structure.disposition_participation_form_class

ephios/core/signup/forms.py

@@ -2,13 +2,14 @@
 from crispy_forms.helper import FormHelper
 from crispy_forms.layout import HTML, Field, Layout
 from django import forms
-from django.db import transaction
+from django.db import models, transaction
 from django.utils.formats import date_format
 from django.utils.timezone import localtime
 from django.utils.translation import gettext_lazy as _
 
 from ephios.core.models import AbstractParticipation, Shift
 from ephios.core.models.events import ParticipationComment
+from ephios.core.signals import collect_signup_form_fields
 from ephios.core.signup.flow.participant_validation import get_conflicting_participations
 from ephios.core.signup.participants import AbstractParticipant
 from ephios.core.widgets import PreviousCommentWidget
@@ -126,14 +127,15 @@ def get_customization_notification_info(self):
         return info
 
 
-class BaseSignupForm(BaseParticipationForm):
+class SignupForm(BaseParticipationForm):
+    class SignupChoices(models.TextChoices):
+        SIGNUP = "sign_up", _("Sign up")
+        CUSTOMIZE = "customize", _("Customize")
+        DECLINE = "decline", _("Decline")
+
     signup_choice = forms.ChoiceField(
         label=_("Signup choice"),
-        choices=[
-            ("sign_up", _("Sign up")),
-            ("customize", _("Customize")),
-            ("decline", _("Decline")),
-        ],
+        choices=SignupChoices.choices,
         widget=forms.HiddenInput,
         required=True,
     )
@@ -164,7 +166,7 @@ def _get_buttons(self):
         if self.shift.signup_flow.get_validator(self.participant).can_decline():
             buttons.append(
                 HTML(
-                    f'<button class="btn btn-secondary mt-1 ms-1 float-end" type="submit" name="signup_choice" value="decline">{_("Decline")}</button>'
+                    f'<button class="btn btn-secondary mt-1 ms-1 float-end" type="submit" name="signup_choice" value="decline" formnovalidate>{_("Decline")}</button>'
                 )
             )
         return buttons
@@ -173,6 +175,7 @@ def __init__(self, *args, **kwargs):
         self.shift: Shift = kwargs.pop("shift")
         self.participant: AbstractParticipant = kwargs.pop("participant")
         super().__init__(*args, **kwargs)
+        self._collect_fields()
         self.helper = FormHelper()
         self.helper.layout = Layout(
             self._get_field_layout(),
@@ -185,6 +188,12 @@ def __init__(self, *args, **kwargs):
             self.fields["individual_start_time"].disabled = True
             self.fields["individual_end_time"].disabled = True
 
+    def _collect_fields(self):
+        for fieldname, field in collect_signup_form_fields(
+            self.shift, self.participant, self.instance, self.data.get("signup_choice")
+        ):
+            self.fields[fieldname] = field["form_class"](**field.get("form_kwargs", {}))
+
     def clean(self):
         cleaned_data = super().clean()
         self._validate_conflicting_participations()

ephios/core/signup/structure/abstract.py

@@ -1,6 +1,9 @@
 import logging
 from abc import ABC
+from typing import Any
 
+from ephios.core.models.events import AbstractParticipation
+from ephios.core.signup.participants import AbstractParticipant
 from ephios.core.signup.stats import SignupStats
 
 logger = logging.getLogger(__name__)
@@ -49,12 +52,22 @@ def disposition_participation_form_class(self):
         """
         raise NotImplementedError()
 
-    @property
-    def signup_form_class(self):
-        """
-        This form will be used for participations in signup.
-        """
-        raise NotImplementedError()
+    def get_signup_form_fields(
+        self,
+        participant: AbstractParticipant,
+        participation: AbstractParticipation,
+        signup_choice,
+    ):
+        pass
+
+    def save_signup(
+        self,
+        participant: AbstractParticipant,
+        participation: AbstractParticipation,
+        signup_choice,
+        cleaned_data: dict[str, Any],
+    ):
+        pass
 
     def get_configuration_form(self, *args, **kwargs):
         """

ephios/core/signup/structure/base.py

@@ -7,7 +7,7 @@
 
 from ephios.core.models import AbstractParticipation
 from ephios.core.signup.disposition import BaseDispositionParticipationForm
-from ephios.core.signup.forms import BaseSignupForm, SignupConfigurationForm
+from ephios.core.signup.forms import SignupConfigurationForm
 from ephios.core.signup.stats import SignupStats
 from ephios.core.signup.structure.abstract import AbstractShiftStructure
 from ephios.extra.utils import format_anything
@@ -24,10 +24,6 @@ class BaseShiftStructure(AbstractShiftStructure):
     def disposition_participation_form_class(self):
         return BaseDispositionParticipationForm
 
-    @property
-    def signup_form_class(self):
-        return BaseSignupForm
-
     @property
     def configuration_form_class(self):
         return SignupConfigurationForm
@@ -36,6 +32,9 @@ def configuration_form_class(self):
     def shift_state_template_name(self):
         raise NotImplementedError()
 
+    def get_signup_form_fields(self, participant, participation, signup_choice):
+        return {}
+
     def get_participant_count_bounds(self):
         return None, None