Merge branch 'develop' into feature/OP-3842_Change-publish-template-settings-location

openpype/pipeline/project_folders.py

@@ -0,0 +1,107 @@
+import os
+import re
+import json
+
+import six
+
+from openpype.settings import get_project_settings
+from openpype.lib import Logger
+
+from .anatomy import Anatomy
+from .template_data import get_project_template_data
+
+
+def concatenate_splitted_paths(split_paths, anatomy):
+    log = Logger.get_logger("concatenate_splitted_paths")
+    pattern_array = re.compile(r"\[.*\]")
+    output = []
+    for path_items in split_paths:
+        clean_items = []
+        if isinstance(path_items, str):
+            path_items = [path_items]
+
+        for path_item in path_items:
+            if not re.match(r"{.+}", path_item):
+                path_item = re.sub(pattern_array, "", path_item)
+            clean_items.append(path_item)
+
+        # backward compatibility
+        if "__project_root__" in path_items:
+            for root, root_path in anatomy.roots.items():
+                if not os.path.exists(str(root_path)):
+                    log.debug("Root {} path path {} not exist on \
+                        computer!".format(root, root_path))
+                    continue
+                clean_items = ["{{root[{}]}}".format(root),
+                               r"{project[name]}"] + clean_items[1:]
+                output.append(os.path.normpath(os.path.sep.join(clean_items)))
+            continue
+
+        output.append(os.path.normpath(os.path.sep.join(clean_items)))
+
+    return output
+
+
+def fill_paths(path_list, anatomy):
+    format_data = get_project_template_data(project_name=anatomy.project_name)
+    format_data["root"] = anatomy.roots
+    filled_paths = []
+
+    for path in path_list:
+        new_path = path.format(**format_data)
+        filled_paths.append(new_path)
+
+    return filled_paths
+
+
+def create_project_folders(project_name, basic_paths=None):
+    log = Logger.get_logger("create_project_folders")
+    anatomy = Anatomy(project_name)
+    if basic_paths is None:
+        basic_paths = get_project_basic_paths(project_name)
+
+    if not basic_paths:
+        return
+
+    concat_paths = concatenate_splitted_paths(basic_paths, anatomy)
+    filled_paths = fill_paths(concat_paths, anatomy)
+
+    # Create folders
+    for path in filled_paths:
+        if os.path.exists(path):
+            log.debug("Folder already exists: {}".format(path))
+        else:
+            log.debug("Creating folder: {}".format(path))
+            os.makedirs(path)
+
+
+def _list_path_items(folder_structure):
+    output = []
+    for key, value in folder_structure.items():
+        if not value:
+            output.append(key)
+            continue
+
+        paths = _list_path_items(value)
+        for path in paths:
+            if not isinstance(path, (list, tuple)):
+                path = [path]
+
+            item = [key]
+            item.extend(path)
+            output.append(item)
+
+    return output
+
+
+def get_project_basic_paths(project_name):
+    project_settings = get_project_settings(project_name)
+    folder_structure = (
+        project_settings["global"]["project_folder_structure"]
+    )
+    if not folder_structure:
+        return []
+
+    if isinstance(folder_structure, six.string_types):
+        folder_structure = json.loads(folder_structure)
+    return _list_path_items(folder_structure)

openpype/pipeline/template_data.py

@@ -53,7 +53,7 @@ def get_project_template_data(project_doc=None, project_name=None):
         project_name = project_doc["name"]
 
     if not project_doc:
-        project_code = get_project(project_name, fields=["data.code"])
+        project_doc = get_project(project_name, fields=["data.code"])
 
     project_code = project_doc.get("data", {}).get("code")
     return {

openpype/pipeline/workfile/__init__.py

@@ -9,6 +9,8 @@ from .path_resolving import (
 
     get_custom_workfile_template,
     get_custom_workfile_template_by_string_context,
+
+    create_workdir_extra_folders,
 )
 
 from .build_workfile import BuildWorkfile
@@ -26,5 +28,7 @@ __all__ = (
     "get_custom_workfile_template",
     "get_custom_workfile_template_by_string_context",
 
+    "create_workdir_extra_folders",
+
     "BuildWorkfile",
 )

openpype/pipeline/workfile/path_resolving.py

@@ -467,3 +467,60 @@ def get_custom_workfile_template_by_string_context(
     return get_custom_workfile_template(
         project_doc, asset_doc, task_name, host_name, anatomy, project_settings
     )
+
+
+def create_workdir_extra_folders(
+    workdir,
+    host_name,
+    task_type,
+    task_name,
+    project_name,
+    project_settings=None
+):
+    """Create extra folders in work directory based on context.
+
+    Args:
+        workdir (str): Path to workdir where workfiles is stored.
+        host_name (str): Name of host implementation.
+        task_type (str): Type of task for which extra folders should be
+            created.
+        task_name (str): Name of task for which extra folders should be
+            created.
+        project_name (str): Name of project on which task is.
+        project_settings (dict): Prepared project settings. Are loaded if not
+            passed.
+    """
+
+    # Load project settings if not set
+    if not project_settings:
+        project_settings = get_project_settings(project_name)
+
+    # Load extra folders profiles
+    extra_folders_profiles = (
+        project_settings["global"]["tools"]["Workfiles"]["extra_folders"]
+    )
+    # Skip if are empty
+    if not extra_folders_profiles:
+        return
+
+    # Prepare profiles filters
+    filter_data = {
+        "task_types": task_type,
+        "task_names": task_name,
+        "hosts": host_name
+    }
+    profile = filter_profiles(extra_folders_profiles, filter_data)
+    if profile is None:
+        return
+
+    for subfolder in profile["folders"]:
+        # Make sure backslashes are converted to forwards slashes
+        #   and does not start with slash
+        subfolder = subfolder.replace("\\", "/").lstrip("/")
+        # Skip empty strings
+        if not subfolder:
+            continue
+
+        fullpath = os.path.join(workdir, subfolder)
+        if not os.path.exists(fullpath):
+            os.makedirs(fullpath)