fix: create and implement attachment filename generator

.gitignore

@@ -13,6 +13,7 @@ certs/
 fetc/ldap_settings.py
 fetc/saml_settings.py
 *.sqlite3
+cdh_files/
 
 ### Coverage ###
 .coverage

attachments/__init__.py

@@ -0,0 +1 @@
+

attachments/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

attachments/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AttachmentsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "attachments"

attachments/kinds.py

@@ -0,0 +1,73 @@
+from django.utils.translation import gettext as _
+from django.urls import reverse
+
+from proposals.models import Proposal
+from studies.models import Study
+from main.utils import renderable
+from attachments.models import ProposalAttachment, StudyAttachment
+from attachments.utils import AttachmentKind, desiredness
+
+
+class ProposalAttachmentKind(AttachmentKind):
+
+    attached_object = Proposal
+    attachment_class = ProposalAttachment
+
+
+class StudyAttachmentKind(AttachmentKind):
+
+    attached_object = Study
+    attachment_class = StudyAttachment
+
+
+class InformationLetter(StudyAttachmentKind):
+
+    db_name = "information_letter"
+    name = _("Informatiebrief")
+    description = _("Omschrijving informatiebrief")
+    desiredness = desiredness.REQUIRED
+
+
+class ConsentForm(AttachmentKind):
+
+    db_name = "consent_form"
+    name = _("Toestemmingsverklaring")
+    description = _("Omschrijving toestemmingsverklaring")
+
+
+class DataManagementPlan(ProposalAttachmentKind):
+
+    db_name = "dmp"
+    name = _("Data Management Plan")
+    description = _("Omschrijving DMP")
+
+    def num_recommended(self):
+        return 1
+
+
+class OtherProposalAttachment(ProposalAttachmentKind):
+
+    db_name = "other"
+    name = _("Overige bestanden")
+    description = _("Voor alle overige soorten bestanden")
+
+    def num_required(self):
+        return 0
+
+    def num_suggested(self):
+        """
+        You may always add another miscellaneous file."""
+        return self.num_provided + 1
+
+
+STUDY_ATTACHMENTS = [
+    InformationLetter,
+    ConsentForm,
+]
+
+PROPOSAL_ATTACHMENTS = [
+    DataManagementPlan,
+    OtherProposalAttachment,
+]
+
+ATTACHMENTS = PROPOSAL_ATTACHMENTS + STUDY_ATTACHMENTS

attachments/migrations/0001_initial.py

@@ -0,0 +1,128 @@
+# Generated by Django 4.2.11 on 2024-09-23 17:00
+
+import cdh.files.db.fields
+from django.db import migrations, models
+import django.db.models.deletion
+import main.utils
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("proposals", "0053_auto_20240201_1557"),
+        ("files", "0004_auto_20210921_1014"),
+        ("studies", "0028_remove_study_sessions_number"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Attachment",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "kind",
+                    models.CharField(
+                        choices=[
+                            ("dmp", "Data Management Plan"),
+                            ("other", "Overige bestanden"),
+                            ("information_letter", "Informatiebrief"),
+                            ("consent_form", "Toestemmingsverklaring"),
+                        ],
+                        default=("", "Gelieve selecteren"),
+                        max_length=100,
+                    ),
+                ),
+                (
+                    "name",
+                    models.CharField(
+                        default="",
+                        help_text="Geef je bestand een omschrijvende naam, het liefst maar enkele woorden.",
+                        max_length=50,
+                    ),
+                ),
+                (
+                    "comments",
+                    models.TextField(
+                        default="",
+                        help_text="Geef hier je motivatie om dit bestand toe te voegen en waar je het voor gaat gebruiken tijdens je onderzoek. Eventuele opmerkingen voor de FETC kun je hier ook kwijt.",
+                        max_length=2000,
+                    ),
+                ),
+                (
+                    "parent",
+                    models.ForeignKey(
+                        default=None,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="children",
+                        to="attachments.attachment",
+                    ),
+                ),
+                (
+                    "upload",
+                    cdh.files.db.fields.FileField(
+                        filename_generator=cdh.files.db.fields._default_filename_generator,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="files.file",
+                    ),
+                ),
+            ],
+            bases=(models.Model, main.utils.renderable),
+        ),
+        migrations.CreateModel(
+            name="StudyAttachment",
+            fields=[
+                (
+                    "attachment_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="attachments.attachment",
+                    ),
+                ),
+                (
+                    "attached_to",
+                    models.ManyToManyField(
+                        related_name="attachments", to="studies.study"
+                    ),
+                ),
+            ],
+            bases=("attachments.attachment",),
+        ),
+        migrations.CreateModel(
+            name="ProposalAttachment",
+            fields=[
+                (
+                    "attachment_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="attachments.attachment",
+                    ),
+                ),
+                (
+                    "attached_to",
+                    models.ManyToManyField(
+                        related_name="attachments", to="proposals.proposal"
+                    ),
+                ),
+            ],
+            bases=("attachments.attachment",),
+        ),
+    ]

