[previews] introduce preview background files

Author: EvanBldy

setup.cfg

@@ -55,6 +55,8 @@ install_requires =
     ldap3==2.9.1
     matterhook==0.2
     meilisearch==0.28.4
+    numpy==1.24.4
+    opencv-python==4.8.1.78
     OpenTimelineIO==0.15.0
     orjson==3.9.10
     pillow==10.1.0

zou/app/blueprints/crud/__init__.py

@@ -118,7 +118,10 @@
     WorkingFilesResource,
     WorkingFileResource,
 )
-
+from zou.app.blueprints.crud.preview_background_file import (
+    PreviewBackgroundFileResource,
+    PreviewBackgroundFilesResource,
+)
 
 routes = [
     ("/data/persons", PersonsResource),
@@ -190,6 +193,11 @@
     ("/data/subscriptions/<instance_id>", SubscriptionResource),
     ("/data/entity-links/", EntityLinksResource),
     ("/data/entity-links/<instance_id>", EntityLinkResource),
+    ("/data/preview-background-files", PreviewBackgroundFilesResource),
+    (
+        "/data/preview-background-files/<instance_id>",
+        PreviewBackgroundFileResource,
+    ),
 ]
 
 blueprint = Blueprint("/data", "data")

zou/app/blueprints/crud/preview_background_file.py

@@ -0,0 +1,61 @@
+from zou.app.models.preview_background_file import PreviewBackgroundFile
+from zou.app.services.exception import ArgumentsException
+from zou.app.services import files_service, deletion_service
+
+from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
+
+
+class PreviewBackgroundFilesResource(BaseModelsResource):
+    def __init__(self):
+        BaseModelsResource.__init__(self, PreviewBackgroundFile)
+
+    def check_read_permissions(self):
+        return True
+
+    def update_data(self, data):
+        name = data.get("name", None)
+        preview_background_file = PreviewBackgroundFile.get_by(name=name)
+        if preview_background_file is not None:
+            raise ArgumentsException(
+                "A preview background file with similar name already exists"
+            )
+        return data
+
+    def post_creation(self, instance):
+        if instance.is_default:
+            files_service.reset_default_preview_background_files(instance.id)
+        files_service.clear_preview_background_file_cache(str(instance.id))
+        return instance.serialize()
+
+
+class PreviewBackgroundFileResource(BaseModelResource):
+    def __init__(self):
+        BaseModelResource.__init__(self, PreviewBackgroundFile)
+
+    def check_read_permissions(self, instance):
+        return True
+
+    def update_data(self, data, instance_id):
+        name = data.get("name", None)
+        if name is not None:
+            preview_background_file = PreviewBackgroundFile.get_by(name=name)
+            if preview_background_file is not None and instance_id != str(
+                preview_background_file.id
+            ):
+                raise ArgumentsException(
+                    "A preview background file with similar name already exists"
+                )
+        return data
+
+    def post_update(self, instance_dict):
+        if instance_dict["is_default"]:
+            files_service.reset_default_preview_background_files(
+                instance_dict["id"]
+            )
+        files_service.clear_preview_background_file_cache(instance_dict["id"])
+        return instance_dict
+
+    def post_delete(self, instance_dict):
+        deletion_service.clear_preview_background_files(instance_dict["id"])
+        files_service.clear_preview_background_file_cache(instance_dict["id"])
+        return instance_dict

zou/app/blueprints/crud/project.py

@@ -15,6 +15,7 @@
     assets_service,
     tasks_service,
     status_automations_service,
+    files_service,
 )
 from zou.app.utils import events, permissions, fields
 
@@ -79,6 +80,31 @@ def update_data(self, data):
                 )
                 for task_type_id in data["status_automations"]
             ]
+
+        if "preview_background_files" in data:
+            data["preview_background_files"] = [
+                files_service.get_preview_background_file_raw(
+                    preview_background_file_id
+                )
+                for preview_background_file_id in data[
+                    "preview_background_files"
+                ]
+            ]
+
+        if data.get("preview_background_file_id") is not None:
+            preview_background_files_ids = []
+            if "preview_background_files" in data:
+                preview_background_files_ids = [
+                    str(preview_background_file.id)
+                    for preview_background_file in data[
+                        "preview_background_files"
+                    ]
+                ]
+            if (
+                data["preview_background_file_id"]
+                not in preview_background_files_ids
+            ):
+                raise ArgumentsException("Invalid preview_background_file_id")
         return data
 
     def post_creation(self, project):
@@ -132,6 +158,37 @@ def pre_update(self, project_dict, data):
                 )
                 for task_type_id in data["status_automations"]
             ]
+        if "preview_background_files" in data:
+            data["preview_background_files"] = [
+                files_service.get_preview_background_file_raw(
+                    preview_background_file_id
+                )
+                for preview_background_file_id in data[
+                    "preview_background_files"
+                ]
+            ]
+
+        if data.get("preview_background_file_id") is not None:
+            if "preview_background_files" in data:
+                preview_background_files_ids = [
+                    str(preview_background_file.id)
+                    for preview_background_file in data[
+                        "preview_background_files"
+                    ]
+                ]
+            else:
+                preview_background_files_ids = [
+                    preview_background_file_id
+                    for preview_background_file_id in project_dict[
+                        "preview_background_files"
+                    ]
+                ]
+            if (
+                data["preview_background_file_id"]
+                not in preview_background_files_ids
+            ):
+                raise ArgumentsException("Invalid preview_background_file_id")
+
         return data
 
     def post_update(self, project_dict):

zou/app/blueprints/previews/__init__.py

@@ -26,6 +26,9 @@
     UpdatePreviewPositionResource,
     ExtractFrameFromPreview,
     ExtractTileFromPreview,
+    CreatePreviewBackgroundFileResource,
+    PreviewBackgroundFileThumbnailResource,
+    PreviewBackgroundFileResource,
 )
 
 routes = [
@@ -98,6 +101,18 @@
         "/pictures/thumbnails/projects/<instance_id>.png",
         ProjectThumbnailResource,
     ),
+    (
+        "/pictures/preview-background-files/<instance_id>",
+        CreatePreviewBackgroundFileResource,
+    ),
+    (
+        "/pictures/thumbnails/preview-background-files/<instance_id>.png",
+        PreviewBackgroundFileThumbnailResource,
+    ),
+    (
+        "/pictures/preview-background-files/<instance_id>.<extension>",
+        PreviewBackgroundFileResource,
+    ),
     (
         "/actions/entities/<entity_id>/set-main-preview/<preview_file_id>",
         LegacySetMainPreviewResource,