Max: Implementation of the validator for model name

client/ayon_core/hosts/max/plugins/publish/validate_model_name.py

@@ -0,0 +1,100 @@
+# -*- coding: utf-8 -*-
+"""Validate model nodes names."""
+import re
+
+import pyblish.api
+from pymxs import runtime as rt
+
+from ayon_core.hosts.max.api.action import SelectInvalidAction
+
+from ayon_core.pipeline.publish import (
+    OptionalPyblishPluginMixin,
+    PublishValidationError,
+    ValidateContentsOrder)
+
+
+class ValidateModelName(pyblish.api.InstancePlugin,
+                        OptionalPyblishPluginMixin):
+    """Validate Model Name
+    Validation regex is (.*)_(?P<subset>.*)_(GEO) by default.
+    e.g. {SOME_RANDOM_NAME}_{YOUR_SUBSET_NAME}_GEO should be your
+        default model name
+
+    The regex of (?P<subset>.*) can be replaced by (?P<asset>.*)
+    and (?P<project>.*).
+    e.g.
+    - (.*)_(?P<asset>.*)_(GEO) check if your model name is
+        {SOME_RANDOM_NAME}_{CURRENT_ASSET_NAME}_GEO
+    - (.*)_(?P<project>.*)_(GEO) check if your model name is
+        {SOME_RANDOM_NAME}_{CURRENT_PROJECT_NAME}_GEO
+
+    """
+    optional = True
+    order = ValidateContentsOrder
+    hosts = ["max"]
+    families = ["model"]
+    label = "Validate Model Name"
+    actions = [SelectInvalidAction]
+    regex = ""
+
+    @classmethod
+    def get_invalid(cls, instance):
+        invalid = []
+        model_names = [model.name for model in instance.data.get("members")]
+        cls.log.debug(model_names)
+        if not model_names:
+            cls.log.error("No Model found in the OP Data.")
+            invalid.append(model_names)
+        for name in model_names:
+            invalid_model_name = cls.get_invalid_model_name(instance, name)
+            invalid.extend(invalid_model_name)
+
+        return invalid
+
+    @classmethod
+    def get_invalid_model_name(cls, instance, name):
+        invalid = []
+        regex = cls.regex
+        reg = re.compile(regex)
+        matched_name = reg.match(name)
+        project_name = instance.context.data["projectName"]
+        current_asset_name = instance.context.data["folderPath"]
+        if matched_name is None:
+            cls.log.error("invalid model name on: {}".format(name))
+            cls.log.error("name doesn't match regex {}".format(regex))
+            invalid.append((rt.getNodeByName(name),
+                            "Model name doesn't match regex"))
+        else:
+            if "asset" in reg.groupindex:
+                if matched_name.group("asset") != current_asset_name:
+                    cls.log.error(
+                        "Invalid asset name of the model {}.".format(name)
+                    )
+                    invalid.append((rt.getNodeByName(name),
+                                    "Model with invalid asset name"))
+            if "subset" in reg.groupindex:
+                if matched_name.group("subset") != instance.name:
+                    cls.log.error(
+                        "Invalid subset name of the model {}.".format(name)
+                    )
+                    invalid.append((rt.getNodeByName(name),
+                                    "Model with invalid subset name"))
+            if "project" in reg.groupindex:
+                if matched_name.group("project") != project_name:
+                    cls.log.error(
+                        "Invalid project name of the model {}.".format(name)
+                    )
+                    invalid.append((rt.getNodeByName(name),
+                                    "Model with invalid project name"))
+        return invalid
+
+    def process(self, instance):
+        if not self.is_active(instance.data):
+            self.log.debug("Skipping Validate Model Name...")
+            return
+
+        invalid = self.get_invalid(instance)
+
+        if invalid:
+            raise PublishValidationError(
+                "Model naming is invalid. See the log.")

client/ayon_core/settings/defaults/project_settings/max.json

