Add survey feature

survey/admin.py

@@ -0,0 +1,13 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from django.contrib import admin
+
+from .models import Survey
+
+
+@admin.register(Survey)
+class SurveyAdmin(admin.ModelAdmin):
+    list_display = ('survey_id', 'name', 'invite_team', 'invite_coaches', 'tournament',)
+    list_filter = ('invite_team', 'invite_coaches', 'tournament',)
+    search_fields = ('name',)

survey/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SurveyConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "survey"

survey/forms.py

@@ -0,0 +1,28 @@
+from django import forms
+
+from .models import Survey
+
+
+class SurveyForm(forms.ModelForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if 'survey_id' in self.initial:
+            self.fields['survey_id'].disabled = True
+
+    class Meta:
+        model = Survey
+        exclude = ('completed_registrations', 'completed_teams',)
+        widgets = {
+            'completed_registrations': forms.SelectMultiple(attrs={
+                'class': 'selectpicker',
+                'data-live-search': 'true',
+                'data-live-search-normalize': 'true',
+                'data-width': 'fit',
+            }),
+            'completed_teams': forms.SelectMultiple(attrs={
+                'class': 'selectpicker',
+                'data-live-search': 'true',
+                'data-live-search-normalize': 'true',
+                'data-width': 'fit',
+            }),
+        }

survey/management/commands/fetch_survey_completion_data.py

@@ -0,0 +1,13 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from django.conf import settings
+from django.core.management import BaseCommand
+
+from ...models import Survey
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **kwargs):
+        for survey in Survey.objects.all():
+            survey.fetch_completion_data()

survey/migrations/0001_initial.py

