handleNodeWithTeam now passes "AUTO" to the callback if the node in
[mkws-moved-to-github.git] / src / mkws-core.js
index cc8c63f..a030d5b 100644 (file)
@@ -11,7 +11,7 @@
 //
 var mkws = {
     authenticated: false,
-    log_level: 1, // Will be overridden from mkws_config, but
+    log_level: 1, // Will be overridden from mkws.config, but
                   // initial value allows jQuery popup to use logging.
     teams: {},
     widgetType2function: {},
@@ -78,12 +78,6 @@ var mkws = {
 };
 
 
-// Define empty mkws_config for simple applications that don't define it.
-if (mkws_config == null || typeof mkws_config != 'object') {
-    var mkws_config = {};
-}
-
-
 mkws.log = function(string) {
     if (!mkws.log_level)
        return;
@@ -102,6 +96,16 @@ mkws.log = function(string) {
 };
 
 
+// This function is taken from a StackOverflow answer
+// http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
+mkws.getParameterByName = function(name) {
+    name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
+    var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
+       results = regex.exec(location.search);
+    return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
+}
+
+
 mkws.registerWidgetType = function(name, fn) {
     mkws.widgetType2function[name] = fn;
     mkws.log("registered widget-type '" + name + "'");
@@ -112,8 +116,13 @@ mkws.promotionFunction = function(name) {
 };
 
 
-mkws.defaultMkwsConfig = function() {
-    /* default mkws config */
+mkws.setMkwsConfig = function(overrides) {
+    // Set global log_level flag early so that mkws.log() works
+    // Fall back to old "debug_level" setting for backwards compatibility
+    var tmp = overrides.log_level;
+    if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
+    if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
+
     var config_default = {
        use_service_proxy: true,
        pazpar2_url: "//mkws.indexdata.com/service-proxy/",
@@ -135,23 +144,62 @@ mkws.defaultMkwsConfig = function() {
        dummy: "dummy"
     };
 
-    // Set global log_level flag early so that log() works
-    // Fall back to old "debug_level" setting for backwards compatibility
-    var tmp = mkws_config.log_level;
-    if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
-
-    if (typeof(tmp) !== 'undefined') {
-       mkws.log_level = tmp;
-    } else if (typeof(config_default.log_level) !== 'undefined') {
-       mkws.log_level = config_default.log_level;
+    mkws.config = mkws.objectInheritingFrom(config_default);
+    for (var k in overrides) {
+       mkws.config[k] = overrides[k];
     }
+};
 
-    /* override standard config values by function parameters */
-    for (var k in config_default) {
-       if (typeof mkws_config[k] === 'undefined')
-           mkws_config[k] = config_default[k];
-       //log("Set config: " + k + ' => ' + mkws_config[k]);
-    }
+
+// This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
+// http://javascript.crockford.com/prototypal.html
+// mkws.objectInheritingFrom behaves the same as Object.create,
+// but since the latter is not available in IE8 we can't use it.
+//
+mkws.objectInheritingFrom = function(o) {
+    function F() {}
+    F.prototype = o;
+    return new F();
+}
+
+
+// The following functions are dispatchers for team methods that
+// are called from the UI using a team-name rather than implicit
+// context.
+mkws.switchView = function(tname, view) {
+    mkws.teams[tname].switchView(view);
+};
+
+mkws.showDetails = function(tname, prefixRecId) {
+    mkws.teams[tname].showDetails(prefixRecId);
+};
+
+mkws.limitTarget  = function(tname, id, name) {
+    mkws.teams[tname].limitTarget(id, name);
+};
+
+mkws.limitQuery  = function(tname, field, value) {
+    mkws.teams[tname].limitQuery(field, value);
+};
+
+mkws.delimitTarget = function(tname, id) {
+    mkws.teams[tname].delimitTarget(id);
+};
+
+mkws.delimitQuery = function(tname, field, value) {
+    mkws.teams[tname].delimitQuery(field, value);
+};
+
+mkws.showPage = function(tname, pageNum) {
+    mkws.teams[tname].showPage(pageNum);
+};
+
+mkws.pagerPrev = function(tname) {
+    mkws.teams[tname].pagerPrev();
+};
+
+mkws.pagerNext = function(tname) {
+    mkws.teams[tname].pagerNext();
 };
 
 
@@ -181,6 +229,8 @@ mkws.defaultMkwsConfig = function() {
                type = cname.replace(/^mkws/, '');
            }
        }
+
+        if (!teamName) teamName = "AUTO";
        callback.call(node, teamName, type);
     }
 
@@ -188,7 +238,7 @@ mkws.defaultMkwsConfig = function() {
     function resizePage() {
        var list = ["mkwsSwitch", "mkwsLang"];
 
-       var width = mkws_config.responsive_design_width;
+       var width = mkws.config.responsive_design_width;
        var parent = $(".mkwsTermlists").parent();
 
        if ($(window).width() <= width &&
@@ -217,47 +267,6 @@ mkws.defaultMkwsConfig = function() {
     };
 
 
-    // The following functions are dispatchers for team methods that
-    // are called from the UI using a team-name rather than implicit
-    // context. Apart from mkws.log, they are the ONLY public UI to
-    // this module.
-    mkws.switchView = function(tname, view) {
-       mkws.teams[tname].switchView(view);
-    };
-
-    mkws.showDetails = function(tname, prefixRecId) {
-       mkws.teams[tname].showDetails(prefixRecId);
-    };
-
-    mkws.limitTarget  = function(tname, id, name) {
-       mkws.teams[tname].limitTarget(id, name);
-    };
-
-    mkws.limitQuery  = function(tname, field, value) {
-       mkws.teams[tname].limitQuery(field, value);
-    };
-
-    mkws.delimitTarget = function(tname, id) {
-       mkws.teams[tname].delimitTarget(id);
-    };
-
-    mkws.delimitQuery = function(tname, field, value) {
-       mkws.teams[tname].delimitQuery(field, value);
-    };
-
-    mkws.showPage = function(tname, pageNum) {
-       mkws.teams[tname].showPage(pageNum);
-    };
-
-    mkws.pagerPrev = function(tname) {
-       mkws.teams[tname].pagerPrev();
-    };
-
-    mkws.pagerNext = function(tname) {
-       mkws.teams[tname].pagerNext();
-    };
-
-
     /*
      * Run service-proxy authentication in background (after page load).
      * The username/password is configured in the apache config file
@@ -303,31 +312,44 @@ mkws.defaultMkwsConfig = function() {
        log("running auto searches");
 
        for (var teamName in mkws.teams) {
-           mkws.teams[teamName].runAutoSearch();
+           mkws.teams[teamName].queue("ready").publish();
        }
     }
 
-
     $(document).ready(function() {
-       mkws.defaultMkwsConfig();
-
-       if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
-           log("Reset query width: " + mkws_config.query_width);
-           mkws_config.query_width = 50;
+       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)) {
+       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];
+                   mkws.locale_lang[lang] = mkws.config[key];
                    log("Added locally configured language '" + lang + "'");
                }
            }
        }
 
-       if (mkws_config.responsive_design_width) {
+       if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
+           log("Reset query width: " + 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("adjust protocol independent links: " + 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);
@@ -335,12 +357,6 @@ mkws.defaultMkwsConfig = function() {
            $(document).ready(resizePage);
        }
 
-       // 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("adjust protocol independent links: " + mkws_config.pazpar2_url);
-       }
-
        // Backwards compatibility: set new magic class names on any
        // elements that have the old magic IDs.
        var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
@@ -388,10 +404,10 @@ mkws.defaultMkwsConfig = function() {
        var now = $.now();
        log("Walking MKWS nodes took " + (now-then) + " ms");
 
-       if (mkws_config.use_service_proxy) {
-           authenticateSession(mkws_config.service_proxy_auth,
-                               mkws_config.service_proxy_auth_domain,
-                               mkws_config.pazpar2_url);
+       if (mkws.config.use_service_proxy) {
+           authenticateSession(mkws.config.service_proxy_auth,
+                               mkws.config.service_proxy_auth_domain,
+                               mkws.config.pazpar2_url);
        } else {
            // raw pp2
            runAutoSearches();