Stackedit/js/extensionMgr.js

define([
    "jquery",
    "underscore",
    "utils",
    "classes/Extension",
    "settings",
    "text!html/settingsExtensionsAccordion.html",
    "extensions/partialRendering",
    "extensions/userCustom",
    "extensions/googleAnalytics",
    "extensions/dialogAbout",
    "extensions/dialogManagePublication",
    "extensions/dialogManageSynchronization",
    "extensions/dialogOpenHarddrive",
    "extensions/documentSelector",
    "extensions/documentTitle",
    "extensions/workingIndicator",
    "extensions/notifications",
    "extensions/markdownExtra",
    "extensions/toc",
    "extensions/mathJax",
    "extensions/emailConverter",
    "extensions/scrollLink",
    "extensions/buttonSync",
    "extensions/buttonPublish",
    "extensions/buttonShare",
    "extensions/buttonStat",
    "extensions/buttonHtmlCode",
    "extensions/buttonMarkdownSyntax",
    "extensions/buttonViewer",
    "libs/bootstrap",
    "libs/jquery.waitforimages"
], function($, _, utils, Extension, settings, settingsExtensionsAccordionHTML) {

    var extensionMgr = {};

    // Create a list of extensions
    var extensionList = _.chain(arguments).map(function(argument) {
        return argument instanceof Extension && argument;
    }).compact().value();

    // Returns all callbacks with the specified name that are implemented in extensions
    function getExtensionCallbackList(hookName) {
        return _.chain(extensionList).map(function(extension) {
            return extension.config.enabled && extension[hookName];
        }).compact().value();
    }

    // Return a function that calls every callbacks with the specified name from all extensions
    var hookCallbackList = {};
    function createHook(hookName, noLog) {
        hookCallbackList[hookName] = getExtensionCallbackList(hookName);
        return function() {
            if(!noLog) {
                logger.log(hookName, arguments);
            }
            var callbackArguments = arguments;
            _.each(hookCallbackList[hookName], function(callback) {
                // In case user custom callback contains error
                try {
                    callback.apply(null, callbackArguments);
                }
                catch(e) {
                    console.error(e);
                }
            });
        };
    }
    
    // Add a Hook to the extensionMgr
    function addHook(hookName, noLog) {
        extensionMgr[hookName] = createHook(hookName, noLog);
    }

    // Used by external modules to listen to extension events
    extensionMgr.addHookCallback = function(hookName, callback) {
        hookCallbackList[hookName].push(callback);
    };

    // Set extension config
    extensionSettings = settings.extensionSettings || {};
    _.each(extensionList, function(extension) {
        extension.config = _.extend({}, extension.defaultConfig, extensionSettings[extension.extensionId]);
        extension.config.enabled = !extension.isOptional || extension.config.enabled === undefined || extension.config.enabled === true;
    });
    
    // Call every onInit callbacks
    createHook("onInit")();

    // Load/Save extension config from/to settings
    extensionMgr["onLoadSettings"] = function() {
        logger.log("onLoadSettings");
        _.each(extensionList, function(extension) {
            utils.setInputChecked("#input-enable-extension-" + extension.extensionId, extension.config.enabled);
            var onLoadSettingsCallback = extension.onLoadSettings;
            onLoadSettingsCallback && onLoadSettingsCallback();
        });
    };
    extensionMgr["onSaveSettings"] = function(newExtensionSettings, event) {
        logger.log("onSaveSettings");
        _.each(extensionList, function(extension) {
            var newExtensionConfig = _.extend({}, extension.defaultConfig);
            newExtensionConfig.enabled = utils.getInputChecked("#input-enable-extension-" + extension.extensionId);
            var onSaveSettingsCallback = extension.onSaveSettings;
            onSaveSettingsCallback && onSaveSettingsCallback(newExtensionConfig, event);
            newExtensionSettings[extension.extensionId] = newExtensionConfig;
        });
    };

    addHook("onMessage");
    addHook("onError");
    addHook("onOfflineChanged");
    addHook("onAsyncRunning", true);
    addHook("onPeriodicRun", true);

    // To access modules that are loaded after extensions
    addHook("onFileMgrCreated");
    addHook("onSynchronizerCreated");
    addHook("onPublisherCreated");
    addHook("onExtensionMgrCreated");

    // Operations on files
    addHook("onFileCreated");
    addHook("onFileDeleted");
    addHook("onFileSelected");
    addHook("onFileOpen");
    addHook("onFileClosed");
    addHook("onContentChanged");
    addHook("onTitleChanged");

    // Sync events
    addHook("onSyncRunning");
    addHook("onSyncSuccess");
    addHook("onSyncImportSuccess");
    addHook("onSyncExportSuccess");
    addHook("onSyncRemoved");

    // Publish events
    addHook("onPublishRunning");
    addHook("onPublishSuccess");
    addHook("onNewPublishSuccess");
    addHook("onPublishRemoved");

    // Operations on Layout
    addHook("onLayoutConfigure");
    addHook("onLayoutCreated");

    // Operations on PageDown
    addHook("onEditorConfigure");
    addHook("onSectionsCreated");

    var onPreviewFinished = createHook("onPreviewFinished");
    var onAsyncPreviewCallbackList = getExtensionCallbackList("onAsyncPreview");
    // The number of times we expect tryFinished to be called
    var nbAsyncPreviewCallback = onAsyncPreviewCallbackList.length + 1;
    var previewContentsElt = undefined;
    var previewContentsJQElt = undefined;
    extensionMgr["onAsyncPreview"] = function() {
        logger.log("onAsyncPreview");
        // Call onPreviewFinished callbacks when all async preview are finished
        var counter = 0;
        function tryFinished() {
            if(++counter === nbAsyncPreviewCallback) {
                _.defer(function() {
                    var html = "";
                    _.each(previewContentsElt.children, function(elt) {
                        html += elt.innerHTML;
                    });
                    onPreviewFinished(utils.trim(html));
                    logger.log("Preview time: " + (new Date() - extensionMgr.previewStartTime));
                });
            }
        }
        // We assume images are loading in the preview
        previewContentsJQElt.waitForImages(tryFinished);
        _.each(onAsyncPreviewCallbackList, function(asyncPreviewCallback) {
            asyncPreviewCallback(tryFinished);
        });
    };

    function createSettings(extension) {
        $("#accordion-extensions").append($(_.template(settingsExtensionsAccordionHTML, {
            extensionId: extension.extensionId,
            extensionName: extension.extensionName,
            isOptional: extension.isOptional,
            settingsBlock: extension.settingsBlock
        })));
    }

    extensionMgr["onReady"] = function() {
        previewContentsElt = document.getElementById('preview-contents');
        previewContentsJQElt = $(previewContentsElt);
        
        // Create accordion in settings dialog
        _.chain(extensionList).sortBy(function(extension) {
            return extension.extensionName.toLowerCase();
        }).each(createSettings);

        // Create extension buttons
        logger.log("onCreateButton");
        var onCreateButtonCallbackList = getExtensionCallbackList("onCreateButton");
        _.each(onCreateButtonCallbackList, function(callback) {
            $("#extension-buttons").append($('<div class="btn-group">').append(callback()));
        });

        // Create extension preview buttons
        logger.log("onCreatePreviewButton");
        var onCreatePreviewButtonCallbackList = getExtensionCallbackList("onCreatePreviewButton");
        _.each(onCreatePreviewButtonCallbackList, function(callback) {
            $("#extension-preview-buttons").append($('<div class="btn-group">').append(callback()));
        });

        // Call extensions onReady callbacks
        var onReady = createHook("onReady");
        onReady();
    };

    // For extensions that need to call other extensions
    extensionMgr.onExtensionMgrCreated(extensionMgr);
    return extensionMgr;
});