Merge pull request #1427 from opengisch/QF-6843-make-attachments-not-versionable

feat: make attachments of a project optionally versionable

Author: gounux

docker-app/qfieldcloud/core/admin.py

@@ -27,6 +27,7 @@
 from django.contrib.auth.models import Group
 from django.contrib.auth.views import redirect_to_login
 from django.core.exceptions import PermissionDenied, ValidationError
+from django.core.files.storage import storages
 from django.db.models import Q, QuerySet
 from django.db.models.fields.json import JSONField
 from django.db.models.functions import Lower
@@ -68,6 +69,7 @@
 from qfieldcloud.core.templatetags.filters import filesizeformat10
 from qfieldcloud.core.utils import get_file_storage_choices
 from qfieldcloud.core.utils2 import delta_utils, jobs, pg_service_file
+from qfieldcloud.filestorage.backend import QfcS3Boto3Storage
 from qfieldcloud.filestorage.models import File
 
 
@@ -855,6 +857,26 @@ def __init__(self, *args, **kwargs):
         )
         if self.instance.has_attachments_files:
             self.fields["attachments_file_storage"].disabled = True
+            self.fields["are_attachments_versioned"].disabled = True
+
+    def clean_are_attachments_versioned(self):
+        value = self.cleaned_data["are_attachments_versioned"]
+
+        if value:
+            return value
+
+        # attachments can not be unversioned if attachments are stored on S3.
+        attachment_storage_value = self.cleaned_data["attachments_file_storage"]
+        attachment_storage = storages[attachment_storage_value]
+
+        if isinstance(attachment_storage, QfcS3Boto3Storage):
+            raise ValidationError(
+                _(
+                    "The '{}' attachments file storage is not compatible with unversioned attachment files."
+                ).format(attachment_storage_value)
+            )
+
+        return value
 
 
 class ProjectAdmin(QFieldCloudModelAdmin):
@@ -899,6 +921,7 @@ class ProjectAdmin(QFieldCloudModelAdmin):
         "file_storage",
         "file_storage_migrated_at",
         "attachments_file_storage",
+        "are_attachments_versioned",
         "is_attachment_download_on_demand",
         "project_files",
     )

docker-app/qfieldcloud/core/migrations/0093_project_are_attachments_versioned.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.25 on 2025-11-13 16:09
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0092_project_restricted_data_last_updated_at"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="project",
+            name="are_attachments_versioned",
+            field=models.BooleanField(
+                default=True,
+                help_text="If enabled, attachment files will make use of the file versioning system. If disabled, only the latest version of each attachment file will be kept, and stored with the extension in the filename.",
+                verbose_name="Versioned attachment files",
+            ),
+        ),
+    ]

docker-app/qfieldcloud/core/models.py

@@ -1262,6 +1262,14 @@ class Meta:
         ),
     )
 
+    are_attachments_versioned = models.BooleanField(
+        default=True,
+        verbose_name=_("Versioned attachment files"),
+        help_text=_(
+            "If enabled, attachment files will make use of the file versioning system. If disabled, only the latest version of each attachment file will be kept, and stored with the extension in the filename."
+        ),
+    )
+
     restricted_data_last_updated_at = models.DateTimeField(
         _("Restricted data last updated at"),
         blank=True,

docker-app/qfieldcloud/filestorage/backend.py

@@ -259,3 +259,21 @@ def patch_nginx_download_redirect(self, response: HttpResponse) -> None:
         b64_auth = base64.b64encode(self.basic_auth.encode()).decode()
         basic_auth = f"Basic {b64_auth}"
         response["webdav_auth"] = basic_auth
+
+    def is_name_available(self, name, max_length=None):
+        # TODO: Delete with QF-7176 and Django >= 5.1 upgrade.
+        # see https://github.com/django/django/blob/6f35c2e1fd71ff8f349598a59689514e213490e7/django/core/files/storage/base.py#L54
+        exceeds_max_length = max_length and len(name) > max_length
+        return not self.exists(name) and not exceeds_max_length
+
+    def get_available_name(self, name: str, max_length: int | None = None) -> str:
+        """Returns a filename that is available on the configured webdav storage.
+
+        Arguments:
+            name: desired relative path of the file on the webdav server.
+            max_length: maximum length of the filename (not used)."""
+
+        if self.is_name_available(name, max_length):
+            return super().get_available_name(name, max_length)
+
+        return name

docker-app/qfieldcloud/filestorage/models.py

@@ -261,12 +261,21 @@ def add_version(
 
 def get_file_version_upload_to(instance: "FileVersion", _filename: str) -> str:
     if instance.file.file_type == File.FileType.PROJECT_FILE:
+        # if the project is configured to not version attachments, store them without version id.
+        if (
+            instance.file.is_attachment()
+            and not instance.file.project.are_attachments_versioned
+        ):
+            return f"projects/{instance.file.project.id}/files/{instance.file.name}"
+
         return f"projects/{instance.file.project.id}/files/{instance.file.name}/{instance.display}-{str(instance.id)[0:8]}"
+
     elif instance.file.file_type == File.FileType.PACKAGE_FILE:
         # TODO decide whether we need to add the version id in there?
         # Currently we don't add it, since there is no situation to have multiple versions of the same file in a packaged file.
         # On the other hand, having this differing from regular files will make it harder to manage.
         return f"projects/{instance.file.project.id}/packages/{instance.file.package_job_id}/{instance.file.name}"
+
     else:
         raise NotImplementedError()
 

docker-app/qfieldcloud/filestorage/tests/test_attachments.py

@@ -191,3 +191,64 @@ def test_attachments_packages_on_default_storage_succeeds(self):
 
             for package_file in package_files_qs:
                 self.assertFileOnStorage(package_file, "default")
+
+    def test_not_versioned_attachment_upload_succeeds(self):
+        p = Project.objects.create(
+            owner=self.u1,
+            name="p2",
+            file_storage="default",
+            attachments_file_storage="webdav",
+            are_attachments_versioned=False,
+        )
+
+        # Upload a first version of the file.
+        response = self._upload_file(
+            self.u1,
+            p,
+            "DCIM/file.name",
+            io.FileIO(testdata_path("DCIM/1.jpg"), "rb"),
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+        self.assertEqual(p.project_files.count(), 1)
+
+        file = p.get_file("DCIM/file.name")
+
+        self.assertFileOnStorage(file, "webdav")
+
+        version = file.latest_version
+
+        self.assertIsNotNone(version)
+
+        first_content_name = version.content.name
+
+        self.assertTrue(first_content_name.endswith("DCIM/file.name"))
+
+        # Upload a second version of the same file (with different content).
+        response = self._upload_file(
+            self.u1,
+            p,
+            "DCIM/file.name",
+            io.FileIO(testdata_path("DCIM/2.jpg"), "rb"),
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+        self.assertEqual(p.project_files.count(), 1)
+
+        file = p.get_file("DCIM/file.name")
+
+        self.assertFileOnStorage(file, "webdav")
+        self.assertEqual(file.versions.count(), 2)
+
+        second_content_name = file.latest_version.content.name
+
+        self.assertTrue(second_content_name.endswith("DCIM/file.name"))
+        self.assertTrue(second_content_name.endswith(".name"))
+
+        response = self._delete_file(self.u1, p, "DCIM/file.name")
+
+        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+        self.assertEqual(p.project_files.count(), 0)
+
+        self.assertFalse(version.content.storage.exists(first_content_name))
+        self.assertFalse(version.content.storage.exists(second_content_name))