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