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