src/mkws-core.js

   1 /*! MKWS, the MasterKey Widget Set.
   2  *  Copyright (C) 2013-2014 Index Data
   3  *  See the file LICENSE for details
   4  */
   5
   6 "use strict"; // HTML5: disable for log_level >= 2
   7
   8
   9 // Set up global mkws object. Contains truly global state such as SP
  10 // authentication, and a hash of team objects, indexed by team-name.
  11 //
  12 var mkws = {
  13   $: $, // Our own local copy of the jQuery object
  14   authenticated: false,
  15   log_level: 1, // Will be overridden from mkws.config, but
  16                 // initial value allows jQuery popup to use logging.
  17   teams: {},
  18   widgetType2function: {},
  19
  20   locale_lang: {
  21     "de": {
  22       "Authors": "Autoren",
  23       "Subjects": "Schlagw&ouml;rter",
  24       "Sources": "Daten und Quellen",
  25       "source": "datenquelle",
  26       "Termlists": "Termlisten",
  27       "Next": "Weiter",
  28       "Prev": "Zur&uuml;ck",
  29       "Search": "Suche",
  30       "Sort by": "Sortieren nach",
  31       "and show": "und zeige",
  32       "per page": "pro Seite",
  33       "Displaying": "Zeige",
  34       "to": "von",
  35       "of": "aus",
  36       "found": "gefunden",
  37       "Title": "Titel",
  38       "Author": "Autor",
  39       "author": "autor",
  40       "Date": "Datum",
  41       "Subject": "Schlagwort",
  42       "subject": "schlagwort",
  43       "Location": "Ort",
  44       "Records": "Datens&auml;tze",
  45       "Targets": "Datenbanken",
  46
  47       "dummy": "dummy"
  48     },
  49
  50     "da": {
  51       "Authors": "Forfattere",
  52       "Subjects": "Emner",
  53       "Sources": "Kilder",
  54       "source": "kilder",
  55       "Termlists": "Termlists",
  56       "Next": "N&aelig;ste",
  57       "Prev": "Forrige",
  58       "Search": "S&oslash;g",
  59       "Sort by": "Sorter efter",
  60       "and show": "og vis",
  61       "per page": "per side",
  62       "Displaying": "Viser",
  63       "to": "til",
  64       "of": "ud af",
  65       "found": "fandt",
  66       "Title": "Title",
  67       "Author": "Forfatter",
  68       "author": "forfatter",
  69       "Date": "Dato",
  70       "Subject": "Emneord",
  71       "subject": "emneord",
  72       "Location": "Lokation",
  73       "Records": "Poster",
  74       "Targets": "Baser",
  75
  76       "dummy": "dummy"
  77     }
  78   }
  79 };
  80
  81
  82 mkws.log = function(string) {
  83   if (!mkws.log_level)
  84     return;
  85
  86   if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
  87     return;
  88   }
  89
  90   // you need to disable use strict at the top of the file!!!
  91   if (mkws.log_level >= 3) {
  92     // Works in Chrome; not sure about elsewhere
  93     console.trace();
  94   } else if (mkws.log_level >= 2) {
  95     console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
  96   }
  97   console.log(string);
  98 };
  99
 100
 101 // Translation function.
 102 mkws.M = function(word) {
 103   var lang = mkws.config.lang;
 104
 105   if (!lang || !mkws.locale_lang[lang])
 106     return word;
 107
 108   return mkws.locale_lang[lang][word] || word;
 109 };
 110
 111
 112 // This function is taken from a StackOverflow answer
 113 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
 114 mkws.getParameterByName = function(name) {
 115   name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
 116   var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
 117   results = regex.exec(location.search);
 118   return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
 119 }
 120
 121
 122 mkws.registerWidgetType = function(name, fn) {
 123   mkws.widgetType2function[name] = fn;
 124   mkws.log("registered widget-type '" + name + "'");
 125 };
 126
 127 mkws.promotionFunction = function(name) {
 128   return mkws.widgetType2function[name];
 129 };
 130
 131
 132 mkws.setMkwsConfig = function(overrides) {
 133   // Set global log_level flag early so that mkws.log() works
 134   // Fall back to old "debug_level" setting for backwards compatibility
 135   var tmp = overrides.log_level;
 136   if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
 137   if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
 138
 139   var config_default = {
 140     use_service_proxy: true,
 141     pazpar2_url: "//mkws.indexdata.com/service-proxy/",
 142     service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
 143     lang: "",
 144     sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
 145     perpage_options: [10, 20, 30, 50],
 146     sort_default: "relevance",
 147     perpage_default: 20,
 148     query_width: 50,
 149     show_lang: true,    /* show/hide language menu */
 150     show_sort: true,    /* show/hide sort menu */
 151     show_perpage: true, /* show/hide perpage menu */
 152     show_switch: true,  /* show/hide switch menu */
 153     lang_options: [],   /* display languages links for given languages, [] for all */
 154     facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
 155     responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
 156     log_level: 1,     /* log level for development: 0..2 */
 157
 158     dummy: "dummy"
 159   };
 160
 161   mkws.config = mkws.objectInheritingFrom(config_default);
 162   for (var k in overrides) {
 163     mkws.config[k] = overrides[k];
 164   }
 165 };
 166
 167
 168 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
 169 // http://javascript.crockford.com/prototypal.html
 170 // mkws.objectInheritingFrom behaves the same as Object.create,
 171 // but since the latter is not available in IE8 we can't use it.
 172 //
 173 mkws.objectInheritingFrom = function(o) {
 174   function F() {}
 175   F.prototype = o;
 176   return new F();
 177 }
 178
 179
 180 mkws.defaultTemplate = function(name) {
 181   if (name === 'Record') {
 182     return '\
 183 <table>\
 184   <tr>\
 185     <th>{{mkws-translate "Title"}}</th>\
 186     <td>\
 187       {{md-title}}\
 188       {{#if md-title-remainder}}\
 189         ({{md-title-remainder}})\
 190       {{/if}}\
 191       {{#if md-title-responsibility}}\
 192         <i>{{md-title-responsibility}}</i>\
 193       {{/if}}\
 194     </td>\
 195   </tr>\
 196   {{#if md-date}}\
 197   <tr>\
 198     <th>{{mkws-translate "Date"}}</th>\
 199     <td>{{md-date}}</td>\
 200   </tr>\
 201   {{/if}}\
 202   {{#if md-author}}\
 203   <tr>\
 204     <th>{{mkws-translate "Author"}}</th>\
 205     <td>{{md-author}}</td>\
 206   </tr>\
 207   {{/if}}\
 208   {{#if md-electronic-url}}\
 209   <tr>\
 210     <th>{{mkws-translate "Links"}}</th>\
 211     <td>\
 212       {{#each md-electronic-url}}\
 213         <a href="{{this}}">Link{{mkws-index1}}</a>\
 214       {{/each}}\
 215     </td>\
 216   </tr>\
 217   {{/if}}\
 218   {{#mkws-if-any location having="md-subject"}}\
 219   <tr>\
 220     <th>{{mkws-translate "Subject"}}</th>\
 221     <td>\
 222       {{#mkws-first location having="md-subject"}}\
 223         {{#if md-subject}}\
 224           {{#mkws-commaList md-subject}}\
 225             {{this}}{{/mkws-commaList}}\
 226         {{/if}}\
 227       {{/mkws-first}}\
 228     </td>\
 229   </tr>\
 230   {{/mkws-if-any}}\
 231   <tr>\
 232     <th>{{mkws-translate "Locations"}}</th>\
 233     <td>\
 234       {{#mkws-commaList location}}\
 235         {{mkws-attr "@name"}}{{/mkws-commaList}}\
 236     </td>\
 237   </tr>\
 238 </table>\
 239 ';
 240   } else if (name === "Summary") {
 241     return '\
 242 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 243   <b>{{md-title}}</b>\
 244 </a>\
 245 {{#if md-title-remainder}}\
 246   <span>{{md-title-remainder}}</span>\
 247 {{/if}}\
 248 {{#if md-title-responsibility}}\
 249   <span><i>{{md-title-responsibility}}</i></span>\
 250 {{/if}}\
 251 ';
 252   } else if (name === "Image") {
 253     return '\
 254       <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
 255         {{#mkws-first md-thumburl}}\
 256           <img src="{{this}}" alt="{{../md-title}}"/>\
 257         {{/mkws-first}}\
 258         <br/>\
 259       </a>\
 260 ';
 261   }
 262
 263   var s = "There is no default '" + name +"' template!";
 264   alert(s);
 265   return s;
 266 };
 267
 268
 269 // The following functions are dispatchers for team methods that
 270 // are called from the UI using a team-name rather than implicit
 271 // context.
 272 mkws.switchView = function(tname, view) {
 273   mkws.teams[tname].switchView(view);
 274 };
 275
 276 mkws.showDetails = function(tname, prefixRecId) {
 277   mkws.teams[tname].showDetails(prefixRecId);
 278 };
 279
 280 mkws.limitTarget  = function(tname, id, name) {
 281   mkws.teams[tname].limitTarget(id, name);
 282 };
 283
 284 mkws.limitQuery  = function(tname, field, value) {
 285   mkws.teams[tname].limitQuery(field, value);
 286 };
 287
 288 mkws.limitCategory  = function(tname, id) {
 289   mkws.teams[tname].limitCategory(id);
 290 };
 291
 292 mkws.delimitTarget = function(tname, id) {
 293   mkws.teams[tname].delimitTarget(id);
 294 };
 295
 296 mkws.delimitQuery = function(tname, field, value) {
 297   mkws.teams[tname].delimitQuery(field, value);
 298 };
 299
 300 mkws.showPage = function(tname, pageNum) {
 301   mkws.teams[tname].showPage(pageNum);
 302 };
 303
 304 mkws.pagerPrev = function(tname) {
 305   mkws.teams[tname].pagerPrev();
 306 };
 307
 308 mkws.pagerNext = function(tname) {
 309   mkws.teams[tname].pagerNext();
 310 };
 311
 312
 313 // wrapper to provide local copy of the jQuery object.
 314 (function($) {
 315   var log = mkws.log;
 316
 317   function handleNodeWithTeam(node, callback) {
 318     // First branch for DOM objects; second branch for jQuery objects
 319     var classes = node.className || node.attr('class');
 320     if (!classes) {
 321       // For some reason, if we try to proceed when classes is
 322       // undefined, we don't get an error message, but this
 323       // function and its callers, up several stack level,
 324       // silently return. What a crock.
 325       log("handleNodeWithTeam() called on node with no classes");
 326       return;
 327     }
 328     var list = classes.split(/\s+/)
 329     var teamName, type;
 330
 331     for (var i = 0; i < list.length; i++) {
 332       var cname = list[i];
 333       if (cname.match(/^mkwsTeam_/)) {
 334         teamName = cname.replace(/^mkwsTeam_/, '');
 335       } else if (cname.match(/^mkws/)) {
 336         type = cname.replace(/^mkws/, '');
 337       }
 338     }
 339
 340     if (!teamName) teamName = "AUTO";
 341     callback.call(node, teamName, type);
 342   }
 343
 344
 345   function resizePage() {
 346     var threshhold = mkws.config.responsive_design_width;
 347     var width = $(window).width();
 348     var from, to, method;
 349
 350     if ((mkws.width === undefined || mkws.width > threshhold) &&
 351         width <= threshhold) {
 352       from = "wide"; to = "narrow"; method = "hide";
 353     } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
 354                width > threshhold) {
 355       from = "narrow"; to = "wide"; method = "show";
 356     }
 357     mkws.width = width;
 358
 359     if (from) {
 360       log("changing from " + from + " to " + to + ": " + width);
 361       for (var tname in mkws.teams) {
 362         var team = mkws.teams[tname];
 363         team.visitWidgets(function(t, w) {
 364           var w1 = team.widget(t + "-Container-" + from);
 365           var w2 = team.widget(t + "-Container-" + to);
 366           if (w1) {
 367             w1.jqnode.hide();
 368           }
 369           if (w2) {
 370             w2.jqnode.show();
 371             w.jqnode.appendTo(w2.jqnode);
 372           }
 373         });
 374         team.queue("resize-" + to).publish();
 375       }
 376     }
 377   };
 378
 379
 380   /*
 381    * Run service-proxy authentication in background (after page load).
 382    * The username/password is configured in the apache config file
 383    * for the site.
 384    */
 385   function authenticateSession(auth_url, auth_domain, pp2_url) {
 386     log("service proxy authentication on URL: " + auth_url);
 387
 388     if (!auth_domain) {
 389       auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
 390       log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
 391     }
 392
 393     var request = new pzHttpRequest(auth_url, function(err) {
 394       alert("HTTP call for authentication failed: " + err)
 395       return;
 396     }, auth_domain);
 397
 398     request.get(null, function(data) {
 399       if (!$.isXMLDoc(data)) {
 400         alert("service proxy auth response document is not valid XML document, give up!");
 401         return;
 402       }
 403       var status = $(data).find("status");
 404       if (status.text() != "OK") {
 405         alert("service proxy auth response status: " + status.text() + ", give up!");
 406         return;
 407       }
 408
 409       log("service proxy authentication successful");
 410       mkws.authenticated = true;
 411       var authName = $(data).find("displayName").text();
 412       // You'd think there would be a better way to do this:
 413       var realm = $(data).find("realm:not(realmAttributes realm)").text();
 414       for (var teamName in mkws.teams) {
 415         mkws.teams[teamName].queue("authenticated").publish(authName, realm);
 416       }
 417
 418       runAutoSearches();
 419     });
 420   }
 421
 422
 423   function runAutoSearches() {
 424     log("running auto searches");
 425
 426     for (var teamName in mkws.teams) {
 427       mkws.teams[teamName].queue("ready").publish();
 428     }
 429   }
 430
 431
 432   function selectorForAllWidgets() {
 433     if (mkws.config.scan_all_nodes) {
 434       // This is the old version, which works by telling jQuery to
 435       // find every node that has a class beginning with "mkws". In
 436       // theory it should be slower than the class-based selector; but
 437       // instrumentation suprisnigly shows this is consistently
 438       // faster. It also has the advantage that any widgets of
 439       // non-registered types are logged as warnings rather than
 440       // silently ignored.
 441       return '[class^="mkws"],[class*=" mkws"]';
 442     } else {
 443       // This is the new version, which works by looking up the
 444       // specific classes of all registered widget types and their
 445       // resize containers. Because all it requires jQuery to do is
 446       // some hash lookups in pre-built tables, it should be very
 447       // fast; but it silently ignores widgets of unregistered types.
 448       var s = "";
 449       for (var type in mkws.widgetType2function) {
 450         if (s) s += ',';
 451         s += '.mkws' + type;
 452         s += ',.mkws' + type + "-Container-wide";
 453         s += ',.mkws' + type + "-Container-narrow";
 454       }
 455       return s;
 456     }
 457   }
 458
 459
 460   function makeWidgetsWithin(level, node) {
 461     node.find(selectorForAllWidgets()).each(function() {
 462       handleNodeWithTeam(this, function(tname, type) {
 463         var myTeam = mkws.teams[tname];
 464         if (!myTeam) {
 465           myTeam = mkws.teams[tname] = team($, tname);
 466           log("made MKWS team '" + tname + "'");
 467         }
 468
 469         var oldHTML = this.innerHTML;
 470         var myWidget = widget($, myTeam, type, this);
 471         myTeam.addWidget(myWidget);
 472         var newHTML = this.innerHTML;
 473         if (newHTML !== oldHTML) {
 474           log("widget " + tname + ":" + type + " HTML changed: reparsing");
 475           makeWidgetsWithin(level+1, $(this));
 476         }
 477       });
 478     });
 479   }
 480
 481
 482   $(document).ready(function() {
 483     var saved_config;
 484     if (typeof mkws_config === 'undefined') {
 485       log("setting empty config");
 486       saved_config = {};
 487     } else {
 488       log("using config: " + $.toJSON(mkws_config));
 489       saved_config = mkws_config;
 490     }
 491     mkws.setMkwsConfig(saved_config);
 492
 493     for (var key in mkws.config) {
 494       if (mkws.config.hasOwnProperty(key)) {
 495         if (key.match(/^language_/)) {
 496           var lang = key.replace(/^language_/, "");
 497           // Copy custom languages into list
 498           mkws.locale_lang[lang] = mkws.config[key];
 499           log("added locally configured language '" + lang + "'");
 500         }
 501       }
 502     }
 503
 504     var lang = mkws.getParameterByName("lang") || mkws.config.lang;
 505     if (!lang || !mkws.locale_lang[lang]) {
 506       mkws.config.lang = ""
 507     } else {
 508       mkws.config.lang = lang;
 509     }
 510
 511     log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
 512
 513     if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
 514       log("reset query width to " + mkws.config.query_width);
 515       mkws.config.query_width = 50;
 516     }
 517
 518     // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
 519     if (mkws.config.pazpar2_url.match(/^\/\//)) {
 520       mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
 521       log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
 522     }
 523
 524     if (mkws.config.responsive_design_width) {
 525       // Responsive web design - change layout on the fly based on
 526       // current screen width. Required for mobile devices.
 527       $(window).resize(resizePage);
 528       // initial check after page load
 529       $(document).ready(resizePage);
 530     }
 531
 532     // Backwards compatibility: set new magic class names on any
 533     // elements that have the old magic IDs.
 534     var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
 535                 "Results", "Records", "Targets", "Ranking",
 536                 "Termlists", "Stat", "MOTD" ];
 537     for (var i = 0; i < ids.length; i++) {
 538       var id = 'mkws' + ids[i];
 539       var node = $('#' + id);
 540       if (node.attr('id')) {
 541         node.addClass(id);
 542         log("added magic class to '" + node.attr('id') + "'");
 543       }
 544     }
 545
 546     var then = $.now();
 547     makeWidgetsWithin(1, $(':root'));
 548     var now = $.now();
 549
 550     log("walking MKWS nodes took " + (now-then) + " ms");
 551
 552     /*
 553       for (var tName in mkws.teams) {
 554       var myTeam = mkws.teams[tName]
 555       log("TEAM '" + tName + "' = " + myTeam + " ...");
 556       myTeam.visitWidgets(function(t, w) {
 557       log("  has widget of type '" + t + "': " + w);
 558       });
 559       }
 560     */
 561
 562     if (mkws.config.use_service_proxy) {
 563       authenticateSession(mkws.config.service_proxy_auth,
 564                           mkws.config.service_proxy_auth_domain,
 565                           mkws.config.pazpar2_url);
 566     } else {
 567       // raw pp2
 568       runAutoSearches();
 569     }
 570   });
 571 })(jQuery);