feat: automatic product archiving

counter/forms.py

@@ -1,13 +1,19 @@
 import math
 
 from django import forms
+from django.core.exceptions import ValidationError
 from django.db.models import Q
 from django.utils.translation import gettext_lazy as _
+from django_celery_beat.models import ClockedSchedule, PeriodicTask
 from phonenumber_field.widgets import RegionalPhoneNumberWidget
 
 from club.widgets.ajax_select import AutoCompleteSelectClub
 from core.models import User
-from core.views.forms import NFCTextInput, SelectDate, SelectDateTime
+from core.views.forms import (
+    NFCTextInput,
+    SelectDate,
+    SelectDateTime,
+)
 from core.views.widgets.ajax_select import (
     AutoCompleteSelect,
     AutoCompleteSelectMultipleGroup,
@@ -158,6 +164,66 @@ class CounterEditForm(forms.ModelForm):
         }
 
 
+class ProductArchiveForm(forms.Form):
+    """Form for automatic product archiving."""
+
+    enabled = forms.BooleanField(
+        label=_("Enabled"),
+        widget=forms.CheckboxInput(attrs={"class": "switch"}),
+        required=False,
+    )
+    archive_at = forms.DateTimeField(
+        label=_("Date and time of archiving"), widget=SelectDateTime, required=False
+    )
+
+    def __init__(self, *args, product: Product, **kwargs):
+        self.product = product
+        self.instance = PeriodicTask.objects.filter(
+            task="counter.tasks.archive_product", args=f"[{product.id}]"
+        ).first()
+        super().__init__(*args, **kwargs)
+        if self.instance:
+            self.fields["enabled"].initial = self.instance.enabled
+            self.fields["archive_at"].initial = self.instance.clocked.clocked_time
+
+    def clean(self):
+        cleaned_data = super().clean()
+        if cleaned_data["enabled"] is True and cleaned_data["archive_at"] is None:
+            raise ValidationError(
+                _(
+                    "Automatic archiving cannot be enabled "
+                    "without providing a archiving date."
+                )
+            )
+
+    def save(self):
+        if not self.changed_data:
+            return
+        if not self.instance:
+            PeriodicTask.objects.create(
+                task="counter.tasks.archive_product",
+                args=f"[{self.product.id}]",
+                name=f"Archive product {self.product}",
+                clocked=ClockedSchedule.objects.create(
+                    clocked_time=self.cleaned_data["archive_at"]
+                ),
+                enabled=self.cleaned_data["enabled"],
+                one_off=True,
+            )
+            return
+        if (
+            "archive_at" in self.changed_data
+            and self.cleaned_data["archive_at"] is None
+        ):
+            self.instance.delete()
+        elif "archive_at" in self.changed_data:
+            self.instance.clocked.clocked_time = self.cleaned_data["archive_at"]
+            self.instance.clocked.save()
+        self.instance.enabled = self.cleaned_data["enabled"]
+        self.instance.save()
+        return self.instance
+
+
 class ProductEditForm(forms.ModelForm):
     error_css_class = "error"
     required_css_class = "required"
@@ -199,22 +265,19 @@ class ProductEditForm(forms.ModelForm):
         queryset=Counter.objects.all(),
     )
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, instance=None, **kwargs):
-        super().__init__(*args, **kwargs)
+        super().__init__(*args, instance=instance, **kwargs)
         if self.instance.id:
             self.fields["counters"].initial = self.instance.counters.all()
+        self.archive_form = ProductArchiveForm(*args, product=self.instance, **kwargs)
+
+    def is_valid(self):
+        return super().is_valid() and self.archive_form.is_valid()
 
     def save(self, *args, **kwargs):
         ret = super().save(*args, **kwargs)
-        if self.fields["counters"].initial:
+        self.instance.counters.set(self.cleaned_data["counters"])
-            # Remove the product from all counter it was added to
+        self.archive_form.save()
-            # It will then only be added to selected counters
-            for counter in self.fields["counters"].initial:
-                counter.products.remove(self.instance)
-                counter.save()
-        for counter in self.cleaned_data["counters"]:
-            counter.products.add(self.instance)
-            counter.save()
         return ret
 
 

counter/models.py

@@ -445,7 +445,8 @@ class Product(models.Model):
         buying_groups = list(self.buying_groups.all())
         if not buying_groups:
             return True
-        return any(user.is_in_group(pk=group.id) for group in buying_groups)
+        res = any(user.is_in_group(pk=group.id) for group in buying_groups)
+        return res
 
     @property
     def profit(self):