@@ -0,0 +1,106 @@
+{
+    "unit_scale_settings": {
+        "enabled": true,
+        "scene_unit_scale": "Meters"
+    },
+    "imageio": {
+        "activate_host_color_management": true,
+        "ocio_config": {
+            "override_global_config": false,
+            "filepath": []
+        },
+        "file_rules": {
+            "activate_host_rules": false,
+            "rules": {}
+        }
+    },
+    "RenderSettings": {
+        "default_render_image_folder": "renders/3dsmax",
+        "aov_separator": "underscore",
+        "image_format": "exr",
+        "multipass": true
+    },
+    "CreateReview": {
+        "review_width": 1920,
+        "review_height": 1080,
+        "percentSize": 100.0,
+        "keep_images": false,
+        "image_format": "png",
+        "visual_style": "Realistic",
+        "viewport_preset": "Quality",
+        "anti_aliasing": "None",
+        "vp_texture": true
+    },
+    "PointCloud": {
+        "attribute": {
+            "Age": "age",
+            "Radius": "radius",
+            "Position": "position",
+            "Rotation": "rotation",
+            "Scale": "scale",
+            "Velocity": "velocity",
+            "Color": "color",
+            "TextureCoordinate": "texcoord",
+            "MaterialID": "matid",
+            "custFloats": "custFloats",
+            "custVecs": "custVecs"
+        }
+    },
+    "publish": {
+        "ValidateFrameRange": {
+            "enabled": true,
+            "optional": true,
+            "active": true
+        },
+        "ValidateAttributes": {
+            "enabled": false,
+            "attributes": {}
+        },
+        "ValidateCameraAttributes": {
+            "enabled": true,
+            "optional": true,
+            "active": false,
+            "fov": 45.0,
+            "nearrange": 0.0,
+            "farrange": 1000.0,
+            "nearclip": 1.0,
+            "farclip": 1000.0
+        },
+        "ValidateModelName": {
+            "enabled": true,
+            "optional": true,
+            "active": false,
+            "regex": "(.*)_(?P<subset>.*)_(GEO)"
+        },
+        "ValidateLoadedPlugin": {
+            "enabled": false,
+            "optional": true,
+            "family_plugins_mapping": []
+        },
+        "ExtractModelObj": {
+            "enabled": true,
+            "optional": true,
+            "active": false
+        },
+        "ExtractModelFbx": {
+            "enabled": true,
+            "optional": true,
+            "active": false
+        },
+        "ExtractModelUSD": {
+            "enabled": true,
+            "optional": true,
+            "active": false
+        },
+        "ExtractModel": {
+            "enabled": true,
+            "optional": true,
+            "active": true
+        },
+        "ExtractMaxSceneRaw": {
+            "enabled": true,
+            "optional": true,
+            "active": true
+        }
+    }
+}

server_addon/max/server/settings/publishers.py

@@ -49,6 +49,20 @@ class FamilyMappingItemModel(BaseSettingsModel):
     )
 
 
+class ValidateModelNameModel(BaseSettingsModel):
+    enabled: bool = SettingsField(title="Enabled")
+    optional: bool = SettingsField(title="Optional")
+    active: bool = SettingsField(title="Active")
+    regex: str = SettingsField(
+        "(.*)_(?P<subset>.*)_(GEO)",
+        title="Validation regex",
+        description=(
+            "Regex for validating model name. You can use named "
+            " capturing groups:(?P<asset>.*) for Asset name"
+        )
+    )
+
+
 class ValidateLoadedPluginModel(BaseSettingsModel):
     enabled: bool = SettingsField(title="Enabled")
     optional: bool = SettingsField(title="Optional")
@@ -86,6 +100,10 @@ class PublishersModel(BaseSettingsModel):
         default_factory=ValidateLoadedPluginModel,
         title="Validate Loaded Plugin"
     )
+    ValidateModelName: ValidateModelNameModel = SettingsField(
+        default_factory=ValidateModelNameModel,
+        title="Validate Model Name"
+    )
     ExtractModelObj: BasicValidateModel = SettingsField(
         default_factory=BasicValidateModel,
         title="Extract OBJ",
@@ -129,6 +147,12 @@ class PublishersModel(BaseSettingsModel):
         "nearclip": 1.0,
         "farclip": 1000.0
     },
+    "ValidateModelName": {
+        "enabled": True,
+        "optional": True,
+        "active": False,
+        "regex": "(.*)_(?P<subset>.*)_(GEO)"
+    },
     "ValidateLoadedPlugin": {
         "enabled": False,
         "optional": True,

server_addon/max/server/version.py

@@ -1 +1 @@
-__version__ = "0.1.5"
+__version__ = "0.1.6"