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