counter/tasks.py

@@ -0,0 +1,13 @@
+# Create your tasks here
+
+from celery import shared_task
+
+from counter.models import Product
+
+
+@shared_task
+def archive_product(product_id):
+    product = Product.objects.get(id=product_id)
+    product.archived = True
+    product.save()
+    product.counters.clear()

counter/templates/counter/product_form.jinja

@@ -0,0 +1,31 @@
+{% extends "core/base.jinja" %}
+
+{% block content %}
+  {% if object %}
+    <h2>{% trans name=object %}Edit product {{ name }}{% endtrans %}</h2>
+  {% else %}
+    <h2>{% trans %}Product creation{% endtrans %}</h2>
+  {% endif %}
+  <form method="post">
+    {% csrf_token %}
+    {{ form.as_p() }}
+
+    <br />
+
+    <h3>{% trans %}Automatic archiving{% endtrans %}</h3>
+
+    <p>
+      <em>
+        {%- trans trimmed -%}
+          Automatic archiving allows you to mark a product as archived
+          and remove it from all its counters at a specified time and date.
+        {%- endtrans -%}
+      </em>
+    </p>
+
+    <fieldset x-data="{enabled: {{ form.archive_form.enabled.initial|tojson }}}">
+      {{ form.archive_form.as_p() }}
+    </fieldset>
+    <p><input type="submit" value="{% trans %}Save{% endtrans %}" /></p>
+  </form>
+{% endblock %}

counter/views/admin.py

@@ -147,7 +147,7 @@ class ProductCreateView(CounterAdminTabsMixin, CounterAdminMixin, CreateView):
 
     model = Product
     form_class = ProductEditForm
-    template_name = "core/create.jinja"
+    template_name = "counter/product_form.jinja"
     current_tab = "products"
 
 
@@ -157,7 +157,7 @@ class ProductEditView(CounterAdminTabsMixin, CounterAdminMixin, UpdateView):
     model = Product
     form_class = ProductEditForm
     pk_url_kwarg = "product_id"
-    template_name = "core/edit.jinja"
+    template_name = "counter/product_form.jinja"
     current_tab = "products"
 
 

galaxy/management/commands/rule_galaxy.py

@@ -45,9 +45,8 @@ class Command(BaseCommand):
                 "verbosity level should be between 0 and 2 included", stacklevel=2
             )
 
-        if options["verbosity"] >= 2:
+        if options["verbosity"] == 2:
             logger.setLevel(logging.DEBUG)
-            logging.getLogger("django.db.backends").setLevel(logging.DEBUG)
         elif options["verbosity"] == 1:
             logger.setLevel(logging.INFO)
         else:
@@ -60,3 +59,6 @@ class Command(BaseCommand):
         Galaxy.objects.filter(state__isnull=True).delete()
 
         logger.info("Ruled the galaxy in {} queries.".format(len(connection.queries)))
+        if options["verbosity"] > 2:
+            for q in connection.queries:
+                logger.debug(q)

galaxy/models.py

@@ -31,14 +31,13 @@ from collections import defaultdict
 from typing import NamedTuple, TypedDict
 
 from django.db import models
-from django.db.models import Count, Exists, F, OuterRef, Q, QuerySet
+from django.db.models import Count, F, Q, QuerySet
-from django.utils.timezone import localdate, now
+from django.utils.timezone import localdate
 from django.utils.translation import gettext_lazy as _
 
 from club.models import Membership
 from core.models import User
 from sas.models import PeoplePictureRelation, Picture
-from subscription.models import Subscription
 
 
 class GalaxyStar(models.Model):
@@ -199,16 +198,8 @@ class Galaxy(models.Model):
         cls, picture_count_threshold: int = DEFAULT_PICTURE_COUNT_THRESHOLD
     ) -> QuerySet[User]:
         return (
-            User.objects.filter(is_subscriber_viewable=True)
+            User.objects.exclude(subscriptions=None)
-            .exclude(subscriptions=None)
+            .annotate(pictures_count=Count("pictures"))
-            .annotate(
-                pictures_count=Count("pictures"),
-                is_active_in_galaxy=Exists(
-                    Subscription.objects.filter(
-                        member=OuterRef("id"), subscription_end__gt=now()
-                    )
-                ),
-            )
             .filter(pictures_count__gt=picture_count_threshold)
             .distinct()
         )
