From 254455e786c50ef20d0f953bebd57d50af077b1e Mon Sep 17 00:00:00 2001
From: Petr Kalis <petr.kalis@gmail.com>
Date: Mon, 30 May 2022 18:05:56 +0200
Subject: [PATCH] OP-3277 - introduced Settings variable

Configured via Maya/Maya-dirmap to use in all Loaders
---
 openpype/hosts/maya/api/plugin.py             | 45 ++++++++++---------
 .../defaults/project_settings/maya.json       |  1 +
 .../projects_schema/schema_project_maya.json  |  6 +++
 3 files changed, 31 insertions(+), 21 deletions(-)

diff --git a/openpype/hosts/maya/api/plugin.py b/openpype/hosts/maya/api/plugin.py
index 93b0793d9c..f05893a7b4 100644
--- a/openpype/hosts/maya/api/plugin.py
+++ b/openpype/hosts/maya/api/plugin.py
@@ -11,7 +11,7 @@ from openpype.pipeline import (
     AVALON_CONTAINER_ID,
 )
 from openpype.api import Anatomy
-
+from openpype.settings import get_project_settings
 from .pipeline import containerise
 from . import lib
 
@@ -133,7 +133,6 @@ class ReferenceLoader(Loader):
                  " imported representation ?"
         )
     ]
-    use_env_var_as_root = True
 
     def load(
         self,
@@ -193,25 +192,6 @@ class ReferenceLoader(Loader):
         """To be implemented by subclass"""
         raise NotImplementedError("Must be implemented by subclass")
 
-    def prepare_root_value(self, file_url, project_name):
-        """Replace root value with env var placeholder.
-
-        Use ${OPENPYPE_ROOT_WORK} (or any other root) instead of proper root
-        value when storing referenced url into a workfile.
-        Useful for remote workflows with SiteSync.
-
-        Args:
-            file_url (str)
-            project_name (dict)
-        Returns:
-            (str)
-        """
-        if self.use_env_var_as_root:
-            anatomy = Anatomy(project_name)
-            file_url = anatomy.replace_root_with_env_key(file_url, '${{{}}}')
-
-        return file_url
-
     def update(self, container, representation):
         from maya import cmds
         from openpype.hosts.maya.api.lib import get_container_members
@@ -344,6 +324,29 @@ class ReferenceLoader(Loader):
         except RuntimeError:
             pass
 
+    def prepare_root_value(self, file_url, project_name):
+        """Replace root value with env var placeholder.
+
+        Use ${OPENPYPE_ROOT_WORK} (or any other root) instead of proper root
+        value when storing referenced url into a workfile.
+        Useful for remote workflows with SiteSync.
+
+        Args:
+            file_url (str)
+            project_name (dict)
+        Returns:
+            (str)
+        """
+        settings = get_project_settings(project_name)
+        use_env_var_as_root = (settings["maya"]
+                                       ["maya-dirmap"]
+                                       ["use_env_var_as_root"])
+        if use_env_var_as_root:
+            anatomy = Anatomy(project_name)
+            file_url = anatomy.replace_root_with_env_key(file_url, '${{{}}}')
+
+        return file_url
+
     @staticmethod
     def _organize_containers(nodes, container):
         # type: (list, str) -> None
diff --git a/openpype/settings/defaults/project_settings/maya.json b/openpype/settings/defaults/project_settings/maya.json
index e03bdcecc3..a42f889e85 100644
--- a/openpype/settings/defaults/project_settings/maya.json
+++ b/openpype/settings/defaults/project_settings/maya.json
@@ -8,6 +8,7 @@
         "yetiRig": "ma"
     },
     "maya-dirmap": {
+        "use_env_var_as_root": true,
         "enabled": false,
         "paths": {
             "source-path": [],
diff --git a/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json b/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
index 0c7943447b..f9523b1baa 100644
--- a/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
+++ b/openpype/settings/entities/schemas/projects_schema/schema_project_maya.json
@@ -22,6 +22,12 @@
             "label": "Maya Directory Mapping",
             "is_group": true,
             "children": [
+                {
+                    "type": "boolean",
+                    "key": "use_env_var_as_root",
+                    "label": "Use env var placeholder in referenced url",
+                    "docstring": "Use ${} placeholder instead of physical value of root when storing into workfile metadata."
+                },
                 {
                     "type": "boolean",
                     "key": "enabled",