mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 21:04:40 +01:00
Merge pull request #2906 from pypeclub/enhancement/OP-2818_Workfile-name-ftrack-attribute
Ftrack: Fill workfile in custom attribute
This commit is contained in:
Jakub Trllo
GitHub
commit
8e1ec6d251
4 changed files with 533 additions and 30 deletions
|
|
@ -0,0 +1,494 @@
|
|||
import os
|
||||
import sys
|
||||
import json
|
||||
import collections
|
||||
import tempfile
|
||||
import datetime
|
||||
|
||||
import ftrack_api
|
||||
|
||||
from avalon.api import AvalonMongoDB
|
||||
from openpype.api import get_project_settings
|
||||
from openpype.lib import (
|
||||
get_workfile_template_key,
|
||||
get_workdir_data,
|
||||
Anatomy,
|
||||
StringTemplate,
|
||||
)
|
||||
from openpype_modules.ftrack.lib import BaseAction, statics_icon
|
||||
from openpype_modules.ftrack.lib.avalon_sync import create_chunks
|
||||
|
||||
NOT_SYNCHRONIZED_TITLE = "Not synchronized"
|
||||
|
||||
|
||||
class FillWorkfileAttributeAction(BaseAction):
|
||||
"""Action fill work filename into custom attribute on tasks.
|
||||
|
||||
Prerequirements are that the project is synchronized so it is possible to
|
||||
access project anatomy and project/asset documents. Tasks that are not
|
||||
synchronized are skipped too.
|
||||
"""
|
||||
|
||||
identifier = "fill.workfile.attr"
|
||||
label = "OpenPype Admin"
|
||||
variant = "- Fill workfile attribute"
|
||||
description = "Precalculate and fill workfile name into a custom attribute"
|
||||
icon = statics_icon("ftrack", "action_icons", "OpenPypeAdmin.svg")
|
||||
|
||||
settings_key = "fill_workfile_attribute"
|
||||
|
||||
def discover(self, session, entities, event):
|
||||
""" Validate selection. """
|
||||
is_valid = False
|
||||
for ent in event["data"]["selection"]:
|
||||
# Ignore entities that are not tasks or projects
|
||||
if ent["entityType"].lower() in ["show", "task"]:
|
||||
is_valid = True
|
||||
break
|
||||
|
||||
if is_valid:
|
||||
is_valid = self.valid_roles(session, entities, event)
|
||||
return is_valid
|
||||
|
||||
def launch(self, session, entities, event):
|
||||
# Separate entities and get project entity
|
||||
project_entity = None
|
||||
for entity in entities:
|
||||
if project_entity is None:
|
||||
project_entity = self.get_project_from_entity(entity)
|
||||
break
|
||||
|
||||
if not project_entity:
|
||||
return {
|
||||
"message": (
|
||||
"Couldn't find project entity."
|
||||
" Could be an issue with permissions."
|
||||
),
|
||||
"success": False
|
||||
}
|
||||
|
||||
# Get project settings and check if custom attribute where workfile
|
||||
# should be set is defined.
|
||||
project_name = project_entity["full_name"]
|
||||
project_settings = get_project_settings(project_name)
|
||||
custom_attribute_key = (
|
||||
project_settings
|
||||
.get("ftrack", {})
|
||||
.get("user_handlers", {})
|
||||
.get(self.settings_key, {})
|
||||
.get("custom_attribute_key")
|
||||
)
|
||||
if not custom_attribute_key:
|
||||
return {
|
||||
"success": False,
|
||||
"message": "Custom attribute key is not set in settings"
|
||||
}
|
||||
|
||||
# Try to find the custom attribute
|
||||
# - get Task type object id
|
||||
task_obj_type = session.query(
|
||||
"select id from ObjectType where name is \"Task\""
|
||||
).one()
|
||||
# - get text custom attribute type
|
||||
text_type = session.query(
|
||||
"select id from CustomAttributeType where name is \"text\""
|
||||
).one()
|
||||
# - find the attribute
|
||||
attr_conf = session.query(
|
||||
(
|
||||
"select id, key from CustomAttributeConfiguration"
|
||||
" where object_type_id is \"{}\""
|
||||
" and type_id is \"{}\""
|
||||
" and key is \"{}\""
|
||||
).format(
|
||||
task_obj_type["id"], text_type["id"], custom_attribute_key
|
||||
)
|
||||
).first()
|
||||
if not attr_conf:
|
||||
return {
|
||||
"success": False,
|
||||
"message": (
|
||||
"Could not find Task (text) Custom attribute \"{}\""
|
||||
).format(custom_attribute_key)
|
||||
}
|
||||
|
||||
# Store report information
|
||||
report = collections.defaultdict(list)
|
||||
user_entity = session.query(
|
||||
"User where id is {}".format(event["source"]["user"]["id"])
|
||||
).one()
|
||||
job_entity = session.create("Job", {
|
||||
"user": user_entity,
|
||||
"status": "running",
|
||||
"data": json.dumps({
|
||||
"description": "(0/3) Fill of workfiles started"
|
||||
})
|
||||
})
|
||||
session.commit()
|
||||
|
||||
try:
|
||||
self.in_job_process(
|
||||
session,
|
||||
entities,
|
||||
job_entity,
|
||||
project_entity,
|
||||
project_settings,
|
||||
attr_conf,
|
||||
report
|
||||
)
|
||||
except Exception:
|
||||
self.log.error(
|
||||
"Fill of workfiles to custom attribute failed", exc_info=True
|
||||
)
|
||||
session.rollback()
|
||||
|
||||
description = "Fill of workfiles Failed (Download traceback)"
|
||||
self.add_traceback_to_job(
|
||||
job_entity, session, sys.exc_info(), description
|
||||
)
|
||||
return {
|
||||
"message": (
|
||||
"Fill of workfiles failed."
|
||||
" Check job for more information"
|
||||
),
|
||||
"success": False
|
||||
}
|
||||
|
||||
job_entity["status"] = "done"
|
||||
job_entity["data"] = json.dumps({
|
||||
"description": "Fill of workfiles completed."
|
||||
})
|
||||
session.commit()
|
||||
if report:
|
||||
temp_obj = tempfile.NamedTemporaryFile(
|
||||
mode="w",
|
||||
prefix="openpype_ftrack_",
|
||||
suffix=".json",
|
||||
delete=False
|
||||
)
|
||||
temp_obj.close()
|
||||
temp_filepath = temp_obj.name
|
||||
with open(temp_filepath, "w") as temp_file:
|
||||
json.dump(report, temp_file)
|
||||
|
||||
component_name = "{}_{}".format(
|
||||
"FillWorkfilesReport",
|
||||
datetime.datetime.now().strftime("%y-%m-%d-%H%M")
|
||||
)
|
||||
self.add_file_component_to_job(
|
||||
job_entity, session, temp_filepath, component_name
|
||||
)
|
||||
# Delete temp file
|
||||
os.remove(temp_filepath)
|
||||
self._show_report(event, report, project_name)
|
||||
return {
|
||||
"message": (
|
||||
"Fill of workfiles finished with few issues."
|
||||
" Check job for more information"
|
||||
),
|
||||
"success": True
|
||||
}
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"message": "Finished with filling of work filenames"
|
||||
}
|
||||
|
||||
def _show_report(self, event, report, project_name):
|
||||
items = []
|
||||
title = "Fill workfiles report ({}):".format(project_name)
|
||||
|
||||
for subtitle, lines in report.items():
|
||||
if items:
|
||||
items.append({
|
||||
"type": "label",
|
||||
"value": "---"
|
||||
})
|
||||
items.append({
|
||||
"type": "label",
|
||||
"value": "# {}".format(subtitle)
|
||||
})
|
||||
items.append({
|
||||
"type": "label",
|
||||
"value": '<p>{}</p>'.format("<br>".join(lines))
|
||||
})
|
||||
|
||||
self.show_interface(
|
||||
items=items,
|
||||
title=title,
|
||||
event=event
|
||||
)
|
||||
|
||||
def in_job_process(
|
||||
self,
|
||||
session,
|
||||
entities,
|
||||
job_entity,
|
||||
project_entity,
|
||||
project_settings,
|
||||
attr_conf,
|
||||
report
|
||||
):
|
||||
task_entities = []
|
||||
other_entities = []
|
||||
project_selected = False
|
||||
for entity in entities:
|
||||
ent_type_low = entity.entity_type.lower()
|
||||
if ent_type_low == "project":
|
||||
project_selected = True
|
||||
break
|
||||
|
||||
elif ent_type_low == "task":
|
||||
task_entities.append(entity)
|
||||
else:
|
||||
other_entities.append(entity)
|
||||
|
||||
project_name = project_entity["full_name"]
|
||||
|
||||
# Find matchin asset documents and map them by ftrack task entities
|
||||
# - result stored to 'asset_docs_with_task_entities' is list with
|
||||
# tuple `(asset document, [task entitis, ...])`
|
||||
dbcon = AvalonMongoDB()
|
||||
dbcon.Session["AVALON_PROJECT"] = project_name
|
||||
# Quety all asset documents
|
||||
asset_docs = list(dbcon.find({"type": "asset"}))
|
||||
job_entity["data"] = json.dumps({
|
||||
"description": "(1/3) Asset documents queried."
|
||||
})
|
||||
session.commit()
|
||||
|
||||
# When project is selected then we can query whole project
|
||||
if project_selected:
|
||||
asset_docs_with_task_entities = self._get_asset_docs_for_project(
|
||||
session, project_entity, asset_docs, report
|
||||
)
|
||||
|
||||
else:
|
||||
asset_docs_with_task_entities = self._get_tasks_for_selection(
|
||||
session, other_entities, task_entities, asset_docs, report
|
||||
)
|
||||
|
||||
job_entity["data"] = json.dumps({
|
||||
"description": "(2/3) Queried related task entities."
|
||||
})
|
||||
session.commit()
|
||||
|
||||
# Keep placeholders in the template unfilled
|
||||
host_name = "{app}"
|
||||
extension = "{ext}"
|
||||
project_doc = dbcon.find_one({"type": "project"})
|
||||
project_settings = get_project_settings(project_name)
|
||||
anatomy = Anatomy(project_name)
|
||||
templates_by_key = {}
|
||||
|
||||
operations = []
|
||||
for asset_doc, task_entities in asset_docs_with_task_entities:
|
||||
for task_entity in task_entities:
|
||||
workfile_data = get_workdir_data(
|
||||
project_doc, asset_doc, task_entity["name"], host_name
|
||||
)
|
||||
# Use version 1 for each workfile
|
||||
workfile_data["version"] = 1
|
||||
workfile_data["ext"] = extension
|
||||
|
||||
task_type = workfile_data["task"]["type"]
|
||||
template_key = get_workfile_template_key(
|
||||
task_type, host_name, project_settings=project_settings
|
||||
)
|
||||
if template_key in templates_by_key:
|
||||
template = templates_by_key[template_key]
|
||||
else:
|
||||
template = StringTemplate(
|
||||
anatomy.templates[template_key]["file"]
|
||||
)
|
||||
templates_by_key[template_key] = template
|
||||
|
||||
result = template.format(workfile_data)
|
||||
if not result.solved:
|
||||
# TODO report
|
||||
pass
|
||||
else:
|
||||
table_values = collections.OrderedDict((
|
||||
("configuration_id", attr_conf["id"]),
|
||||
("entity_id", task_entity["id"])
|
||||
))
|
||||
operations.append(
|
||||
ftrack_api.operation.UpdateEntityOperation(
|
||||
"ContextCustomAttributeValue",
|
||||
table_values,
|
||||
"value",
|
||||
ftrack_api.symbol.NOT_SET,
|
||||
str(result)
|
||||
)
|
||||
)
|
||||
|
||||
if operations:
|
||||
for sub_operations in create_chunks(operations, 50):
|
||||
for op in sub_operations:
|
||||
session.recorded_operations.push(op)
|
||||
session.commit()
|
||||
|
||||
job_entity["data"] = json.dumps({
|
||||
"description": "(3/3) Set custom attribute values."
|
||||
})
|
||||
session.commit()
|
||||
|
||||
def _get_entity_path(self, entity):
|
||||
path_items = []
|
||||
for item in entity["link"]:
|
||||
if item["type"].lower() != "project":
|
||||
path_items.append(item["name"])
|
||||
return "/".join(path_items)
|
||||
|
||||
def _get_asset_docs_for_project(
|
||||
self, session, project_entity, asset_docs, report
|
||||
):
|
||||
asset_docs_task_names = {}
|
||||
|
||||
for asset_doc in asset_docs:
|
||||
asset_data = asset_doc["data"]
|
||||
ftrack_id = asset_data.get("ftrackId")
|
||||
if not ftrack_id:
|
||||
hierarchy = list(asset_data.get("parents") or [])
|
||||
hierarchy.append(asset_doc["name"])
|
||||
path = "/".join(hierarchy)
|
||||
report[NOT_SYNCHRONIZED_TITLE].append(path)
|
||||
continue
|
||||
|
||||
asset_tasks = asset_data.get("tasks") or {}
|
||||
asset_docs_task_names[ftrack_id] = (
|
||||
asset_doc, list(asset_tasks.keys())
|
||||
)
|
||||
|
||||
task_entities = session.query((
|
||||
"select id, name, parent_id, link from Task where project_id is {}"
|
||||
).format(project_entity["id"])).all()
|
||||
task_entities_by_parent_id = collections.defaultdict(list)
|
||||
for task_entity in task_entities:
|
||||
parent_id = task_entity["parent_id"]
|
||||
task_entities_by_parent_id[parent_id].append(task_entity)
|
||||
|
||||
output = []
|
||||
for ftrack_id, item in asset_docs_task_names.items():
|
||||
asset_doc, task_names = item
|
||||
valid_task_entities = []
|
||||
for task_entity in task_entities_by_parent_id[ftrack_id]:
|
||||
if task_entity["name"] in task_names:
|
||||
valid_task_entities.append(task_entity)
|
||||
else:
|
||||
path = self._get_entity_path(task_entity)
|
||||
report[NOT_SYNCHRONIZED_TITLE].append(path)
|
||||
|
||||
if valid_task_entities:
|
||||
output.append((asset_doc, valid_task_entities))
|
||||
|
||||
return output
|
||||
|
||||
def _get_tasks_for_selection(
|
||||
self, session, other_entities, task_entities, asset_docs, report
|
||||
):
|
||||
all_tasks = object()
|
||||
asset_docs_by_ftrack_id = {}
|
||||
asset_docs_by_parent_id = collections.defaultdict(list)
|
||||
for asset_doc in asset_docs:
|
||||
asset_data = asset_doc["data"]
|
||||
ftrack_id = asset_data.get("ftrackId")
|
||||
parent_id = asset_data.get("visualParent")
|
||||
asset_docs_by_parent_id[parent_id].append(asset_doc)
|
||||
if ftrack_id:
|
||||
asset_docs_by_ftrack_id[ftrack_id] = asset_doc
|
||||
|
||||
missing_doc_ftrack_ids = {}
|
||||
all_tasks_ids = set()
|
||||
task_names_by_ftrack_id = collections.defaultdict(list)
|
||||
for other_entity in other_entities:
|
||||
ftrack_id = other_entity["id"]
|
||||
if ftrack_id not in asset_docs_by_ftrack_id:
|
||||
missing_doc_ftrack_ids[ftrack_id] = None
|
||||
continue
|
||||
all_tasks_ids.add(ftrack_id)
|
||||
task_names_by_ftrack_id[ftrack_id] = all_tasks
|
||||
|
||||
for task_entity in task_entities:
|
||||
parent_id = task_entity["parent_id"]
|
||||
if parent_id not in asset_docs_by_ftrack_id:
|
||||
missing_doc_ftrack_ids[parent_id] = None
|
||||
continue
|
||||
|
||||
if all_tasks_ids not in all_tasks_ids:
|
||||
task_names_by_ftrack_id[ftrack_id].append(task_entity["name"])
|
||||
|
||||
ftrack_ids = set()
|
||||
asset_doc_with_task_names_by_id = {}
|
||||
for ftrack_id, task_names in task_names_by_ftrack_id.items():
|
||||
asset_doc = asset_docs_by_ftrack_id[ftrack_id]
|
||||
asset_data = asset_doc["data"]
|
||||
asset_tasks = asset_data.get("tasks") or {}
|
||||
|
||||
if task_names is all_tasks:
|
||||
task_names = list(asset_tasks.keys())
|
||||
else:
|
||||
new_task_names = []
|
||||
for task_name in task_names:
|
||||
if task_name in asset_tasks:
|
||||
new_task_names.append(task_name)
|
||||
continue
|
||||
|
||||
if ftrack_id not in missing_doc_ftrack_ids:
|
||||
missing_doc_ftrack_ids[ftrack_id] = []
|
||||
if missing_doc_ftrack_ids[ftrack_id] is not None:
|
||||
missing_doc_ftrack_ids[ftrack_id].append(task_name)
|
||||
|
||||
task_names = new_task_names
|
||||
|
||||
if task_names:
|
||||
ftrack_ids.add(ftrack_id)
|
||||
asset_doc_with_task_names_by_id[ftrack_id] = (
|
||||
asset_doc, task_names
|
||||
)
|
||||
|
||||
task_entities = session.query((
|
||||
"select id, name, parent_id from Task where parent_id in ({})"
|
||||
).format(self.join_query_keys(ftrack_ids))).all()
|
||||
task_entitiy_by_parent_id = collections.defaultdict(list)
|
||||
for task_entity in task_entities:
|
||||
parent_id = task_entity["parent_id"]
|
||||
task_entitiy_by_parent_id[parent_id].append(task_entity)
|
||||
|
||||
output = []
|
||||
for ftrack_id, item in asset_doc_with_task_names_by_id.items():
|
||||
asset_doc, task_names = item
|
||||
valid_task_entities = []
|
||||
for task_entity in task_entitiy_by_parent_id[ftrack_id]:
|
||||
if task_entity["name"] in task_names:
|
||||
valid_task_entities.append(task_entity)
|
||||
else:
|
||||
if ftrack_id not in missing_doc_ftrack_ids:
|
||||
missing_doc_ftrack_ids[ftrack_id] = []
|
||||
if missing_doc_ftrack_ids[ftrack_id] is not None:
|
||||
missing_doc_ftrack_ids[ftrack_id].append(task_name)
|
||||
if valid_task_entities:
|
||||
output.append((asset_doc, valid_task_entities))
|
||||
|
||||
# Store report information about not synchronized entities
|
||||
if missing_doc_ftrack_ids:
|
||||
missing_entities = session.query(
|
||||
"select id, link from TypedContext where id in ({})".format(
|
||||
self.join_query_keys(missing_doc_ftrack_ids.keys())
|
||||
)
|
||||
).all()
|
||||
for missing_entity in missing_entities:
|
||||
path = self._get_entity_path(missing_entity)
|
||||
task_names = missing_doc_ftrack_ids[missing_entity["id"]]
|
||||
if task_names is None:
|
||||
report[NOT_SYNCHRONIZED_TITLE].append(path)
|
||||
else:
|
||||
for task_name in task_names:
|
||||
task_path = "/".join([path, task_name])
|
||||
report[NOT_SYNCHRONIZED_TITLE].append(task_path)
|
||||
|
||||
return output
|
||||
|
||||
|
||||
def register(session):
|
||||
FillWorkfileAttributeAction(session).register()
|
||||
|
|
@ -193,6 +193,11 @@
|
|||
"Administrator"
|
||||
]
|
||||
},
|
||||
"fill_workfile_attribute": {
|
||||
"enabled": false,
|
||||
"custom_attribute_key": "",
|
||||
"role_list": []
|
||||
},
|
||||
"seed_project": {
|
||||
"enabled": true,
|
||||
"role_list": [
|
||||
|
|
|
|||
|
|
@ -589,6 +589,34 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "dict",
|
||||
"key": "fill_workfile_attribute",
|
||||
"label": "Fill workfile Custom attribute",
|
||||
"checkbox_key": "enabled",
|
||||
"children": [
|
||||
{
|
||||
"type": "boolean",
|
||||
"key": "enabled",
|
||||
"label": "Enabled"
|
||||
},
|
||||
{
|
||||
"type": "label",
|
||||
"label": "Custom attribute must be <b>Text</b> type added to <b>Task</b> entity type"
|
||||
},
|
||||
{
|
||||
"type": "text",
|
||||
"key": "custom_attribute_key",
|
||||
"label": "Custom attribute key"
|
||||
},
|
||||
{
|
||||
"type": "list",
|
||||
"key": "role_list",
|
||||
"label": "Roles",
|
||||
"object_type": "text"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "dict",
|
||||
"key": "seed_project",
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ from openpype.lib import (
|
|||
save_workfile_data_to_doc,
|
||||
get_workfile_template_key,
|
||||
create_workdir_extra_folders,
|
||||
get_system_general_anatomy_data
|
||||
get_workdir_data
|
||||
)
|
||||
from openpype.lib.avalon_context import (
|
||||
update_current_task,
|
||||
|
|
@ -48,6 +48,7 @@ def build_workfile_data(session):
|
|||
# Set work file data for template formatting
|
||||
asset_name = session["AVALON_ASSET"]
|
||||
task_name = session["AVALON_TASK"]
|
||||
host_name = session["AVALON_APP"]
|
||||
project_doc = io.find_one(
|
||||
{"type": "project"},
|
||||
{
|
||||
|
|
@ -63,42 +64,17 @@ def build_workfile_data(session):
|
|||
"name": asset_name
|
||||
},
|
||||
{
|
||||
"name": True,
|
||||
"data.tasks": True,
|
||||
"data.parents": True
|
||||
}
|
||||
)
|
||||
|
||||
task_type = asset_doc["data"]["tasks"].get(task_name, {}).get("type")
|
||||
|
||||
project_task_types = project_doc["config"]["tasks"]
|
||||
task_short = project_task_types.get(task_type, {}).get("short_name")
|
||||
|
||||
asset_parents = asset_doc["data"]["parents"]
|
||||
parent_name = project_doc["name"]
|
||||
if asset_parents:
|
||||
parent_name = asset_parents[-1]
|
||||
|
||||
data = {
|
||||
"project": {
|
||||
"name": project_doc["name"],
|
||||
"code": project_doc["data"].get("code")
|
||||
},
|
||||
"asset": asset_name,
|
||||
"task": {
|
||||
"name": task_name,
|
||||
"type": task_type,
|
||||
"short": task_short,
|
||||
},
|
||||
"parent": parent_name,
|
||||
data = get_workdir_data(project_doc, asset_doc, task_name, host_name)
|
||||
data.update({
|
||||
"version": 1,
|
||||
"user": getpass.getuser(),
|
||||
"comment": "",
|
||||
"ext": None
|
||||
}
|
||||
|
||||
# add system general settings anatomy data
|
||||
system_general_data = get_system_general_anatomy_data()
|
||||
data.update(system_general_data)
|
||||
})
|
||||
|
||||
return data
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue