feat: team list PDF generation without personal data (#986)

Author: gardenerik

bullet/bullet_admin/forms/documents.py

@@ -1,9 +1,8 @@
-from competitions.models import Competition, Venue
+from competitions.models import Competition
 from django import forms
 from django.conf import settings
 from django.core.exceptions import ValidationError
 from documents.models import CertificateTemplate, TexTemplate
-from users.models import User
 
 
 class CertificateForm(forms.Form):
@@ -50,14 +49,6 @@ def clean(self):
         return self.cleaned_data
 
 
-class TeamListForm(forms.Form):
-    venue = forms.ModelChoiceField(queryset=Venue.objects.none())
-
-    def __init__(self, competition: Competition, user: User, **kwargs):
-        super().__init__(**kwargs)
-        self.fields["venue"].queryset = Venue.objects.for_user(competition, user)
-
-
 class TearoffForm(forms.Form):
     first_problem = forms.IntegerField(
         label="First problem",

bullet/bullet_admin/forms/venues.py

@@ -76,3 +76,14 @@ def clean_shortcode(self):
         if not prefix_re.match(data):
             raise ValidationError("Barcode prefix must contain only capital letters.")
         return data
+
+
+class TeamListForm(forms.Form):
+    include_contact = forms.BooleanField(
+        required=False, label="Include contact information", initial=True
+    )
+    include_contestants = forms.BooleanField(
+        required=False,
+        label="Include contestants",
+        initial=True,
+    )

bullet/bullet_admin/templates/bullet_admin/documents/team_list.html

@@ -26,7 +26,7 @@
 
 from bullet_admin.access import AdminAccess, CountryAdminAccess, VenueAccess
 from bullet_admin.forms.documents import CertificateForm, TearoffForm
-from bullet_admin.forms.venues import VenueForm
+from bullet_admin.forms.venues import TeamListForm, VenueForm
 from bullet_admin.mixins import AdminRequiredMixin, RedirectBackMixin
 from bullet_admin.utils import get_active_competition
 from bullet_admin.views import GenericForm, GenericList
@@ -160,13 +160,14 @@ def form_valid(self, form):
 
 class TeamListView(VenueMixin, GenericForm, FormView):
     require_unlocked_competition = False
-    form_class = Form
+    form_class = TeamListForm
 
     def form_valid(self, form):
         venue = self.venue
         data = team_list(
             Team.objects.competing().filter(venue=venue, number__isnull=False),
             f"Team list: {venue.name}",
+            **form.cleaned_data,
         )
         return FileResponse(data, as_attachment=True, filename="team_list.pdf")
 

bullet/bullet_admin/views/venues.py

@@ -9,7 +9,9 @@
 from documents.generators.reportlab_utils import prepare_pdf, render_table
 
 
-def team_list(teams: QuerySet, title: str) -> io.BytesIO:
+def team_list(
+    teams: QuerySet, title: str, include_contact=True, include_contestants=True
+) -> io.BytesIO:
     teams = (
         teams.order_by("number")
         .prefetch_related("contestants")
@@ -46,43 +48,56 @@ def team_list(teams: QuerySet, title: str) -> io.BytesIO:
     )
 
     data = []
-    data.append(
-        [
-            Paragraph("Number", style_bold),
-            Paragraph("School", style_bold),
-            Paragraph("Contact information", style_bold),
-            Paragraph("Contestants", style_bold),
-        ]
-    )
+    header = [
+        Paragraph("Number", style_bold),
+        Paragraph("School", style_bold),
+    ]
+    if include_contact:
+        header.append(Paragraph("Contact information", style_bold))
+    if include_contestants:
+        header.append(Paragraph("Contestants", style_bold))
+    data.append(header)
 
     for team in teams:
         contact = []
         if team.contact_email:
             contact.append(team.contact_email)
         if team.contact_phone:
             contact.append(team.contact_phone_pretty)
-        data.append(
+
+        row: list = [
             [
-                [
-                    Paragraph(
-                        f"{team.venue.shortcode}<b>{team.number:03d}</b>", style_code
-                    ),
-                    Paragraph(team.id_display, style_code_small),
-                ],
-                [
-                    Paragraph(team.school.name, style_base),
-                    Paragraph(team.school.address, style_small),
-                ],
+                Paragraph(
+                    f"{team.venue.shortcode}<b>{team.number:03d}</b>", style_code
+                ),
+                Paragraph(team.id_display, style_code_small),
+            ],
+            [
+                Paragraph(
+                    f"{team.school.name}<b> {team.in_school_symbol or ''}</b>",
+                    style_base,
+                ),
+                Paragraph(team.school.address, style_small),
+            ],
+        ]
+
+        if include_contact:
+            row.append(
                 [
                     Paragraph(team.contact_name, style_base),
                     Paragraph("<br/>".join(contact), style_small),
-                ],
+                ]
+            )
+
+        if include_contestants:
+            row.append(
                 Paragraph(
                     "<br/>".join([c.full_name for c in team.contestants.all()]),
                     style_small,
-                ),
-            ]
-        )
+                )
+            )
+
+        data.append(row)
 
     story = []
     story.append(Paragraph(title, style_title))