keep memory of deleted evaluations and don't import them again

Author: janno42

evap/cms/json_importer.py

@@ -16,6 +16,7 @@
 from pydantic import TypeAdapter
 from typing_extensions import TypedDict
 
+from evap.cms.models import IgnoredEvaluation
 from evap.evaluation.models import (
     Contribution,
     Course,
@@ -426,7 +427,11 @@ def _import_course_from_unused_exam(self, data: ImportEvent) -> Course | None:
     # pylint: disable=too-many-locals
     def _import_evaluation(  # noqa: PLR0912, PLR0915
         self, course: Course, data: ImportEvent, earliest_exam_date: date | None = None
-    ) -> Evaluation:
+    ) -> Evaluation | None:
+        # Don't import ignored evaluations again
+        if IgnoredEvaluation.objects.filter(cms_id=data["gguid"]).exists():
+            return None
+
         try:
             evaluation = Evaluation.objects.get(course=course, cms_id=data["gguid"])
         except Evaluation.DoesNotExist:

evap/cms/migrations/0001_initial.py

@@ -0,0 +1,41 @@
+# Generated by Django 5.2 on 2026-01-12 20:23
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("evaluation", "0160_evaluation_staff_notes"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="IgnoredEvaluation",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "cms_id",
+                    models.CharField(max_length=255, unique=True, verbose_name="campus management system id"),
+                ),
+                ("name_de", models.CharField(blank=True, max_length=1024, verbose_name="name (german)")),
+                ("name_en", models.CharField(blank=True, max_length=1024, verbose_name="name (english)")),
+                ("notes", models.TextField(blank=True, verbose_name="notes")),
+                (
+                    "course",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="ignored_evaluations",
+                        to="evaluation.course",
+                        verbose_name="course",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "ignored evaluation",
+                "verbose_name_plural": "ignored evaluations",
+            },
+        ),
+    ]

evap/cms/models.py

@@ -0,0 +1,29 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from evap.evaluation.models import Course
+from evap.evaluation.tools import translate
+
+
+class IgnoredEvaluation(models.Model):
+    """Model for an evaluation that was deleted and should not be imported again from the CMS"""
+
+    # unique reference for import from campus management system
+    cms_id = models.CharField(verbose_name=_("campus management system id"), unique=True, max_length=255)
+
+    name_de = models.CharField(max_length=1024, verbose_name=_("name (german)"), blank=True)
+    name_en = models.CharField(max_length=1024, verbose_name=_("name (english)"), blank=True)
+    name = translate(en="name_en", de="name_de")
+
+    course = models.ForeignKey(Course, models.CASCADE, verbose_name=_("course"), related_name="ignored_evaluations")
+
+    notes = models.TextField(verbose_name=_("notes"), blank=True)
+
+    class Meta:
+        verbose_name = _("ignored evaluation")
+        verbose_name_plural = _("ignored evaluations")
+
+    def __str__(self):
+        if self.name:
+            return f"{self.course.name} – {self.name}"
+        return self.course.name

evap/cms/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from evap.cms import views
+
+app_name = "cms"
+
+urlpatterns = [
+    path("ignored_evaluation/delete", views.ignored_evaluation_delete, name="ignored_evaluation_delete"),
+]

evap/cms/views.py

@@ -0,0 +1,18 @@
+from django.views.decorators.http import require_POST
+
+from evap.cms.models import IgnoredEvaluation
+from evap.evaluation.auth import manager_required
+from evap.evaluation.tools import (
+    HttpResponseNoContent,
+    get_object_from_dict_pk_entry_or_logged_40x,
+)
+
+
+@require_POST
+@manager_required
+def ignored_evaluation_delete(request):
+    ignored_evaluation = get_object_from_dict_pk_entry_or_logged_40x(
+        IgnoredEvaluation, request.POST, "ignored_evaluation_id"
+    )
+    ignored_evaluation.delete()
+    return HttpResponseNoContent()

evap/staff/templates/staff_course_form.html

@@ -1,5 +1,7 @@
 {% extends 'staff_course_base.html' %}
 
+{% load static %}
+
 {% block content %}
     {{ block.super }}
     <h3>
@@ -47,8 +49,59 @@ <h5 class="card-title">{% translate 'Evaluations' %}</h5>
                 </div>
             </div>
         {% endif %}
+    </form>
 
-      {% include 'log/logentries.html' with logged_object=course %}
+    {% if course.ignored_evaluations.count > 0 %}
+        <form id="ignored-evaluation-deletion-form" custom-success method="POST" action="{% url 'cms:ignored_evaluation_delete' %}">
+            {% csrf_token %}
+        </form>
 
