Merge pull request #908 from pypeclub/feature/3.0_ftrack_clone_review_session

Clone review session with children.

pype/modules/ftrack/events/action_clone_review_session.py

@@ -0,0 +1,128 @@
+import json
+
+from pype.modules.ftrack.lib import ServerAction
+
+
+def clone_review_session(session, entity):
+    # Create a client review with timestamp.
+    name = entity["name"]
+    review_session = session.create(
+        "ReviewSession",
+        {
+            "name": f"Clone of {name}",
+            "project": entity["project"]
+        }
+    )
+
+    # Add all invitees.
+    for invitee in entity["review_session_invitees"]:
+        session.create(
+            "ReviewSessionInvitee",
+            {
+                "name": invitee["name"],
+                "email": invitee["email"],
+                "review_session": review_session
+            }
+        )
+
+    # Add all objects to new review session.
+    for obj in entity["review_session_objects"]:
+        session.create(
+            "ReviewSessionObject",
+            {
+                "name": obj["name"],
+                "version": obj["version"],
+                "review_session": review_session,
+                "asset_version": obj["asset_version"]
+            }
+        )
+
+    session.commit()
+
+
+class CloneReviewSession(ServerAction):
+    '''Generate Client Review action
+    `label` a descriptive string identifing your action.
+    `varaint` To group actions together, give them the same
+    label and specify a unique variant per action.
+    `identifier` a unique identifier for your action.
+    `description` a verbose descriptive text for you action
+     '''
+    label = "Clone Review Session"
+    variant = None
+    identifier = "clone-review-session"
+    description = None
+    settings_key = "clone_review_session"
+
+    def discover(self, session, entities, event):
+        '''Return true if we can handle the selected entities.
+        *session* is a `ftrack_api.Session` instance
+        *entities* is a list of tuples each containing the entity type and the
+        entity id.
+        If the entity is a hierarchical you will always get the entity
+        type TypedContext, once retrieved through a get operation you
+        will have the "real" entity type ie. example Shot, Sequence
+        or Asset Build.
+        *event* the unmodified original event
+        '''
+        is_valid = (
+            len(entities) == 1
+            and entities[0].entity_type == "ReviewSession"
+        )
+        if is_valid:
+            is_valid = self.valid_roles(session, entities, event)
+        return is_valid
+
+    def launch(self, session, entities, event):
+        '''Callback method for the custom action.
+        return either a bool ( True if successful or False if the action
+        failed ) or a dictionary with they keys `message` and `success`, the
+        message should be a string and will be displayed as feedback to the
+        user, success should be a bool, True if successful or False if the
+        action failed.
+        *session* is a `ftrack_api.Session` instance
+        *entities* is a list of tuples each containing the entity type and the
+        entity id.
+        If the entity is a hierarchical you will always get the entity
+        type TypedContext, once retrieved through a get operation you
+        will have the "real" entity type ie. example Shot, Sequence
+        or Asset Build.
+        *event* the unmodified original event
+        '''
+        userId = event['source']['user']['id']
+        user = session.query('User where id is ' + userId).one()
+        job = session.create(
+            'Job',
+            {
+                'user': user,
+                'status': 'running',
+                'data': json.dumps({
+                    'description': 'Cloning Review Session.'
+                })
+            }
+        )
+        session.commit()
+
+        try:
+            clone_review_session(session, entities[0])
+
+            job['status'] = 'done'
+            session.commit()
+        except Exception:
+            session.rollback()
+            job["status"] = "failed"
+            session.commit()
+            self.log.error(
+                "Cloning review session failed ({})", exc_info=True
+            )
+
+        return {
+            'success': True,
+            'message': 'Action completed successfully'
+        }
+
+
+def register(session):
+    '''Register action. Called when used as an event plugin.'''
+
+    CloneReviewSession(session).register()

pype/settings/defaults/project_settings/ftrack.json

@@ -26,6 +26,14 @@
                 "Project Manager"
             ]
         },
+        "clone_review_session": {
+            "enabled": true,
+            "role_list": [
+                "Pypeclub",
+                "Administrator",
+                "Project Manager"
+            ]
+        },
         "thumbnail_updates": {
             "enabled": true,
             "levels": 1

pype/tools/settings/settings/gui_schemas/projects_schema/schema_project_ftrack.json

@@ -104,6 +104,25 @@
                         }
                     ]
                 },
+                {
+                    "type": "dict",
+                    "key": "clone_review_session",
+                    "label": "Clone Review Session",
+                    "checkbox_key": "enabled",
+                    "children": [
+                        {
+                            "type": "boolean",
+                            "key": "enabled",
+                            "label": "Enabled"
+                        },
+                        {
+                            "type": "list",
+                            "key": "role_list",
+                            "label": "Roles for action",
+                            "object_type": "text"
+                        }
+                    ]
+                },
                 {
                     "type": "dict",
                     "key": "thumbnail_updates",