element to the log div
+ const log = document.getElementById("sg_panel_console_log");
// create a element and insert the msg
const node = document.createElement("pre");
node.setAttribute("id", div_id);
node.appendChild(document.createTextNode(msg));
- // append the element to the log div
- const log = document.getElementById("sg_panel_console_log");
+ // just a little indicator so that we know if the log message came from
+ // (javascript or python) when looking in the panel console.
+ const tag = document.createElement("pre");
+ tag.setAttribute("id", "sg_panel_console_tag");
+ if (log_source == "js") {
+ tag.appendChild(document.createTextNode("js"))
+ } else {
+ tag.appendChild(document.createTextNode("py"))
+ }
+
+ log.appendChild(tag);
log.appendChild(node);
log.appendChild(document.createElement("br"));
@@ -1014,6 +1079,13 @@ sg_panel.Panel = new function() {
}
);
+ // Sets the panel into a state where the context is not known
+ sg_manager.UNKNOWN_CONTEXT.connect(
+ function(event) {
+ self.set_unknown_context_state();
+ }
+ );
+
// Clears the current context
sg_manager.CONTEXT_ABOUT_TO_CHANGE.connect(
function(event) {
diff --git a/plugins/basic/js/shotgun/socket_io_manager.js b/plugins/basic/js/shotgun/socket_io_manager.js
index 1d95b6f..07cda7a 100644
--- a/plugins/basic/js/shotgun/socket_io_manager.js
+++ b/plugins/basic/js/shotgun/socket_io_manager.js
@@ -399,6 +399,12 @@ sg_socket_io.SocketManager = new function() {
sg_manager.UPDATE_CONTEXT_THUMBNAIL.emit(context_thumbnail);
});
+ socket.on("set_unknown_context", function() {
+ // The context is unknown
+ sg_logging.debug("Sending unknown context signal from the client.");
+ sg_manager.UNKNOWN_CONTEXT.emit();
+ });
+
socket.on("context_about_to_change", function() {
// The context is about to change
sg_logging.debug("Sending context about to change from client.");
diff --git a/plugins/basic/python/plugin_bootstrap.py b/plugins/basic/python/plugin_bootstrap.py
index 324c563..ce77a0b 100644
--- a/plugins/basic/python/plugin_bootstrap.py
+++ b/plugins/basic/python/plugin_bootstrap.py
@@ -70,6 +70,7 @@ def get_sgtk_logger(sgtk):
# initializes the file where logging output will go
sgtk.LogManager().initialize_base_file_handler(engine_name)
+ sgtk_logger.debug("Log dir: %s" % (sgtk.LogManager().log_folder))
return sgtk_logger, bootstrap_log_handler
diff --git a/python/startup/bootstrap.py b/python/startup/bootstrap.py
index f4f7139..f4d632d 100644
--- a/python/startup/bootstrap.py
+++ b/python/startup/bootstrap.py
@@ -8,9 +8,23 @@
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.
-import sys
+import glob
import os
+import re
+import shutil
+import sys
+import tempfile
+import zipfile
+
import sgtk
+from sgtk.util.filesystem import (
+ backup_folder,
+ ensure_folder_exists,
+ move_folder,
+)
+
+logger = sgtk.LogManager.get_logger(__name__)
+
def bootstrap(engine_name, context, app_path, app_args, **kwargs):
"""
@@ -38,5 +52,206 @@ def bootstrap(engine_name, context, app_path, app_args, **kwargs):
os.pathsep.join(sys.path),
)
+ # the basic plugin needs to be installed in order to launch the adobe
+ # engine. we need to make sure the plugin is installed and up-to-date.
+ # will only run if SHOTGUN_ADOBECC_DISABLE_AUTO_INSTALL is not set.
+ if not "SHOTGUN_ADOBECC_DISABLE_AUTO_INSTALL" in os.environ:
+ logger.debug("Ensuring adobe extension is up-to-date...")
+ try:
+ _ensure_extension_up_to_date(context)
+ except Exception, e:
+ import traceback
+ exc = traceback.format_exc()
+ raise Exception(
+ "There was a problem ensuring the Adobe integration extension "
+ "was up-to-date with your toolkit engine. If this is a "
+ "recurring issue please contact support@shotgunsoftware.com. "
+ "The specific error message encountered was:\n'%s'." % (exc,)
+ )
+
return (app_path, app_args)
+
+def _ensure_extension_up_to_date(context):
+ """
+ Ensure the basic adobe extension is installed in the OS-specific location
+ and that it matches the extension bundled with the installed engine.
+
+ :param context: The context to use when bootstrapping.
+ """
+
+ extension_name = "com.shotgunsoftware.basic.adobecc"
+
+ # the CEP install directory is OS-specific
+ if sys.platform == "win32":
+ app_data = os.getenv("APPDATA")
+ elif sys.platform == "darwin":
+ app_data = os.path.expanduser("~/Library/Application Support")
+ else:
+ raise Exception("This engine only runs on OSX & Windows.")
+
+ # the adobe CEP install directory. This is where the extension is stored.
+ adobe_cep_dir = os.path.join(app_data, "Adobe", "CEP", "extensions")
+ logger.debug("Adobe CEP extension dir: %s" % (adobe_cep_dir,))
+
+ # make sure the directory exists. create it if not.
+ if not os.path.exists(adobe_cep_dir):
+ logger.debug("Extension folder does not exist. Creating it.")
+ ensure_folder_exists(adobe_cep_dir)
+
+ # get the path to the installed engine's .zxp file. the extension_name file i
+ # is 3 levels up from this file.
+ bundled_ext_path = os.path.abspath(
+ os.path.join(
+ os.path.dirname(__file__),
+ os.pardir,
+ os.pardir,
+ "%s.zxp" % (extension_name,)
+ )
+ )
+
+ if not os.path.exists(bundled_ext_path):
+ raise Exception(
+ "Could not find bundled extension. Expected: '%s'" %
+ (bundled_ext_path,)
+ )
+
+ # now get the version of the bundled extension
+ version_file = "%s.version" % (extension_name,)
+
+ bundled_version_file_path = os.path.abspath(
+ os.path.join(
+ os.path.dirname(__file__),
+ os.pardir,
+ os.pardir,
+ version_file
+ )
+ )
+
+ if not os.path.exists(bundled_version_file_path):
+ raise Exception(
+ "Could not find bundled version file. Expected: '%s'" %
+ (bundled_version_file_path,)
+ )
+
+ # get the bundled version from the version file
+ with open(bundled_version_file_path, "r") as bundled_version_file:
+ bundled_version = bundled_version_file.read().strip()
+
+ # check to see if the extension is installed in the CEP extensions directory
+ installed_ext_dir = os.path.join(adobe_cep_dir, extension_name)
+
+ # if not installed, install it
+ if not os.path.exists(installed_ext_dir):
+ logger.debug("Extension not installed. Installing it!")
+ _install_extension(bundled_ext_path, installed_ext_dir)
+ return
+
+ # ---- already installed, check for udpate
+
+ logger.debug("Bundled extension's version is: %s" % (bundled_version,))
+
+ # get the version from the installed extension's build_version.txt file
+ installed_version_file_path = os.path.join(installed_ext_dir, version_file)
+
+ logger.debug(
+ "The installed version file path is: %s" %
+ (installed_version_file_path,)
+ )
+
+ if not os.path.exists(installed_version_file_path):
+ raise Exception(
+ "Could not find installed version file '%s'" %
+ (installed_version_file_path,)
+ )
+
+ # the version of the installed extension
+ installed_version = None
+
+ # get the installed version from the installed version info file
+ with open(installed_version_file_path, "r") as installed_version_file:
+ logger.debug("Extracting the version from the installed extension.")
+ installed_version = installed_version_file.read().strip()
+
+ if installed_version is None:
+ raise Exception(
+ "Could not determine version for the installed extension.")
+
+ logger.debug("Installed extension's version is: %s" % (installed_version,))
+
+ from sgtk.util.version import is_version_older
+ if bundled_version != "dev" and installed_version != "dev":
+ if (bundled_version == installed_version or
+ is_version_older(bundled_version, installed_version)):
+
+ # the bundled version is the same or older. or it is a 'dev' build
+ # which means always install that one.
+ logger.debug(
+ "Installed extension is equal to or newer than the bundled "
+ "build. Nothing to do!"
+ )
+ return
+
+ # ---- extension in engine is newer. update!
+
+ if bundled_version == "dev":
+ logger.debug("Installing the bundled 'dev' version of the extension.")
+ else:
+ logger.debug(
+ "Bundled extension build is newer than the installed extension " +
+ "build! Updating..."
+ )
+
+ # move the installed extension to the backup directory
+ backup_ext_dir = tempfile.mkdtemp()
+ logger.debug("Backing up the installed extension to: %s" % (backup_ext_dir,))
+ try:
+ backup_folder(installed_ext_dir, backup_ext_dir)
+ except Exception:
+ shutil.rmtree(backup_ext_dir)
+ raise Exception("Unable to create backup during extension update.")
+
+ # now remove the installed extension
+ logger.debug("Removing the installed extension directory...")
+ try:
+ shutil.rmtree(installed_ext_dir)
+ except Exception:
+ # try to restore the backup
+ move_folder(backup_ext_dir, installed_ext_dir)
+ raise Exception("Unable to remove the old extension during update.")
+
+ # install the bundled .zxp file
+ _install_extension(bundled_ext_path, installed_ext_dir)
+
+ # if we're here, the install was successful. remove the backup
+ try:
+ logger.debug("Install success. Removing the backed up extension.")
+ shutil.rmtree(backup_ext_dir)
+ except Exception:
+ # can't remove temp dir. no biggie.
+ pass
+
+def _install_extension(ext_path, dest_dir):
+ """
+ Installs the supplied extension path by unzipping it directly into the
+ supplied destination directory.
+
+ :param ext_path: The path to the .zxp extension.
+ :param dest_dir: The CEP extension's destination
+ :return:
+ """
+
+ logger.debug(
+ "Installing bundled extension: '%s' to '%s'" % (ext_path, dest_dir))
+
+ # make sure the bundled extension exists
+ if not os.path.exists(ext_path):
+ raise Exception(
+ "Expected CEP extension does not exist. Looking for %s" %
+ (ext_path,)
+ )
+
+ # extract the .zxp file into the destination dir
+ with zipfile.ZipFile(ext_path, 'r') as ext_zxp:
+ ext_zxp.extractall(dest_dir)
+
diff --git a/python/tk_adobecc/adobe_bridge.py b/python/tk_adobecc/adobe_bridge.py
index a055807..b33ae05 100644
--- a/python/tk_adobecc/adobe_bridge.py
+++ b/python/tk_adobecc/adobe_bridge.py
@@ -216,7 +216,17 @@ def send_context_thumbnail(self, context_thumbnail):
self.logger.debug("Sending context thumb path: %s" % json_context_thumbnail)
self._io.emit("set_context_thumbnail", json_context_thumbnail)
+ def send_unknown_context(self):
+ """
+ Sent when a context can not be determined for the current file.
+ """
+ self.logger.debug("Alerting js that there is no context")
+ self._io.emit("set_unknown_context")
+
def context_about_to_change(self):
+ """
+ Sent just before the context is about to change.
+ """
self.logger.debug("Sending context about to change message.")
self._io.emit("context_about_to_change")
" +
+ "
");
+ "
");
_show_info(true);
_set_info(
@@ -71,6 +73,47 @@ sg_panel.Panel = new function() {
);
};
+ this.set_unknown_context_state = function() {
+ // Clears the panel's contents and displays a message that it is disabled
+
+ this.clear();
+
+ _set_bg_color("#222222");
+
+ _show_header(false);
+ _clear_messages();
+
+ var app_name = _cs_interface.getHostEnvironment().appName;
+ const app_display_name = sg_constants.product_info[app_name].display_name;
+
+ _set_contents(
+ "