api

class PhotoshopHost(HostBase, IWorkfileHost, ILoadHost, IPublishHost):
    name = "photoshop"
    workfile_extensions = [".psd", ".psb"]

    def install(self):
        """Install Photoshop-specific functionality needed for integration.

        This function is called automatically on calling
        `api.install(photoshop)`.
        """
        log.info("Installing OpenPype Photoshop...")
        pyblish.api.register_host("photoshop")

        pyblish.api.register_plugin_path(PUBLISH_PATH)
        register_loader_plugin_path(LOAD_PATH)
        register_creator_plugin_path(CREATE_PATH)

        register_event_callback("application.launched", on_application_launch)
        self._set_default_workfile_extension()

    def _set_default_workfile_extension(self) -> None:
        """Get the default workfile extension for the current project."""

        project_name = self.get_current_project_name()
        settings = get_project_settings(project_name)
        default_workfile_extension = settings["photoshop"]["default_workfile_extension"]
        if self.workfile_extensions[0] != default_workfile_extension:
            self.workfile_extensions.remove(default_workfile_extension)
            self.workfile_extensions.insert(0, default_workfile_extension)

    def work_root(self, session):
        return os.path.normpath(session["AYON_WORKDIR"]).replace("\\", "/")

    def open_workfile(self, filepath):
        lib.stub().open(filepath)
        return True

    def save_workfile(self, filepath=None):
        _, ext = os.path.splitext(filepath)
        lib.stub().saveAs(filepath, ext.lstrip("."), False)

    def get_current_workfile(self):
        try:
            full_name = lib.stub().get_active_document_full_name()
            if full_name and full_name != "null":
                return os.path.normpath(full_name).replace("\\", "/")
        except Exception:
            pass

        return None

    def workfile_has_unsaved_changes(self):
        if self.get_current_workfile():
            return not lib.stub().is_saved()

        return False

    def get_workfile_extensions(self):
        return self.workfile_extensions

    def get_containers(self):
        return ls()

    def _get_doc_context_metadata(self):
        """Read project/folder/task stored in the active documen.

        Returns:
            dict: With keys 'project_name'/'folder_path'/'task_name' if the
                active document was stamped with a context, empty dict
                otherwise (no active document, or never stamped yet).
        """
        stub = _get_stub()
        if stub is None:
            return {}

        try:
            layers_meta = stub.get_layers_metadata()
        except Exception:
            log.warning(
                "Failed to read doc-context metadata", exc_info=True
            )
            return {}

        for item in layers_meta:
            if item.get("id") == DOC_CONTEXT_METADATA_ID:
                return item

        return {}

    def get_current_project_name(self):
        context = self.get_current_context()
        return context["project_name"]

    def get_current_folder_path(self):
        context = self.get_current_context()
        return context["folder_path"]

    def get_current_task_name(self):
        context = self.get_current_context()
        return context["task_name"]

    def get_current_context(self):
        doc_context = self._get_doc_context_metadata()
        project_name = doc_context.get("project_name")
        if project_name:
            return {
                "project_name": project_name,
                "folder_path": doc_context["folder_path"],
                "task_name": doc_context["task_name"],
            }
        # Older workfiles might not have stored the context
        # - can happen if workfile was not opened using
        #   AYON workfile api
        return {
            "project_name": os.environ.get("AYON_PROJECT_NAME"),
            "folder_path": os.environ.get("AYON_FOLDER_PATH"),
            "task_name": os.environ.get("AYON_TASK_NAME"),
        }

    def set_active_document_context(
        self,
        project_name: str,
        folder_path: str,
        task_name: str,
    ) -> None:
        """Persist project/folder/task into the active document's metadata.

        This is the single place writing DOC_CONTEXT_METADATA_ID — the
        source of truth read back by get_current_context() for whichever
        document happens to be active — kept separate from ayon-core's
        'publish_context'.

        Args:
            only_if_unstamped (bool): When True, never overwrite an
                existing stamp — only write one if the active document
                has none yet.
        """
        stub = _get_stub()
        if stub is None:
            return

        items = [
            item
            for item in stub.get_layers_metadata()
            if item.get("id") != DOC_CONTEXT_METADATA_ID
        ]
        doc_context = {
            "id": DOC_CONTEXT_METADATA_ID,
            "project_name": project_name,
            "folder_path": folder_path,
            "task_name": task_name,
        }
        stub.imprint(doc_context["id"], doc_context, items_meta=items)

    def _set_current_context(self, context_change_data):
        """Store the new context directly on the active document.

        Skipped for workfile_open: at this point the target workfile has
        not been opened yet, so the active document is still the
        previous one — stamping here would corrupt it. _after_workfile_open
        handles that case once the new document is actually active.
        """
        if context_change_data.reason == ContextChangeReason.workfile_open:
            return

        self.set_active_document_context(
            context_change_data.project_entity["name"],
            context_change_data.folder_entity["path"],
            context_change_data.task_entity["name"],
        )

    def _after_workfile_open(self, open_workfile_context):
        """Stamp context onto the document once it is actually active."""
        self.set_active_document_context(
            open_workfile_context.project_entity["name"],
            open_workfile_context.folder_entity["path"],
            open_workfile_context.task_entity["name"],
        )

    def _before_workfile_save(self, save_workfile_context):
        """Stamp context onto the document before it is saved."""
        self.set_active_document_context(
            save_workfile_context.project_entity["name"],
            save_workfile_context.folder_entity["path"],
            save_workfile_context.task_entity["name"],
        )

    def store_global_context_to_active_document(self):
        """Stamp the current global (env-based) context onto the active
        document.

        Used for the very first document opened at Photoshop startup.
        """
        context = super().get_current_context()
        self.set_active_document_context(
            context["project_name"],
            context["folder_path"],
            context["task_name"],
        )

    def get_context_data(self):
        """Get stored values for context (validation enable/disable etc)"""
        meta = _get_stub().get_layers_metadata()
        for item in meta:
            if item.get("id") == "publish_context":
                item.pop("id")
                return item
        return {}

    def update_context_data(self, data, changes):
        """Store value needed for context"""
        item = data
        item["id"] = "publish_context"
        _get_stub().imprint(item["id"], item)

    def list_instances(self):
        """List all created instances to publish from current workfile.

        Pulls from File > File Info

        Returns:
            (list) of dictionaries matching instances format
        """
        stub = _get_stub()

        if not stub:
            return []

        instances = []
        layers_meta = stub.get_layers_metadata()
        if layers_meta:
            for instance in layers_meta:
                if instance.get("id") in {
                    AYON_INSTANCE_ID, AVALON_INSTANCE_ID
                }:
                    instances.append(instance)

        return instances

    def remove_instance(self, instance):
        """Remove instance from current workfile metadata.

        Updates metadata of current file in File > File Info and removes
        icon highlight on group layer.

        Args:
            instance (dict): instance representation from subsetmanager model
        """
        stub = _get_stub()

        if not stub:
            return

        inst_id = instance.get("instance_id") or instance.get("uuid")  # legacy
        if not inst_id:
            log.warning("No instance identifier for {}".format(instance))
            return

        stub.remove_instance(inst_id)

        if instance.get("members"):
            item = stub.get_layer(instance["members"][0])
            if item:
                stub.rename_layer(item.id,
                                  item.name.replace(stub.PUBLISH_ICON, ''))