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