Replace Sound in_use and is_used_by_other_user with fields to avoid n+1 queries on templates

pablodiegoss · pablodiegoss · commit a8d7c0ca32d1 · 2026-07-11T20:09:58.000+01:00
diff --git a/src/core/forms.py b/src/core/forms.py
@@ -399,7 +399,7 @@ def clean_file(self):
         # Sound already exists, we need to check if it's being used by another user
         if self.instance.pk:
             if file_has_changed(file, self.instance.file):
-                if self.instance.is_used_by_other_user():
+                if self.instance.is_used_by_other_user:
                     raise forms.ValidationError(
                         _(
                             "This sound is being used by another user. You cannot change the source file."
diff --git a/src/core/jinja2/core/templates/sound_thumbnail.jinja2 b/src/core/jinja2/core/templates/sound_thumbnail.jinja2
@@ -5,7 +5,7 @@
        controls>
 </audio>
 {% if editable %}
-    {% set can_edit = not sound.is_used_by_other_user() %}
+    {% set can_edit = not sound.is_used_by_other_user %}
     {% set can_delete = not sound.in_use %}
     {% set edit_reason = _("This sound is used by other users and cannot be edited.") %}
     {% set delete_reason = _("This sound is in use and cannot be deleted.") %}
diff --git a/src/core/migrations/0043_add_in_use_fields_to_sound.py b/src/core/migrations/0043_add_in_use_fields_to_sound.py
@@ -0,0 +1,51 @@
+# Generated by Django 6.0.6 on 2026-07-11 19:05
+
+import pgtrigger.compiler
+import pgtrigger.migrations
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0042_populate_is_used_by_other_user_field'),
+    ]
+
+    operations = [
+        pgtrigger.migrations.RemoveTrigger(
+            model_name='sound',
+            name='insert_insert',
+        ),
+        pgtrigger.migrations.RemoveTrigger(
+            model_name='sound',
+            name='update_update',
+        ),
+        migrations.AddField(
+            model_name='sound',
+            name='in_use',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='sound',
+            name='is_used_by_other_user',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='soundevent',
+            name='in_use',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='soundevent',
+            name='is_used_by_other_user',
+            field=models.BooleanField(default=False),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='sound',
+            trigger=pgtrigger.compiler.Trigger(name='insert_insert', sql=pgtrigger.compiler.UpsertTriggerSql(func='INSERT INTO "core_soundevent" ("author", "created", "file", "file_extension", "file_name_original", "file_size", "id", "in_use", "is_used_by_other_user", "modified", "owner_id", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "title") VALUES (NEW."author", NEW."created", NEW."file", NEW."file_extension", NEW."file_name_original", NEW."file_size", NEW."id", NEW."in_use", NEW."is_used_by_other_user", NEW."modified", NEW."owner_id", _pgh_attach_context(), NOW(), \'insert\', NEW."id", NEW."title"); RETURN NULL;', hash='cc51980a6dcdc729109bf15f4be631e1aa1b398e', operation='INSERT', pgid='pgtrigger_insert_insert_fe2cc', table='core_sound', when='AFTER')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='sound',
+            trigger=pgtrigger.compiler.Trigger(name='update_update', sql=pgtrigger.compiler.UpsertTriggerSql(condition='WHEN (OLD.* IS DISTINCT FROM NEW.*)', func='INSERT INTO "core_soundevent" ("author", "created", "file", "file_extension", "file_name_original", "file_size", "id", "in_use", "is_used_by_other_user", "modified", "owner_id", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "title") VALUES (NEW."author", NEW."created", NEW."file", NEW."file_extension", NEW."file_name_original", NEW."file_size", NEW."id", NEW."in_use", NEW."is_used_by_other_user", NEW."modified", NEW."owner_id", _pgh_attach_context(), NOW(), \'update\', NEW."id", NEW."title"); RETURN NULL;', hash='4d24c37be50a81ac25831f917e6380db10013293', operation='UPDATE', pgid='pgtrigger_update_update_8c5ab', table='core_sound', when='AFTER')),
+        ),
+    ]
diff --git a/src/core/migrations/0044_populate_sound_in_use_fields.py b/src/core/migrations/0044_populate_sound_in_use_fields.py
@@ -0,0 +1,37 @@
+# Generated by Django 6.0.6 on 2026-07-11 19:06
+
+from django.db import migrations
+
+
+def populate_sound_flags(apps, schema_editor):
+    Sound = apps.get_model("core", "Sound")
+    Artwork = apps.get_model("core", "Artwork")
+    Object = apps.get_model("core", "Object")
+    Exhibit = apps.get_model("core", "Exhibit")
+
+    for sound in Sound.objects.all():
+        is_in_use = (
+            Artwork.objects.filter(sound=sound).exists()
+            or Object.objects.filter(sound=sound).exists()
+            or Exhibit.objects.filter(sounds=sound).exists()
+        )
+        used_by_other = (
+            Artwork.objects.filter(sound=sound).exclude(author=sound.owner).exists()
+            or Object.objects.filter(sound=sound).exclude(owner=sound.owner).exists()
+            or Exhibit.objects.filter(sounds=sound).exclude(owner=sound.owner).exists()
+        )
+        if is_in_use or used_by_other:
+            Sound.objects.filter(pk=sound.pk).update(
+                in_use=is_in_use, is_used_by_other_user=used_by_other
+            )
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0043_add_in_use_fields_to_sound'),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_sound_flags, migrations.RunPython.noop),
+    ]
diff --git a/src/core/models.py b/src/core/models.py
@@ -3,7 +3,7 @@
 import pghistory
 from django.core.files.base import ContentFile as CF
 from django.db import models
-from django.db.models.signals import post_delete, post_save, pre_save
+from django.db.models.signals import m2m_changed, post_delete, post_save, pre_save
 from django.dispatch import receiver
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
@@ -75,6 +75,8 @@ class Sound(TimeStampedModel, ContentMixin):
     file_extension = models.CharField(
         max_length=10, db_index=True, choices=SoundExtensions.choices
     )
+    in_use = models.BooleanField(default=False)
+    is_used_by_other_user = models.BooleanField(default=False)
 
     @property
     def date(self):
@@ -92,27 +94,7 @@ def augmenteds_count(self):
     def exhibits_count(self):
         return self.exhibits.count()
 
-    def is_used_by_other_user(self):
-        """
-        Check if the object is used by another user.
-        This is done by checking if there are artworks that reference this object
-        and if the owner of those artworks is not the current user.
-        """
-        return (
-            self.ar_objects.exclude(owner=self.owner).exists()
-            or self.artworks.exclude(author=self.owner).exists()
-            or self.exhibits.exclude(owner=self.owner).exists()
-        )
 
-    @property
-    def in_use(self):
-        if self.exhibits_count > 0:
-            return True
-        if self.augmenteds_count > 0:
-            return True
-        if self.artworks_count > 0:
-            return True
-        return False
 
     def used_in_html_string(self):
         used_in = "{} {} {} {} {} {} {}".format(
@@ -581,7 +563,7 @@ def remove_source_file(sender, instance, **kwargs):
 
 @receiver(pre_save, sender=Artwork)
 def artwork_pre_save(sender, instance, **kwargs):
-    """Capture the previous marker/object before an artwork is updated."""
+    """Capture the previous marker/object/sound before an artwork is updated."""
     if not instance.pk:
         return
     try:
@@ -590,14 +572,17 @@ def artwork_pre_save(sender, instance, **kwargs):
         return
     instance._old_marker_id = old.marker_id
     instance._old_augmented_id = old.augmented_id
+    instance._old_sound_id = old.sound_id
 
 
 @receiver(post_save, sender=Artwork)
 def artwork_post_save(sender, instance, **kwargs):
-    """Mark the current marker/object as in_use; check if old ones are still used."""
+    """Mark the current marker/object/sound as in_use; check if old ones are still used."""
     # Mark current references as in use
     Marker.objects.filter(pk=instance.marker_id, in_use=False).update(in_use=True)
     Object.objects.filter(pk=instance.augmented_id, in_use=False).update(in_use=True)
+    if instance.sound_id:
+        Sound.objects.filter(pk=instance.sound_id, in_use=False).update(in_use=True)
 
     # Update is_used_by_other_user for current marker/object
     marker = Marker.objects.get(pk=instance.marker_id)
@@ -610,6 +595,13 @@ def artwork_post_save(sender, instance, **kwargs):
         if not augmented.is_used_by_other_user:
             Object.objects.filter(pk=augmented.pk).update(is_used_by_other_user=True)
 
+    # Update is_used_by_other_user for current sound
+    if instance.sound_id:
+        sound = Sound.objects.get(pk=instance.sound_id)
+        if instance.author_id != sound.owner_id:
+            if not sound.is_used_by_other_user:
+                Sound.objects.filter(pk=sound.pk).update(is_used_by_other_user=True)
+
     # If marker changed, check if the old one is still in use
     old_marker_id = getattr(instance, "_old_marker_id", None)
     if old_marker_id and old_marker_id != instance.marker_id:
@@ -632,10 +624,15 @@ def artwork_post_save(sender, instance, **kwargs):
             if not still_used_by_other:
                 Object.objects.filter(pk=old_augmented_id).update(is_used_by_other_user=False)
 
+    # If sound changed, check if the old one is still in use
+    old_sound_id = getattr(instance, "_old_sound_id", None)
+    if old_sound_id and old_sound_id != instance.sound_id:
+        _recalculate_sound_flags(old_sound_id)
+
 
 @receiver(post_delete, sender=Artwork)
 def artwork_post_delete(sender, instance, **kwargs):
-    """When an artwork is deleted, check if its marker/object are still in use."""
+    """When an artwork is deleted, check if its marker/object/sound are still in use."""
     if not Artwork.objects.filter(marker_id=instance.marker_id).exists():
         Marker.objects.filter(pk=instance.marker_id).update(in_use=False, is_used_by_other_user=False)
     else:
@@ -649,3 +646,78 @@ def artwork_post_delete(sender, instance, **kwargs):
         obj = Object.objects.get(pk=instance.augmented_id)
         if not obj.artworks.exclude(author=obj.owner).exists():
             Object.objects.filter(pk=obj.pk).update(is_used_by_other_user=False)
+
+    if instance.sound_id:
+        _recalculate_sound_flags(instance.sound_id)
+
+
+def _recalculate_sound_flags(sound_id):
+    """Recalculate in_use and is_used_by_other_user for a Sound."""
+    try:
+        sound = Sound.objects.get(pk=sound_id)
+    except Sound.DoesNotExist:
+        return
+
+    is_in_use = (
+        sound.artworks.exists()
+        or sound.ar_objects.exists()
+        or sound.exhibits.exists()
+    )
+    used_by_other = (
+        sound.artworks.exclude(author=sound.owner).exists()
+        or sound.ar_objects.exclude(owner=sound.owner).exists()
+        or sound.exhibits.exclude(owner=sound.owner).exists()
+    )
+    Sound.objects.filter(pk=sound_id).update(
+        in_use=is_in_use, is_used_by_other_user=used_by_other
+    )
+
+
+@receiver(pre_save, sender=Object)
+def object_pre_save(sender, instance, **kwargs):
+    """Capture the previous sound before an object is updated."""
+    if not instance.pk:
+        return
+    try:
+        old = Object.objects.get(pk=instance.pk)
+    except Object.DoesNotExist:
+        return
+    instance._old_sound_id = old.sound_id
+
+
+@receiver(post_save, sender=Object)
+def object_post_save(sender, instance, **kwargs):
+    """Update sound flags when an object's sound FK changes."""
+    if instance.sound_id:
+        sound = Sound.objects.get(pk=instance.sound_id)
+        updates = {}
+        if not sound.in_use:
+            updates["in_use"] = True
+        if instance.owner_id != sound.owner_id and not sound.is_used_by_other_user:
+            updates["is_used_by_other_user"] = True
+        if updates:
+            Sound.objects.filter(pk=sound.pk).update(**updates)
+
+    old_sound_id = getattr(instance, "_old_sound_id", None)
+    if old_sound_id and old_sound_id != instance.sound_id:
+        _recalculate_sound_flags(old_sound_id)
+
+
+@receiver(post_delete, sender=Object)
+def object_post_delete_sound(sender, instance, **kwargs):
+    """When an object is deleted, recalculate its sound's flags."""
+    if instance.sound_id:
+        _recalculate_sound_flags(instance.sound_id)
+
+
+@receiver(m2m_changed, sender=Exhibit.sounds.through)
+def exhibit_sounds_changed(sender, instance, action, pk_set, **kwargs):
+    """Update sound flags when exhibits add/remove sounds."""
+    if action in ("post_add", "post_remove", "post_clear"):
+        if pk_set:
+            for sound_id in pk_set:
+                _recalculate_sound_flags(sound_id)
+        elif action == "post_clear":
+            # post_clear doesn't provide pk_set; recalculate all sounds
+            for sound in Sound.objects.filter(in_use=True):
+                _recalculate_sound_flags(sound.pk)
diff --git a/src/users/jinja2/users/login.jinja2 b/src/users/jinja2/users/login.jinja2
@@ -30,7 +30,9 @@
                     {% endfor %}
                     {% if form.non_field_errors() %}
                         <ul class="errorlist">
-                            {% for error in form.non_field_errors() %}<li>{{ error }}</li>{% endfor %}
+                            {% for error in form.non_field_errors() %}
+                                <li>{{ error }}</li>
+                            {% endfor %}
                         </ul>
                     {% endif %}
                     <div class="form-options">
