Add participant progress bar

evap/settings.py

@@ -352,6 +352,17 @@ class ManifestStaticFilesStorageWithJsReplacement(ManifestStaticFilesStorage):
 # Absolute filesystem path to the directory that will hold user-uploaded files.
 MEDIA_ROOT = os.path.join(BASE_DIR, "upload")
 
+### Evaluation progress rewards
+GLOBAL_EVALUATION_PROGRESS_REWARDS: list[tuple[float, str]] = [
+    (0, "0€"),
+    (0.25, "1.000€"),
+    (0.6, "3.000€"),
+    (0.7, "7.000€"),
+    (0.9, "10.000€"),
+]
+EXCLUDED_COURSE_TYPE_IDS: list[int] = []
+EXCLUDED_EVALUATION_IDS: list[int] = []
+PARTICIPANT_PROGRESS_TEXT = "Deine Teilnahme am Evaluationsprojekt wird helfen. Evaluiere also <b>jetzt</b>!"
 
 ### Slogans
 SLOGANS_DE = [

evap/student/templates/student_index.html

@@ -16,7 +16,40 @@
             </div>
         </div>
     {% endif %}
+{% if global_progress_rewards %}
+    <div class="card mb-3">
+        <div class="card-header">Nächstes Spendenziel: {{ next_reward }}</div>
+        <div class="card-body">
+            <div>
+                noch {{ remaining_votes }} Evaluierungen benötigt
+            </div>
 
+            <div class="position-relative d-grid py-2 px-4">
+            <span class="progress-container d-flex" style="height: 25px; grid-column-start: 1; grid-row-start: 1">
+                <span class="progress m-0 bg-info">
+                    <span class="progress-bar progress-bar-striped progress-bar-animated bg-success width-percent-{% widthratio num_total_votes final_goal 100 %}"></span>
+                    <span class="progress-bartext">
+                        {{ num_total_votes }}/{{ final_goal }}
+                    </span>
+                </span>
+            </span>
+                {% for ratio, global_ratio, tag in global_progress_rewards %}
+                    <div class="position-relative "
+                         style="left: {% widthratio ratio 1 100 %}%; transform: translateX(-50%); width: fit-content;grid-column-start: 1; grid-row-start: 2">
+                        <div style="width: fit-content">
+                            <div class="text-center">|</div>
+                            <div class="text-lg-center fw-semibold">{{ tag }}</div>
+                            <div class="text-center">bei {% widthratio global_ratio 1 100 %}%</div>
+                        </div>
+                    </div>
+                {% endfor %}
+            </div>
+            {{ progress_description | safe }}. This should be collapsed by default.
+            <br>
+            The last evaluation was submitted N minutes/hours/days ago.
+        </div>
+    </div>
+{% endif %}
     {% if unfinished_evaluations %}
         <div class="card card-outline-primary mb-3">
             <div class="card-header">

evap/student/views.py

@@ -1,10 +1,10 @@
-from collections import OrderedDict
+from collections import OrderedDict, defaultdict
 
 from django.conf import settings
 from django.contrib import messages
 from django.core.exceptions import PermissionDenied
 from django.db import transaction
-from django.db.models import Exists, F, OuterRef, Q
+from django.db.models import Exists, F, OuterRef, Q, Sum
 from django.http import HttpResponse
 from django.shortcuts import get_object_or_404, render
 from django.urls import reverse
@@ -25,7 +25,7 @@
 
 
 @participant_required
-def index(request):
+def index(request):  # pylint: disable=too-many-locals
     query = (
         Evaluation.objects.annotate(
             participates_in=Exists(Evaluation.objects.filter(id=OuterRef("id"), participants=request.user))
@@ -105,12 +105,51 @@ def sorter(evaluation):
         )
 
     unfinished_evaluations.sort(key=sorter)
+    info = Evaluation.annotate_with_participant_and_voter_counts(
+        Semester.active_semester()
+        .evaluations.filter(is_single_result=False)
+        .exclude(state__lt=Evaluation.State.APPROVED)
+        .exclude(is_rewarded=False)
+        .exclude(id__in=settings.EXCLUDED_EVALUATION_IDS)
+        .exclude(course__type__id__in=settings.EXCLUDED_COURSE_TYPE_IDS)
+        .exclude(course__is_private=True)
+    ).aggregate(
+        total_votes=Sum("num_voters"),
+        participants=Sum("num_participants"),
+    )
+    if settings.GLOBAL_EVALUATION_PROGRESS_REWARDS:
+        max_reward = max(settings.GLOBAL_EVALUATION_PROGRESS_REWARDS)
+        final_goal = round(info["participants"] * max_reward[0])
+        next_goal = final_goal
+        next_reward = max_reward[1]
+        for percentage, reward in settings.GLOBAL_EVALUATION_PROGRESS_REWARDS:
+            candidate = info["participants"] * percentage
+            if info["total_votes"] < candidate < next_goal:
+                next_goal = round(candidate)
+                next_reward = reward
+        positioned_labels = [
+            (percentage / max_reward[0], percentage, label)
+            for percentage, label in settings.GLOBAL_EVALUATION_PROGRESS_REWARDS
+        ]
+
+    else:
+        final_goal = None
+        positioned_labels = None
+        info = defaultdict(lambda: 0)
+        next_goal = 0
+        next_reward = 0
 
     template_data = {
         "semester_list": semester_list,
         "can_download_grades": request.user.can_download_grades,
         "unfinished_evaluations": unfinished_evaluations,
         "evaluation_end_warning_period": settings.EVALUATION_END_WARNING_PERIOD,
+        "num_total_votes": info["total_votes"],
+        "final_goal": final_goal,
+        "global_progress_rewards": positioned_labels,
+        "remaining_votes": next_goal - info["total_votes"],
+        "next_reward": next_reward,
+        "progress_description": settings.PARTICIPANT_PROGRESS_TEXT,
     }
 
     return render(request, "student_index.html", template_data)