@@ -0,0 +1,83 @@
+# Generated by Django 5.1.5 on 2025-03-19 21:12
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        (
+            "participation",
+            "0023_tournament_unified_registration",
+        ),
+        ("registration", "0014_participantregistration_country"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Survey",
+            fields=[
+                (
+                    "survey_id",
+                    models.IntegerField(
+                        help_text="The numeric identifier of the Limesurvey.",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="survey identifier",
+                    ),
+                ),
+                ("name", models.CharField(max_length=255, verbose_name="display name")),
+                (
+                    "invite_team",
+                    models.BooleanField(
+                        default=False,
+                        help_text="When this field is checked, teams will get only one survey invitation instead of one per person.",
+                        verbose_name="invite whole team",
+                    ),
+                ),
+                (
+                    "invite_coaches",
+                    models.BooleanField(
+                        default=True,
+                        help_text="When this field is checked, coaches will also be invited in the survey. No effect when the whole team is invited.",
+                        verbose_name="invite coaches",
+                    ),
+                ),
+                (
+                    "completed_registrations",
+                    models.ManyToManyField(
+                        related_name="completed_surveys",
+                        to="registration.participantregistration",
+                        verbose_name="participants that completed the survey",
+                    ),
+                ),
+                (
+                    "completed_teams",
+                    models.ManyToManyField(
+                        related_name="completed_surveys",
+                        to="participation.team",
+                        verbose_name="teams that completed the survey",
+                    ),
+                ),
+                (
+                    "tournament",
+                    models.ForeignKey(
+                        blank=True,
+                        default=None,
+                        help_text="When this field is filled, the survey participants will be restricted to this tournament members.",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="participation.tournament",
+                        verbose_name="tournament restriction",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "survey",
+                "verbose_name_plural": "surveys",
+            },
+        ),
+    ]

survey/models.py

@@ -0,0 +1,134 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from citric import Client
+from django.conf import settings
+from django.db import models
+from django.urls import reverse_lazy
+from django.utils.translation import gettext_lazy as _
+
+from participation.models import Team, Tournament
+from registration.models import ParticipantRegistration, StudentRegistration
+
+
+class Survey(models.Model):
+    """
+    Ce modèle représente un sondage LimeSurvey afin de faciliter l'import des
+    participant⋅es au sondage et d'effectuer le suivi.
+    """
+    survey_id = models.IntegerField(
+        primary_key=True,
+        verbose_name=_("survey identifier"),
+        help_text=_("The numeric identifier of the Limesurvey."),
+    )
+
+    name = models.CharField(
+        max_length=255,
+        verbose_name=_("display name"),
+    )
+
+    invite_team = models.BooleanField(
+        default=False,
+        verbose_name=_("invite whole team"),
+        help_text=_("When this field is checked, teams will get only one survey invitation instead of one per person."),
+    )
+
+    invite_coaches = models.BooleanField(
+        default=True,
+        verbose_name=_("invite coaches"),
+        help_text=_("When this field is checked, coaches will also be invited in the survey. No effect when the whole team is invited."),
+    )
+
+    tournament = models.ForeignKey(
+        Tournament,
+        null=True,
+        blank=True,
+        default=None,
+        on_delete=models.SET_NULL,
+        verbose_name=_("tournament restriction"),
+        help_text=_("When this field is filled, the survey participants will be restricted to this tournament members."),
+    )
+
+    completed_registrations = models.ManyToManyField(
+        ParticipantRegistration,
+        related_name="completed_surveys",
+        verbose_name=_("participants that completed the survey"),
+    )
+
+    completed_teams = models.ManyToManyField(
+        Team,
+        related_name="completed_surveys",
+        verbose_name=_("teams that completed the survey"),
+    )
+
+    @property
+    def participants(self):
+        if self.invite_team:
+            teams = Team.objects.filter(participation__valid=True)
+            if self.tournament:
+                teams = teams.filter(participation__tournament=self.tournament)
+            return teams.all()
+        else:
+            if self.invite_coaches:
+                registrations = ParticipantRegistration.objects.filter(team__participation__valid=True)
+            else:
+                registrations = StudentRegistration.objects.filter(team__participation__valid=True)
+            if self.tournament:
+                registrations = registrations.filter(team__participation__tournament=self.tournament)
+            return registrations.all()
+
+    @property
+    def completed(self):
+        if self.invite_team:
+            return self.completed_teams
+        else:
+            return self.completed_registrations
+
+    def get_absolute_url(self):
+        return reverse_lazy("survey:survey_detail", args=(self.survey_id,))
+
+    def generate_participants_data(self):
+        participants_data = []
+        if self.invite_team:
+            for team in self.participants:
+                participant_data = {"firstname": team.name, "lastname": f"(équipe {team.trigram})", "email": team.email}
+                participants_data.append(participant_data)
+        else:
+            for reg in self.participants:
+                participant_data = {"firstname": reg.user.first_name, "lastname": reg.user.last_name, "email": reg.user.email}
+                participants_data.append(participant_data)
+        return participants_data
+
+    def invite_all(self):
+        participants_data = self.generate_participants_data()
+        with Client(f"{settings.LIMESURVEY_URL}/index.php/admin/remotecontrol", settings.LIMESURVEY_USER, settings.LIMESURVEY_PASSWORD) as client:
+            try:
+                current_participants = client.list_participants(self.survey_id, limit=10000)
+            except:
+                current_participants = []
+            current_participants_email = set(participant['participant_info']['email'] for participant in current_participants)
+            participants_data = [participant_data for participant_data in participants_data if participant_data['email'] not in current_participants_email]
+            try:
+                client.activate_tokens(self.survey_id)
+            except:
+                pass
+            new_participants = client.add_participants(self.survey_id, participant_data=participants_data)
+            if new_participants:
+                client.invite_participants(self.survey_id, token_ids=[participant['tid'] for participant in new_participants])
+            return new_participants
+
+    def fetch_completion_data(self):
+        with Client(f"{settings.LIMESURVEY_URL}/index.php/admin/remotecontrol", settings.LIMESURVEY_USER, settings.LIMESURVEY_PASSWORD) as client:
+            participants = client.list_participants(self.survey_id, limit=10000, attributes=['completed'])
+        if self.invite_team:
+            team_names = [participant['participant_info']['firstname'] for participant in participants if participant['completed'] != 'N']
+            self.completed_teams.set(list(Team.objects.filter(name__in=team_names).values_list('id', flat=True)))
+        else:
+            mails = [participant['participant_info']['email'] for participant in participants if participant['completed'] != 'N']
+            self.completed_registrations.set(list(ParticipantRegistration.objects.filter(user__email__in=mails).values_list('id', flat=True)))
+        self.save()
+
+
+    class Meta:
+        verbose_name = _("survey")
+        verbose_name_plural = _("surveys")

survey/tables.py

@@ -0,0 +1,31 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from django.utils.translation import gettext_lazy as _
+import django_tables2 as tables
+
+from .models import Survey
+
+
+class SurveyTable(tables.Table):
+    survey_id = tables.LinkColumn(
+        'survey:survey_detail',
+        args=[tables.A('survey_id')],
+        verbose_name=lambda: _("survey identifier").capitalize(),
+    )
+
+    nb_completed = tables.Column(
+        verbose_name=_("completed").capitalize,
+        accessor='survey_id'
+    )
+
+    def render_nb_completed(self, record):
+        return f"{record.completed.count()}/{record.participants.count()}"
+
+    class Meta:
+        attrs = {
+            'class': 'table table-condensed table-striped',
+        }
+        model = Survey
+        fields = ('survey_id', 'name', 'invite_team', 'invite_coaches', 'tournament', 'nb_completed',)
+        order_by = ('survey_id',)

survey/templates/survey/survey_detail.html

@@ -0,0 +1,84 @@
+{% extends "base.html" %}
+
+{% load i18n %}
+{% load crispy_forms_filters %}
+
+{% block content %}
+    <div class="card bg-body shadow">
+        <div class="card-header text-center">
+            <h4>
+                {% trans "survey"|capfirst %} {{ survey.survey_id }}
+                <a href="{{ TFJM.LIMESURVEY_URL }}/index.php/{{ survey.survey_id }}" target="_blank"><i class="fas fa-arrow-up-right-from-square"></i></a>
+            </h4>
+        </div>
+        <div class="card-body">
+            <dl class="row">
+                <dt class="col-sm-6 text-sm-end">{% trans "Name:" %}</dt>
+                <dd class="col-sm-6">{{ survey.name }}</dd>
+
+                <dt class="col-sm-6 text-sm-end">{% trans "One answer per team:" %}</dt>
+                <dd class="col-sm-6">{{ survey.invite_team|yesno }}</dd>
+
+                {% if not survey.invite_team %}
+                    <dt class="col-sm-6 text-sm-end">{% trans "Coaches can answer the survey:" %}</dt>
+                    <dd class="col-sm-6">{{ survey.invite_coaches|yesno }}</dd>
+                {% endif %}
+
+                {% if survey.tournament %}
+                    <dt class="col-sm-6 text-sm-end">{% trans "Tournament restriction:" %}</dt>
+                    <dd class="col-sm-6">{{ survey.tournament }}</dd>
+                {% endif %}
+
+                <dt class="col-sm-6 text-sm-end">{% trans "Completion rate:" %}</dt>
+                <dd class="col-sm-6">
+                    {{ survey.completed.count }}/{{ survey.participants.count }}
+                    <a href="{% url "survey:survey_refresh_completed" pk=survey.pk %}"><i class="fas fa-arrow-rotate-right" alt="refresh"></i></a>
+                </dd>
+            </dl>
+        </div>
+        <div class="card-footer text-center">
+            <button class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#updateSurveyModal">{% trans "Update" %}</button>
+            <a class="btn btn-secondary" href="{% url "survey:survey_invite" pk=survey.pk %}">{% trans "Send invites" %}</a>
+        </div>
+    </div>
+
+    <hr>
+
+    <table class="table table-condensed table-striped">
+        <thead>
+            <tr>
+                <th>{% trans "participant"|capfirst %}</th>
+                <th>{% trans "completed"|capfirst %}</th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for participant in survey.participants %}
+                <tr class="{% if participant in survey.completed.all %}table-success{% else %}table-danger{% endif %}">
+                    {% if survey.invite_team %}
+                        <td>{% trans "Team" %} {{ participant.name }} ({{ participant.trigram }})</td>
+                    {% else %}
+                        <td>{{ participant.user.first_name }} {{ participant.user.last_name }} ({% trans "team" %} {{ participant.team.trigram }})</td>
+                    {% endif %}
+                    {% if participant in survey.completed.all %}
+                        <td>{% trans "Yes" %}</td>
+                    {% else %}
+                        <td>{% trans "No" %}</td>
+                    {% endif %}
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+
+    {% trans "Update survey" as modal_title %}
+    {% trans "Update" as modal_button %}
+    {% url "survey:survey_update" pk=survey.pk as modal_action %}
+    {% include "base_modal.html" with modal_id="updateSurvey" %}
+{% endblock %}
+
+{% block extrajavascript %}
+    <script>
+        document.addEventListener('DOMContentLoaded', () => {
+            initModal("updateSurvey", "{% url "survey:survey_update" pk=survey.pk %}")
+        })
+    </script>
+{% endblock %}