attachments/migrations/0002_attachment_author_alter_attachment_upload.py

@@ -0,0 +1,40 @@
+# Generated by Django 4.2.11 on 2024-10-01 13:43
+
+import cdh.files.db.fields
+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),
+        ("files", "0004_auto_20210921_1014"),
+        ("attachments", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="attachment",
+            name="author",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="created_attachments",
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="attachment",
+            name="upload",
+            field=cdh.files.db.fields.FileField(
+                filename_generator=cdh.files.db.fields._default_filename_generator,
+                help_text="Selecteer hier het bestand om toe te voegen.",
+                on_delete=django.db.models.deletion.CASCADE,
+                to="files.file",
+                verbose_name="Bestand",
+            ),
+        ),
+    ]

attachments/models.py

@@ -0,0 +1,131 @@
+from django.db import models
+from django.contrib.auth import get_user_model
+from django.utils.translation import gettext as _
+from main.utils import renderable
+from attachments.utils import attachment_filename_generator
+
+from cdh.files.db import FileField as CDHFileField
+
+class Attachment(models.Model, renderable):
+
+    template_name = "attachments/attachment_model.html"
+    author = models.ForeignKey(
+        get_user_model(),
+        related_name="created_attachments",
+        null=True,
+        on_delete=models.SET_NULL,
+        default=None,
+    )
+    upload = CDHFileField(
+        verbose_name=_("Bestand"),
+        help_text=_("Selecteer hier het bestand om toe te voegen."),
+        filename_generator=attachment_filename_generator,
+    )
+    parent = models.ForeignKey(
+        "attachments.attachment",
+        related_name="children",
+        null=True,
+        on_delete=models.SET_NULL,
+        default=None,
+    )
+    kind = models.CharField(
+        max_length=100,
+        # It would be nice to be able to define fixed choices here.
+        # But I haven't found a way to nicely import them from kinds.py
+        # without circular imports. So for now we just set the choices in
+        # whatever form needs them.
+        # From Django 5 onwards we can define a callable to get
+        # the choices which would be the preferred solution.
+        default=("", _("Gelieve selecteren")),
+    )
+    name = models.CharField(
+        max_length=50,
+    )
+    comments = models.TextField(
+        max_length=2000,
+        default="",
+        help_text=_(
+            "Geef hier optioneel je motivatie om dit bestand toe te voegen en "
+            "waar "
+            "je het voor gaat gebruiken tijdens je onderzoek. Eventuele "
+            "opmerkingen voor de FETC kun je hier ook kwijt."
+        ),
+    )
+
+    def get_correct_submodel(self):
+        if self.__class__.__name__ != "Attachment":
+            # In this case, we're already dealing with a submodel
+            return self
+        submodels = [StudyAttachment, ProposalAttachment]
+        # By default, lowering the class name is how subclassed model
+        # relation names are generated by Django. That's why the following
+        # lines work.
+        # However, if we use a different related_name or run into a name
+        # collision we'd have to be smarter about getting the submodel.
+        for submodel in submodels:
+            key = submodel.__name__.lower()
+            if hasattr(self, key):
+                return getattr(self, key)
+        raise KeyError("Couldn't find a matching submodel.")
+
+    def detach(self, other_object):
+        """
+        Remove an attachment from an owner object. If no other
+        owner objects remain, delete the attachment.
+
+        This method is simple enough to define for all submodels,
+        assuming they use the attached_to attribute name. However,
+        base Attachments do not have an attached_to attribute, so
+        we have to defer to the submodel if detach is called on a
+        base Attachment instance.
+        """
+        if self.__class__.__name__ == "Attachment":
+            attachment = self.get_correct_submodel()
+            return attachment.detach(other_object)
+        # The following part only runs if called from a submodel
+        if self.attached_to.count() > 1:
+            self.attached_to.remove(other_object)
+        else:
+            self.delete()
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["attachment"] = self
+        return context
+
+
+class ProposalAttachment(
+    Attachment,
+):
+    attached_to = models.ManyToManyField(
+        "proposals.Proposal",
+        related_name="attachments",
+    )
+
+    def get_owner_for_proposal(
+        self,
+        proposal,
+    ):
+        """
+        This method doesn't do much, it's just here to provide
+        a consistent interface for getting owner objects.
+        """
+        return proposal
+
+
+class StudyAttachment(
+    Attachment,
+):
+    attached_to = models.ManyToManyField(
+        "studies.Study",
+        related_name="attachments",
+    )
+
+    def get_owner_for_proposal(
+        self,
+        proposal,
+    ):
+        """
+        Gets the owner study based on given proposal.
+        """
+        return self.attached_to.get(proposal=proposal)

attachments/templates/attachments/attachment_model.html

@@ -0,0 +1,2 @@
+<a href="{% url "proposals:download_attachment_original" proposal_pk=proposal.pk attachment_pk=attachment.pk %}">
+{{ attachment.upload }}</a>