-    </form>
+        <script type="module">
+            import { fadeOutThenRemove } from "{% static 'js/utils.js' %}";
+            document.getElementById("ignored-evaluation-deletion-form").addEventListener("submit-success", event => {
+                fadeOutThenRemove(document.getElementById(`ignored-evaluation-row-${event.detail.body.get("ignored_evaluation_id")}`))
+            });
+        </script>
+        <div class="card mb-3">
+            <div class="card-body">
+                <h5 class="card-title">{% translate 'Ignored evaluations' %}</h5>
+                <table class="table table-vertically-aligned">
+                    <thead>
+                        <tr>
+                            <th class="width-percent-35">{% translate 'Name' %}</th>
+                            <th class="width-percent-35">{% translate 'Notes' %}</th>
+                            <th class="width-percent-25">{% translate 'CMS ID' %}</th>
+                            <th class="width-percent-5"></th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        {% for ignored_evaluation in course.ignored_evaluations.all %}
+                            <tr id="ignored-evaluation-row-{{ ignored_evaluation.id }}">
+                                <td>{{ ignored_evaluation }}</td>
+                                <td>{{ ignored_evaluation.notes|linebreaks }}</td>
+                                <td>{{ ignored_evaluation.cms_id }}</td>
+                                <td class="text-end">
+                                    <confirmation-modal type="submit" form="ignored-evaluation-deletion-form" name="ignored_evaluation_id" value="{{ ignored_evaluation.id }}" confirm-button-class="btn-danger">
+                                        <span slot="title">{% translate 'Delete ignored evaluation' %}</span>
+                                        <span slot="action-text">{% translate 'Delete ignored evaluation' %}</span>
+                                        <span slot="question">
+                                            {% blocktranslate trimmed %}
+                                                Do you really want to delete the ignored evaluation <strong>{{ ignored_evaluation }}</strong>? It will then be imported again on the next CMS import.
+                                            {% endblocktranslate %}
+                                        </span>
+
+                                        <button slot="show-button" type="button" class="btn btn-sm btn-danger" data-bs-toggle="tooltip" data-bs-placement="top" title="{% translate 'Delete' %}">
+                                            <span class="fas fa-fw fa-trash" aria-hidden="true"></span>
+                                        </button>
+                                    </confirmation-modal>
+                                </td>
+                            </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
+            </div>
+        </div>
+    {% endif %}
+
+    {% include 'log/logentries.html' with logged_object=course %}
 {% endblock %}

evap/staff/templates/staff_semester_view.html

@@ -506,14 +506,16 @@ <h3 class="m-0 me-1">{{ semester.name }}</h3>
                         <colgroup>
                             <col />
                             <col style="width: 14em" />
-                            <col style="width: 12em" />
+                            <col style="width: 10em" />
+                            <col style="width: 10em" />
                             <col style="width: 9em" />
                         </colgroup>
                         <thead>
                             <tr>
                                 <th class="col-order" data-col="name">{% translate 'Course' %}</th>
                                 <th class="col-order" data-col="responsible">{% translate 'Responsible' %}</th>
                                 <th class="col-order" data-col="evaluation-count">{% translate '#Evaluations' %}</th>
+                                <th class="col-order" data-col="ignored-evaluation-count">{% translate '#Ignored evaluations' %}</th>
                                 <th data-not-searchable></th>
                             </tr>
                         </thead>
@@ -541,6 +543,9 @@ <h3 class="m-0 me-1">{{ semester.name }}</h3>
                                             {{ course.evaluations.count }}
                                         {% endif %}
                                     </td>
+                                    <td data-col="ignored-evaluation-count" data-order="{{ course.ignored_evaluations.count }}">
+                                        {{ course.ignored_evaluations.count }}
+                                    </td>
                                     <td class="icon-buttons">
                                         {% if request.user.is_manager %}
                                             <a class="btn btn-sm btn-dark" data-bs-toggle="tooltip"

evap/staff/views.py

@@ -39,6 +39,7 @@
 from django.views.decorators.http import require_POST
 from django.views.generic import CreateView, FormView, UpdateView
 
+from evap.cms.models import IgnoredEvaluation
 from evap.contributor.views import export_contributor_results
 from evap.evaluation.auth import manager_required, reviewer_required, staff_permission_required
 from evap.evaluation.models import (
@@ -1400,6 +1401,15 @@ def notify_reward_points(grantings, **_kwargs):
         )
 
     with temporary_receiver(RewardPointGranting.granted_by_evaluation_deletion, notify_reward_points):
+        if evaluation.cms_id:
+            # remember deleted evaluation to prevent the importer from creating it again
+            IgnoredEvaluation.objects.create(
+                cms_id=evaluation.cms_id,
+                name_de=evaluation.name_de,
+                name_en=evaluation.name_en,
+                course=evaluation.course,
+                notes=evaluation.staff_notes,
+            )
         evaluation.delete()
         update_template_cache_of_published_evaluations_in_course(evaluation.course)
 

evap/static/scss/components/_tables.scss

@@ -127,3 +127,7 @@ tr.evaluation-row:not(.heading-row) {
 .table-headerless tr:last-child td {
     border-bottom-width: 0;
 }
+
+td p {
+    margin-bottom: 0;
+}

evap/urls.py

@@ -13,6 +13,7 @@
     path("contributor/", include('evap.contributor.urls')),
     path("rewards/", include('evap.rewards.urls')),
     path("grades/", include('evap.grades.urls')),
+    path("cms/", include('evap.cms.urls')),
 
     path("logout", django.contrib.auth.views.LogoutView.as_view(next_page="/"), name="django-auth-logout"),
     path("oidc/", include('mozilla_django_oidc.urls')),