Feature/attachment filename generator

attachments/models.py

@@ -4,6 +4,7 @@
 from django.urls import reverse
 from main.utils import renderable
 
+
 from cdh.files.db import FileField as CDHFileField
 
 # Create your models here.

attachments/templates/attachments/attachment_model.html

@@ -2,6 +2,8 @@
 
 <a href="{% url "proposals:download_attachment_original" proposal_pk=proposal.pk attachment_pk=attachment.pk %}">
 {{ attachment.upload.original_filename }}</a>
-{% if include_normalized %}
-    <span class="ms-2o">    (<a href="{% url "proposals:download_attachment" proposal_pk=proposal.pk attachment_pk=attachment.pk %}">{% trans "FETC-bestandsnaam" %}</a>)</span>
+{% if normalized_filename %}
+    <span class="ms-2o">
+        <br />
+        <a href="{% url "proposals:download_attachment" proposal_pk=proposal.pk attachment_pk=attachment.pk %}">{{ normalized_filename }}</a></span>
 {% endif %}

attachments/utils.py

@@ -1,3 +1,6 @@
+import mimetypes
+from collections import Counter
+
 from django.template.loader import get_template
 from django.utils.translation import gettext as _
 from django.urls import reverse
@@ -25,6 +28,14 @@ class AttachmentKind:
     attached_field = "attachments"
     desiredness = desiredness.OPTIONAL
 
+    @classmethod
+    def get_fn_part(cls):
+        if hasattr(cls, "fn_part"):
+            return cls.fn_part
+        # Capitalize DB name
+        parts = cls.db_name.split("_")
+        return "_".join([part.capitalize() for part in parts])
+
 
 class AttachmentSlot(renderable):
 
@@ -37,15 +48,32 @@ def __init__(
         kind=None,
         force_desiredness=None,
         optionality_group=None,
+        order=None,
     ):
         self.attachment = attachment
         self.attached_object = attached_object
-        self.kind = kind
+        self.order = order
+
+        if attachment and not kind:
+            # If an attachment was provided but no kind,
+            # attempt to get the kind from the attachment
+            self.kind = self.get_kind_from_attachment()
+        else:
+            self.kind = kind
+
         self.force_desiredness = force_desiredness
         self.optionality_group = optionality_group
         if self.optionality_group:
             self.optionality_group.members.append(self)
 
