Merge branch 'dev-team-csvs' into dev

Author: mmcinnestaylor

Dockerfile

@@ -1,8 +1,8 @@
 FROM python:3.10-slim
 LABEL maintainer="ACM at FSU <contact@fsu.acm.org>"
 
-ENV PYTHONUNBUFFERED 1
-ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED=1
+ENV PYTHONDONTWRITEBYTECODE=1
 
 ARG REQUIREMENTS=requirements.txt
 
@@ -30,6 +30,7 @@ RUN pip install --no-cache-dir -r /tmp/requirements.txt \
   && install -d -m 0755 -o app_user -g app_user /app/media \
   && install -d -m 0755 -o app_user -g app_user /app/media/contest_files \
   && install -d -m 0755 -o app_user -g app_user /app/media/ec_files \
+  && install -d -m 0755 -o app_user -g app_user /app/media/team_files \
   && install -d -m 0755 -o app_user -g app_user /app/media/uploads
 
 # Code and User Setup

src/contestadmin/tasks.py

@@ -266,6 +266,38 @@ def generate_ec_reports():
         f'Processed extra credit files for {num_courses} courses')
 
 
+@shared_task
+def generate_team_csvs():
+    """
+    Celery task which creates CSV files containing team data per division.
+    """
+    
+    for division in Team.DIVISION:
+        if division[0] == 1:  # Upper
+            team_file = f"{MEDIA_ROOT}/team_files/upper.csv"
+        else:  # Lower
+            team_file = f"{MEDIA_ROOT}/team_files/lower.csv"
+
+        with open(team_file, 'w', newline='') as team_csv:        
+            writer = csv.writer(
+                team_csv, delimiter=',', quoting=csv.QUOTE_MINIMAL)
+            
+            # File header
+            writer.writerow(['team_division', 'team_name', 'questions_answered', 'domjudge_id', 'team_active', 'team_members'])
+            
+            # Team data
+            teams = Team.objects.filter(division=division[0])
+            for team in teams:
+                writer.writerow([
+                    team.get_division_code(),
+                    team.name,
+                    team.questions_answered,
+                    team.contest_id,
+                    'T' if team.is_active() else 'F',
+                    '_'.join(team.get_members())
+                ])
+
+
 @shared_task
 def email_faculty(domain):
     """

src/contestadmin/templates/contestadmin/dashboard.html

@@ -104,6 +104,14 @@ <h1 class="text-center">Contest Dashboard</h1>
 				<i class="fa-solid fa-wrench fa-fw"></i> Contest Tools 
 			</div>
 			<div class="card-body overflow-auto">
+				<div class="row justify-content-center">
+					<a class="btn btn-primary btn-sm my-1" href="{% url 'generate_team_csvs' %}" onclick="return confirm('Are you certain you want to generate the team data CSVs?');"><i class="fa-solid fa-file-circle-plus fa-fw"></i> Generate Team CSVs</a>
+					{% if team_csvs_available %}					
+						<a class="btn text-dark" href="{% url 'download_team_csvs' %}" role="button"><i class="fa fa-download fa-md" aria-hidden="true"></i></a>
+					{% else %}
+						<a class="btn text-secondary disabled" href="#" role="button"><i class="fa fa-download fa-md" aria-hidden="true"></i></a>
+					{% endif %}
+				</div>
 				<div class="row justify-content-center">
 					<button type="button" class="btn btn-primary btn-sm my-1" data-toggle="modal" data-target="#walkinModal"> <i class="fa-solid fa-person-walking fa-fw"></i> Create Walk-in teams</button>
 				</div>

src/contestadmin/urls.py

@@ -15,5 +15,7 @@
     path('ec_files/generate', login_required((user_passes_test(contestadmin_auth, login_url='/', redirect_field_name=None))(views.GenerateExtraCreditReports.as_view())), name='gen_ec_reports'),
     path('faculty/<uidb64>/', views.FacultyDashboard.as_view(), name='fac_ec_dashboard'),
     path('faculty/<uidb64>/download', views.FacultyDashboard.download, name='fac_ec_files_dl'),
-    path('statistics/', views.contest_statistics, name='contest_stats')
+    path('statistics/', views.contest_statistics, name='contest_stats'),
+    path('team_csvs/generate', views.ExportTeamData.as_view(), name='generate_team_csvs'),
+    path('team_csvs/download', views.ExportTeamData.download, name='download_team_csvs')
 ]

src/contestadmin/utils.py

@@ -1,7 +1,19 @@
+from django.contrib.auth.mixins import UserPassesTestMixin
+
 """
 Functions useable by @user_passes_test view decorator. Each function accepts a User object
 as its only parameter.
 """
 
 def contestadmin_auth(user):
-	return user.profile.role == 5 or user.is_superuser
+    return user.profile.role == 5 or user.is_superuser
+
+
+class ContestAdminAuthMixin(UserPassesTestMixin):
+    """
+    Mixin which integrates the contestadmin_auth test into a UserPassesTestMixin.
+    - Enables class based view support of the test.
+    """
+
+    def test_func(self):
+        return contestadmin_auth(self.request.user)

src/contestadmin/views.py

@@ -1,8 +1,9 @@
 import os
 
 from django.contrib import messages
-from django.contrib.auth.models import User
 from django.contrib.auth.decorators import login_required, user_passes_test
+from django.contrib.auth.mixins import LoginRequiredMixin
+from django.contrib.auth.models import User
 from django.db import transaction
 from django.http import HttpResponse
 from django.utils.encoding import force_str
@@ -15,7 +16,7 @@
 
 from . import forms
 from . import tasks
-from .utils import contestadmin_auth
+from .utils import contestadmin_auth, ContestAdminAuthMixin
 from contestadmin.models import Contest
 from contestsuite.settings import MEDIA_ROOT
 from lfg.models import LFGProfile
@@ -192,6 +193,53 @@ def get(self, request):
         return redirect('admin_dashboard')
 
 
+class ExportTeamData(LoginRequiredMixin, ContestAdminAuthMixin, View):
+    """
+    View which creates and serves a zip file containing contest team data per division.
+    """
+
+    def get(self, request):
+        """
+        Schedules generation of CSV files.
+        """
+
+        tasks.generate_team_csvs.delay()
+        messages.info(request, 'Team data CSVs generation scheduled.', fail_silently=True)
+
+        return redirect('admin_dashboard')
+
+    def download(self):
+        """
+        Serves a ZIP file containing all team data CSV files. 
+        """
+        
+        fpath = f"{MEDIA_ROOT}/team_files/"
+
+        # Initialize zip file
+        in_memory = BytesIO()
+        zip = ZipFile(in_memory, 'a')
+
+        # Add team csvs to zip file
+        for fname in os.listdir(fpath):
+            zip.write(fpath+fname, fname)
+
+        # fix for Linux zip files read in Windows
+        for file in zip.filelist:
+            file.create_system = 0 
+
+        zip.close()
+
+        # Initialize response
+        response = HttpResponse(content_type='application/zip')
+        response['Content-Disposition'] = 'attachment; filename=team_data_csvs.zip'
+        
+        # Write zip file to response
+        in_memory.seek(0)    
+        response.write(in_memory.read())
+        
+        return response
+    
+
 @login_required
 @user_passes_test(contestadmin_auth, login_url='/', redirect_field_name=None)
 @transaction.atomic
@@ -324,6 +372,9 @@ def dashboard(request):
         context['dj_files_available'] = True
     else:
         context['dj_files_available'] = False
+
+    # Determine if team CSVs have been generated
+    context['team_csvs_available'] = True if len(os.listdir(f"{MEDIA_ROOT}/team_files/")) > 0 else False
 
     # Volunteer card data
     context['volunteers'] = [user for user in Profile.objects.order_by('role').all() if user.is_volunteer()]