Notify users if they have submitted a text answer but sent no description

trojsten/contests/helpers.py

@@ -3,6 +3,8 @@
 from trojsten.contests.models import Round
 from trojsten.results.helpers import UserResult
 from trojsten.results.manager import get_results_tags_for_rounds
+from trojsten.submit.constants import SUBMIT_TYPE_DESCRIPTION, SUBMIT_TYPE_TEXT
+from trojsten.submit.models import Submit
 
 from .constants import DEFAULT_NUMBER_OF_TAGS, MAX_NUMBER_OF_TAGS
 
@@ -41,3 +43,17 @@ def get_points_from_submits(tasks, submits):
             submit.task, submit.submit_type, submit.user_points, submit.testing_status
         )
     return res
+
+
+def check_description_at_text_submit(user, tasks):
+    user_submits = Submit.objects.latest_for_user(tasks, user)
+    for task in tasks:
+        if (
+            task.has_text_submit
+            and task.has_description
+            and task.round.can_submit
+            and user_submits.filter(task=task, submit_type=SUBMIT_TYPE_TEXT, points__gt=0)
+            and not user_submits.filter(task=task, submit_type=SUBMIT_TYPE_DESCRIPTION)
+        ):
+            return True
+    return False

trojsten/contests/templates/trojsten/contests/parts/task_list.html

@@ -1,6 +1,13 @@
 {% load utils %}
+{% load i18n %}
 <!-- Nav tabs -->
 
+{% if warning_no_description %}
+    <div class="alert alert-danger">
+        {% trans "You have submitted a text answer but have not submitted a description. This may lead to point deduction." %}
+    </div>
+{% endif %}
+
 {% if categories.count > 1 %}
 <ul class="nav nav-tabs" role="tablist">
     <li class="active">

trojsten/contests/templates/trojsten/contests/view_task_statement.html

@@ -3,6 +3,7 @@
 {% load statements_parts %}
 {% load staticfiles %}
 {% load utils %}
+{% load i18n %}
 
 {% block stylesheets %}
 {{ block.super }}
@@ -39,6 +40,11 @@ <h1 id="article-title" class="task-name">{{ task.number }}. {{ task.name }}
 {% endblock %}
 
 {% block page_content %}
+    {% if warning_no_description %}
+        <div class="alert alert-danger">
+            {% trans "You have submitted a text answer but have not submitted a description. This may lead to point deduction." %}
+        </div>
+    {% endif %}
     {% show_progress task.round %}
     {% if task.description_points > 0 or task.source_points > 0 %}
     <div class="well pull-right task-points">

trojsten/contests/templatetags/statements_parts.py

@@ -8,7 +8,7 @@
 from trojsten.submit.models import Submit
 from trojsten.utils import utils
 
-from ..helpers import get_points_from_submits, slice_tag_list
+from ..helpers import check_description_at_text_submit, get_points_from_submits, slice_tag_list
 
 register = template.Library()
 
@@ -34,6 +34,8 @@ def show_task_list(context, round):
         "tasks": tasks,
         "categories": categories,
         "solutions_visible": round.solutions_are_visible_for_user(context["user"]),
+        "warning_no_description": context["user"].is_authenticated
+        and check_description_at_text_submit(context["user"], tasks),
     }
     if context["user"].is_authenticated:
         submits = Submit.objects.latest_for_user(tasks, context["user"])

trojsten/contests/tests.py

@@ -339,6 +339,10 @@ def setUp(self):
         self.nonstaff_user = User.objects.create(username="nonstaff")
         self.task_url = reverse("task_statement", kwargs={"task_id": self.task.id})
         self.solution_url = reverse("solution_statement", kwargs={"task_id": self.task.id})
+        self.point_deduction_message = (
+            "You have submitted a text answer but "
+            "have not submitted a description. This may lead to point deduction."
+        )
 
     def test_invalid_task(self):
         url = reverse("task_statement", kwargs={"task_id": get_noexisting_id(Task)})
@@ -416,6 +420,109 @@ def test_missing_solution_statement_file(self):
         self.assertContains(response, "Test task 2")
         self.assertContains(response, "test <b>html</b> task statement")
 
