Merged in feature/PYPE-51-custom-attribute-action (pull request #18)

Created attributes are set to group and security roles are set for API only

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

pype/ftrack/actions/action_createCustomAttributes.py

@@ -24,14 +24,18 @@ class AvalonIdAttribute(BaseAction):
 
 
     def discover(self, session, entities, event):
-        ''' Validation '''
+        '''
+        Validation
+        - action is only for Administrators
+        '''
+        success = False
+        userId = event['source']['user']['id']
+        user = session.query('User where id is ' + userId).one()
+        for role in user['user_security_roles']:
+            if role['security_role']['name'] == 'Administrator':
+                success = True
 
-        # userId = event['source']['user']['id']
-        # user = session.query('User where id is ' + userId).one()
-        # if user['user_security_roles'][0]['security_role']['name'] != 'Administrator':
-        #     return False
-
-        return True
+        return success
 
 
     def launch(self, session, entities, event):
@@ -49,13 +53,21 @@ class AvalonIdAttribute(BaseAction):
         })
         session.commit()
         try:
+            # Checkbox for event sync
+            cbxSyncName = 'avalon_auto_sync'
+            cbxSyncLabel = 'Avalon auto-sync'
+            cbxSyncExist = False
+
             # Attribute Name and Label
             custAttrName = 'avalon_mongo_id'
             custAttrLabel = 'Avalon/Mongo Id'
+
+            attrs_update = set()
             # Types that don't need object_type_id
             base = {'show'}
+
             # Don't create custom attribute on these entity types:
-            exceptions = ['task','milestone','library']
+            exceptions = ['task', 'milestone']
             exceptions.extend(base)
             # Get all possible object types
             all_obj_types = session.query('ObjectType').all()
@@ -73,6 +85,7 @@ class AvalonIdAttribute(BaseAction):
 
             # Get IDs of filtered object types
             all_obj_types_id = set()
+
             for obj in all_obj_types:
                 all_obj_types_id.add(obj['id'])
 
@@ -80,20 +93,60 @@ class AvalonIdAttribute(BaseAction):
             current_cust_attr = session.query('CustomAttributeConfiguration').all()
             # Filter already existing AvalonMongoID attr.
             for attr in current_cust_attr:
+                if attr['key'] == cbxSyncName:
+                    cbxSyncExist = True
+                    cbxAttribute = attr
                 if attr['key'] == custAttrName:
                     if attr['entity_type'] in base:
                         base.remove(attr['entity_type'])
+                        attrs_update.add(attr)
                     if attr['object_type_id'] in all_obj_types_id:
                         all_obj_types_id.remove(attr['object_type_id'])
+                        attrs_update.add(attr)
 
             # Set session back to begin("session.query" raises error on commit)
             session.rollback()
             # Set security roles for attribute
-            custAttrSecuRole = session.query('SecurityRole').all()
+            role_api = session.query('SecurityRole where name is "API"').one()
+            role_admin = session.query('SecurityRole where name is "Administrator"').one()
+            roles = [role_api,role_admin]
+
             # Set Text type of Attribute
             custom_attribute_type = session.query(
                 'CustomAttributeType where name is "text"'
             ).one()
+            # Get/Set 'avalon' group
+            groups = session.query('CustomAttributeGroup where name is "avalon"').all()
+            if len(groups) > 1:
+                msg = "There are more Custom attribute groups with name 'avalon'"
+                self.log.warning(msg)
+                return { 'success': False, 'message':msg }
+
+            elif len(groups) < 1:
+                group = session.create('CustomAttributeGroup', {
+                    'name': 'avalon',
+                })
+                session.commit()
+            else:
+                group = groups[0]
+
+            # Checkbox for auto-sync event / Create or Update(roles + group)
+            if cbxSyncExist is False:
+                cbxType = session.query('CustomAttributeType where name is "boolean"').first()
+                session.create('CustomAttributeConfiguration', {
+                    'entity_type': 'show',
+                    'type': cbxType,
+                    'label': cbxSyncLabel,
+                    'key': cbxSyncName,
+                    'default': False,
+                    'write_security_roles': roles,
+                    'read_security_roles': roles,
+                    'group':group,
+                })
+            else:
+                cbxAttribute['write_security_roles'] = roles
+                cbxAttribute['read_security_roles'] = roles
+                cbxAttribute['group'] = group
 
             for entity_type in base:
                 # Create a custom attribute configuration.
@@ -103,8 +156,9 @@ class AvalonIdAttribute(BaseAction):
                     'label': custAttrLabel,
                     'key': custAttrName,
                     'default': '',
-                    'write_security_roles': custAttrSecuRole,
-                    'read_security_roles': custAttrSecuRole,
+                    'write_security_roles': roles,
+                    'read_security_roles': roles,
+                    'group':group,
                     'config': json.dumps({'markdown': False})
                 })
 
@@ -117,16 +171,24 @@ class AvalonIdAttribute(BaseAction):
                     'label': custAttrLabel,
                     'key': custAttrName,
                     'default': '',
-                    'write_security_roles': custAttrSecuRole,
-                    'read_security_roles': custAttrSecuRole,
+                    'write_security_roles': roles,
+                    'read_security_roles': roles,
+                    'group':group,
                     'config': json.dumps({'markdown': False})
                 })
 
+            for attr in attrs_update:
+                attr['write_security_roles'] = roles
+                attr['read_security_roles'] = roles
+                attr['group'] = group
+
             job['status'] = 'done'
             session.commit()
 
         except Exception as e:
+            session.rollback()
             job['status'] = 'failed'
+            session.commit()
             self.log.error("Creating custom attributes failed ({})".format(e))
 
         return True