added sync hierarchical attributes action for event server

pype/ftrack/events/action_sync_hier_attrs.py

@@ -0,0 +1,274 @@
+import os
+import sys
+import json
+import argparse
+import logging
+import collections
+
+from pypeapp import config
+from pype.vendor import ftrack_api
+from pype.ftrack import BaseAction, lib
+from avalon.tools.libraryloader.io_nonsingleton import DbConnector
+from bson.objectid import ObjectId
+
+
+class SyncHierarchicalAttrs(BaseAction):
+
+    db_con = DbConnector()
+    ca_mongoid = lib.get_ca_mongoid()
+
+    #: Action identifier.
+    identifier = 'sync.hierarchical.attrs'
+    #: Action label.
+    label = 'Sync HierAttrs'
+    #: Action description.
+    description = 'Synchronize hierarchical attributes'
+    #: Icon
+    icon = '{}/ftrack/action_icons/SyncHierarchicalAttrs.svg'.format(
+        os.environ.get(
+            'PYPE_STATICS_SERVER',
+            'http://localhost:{}'.format(
+                config.get_presets().get('services', {}).get(
+                    'statics_server', {}
+                ).get('default_port', 8021)
+            )
+        )
+    )
+
+    def register(self):
+        self.session.event_hub.subscribe(
+            'topic=ftrack.action.discover',
+            self._discover
+        )
+
+        self.session.event_hub.subscribe(
+            'topic=ftrack.action.launch and data.actionIdentifier={}'.format(
+                self.identifier
+            ),
+            self._launch
+        )
+
+    def discover(self, session, entities, event):
+        ''' Validation '''
+        role_check = False
+        discover = False
+        role_list = ['Pypeclub', 'Administrator', 'Project Manager']
+        user = session.query(
+            'User where id is "{}"'.format(event['source']['user']['id'])
+        ).one()
+
+        for role in user['user_security_roles']:
+            if role['security_role']['name'] in role_list:
+                role_check = True
+                break
+        print(self.icon)
+        if role_check is True:
+            for entity in entities:
+                context_type = entity.get('context_type', '').lower()
+                if (
+                    context_type in ('show', 'task') and
+                    entity.entity_type.lower() != 'task'
+                ):
+                    discover = True
+                    break
+
+        return discover
+
+    def launch(self, session, entities, event):
+        user = session.query(
+            'User where id is "{}"'.format(event['source']['user']['id'])
+        ).one()
+
+        job = session.create('Job', {
+            'user': user,
+            'status': 'running',
+            'data': json.dumps({
+                'description': 'Sync Hierachical attributes'
+            })
+        })
+        session.commit()
+
+        try:
+            # Collect hierarchical attrs
+            custom_attributes = {}
+            all_avalon_attr = session.query(
+                'CustomAttributeGroup where name is "avalon"'
+            ).one()
+            for cust_attr in all_avalon_attr['custom_attribute_configurations']:
+                if 'avalon_' in cust_attr['key']:
+                    continue
+
+                if not cust_attr['is_hierarchical']:
+                    continue
+
+                if cust_attr['default']:
+                    self.log.warning((
+                        'Custom attribute "{}" has set default value.'
+                        ' This attribute can\'t be synchronized'
+                    ).format(cust_attr['label']))
+                    continue
+
+                custom_attributes[cust_attr['key']] = cust_attr
+
+            if not custom_attributes:
+                msg = 'No hierarchical attributes to sync.'
+                self.log.debug(msg)
+                return {
+                    'success': True,
+                    'message': msg
+                }
+
+            entity = entities[0]
+            if entity.entity_type.lower() == 'project':
+                project_name = entity['full_name']
+            else:
+                project_name = entity['project']['full_name']
+
+            self.db_con.install()
+            self.db_con.Session['AVALON_PROJECT'] = project_name
+
+            for entity in entities:
+                for key in custom_attributes:
+                    # check if entity has that attribute
+                    if key not in entity['custom_attributes']:
+                        self.log.debug(
+                            'Hierachical attribute "{}" not found on "{}"'.format(
+                                key, entity.get('name', entity)
+                            )
+                        )
+                        continue
+
+                    value = self.get_hierarchical_value(key, entity)
+                    if value is None:
+                        self.log.warning(
+                            'Hierarchical attribute "{}" not set on "{}"'.format(
+                                key, entity.get('name', entity)
+                            )
+                        )
+                        continue
+
+                    self.update_hierarchical_attribute(entity, key, value)
+
+        except Exception:
+            self.log.error(
+                'Action "{}" failed'.format(self.label),
+                exc_info=True
+            )
+
+        finally:
+            self.db_con.uninstall()
+
+            if job['status'] in ('queued', 'running'):
+                job['status'] = 'failed'
+            session.commit()
+
+        return True
+
+    def get_hierarchical_value(self, key, entity):
+        value = entity['custom_attributes'][key]
+        if (
+            value is not None or
+            entity.entity_type.lower() == 'project'
+        ):
+            return value
+
+        return self.get_hierarchical_value(key, entity['parent'])
+
+    def update_hierarchical_attribute(self, entity, key, value):
+        if (
+            entity['context_type'].lower() not in ('show', 'task') or
+            entity.entity_type.lower() == 'task'
+        ):
+            return
+        # collect entity's custom attributes
+        custom_attributes = entity.get('custom_attributes')
+        if not custom_attributes:
+            return
+
+        mongoid = custom_attributes.get(self.ca_mongoid)
+        if not mongoid:
+            self.log.debug('Entity "{}" is not synchronized to avalon.'.format(
+                entity.get('name', entity)
+            ))
+            return
+
+        try:
+            mongoid = ObjectId(mongoid)
+        except Exception:
+            self.log.warning('Entity "{}" has stored invalid MongoID.'.format(
+                entity.get('name', entity)
+            ))
+            return
+        # Find entity in Mongo DB
+        mongo_entity = self.db_con.find_one({'_id': mongoid})
+        if not mongo_entity:
+            self.log.warning(
+                'Entity "{}" is not synchronized to avalon.'.format(
+                    entity.get('name', entity)
+                )
+            )
+            return
+
+        # Change value if entity has set it's own
+        entity_value = custom_attributes[key]
+        if entity_value is not None:
+            value = entity_value
+
+        data = mongo_entity.get('data') or {}
+
+        data[key] = value
+        self.db_con.update_many(
+            {'_id': mongoid},
+            {'$set': {'data': data}}
+        )
+
+        for child in entity.get('children', []):
+            self.update_hierarchical_attribute(child, key, value)
+
+
+def register(session, **kw):
+    '''Register plugin. Called when used as an plugin.'''
+
+    if not isinstance(session, ftrack_api.session.Session):
+        return
+
+    SyncHierarchicalAttrs(session).register()
+
+
+def main(arguments=None):
+    '''Set up logging and register action.'''
+    if arguments is None:
+        arguments = []
+
+    parser = argparse.ArgumentParser()
+    # Allow setting of logging level from arguments.
+    loggingLevels = {}
+    for level in (
+        logging.NOTSET, logging.DEBUG, logging.INFO, logging.WARNING,
+        logging.ERROR, logging.CRITICAL
+    ):
+        loggingLevels[logging.getLevelName(level).lower()] = level
+
+    parser.add_argument(
+        '-v', '--verbosity',
+        help='Set the logging output verbosity.',
+        choices=loggingLevels.keys(),
+        default='info'
+    )
+    namespace = parser.parse_args(arguments)
+
+    # Set up basic logging
+    logging.basicConfig(level=loggingLevels[namespace.verbosity])
+
+    session = ftrack_api.Session()
+    register(session)
+
+    # Wait for events
+    logging.info(
+        'Registered actions and listening for events. Use Ctrl-C to abort.'
+    )
+    session.event_hub.wait()
+
+
+if __name__ == '__main__':
+    raise SystemExit(main(sys.argv[1:]))