+    def test_statement_only_text_submit(self):
+        self.client.force_login(self.nonstaff_user)
+        self.task.text_submit_solution = ["Password"]
+        self.task.save()
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_TEXT,
+            testing_status=submit_constants.SUBMIT_STATUS_REVIEWED,
+            points=5,
+        )
+        url = reverse("task_statement", kwargs={"task_id": self.task.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+        url = reverse("task_list", kwargs={"round_id": self.round.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+
+    def test_text_submit_zero_points(self):
+        self.client.force_login(self.nonstaff_user)
+        self.task.text_submit_solution = ["Password"]
+        self.task.has_description = True
+        self.task.save()
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_TEXT,
+            testing_status=submit_constants.SUBMIT_STATUS_REVIEWED,
+            points=0,
+        )
+        url = reverse("task_statement", kwargs={"task_id": self.task.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+        url = reverse("task_list", kwargs={"round_id": self.round.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+
+    def test_missing_description(self):
+        self.client.force_login(self.nonstaff_user)
+        self.task.text_submit_solution = ["Password"]
+        self.task.has_description = True
+        self.task.save()
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_TEXT,
+            testing_status=submit_constants.SUBMIT_STATUS_REVIEWED,
+            points=4,
+        )
+        url = reverse("task_statement", kwargs={"task_id": self.task.id})
+        response = self.client.get(url)
+        self.assertContains(response, _(self.point_deduction_message))
+        url = reverse("task_list", kwargs={"round_id": self.round.id})
+        response = self.client.get(url)
+        self.assertContains(response, _(self.point_deduction_message))
+
+    def test_missing_description_after_round_end(self):
+        self.client.force_login(self.nonstaff_user)
+        self.task.text_submit_solution = ["Password"]
+        self.task.has_description = True
+        self.task.save()
+        self.round.end_time = timezone.now() + timezone.timedelta(-8)
+        self.round.save()
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_TEXT,
+            testing_status=submit_constants.SUBMIT_STATUS_REVIEWED,
+            points=4,
+        )
+        url = reverse("task_statement", kwargs={"task_id": self.task.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+        url = reverse("task_list", kwargs={"round_id": self.round.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+
+    def test_text_and_description_submitted(self):
+        self.client.force_login(self.nonstaff_user)
+        self.task.text_submit_solution = ["Password"]
+        self.task.has_description = True
+        self.task.save()
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_TEXT,
+            testing_status=submit_constants.SUBMIT_STATUS_REVIEWED,
+            points=4,
+        )
+        Submit.objects.create(
+            task=self.task,
+            user=self.nonstaff_user,
+            submit_type=submit_constants.SUBMIT_TYPE_DESCRIPTION,
+            testing_status=submit_constants.SUBMIT_STATUS_IN_QUEUE,
+            points=0,
+        )
+        url = reverse("task_statement", kwargs={"task_id": self.task.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+        url = reverse("task_list", kwargs={"round_id": self.round.id})
+        response = self.client.get(url)
+        self.assertNotContains(response, _(self.point_deduction_message))
+
 
 @override_settings(
     TASK_STATEMENTS_STORAGE=FileSystemStorage(

trojsten/contests/views.py

@@ -14,6 +14,7 @@
 from trojsten.utils.utils import is_true
 
 from . import constants
+from .helpers import check_description_at_text_submit
 
 
 @get_article(can_read=True)
@@ -34,6 +35,9 @@ def _statement_view(request, task_id, solution=False):
     if solution and task.solution_file_exists:
         with settings.TASK_STATEMENTS_STORAGE.open(task.get_path(solution=True)) as f:
             template_data["solution_text"] = f.read().decode()
+    template_data[
+        "warning_no_description"
+    ] = request.user.is_authenticated and check_description_at_text_submit(request.user, [task])
     return render(
         request,
         "trojsten/contests/view_{}_statement.html".format("solution" if solution else "task"),

trojsten/locale/sk/LC_MESSAGES/django.po

@@ -1016,3 +1016,6 @@ msgstr "Len tento seminár"
 
 msgid "Include all sites"
 msgstr "Zahrnúť všetky semináre"
+
+msgid "You have submitted a text answer but have not submitted a description. This may lead to point deduction."
+msgstr "Máš odovzdanú textovú odpoveď, ale žiaden popis. Toto môže viesť k strate bodov."