Merge pull request #3750 from pypeclub/feature/OP-3484_Thumbnail-storage-per-project

General: Thumbnail can use project roots

openpype/client/operations.py

@@ -24,6 +24,7 @@ CURRENT_SUBSET_SCHEMA = "openpype:subset-3.0"
 CURRENT_VERSION_SCHEMA = "openpype:version-3.0"
 CURRENT_REPRESENTATION_SCHEMA = "openpype:representation-2.0"
 CURRENT_WORKFILE_INFO_SCHEMA = "openpype:workfile-1.0"
+CURRENT_THUMBNAIL_SCHEMA = "openpype:thumbnail-1.0"
 
 
 def _create_or_convert_to_mongo_id(mongo_id):
@@ -195,6 +196,29 @@ def new_representation_doc(
     }
 
 
+def new_thumbnail_doc(data=None, entity_id=None):
+    """Create skeleton data of thumbnail document.
+
+    Args:
+        data (Dict[str, Any]): Thumbnail document data.
+        entity_id (Union[str, ObjectId]): Predefined id of document. New id is
+            created if not passed.
+
+    Returns:
+        Dict[str, Any]: Skeleton of thumbnail document.
+    """
+
+    if data is None:
+        data = {}
+
+    return {
+        "_id": _create_or_convert_to_mongo_id(entity_id),
+        "type": "thumbnail",
+        "schema": CURRENT_THUMBNAIL_SCHEMA,
+        "data": data
+    }
+
+
 def new_workfile_info_doc(
     filename, asset_id, task_name, files, data=None, entity_id=None
 ):

openpype/pipeline/thumbnail.py

@@ -4,6 +4,7 @@ import logging
 
 from openpype.client import get_project
 from . import legacy_io
+from .anatomy import Anatomy
 from .plugin_discover import (
     discover,
     register_plugin,
@@ -73,19 +74,20 @@ class ThumbnailResolver(object):
 
 
 class TemplateResolver(ThumbnailResolver):
-
     priority = 90
 
     def process(self, thumbnail_entity, thumbnail_type):
-
-        if not os.environ.get("AVALON_THUMBNAIL_ROOT"):
-            return
-
         template = thumbnail_entity["data"].get("template")
         if not template:
             self.log.debug("Thumbnail entity does not have set template")
             return
 
+        thumbnail_root_format_key = "{thumbnail_root}"
+        thumbnail_root = os.environ.get("AVALON_THUMBNAIL_ROOT") or ""
+        # Check if template require thumbnail root and if is avaiable
+        if thumbnail_root_format_key in template and not thumbnail_root:
+            return
+
         project_name = self.dbcon.active_project()
         project = get_project(project_name, fields=["name", "data.code"])
 
@@ -95,12 +97,16 @@ class TemplateResolver(ThumbnailResolver):
         template_data.update({
             "_id": str(thumbnail_entity["_id"]),
             "thumbnail_type": thumbnail_type,
-            "thumbnail_root": os.environ.get("AVALON_THUMBNAIL_ROOT"),
+            "thumbnail_root": thumbnail_root,
             "project": {
                 "name": project["name"],
                 "code": project["data"].get("code")
-            }
+            },
         })
+        # Add anatomy roots if is in template
+        if "{root" in template:
+            anatomy = Anatomy(project_name)
+            template_data["root"] = anatomy.roots
 
         try:
             filepath = os.path.normpath(template.format(**template_data))

openpype/plugins/publish/integrate_thumbnail.py

@@ -6,10 +6,9 @@ import copy
 
 import six
 import pyblish.api
-from bson.objectid import ObjectId
 
 from openpype.client import get_version_by_id
-from openpype.pipeline import legacy_io
+from openpype.client.operations import OperationsSession, new_thumbnail_doc
 
 
 class IntegrateThumbnails(pyblish.api.InstancePlugin):
@@ -24,13 +23,9 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
     ]
 
     def process(self, instance):
