Archive Item Titles

app/grandchallenge/archives/forms.py

@@ -17,10 +17,17 @@
     ArchivePermissionRequest,
 )
 from grandchallenge.cases.forms import UploadRawImagesForm
+from grandchallenge.components.forms import (
+    CIVSetCreateFormMixin,
+    CIVSetUpdateFormMixin,
+    MultipleCIVForm,
+)
 from grandchallenge.components.models import ComponentInterface, InterfaceKind
 from grandchallenge.core.forms import (
     PermissionRequestUpdateForm,
     SaveFormInitMixin,
+    UniqueTitleCreateFormMixin,
+    UniqueTitleUpdateFormMixin,
     WorkstationUserFilterMixin,
 )
 from grandchallenge.core.guardian import get_objects_for_user
@@ -225,3 +232,37 @@ def save(self, *args, **kwargs):
             {"interface_pk": self.cleaned_data["interface"].pk}
         )
         return super().save(*args, **kwargs)
+
+
+class ArchiveItemFormMixin:
+    class Meta:
+        non_interface_fields = ("title",)
+
+    @property
+    def model(self):
+        return self.base_obj.civ_set_model
+
+    def unique_title_query(self, *args, **kwargs):
+        return (
+            super()
+            .unique_title_query(*args, **kwargs)
+            .filter(archive=self.base_obj)
+        )
+
+
+class ArchiveItemCreateForm(
+    ArchiveItemFormMixin,
+    UniqueTitleCreateFormMixin,
+    CIVSetCreateFormMixin,
+    MultipleCIVForm,
+):
+    pass
+
+
+class ArchiveItemUpdateForm(
+    ArchiveItemFormMixin,
+    UniqueTitleUpdateFormMixin,
+    CIVSetUpdateFormMixin,
+    MultipleCIVForm,
+):
+    pass

app/grandchallenge/archives/migrations/0018_archiveitem_title_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.11 on 2024-05-06 13:29
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("archives", "0017_archive_item_delete_permission_granting"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="archiveitem",
+            name="title",
+            field=models.CharField(blank=True, default="", max_length=255),
+        ),
+        migrations.AddConstraint(
+            model_name="archiveitem",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("title", ""), _negated=True),
+                fields=("title", "archive"),
+                name="unique_archive_item_title",
+            ),
+        ),
+    ]

app/grandchallenge/archives/models.py

@@ -1,10 +1,9 @@
-import os
-
 from actstream.models import Follow
 from django.conf import settings
 from django.contrib.auth.models import Group
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
+from django.db.models import Q
 from django_extensions.db.models import TitleSlugDescriptionModel
 from guardian.models import GroupObjectPermissionBase, UserObjectPermissionBase
 from guardian.shortcuts import assign_perm, remove_perm
@@ -14,6 +13,7 @@
 from grandchallenge.anatomy.models import BodyStructure
 from grandchallenge.components.models import (
     CIVForObjectMixin,
+    CIVSetStringRepresentationMixin,
     ComponentInterfaceValue,
     ValuesForInterfacesMixin,
 )
@@ -266,6 +266,9 @@ def civ_sets_related_manager(self):
     def civ_set_model(self):
         return ArchiveItem
 
+    def create_civ_set(self, data):
+        return self.civ_set_model.objects.create(archive=self, **data)
+
     @property
     def create_civ_set_url(self):
         return reverse("archives:item-create", kwargs={"slug": self.slug})
@@ -283,22 +286,16 @@ class ArchiveGroupObjectPermission(GroupObjectPermissionBase):
     content_object = models.ForeignKey(Archive, on_delete=models.CASCADE)
 
 
-class ArchiveItem(CIVForObjectMixin, UUIDModel):
+class ArchiveItem(
+    CIVSetStringRepresentationMixin, CIVForObjectMixin, UUIDModel
+):
     archive = models.ForeignKey(
         Archive, related_name="items", on_delete=models.PROTECT
     )
     values = models.ManyToManyField(
         ComponentInterfaceValue, blank=True, related_name="archive_items"
     )
