How can I define the permissions for folders that Toolkit creates?

philip.scadding · July 23, 2019, 1:53pm

The creation process for folders that get generated by the Toolkit schema, can be customized in the process_folder_creation.py core hook:

github.com

shotgunsoftware/tk-core/blob/master/hooks/process_folder_creation.py#L121


for i in items:


    action = i.get("action")


    if action in ["entity_folder", "folder"]:
        # folder creation
        path = i.get("path")
        if not os.path.exists(path):
            if not preview_mode:
                # create the folder using open permissions
                os.makedirs(path, 0777)
            locations.append(path)


    elif action == "remote_entity_folder":
        # Remote folder creation
        #
        # NOTE! This action happens when another user has created
        # a folder on their machine and we are syncing our local path
        # cache to be aware of this folder's existance.
        #
        # For a traditional setup, where the project storage is shared,

To modify the hook you would copy the hook from the .../install/core/hooks folder over to your .../config/core/hooks folder and then modify it there. Or if you’re on a distributed config then you could take a copy from the GitHub repository or your bundle cache.

For all other folders that get created by Toolkit, such as folders that are defined in templates but not in the schema, you can use the ensure_folder_exists.py core hook:

github.com

shotgunsoftware/tk-core/blob/v0.18.167/hooks/ensure_folder_exists.py#L40




The default implementation creates these folders with read/write
permissions for everyone.


:param str path: path to create
:param bundle_object: Object requesting the creation. This is a legacy
                      parameter and we recommend using self.parent instead.
:type bundle_object: :class:`~sgtk.platform.Engine`, :class:`~sgtk.platform.Framework`
    or :class:`~sgtk.platform.Application`
"""
filesystem.ensure_folder_exists(path, permissions=0777)