Merge branch 'master' of ssh://git.indexdata.com/home/git/private/mkws
[mkws-moved-to-github.git] / src / mkws-core.js
index ccba3ef..0af84a9 100644 (file)
@@ -10,6 +10,7 @@
 // authentication, and a hash of team objects, indexed by team-name.
 //
 var mkws = {
+  $: $, // Our own local copy of the jQuery object
   authenticated: false,
   log_level: 1, // Will be overridden from mkws.config, but
                 // initial value allows jQuery popup to use logging.
@@ -145,10 +146,11 @@ mkws.setMkwsConfig = function(overrides) {
     sort_default: "relevance",
     perpage_default: 20,
     query_width: 50,
-    show_lang: true,   /* show/hide language menu */
-    show_sort: true,   /* show/hide sort menu */
-    show_perpage: true,        /* show/hide perpage menu */
-    lang_options: [],  /* display languages links for given languages, [] for all */
+    show_lang: true,    /* show/hide language menu */
+    show_sort: true,    /* show/hide sort menu */
+    show_perpage: true, /* show/hide perpage menu */
+    show_switch: true,  /* show/hide switch menu */
+    lang_options: [],   /* display languages links for given languages, [] for all */
     facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
     responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
     log_level: 1,     /* log level for development: 0..2 */
@@ -184,10 +186,10 @@ mkws.defaultTemplate = function(name) {
     <td>\
       {{md-title}}\
       {{#if md-title-remainder}}\
-       ({{md-title-remainder}})\
+        ({{md-title-remainder}})\
       {{/if}}\
       {{#if md-title-responsibility}}\
-       <i>{{md-title-responsibility}}</i>\
+        <i>{{md-title-responsibility}}</i>\
       {{/if}}\
     </td>\
   </tr>\
@@ -208,7 +210,7 @@ mkws.defaultTemplate = function(name) {
     <th>{{mkws-translate "Links"}}</th>\
     <td>\
       {{#each md-electronic-url}}\
-       <a href="{{this}}">Link{{mkws-index1}}</a>\
+        <a href="{{this}}">Link{{mkws-index1}}</a>\
       {{/each}}\
     </td>\
   </tr>\
@@ -218,10 +220,10 @@ mkws.defaultTemplate = function(name) {
     <th>{{mkws-translate "Subject"}}</th>\
     <td>\
       {{#mkws-first location having="md-subject"}}\
-       {{#if md-subject}}\
-         {{#mkws-commaList md-subject}}\
-           {{this}}{{/mkws-commaList}}\
-       {{/if}}\
+        {{#if md-subject}}\
+          {{#mkws-commaList md-subject}}\
+            {{this}}{{/mkws-commaList}}\
+        {{/if}}\
       {{/mkws-first}}\
     </td>\
   </tr>\
@@ -230,7 +232,7 @@ mkws.defaultTemplate = function(name) {
     <th>{{mkws-translate "Locations"}}</th>\
     <td>\
       {{#mkws-commaList location}}\
-       {{mkws-attr "@name"}}{{/mkws-commaList}}\
+        {{mkws-attr "@name"}}{{/mkws-commaList}}\
     </td>\
   </tr>\
 </table>\
@@ -251,9 +253,9 @@ mkws.defaultTemplate = function(name) {
     return '\
       <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
         {{#mkws-first md-thumburl}}\
-         <img src="{{this}}" alt="{{../md-title}}"/>\
+          <img src="{{this}}" alt="{{../md-title}}"/>\
         {{/mkws-first}}\
-       <br/>\
+        <br/>\
       </a>\
 ';
   }
@@ -308,8 +310,8 @@ mkws.pagerNext = function(tname) {
 };
 
 
-// wrapper to call team() after page load
-(function(j) {
+// wrapper to provide local copy of the jQuery object.
+(function($) {
   var log = mkws.log;
 
   function handleNodeWithTeam(node, callback) {
@@ -329,9 +331,9 @@ mkws.pagerNext = function(tname) {
     for (var i = 0; i < list.length; i++) {
       var cname = list[i];
       if (cname.match(/^mkwsTeam_/)) {
-       teamName = cname.replace(/^mkwsTeam_/, '');
+        teamName = cname.replace(/^mkwsTeam_/, '');
       } else if (cname.match(/^mkws/)) {
-       type = cname.replace(/^mkws/, '');
+        type = cname.replace(/^mkws/, '');
       }
     }
 
@@ -362,11 +364,11 @@ mkws.pagerNext = function(tname) {
           var w1 = team.widget(t + "-Container-" + from);
           var w2 = team.widget(t + "-Container-" + to);
           if (w1) {
-            $(w1.node).hide();
+            w1.node.hide();
           }
           if (w2) {
-            $(w2.node).show();
-           $(w.node).appendTo($(w2.node));
+            w2.node.show();
+            w.node.appendTo(w2.node);
           }
         });
         team.queue("resize-" + to).publish();
@@ -381,7 +383,7 @@ mkws.pagerNext = function(tname) {
    * for the site.
    */
   function authenticateSession(auth_url, auth_domain, pp2_url) {
-    log("Run service proxy auth URL: " + auth_url);
+    log("service proxy authentication on URL: " + auth_url);
 
     if (!auth_domain) {
       auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
@@ -395,22 +397,22 @@ mkws.pagerNext = function(tname) {
 
     request.get(null, function(data) {
       if (!$.isXMLDoc(data)) {
-       alert("service proxy auth response document is not valid XML document, give up!");
-       return;
+        alert("service proxy auth response document is not valid XML document, give up!");
+        return;
       }
       var status = $(data).find("status");
       if (status.text() != "OK") {
-       alert("service proxy auth response status: " + status.text() + ", give up!");
-       return;
+        alert("service proxy auth response status: " + status.text() + ", give up!");
+        return;
       }
 
-      log("Service proxy auth successfully done");
+      log("service proxy authentication successful");
       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, realm);
+        mkws.teams[teamName].queue("authenticated").publish(authName, realm);
       }
 
       runAutoSearches();
@@ -427,12 +429,45 @@ mkws.pagerNext = function(tname) {
   }
 
 
+  function selectorForAllWidgets() {
+    if (mkws.config && mkws.config.scan_all_nodes) {
+      // This is the old version, which works by telling jQuery to
+      // find every node that has a class beginning with "mkws". In
+      // theory it should be slower than the class-based selector; but
+      // instrumentation suprisnigly shows this is consistently
+      // faster. It also has the advantage that any widgets of
+      // non-registered types are logged as warnings rather than
+      // silently ignored.
+      return '[class^="mkws"],[class*=" mkws"]';
+    } else {
+      // This is the new version, which works by looking up the
+      // specific classes of all registered widget types and their
+      // resize containers. Because all it requires jQuery to do is
+      // some hash lookups in pre-built tables, it should be very
+      // fast; but it silently ignores widgets of unregistered types.
+      var s = "";
+      for (var type in mkws.widgetType2function) {
+       if (s) s += ',';
+       s += '.mkws' + type;
+       s += ',.mkws' + type + "-Container-wide";
+       s += ',.mkws' + type + "-Container-narrow";
+      }
+      return s;
+    }
+  }
+
+
   function makeWidgetsWithin(level, node) {
-    node.find('[class^="mkws"],[class*=" mkws"]').each(function() {
+    node.find(selectorForAllWidgets()).each(function() {
       handleNodeWithTeam(this, function(tname, type) {
-        var oldHTML = this.innerHTML;
         var myTeam = mkws.teams[tname];
-        var myWidget = widget(j, myTeam, type, this);
+        if (!myTeam) {
+          myTeam = mkws.teams[tname] = team($, tname);
+          log("made MKWS team '" + tname + "'");
+        }
+
+        var oldHTML = this.innerHTML;
+        var myWidget = widget($, myTeam, type, this);
         myTeam.addWidget(myWidget);
         var newHTML = this.innerHTML;
         if (newHTML !== oldHTML) {
@@ -444,7 +479,8 @@ mkws.pagerNext = function(tname) {
   }
 
 
-  $(document).ready(function() {
+  function init(rootsel) {
+    if (!rootsel) var rootsel = ':root';
     var saved_config;
     if (typeof mkws_config === 'undefined') {
       log("setting empty config");
@@ -457,12 +493,12 @@ mkws.pagerNext = function(tname) {
 
     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 + "'");
-       }
+        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 + "'");
+        }
       }
     }
 
@@ -473,17 +509,17 @@ mkws.pagerNext = function(tname) {
       mkws.config.lang = lang;
     }
 
-    log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
+    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: " + mkws.config.query_width);
+      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("adjust protocol independent links: " + mkws.config.pazpar2_url);
+      log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
     }
 
     if (mkws.config.responsive_design_width) {
@@ -497,38 +533,27 @@ mkws.pagerNext = function(tname) {
     // Backwards compatibility: set new magic class names on any
     // elements that have the old magic IDs.
     var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
-               "Results", "Records", "Targets", "Ranking",
-               "Termlists", "Stat", "MOTD" ];
+                "Results", "Records", "Targets", "Ranking",
+                "Termlists", "Stat", "MOTD" ];
     for (var i = 0; i < ids.length; i++) {
       var id = 'mkws' + ids[i];
       var node = $('#' + id);
       if (node.attr('id')) {
-       node.addClass(id);
-       log("added magic class to '" + node.attr('id') + "'");
+        node.addClass(id);
+        log("added magic class to '" + node.attr('id') + "'");
       }
     }
 
-    // Find all nodes with an MKWS class, and determine their team from
-    // the mkwsTeam_* class. Make all team objects.
     var then = $.now();
-    $('[class^="mkws"],[class*=" mkws"]').each(function() {
-      handleNodeWithTeam(this, function(tname, type) {
-       if (!mkws.teams[tname]) {
-         mkws.teams[tname] = team(j, tname);
-         log("Made MKWS team '" + tname + "'");
-       }
-      });
-    });
-
-    makeWidgetsWithin(1, $(':root'));
-    
+    makeWidgetsWithin(1, $(rootsel));
     var now = $.now();
-    log("Walking MKWS nodes took " + (now-then) + " ms");
+
+    log("walking MKWS nodes took " + (now-then) + " ms");
 
     /*
       for (var tName in mkws.teams) {
       var myTeam = mkws.teams[tName]
-      log("TEAM '" + tName + "' = " + myTeam + " ...");
+      log("team '" + tName + "' = " + myTeam + " ...");
       myTeam.visitWidgets(function(t, w) {
       log("  has widget of type '" + t + "': " + w);
       });
@@ -537,11 +562,15 @@ mkws.pagerNext = function(tname) {
 
     if (mkws.config.use_service_proxy) {
       authenticateSession(mkws.config.service_proxy_auth,
-                         mkws.config.service_proxy_auth_domain,
-                         mkws.config.pazpar2_url);
+                          mkws.config.service_proxy_auth_domain,
+                          mkws.config.pazpar2_url);
     } else {
       // raw pp2
       runAutoSearches();
     }
+  };
+  $(document).ready(function() {
+    var widgetSelector = selectorForAllWidgets();
+    if (widgetSelector && $(widgetSelector).length !== 0) init();
   });
 })(jQuery);