survey/templates/survey/survey_form.html

@@ -0,0 +1,17 @@
+{% extends request.content_only|yesno:"empty.html,base.html" %}
+
+{% load crispy_forms_filters i18n %}
+
+{% block content %}
+    <form method="post">
+        <div id="form-content">
+            {% csrf_token %}
+            {{ form|crispy }}
+        </div>
+        {% if object.pk %}
+            <button class="btn btn-primary" type="submit">{% trans "Update" %}</button>
+        {% else %}
+            <button class="btn btn-success" type="submit">{% trans "Create" %}</button>
+        {% endif %}
+    </form>
+{% endblock content %}

survey/templates/survey/survey_list.html

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+
+{% load django_tables2 i18n %}
+
+{% block content %}
+    <div class="d-grid">
+        <a href="{% url "survey:survey_create" %}" class="btn gap-0 btn-success">
+            <i class="fas fa-square-poll-horizontal"></i> {% trans "Add survey" %}
+        </a>
+    </div>
+    <hr>
+
+    {% render_table table %}
+{% endblock %}

survey/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

survey/urls.py

@@ -0,0 +1,18 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from django.urls import path
+
+from .views import SurveyCreateView, SurveyDetailView, SurveyInviteView, \
+    SurveyListView, SurveyRefreshCompletedView, SurveyUpdateView
+
+app_name = "survey"
+
+urlpatterns = [
+    path("", SurveyListView.as_view(), name="survey_list"),
+    path("create/", SurveyCreateView.as_view(), name="survey_create"),
+    path("<int:pk>/", SurveyDetailView.as_view(), name="survey_detail"),
+    path("<int:pk>/invite/", SurveyInviteView.as_view(), name="survey_invite"),
+    path("<int:pk>/refresh/", SurveyRefreshCompletedView.as_view(), name="survey_refresh_completed"),
+    path("<int:pk>/update/", SurveyUpdateView.as_view(), name="survey_update"),
+]

