Add logging of size state-changes.
[mkws-moved-to-github.git] / src / mkws-core.js
index e0d4e2f..8d19f3a 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;
@@ -94,7 +88,8 @@ mkws.log = function(string) {
 
     // you need to disable use strict at the top of the file!!!
     if (mkws.log_level >= 3) {
-       console.log(arguments.callee.caller);
+        // Works in Chrome; not sure about elsewhere
+       console.trace();
     } else if (mkws.log_level >= 2) {
        console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
     }
@@ -102,6 +97,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 +117,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 +145,111 @@ 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();
+}
+
+
+mkws.defaultTemplate = function(name) {
+    if (name === 'Record') {
+       return '\
+<table>\
+  <tr>\
+    <th>{{translate "Title"}}</th>\
+    <td>\
+      {{md-title}}\
+      {{#if md-title-remainder}}\
+       ({{md-title-remainder}})\
+      {{/if}}\
+      {{#if md-title-responsibility}}\
+       <i>{{md-title-responsibility}}</i>\
+      {{/if}}\
+    </td>\
+  </tr>\
+  {{#if md-date}}\
+  <tr>\
+    <th>{{translate "Date"}}</th>\
+    <td>{{md-date}}</td>\
+  </tr>\
+  {{/if}}\
+  {{#if md-author}}\
+  <tr>\
+    <th>{{translate "Author"}}</th>\
+    <td>{{md-author}}</td>\
+  </tr>\
+  {{/if}}\
+  {{#if md-electronic-url}}\
+  <tr>\
+    <th>{{translate "Links"}}</th>\
+    <td>\
+      {{#each md-electronic-url}}\
+       <a href="{{this}}">Link{{index1}}</a>\
+      {{/each}}\
+    </td>\
+  </tr>\
+  {{/if}}\
+  {{#if-any location having="md-subject"}}\
+  <tr>\
+    <th>{{translate "Subject"}}</th>\
+    <td>\
+      {{#first location having="md-subject"}}\
+       {{#if md-subject}}\
+         {{#commaList md-subject}}\
+           {{this}}{{/commaList}}\
+       {{/if}}\
+      {{/first}}\
+    </td>\
+  </tr>\
+  {{/if-any}}\
+  <tr>\
+    <th>{{translate "Locations"}}</th>\
+    <td>\
+      {{#commaList location}}\
+       {{attr "@name"}}{{/commaList}}\
+    </td>\
+  </tr>\
+</table>\
+';
+    } else if (name === "Summary") {
+       return '\
+<a href="#" id="{{_id}}" onclick="{{_onclick}}">\
+  <b>{{md-title}}</b>\
+</a>\
+{{#if md-title-remainder}}\
+  <span>{{md-title-remainder}}</span>\
+{{/if}}\
+{{#if md-title-responsibility}}\
+  <span><i>{{md-title-responsibility}}</i></span>\
+{{/if}}\
+';
+    } else if (name === "Image") {
+       return '\
+      <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
+        {{#first md-thumburl}}\
+         <img src="{{this}}" alt="{{../md-title}}"/>\
+        {{/first}}\
+       <br/>\
+      </a>\
+';
     }
+
+    var s = "There is no default '" + name +"' template!";
+    alert(s);
+    return s;
 };
 
 
@@ -174,6 +272,10 @@ mkws.limitQuery  = function(tname, field, value) {
     mkws.teams[tname].limitQuery(field, value);
 };
 
+mkws.limitCategory  = function(tname, id) {
+    mkws.teams[tname].limitCategory(id);
+};
+
 mkws.delimitTarget = function(tname, id) {
     mkws.teams[tname].delimitTarget(id);
 };
@@ -221,6 +323,8 @@ mkws.pagerNext = function(tname) {
                type = cname.replace(/^mkws/, '');
            }
        }
+
+        if (!teamName) teamName = "AUTO";
        callback.call(node, teamName, type);
     }
 