@@ -299,9 +290,9 @@ class Galaxy(models.Model):
         31/12/2022 (also two years, but with an offset of one year), then their
         club score is 365.
         """
-        memberships = user.memberships.values("start_date", "end_date", "club_id")
+        memberships = user.memberships.only("start_date", "end_date", "club_id")
         result = defaultdict(int)
-        today = localdate()
+        now = localdate()
         for membership in memberships:
             # This is a N+1 query, but 92% of galaxy users have less than 10 memberships.
             # Only 5 users have more than 30 memberships.
@@ -309,23 +300,23 @@ class Galaxy(models.Model):
                 Membership.objects.exclude(user=user)
                 .filter(
                     Q(  # start2 <= start1 <= end2
-                        start_date__lte=membership["start_date"],
+                        start_date__lte=membership.start_date,
-                        end_date__gte=membership["start_date"],
+                        end_date__gte=membership.start_date,
                     )
-                    | Q(  # start2 <= start1 <= today
+                    | Q(  # start2 <= start1 <= now
-                        start_date__lte=membership["start_date"], end_date=None
+                        start_date__lte=membership.start_date, end_date=None
                     )
                     | Q(  # start1 <= start2 <= end2
-                        start_date__gte=membership["start_date"],
+                        start_date__gte=membership.start_date,
-                        start_date__lte=membership["end_date"] or today,
+                        start_date__lte=membership.end_date or now,
                     ),
-                    club_id=membership["club_id"],
+                    club_id=membership.club_id,
                 )
                 .only("start_date", "end_date", "user_id")
             )
             for other in common_memberships:
-                start = max(membership["start_date"], other.start_date)
+                start = max(membership.start_date, other.start_date)
-                end = min(membership["end_date"] or today, other.end_date or today)
+                end = min(membership.end_date or now, other.end_date or now)
                 result[other.user_id] += (end - start).days * cls.CLUBS_POINTS
         return result
 
@@ -391,22 +382,18 @@ class Galaxy(models.Model):
         # this is memory expensive but prevents a lot of db hits, therefore
         # is far more time efficient
 
-        rulable_users_qs = self.get_rulable_users(picture_count_threshold)
+        rulable_users = list(self.get_rulable_users(picture_count_threshold))
-        active_users_count = rulable_users_qs.filter(is_active_in_galaxy=True).count()
+        rulable_users_count = len(rulable_users)
-        rulable_users = list(rulable_users_qs)
         user1_count = 0
         self.logger.info(
-            f" {len(rulable_users)} citizens (with {active_users_count} active ones) "
+            f"{rulable_users_count} citizen have been listed. Starting to rule."
-            f"have been listed. Starting to rule."
         )
 
         self.logger.info("Creating stars for all citizen")
         individual_scores = self.compute_individual_scores()
         GalaxyStar.objects.bulk_create(
             [
-                GalaxyStar(
+                GalaxyStar(owner=user, galaxy=self, mass=individual_scores[user.id])
-                    owner_id=user.id, galaxy=self, mass=individual_scores[user.id]
-                )
                 for user in rulable_users
             ]
         )
@@ -418,9 +405,9 @@ class Galaxy(models.Model):
         t_global_start = time.time()
         while len(rulable_users) > 0:
             user1 = rulable_users.pop()
-            if not user1.is_active_in_galaxy:
-                continue
             user1_count += 1
+            rulable_users_count2 = len(rulable_users)
+
             star1 = stars[user1.id]
 
             lanes = []
@@ -461,20 +448,17 @@ class Galaxy(models.Model):
                 self.logger.info("")
                 self.logger.info(f" Ruling of {self} ".center(60, "#"))
                 self.logger.info(
-                    f"Progression: {user1_count}/{active_users_count} "
+                    f"Progression: {user1_count}/{rulable_users_count} "
-                    f"citizen -- {active_users_count - user1_count} remaining"
+                    f"citizen -- {rulable_users_count - user1_count} remaining"
                 )
                 self.logger.info(f"Speed: {global_avg_speed:.2f} citizen per second")
-                eta = len(rulable_users) // global_avg_speed
+                eta = rulable_users_count2 // global_avg_speed
                 self.logger.info(
                     f"ETA: {int(eta // 60 % 60)} minutes {int(eta % 60)} seconds"
                 )
                 self.logger.info("#" * 60)
             t_global_start = time.time()
 
-        count, _ = self.stars.filter(Q(lanes1=None) & Q(lanes2=None)).delete()
-        self.logger.info(f"{count} orphan stars have been trimmed.")
-
         # Here, we get the IDs of the old galaxies that we'll need to delete. In normal operation, only one galaxy
         # should be returned, and we can't delete it yet, as it's the one still displayed by the Sith.
         old_galaxies_pks = list(

galaxy/tests.py

@@ -122,7 +122,7 @@ class TestGalaxyModel(TestCase):
             self.com,
         ]
 
-        with self.assertNumQueries(38):
+        with self.assertNumQueries(44):
             while len(users) > 0:
                 user1 = users.pop(0)
                 family_scores = Galaxy.compute_user_family_score(user1)
@@ -150,7 +150,7 @@ class TestGalaxyModel(TestCase):
         that the number of queries to rule the galaxy is stable.
         """
         galaxy = Galaxy.objects.create()
