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