From ff7b3004ad953253afbc8e3a9640aa99a24f1c47 Mon Sep 17 00:00:00 2001
From: Jakub Trllo <jakub.trllo@gmail.com>
Date: Wed, 15 Feb 2023 11:00:10 +0100
Subject: [PATCH] added validator for duplicated usage of render layer groups

---
 .../help/validate_render_layer_group.xml      | 18 +++++
 .../publish/validate_render_layer_group.py    | 74 +++++++++++++++++++
 2 files changed, 92 insertions(+)
 create mode 100644 openpype/hosts/tvpaint/plugins/publish/help/validate_render_layer_group.xml
 create mode 100644 openpype/hosts/tvpaint/plugins/publish/validate_render_layer_group.py

diff --git a/openpype/hosts/tvpaint/plugins/publish/help/validate_render_layer_group.xml b/openpype/hosts/tvpaint/plugins/publish/help/validate_render_layer_group.xml
new file mode 100644
index 0000000000..a95387356f
--- /dev/null
+++ b/openpype/hosts/tvpaint/plugins/publish/help/validate_render_layer_group.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+<error id="main">
+<title>Overused Color group</title>
+<description>## One Color group is used by multiple Render Layers
+
+Single color group used by multiple Render Layers would cause clashes of rendered TVPaint layers. The same layers would be used for output files of both groups.
+
+### Missing layer names
+
+{groups_information}
+
+### How to repair?
+
+Refresh, go to 'Publish' tab and go through Render Layers and change their groups to not clash each other. If you reach limit of TVPaint color groups there is nothing you can do about it to fix the issue.
+</description>
+</error>
+</root>
diff --git a/openpype/hosts/tvpaint/plugins/publish/validate_render_layer_group.py b/openpype/hosts/tvpaint/plugins/publish/validate_render_layer_group.py
new file mode 100644
index 0000000000..bb0a9a4ffe
--- /dev/null
+++ b/openpype/hosts/tvpaint/plugins/publish/validate_render_layer_group.py
@@ -0,0 +1,74 @@
+import collections
+import pyblish.api
+from openpype.pipeline import PublishXmlValidationError
+
+
+class ValidateRenderLayerGroups(pyblish.api.ContextPlugin):
+    """Validate group ids of renderLayer subsets.
+
+    Validate that there are not 2 render layers using the same group.
+    """
+
+    label = "Validate Render Layers Group"
+    order = pyblish.api.ValidatorOrder + 0.1
+
+    def process(self, context):
+        # Prepare layers
+        render_layers_by_group_id = collections.defaultdict(list)
+        for instance in context:
+            families = instance.data.get("families")
+            if not families or "renderLayer" not in families:
+                continue
+
+            group_id = instance.data["creator_attributes"]["group_id"]
+            render_layers_by_group_id[group_id].append(instance)
+
+        duplicated_instances = []
+        for group_id, instances in render_layers_by_group_id.items():
+            if len(instances) > 1:
+                duplicated_instances.append((group_id, instances))
+
+        if not duplicated_instances:
+            return
+
+        # Exception message preparations
+        groups_data = context.data["groupsData"]
+        groups_by_id = {
+            group["group_id"]: group
+            for group in groups_data
+        }
+
+        per_group_msgs = []
+        groups_information_lines = []
+        for group_id, instances in duplicated_instances:
+            group = groups_by_id[group_id]
+            group_label = "Group \"{}\" ({})".format(
+                group["name"],
+                group["group_id"],
+            )
+            line_join_subset_names = "\n".join([
+                f"    - {instance['subset']}"
+                for instance in instances
+            ])
+            joined_subset_names = ", ".join([
+                f"\"{instance['subset']}\""
+                for instance in instances
+            ])
+            per_group_msgs.append(
+                "{} < {} >".format(group_label, joined_subset_names)
+            )
+            groups_information_lines.append(
+                "<b>{}</b>\n{}".format(group_label, line_join_subset_names)
+            )
+
+        # Raise an error
+        raise PublishXmlValidationError(
+            self,
+            (
+                "More than one Render Layer is using the same TVPaint"
+                " group color. {}"
+            ).format(" | ".join(per_group_msgs)),
+            formatting_data={
+                "groups_information": "\n".join(groups_information_lines)
+            }
+        )