main.js

/*
 * Copyright (c) 2012 Massachusetts Institute of Technology, Adobe Systems
 * Incorporated, and other contributors. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

/*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */
/*global define, $, brackets, Mustache */

/**
 * provides events:
 *
 *  - enable & disable, when the extension should operate
 */

define(function (require, exports, module) {
    "use strict";

    var Agent              = require("./src/Agent");
    var AgentManager       = require("./src/AgentManager");
    var AppInit            = brackets.getModule("utils/AppInit");
    var CommandManager     = brackets.getModule("command/CommandManager");
    var Commands           = brackets.getModule("command/Commands");
    var Dialogs            = brackets.getModule("widgets/Dialogs");
    var EpochPanel         = require("./src/EpochPanel");
    var FileCallGraphPanel = require("./src/FileCallGraphPanel");
    var EditorInterface    = require("./src/EditorInterface");
    var ExtensionUtils     = brackets.getModule("utils/ExtensionUtils");
    var Invitation         = require("./src/Invitation");
    var Inspector          = brackets.getModule("LiveDevelopment/Inspector/Inspector");
    var LiveDevelopment    = brackets.getModule("LiveDevelopment/LiveDevelopment");
    var Menus              = brackets.getModule("command/Menus");
    var NativeApp          = brackets.getModule("utils/NativeApp");
    var FileSystem         = brackets.getModule("filesystem/FileSystem");
    var Panel              = require("./src/Panel");
    var ProxyProvider      = require("./src/ProxyProvider");
    var Strings            = require("./src/strings");
    var UI                 = require("./src/UI");
    var Update             = require("./src/Update");
    var Usage              = require("./src/Usage");
    var StringUtils        = brackets.getModule("utils/StringUtils");
    var Preferences        = require("./src/Preferences");

    var $exports = $(exports);

    var THESEUS_VERSION = JSON.parse(require("text!package.json")).version;

    // check that node_modules is there and alert the user if it isn't
    var corruptInstallationDialogHTML = require("text!./src/InstallationCorrupt.html");
    var corruptInstallationDialogTemplate = Mustache.render(corruptInstallationDialogHTML, {Strings : Strings});
    var nodeModulesPath = ExtensionUtils.getModulePath(module, "node_modules");
    FileSystem.resolve(nodeModulesPath, function (err) {
        if (err) {
            var dialog = Dialogs.showModalDialogUsingTemplate(corruptInstallationDialogTemplate);
            var $dialog = dialog.getElement();
            $dialog.find(".close").on("click", dialog.close.bind(dialog));
        }
    });

    // set up the menus

    var _modes = {
        "static" : { name: "static", displayName: Strings.MENU_MODE_STATIC_DISPLAYNAME },
        "proxy" : { name: "proxy", displayName: Strings.MENU_MODE_PROXY_DISPLAYNAME },
    };
    var _orderedModes = [_modes["static"], _modes["proxy"]];
    var DEFAULT_MODE = _modes["static"];

    var ID_THESEUS_WELCOME_SCREEN   = "brackets.theseus.welcome";
    var NAME_THESEUS_WELCOME_SCREEN = Strings.MENU_NAME_THESEUS_WELCOME_SCREEN;

    var ID_THESEUS_TROUBLESHOOTING   = "brackets.theseus.troubleshooting";
    var NAME_THESEUS_TROUBLESHOOTING = Strings.MENU_NAME_THESEUS_TROUBLESHOOTING;

    var ID_THESEUS_ENABLE = "brackets.theseus.enable";
    var NAME_THESEUS_ENABLE = Strings.MENU_NAME_THESEUS_ENABLE;

    var ID_THESEUS_DEBUG_BRACKETS = "brackets.theseus.debug-brackets";
    var NAME_THESEUS_DEBUG_BRACKETS = Strings.MENU_NAME_THESEUS_DEBUG_BRACKETS;

    var ID_THESEUS_RESET_TRACE = "brackets.theseus.reset-trace";
    var NAME_THESEUS_RESET_TRACE = Strings.MENU_NAME_THESEUS_RESET_TRACE;

    var ID_THESEUS_MODES = _orderedModes.map(function (mode) { return "brackets.theseus.mode." + mode.name; });
    var NAME_THESEUS_MODES = _orderedModes.map(function (mode) { return "   " + Strings.MENU_MODE + " " + mode.displayName; });

    // module variables

    var _enabled = false;
    var _mode = DEFAULT_MODE;

    function _enable() {
        $exports.triggerHandler("enable");
    }

    function _disable() {
        $exports.triggerHandler("disable");
    }

    function _toggleEnabled(enabled) {
        // TODO: disable or enable immediately
        if (enabled !== undefined) { // set to a given state
            _enabled = enabled;
        } else {
            _enabled = !_enabled;
        }
        Preferences.set("enabled", _enabled, true);
        _updateMenuStates();

        if (_enabled) {
            _enable();
        } else {
            _disable();
        }
    }

    function _setMode(modeName) {
        // TODO: warn user that connection will need to be restarted
        _mode = _modes[modeName] || DEFAULT_MODE;
        Preferences.set("mode", _mode.name, true);
        _updateMenuStates();
    }

    function _setModeHandler(modeName) {
        return function () {
            _setMode(modeName);
            $exports.triggerHandler("modeChange", modeName);
        };
    }

    function _showWelcomeScreen() {
        Invitation.showInvitation();
    }

    function _showTroubleshooting() {
        NativeApp.openURLInDefaultBrowser("https://github.com/adobe-research/theseus/wiki/Troubleshooting-Theseus");
    }

    function _debugBrackets() {
        var _proxy;

        var bracketsPath = window.location.pathname;
        var bracketsRoot = "/", bracketsRelativePath = bracketsPath;
        var pathMatch;
        if (bracketsRelativePath[0] === "/") {
            bracketsRelativePath = bracketsRelativePath.slice(1);
        }
        if (pathMatch = /^[a-z]\:[\/\\]/i.exec(bracketsRelativePath)) {
            bracketsRoot = pathMatch[0];
            bracketsRelativePath = bracketsRelativePath.slice(pathMatch[0].length);
        }

        if (!_enabled) {
            _enabled = true;
            _enable();
        }

        console.log("[theseus] opening new brackets window");
        var debugWindowMarker = "debug_" + Date.now() + Math.floor(Math.random() * 100).toString(); // very likely to be unique
        location.hash = debugWindowMarker;
        CommandManager.execute("debug.newBracketsWindow").then(function () {
            location.hash = "";
            console.log("[theseus] getting a proxy server for " + bracketsRoot);
            return ProxyProvider.getServer(bracketsRoot, "static");
        }).then(function (proxy) {
            _proxy = proxy;
            console.log("[theseus] finding debuggable windows");
            return Inspector.getDebuggableWindows("127.0.0.1", 9234);
        }).then(function (response) {
            console.log("[theseus] got windows");
            var keys = Object.keys(response).filter(function (k) {
               return (response[k].webSocketDebuggerUrl && response[k].url.indexOf(debugWindowMarker) !== -1);
            });
            if (keys.length > 0) {
                var page = response[keys[0]];

                var redirect = function () {
                    Inspector.off("connect", redirect);
                    var redirectTo = _proxy.proxyRootURL + bracketsRelativePath;
                    console.log("[theseus] redirecting to " + redirectTo);
                    Inspector.Runtime.evaluate("window.location = " + JSON.stringify(redirectTo), function () {});
                };
                console.log("[theseus] waiting to redirect");
                Inspector.on("connect", redirect);

                Inspector.connect(page.webSocketDebuggerUrl);
            }
            else {
                console.log("[theseus] unable to get debuggable window");
            }
        }).fail(function onFail(err) {
            console.log("[theseus] debugging brackets failed: " + err);
        });
    }

    function _resetTrace() {
        AgentManager.resetTrace();
    }

    function _loadPreferences() {
        _enabled = Preferences.get("enabled");
        _mode = _modes[Preferences.get("mode")] || DEFAULT_MODE;
    }

    function _setupMenu() {
        CommandManager.register(
            NAME_THESEUS_WELCOME_SCREEN,
            ID_THESEUS_WELCOME_SCREEN,
            _showWelcomeScreen
        );

        CommandManager.register(
            NAME_THESEUS_TROUBLESHOOTING,
            ID_THESEUS_TROUBLESHOOTING,
            _showTroubleshooting
        );

        CommandManager.register(
            NAME_THESEUS_ENABLE,
            ID_THESEUS_ENABLE,
            _toggleEnabled
        );

        CommandManager.register(
            NAME_THESEUS_DEBUG_BRACKETS,
            ID_THESEUS_DEBUG_BRACKETS,
            _debugBrackets
        );

        CommandManager.register(
            NAME_THESEUS_RESET_TRACE,
            ID_THESEUS_RESET_TRACE,
            _resetTrace
        );

        _orderedModes.forEach(function (mode, i) {
            CommandManager.register(
                NAME_THESEUS_MODES[i],
                ID_THESEUS_MODES[i],
                _setModeHandler(mode.name)
            );
        });

        var menu = Menus.getMenu(Menus.AppMenuBar.HELP_MENU);
        menu.addMenuDivider(Menus.LAST, null);
        menu.addMenuItem(ID_THESEUS_WELCOME_SCREEN, null, Menus.LAST, null);
        menu.addMenuItem(ID_THESEUS_TROUBLESHOOTING, null, Menus.LAST, null);

        var fileMenu = Menus.getMenu(Menus.AppMenuBar.FILE_MENU);
        fileMenu.addMenuDivider(Menus.LAST, null);
        fileMenu.addMenuItem(ID_THESEUS_ENABLE, null, Menus.LAST, null);
        _orderedModes.forEach(function (mode, i) {
            var prev = (i == 0) ? ID_THESEUS_ENABLE : ID_THESEUS_MODES[i - 1];
            fileMenu.addMenuItem(ID_THESEUS_MODES[i], null, Menus.AFTER, prev);
        });
        // fileMenu.addMenuItem(ID_THESEUS_RESET_TRACE, null, Menus.AFTER, ID_THESEUS_MODES[ID_THESEUS_MODES.length - 1]);

        var debugMenu = Menus.getMenu("debug-menu");

        if (debugMenu) {
            debugMenu.addMenuDivider(Menus.LAST, null);
            debugMenu.addMenuItem(ID_THESEUS_DEBUG_BRACKETS, [{ "key": "F10" }, { "key": "Cmd-Opt-T", "platform": "mac" }], Menus.LAST, null);
        }

        _updateMenuStates();
    }

    function _updateMenuStates() {
        CommandManager.get(ID_THESEUS_ENABLE).setChecked(_enabled);
        _orderedModes.forEach(function (mode, i) {
            var cmd = CommandManager.get(ID_THESEUS_MODES[i]);
            cmd.setChecked(_mode.name === mode.name);
            cmd.setEnabled(_enabled);
        });
    }

    function isEnabled() {
        return _enabled;
    }

    function isInsideTheseus() {
        return typeof __tracer !== "undefined";
    }

    function getModeName() {
        return _mode.name;
    }

    function _init() {
        _loadPreferences();
        _setupMenu();

        ExtensionUtils.loadStyleSheet(module, "src/main.less");

        Usage.init();
        ProxyProvider.init();
        Agent.init();
        AgentManager.init();
        EditorInterface.init();
        UI.init();
        Panel.init();
        EpochPanel.init();
        // FileCallGraphPanel.init();

        // after a short delay, show 'Thank you!' popup if they haven't seen it
        // setTimeout(function () {
        //     if (!isInsideTheseus()) {
        //         Invitation.showInvitationIfNecessary();
        //     }
        // }, 1000);

        $(LiveDevelopment).on("statusChange", function (e, status) {
            if (!_enabled) return;

            if (status === 1) { // "Connecting to the remote debugger"
                setTimeout(function () {
                    var $btnGoLive = $("#toolbar-go-live");

                    $btnGoLive.twipsy("hide").removeData("twipsy");
                    $btnGoLive.twipsy({
                        placement: "left",
                        trigger: "manual",
                        autoHideDelay: 5000,
                        title: function () { return StringUtils.format(Strings.NOTIFICATION_LIVE_DEV_WITH_THESEUS, _mode.name.toUpperCase()) },
                    }).twipsy("show");
                }, 1000);
            }
        });

        $(Preferences).on("change.enabled", function () {
            _toggleEnabled(Preferences.get("enabled"));
        });
        $(Preferences).on("change.mode", function () {
            _setMode(Preferences.get("mode"));
        });

        if (_enabled) { // enable now if enabled in preferences
            _enable();
        }
        
        // Do update procedure, if necessary
        Update.updateIfNecessary();
    }

    // exports

    exports.isEnabled = isEnabled;
    exports.isInsideTheseus = isInsideTheseus;
    exports.getModeName = getModeName;
    exports.version = THESEUS_VERSION;

    // initialize the extension

    AppInit.appReady(_init);
});