Merged in feature/PYPE-132_loader_thumbnails (pull request #378)

Feature/PYPE-132 loader thumbnails

Approved-by: Milan Kolar <milan@orbi.tools>

pype/plugins/ftrack/publish/integrate_remove_components.py

@@ -11,13 +11,13 @@ class IntegrateCleanComponentData(pyblish.api.InstancePlugin):
     label = 'Clean component data'
     families = ["ftrack"]
     optional = True
-    active = True
+    active = False
 
     def process(self, instance):
 
         for comp in instance.data['representations']:
             self.log.debug('component {}'.format(comp))
-            
+
             if "%" in comp['published_path'] or "#" in comp['published_path']:
                 continue
 

pype/plugins/global/publish/extract_jpeg.py

@@ -6,7 +6,7 @@ import pype.api
 
 
 class ExtractJpegEXR(pyblish.api.InstancePlugin):
-    """Resolve any dependency issies
+    """Resolve any dependency issues
 
     This plug-in resolves any paths which, if not updated might break
     the published file.
@@ -55,8 +55,8 @@ class ExtractJpegEXR(pyblish.api.InstancePlugin):
             filename = os.path.splitext(input_file)[0]
             if not filename.endswith('.'):
                 filename += "."
-            jpegFile = filename + "jpg"
-            full_output_path = os.path.join(stagingdir, jpegFile)
+            jpeg_file = filename + "jpg"
+            full_output_path = os.path.join(stagingdir, jpeg_file)
 
             self.log.info("output {}".format(full_output_path))
 
@@ -87,9 +87,9 @@ class ExtractJpegEXR(pyblish.api.InstancePlugin):
                 instance.data["representations"] = []
 
             representation = {
-                'name': 'jpg',
+                'name': 'thumbnail',
                 'ext': 'jpg',
-                'files': jpegFile,
+                'files': jpeg_file,
                 "stagingDir": stagingdir,
                 "thumbnail": True,
                 "tags": ['thumbnail']

pype/plugins/global/publish/integrate_new.py

@@ -401,6 +401,7 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
                 self.log.debug("__ dst: {}".format(dst))
 
             representation = {
+                "_id": io.ObjectId(),
                 "schema": "pype:representation-2.0",
                 "type": "representation",
                 "parent": version_id,
@@ -443,6 +444,7 @@ class IntegrateAssetNew(pyblish.api.InstancePlugin):
             self.log.debug("__ represNAME: {}".format(rep['name']))
             self.log.debug("__ represPATH: {}".format(rep['published_path']))
         io.insert_many(representations)
+        instance.data["published_representations"] = representations
         # self.log.debug("Representation: {}".format(representations))
         self.log.info("Registered {} items".format(len(representations)))
 

pype/plugins/global/publish/integrate_thumbnail.py

@@ -0,0 +1,139 @@
+import os
+import sys
+import errno
+import shutil
+import copy
+
+import six
+import pyblish.api
+from bson.objectid import ObjectId
+
+from avalon import api, io
+
+
+class IntegrateThumbnails(pyblish.api.InstancePlugin):
+    """Integrate Thumbnails."""
+
+    label = "Integrate Thumbnails"
+    order = pyblish.api.IntegratorOrder + 0.01
+    families = ["review"]
+
+    def process(self, instance):
+
+        if not os.environ.get("AVALON_THUMBNAIL_ROOT"):
+            self.log.info("AVALON_THUMBNAIL_ROOT is not set."
+                          " Skipping thumbnail integration.")
+            return
+
+        published_repres = instance.data.get("published_representations")
+        if not published_repres:
+            self.log.debug(
+                "There are not published representation ids on the instance."
+            )
+            return
+
+        project_name = api.Session["AVALON_PROJECT"]
+
+        anatomy = instance.context.data["anatomy"]
+        if "publish" not in anatomy.templates:
+            raise AssertionError("Anatomy does not have set publish key!")
+
+        if "thumbnail" not in anatomy.templates["publish"]:
+            raise AssertionError((
+                "There is not set \"thumbnail\" template for project \"{}\""
+            ).format(project_name))
+
+        thumbnail_template = anatomy.templates["publish"]["thumbnail"]
+
+        io.install()
+
+        thumb_repre = None
+        for repre in published_repres:
+            if repre["name"].lower() == "thumbnail":
+                thumb_repre = repre
+                break
+
+        if not thumb_repre:
+            self.log.debug(
+                "There is not representation with name \"thumbnail\""
+            )
+            return
+
+        version = io.find_one({"_id": thumb_repre["parent"]})
+        if not version:
+            raise AssertionError(
+                "There does not exist version with id {}".format(
+                    str(thumb_repre["parent"])
+                )
+            )
+
+        # Get full path to thumbnail file from representation
+        src_full_path = os.path.normpath(thumb_repre["data"]["path"])
+        if not os.path.exists(src_full_path):
+            self.log.warning("Thumbnail file was not found. Path: {}".format(
+                src_full_path
+            ))
+            return
+
+        filename, file_extension = os.path.splitext(src_full_path)
+        # Create id for mongo entity now to fill anatomy template
+        thumbnail_id = ObjectId()
+
+        # Prepare anatomy template fill data
+        template_data = copy.deepcopy(thumb_repre["context"])
+        template_data.update({
+            "_id": str(thumbnail_id),
+            "thumbnail_root": os.environ.get("AVALON_THUMBNAIL_ROOT"),
+            "ext": file_extension,
+            "thumbnail_type": "thumbnail"
+        })
+
+        anatomy_filled = anatomy.format(template_data)
+        final_path = anatomy_filled.get("publish", {}).get("thumbnail")
+        if not final_path:
+            raise AssertionError((
+                "Anatomy template was not filled with entered data"
+                "\nTemplate: {} "
+                "\nData: {}"
+            ).format(thumbnail_template, str(template_data)))
+
+        dst_full_path = os.path.normpath(final_path)
+        self.log.debug(
+            "Copying file .. {} -> {}".format(src_full_path, dst_full_path)
+        )
+        dirname = os.path.dirname(dst_full_path)
+        try:
+            os.makedirs(dirname)
+        except OSError as e:
+            if e.errno != errno.EEXIST:
+                tp, value, tb = sys.exc_info()
+                six.reraise(tp, value, tb)
+
+        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")
+
+        thumbnail_entity = {
+            "_id": thumbnail_id,
+            "type": "thumbnail",
+            "schema": "pype:thumbnail-1.0",
+            "data": {
+                "template": thumbnail_template,
+                "template_data": template_data
+            }
+        }
+        # Create thumbnail entity
+        io.insert_one(thumbnail_entity)
+        self.log.debug(
+            "Creating entity in database {}".format(str(thumbnail_entity))
+        )
+        # Set thumbnail id for version
+        io.update_many(
+            {"_id": version["_id"]},
+            {"$set": {"data.thumbnail_id": thumbnail_id}}
+        )
+        self.log.debug("Setting thumbnail for version \"{}\" <{}>".format(
+            version["name"], str(version["_id"])
+        ))