WIP: Unify names of generic relations to media classes

api/api/migrations/0069_alter_audiodecision_options_and_more.py

@@ -0,0 +1,116 @@
+# Generated by Django 4.2.11 on 2024-07-04 07:01
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('api', '0068_remove_audioreport_status_remove_imagereport_status'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='audiodecision',
+            options={'default_related_name': 'decision'},
+        ),
+        migrations.AlterModelOptions(
+            name='audiodecisionthrough',
+            options={'default_related_name': 'decision_through'},
+        ),
+        migrations.AlterModelOptions(
+            name='audioreport',
+            options={'default_related_name': 'report'},
+        ),
+        migrations.AlterModelOptions(
+            name='deletedaudio',
+            options={'default_related_name': 'deleted_media', 'verbose_name_plural': 'Deleted audio'},
+        ),
+        migrations.AlterModelOptions(
+            name='deletedimage',
+            options={'default_related_name': 'deleted_media'},
+        ),
+        migrations.AlterModelOptions(
+            name='imagedecision',
+            options={'default_related_name': 'decision'},
+        ),
+        migrations.AlterModelOptions(
+            name='imagedecisionthrough',
+            options={'default_related_name': 'decision_through'},
+        ),
+        migrations.AlterModelOptions(
+            name='imagereport',
+            options={'default_related_name': 'report'},
+        ),
+        migrations.AlterModelOptions(
+            name='sensitiveaudio',
+            options={'default_related_name': 'sensitive_media', 'verbose_name_plural': 'Sensitive audio'},
+        ),
+        migrations.AlterModelOptions(
+            name='sensitiveimage',
+            options={'default_related_name': 'sensitive_media'},
+        ),
+        migrations.AlterField(
+            model_name='audiodecision',
+            name='media_objs',
+            field=models.ManyToManyField(help_text='The audio items being moderated.', related_name='decision', through='api.AudioDecisionThrough', to='api.audio'),
+        ),
+        migrations.AlterField(
+            model_name='audiodecision',
+            name='moderator',
+            field=models.ForeignKey(help_text='The moderator who undertook this decision.', on_delete=django.db.models.deletion.DO_NOTHING, related_name='audio_decision', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='audiodecisionthrough',
+            name='media_obj',
+            field=models.ForeignKey(db_column='identifier', db_constraint=False, on_delete=django.db.models.deletion.DO_NOTHING, related_name='decision_through', to='api.audio', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='audioreport',
+            name='media_obj',
+            field=models.ForeignKey(db_column='identifier', db_constraint=False, help_text='The reference to the audio being reported.', on_delete=django.db.models.deletion.DO_NOTHING, related_name='report', to='api.audio', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='deletedaudio',
+            name='media_obj',
+            field=models.OneToOneField(db_column='identifier', db_constraint=False, help_text='The reference to the deleted audio.', on_delete=django.db.models.deletion.DO_NOTHING, primary_key=True, related_name='deleted_media', serialize=False, to='api.audio', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='deletedimage',
+            name='media_obj',
+            field=models.OneToOneField(db_column='identifier', db_constraint=False, help_text='The reference to the deleted image.', on_delete=django.db.models.deletion.DO_NOTHING, primary_key=True, related_name='deleted_media', serialize=False, to='api.image', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='imagedecision',
+            name='media_objs',
+            field=models.ManyToManyField(help_text='The image items being moderated.', related_name='decision', through='api.ImageDecisionThrough', to='api.image'),
+        ),
+        migrations.AlterField(
+            model_name='imagedecision',
+            name='moderator',
+            field=models.ForeignKey(help_text='The moderator who undertook this decision.', on_delete=django.db.models.deletion.DO_NOTHING, related_name='image_decision', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='imagedecisionthrough',
+            name='media_obj',
+            field=models.ForeignKey(db_column='identifier', db_constraint=False, on_delete=django.db.models.deletion.DO_NOTHING, related_name='decision_through', to='api.image', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='imagereport',
+            name='media_obj',
+            field=models.ForeignKey(db_column='identifier', db_constraint=False, help_text='The reference to the image being reported.', on_delete=django.db.models.deletion.DO_NOTHING, related_name='report', to='api.image', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='sensitiveaudio',
+            name='media_obj',
+            field=models.OneToOneField(db_column='identifier', db_constraint=False, help_text='The reference to the sensitive audio.', on_delete=django.db.models.deletion.DO_NOTHING, primary_key=True, related_name='sensitive_media', serialize=False, to='api.audio', to_field='identifier'),
+        ),
+        migrations.AlterField(
+            model_name='sensitiveimage',
+            name='media_obj',
+            field=models.OneToOneField(db_column='identifier', db_constraint=False, help_text='The reference to the sensitive image.', on_delete=django.db.models.deletion.DO_NOTHING, primary_key=True, related_name='sensitive_media', serialize=False, to='api.image', to_field='identifier'),
+        ),
+    ]

api/api/models/audio.py

@@ -7,7 +7,7 @@
 from uuslug import uuslug
 
 from api.constants.media_types import AUDIO_TYPE
-from api.models import OpenLedgerModel
+from api.models.base import OpenLedgerModel
 from api.models.media import (
     AbstractAltFile,
     AbstractDeletedMedia,
@@ -17,6 +17,7 @@
     AbstractMediaList,
     AbstractMediaReport,
     AbstractSensitiveMedia,
+    MediaModeratorForeignKey,
 )
 from api.models.mixins import FileMixin, ForeignIdentifierMixin, MediaMixin
 from api.utils.waveform import generate_peaks
@@ -155,6 +156,8 @@ class Audio(AudioFileMixin, AbstractMedia):
         `audio_set_foreign_identifier` and `provider`.
     """
 
+    media_type = "audio"
+
     audioset = models.ForeignObject(
         to="AudioSet",
         on_delete=models.DO_NOTHING,
@@ -206,9 +209,8 @@ class Audio(AudioFileMixin, AbstractMedia):
         """),
     )
 
-    @property
-    def sensitive(self) -> bool:
-        return hasattr(self, "sensitive_audio")
+    class Meta(AbstractMedia.Meta):
+        db_table = "audio"
 
     @property
     def alternative_files(self):
@@ -248,9 +250,6 @@ def get_or_create_waveform(self):
 
         return add_on.waveform_peaks
 
-    class Meta(AbstractMedia.Meta):
-        db_table = "audio"
-
     def get_absolute_url(self):
         """Enable the "View on site" link in the Django Admin."""
 
@@ -277,7 +276,7 @@ class DeletedAudio(AbstractDeletedMedia):
         primary_key=True,
         db_constraint=False,
         db_column="identifier",
-        related_name="deleted_audio",
+        related_name="deleted_media",
         help_text="The reference to the deleted audio.",
     )
 
@@ -303,7 +302,7 @@ class SensitiveAudio(AbstractSensitiveMedia):
         primary_key=True,
         db_constraint=False,
         db_column="identifier",
-        related_name="sensitive_audio",
+        related_name="sensitive_media",
         help_text="The reference to the sensitive audio.",
     )
 
@@ -328,7 +327,7 @@ class AudioReport(AbstractMediaReport):
         on_delete=models.DO_NOTHING,
         db_constraint=False,
         db_column="identifier",
-        related_name="audio_report",
+        related_name="report",
         help_text="The reference to the audio being reported.",
     )
     decision = models.ForeignKey(
@@ -348,10 +347,13 @@ class AudioDecision(AbstractMediaDecision):
 
     media_class = Audio
 
+    moderator = MediaModeratorForeignKey(related_name="audio_decision")
+
     media_objs = models.ManyToManyField(
         to="Audio",
         through="AudioDecisionThrough",
         help_text="The audio items being moderated.",
+        related_name="decision",
     )
 
 
@@ -364,15 +366,14 @@ class AudioDecisionThrough(AbstractMediaDecisionThrough):
     """
 
     media_class = Audio
-    sensitive_media_class = SensitiveAudio
-    deleted_media_class = DeletedAudio
 
     media_obj = models.ForeignKey(
         Audio,
         to_field="identifier",
         on_delete=models.DO_NOTHING,
         db_column="identifier",
         db_constraint=False,
+        related_name="decision_through",
     )
     decision = models.ForeignKey(AudioDecision, on_delete=models.CASCADE)
 

api/api/models/base.py

@@ -1,5 +1,9 @@
+from typing import Protocol
+
 from django.db import models
 
+from api.constants.media_types import MediaType
+
 
 class OpenLedgerModel(models.Model):
     created_on = models.DateTimeField(auto_now_add=True)
@@ -12,3 +16,74 @@ def __iter__(self):
         for field_name in self._meta.get_fields():
             value = getattr(self, field_name, None)
             yield field_name, value
+
+
+class OpenverseMediaModel(Protocol):
+    media_type: MediaType
+
+
+class MediaRelatedBase(models.base.ModelBase):
+    """
+    Metaclass for models related to any media type, for each each media type has its own subclass.
+
+    The metaclass ensures media types use the same names to refer to related models
+    of the same kind. Django will not inherit properties from parent the ``Meta``
+    of model base classes. As such, this class implements a "related_name" specific
+    inheritance via base classes' ``Meta``.
+
+    Additionally, it ensures base classes define the media class they are related to
+    and that the media class has a back reference to the related model. The method
+    used ensures all media classes have identical properties with which to reference
+    shared related models.
+    """
+
+    def _handle_abstract(cls, name, bases, attrs, related_name: str | None, **kwargs):
+        if not related_name:
+            raise TypeError(
+                f"{name} missing 1 required keyword-only argument: 'related_name'"
+            )
+
+        setattr(attrs["Meta"], "default_related_name", related_name)
+
+        return super().__new__(cls, name, bases, attrs, **kwargs)
+
+    def _handle_final(cls, name, bases, attrs, **kwargs):
+        if "media_class" not in attrs:
+            raise TypeError(f"{name} missing required attribute: 'media_class'")
+
+        media_class = attrs["media_class"]
+
+        default_related_name = None
+        for base in bases:
+            if not hasattr(base, "Meta"):
+                continue
+
+            default_related_name = getattr(base.Meta, "default_related_name", None)
+            if not default_related_name:
+                continue
+
+            if "Meta" not in attrs:
+                attrs["Meta"] = type(
+                    "Meta", (), {"default_related_name": default_related_name}
+                )
+            else:
+                setattr(attrs["Meta"], "default_related_name", default_related_name)
+
+        if default_related_name is None:
+            raise NotImplementedError(
+                f"Media-related model {name} is not abstract, but has no base class that "
+                "defines 'default_related_name'. Did you mean to mark this model abstract?"
+            )
+
+        new_model = super().__new__(cls, name, bases, attrs, **kwargs)
+
+        setattr(media_class, f"{default_related_name}_class", new_model)
+
+        return new_model
+
+    def __new__(cls, name, bases, attrs, *, related_name: str | None = None, **kwargs):
+        if "Meta" in attrs and getattr(attrs["Meta"], "abstract", False):
+            # Abstract models are models with a ``Meta`` defined with ``abstract = True``
+            return cls._handle_abstract(cls, name, bases, attrs, related_name, **kwargs)
+        else:
+            return cls._handle_final(cls, name, bases, attrs, **kwargs)

api/api/models/image.py

@@ -12,6 +12,7 @@
     AbstractMediaList,
     AbstractMediaReport,
     AbstractSensitiveMedia,
+    MediaModeratorForeignKey,
 )
 from api.models.mixins import FileMixin
 
@@ -51,6 +52,8 @@ class Image(ImageFileMixin, AbstractMedia):
     category: eg. photograph, digitized_artwork & illustration
     """
 
+    media_type = "image"
+
     class Meta(AbstractMedia.Meta):
         db_table = "image"
 
@@ -61,10 +64,6 @@ def get_absolute_url(self):
 
         return reverse("image-detail", args=[str(self.identifier)])
 
-    @property
-    def sensitive(self) -> bool:
-        return hasattr(self, "sensitive_image")
-
 
 class DeletedImage(AbstractDeletedMedia):
     """
@@ -84,7 +83,7 @@ class DeletedImage(AbstractDeletedMedia):
         primary_key=True,
         db_constraint=False,
         db_column="identifier",
-        related_name="deleted_image",
+        related_name="deleted_media",
         help_text="The reference to the deleted image.",
     )
 
@@ -107,7 +106,7 @@ class SensitiveImage(AbstractSensitiveMedia):
         primary_key=True,
         db_constraint=False,
         db_column="identifier",
-        related_name="sensitive_image",
+        related_name="sensitive_media",
         help_text="The reference to the sensitive image.",
     )
 
@@ -131,7 +130,7 @@ class ImageReport(AbstractMediaReport):
         on_delete=models.DO_NOTHING,
         db_constraint=False,
         db_column="identifier",
-        related_name="image_report",
+        related_name="report",
         help_text="The reference to the image being reported.",
     )
     decision = models.ForeignKey(
@@ -151,10 +150,13 @@ class ImageDecision(AbstractMediaDecision):
 
     media_class = Image
 
+    moderator = MediaModeratorForeignKey(related_name="image_decision")
+
     media_objs = models.ManyToManyField(
         to="Image",
         through="ImageDecisionThrough",
         help_text="The image items being moderated.",
+        related_name="decision",
     )
 
 
@@ -167,16 +169,16 @@ class ImageDecisionThrough(AbstractMediaDecisionThrough):
     """
 
     media_class = Image
-    sensitive_media_class = SensitiveImage
-    deleted_media_class = DeletedImage
 
     media_obj = models.ForeignKey(
         Image,
         to_field="identifier",
         on_delete=models.DO_NOTHING,
         db_column="identifier",
         db_constraint=False,
+        related_name="decision_through",
     )
+
     decision = models.ForeignKey(ImageDecision, on_delete=models.CASCADE)