-
-    def __str__(self):
-        values = []
-        for value in self.values.all():
-            if value.image:
-                values.append(value.image.name)
-            if value.file:
-                values.append(os.path.basename(value.file.file.name))
-        return ", ".join(values)
+    title = models.CharField(max_length=255, default="", blank=True)
 
     def save(self, *args, **kwargs):
         adding = self._state.adding
@@ -308,6 +305,15 @@ def save(self, *args, **kwargs):
         if adding:
             self.assign_permissions()
 
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(
+                fields=["title", "archive"],
+                name="unique_archive_item_title",
+                condition=~Q(title=""),
+            )
+        ]
+
     def assign_permissions(self):
         # Archive editors, uploaders and users can view this archive item
         assign_perm(
@@ -339,11 +345,6 @@ def assign_permissions(self):
     def base_object(self):
         return self.archive
 
-    @property
-    def is_editable(self):
-        # always editable
-        return True
-
     @property
     def update_url(self):
         return reverse(

app/grandchallenge/archives/serializers.py

@@ -34,6 +34,7 @@ class Meta:
         model = ArchiveItem
         fields = (
             "pk",
+            "title",
             "archive",
             "values",
             "hanging_protocol",

app/grandchallenge/archives/urls.py

@@ -4,9 +4,9 @@
     ArchiveCreate,
     ArchiveDetail,
     ArchiveEditorsUpdate,
-    ArchiveItemBulkDeleteView,
+    ArchiveItemBulkDelete,
     ArchiveItemCreateView,
-    ArchiveItemDeleteView,
+    ArchiveItemDelete,
     ArchiveItemInterfaceCreate,
     ArchiveItemsList,
     ArchiveItemsToReaderStudyUpdate,
@@ -66,7 +66,7 @@
     ),
     path(
         "<slug>/items/delete/",
-        ArchiveItemBulkDeleteView.as_view(),
+        ArchiveItemBulkDelete.as_view(),
         name="items-bulk-delete",
     ),
     path(
@@ -76,7 +76,7 @@
     ),
     path(
         "<slug>/items/<uuid:pk>/delete/",
-        ArchiveItemDeleteView.as_view(),
+        ArchiveItemDelete.as_view(),
         name="item-delete",
     ),
     path(

app/grandchallenge/archives/views.py

@@ -30,7 +30,9 @@
 from grandchallenge.archives.forms import (
     AddCasesForm,
     ArchiveForm,
+    ArchiveItemCreateForm,
     ArchiveItemsToReaderStudyForm,
+    ArchiveItemUpdateForm,
     ArchivePermissionRequestUpdateForm,
     UploadersForm,
     UsersForm,
@@ -49,8 +51,8 @@
 from grandchallenge.cases.models import Image, RawImageUploadSession
 from grandchallenge.components.forms import MultipleCIVForm, NewFileUploadForm
 from grandchallenge.components.views import (
-    CIVSetBulkDeleteView,
-    CIVSetDeleteView,
+    CIVSetBulkDelete,
+    CIVSetDelete,
     CIVSetFormMixin,
     CivSetListView,
     InterfacesCreateBaseView,
@@ -364,8 +366,11 @@ def get_context_data(self, **kwargs):
         return context
 
 
-class ArchiveItemUpdate(CIVSetFormMixin, MultipleCIVProcessingBaseView):
-    form_class = MultipleCIVForm
+class ArchiveItemUpdate(
+    CIVSetFormMixin,
+    MultipleCIVProcessingBaseView,
+):
+    form_class = ArchiveItemUpdateForm
     permission_required = (
         f"{ArchiveItem._meta.app_label}.change_{ArchiveItem._meta.model_name}"
     )
@@ -410,15 +415,6 @@ def new_interface_url(self):
             kwargs={"slug": self.base_object.slug, "pk": self.object.pk},
         )
 
-    def process_data_for_object(self, data):
-        """Updates the archive item"""
-        instance = self.object
-        for ci_slug, new_value in data.items():
-            instance.create_civ(
-                ci_slug=ci_slug, new_value=new_value, user=self.request.user
-            )
-        return instance
-
 
 class ArchiveItemsList(CivSetListView):
     model = ArchiveItem
@@ -427,10 +423,19 @@ class ArchiveItemsList(CivSetListView):
     )
     columns = [
         Column(title=""),
-        Column(title="ArchiveItem ID", sort_field="pk"),
+        Column(title="ID", sort_field="pk"),
+        Column(
+            title="Title",
+            sort_field="title",
+            optional_condition=lambda obj: bool(obj.title),
+        ),
         *CivSetListView.columns,
     ]
-    default_sort_column = 1
+    default_sort_column = 2
+    search_fields = [
+        "title",
+        *CivSetListView.search_fields,
+    ]
 
     @cached_property
     def base_object(self):
@@ -479,7 +484,10 @@ def form_valid(self, form):
 
         for item in items:
             values = item.values.all()
-            ds = DisplaySet.objects.create(reader_study=reader_study)
+            ds = DisplaySet.objects.create(
+                reader_study=reader_study,
+                title=item.title,
+            )
             ds.values.set(values)
 
         self.success_url = reader_study.get_absolute_url()
@@ -554,7 +562,7 @@ class ArchiveItemCreateView(
     CIVSetFormMixin,
     MultipleCIVProcessingBaseView,
 ):
-    form_class = MultipleCIVForm
+    form_class = ArchiveItemCreateForm
     permission_required = (
         f"{Archive._meta.app_label}.change_{Archive._meta.model_name}"
     )
@@ -590,15 +598,6 @@ def new_interface_url(self):
             kwargs={"slug": self.base_object.slug},
         )
 
-    def process_data_for_object(self, data):
-        """Creates an archive item"""
-        instance = ArchiveItem.objects.create(archive=self.base_object)
-        for slug in data:
-            instance.create_civ(
-                ci_slug=slug, new_value=data[slug], user=self.request.user
-            )
-        return instance
-
     def get_success_url(self):
         return self.return_url
 
@@ -641,14 +640,14 @@ def get_htmx_url(self):
             )
 
 
-class ArchiveItemDeleteView(CIVSetDeleteView):
+class ArchiveItemDelete(CIVSetDelete):
     model = ArchiveItem
     permission_required = (
         f"{Archive._meta.app_label}.delete_{ArchiveItem._meta.model_name}"
     )
 
 
-class ArchiveItemBulkDeleteView(CIVSetBulkDeleteView):
+class ArchiveItemBulkDelete(CIVSetBulkDelete):
     model = ArchiveItem
 
     @property

app/grandchallenge/components/forms.py

@@ -13,6 +13,7 @@
     ModelForm,
     ModelMultipleChoiceField,
 )