-
-        if not os.environ.get("AVALON_THUMBNAIL_ROOT"):
-            self.log.warning(
-                "AVALON_THUMBNAIL_ROOT is not set."
-                " Skipping thumbnail integration."
-            )
-            return
+        env_key = "AVALON_THUMBNAIL_ROOT"
+        thumbnail_root_format_key = "{thumbnail_root}"
+        thumbnail_root = os.environ.get(env_key) or ""
 
         published_repres = instance.data.get("published_representations")
         if not published_repres:
@@ -51,6 +46,16 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
             ).format(project_name))
             return
 
+        thumbnail_template = anatomy.templates["publish"]["thumbnail"]
+        if (
+            not thumbnail_root
+            and thumbnail_root_format_key in thumbnail_template
+        ):
+            self.log.warning((
+                "{} is not set. Skipping thumbnail integration."
+            ).format(env_key))
+            return
+
         thumb_repre = None
         thumb_repre_anatomy_data = None
         for repre_info in published_repres.values():
@@ -66,10 +71,6 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
             )
             return
 
-        legacy_io.install()
-
-        thumbnail_template = anatomy.templates["publish"]["thumbnail"]
-
         version = get_version_by_id(project_name, thumb_repre["parent"])
         if not version:
             raise AssertionError(
@@ -88,14 +89,15 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
 
         filename, file_extension = os.path.splitext(src_full_path)
         # Create id for mongo entity now to fill anatomy template
-        thumbnail_id = ObjectId()
+        thumbnail_doc = new_thumbnail_doc()
+        thumbnail_id = thumbnail_doc["_id"]
 
         # Prepare anatomy template fill data
         template_data = copy.deepcopy(thumb_repre_anatomy_data)
         template_data.update({
             "_id": str(thumbnail_id),
-            "thumbnail_root": os.environ.get("AVALON_THUMBNAIL_ROOT"),
             "ext": file_extension[1:],
+            "thumbnail_root": thumbnail_root,
             "thumbnail_type": "thumbnail"
         })
 
@@ -117,8 +119,8 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
         shutil.copy(src_full_path, dst_full_path)
 
         # Clean template data from keys that are dynamic
-        template_data.pop("_id")
-        template_data.pop("thumbnail_root")
+        for key in ("_id", "thumbnail_root"):
+            template_data.pop(key, None)
 
         repre_context = template_filled.used_values
         for key in self.required_context_keys:
@@ -127,34 +129,40 @@ class IntegrateThumbnails(pyblish.api.InstancePlugin):
                 continue
             repre_context[key] = template_data[key]
 
-        thumbnail_entity = {
-            "_id": thumbnail_id,
-            "type": "thumbnail",
-            "schema": "openpype:thumbnail-1.0",
-            "data": {
-                "template": thumbnail_template,
-                "template_data": repre_context
-            }
+        op_session = OperationsSession()
+
+        thumbnail_doc["data"] = {
+            "template": thumbnail_template,
+            "template_data": repre_context
         }
-        # Create thumbnail entity
-        legacy_io.insert_one(thumbnail_entity)
-        self.log.debug(
-            "Creating entity in database {}".format(str(thumbnail_entity))
+        op_session.create_entity(
+            project_name, thumbnail_doc["type"], thumbnail_doc
         )
+        # Create thumbnail entity
+        self.log.debug(
+            "Creating entity in database {}".format(str(thumbnail_doc))
+        )
+
         # Set thumbnail id for version
-        legacy_io.update_many(
-            {"_id": version["_id"]},
-            {"$set": {"data.thumbnail_id": thumbnail_id}}
+        op_session.update_entity(
+            project_name,
+            version["type"],
+            version["_id"],
+            {"data.thumbnail_id": thumbnail_id}
         )
         self.log.debug("Setting thumbnail for version \"{}\" <{}>".format(
             version["name"], str(version["_id"])
         ))
 
         asset_entity = instance.data["assetEntity"]
-        legacy_io.update_many(
-            {"_id": asset_entity["_id"]},
-            {"$set": {"data.thumbnail_id": thumbnail_id}}
+        op_session.update_entity(
+            project_name,
+            asset_entity["type"],
+            asset_entity["_id"],
+            {"data.thumbnail_id": thumbnail_id}
         )
         self.log.debug("Setting thumbnail for asset \"{}\" <{}>".format(
             asset_entity["name"], str(version["_id"])
         ))
+
+        op_session.commit()