-        with self.assertNumQueries(36):
+        with self.assertNumQueries(39):
             galaxy.rule(0)  # We want everybody here
 
 

locale/fr/LC_MESSAGES/django.po

@@ -6,7 +6,7 @@
 msgid ""
 msgstr ""
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-09-01 18:18+0200\n"
+"POT-Creation-Date: 2025-09-14 01:35+0200\n"
 "PO-Revision-Date: 2016-07-18\n"
 "Last-Translator: Maréchal <thomas.girod@utbm.fr\n"
 "Language-Team: AE info <ae.info@utbm.fr>\n"
@@ -561,6 +561,7 @@ msgstr ""
 #: core/templates/core/user_godfathers_tree.jinja
 #: core/templates/core/user_preferences.jinja
 #: counter/templates/counter/cash_register_summary.jinja
+#: counter/templates/counter/product_form.jinja
 #: forum/templates/forum/reply.jinja
 #: subscription/templates/subscription/fragments/creation_form.jinja
 #: trombi/templates/trombi/comment.jinja
@@ -1713,8 +1714,8 @@ msgid ""
 "AE UTBM is a voluntary organisation run by UTBM students. It organises "
 "student life at UTBM and manages its student facilities."
 msgstr ""
-"L'AE UTBM est une association bénévole gérée par les étudiants de "
+"L'AE UTBM est une association bénévole gérée par les étudiants de l'UTBM. "
-"l'UTBM. Elle organise la vie étudiante de l'UTBM et gère ses lieux de vie."
+"Elle organise la vie étudiante de l'UTBM et gère ses lieux de vie."
 
 #: core/templates/core/base/footer.jinja core/templates/core/base/navbar.jinja
 msgid "Contacts"
@@ -2157,10 +2158,6 @@ msgstr ""
 msgid "Page history"
 msgstr "Historique de la page"
 
-#: core/templates/core/page_list.jinja
-msgid "There is no page in this website."
-msgstr "Il n'y a pas de page sur ce site web."
-
 #: core/templates/core/page_prop.jinja
 msgid "Page properties"
 msgstr "Propriétés de la page"
@@ -2896,6 +2893,20 @@ msgstr "Cet UID est invalide"
 msgid "User not found"
 msgstr "Utilisateur non trouvé"
 
+#: counter/forms.py
+msgid "Enabled"
+msgstr "Activé"
+
+#: counter/forms.py
+msgid "Date and time of archiving"
+msgstr "Date et heure de l'archivage"
+
+#: counter/forms.py
+msgid ""
+"Automatic archiving cannot be enabled without providing a archiving date."
+msgstr ""
+"L'archivage automatique ne peut pas activé sans fournir une date d'archivage."
+
 #: counter/forms.py
 msgid ""
 "Describe the product. If it's an event's click, give some insights about it, "
@@ -3548,6 +3559,29 @@ msgstr ""
 "votre cotisation. Si vous ne renouvelez pas votre cotisation, il n'y aura "
 "aucune conséquence autre que le retrait de l'argent de votre compte."
 
+#: counter/templates/counter/product_form.jinja
+#, python-format
+msgid "Edit product %(name)s"
+msgstr "Édition du produit %(name)s"
+
+#: counter/templates/counter/product_form.jinja
+#, fuzzy
+#| msgid "Product state"
+msgid "Product creation"
+msgstr "Etat du produit"
+
+#: counter/templates/counter/product_form.jinja
+msgid "Automatic archiving"
+msgstr "Archivage automatique"
+
+#: counter/templates/counter/product_form.jinja
+msgid ""
+"Automatic archiving allows you to mark a product as archived and remove it "
+"from all its counters at a specified time and date."
+msgstr ""
+"L'archivage automatique permet de marquer un produit comme archivé et de le "
+"retirer de tous ses comptoirs à une heure et une date voulues."
+
 #: counter/templates/counter/product_list.jinja
 msgid "Product list"
 msgstr "Liste des produits"