feat: allow multi-language tearoff generation, store tearoffs on server

gardenerik · gardenerik · commit c265b3cfeb55 · 2024-11-11T00:07:50.000+01:00
diff --git a/bullet/bullet_admin/forms/competition.py b/bullet/bullet_admin/forms/competition.py
@@ -1,5 +1,6 @@
 from competitions.models import Competition
 from django import forms
+from django.core.validators import FileExtensionValidator
 from users.models import User
 
 
@@ -38,3 +39,14 @@ class Meta:
 
     def __init__(self, user: User, **kwargs):
         super().__init__(**kwargs)
+
+
+class TearoffUploadForm(forms.Form):
+    problems = forms.FileField(
+        label="Tearoff file",
+        help_text="A ZIP file containing one PDF for every language, "
+        "or a single PDF file. The file names should be the 2-letter language code.",
+        validators=[
+            FileExtensionValidator(["pdf", "zip"]),
+        ],
+    )
diff --git a/bullet/bullet_admin/forms/documents.py b/bullet/bullet_admin/forms/documents.py
@@ -1,8 +1,8 @@
 from competitions.models import Competition, Venue
 from django import forms
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from documents.models import CertificateTemplate, TexTemplate
-from pikepdf import Pdf
 from users.models import User
 
 
@@ -59,12 +59,6 @@ def __init__(self, competition: Competition, user: User, **kwargs):
 
 
 class TearoffForm(forms.Form):
-    problems = forms.FileField(
-        label="Problem file",
-        help_text=(
-            "A PDF file containing one problem per page (including last empty page)."
-        ),
-    )
     first_problem = forms.IntegerField(
         label="First problem",
         initial=1,
@@ -75,6 +69,9 @@ class TearoffForm(forms.Form):
         initial=0,
         min_value=0,
     )
+    backup_team_language = forms.ChoiceField(
+        label="Backup team language",
+    )
     ordering = forms.ChoiceField(
         label="Problem ordering",
         choices=[("align", "Aligned"), ("seq", "Sequential")],
@@ -83,27 +80,11 @@ class TearoffForm(forms.Form):
         label="Include QR code", initial=True, required=False
     )
 
-    def __init__(self, *, problems, first_problem, **kwargs):
+    def __init__(self, *, problems, first_problem, venue, **kwargs):
         super().__init__(**kwargs)
 
         self.fields["first_problem"].initial = first_problem
+        self.fields["backup_team_language"].choices = list(
+            filter(lambda lang: lang[0] in venue.accepted_languages, settings.LANGUAGES)
+        )
         self._problem_count = problems