+from django.utils.functional import empty
 
 from grandchallenge.algorithms.models import AlgorithmImage
 from grandchallenge.components.form_fields import InterfaceFormField
@@ -106,6 +107,9 @@ class MultipleCIVForm(Form):
         SelectUploadWidget,
     }
 
+    class Meta:
+        non_interface_fields = tuple()
+
     def __init__(self, *args, instance, base_obj, user, **kwargs):
         super().__init__(*args, **kwargs)
         self.instance = instance
@@ -249,6 +253,44 @@ def _get_default_field(self, *, interface, current_value):
             user=self.user,
         ).field
 
+    def process_object_data(self):
+        for key, value in self.cleaned_data.items():
+            if key not in self.Meta.non_interface_fields:
+                self.instance.create_civ(
+                    ci_slug=key,
+                    new_value=value,
+                    user=self.user,
+                )
+
+
+class CIVSetCreateFormMixin:
+    instance = None
+
+    def process_object_data(self):
+        non_civ_data = {
+            k: v
+            for k, v in self.cleaned_data.items()
+            if k in self.Meta.non_interface_fields
+        }
+        self.instance = self.base_obj.create_civ_set(data=non_civ_data)
+        super().process_object_data()
+
+
+class CIVSetUpdateFormMixin:
+    def process_object_data(self):
+        instance = self.instance
+
+        save = False
+        for key in self.Meta.non_interface_fields:
+            value = self.cleaned_data.get(key, empty)
+            if value is not empty and value != getattr(instance, key):
+                setattr(instance, key, value)
+                save = True
+        if save:
+            instance.save()
+
+        super().process_object_data()
+
 
 class SingleCIVForm(Form):
     _possible_widgets = {