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