Delete participations of long inactive users

evap/settings.py

@@ -11,6 +11,7 @@
 import logging
 import os
 import sys
+from datetime import timedelta
 from fractions import Fraction
 from typing import Any
 
@@ -36,6 +37,7 @@
 VOTER_COUNT_NEEDED_FOR_PUBLISHING_RATING_RESULTS = 2
 VOTER_PERCENTAGE_NEEDED_FOR_PUBLISHING_AVERAGE_GRADE = 0.2
 SMALL_COURSE_SIZE = 5  # up to which number of participants the evaluation gets additional warnings about anonymity
+PARTICIPATION_DELETION_AFTER_INACTIVE_TIME = timedelta(days=18 * 30)
 
 # a warning is shown next to results where less than RESULTS_WARNING_COUNT answers were given
 # or the number of answers is less than RESULTS_WARNING_PERCENTAGE times the median number of answers (for this question in this evaluation)

evap/staff/tests/test_tools.py

@@ -1,8 +1,10 @@
+from datetime import datetime, timedelta
 from io import BytesIO
 from itertools import cycle, repeat
 from unittest.mock import MagicMock, patch
 
 from django.contrib.auth.models import Group
+from django.test import override_settings
 from django.utils.html import escape
 from model_bakery import baker
 from openpyxl import load_workbook
@@ -19,6 +21,7 @@
 from evap.staff.tools import (
     conditional_escape,
     merge_users,
+    remove_participations_if_inactive,
     remove_user_from_represented_and_ccing_users,
     user_edit_link,
 )
@@ -217,6 +220,70 @@ def test_do_nothing_if_test_run(self):
         self.assertEqual(len(messages), 4)
 
 
+class RemoveParticipationDueToInactivityTest(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = baker.make(UserProfile)
+        cls.evaluation = baker.make(
+            Evaluation,
+            state=Evaluation.State.PUBLISHED,
+            vote_start_datetime=datetime.today() - timedelta(days=200),
+            vote_end_date=(datetime.today() - timedelta(days=180)).date(),
+            participants=[cls.user],
+        )
+        cls.evaluation.course.semester.archive()
+
+    @override_settings(PARTICIPATION_DELETION_AFTER_INACTIVE_TIME=timedelta(6 * 30))
+    def test_remove_user_due_to_inactivity(self):
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+
+        messages = remove_participations_if_inactive(self.user)
+
+        self.assertFalse(self.user.evaluations_participating_in.exists())
+        self.assertTrue(self.user.can_be_marked_inactive_by_manager)
+        self.assertEqual(messages, [f"1 participation of {self.user.full_name} was removed due to inactivity."])
+
+        messages = remove_participations_if_inactive(self.user)
+
+        self.assertEqual(messages, [])
+
+    @patch("evap.evaluation.models.UserProfile.is_active", True)
+    @patch("evap.evaluation.models.UserProfile.can_be_marked_inactive_by_manager", True)
+    @override_settings(PARTICIPATION_DELETION_AFTER_INACTIVE_TIME=timedelta(360))
+    def test_do_not_remove_user_due_to_inactivity_with_recently_archived_evaluation(self):
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+
+        messages = remove_participations_if_inactive(self.user)
+
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+        self.assertEqual(messages, [])
+
+    @patch("evap.evaluation.models.UserProfile.is_active", True)
+    @patch("evap.evaluation.models.UserProfile.can_be_marked_inactive_by_manager", False)
+    @override_settings(PARTICIPATION_DELETION_AFTER_INACTIVE_TIME=timedelta(360))
+    def test_do_not_remove_user_due_to_inactivity_with_active_evaluation(self):
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+
+        messages = remove_participations_if_inactive(self.user)
+
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+        self.assertEqual(messages, [])
+
+    @override_settings(PARTICIPATION_DELETION_AFTER_INACTIVE_TIME=timedelta(6 * 30))
+    def test_do_nothing_if_test_run(self):
+        self.assertTrue(self.user.evaluations_participating_in.exists())
+
+        messages = remove_participations_if_inactive(self.user, test_run=True)
+        pre_count = self.user.evaluations_participating_in.count()
+
+        self.assertEqual(list(self.user.evaluations_participating_in.all()), [self.evaluation])
+        self.assertTrue(self.user.can_be_marked_inactive_by_manager)
+        self.assertEqual(messages, [f"1 participation of {self.user.full_name} would be removed due to inactivity."])
+
+        post_count = self.user.evaluations_participating_in.count()
+        self.assertEqual(pre_count, post_count)
+
+
 class UserEditLinkTest(TestCase):
     def test_user_edit_link(self):
         user = baker.make(UserProfile)

evap/staff/tools.py

@@ -8,15 +8,16 @@
 from django.contrib.auth.models import Group
 from django.core.exceptions import SuspiciousOperation
 from django.db import transaction
-from django.db.models import Count
+from django.db.models import Count, Max
 from django.urls import reverse
 from django.utils.html import escape, format_html, format_html_join
 from django.utils.safestring import SafeString
 from django.utils.translation import gettext_lazy as _
+from django.utils.translation import ngettext
 
 from evap.evaluation.models import Contribution, Course, Evaluation, TextAnswer, UserProfile
 from evap.evaluation.models_logging import LogEntry
-from evap.evaluation.tools import clean_email, is_external_email
+from evap.evaluation.tools import StrOrPromise, clean_email, is_external_email
 from evap.grades.models import GradeDocument
 from evap.results.tools import STATES_WITH_RESULTS_CACHING, cache_results
 
@@ -195,6 +196,9 @@
                 user, deletable_users + users_to_mark_inactive, test_run
             ):
                 messages.warning(request, message)
+        for user in users_to_mark_inactive:
+            for message in remove_participations_if_inactive(user, test_run):
+                messages.warning(request, message)
         if test_run:
             messages.info(request, _("No data was changed in this test run."))
         else:
@@ -203,6 +207,7 @@
             for user in users_to_mark_inactive:
                 user.is_active = False
                 user.save()
+
             for user, email in users_to_be_updated:
                 user.email = email
                 user.save()
@@ -375,6 +380,35 @@
     return remove_messages
 
 
+def remove_participations_if_inactive(user: UserProfile, test_run=False) -> list[StrOrPromise]:
+    if user.is_active and not user.can_be_marked_inactive_by_manager:
+        return []
+    last_participation = user.evaluations_participating_in.aggregate(Max("vote_end_date"))["vote_end_date__max"]
+    if (
+        last_participation is None
+        or (date.today() - last_participation) < settings.PARTICIPATION_DELETION_AFTER_INACTIVE_TIME
+    ):
+        return []
+
+    evaluation_count = user.evaluations_participating_in.count()
+    if test_run:
+        return [
+            ngettext(
+                "{} participation of {} would be removed due to inactivity.",
+                "{} participations of {} would be removed due to inactivity.",
+                evaluation_count,
+            ).format(evaluation_count, user.full_name)
+        ]
+    user.evaluations_participating_in.clear()
+    return [
+        ngettext(
+            "{} participation of {} was removed due to inactivity.",
+            "{} participations of {} were removed due to inactivity.",
+            evaluation_count,
+        ).format(evaluation_count, user.full_name)
+    ]
+
+
 def user_edit_link(user_id):
     return format_html(
         '<a href="{}" target=_blank><span class="fas fa-user-pen"></span> {}</a>',