res/ftrack/action_icons/SyncHierarchicalAttrs.svg

@@ -1 +1,9 @@
-<?xml version="1.0" ?><svg enable-background="new 0 0 512 512" id="Layer_1" version="1.1" viewBox="0 0 512 512" xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><g><g><linearGradient gradientUnits="userSpaceOnUse" id="SVGID_1_" x1="0.0000038" x2="512" y1="256" y2="256"><stop offset="0" style="stop-color:#00AEEE"/><stop offset="1" style="stop-color:#0095DA"/></linearGradient><circle cx="256" cy="256" fill="url(#SVGID_1_)" r="256"/><linearGradient gradientUnits="userSpaceOnUse" id="SVGID_2_" x1="42.6666679" x2="469.3333435" y1="256.0005188" y2="256.0005188"><stop offset="0" style="stop-color:#0095DA"/><stop offset="1" style="stop-color:#00AEEE"/></linearGradient><path d="M256,469.3338623c-117.6314697,0-213.3333282-95.7023926-213.3333282-213.3333435    c0-117.6314545,95.7018585-213.333313,213.3333282-213.333313c117.636261,0,213.3333435,95.7018661,213.3333435,213.333313    C469.3333435,373.6314697,373.636261,469.3338623,256,469.3338623z" fill="url(#SVGID_2_)"/></g><path d="M360.2250671,330.9226685v-37.9413452h-91.2255859v-46.6655884   c25.976532-2.5151978,46.2854309-24.3957367,46.2854309-51.0314636C315.2849121,166.9605255,292.3237305,144,264,144   s-51.2848053,22.9605255-51.2848053,51.2842712c0,26.6357269,20.3088074,48.5162659,46.2842865,51.0314636v46.6655884h-91.2256165   v37.9413452h-21.5375977V384h53.0762634v-53.0773315h-21.5386658v-27.9413452h81.2256165v27.9413452h-21.5376129V384h53.0763702   v-53.0773315h-21.5387573v-27.9413452h81.2255859v27.9413452H328.687561V384h53.0761719v-53.0773315H360.2250671z" opacity="0.3"/><path d="M352.2250671,322.9226685v-37.9413452h-91.2255859v-46.6655884   c25.976532-2.5151978,46.2854309-24.3957367,46.2854309-51.0314636C307.2849121,158.9605255,284.3237305,136,256,136   s-51.2848053,22.9605255-51.2848053,51.2842712c0,26.6357269,20.3088074,48.5162659,46.2842712,51.0314636v46.6655884h-91.2256012   v37.9413452h-21.5375977V376h53.0762634v-53.0773315h-21.5386658v-27.9413452h81.2256012v27.9413452h-21.5375977V376h53.0763702   v-53.0773315h-21.5387573v-27.9413452h81.2255859v27.9413452H320.687561V376h53.0761719v-53.0773315H352.2250671z" fill="#FFFFFF"/></g></svg>
+<?xml version="1.0" ?>
+<svg enable-background="new 0 0 512 512" id="Layer_1" version="1.1" viewBox="0 0 512 512" xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g transform="scale(1.5)">
+        <g transform="translate(-78, -84)">
+            <path d="M360.2250671,330.9226685v-37.9413452h-91.2255859v-46.6655884   c25.976532-2.5151978,46.2854309-24.3957367,46.2854309-51.0314636C315.2849121,166.9605255,292.3237305,144,264,144   s-51.2848053,22.9605255-51.2848053,51.2842712c0,26.6357269,20.3088074,48.5162659,46.2842865,51.0314636v46.6655884h-91.2256165   v37.9413452h-21.5375977V384h53.0762634v-53.0773315h-21.5386658v-27.9413452h81.2256165v27.9413452h-21.5376129V384h53.0763702   v-53.0773315h-21.5387573v-27.9413452h81.2255859v27.9413452H328.687561V384h53.0761719v-53.0773315H360.2250671z" opacity="0.3"/>
+            <path d="M352.2250671,322.9226685v-37.9413452h-91.2255859v-46.6655884   c25.976532-2.5151978,46.2854309-24.3957367,46.2854309-51.0314636C307.2849121,158.9605255,284.3237305,136,256,136   s-51.2848053,22.9605255-51.2848053,51.2842712c0,26.6357269,20.3088074,48.5162659,46.2842712,51.0314636v46.6655884h-91.2256012   v37.9413452h-21.5375977V376h53.0762634v-53.0773315h-21.5386658v-27.9413452h81.2256012v27.9413452h-21.5375977V376h53.0763702   v-53.0773315h-21.5387573v-27.9413452h81.2255859v27.9413452H320.687561V376h53.0761719v-53.0773315H352.2250671z" fill="#FFFFFF"/>
+        </g>
+    </g>
+</svg>