From 779b8c03f3340a2a02753f6276438514ad6fa0ec Mon Sep 17 00:00:00 2001 From: Jason Skomorowski Date: Tue, 12 Aug 2014 14:29:45 -0400 Subject: [PATCH] Make mkws.init() repeatable and replace init_widgets() --- examples/htdocs/mkws-widget-ru-requirejs.html | 2 +- src/mkws-core.js | 160 ++++++++++++++----------- 2 files changed, 91 insertions(+), 71 deletions(-) diff --git a/examples/htdocs/mkws-widget-ru-requirejs.html b/examples/htdocs/mkws-widget-ru-requirejs.html index fc6e691..a311cb2 100644 --- a/examples/htdocs/mkws-widget-ru-requirejs.html +++ b/examples/htdocs/mkws-widget-ru-requirejs.html @@ -22,7 +22,7 @@ } }); - require(['mkws_widget_ru'], function() { mkws.init_widgets("requirejs is done"); } ); + require(['mkws_widget_ru'], function() { mkws.init("requirejs is done"); } );
diff --git a/src/mkws-core.js b/src/mkws-core.js index 9c46f27..3632a64 100644 --- a/src/mkws-core.js +++ b/src/mkws-core.js @@ -14,6 +14,7 @@ window.mkws = { $: $, // Our own local copy of the jQuery object authenticated: false, + active: false, log_level: 1, // Will be overridden from mkws.config, but // initial value allows jQuery popup to use logging. teams: {}, @@ -520,7 +521,11 @@ mkws.pagerNext = function(tname) { function makeWidgetsWithin(level, node) { - node.find(selectorForAllWidgets()).each(function() { + if (node) var widgetNodes = node.find(selectorForAllWidgets()); + else widgetNodes = $(selectorForAllWidgets()); + // Return false if we parse no widgets + if (widgetNodes.length < 1) return false; + widgetNodes.each(function() { handleNodeWithTeam(this, function(tname, type) { var myTeam = mkws.teams[tname]; if (!myTeam) { @@ -538,61 +543,20 @@ mkws.pagerNext = function(tname) { } }); }); + return true; } - function init(rootsel) { - mkws.autoHasAuto = false; - if (!rootsel) var rootsel = ':root'; - var saved_config; - if (typeof mkws_config === 'undefined') { - log("setting empty config"); - saved_config = {}; - } else { - log("using config: " + $.toJSON(mkws_config)); - saved_config = mkws_config; - } - mkws.setMkwsConfig(saved_config); - - for (var key in mkws.config) { - if (mkws.config.hasOwnProperty(key)) { - if (key.match(/^language_/)) { - var lang = key.replace(/^language_/, ""); - // Copy custom languages into list - mkws.locale_lang[lang] = mkws.config[key]; - log("added locally configured language '" + lang + "'"); - } - } - } - - var lang = mkws.getParameterByName("lang") || mkws.config.lang; - if (!lang || !mkws.locale_lang[lang]) { - mkws.config.lang = "" - } else { - mkws.config.lang = lang; - } - - log("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); - - if (mkws.config.query_width < 5 || mkws.config.query_width > 150) { - log("reset query width to " + mkws.config.query_width); - mkws.config.query_width = 50; - } - - // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" - if (mkws.config.pazpar2_url.match(/^\/\//)) { - mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; - log("adjusted protocol independent link to " + mkws.config.pazpar2_url); - } - - if (mkws.config.responsive_design_width) { - // Responsive web design - change layout on the fly based on - // current screen width. Required for mobile devices. - $(window).resize(resizePage); - // initial check after page load - $(document).ready(resizePage); - } + // This function should have no side effects if run again on an operating session, even if + // the element/selector passed causes existing widgets to be reparsed: + // + // * configuration is not regenerated + // * authentication is not performed again + // * autosearches are not re-run + mkws.init = function(message, rootsel) { + if (message) mkws.log(message); + // TODO: Let's remove this soon // Backwards compatibility: set new magic class names on any // elements that have the old magic IDs. var ids = [ "Switch", "Lang", "Search", "Pager", "Navi", @@ -607,8 +571,71 @@ mkws.pagerNext = function(tname) { } } + // MKWS is not active until init() has been run against an object with widget nodes. + // We only set initial configuration when MKWS is first activated. + if (!mkws.isActive) { + var widgetSelector = selectorForAllWidgets(); + if ($(widgetSelector).length < 1) { + mkws.log("no widgets found"); + return; + } + + // Initial configuration + mkws.autoHasAuto = false; + var saved_config; + if (typeof mkws_config === 'undefined') { + log("setting empty config"); + saved_config = {}; + } else { + log("using config: " + $.toJSON(mkws_config)); + saved_config = mkws_config; + } + mkws.setMkwsConfig(saved_config); + + for (var key in mkws.config) { + if (mkws.config.hasOwnProperty(key)) { + if (key.match(/^language_/)) { + var lang = key.replace(/^language_/, ""); + // Copy custom languages into list + mkws.locale_lang[lang] = mkws.config[key]; + log("added locally configured language '" + lang + "'"); + } + } + } + + var lang = mkws.getParameterByName("lang") || mkws.config.lang; + if (!lang || !mkws.locale_lang[lang]) { + mkws.config.lang = "" + } else { + mkws.config.lang = lang; + } + + log("using language: " + (mkws.config.lang ? mkws.config.lang : "none")); + + if (mkws.config.query_width < 5 || mkws.config.query_width > 150) { + log("reset query width to " + mkws.config.query_width); + mkws.config.query_width = 50; + } + + // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp" + if (mkws.config.pazpar2_url.match(/^\/\//)) { + mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url; + log("adjusted protocol independent link to " + mkws.config.pazpar2_url); + } + + if (mkws.config.responsive_design_width) { + // Responsive web design - change layout on the fly based on + // current screen width. Required for mobile devices. + $(window).resize(resizePage); + // initial check after page load + $(document).ready(resizePage); + } + } + var then = $.now(); - makeWidgetsWithin(1, $(rootsel)); + // If we've made no widgets, return without starting an SP session + // or marking MKWS active. + if (makeWidgetsWithin(1, rootsel) === false) return false; var now = $.now(); log("walking MKWS nodes took " + (now-then) + " ms"); @@ -623,30 +650,23 @@ mkws.pagerNext = function(tname) { } */ - if (mkws.config.use_service_proxy && !mkws.authenticated) { - authenticateSession(mkws.config.service_proxy_auth, - mkws.config.service_proxy_auth_domain, - mkws.config.pazpar2_url); + if (mkws.config.use_service_proxy) { + if (!mkws.authenticated) { + authenticateSession(mkws.config.service_proxy_auth, + mkws.config.service_proxy_auth_domain, + mkws.config.pazpar2_url); + } } else { // raw pp2 runAutoSearches(); } - }; - - // callback for calls after page load, e.g. requirejs - mkws.init_widgets = function (message) { - if (message) mkws.log(message); - - var widgetSelector = selectorForAllWidgets(); - if (widgetSelector && $(widgetSelector).length !== 0) { - init(); - } else { - mkws.log("no widgets found"); - } + + mkws.isActive = true; + return true; }; $(document).ready(function() { - mkws.init_widgets(); + mkws.init(); }); })(mkws.$); -- 1.7.10.4