+    @classmethod
+    def from_proposal(attachment, proposal):
+        attached_object = attachment.get_owner_for_proposal(proposal)
+        return AttachmentSlot(
+            attached_object,
+            attachment=attachment,
+        )
+
     def match(self, exclude=[]):
         """
         Tries to find a matching attachment for this slot. If it finds one,
@@ -68,6 +96,16 @@ def match_and_set(self, exclude):
             return self.attachment
         return False
 
+    def get_kind_from_attachment(
+        self,
+    ):
+        return get_kind_from_str(self.attachment.kind)
+
+    def get_fetc_filename(
+        self,
+    ):
+        return generate_filename(self)
+
     @property
     def classes(self):
         if self.required:
@@ -281,6 +319,85 @@ def merge_groups(slots):
     return out
 
 
+def generate_filename(slot):
+
+    proposal = slot.get_proposal()
+    chamber = proposal.reviewing_committee.name
+    lastname = proposal.created_by.last_name
+    refnum = proposal.reference_number
+    original_fn = slot.attachment.upload.original_filename
+    kind = slot.kind.get_fn_part()
+    order = slot.order
+
+    extension = (
+        "." + original_fn.split(".")[-1][-7:]
+    )  # At most 7 chars seems reasonable
+
+    trajectory = None
+    if not type(slot.attached_object) is Proposal:
+        trajectory = "T" + str(slot.attached_object.order)
+
+    fn_parts = [
+        "FETC",
+        chamber,
+        refnum,
+        lastname,
+        trajectory,
+        kind,
+        order,
+    ]
+
+    # Translations will trip up join(), so we convert them here.
+    # This will also remove parts that are None.
+    fn_parts = [str(p) for p in fn_parts if p]
+
+    return "-".join(fn_parts) + extension
+
+
+def enumerate_slots(slots):
+    """
+    Provides an order attribute to all attachment slots whose kind
+    appears more than once in the provided list.
+    """
+    # Create seperate slot lists per attached_object
+    per_ao = sort_into_dict(
+        slots,
+        lambda x: x.attached_object,
+    ).values()
+    # Assign orders to them separately
+    for ao_slots in per_ao:
+        assign_orders(ao_slots)
+
+
+def sort_into_dict(iterable, key_func):
+    """
+    Split iterable into separate lists in a dict whose keys
+    are the shared response to all its items' key_func(item).
+    """
+    out_dict = {}
+    for item in iterable:
+        key = key_func(item)
+        if key not in out_dict:
+            out_dict[key] = [item]
+        else:
+            out_dict[key].append(item)
+    return out_dict
+
+
+def assign_orders(slots):
+    # Count total kind occurrences
+    totals = Counter([slot.kind for slot in slots])
+    # Create counter to increment gradually
+    kind_counter = Counter()
+    # Loop through the slots
+    for slot in slots:
+        if totals[slot.kind] < 2:
+            # Skip slots with unique kinds
+            continue
+        kind_counter[slot.kind] += 1
+        slot.order = kind_counter[slot.kind]
+
+
 def get_kind_from_str(db_name):
     from attachments.kinds import ATTACHMENTS, OtherAttachment
 

proposals/utils/checkers.py

@@ -1093,6 +1093,7 @@ def make_stepper_item(self):
             self.stepper,
         )
         return item
+        return [TranslationChecker]
 
 
 class TranslationChecker(

proposals/utils/pdf_diff_utils.py

@@ -323,7 +323,7 @@ def handle_attachment(self, filewrapper):
                 '<a href="{}">{}</a>',
                 settings.BASE_URL
                 + reverse(
-                    "proposals:download_attachment_original",
+                    "proposals:download_attachment",
                     kwargs={
                         "proposal_pk": self.proposal.pk,
                         "attachment_pk": self.obj.pk,

proposals/utils/stepper.py

@@ -18,7 +18,7 @@
 from interventions.forms import InterventionForm
 
 from proposals.utils.validate_sessions_tasks import validate_sessions_tasks
-from attachments.utils import AttachmentSlot
+from attachments.utils import AttachmentSlot, enumerate_slots
 from attachments.kinds import desiredness
 
 
@@ -82,7 +82,15 @@ def attachment_slots(
                 success = empty_slot.match_and_set(exclude=exclude)
                 if success:
                     extra_slots.append(empty_slot)
-        return self._attachment_slots + extra_slots
+        all_slots = self._attachment_slots + extra_slots
+        enumerate_slots(all_slots)
+        return all_slots
+
+    @property
+    def filled_slots(
+        self,
+    ):
+        return [slot for slot in self.attachment_slots if slot.attachment]
 
     def get_context_data(self):
         context = super().get_context_data()

proposals/views/attachment_views.py

@@ -16,7 +16,7 @@
 from reviews.mixins import HideStepperMixin
 from django.utils.translation import gettext as _
 from attachments.kinds import ATTACHMENTS, KIND_CHOICES
-from attachments.utils import AttachmentKind, merge_groups
+from attachments.utils import AttachmentKind, merge_groups, AttachmentSlot
 from cdh.core import forms as cdh_forms
 from django.utils.translation import gettext as _
 from reviews.mixins import UsersOrGroupsAllowedMixin
@@ -369,14 +369,14 @@ def get_filename(self):
         if self.original_filename:
             return self.attachment.upload.original_filename
         else:
-            return self.get_filename_from_kind()
+            return self.get_filename_from_slot()
 
-    def get_filename_from_kind(self):
-        self.kind = AttachmentKind.from_proposal(
-            self.proposal,
+    def get_filename_from_slot(self):
+        self.slot = AttachmentSlot.from_proposal(
             self.attachment,
+            self.proposal,
         )
-        return self.kind.name
+        return self.slot.get_fetc_filename()
 
     def get_file_response(self):
         attachment_file = self.attachment.upload.file

reviews/templates/reviews/review_attachments.html

@@ -75,7 +75,7 @@ <h6>{{ slot.kind.name }}</h6>
                                 </tr>
                                 <tr>
                                     <td>{% trans "Bestand" %}</td>
-                                    <td>{% include slot.attachment with proposal=proposal include_normalized=True %}</td>
+                                    <td>{% include slot.attachment with proposal=proposal normalized_filename=slot.get_fetc_filename %}</td>
                                 </tr>
                                 <tr>
                                     <td>{% trans "Commentaar" %}</td>