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