Skip to content

validate_node_ids_in_database

ValidateNodeIdsInDatabase

Bases: MayaInstancePlugin

Validate if the CB Id is related to an folder in the database

All nodes with the cbId attribute will be validated to ensure that the loaded asset in the scene is related to the current project.

Tip: If there is an asset which is being reused from a different project please ensure the asset is republished in the new project

Source code in client/ayon_maya/plugins/publish/validate_node_ids_in_database.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class ValidateNodeIdsInDatabase(plugin.MayaInstancePlugin):
    """Validate if the CB Id is related to an folder in the database

    All nodes with the `cbId` attribute will be validated to ensure that
    the loaded asset in the scene is related to the current project.

    Tip: If there is an asset which is being reused from a different project
    please ensure the asset is republished in the new project

    """

    order = ValidatePipelineOrder
    label = 'Node Ids in Database'
    families = ["*"]

    actions = [ayon_maya.api.action.SelectInvalidAction,
               ayon_maya.api.action.GenerateUUIDsOnInvalidAction]

    @classmethod
    def apply_settings(cls, project_settings):
        # Disable plug-in if cbId workflow is disabled
        if not project_settings["maya"].get("use_cbid_workflow", True):
            cls.enabled = False
            return

    def process(self, instance):
        invalid = self.get_invalid(instance)
        if invalid:
            raise PublishValidationError(
                "Found folder ids which are not related to "
                "current project in instance: `{}`".format(instance.name))

    @classmethod
    def get_invalid(cls, instance):

        nodes = instance[:]
        if not nodes:
            return

        # Get all id required nodes
        id_required_nodes = lib.get_id_required_nodes(referenced_nodes=False,
                                                      nodes=nodes)
        if not id_required_nodes:
            return

        # check ids against database ids
        folder_ids = cls.get_project_folder_ids(context=instance.context)

        # Get all asset IDs
        invalid = []
        for node in id_required_nodes:
            cb_id = lib.get_id(node)

            # Ignore nodes without id, those are validated elsewhere
            if not cb_id:
                continue

            folder_id = cb_id.split(":", 1)[0]
            if folder_id not in folder_ids:
                cls.log.error("`%s` has unassociated folder id" % node)
                invalid.append(node)

        return invalid

    @classmethod
    def get_project_folder_ids(cls, context):
        """Return all folder ids in the current project.

        Arguments:
            context (pyblish.api.Context): The publish context.

        Returns:
            set[str]: All folder ids in the current project.

        """
        # We query the database only for the first instance instead of
        # per instance by storing a cache in the context
        key = "__cache_project_folder_ids"
        if key in context.data:
            return context.data[key]

        # check ids against database
        project_name = context.data["projectName"]
        folder_entities = ayon_api.get_folders(project_name, fields={"id"})
        folder_ids = {
            folder_entity["id"]
            for folder_entity in folder_entities
        }

        context.data[key] = folder_ids
        return folder_ids

get_project_folder_ids(context) classmethod

Return all folder ids in the current project.

Parameters:

Name Type Description Default
context Context

The publish context.

 required

Returns:

Type Description

set[str]: All folder ids in the current project.
Source code in client/ayon_maya/plugins/publish/validate_node_ids_in_database.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@classmethod
def get_project_folder_ids(cls, context):
    """Return all folder ids in the current project.

    Arguments:
        context (pyblish.api.Context): The publish context.

    Returns:
        set[str]: All folder ids in the current project.

    """
    # We query the database only for the first instance instead of
    # per instance by storing a cache in the context
    key = "__cache_project_folder_ids"
    if key in context.data:
        return context.data[key]

    # check ids against database
    project_name = context.data["projectName"]
    folder_entities = ayon_api.get_folders(project_name, fields={"id"})
    folder_ids = {
        folder_entity["id"]
        for folder_entity in folder_entities
    }

    context.data[key] = folder_ids
    return folder_ids