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