mirror of
https://github.com/ynput/ayon-core.git
synced 2026-01-01 16:34:53 +01:00
77 lines
2.8 KiB
Python
77 lines
2.8 KiB
Python
import pyblish.api
|
|
from openpype.pipeline.publish import ValidateContentsOrder
|
|
from openpype.pipeline.publish import (
|
|
PublishXmlValidationError,
|
|
get_publish_template_name,
|
|
)
|
|
|
|
|
|
class ValidatePublishDir(pyblish.api.InstancePlugin):
|
|
"""Validates if files are being published into a project directory
|
|
|
|
In specific cases ('source' template - in place publishing) source folder
|
|
of published items is used as a regular `publish` dir.
|
|
This validates if it is inside any project dir for the project.
|
|
(eg. files are not published from local folder, inaccessible for studio')
|
|
|
|
"""
|
|
|
|
order = ValidateContentsOrder
|
|
label = "Validate publish dir"
|
|
|
|
checked_template_names = ["source"]
|
|
# validate instances might have interim family, needs to be mapped to final
|
|
family_mapping = {
|
|
"renderLayer": "render",
|
|
"renderLocal": "render"
|
|
}
|
|
|
|
def process(self, instance):
|
|
|
|
template_name = self._get_template_name_from_instance(instance)
|
|
|
|
if template_name not in self.checked_template_names:
|
|
return
|
|
|
|
original_dirname = instance.data.get("originalDirname")
|
|
if not original_dirname:
|
|
raise PublishXmlValidationError(
|
|
self,
|
|
"Instance meant for in place publishing."
|
|
" Its 'originalDirname' must be collected."
|
|
" Contact OP developer to modify collector."
|
|
)
|
|
|
|
anatomy = instance.context.data["anatomy"]
|
|
|
|
# original_dirname must be convertable to rootless path
|
|
# in other case it is path inside of root folder for the project
|
|
success, _ = anatomy.find_root_template_from_path(original_dirname)
|
|
|
|
formatting_data = {
|
|
"original_dirname": original_dirname,
|
|
}
|
|
msg = "Path '{}' not in project folder.".format(original_dirname) + \
|
|
" Please publish from inside of project folder."
|
|
if not success:
|
|
raise PublishXmlValidationError(self, msg, key="not_in_dir",
|
|
formatting_data=formatting_data)
|
|
|
|
def _get_template_name_from_instance(self, instance):
|
|
"""Find template which will be used during integration."""
|
|
project_name = instance.context.data["projectName"]
|
|
host_name = instance.context.data["hostName"]
|
|
anatomy_data = instance.data["anatomyData"]
|
|
family = anatomy_data["family"]
|
|
family = self.family_mapping.get(family) or family
|
|
task_info = anatomy_data.get("task") or {}
|
|
|
|
return get_publish_template_name(
|
|
project_name,
|
|
host_name,
|
|
family,
|
|
task_name=task_info.get("name"),
|
|
task_type=task_info.get("type"),
|
|
project_settings=instance.context.data["project_settings"],
|
|
logger=self.log
|
|
)
|