survey/views.py

@@ -0,0 +1,56 @@
+# Copyright (C) 2025 by Animath
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from django.contrib import messages
+from django.shortcuts import redirect
+from django.utils.translation import gettext_lazy as _
+from django.views.generic import CreateView, DetailView, UpdateView
+from django_tables2 import SingleTableView
+
+from tfjm.views import AdminMixin
+from .forms import SurveyForm
+from .models import Survey
+from .tables import SurveyTable
+
+
+class SurveyListView(AdminMixin, SingleTableView):
+    model = Survey
+    table_class = SurveyTable
+    template_name = "survey/survey_list.html"
+
+
+class SurveyCreateView(AdminMixin, CreateView):
+    model = Survey
+    form_class = SurveyForm
+
+
+class SurveyDetailView(AdminMixin, DetailView):
+    model = Survey
+
+
+class SurveyInviteView(AdminMixin, DetailView):
+    model = Survey
+
+    def get(self, request, *args, **kwargs):
+        survey = self.get_object()
+        new_participants = survey.invite_all()
+        if new_participants:
+            messages.success(request, _("Invites sent!"))
+        else:
+            messages.warning(request, _("All invites were already sent."))
+        return redirect("survey:survey_detail", survey.pk)
+
+
+class SurveyRefreshCompletedView(AdminMixin, DetailView):
+    model = Survey
+
+    def get(self, request, *args, **kwargs):
+        survey = self.get_object()
+        survey.fetch_completion_data()
+        messages.success(request, _("Completion data refreshed!"))
+        return redirect("survey:survey_detail", survey.pk)
+
+
+class SurveyUpdateView(AdminMixin, UpdateView):
+    model = Survey
+    form_class = SurveyForm