app.py

# Copyright (c) 2013 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.

"""
Open selection in Shotgun
"""

import hiero.core

from tank.platform import Application
from tank import TankError
from tank.platform.qt import QtGui, QtCore


class HieroOpenInShotgun(Application):
    """
    This app adds a menu item that allows a user to jump from an object
    in Hiero to the associated object in Shotgun.
    """

    def init_app(self):
        """
        Initialization
        """
        self.engine.register_command("Open in Flow Production Tracking", self.callback)

    @property
    def context_change_allowed(self):
        """
        Specifies that context changes are allowed.
        """
        return True

    def callback(self):
        """
        Command implementation
        """
        try:
            self._open_shot()
        except TankError as e:
            # report all tank errors with a UI popup.
            QtGui.QMessageBox.critical(None, "Shot Lookup Error!", str(e))
        except Exception as e:
            # log full call stack to console
            self.log_exception("General error reported.")
            # pop up message
            msg = "A general error was reported: %s" % e
            QtGui.QMessageBox.critical(None, "Shot Lookup Error!", msg)

    def _open_shot(self):
        """
        Look up shot in shotgun from selection
        """

        # grab the current selection from the view that triggered the event.
        selection = self.engine.get_menu_selection()

        # Exclude transisions from the list of selected items if this version of
        # hiero supports effects
        if hasattr(hiero.core, "Transition"):
            selection = [
                s for s in selection if not isinstance(s, hiero.core.Transition)
            ]

        # Exclude effects from the list of selected items if this version of
        # hiero supports effects
        if hasattr(hiero.core, "EffectTrackItem"):
            selection = [
                s for s in selection if not isinstance(s, hiero.core.EffectTrackItem)
            ]

        if len(selection) != 1:
            raise TankError("Please select a single Shot!")

        if not isinstance(selection[0], hiero.core.TrackItem):
            raise TankError("Please select a Shot in the Timeline or Spreadsheet!")

        # this is always okay according to the hiero API docs
        sequence = selection[0].parent().parent()

        shot_name = selection[0].name()
        sequence_name = sequence.name()

        self.log_debug(
            "Looking for a shot '%s' with a sequence '%s' in Flow Production Tracking..."
            % (shot_name, sequence_name)
        )

        filters = []
        filters.append(["sg_sequence.Sequence.code", "is", sequence_name])
        filters.append(["code", "is", shot_name])

        sg_data = self.shotgun.find_one("Shot", filters)

        if sg_data is None:
            raise TankError(
                "Could not find a Shot in Flow Production Tracking with name '%s' associated with a Sequence '%s'!"
                % (shot_name, sequence_name)
            )

        # launch Shotgun Url using default browser
        url = "%s/detail/Shot/%s" % (self.shotgun.base_url, sg_data["id"])
        QtGui.QDesktopServices.openUrl(QtCore.QUrl(url))