@@ -228,27 +332,43 @@ mkws.pagerNext = function(tname) {
     function resizePage() {
        var list = ["mkwsSwitch", "mkwsLang"];
 
-       var width = mkws_config.responsive_design_width;
        var parent = $(".mkwsTermlists").parent();
-
-       if ($(window).width() <= width &&
-           parent.hasClass("mkwsTermlistContainer1")) {
-           log("changing from wide to narrow: " + $(window).width());
-           $(".mkwsTermlistContainer1").hide();
-           $(".mkwsTermlistContainer2").show();
+       var targetWidth = mkws.config.responsive_design_width;
+        var width = $(window).width();
+
+        if (mkws.width === undefined) {
+            // No state change, since we have no previous state
+        } else if (mkws.width <= targetWidth && width > targetWidth) {
+            log("narrow -> wide");
+        } else if (mkws.width > targetWidth && width <= targetWidth) {
+            log("wide -> narrow");
+        } else if (width > targetWidth) {
+            log("already wide");
+        } else {
+            log("already narrow");
+        }
+        mkws.width = width;
+
+       if (width <= targetWidth &&
+           parent.hasClass("mkwsTermlist-Container-wide")) {
+           log("changing from wide to narrow: " + width);
+           $(".mkwsTermlist-Container-wide").hide();
+           $(".mkwsTermlist-Container-narrow").show();
            for (var tname in mkws.teams) {
-               $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
+                mkws.teams[tname].queue("resize-narrow").publish();
+               $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-narrow.mkwsTeam_" + tname));
                for(var i = 0; i < list.length; i++) {
                    $("." + list[i] + ".mkwsTeam_" + tname).hide();
                }
            }
-       } else if ($(window).width() > width &&
-                  parent.hasClass("mkwsTermlistContainer2")) {
-           log("changing from narrow to wide: " + $(window).width());
-           $(".mkwsTermlistContainer1").show();
-           $(".mkwsTermlistContainer2").hide();
+       } else if (width > targetWidth &&
+                  parent.hasClass("mkwsTermlist-Container-narrow")) {
+           log("changing from narrow to wide: " + width);
+           $(".mkwsTermlist-Container-wide").show();
+           $(".mkwsTermlist-Container-narrow").hide();
            for (var tname in mkws.teams) {
-               $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
+                mkws.teams[tname].queue("resize-wide").publish();
+               $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-wide.mkwsTeam_" + tname));
                for(var i = 0; i < list.length; i++) {
                    $("." + list[i] + ".mkwsTeam_" + tname).show();
                }
@@ -289,8 +409,10 @@ mkws.pagerNext = function(tname) {
            log("Service proxy auth successfully done");
            mkws.authenticated = true;
            var authName = $(data).find("displayName").text();
+           // You'd think there would be a better way to do this:
+           var realm = $(data).find("realm:not(realmAttributes realm)").text();
            for (var teamName in mkws.teams) {
-               mkws.teams[teamName].queue("authenticated").publish(authName);
+               mkws.teams[teamName].queue("authenticated").publish(authName, realm);
            }
 
            runAutoSearches();
@@ -302,31 +424,62 @@ mkws.pagerNext = function(tname) {
        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();
+    function makeWidgetsWithin(level, node) {
+        node.find('[class^="mkws"],[class*=" mkws"]').each(function() {
+            handleNodeWithTeam(this, function(tname, type) {
+                var oldHTML = this.innerHTML;
+                var myTeam = mkws.teams[tname];
+                var myWidget = widget(j, myTeam, type, this);
+                myTeam.addWidget(myWidget);
+                var newHTML = this.innerHTML;
+                if (newHTML !== oldHTML) {
+                    log("widget " + tname + ":" + type + " HTML changed from '" + oldHTML + "' to '" + newHTML + "': reparse!");
+                    makeWidgetsWithin(level+1, $(this));
+                }
+            });
+        });
+    }
+
 
-       if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
-           log("Reset query width: " + mkws_config.query_width);
-           mkws_config.query_width = 50;
+    $(document).ready(function() {
+       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);
@@ -334,12 +487,6 @@ mkws.pagerNext = function(tname) {
            $(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",
@@ -354,15 +501,6 @@ mkws.pagerNext = function(tname) {
            }
        }
 
-       // For all MKWS-classed nodes that don't have a team
-       // specified, set the team to AUTO.
-       $('[class^="mkws"],[class*=" mkws"]').each(function() {
-           if (!this.className.match(/mkwsTeam_/)) {
-               log("adding AUTO team to node with class '" + this.className + "'");
-               $(this).addClass('mkwsTeam_AUTO');
-           }
-       });
-
        // Find all nodes with an MKWS class, and determine their team from
        // the mkwsTeam_* class. Make all team objects.
        var then = $.now();
@@ -374,23 +512,26 @@ mkws.pagerNext = function(tname) {
                }
            });
        });
-       // Second pass: make the individual widget objects. This has
-       // to be done separately, and after the team-creation, since
-       // that sometimes makes new widget nodes (e.g. creating
-       // mkwsTermlists inside mkwsResults.
-       $('[class^="mkws"],[class*=" mkws"]').each(function() {
-           handleNodeWithTeam(this, function(tname, type) {
-               var myTeam = mkws.teams[tname];
-               var myWidget = widget(j, myTeam, type, this);
-           });
-       });
+
+        makeWidgetsWithin(1, $(':root'));
+        
        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);
+//        for (var tName in mkws.teams) {
+//            var myTeam = mkws.teams[tName]
+//            var types = myTeam.widgetTypes();
+//            log("TEAM '" + tName + "' = " + myTeam + " has widget types " + types);
+//            for (var i = 0; i < types.length; i++) {
+//                var type = types[i];
+//                log("  has widget of type '" + type + "': " + myTeam.widget(type));
+//            }
+//        }
+
+       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();