engine.py

# Copyright (c) 2016 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

from __future__ import print_function
import sgtk
import nuke
import os
import nukescripts
import logging


class NukeEngine(sgtk.platform.Engine):
    """
    An engine that supports Nuke 6.3v5+, Hiero 9.0+, and Nuke Studio 9.0+

    **Bootstrap Flow**

    The code path for the bootstrap routine for Nuke, Nuke Studio, and Hiero is quite
    complex due to the support of all three modes of the application.

    - All three Nuke modes make use of the "generic" bootstrap routine in
      tk-multi-launchapp. There is still Nuke- and Hiero-specific logic in
      that app, but it is there for the sake of backwards compatibility
      should someone still be using the tk-hiero engine or an old version
      of tk-nuke.

    - There are, in essence, two code paths for the bootstrap: Nuke in one and
      Hiero/Nuke Studio in the other. Nuke Studio acts much more like Hiero than it
      does Nuke, and as such shares many similarities when it comes to the bootstrap
      process.

    Step 1:
        The tk-multi-launchapp app will go into its "generic" bootstrap routine and
        will look in the engine structure for `tk-nuke/python/startup/bootstrap.py`.
        This is the first block of logic that will be executed, regardless of whether
        it is Nuke, Nuke Studio, or Hiero that is being launched. This logic handles
        setting either the NUKE_PATH or HIERO_PLUGIN_PATH environment variables,
        depending on which mode is being launched.

    Step 2:
        With the appropriate path variable set in #1, the `tk-nuke/python/startup`
        directory is now available to Nuke at launch as a location to look for both
        `init.py` and `menu.py` scripts to be run on launch. It's worth noting that
        the order of operations for Nuke (regardless of mode) is to execute init.py
        first, before the GUI is loaded, and menu.py later after most of the Nuke
        application is up and running and any file loads have completed.

    Step 3:
        Startup of the DCC application is under way at this point. If Nuke is launching
        in a no-UI mode, then the `init.py` is responsible for continuing the bootstrap,
        otherwise `tk-nuke/python/startup/menu.py` is in charge. In either case, the
        `tk-nuke/python/startup` directory is added to `sys.path` and its `sgtk_startup.py`
        module is loaded, which executes its own `bootstrap_sgtk()` function.

    Step 4:
        The `bootstrap_sgtk()` function handles initializing PTR and starting up
        the tk-nuke engine.

    .. NOTE:: There is also an addition made to the `NUKE_PATH` environment variable
              in the engine initialization routine here in `engine.py`. This adds the
              root-level `tk-nuke/startup` directory, which contains a `menu.py` that
              is utilized during script load in the Nuke mode of the DCC. This is needed
              because the bootstrap routine outlined in the steps above only occurs at
              launch time, but NOT on script open. This is an important distinction, because
              each file open operation Nuke performs spawns a new process, which itself needs
              to then have the engine's `tk-nuke/python` directory added to `sys.path`.

    **Nuke Event Callbacks**

    During the bootstrap process described above, event callbacks are registered with
    Nuke. The events of interest are OnScriptLoad and OnScriptSave. Interest is registered
    in these events in `tk-nuke/python/tk_nuke/__init__.py`, which is also where the
    callbacks themselves are defined.
    """

    # Define the different areas where menu events can occur in Hiero.
    (HIERO_BIN_AREA, HIERO_SPREADSHEET_AREA, HIERO_TIMELINE_AREA) = range(3)

    def __init__(self, *args, **kwargs):
        # For the short term, we will treat Nuke Studio as if it
        # is Hiero. This logic will change once we have true Nuke
        # Studio support for this engine.
        self._hiero_enabled = nuke.env.get("hiero")
        self._studio_enabled = nuke.env.get("studio")
        self._ui_enabled = nuke.env.get("gui")
        self._context_switcher = None
        self._menu_generator = None
        self._context_change_menu_rebuild = True
        self._processed_paths = []
        self._processed_environments = []
        self._previous_generators = []

        super(NukeEngine, self).__init__(*args, **kwargs)

    #####################################################################################
    # Properties

    @property
    def has_ui(self):
        """
        Whether Nuke is running as a GUI/interactive session.
        """
        return self._ui_enabled

    @property
    def hiero_enabled(self):
        """
        Whether Nuke is running in Hiero mode.
        """
        return self._hiero_enabled

    @property
    def studio_enabled(self):
        """
        Whether Nuke is running in Studio mode.
        """
        return self._studio_enabled

    @property
    def context_change_allowed(self):
        """
        Whether the engine allows a context change without the need for a restart.
        """
        return True

    @property
    def menu_generator(self):
        return self._menu_generator

    @property
    def in_plugin_mode(self):
        """
        Indicates if we are running one of the builtin plugins.
        """
        return True if self.get_setting("launch_builtin_plugins") else False

    #####################################################################################
    # Engine Initialization and Destruction

    def pre_app_init(self):
        """
        Sets up the engine into an operational state. This method called before
        any apps are loaded.
        """

        self.logger.debug("%s: Initializing...", self)

        MAX_VERSION = (15, 1)  # untested above this so display a warning

        import tk_nuke

        tk_nuke.tank_ensure_callbacks_registered(engine=self)

        # We need to check to make sure that we are using one of the
        # supported versions of Nuke. Right now that is anything between
        # 6.3v5 and 9.0v*. For versions higher than what we know we
        # support we'll simply warn and continue. For older versions
        # we will have to bail out, as we know they won't work properly.
        nuke_version = (
            nuke.env.get("NukeVersionMajor"),
            nuke.env.get("NukeVersionMinor"),
            nuke.env.get("NukeVersionRelease"),
        )

        msg = "Nuke 7.0v10 is the minimum version supported!"
        if nuke_version[0] < 7:
            self.logger.error(msg)
            return
        elif nuke_version[0] == 7 and nuke_version[1] == 0 and nuke_version[2] < 10:
            self.logger.error(msg)
            return

        # Versions > 14.0 have not yet been tested so show a message to that effect.
        if nuke_version[0] > MAX_VERSION[0] or (
            nuke_version[0] == MAX_VERSION[0] and nuke_version[1] > MAX_VERSION[1]
        ):
            # This is an untested version of Nuke.
            msg = (
                "The Flow Production Tracking has not yet been fully tested "
                "with Nuke %d.%dv%d. You can continue to use the Toolkit but you may "
                "experience bugs or instability. Please report any issues to our support "
                "team via %s"
                % (nuke_version[0], nuke_version[1], nuke_version[2], sgtk.support_url)
            )

            # Show nuke message if in UI mode, this is the first time the engine has been started
            # and the warning dialog isn't overridden by the config. Note that nuke.message isn't
            # available in Hiero, so we have to skip this there.
            if (
                self.has_ui
                and "TANK_NUKE_ENGINE_INIT_NAME" not in os.environ
                and nuke_version[0]
                >= self.get_setting("compatibility_dialog_min_version", 11)
                and not self.hiero_enabled
            ):
                nuke.message("Warning - Flow Production Tracking!\n\n%s" % msg)

            # Log the warning.
            self.logger.warning(msg)

        # Make sure we are not running Nuke PLE or Non-Commercial!
        if nuke.env.get("ple"):
            self.logger.error("The Nuke Engine does not work with Nuke PLE!")
            return
        elif nuke.env.get("nc"):
            self.logger.error("The Nuke Engine does not work with Nuke Non-Commercial!")
            return

        # Now check that we are at least in a project context. Note that plugin mode
        # does not require this check since it can operate at the site level.
        if not self.in_plugin_mode and self.context.project is None:
            # Must have at least a project in the context to even start!
            raise sgtk.TankError(
                "The nuke engine needs at least a project "
                "in the context in order to start! Your "
                "context: %s" % self.context
            )

        # Figure out what our menu will be named.
        self._menu_name = "Flow Production Tracking"
        if self.get_setting("use_short_menu_name", False):
            self._menu_name = "FPTR"

        # Do our mode-specific initializations.
        if self.hiero_enabled:
            self.pre_app_init_hiero()
        elif self.studio_enabled:
            self.pre_app_init_studio()
        else:
            self.pre_app_init_nuke()

    def pre_app_init_studio(self):
        """
        The Nuke Studio specific portion of engine initialization.
        """
        self.pre_app_init_hiero()

    def pre_app_init_hiero(self):
        """
        The Hiero-specific portion of engine initialization.
        """
        self._last_clicked_selection = []
        self._last_clicked_area = None

    def pre_app_init_nuke(self):
        """
        The Nuke-specific portion of engine initialization.
        """
        # Now prepare sgtk so that it will be picked up by any new processes
        # created by file->new or file->open.
        # Store data needed for bootstrapping Sgtk in env vars.
        # Used in classic_startup/sgtk_startup.py, and plugins/basic/Python/tk_nuke_basic/plugin_bootstrap.py
        os.environ["TANK_ENGINE"] = self.instance_name
        os.environ["TANK_CONTEXT"] = sgtk.context.serialize(self.context)

        """
        https://jira.autodesk.com/browse/SG-25374
        Weblogin does not show up in Nuke 11 and makes Nuke 12 and 13 to crash

        To avoid Nuke crash, a monkeypatch of on_dialog_closed is required,
        here the user is warned about restarted nuke is needed to continue.
        """
        sgtk.authentication.sso_saml2.core.sso_saml2_core.SsoSaml2Core.on_dialog_closed = (
            self._on_dialog_closed_monkeypatch
        )

    @staticmethod
    def _on_dialog_closed_monkeypatch(self, result):
        """
        Called whenever the dialog is dismissed.

        This can be the result of a callback, a timeout or user interaction.

        :param result: Qt result following the closing of the dialog.
                       QtGui.QDialog.Accepted or QtGui.QDialog.Rejected
        """
        self._logger.debug("SSO dialog closed")
        # pylint: disable=invalid-name
        QtGui = self._QtGui  # noqa

        if self.is_handling_event():
            if result == QtGui.QDialog.Rejected and self._session.cookies != "":
                # We got here because of a timeout attempting a GUI-less login.
                # Let's clear the cookies, and force the use of the GUI.
                self._session.cookies = ""
                # Let's have another go, without any cookies this time !
                # This will force the GUI to be shown to the user.
                self._logger.debug(
                    "Unable to login/renew claims automatically, presenting GUI "
                    "to user"
                )
                """
                https://jira.autodesk.com/browse/SG-25374
                Weblogin does not show up in Nuke 11 and makes Nuke 12 and
                13 to crash
                """
                base_dir = os.path.dirname(os.path.abspath(__file__))

                msgbox_icon = os.path.join(base_dir, "resources", "alert_icon.png")
                msgbox_parent = self._dialog
                msgbox_title = "Nuke"
                msgbox_text = [
                    "The Flow Production Tracking user session has expired.",
                    "To continue using Flow Production Tracking in Nuke, please "
                    "restart Nuke.",
                ]
                msgbox_buttons = self._QtGui.QMessageBox.Ok

                msgbox = self._QtGui.QMessageBox(msgbox_parent)
                msgbox.setWindowTitle(msgbox_title)
                msgbox.setText("\n\n".join(msgbox_text))
                msgbox.setStandardButtons(msgbox_buttons)
                msgbox.setIconPixmap(self._QtGui.QPixmap(msgbox_icon))
                msgbox.activateWindow()  # for Windows
                msgbox.raise_()  # for MacOS
                msgbox.exec_()

                status = QtGui.QDialog.Rejected
                self._logger.warn("Skipping web login dialog for Nuke DCC.")
                self._login_status = self._login_status or status
            else:
                self.resolve_event()
        else:
            # Should we get a rejected dialog, then we have had a timeout.
            if result == QtGui.QDialog.Rejected:
                # @FIXME: Figure out exactly what to do when we have a timeout.
                self._logger.warn(
                    "Our QDialog got canceled outside of an event handling"
                )

        # Clear the web page
        self._view.page().mainFrame().load("about:blank")

    def post_app_init(self):
        """
        Called when all apps have initialized.
        """

        # We have some mode-specific initialization to do.
        if self.hiero_enabled:
            self.post_app_init_hiero()
        elif self.studio_enabled:
            self.post_app_init_studio()

            # We want to run the Nuke init, as well, to load up
            # any gizmos, but we don't want it to be part of the
            # post_app_init_studio method, since we'll also need
            # to call just the gizmo stuff on context changes and
            # not the other Nuke Studio-related init stuff.
            self.post_app_init_nuke()
        else:
            self.post_app_init_nuke()

    def post_app_init_studio(self):
        """
        The Nuke Studio specific portion of the engine's post-init process.
        """
        if self.has_ui:
            # Note! not using the import as this confuses Nuke's callback system
            # (several of the key scene callbacks are in the main init file).
            import tk_nuke
            import hiero
            from hiero.core import env as hiero_env

            # Create the menu!
            self._menu_generator = tk_nuke.NukeStudioMenuGenerator(
                self, self._menu_name
            )
            self._menu_generator.create_menu()

            # No context switching in plugin mode.
            if self.in_plugin_mode:
                self._context_switcher = tk_nuke.PluginStudioContextSwitcher(self)
            else:
                hiero.core.events.registerInterest(
                    "kAfterNewProjectCreated",
                    self.set_project_root,
                )

                hiero.core.events.registerInterest(
                    "kAfterProjectLoad",
                    self._on_project_load_callback,
                )

                self._context_switcher = tk_nuke.ClassicStudioContextSwitcher(self)
                # On selection change we have to check what was selected and pre-load
                # the context if that environment (ie: shot_step) hasn't already been
                # processed. This ensure that all Nuke gizmos for the target environment
                # will be available.
                hiero.core.events.registerInterest(
                    "kSelectionChanged",
                    self._handle_studio_selection_change,
                )

    def log_user_attribute_metric(self, name, value):
        """
        This method is deprecated and shouldn't be used anymore
        """
        pass

    def post_app_init_hiero(self):
        """
        The Hiero-specific portion of the engine's post-init process.
        """
        if self.has_ui:
            # Note! not using the import as this confuses Nuke's callback system
            # (several of the key scene callbacks are in the main init file).
            import tk_nuke
            import hiero
            from hiero.core import env as hiero_env

            # Create the menu!
            self._menu_generator = tk_nuke.HieroMenuGenerator(self, self._menu_name)
            self._menu_generator.create_menu()

            hiero.core.events.registerInterest(
                "kAfterNewProjectCreated",
                self.set_project_root,
            )

            hiero.core.events.registerInterest(
                "kAfterProjectLoad",
                self._on_project_load_callback,
            )

    def post_app_init_nuke(self):
        """
        The Nuke-specific portion of the engine's post-init process.
        """

        if self.has_ui and not self.studio_enabled:
            # Note! not using the import as this confuses Nuke's callback system
            # (several of the key scene callbacks are in the main init file).
            import tk_nuke

            # Create the menu!
            #
            # We keep a reference to any previous menu generators that have
            # existed. This is to prevent a crash on close in Nuke 11 that occurs
            # after a context change is triggered.
            self._previous_generators.append(self._menu_generator)
            self._menu_generator = tk_nuke.NukeMenuGenerator(self, self._menu_name)
            self._menu_generator.create_menu()

            # Initialize favourite dirs in the file open/file save dialogs
            self.__setup_favorite_dirs()

            # Register all panels with nuke's callback system
            # this will be used at nuke startup in order
            # for nuke to be able to restore panels
            # automatically. For all panels that exist as
            # part of saved layouts, nuke will look through
            # a global list of registered panels, try to locate
            # the one it needs and then run the callback.
            for panel_id, panel_dict in self.panels.items():
                nukescripts.panels.registerPanel(
                    panel_id,
                    panel_dict["callback"],
                )

        # Iterate over all apps, if there is a gizmo folder, add it to nuke path.
        for app in self.apps.values():
            # Add gizmos to nuke path.
            app_gizmo_folder = os.path.join(app.disk_location, "gizmos")
            if os.path.exists(app_gizmo_folder):
                # Now translate the path so that nuke is happy on Windows.
                app_gizmo_folder = app_gizmo_folder.replace(os.path.sep, "/")
                self.logger.debug(
                    "Gizmos found - Adding %s to nuke.pluginAddPath() and NUKE_PATH",
                    app_gizmo_folder,
                )
                nuke.pluginAddPath(app_gizmo_folder)
                # And also add it to the plugin path - this is so that any
                # new processes spawned from this one will have access too.
                # (for example if you do file->open or file->new)
                sgtk.util.append_path_to_env_var("NUKE_PATH", app_gizmo_folder)

        # Nuke Studio 9 really doesn't like us running commands at startup, so don't.
        if not (nuke.env.get("NukeVersionMajor") == 9 and nuke.env.get("studio")):
            self._run_commands_at_startup()

    @property
    def host_info(self):
        """
        :returns: A {"name": application name, "version": application version}
                  dictionary with informations about the application hosting this
                  engine.
        """
        app_name = "Nuke"
        version = ""
        try:
            if self.studio_enabled:
                app_name = "Nuke Studio"
                from hiero.core import env as hiero_env

                # VersionRelease is something like "v8", so we don't put a '.'
                # between it and VersionMinor
                version = "%s.%s%s" % (
                    hiero_env["VersionMajor"],
                    hiero_env["VersionMinor"],
                    hiero_env["VersionRelease"],
                )
            elif self.hiero_enabled:
                from hiero.core import env as hiero_env

                # VersionString is something like 'Hiero 10.5v1', it seems safer to
                # deal with the app name and version more explicitly
                app_name = hiero_env["ApplicationName"]
                # VersionRelease is something like "v8", so we don't put a '.'
                # between it and VersionMinor
                version = "%s.%s%s" % (
                    hiero_env["VersionMajor"],
                    hiero_env["VersionMinor"],
                    hiero_env["VersionRelease"],
                )
            else:
                # Check which Nuke favor we're running. No need to check for PLE or
                # non-commercial: the engine does not support them.
                if nuke.env["nukex"]:
                    app_name = "NukeX"
                elif nuke.env["assist"]:
                    app_name = "Nuke Assist"
                version = nuke.env["NukeVersionString"]
        except Exception:
            # If we couldn't figure out the version, it's likely an old version
            # of Nuke we're in (pre-10.0). We don't want that to let us stop the
            # the integration from working properly, so we just return an empty
            # string for the version in this situation.
            pass

        return {"name": app_name, "version": version}

    def _run_commands_at_startup(self):
        # Build a dictionary mapping app instance names to dictionaries of commands they registered with the engine.
        app_instance_commands = {}
        for command_name, value in self.commands.items():
            app_instance = value["properties"].get("app")
            if app_instance:
                # Add entry 'command name: command function' to the command dictionary of this app instance.
                command_dict = app_instance_commands.setdefault(
                    app_instance.instance_name, {}
                )
                command_dict[command_name] = value["callback"]

        commands_to_run = []
        # Run the series of app instance commands listed in the 'run_at_startup' setting.
        for app_setting_dict in self.get_setting("run_at_startup", []):
            app_instance_name = app_setting_dict["app_instance"]
            # Menu name of the command to run or '' to run all commands of the given app instance.
            setting_command_name = app_setting_dict["name"]

            # Retrieve the command dictionary of the given app instance.
            command_dict = app_instance_commands.get(app_instance_name)

            if command_dict is None:
                self.logger.warning(
                    "%s configuration setting 'run_at_startup' requests app '%s' that is not installed.",
                    self.name,
                    app_instance_name,
                )
            else:
                if not setting_command_name:
                    # Run all commands of the given app instance.
                    for command_name, command_function in command_dict.items():
                        self.logger.debug(
                            "%s startup running app '%s' command '%s'.",
                            self.name,
                            app_instance_name,
                            command_name,
                        )
                        commands_to_run.append(command_function)
                else:
                    # Run the command whose name is listed in the 'run_at_startup' setting.
                    command_function = command_dict.get(setting_command_name)
                    if command_function:
                        self.logger.debug(
                            "%s startup running app '%s' command '%s'.",
                            self.name,
                            app_instance_name,
                            setting_command_name,
                        )
                        commands_to_run.append(command_function)
                    else:
                        known_commands = ", ".join(
                            "'%s'" % name for name in command_dict
                        )
                        self.logger.warning(
                            "%s configuration setting 'run_at_startup' requests app '%s' unknown command '%s'. "
                            "Known commands: %s",
                            self.name,
                            app_instance_name,
                            setting_command_name,
                            known_commands,
                        )

        # Run the commands once Nuke will have completed its UI update and be idle
        # in order to run it after the ones that restore the persisted Shotgun app panels.
        # Set the _callback_from_non_pane_menu hint so that the show_panel method knows this
        # was invoked not from the pane menu.

        def run_at_startup():
            # FIXME: This pattern is horrible.
            sgtk._callback_from_non_pane_menu = True
            try:
                for command in commands_to_run:
                    command()
            finally:
                delattr(sgtk, "_callback_from_non_pane_menu")

        # We used to call this loop above directly here, but in Nuke 11
        # it is causing a deadlock whenever an app calls
        # engine.async_execute_in_main_thread from a background thread.
        # The theory is that the main thread is locked up by Nuke in a
        # way that prevents Toolkit to queue new events. Instead, we'll queue
        # the launch of the apps until the main thread has finished executing
        # current events.
        sgtk.platform.qt.QtCore.QTimer.singleShot(0, run_at_startup)

    def destroy_engine(self):
        """
        Runs when the engine is unloaded, typically at context switch.
        """
        self.logger.debug("%s: Destroying...", self)

        if self._context_switcher:
            self._context_switcher.destroy()

        if self.has_ui:
            self._menu_generator.destroy_menu()

        if self.hiero_enabled or self.studio_enabled:
            import hiero.core

            hiero.core.events.unregisterInterest(
                "kAfterNewProjectCreated",
                self.set_project_root,
            )
            hiero.core.events.unregisterInterest(
                "kAfterProjectLoad",
                self._on_project_load_callback,
            )

            if self.studio_enabled:
                hiero.core.events.unregisterInterest(
                    "kSelectionChanged",
                    self._handle_studio_selection_change,
                )

    def post_context_change(self, old_context, new_context):
        """
        Handles post-context-change requirements for Nuke, Hiero, and Nuke Studio.

        :param old_context: The sgtk.context.Context being switched away from.
        :param new_context: The sgtk.context.Context being switched to.
        """
        # As we've changed contexts, we should update our environment variables so that if we spawn a new nuke instance
        # it will start up in the same environment.
        self.pre_app_init_nuke()

        # Make sure the callbacks are updated based one the current environment settings.
        # (for example they may be enabled or disabled in the new environment.)
        import tk_nuke

        tk_nuke.tank_ensure_callbacks_registered(engine=self)

        self.logger.debug("tk-nuke context changed to %s", str(new_context))

        # We also need to run the post init for Nuke, which will handle
        # getting any gizmos setup.
        if not self.hiero_enabled:
            self.post_app_init_nuke()

        if self.has_ui and self._context_change_menu_rebuild:
            self.menu_generator.create_menu()

    #####################################################################################
    # Logging

    def _emit_log_message(self, handler, record):
        """
        Emits a log to Nuke's Script Editor and Error Console.

        :param handler: Log handler that this message was dispatched from
        :type handler: :class:`~python.logging.LogHandler`
        :param record: Std python logging record
        :type record: :class:`~python.logging.LogRecord`
        """
        msg = handler.format(record)

        # Sends the message to error console of the DCC
        if self.hiero_enabled:
            import hiero

            existing_log_level = hiero.core.log.logLevel()

            if record.levelno >= logging.ERROR:
                hiero.core.log.error(msg)
            elif record.levelno >= logging.WARNING:
                hiero.core.log.info(msg)
            elif record.levelno >= logging.INFO:
                hiero.core.log.info(msg)
            else:
                hiero.core.log.setLogLevel(hiero.core.log.kDebug)
                hiero.core.log.debug(msg)
                hiero.core.log.setLogLevel(existing_log_level)
        else:
            if record.levelno >= logging.CRITICAL:
                nuke.critical("PTR Critical: %s" % msg)
            elif record.levelno >= logging.ERROR:
                nuke.error("PTR Error: %s" % msg)
            elif record.levelno >= logging.WARNING:
                nuke.warning("PTR Warning: %s" % msg)

        # Sends the message to the script editor.
        self.async_execute_in_main_thread(print, msg)

    #####################################################################################
    # Panel Support

    def show_panel(self, panel_id, title, bundle, widget_class, *args, **kwargs):
        """
        Shows a panel in Nuke. If the panel already exists, the previous panel is swapped out
        and replaced with a new one. In this case, the contents of the panel (e.g. the toolkit app)
        is not destroyed but carried over to the new panel.

        If this is being called from a non-pane menu in Nuke, there isn't a well established logic
        for where the panel should be mounted. In this case, the code will look for suitable
        areas in the UI and try to panel it there, starting by looking for the property pane and
        trying to dock panels next to this.

        :param panel_id: Unique id to associate with the panel - normally this is a string obtained
                         via the register_panel() call.
        :param title: The title of the window
        :param bundle: The app, engine or framework object that is associated with this window
        :param widget_class: The class of the UI to be constructed. This must derive from QWidget.

        Additional parameters specified will be passed through to the widget_class constructor.
        """
        if self.hiero_enabled:
            self.logger.info(
                "Panels are not supported in Hiero. Launching as a dialog..."
            )
            return self.show_dialog(title, bundle, widget_class, *args, **kwargs)

        # Note! Not using the import_module call as this confuses nuke's callback system
        import tk_nuke_qt

        # Create the panel.
        panel_widget = tk_nuke_qt.NukePanelWidget(
            bundle, title, panel_id, widget_class, *args, **kwargs
        )

        self.logger.debug("Showing pane %s - %s from %s", panel_id, title, bundle.name)

        if hasattr(sgtk, "_callback_from_non_pane_menu"):
            self.logger.debug("Looking for a pane.")

            # This global flag is set by the menu callback system
            # to indicate that the click comes from a non-pane context.
            #
            # In this case, we have to figure out where the pane should be shown.
            # Try to parent it next to the properties panel
            # if possible, because this is typically laid out like a classic
            # panel UI - narrow and tall. If not possible, then fall back on other
            # built-in objects and use these to find a location.
            #
            # Note: on Nuke versions prior to 9, a pane is required for the UI to appear.
            built_in_tabs = [
                "Properties.1",  # properties dialog - best choice to parent next to
                "DAG.1",  # node graph, so usually wide not tall
                "DopeSheet.1",  # dope sheet, usually wide, not tall
                "Viewer.1",  # viewer
                "Toolbar.1",  # nodes toolbar
            ]

            existing_pane = None
            for tab_name in built_in_tabs:
                self.logger.debug("Parenting panel - looking for %s tab...", tab_name)
                existing_pane = nuke.getPaneFor(tab_name)
                if existing_pane:
                    break

            if existing_pane is None and nuke.env.get("NukeVersionMajor") < 9:
                # Couldn't find anything to parent next to!
                # Nuke 9 will automatically handle this situation
                # but older versions will not show the UI!
                # Tell the user that they need to have the property
                # pane present in the UI.
                nuke.message(
                    "Cannot find any of the standard Nuke UI panels to anchor against. "
                    "Please add a Properties Bin to your Nuke UI layout and try again."
                )
                return

            self.logger.debug("Pane found: %s", existing_pane)

            # All good - we are running nuke 9 and/or
            # have existing panes to parent against.
            panel_widget.addToPane(existing_pane)
        else:
            self.logger.debug("Adding to established pane.")
            # We are either calling this from a pane restore
            # callback or from the pane menu in Nuke. In both
            # these cases, the current pane is already established
            # by the system, so just add our widget.
            # Add it to the current pane
            panel_widget.addToPane()
        return panel_widget

    #####################################################################################
    # Menu Utilities

    def get_menu_selection(self):
        """
        Returns the list of hiero objects selected in the most recent menu click.
        This list may contain items of various types. To see exactly what is being
        returned by which methods, turn on debug logging - this will print out details
        of what is going on.

        Examples of types that are being returned are:

        Selecting a project in the bin view:
        http://docs.thefoundry.co.uk/hiero/10/hieropythondevguide/api/api_core.html#hiero.core.Bin

        Selecting an item in a bin view:
        http://docs.thefoundry.co.uk/hiero/10/hieropythondevguide/api/api_core.html#hiero.core.BinItem

        Selecting a track:
        http://docs.thefoundry.co.uk/hiero/10/hieropythondevguide/api/api_core.html#hiero.core.TrackItem
        """
        return self._last_clicked_selection

    def get_menu_category(self):
        """
        Returns the UI area where the last menu click took place.

        Returns one of the following constants:

        - HieroEngine.HIERO_BIN_AREA
        - HieroEngine.HIERO_SPREADSHEET_AREA
        - HieroEngine.HIERO_TIMELINE_AREA
        - None for unknown or undefined
        """
        return self._last_clicked_area

    #####################################################################################
    # General Utilities

    def set_project_root(self, event):
        """
        Ensure any new projects get the project root or default startup
        projects get the project root set properly.

        :param event:   A Nuke event object. It is a standard argument for
                        event callbacks in Nuke, which is what this method is registered
                        as on engine initialization.
        """
        import hiero

        for p in hiero.core.projects():
            # In Nuke 11 and greater the Project.projectRoot and Project.setProjectRoot methods
            # have been deprecated in favour of Project.exportRootDirectory and
            # Project.setProjectDirectory.
            if nuke.env.get("NukeVersionMajor") >= 11 and not p.exportRootDirectory():
                self.logger.debug(
                    "Setting exportRootDirectory on %s to: %s",
                    p.name(),
                    self.sgtk.project_path,
                )
                p.setProjectDirectory(self.sgtk.project_path)
            elif nuke.env.get("NukeVersionMajor") <= 10 and not p.projectRoot():
                self.logger.debug(
                    "Setting projectRoot on %s to: %s", p.name(), self.sgtk.project_path
                )
                p.setProjectRoot(self.sgtk.project_path)

    def _get_dialog_parent(self):
        """
        Return the QWidget parent for all dialogs created through
        show_dialog and show_modal.
        """
        # See https://github.com/shotgunsoftware/tk-nuke/commit/35ca540d152cc5357dc7e347b5efc728a3a89f4a
        # for more info. There have been instability issues with nuke 7 causing
        # various crashes, so window parenting on Nuke versions above 6 is
        # currently disabled.
        if nuke.env.get("NukeVersionMajor") == 7:
            return None
        return super(NukeEngine, self)._get_dialog_parent()

    def _handle_studio_selection_change(self, event):
        """
        An event handler that processes selection-change events in Nuke Studio.

        :param event:   The event that triggered this callback's execution.
        """
        # Keep a copy of the current context since we'll need
        # to get back to it after pre-loading the target.
        current_context = self.context
        sender = event.sender
        import hiero

        try:
            for item in sender.selection():
                # Depending on whether this is a BinItem or something
                # else, we have different ways of getting to the Clip
                # object for the item.
                try:
                    clip = item.source()
                except AttributeError:
                    clip = item.activeItem()

                if isinstance(clip, hiero.core.Clip):
                    media = clip.mediaSource()
                    infos = media.fileinfos()
                    file_path = str(infos[0].filename())

                    # If we've already seen this file selected before, or if it's
                    # not a .nk file, then we don't need to do anything.
                    if file_path not in self._processed_paths and file_path.endswith(
                        ".nk"
                    ):
                        self._processed_paths.append(file_path)
                        self._context_change_menu_rebuild = False
                        current_context = self.context
                        target_context = self._context_switcher.get_new_context(
                            file_path
                        )

                        if target_context:
                            # If this environment has already been processed then
                            # we don't need to do anything. There's only one "shot_step"
                            # environment out there, regardless of what .nk file was
                            # selected.
                            env_name = target_context.sgtk.execute_core_hook(
                                sgtk.constants.PICK_ENVIRONMENT_CORE_HOOK_NAME,
                                context=target_context,
                            )

                            if env_name not in self._processed_environments:
                                self._processed_environments.append(env_name)
                                self._context_switcher.change_context(target_context)
        except Exception as e:
            # If anything went wrong, we can just let the finally block
            # run, which will put things back to the way they were.
            self.logger.debug("Unable to pre-load environment: %s", str(e))
        finally:
            # If the context was changed during the course of the handling
            # of the selection event, we need to go back to what we had.
            # Once we do we can then make sure that we re-enable menu rebuilds
            # for future context changes.
            if self.context is not current_context:
                self._context_switcher.change_context(current_context)
            self._context_change_menu_rebuild = True

    def _on_project_load_callback(self, event):
        """
        Callback executed after project load in Hiero and Nuke Studio. This
        triggers an attempt to change the PTR context to that of the newly
        opened project file.

        :param event:   The event object from Hiero/NS.
        """
        import hiero.core

        project = hiero.core.projects()[-1]
        script_path = project.path()

        # We're going to just skip doing anything if this fails
        # for any reason. It would be nice to swap to the error
        # menu item, but unfortunately a project open event is
        # triggered on launch when Hiero/Nuke Studio loads the
        # "Untitled" project from the Nuke install location. There
        # isn't a way to distinguish between that and something the
        # user purposefully opened, and we don't want to hose the
        # toolkit context with that.
        try:
            tk = sgtk.tank_from_path(script_path)

            # Extract a new context based on the file and change to that
            # context.
            new_context = tk.context_from_path(
                script_path,
                previous_context=self.context,
            )

            if new_context != self.context:
                sgtk.platform.change_context(new_context)
        except Exception:
            self.logger.debug("Unable to determine context for file: %s", script_path)

    def _define_qt_base(self):
        """
        This will be called at initialisation time and will allow
        a user to control various aspects of how QT is being used
        by Sgtk. The method should return a dictionary with a number
        of specific keys, outlined below.

        * qt_core - the QtCore module to use
        * qt_gui - the QtGui module to use
        * wrapper - the Qt wrapper root module, e.g. PySide
        * dialog_base - base class for to use for Sgtk's dialog factory

        We are overriding the base implementation so that we can set the "SHOTGUN_SKIP_QTWEBENGINEWIDGETS_IMPORT"
        environment variable for versions of Nuke on Windows that use PySide2. Once this is done, we call the
        base implementation

        :return: dict
        """

        nuke_version = (
            nuke.env.get("NukeVersionMajor"),
            nuke.env.get("NukeVersionMinor"),
            nuke.env.get("NukeVersionRelease"),
        )

        # Disable the importing of the web engine widgets submodule from PySide2
        # if this is a Windows environment. Failing to do so will cause Nuke to freeze on startup.
        if nuke_version[0] > 10 and sgtk.util.is_windows():
            self.logger.debug(
                "Nuke 11+ on Windows can deadlock if QtWebEngineWidgets "
                "is imported. Setting SHOTGUN_SKIP_QTWEBENGINEWIDGETS_IMPORT=1..."
            )
            os.environ["SHOTGUN_SKIP_QTWEBENGINEWIDGETS_IMPORT"] = "1"

        return super(NukeEngine, self)._define_qt_base()

    def __setup_favorite_dirs(self):
        """
        Sets up nuke shortcut "favorite dirs" that are presented in the left hand side of
        Nuke common dialogs (open, save).

        Nuke currently only writes favorites to disk in ~/.nuke/folders.nk. If you add/remove
        one in the UI. Doing them via the api only updates them for the session (Nuke bug #3740).
        See http://forums.thefoundry.co.uk/phpBB2/viewtopic.php?t=3481&start=15
        """
        engine_root_dir = self.disk_location
        sg_logo = os.path.abspath(
            os.path.join(engine_root_dir, "resources", "sg_logo_80px.png")
        )

        # Ensure old favorites we used to use are removed.
        supported_entity_types = ["Shot", "Sequence", "Scene", "Asset", "Project"]
        for x in supported_entity_types:
            nuke.removeFavoriteDir("Tank Current %s" % x)
        nuke.removeFavoriteDir("Tank Current Work")
        nuke.removeFavoriteDir("PTR Current Project")
        nuke.removeFavoriteDir("PTR Current Work")

        # Add favorties for current project root(s).
        proj = self.context.project
        current_proj_fav = self.get_setting("project_favourite_name")
        # Only add these current project entries if we have a value from settings.
        # Otherwise, they have opted to not show them.
        if proj and current_proj_fav:
            proj_roots = self.sgtk.roots
            for root_name, root_path in proj_roots.items():
                dir_name = current_proj_fav
                if len(proj_roots) > 1:
                    dir_name += " (%s)" % root_name

                # Remove old directory
                nuke.removeFavoriteDir(dir_name)

                # Add new path
                nuke.addFavoriteDir(
                    dir_name,
                    directory=root_path,
                    type=(nuke.IMAGE | nuke.SCRIPT | nuke.GEO),
                    icon=sg_logo,
                    tooltip=root_path,
                )

        # Add favorites directories from the config
        for favorite in self.get_setting("favourite_directories"):
            # Remove old directory
            nuke.removeFavoriteDir(favorite["display_name"])
            try:
                template = self.get_template_by_name(favorite["template_directory"])
                fields = self.context.as_template_fields(template)
                path = template.apply_fields(fields)
            except Exception as e:
                msg = (
                    "Error processing template '%s' to add to favorite "
                    "directories: %s" % (favorite["template_directory"], e)
                )
                self.logger.exception(msg)
                continue

            # Add new directory
            icon_path = favorite.get("icon")
            if not os.path.isfile(icon_path) or not os.path.exists(icon_path):
                icon_path = sg_logo

            nuke.addFavoriteDir(
                favorite["display_name"],
                directory=path,
                type=(nuke.IMAGE | nuke.SCRIPT | nuke.GEO),
                icon=icon_path,
                tooltip=path,
            )