-
-    def clean_problems(self):
-        pdf = None
-        try:
-            pdf = Pdf.open(self.cleaned_data["problems"])
-        except Exception:
-            if pdf:
-                pdf.close()
-            raise ValidationError("The uploaded file is not a valid PDF.")
-
-        if len(pdf.pages) != self._problem_count + 1:
-            pdf.close()
-            raise ValidationError(
-                f"The uploaded file does not have the correct number of pages. "
-                f"Expected {self._problem_count} + 1."
-            )
-
-        pdf.close()
-        return self.cleaned_data["problems"]
diff --git a/bullet/bullet_admin/templates/bullet_admin/competition/form.html b/bullet/bullet_admin/templates/bullet_admin/competition/form.html
@@ -18,6 +18,8 @@
                 {% if not object.results_public %}
                     {% url "badmin:competition_finalize" as finalize_url %}
                     {% #abtn label="Finalize results" icon="mdi:check" url=finalize_url %}
+                    {% url "badmin:competition_upload_tearoffs" as upload_url %}
+                    {% #abtn label="Upload tearoffs" icon="mdi:upload" url=upload_url %}
                 {% endif %}
             </div>
         </form>
diff --git a/bullet/bullet_admin/templates/bullet_admin/competition/tearoff.html b/bullet/bullet_admin/templates/bullet_admin/competition/tearoff.html
@@ -0,0 +1,4 @@
+{% extends "bullet_admin/generic/form.html" %}
+{% block before_form %}
+    <p class="mb-4">Current uploaded tearoff files: {{ available_langs|join:", " }}</p>
+{% endblock before_form %}
diff --git a/bullet/bullet_admin/urls/__init__.py b/bullet/bullet_admin/urls/__init__.py
@@ -55,6 +55,11 @@
         competition.CompetitionFinalizeView.as_view(),
         name="competition_finalize",
     ),
+    path(
+        "competitions/tearoff_upload/",
+        competition.CompetitionTearoffUploadView.as_view(),
+        name="competition_upload_tearoffs",
+    ),
     path(
         "competitions/automove/",
         competition.CompetitionAutomoveView.as_view(),
diff --git a/bullet/bullet_admin/utils.py b/bullet/bullet_admin/utils.py
@@ -12,7 +12,7 @@
     from competitions.models import Venue
 
 
-def get_active_competition(request: HttpRequest):
+def get_active_competition(request: HttpRequest) -> Competition:
     if not hasattr(request, "_badmin_competition"):
         session_key = f"badmin_{request.BRANCH.identifier}_competition"
         if session_key not in request.session:
diff --git a/bullet/bullet_admin/views/competition.py b/bullet/bullet_admin/views/competition.py
@@ -1,5 +1,11 @@
+import os.path
+import zipfile
+from operator import itemgetter
+
 from competitions.models import Competition
+from django.conf import settings
 from django.contrib import messages
+from django.core.files.storage import default_storage
 from django.forms import Form
 from django.shortcuts import redirect
 from django.urls import reverse
@@ -9,7 +15,7 @@
 from users.logic import move_all_eligible_teams
 
 from bullet_admin.access import BranchAdminAccess, UnlockedCompetitionMixin
-from bullet_admin.forms.competition import CompetitionForm
+from bullet_admin.forms.competition import CompetitionForm, TearoffUploadForm
 from bullet_admin.utils import get_active_competition
 from bullet_admin.views import GenericForm
 
@@ -81,3 +87,62 @@ def form_valid(self, form):
             self.request, "The teams will be moved to the competition shortly."
         )
         return redirect("badmin:home")
+
+
+class CompetitionTearoffUploadView(
+    UnlockedCompetitionMixin, BranchAdminAccess, GenericForm, FormView
+):
+    form_class = TearoffUploadForm
+    form_title = "Tearoff upload"
+    form_multipart = True
+    template_name = "bullet_admin/competition/tearoff.html"
+
+    def get_upload_folder(self):
+        competition = get_active_competition(self.request)
+        return str(competition.secret_dir / "tearoffs")
+
+    def get_context_data(self, **kwargs):
+        ctx = super().get_context_data(**kwargs)
+        path = self.get_upload_folder()
+        if not default_storage.exists(path):
+            ctx["available_langs"] = []
+        else:
+            ctx["available_langs"] = default_storage.listdir(path)[1]
+        return ctx
+
+    def is_valid_name(self, name):
+        return name in map(itemgetter(0), settings.LANGUAGES)
+
+    def upload_zip(self, problems):
+        target_dir = default_storage.path(self.get_upload_folder())
+
+        with zipfile.ZipFile(problems) as zipf:
+            for file in zipf.namelist():
+                name, extension = os.path.splitext(file)
+                if extension != ".pdf":
+                    continue
+
+                if not self.is_valid_name(name):
+                    continue
+
+                zipf.extract(file, target_dir)
+
+    def upload_pdf(self, problems):
+        name, extension = os.path.splitext(problems.name)
+        if not self.is_valid_name(name):
+            return
+        path = os.path.join(self.get_upload_folder(), problems.name)
+        if default_storage.exists(path):
+            default_storage.delete(path)
+        default_storage.save(path, problems)
+
+    def form_valid(self, form):
+        problems = form.cleaned_data["problems"]
+
+        if problems.name.endswith(".zip"):
+            self.upload_zip(problems)
+        else:
+            self.upload_pdf(problems)
+
+        messages.success(self.request, "Tearoffs uploaded successfully.")
+        return redirect("badmin:competition_upload_tearoffs")
diff --git a/bullet/bullet_admin/views/venues.py b/bullet/bullet_admin/views/venues.py
@@ -1,7 +1,10 @@
+from pathlib import Path
+
 from competitions.models import Venue
 from django.contrib import messages
+from django.core.files.storage import default_storage
 from django.forms import Form
-from django.http import FileResponse, HttpResponseRedirect
+from django.http import FileResponse, HttpResponse, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, redirect
 from django.urls import reverse, reverse_lazy
 from django.utils.functional import cached_property
@@ -14,7 +17,7 @@
 )
 from documents.generators.certificate import certificates_for_venue
 from documents.generators.team_list import team_list
-from documents.generators.tearoff import TearoffGenerator
+from documents.generators.tearoff import TearoffGenerator, TearoffRequirementMissing
 from documents.models import TexJob
 from problems.logic.results import save_country_ranks, save_venue_ranks
 from problems.models import CategoryProblem, Problem
@@ -207,25 +210,48 @@ def get_form_kwargs(self):
             .first()
         )
         kw["problems"] = problem_count
+        kw["venue"] = self.venue
         kw["first_problem"] = first_problem.number if first_problem else 1
         return kw
 
     def form_valid(self, form):
-        t = TearoffGenerator(form.cleaned_data["problems"])
+        competition = self.venue.category.competition
+
+        try:
+            tearoff_dir = Path(
+                default_storage.path(competition.secret_dir / "tearoffs")
+            )
+            t = TearoffGenerator(tearoff_dir, form.cleaned_data["backup_team_language"])
+        except TearoffRequirementMissing as e:
+            return HttpResponse(str(e), status=500)
+
         teams = list(
             Team.objects.competing()
             .filter(venue=self.venue, number__isnull=False)
             .all()
         )
+
         for i in range(form.cleaned_data["backup_teams"]):
-            teams.append(Team(venue=self.venue, name="???", number=999 - i))
-        data = t.generate_pdf(
-            teams,
-            form.cleaned_data["first_problem"],
-            form.cleaned_data["ordering"],
-            form.cleaned_data["include_qr_codes"],
-        )
-        return FileResponse(data, filename="tearoffs.pdf")
+            teams.append(
+                Team(
+                    venue=self.venue,
+                    language=form.cleaned_data["backup_team_language"],
+                    name="???",
+                    number=999 - i,
+                )
+            )
+
+        try:
+            data = t.generate_pdf(
+                teams,
+                form.cleaned_data["first_problem"],
+                form._problem_count,
+                form.cleaned_data["ordering"],
+                form.cleaned_data["include_qr_codes"],
+            )
+            return FileResponse(data, filename="tearoffs.pdf")
+        except TearoffRequirementMissing as e:
+            return HttpResponse(str(e), status=500)
 
 
 class FinishReviewView(VenueMixin, RedirectBackMixin, GenericForm, FormView):
diff --git a/bullet/documents/generators/tearoff.py b/bullet/documents/generators/tearoff.py
