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