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