1 /*! MKWS, the MasterKey Widget Set.
2 * Copyright (C) 2013-2014 Index Data
3 * See the file LICENSE for details
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.
12 // We set it as a property of window to make the global explicit as
13 // some things complain about an implicit global.
15 $: $, // Our own local copy of the jQuery object
17 authenticating: false,
22 widgetType2function: {},
28 "Subjects": "Schlagwörter",
29 "Sources": "Daten und Quellen",
30 "source": "datenquelle",
31 "Facets": "Termlisten",
33 "Prev": "Zurück",
35 "Sort by": "Sortieren nach",
36 "and show": "und zeige",
37 "per page": "pro Seite",
38 "Displaying": "Zeige",
46 "Subject": "Schlagwort",
47 "subject": "schlagwort",
49 "Records": "Datensätze",
50 "Targets": "Datenbanken",
51 "relevance": "Relevanz",
54 "oldest": "Älteste",
60 "Authors": "Forfattere",
64 "Facets": "Termlists",
65 "Next": "Næste",
67 "Search": "Søg",
68 "Sort by": "Sorter efter",
70 "per page": "per side",
71 "Displaying": "Viser",
76 "Author": "Forfatter",
77 "author": "forfatter",
81 "Location": "Lokation",
84 "relevance": "Relevans",
94 // We may be using a separate copy
95 if (typeof(mkws_jQuery) !== "undefined") {
101 // It's ridiculous that JSNLog doesn't provide this
102 mkws.stringToLevel = function(s) {
104 return JL.getTraceLevel();
105 } else if (s === 'debug') {
106 return JL.getDebugLevel();
107 } else if (s === 'info') {
108 return JL.getInfoLevel();
109 } else if (s === 'warn') {
110 return JL.getWarnLevel();
111 } else if (s === 'error') {
112 return JL.getErrorLevel();
113 } else if (s === 'fatal') {
114 return JL.getFatalLevel();
116 throw "bad log-level '" + s + "'";
120 mkws.logger = JL('mkws');
121 var consoleAppender = JL.createConsoleAppender('consoleAppender');
122 mkws.logger.setOptions({ "appenders": [consoleAppender] });
126 var argsAsARealArray = Array.prototype.slice.call(arguments);
127 var fn = argsAsARealArray.shift();
128 fn.apply(mkws.logger, argsAsARealArray);
130 mkws.trace = function(x) { _log(mkws.logger.trace, x) };
131 mkws.debug = function(x) { _log(mkws.logger.debug, x) };
132 mkws.info = function(x) { _log(mkws.logger.info, x) };
133 mkws.warn = function(x) { _log(mkws.logger.warn, x) };
134 mkws.error = function(x) { _log(mkws.logger.error, x) };
135 mkws.fatal = function(x) { _log(mkws.logger.fatal, x) };
138 // Translation function.
139 mkws.M = function(word) {
140 var lang = mkws.config.lang;
142 if (!lang || !mkws.locale_lang[lang])
145 return mkws.locale_lang[lang][word] || word;
149 // This function is taken from a StackOverflow answer
150 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
151 mkws.getParameterByName = function(name, url) {
152 if (!url) url = location.search;
153 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
154 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
155 results = regex.exec(url);
156 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
160 mkws.registerWidgetType = function(name, fn) {
161 if(mkws._old2new.hasOwnProperty(name)) {
162 mkws.warn("registerWidgetType old widget name: " + name + " => " + mkws._old2new[name]);
163 name = mkws._old2new[name];
166 mkws.widgetType2function[name] = fn;
167 mkws.info("registered widget-type '" + name + "'");
170 mkws.aliasWidgetType = function(newName, oldName) {
171 mkws.widgetType2function[newName] = mkws.widgetType2function[oldName];
172 mkws.info("aliased widget-type '" + newName + "' to '" + oldName + "'");
176 mkws.promotionFunction = function(name) {
177 return mkws.widgetType2function[name];
181 mkws.setMkwsConfig = function(overrides) {
182 var config_default = {
183 use_service_proxy: true,
184 pazpar2_url: undefined,
185 pp2_hostname: "sp-mkws.indexdata.com",
186 pp2_path: "service-proxy/",
187 service_proxy_auth: undefined,
188 sp_auth_path: undefined,
189 sp_auth_query: "command=auth&action=perconfig",
190 sp_auth_credentials: undefined,
192 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
193 perpage_options: [10, 20, 30, 50],
194 sort_default: "relevance",
196 show_lang: true, /* show/hide language menu */
197 show_sort: true, /* show/hide sort menu */
198 show_perpage: true, /* show/hide perpage menu */
199 show_switch: true, /* show/hide switch menu */
200 lang_options: [], /* display languages links for given languages, [] for all */
201 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
202 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
203 log_level: 1, /* log level for development: 0..2 */
204 template_vars: {}, /* values that may be exposed to templates */
209 mkws.config = mkws.objectInheritingFrom(config_default);
210 for (var k in overrides) {
211 mkws.config[k] = overrides[k];
216 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
217 // http://javascript.crockford.com/prototypal.html
218 // mkws.objectInheritingFrom behaves the same as Object.create,
219 // but since the latter is not available in IE8 we can't use it.
221 mkws.objectInheritingFrom = function(o) {
228 // The following functions are dispatchers for team methods that
229 // are called from the UI using a team-name rather than implicit
231 mkws.switchView = function(tname, view) {
232 mkws.teams[tname].switchView(view);
235 mkws.showDetails = function(tname, prefixRecId) {
236 mkws.teams[tname].showDetails(prefixRecId);
239 mkws.limitTarget = function(tname, id, name) {
240 mkws.teams[tname].limitTarget(id, name);
243 mkws.limitQuery = function(tname, field, value) {
244 mkws.teams[tname].limitQuery(field, value);
247 mkws.limitCategory = function(tname, id) {
248 mkws.teams[tname].limitCategory(id);
251 mkws.delimitTarget = function(tname, id) {
252 mkws.teams[tname].delimitTarget(id);
255 mkws.delimitQuery = function(tname, field, value) {
256 mkws.teams[tname].delimitQuery(field, value);
259 mkws.showPage = function(tname, pageNum) {
260 mkws.teams[tname].showPage(pageNum);
263 mkws.pagerPrev = function(tname) {
264 mkws.teams[tname].pagerPrev();
267 mkws.pagerNext = function(tname) {
268 mkws.teams[tname].pagerNext();
272 mkws.pazpar2_url = function() {
273 if (mkws.config.pazpar2_url) {
274 mkws.info("using pre-baked pazpar2_url '" + mkws.config.pazpar2_url + "'");
275 return mkws.config.pazpar2_url;
277 var s = document.location.protocol + "//" + mkws.config.pp2_hostname + "/" + mkws.config.pp2_path;
278 mkws.info("generated pazpar2_url '" + s + "'");
284 // We put a session token in window.name, as it's the only place to
285 // keep data that is preserved across reloads and within-site
286 // navigation. pz2.js picks this up and uses it as part of the
287 // cookie-name, to ensure we get a new session when we need one.
289 // We want to use different sessions for different windows/tabs (so
290 // they don't receive each other's messages), different hosts and
291 // different paths on a host (since in general these will
292 // authenticate as different libraries). So the window name needs to
293 // include the hostname and the path from the URL, plus the token.
297 token = window.name.replace(/.*\//, '');
298 mkws.debug("Reusing existing window token '" + token + "'");
300 // Incredible that the standard JavaScript runtime doesn't define a
301 // unique windowId. Instead, we have to make one up. And since there's
302 // no global area shared between windows, the best we can do for
303 // ensuring uniqueness is generating a random ID and crossing our
306 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
307 // At one per second, it will take 116 million years to duplicate a token
308 token = Math.random().toString(36).slice(2, 12);
309 mkws.debug("Generated new window token '" + token + "'");
312 window.name = window.location.hostname + window.location.pathname + '/' + token;
313 mkws.info("Using window.name '" + window.name + "'");
316 // wrapper to provide local copy of the jQuery object.
318 var _old2new = { // Maps old-style widget names to new-style
319 'Authname': 'auth-name',
320 'ConsoleBuilder': 'console-builder',
321 'Coverart': 'cover-art',
322 'GoogleImage': 'google-image',
324 'MOTDContainer': 'motd-container',
325 'Perpage': 'per-page',
326 'SearchForm': 'search-form',
327 'ReferenceUniverse': 'reference-universe',
328 'Termlists': 'facets'
330 // Annoyingly, there is no built-in way to invert a hash
332 for (var key in _old2new) {
333 if(_old2new.hasOwnProperty(key)) {
334 _new2old[_old2new[key]] = key;
338 mkws._old2new = _old2new;
340 function handleNodeWithTeam(node, callback) {
341 // First branch for DOM objects; second branch for jQuery objects
342 var classes = node.className || node.attr('class');
344 // For some reason, if we try to proceed when classes is
345 // undefined, we don't get an error message, but this
346 // function and its callers, up several stack level,
347 // silently return. What a crock.
348 mkws.fatal("handleNodeWithTeam() called on node with no classes");
351 var list = classes.split(/\s+/)
354 for (var i = 0; i < list.length; i++) {
356 if (cname.match(/^mkws-team-/)) {
357 // New-style teamnames of the form mkws-team-xyz
358 teamName = cname.replace(/^mkws-team-/, '');
359 } else if (cname.match(/^mkwsTeam_/)) {
360 // Old-style teamnames of the form mkwsTeam_xyz
361 teamName = cname.replace(/^mkwsTeam_/, '');
362 } else if (cname.match(/^mkws-/)) {
363 // New-style names of the from mkws-foo-bar
364 type = cname.replace(/^mkws-/, '');
365 } else if (cname.match(/^mkws/)) {
366 // Old-style names of the form mkwsFooBar
367 var tmp = cname.replace(/^mkws/, '');
368 type = _old2new[tmp] || tmp.toLowerCase();
372 // Widgets without a team are on team "AUTO"
375 // Autosearch widgets don't join team AUTO if there is already an
376 // autosearch on the team or the team has otherwise gotten a query
377 if (node.getAttribute("autosearch")) {
378 if (mkws.autoHasAuto ||
379 mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) {
380 mkws.warn("AUTO team already has a query, using unique team");
383 mkws.autoHasAuto = true;
387 // Widgets on team "UNIQUE" get a random team
388 if (teamName === "UNIQUE") {
389 teamName = Math.floor(Math.random() * 100000000).toString();
392 callback.call(node, teamName, type);
396 function resizePage() {
397 var threshhold = mkws.config.responsive_design_width;
398 var width = $(window).width();
399 var from, to, method;
401 if ((mkws.width === undefined || mkws.width > threshhold) &&
402 width <= threshhold) {
403 from = "wide"; to = "narrow"; method = "hide";
404 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
405 width > threshhold) {
406 from = "narrow"; to = "wide"; method = "show";
411 mkws.info("changing from " + from + " to " + to + ": " + width);
412 for (var tname in mkws.teams) {
413 var team = mkws.teams[tname];
414 team.visitWidgets(function(t, w) {
415 var w1 = team.widget(t + "-container-" + from);
416 var w2 = team.widget(t + "-container-" + to);
422 w.node.appendTo(w2.node);
425 team.queue("resize-" + to).publish();
432 * Run service-proxy authentication in background (after page load).
433 * The username/password is configured in the apache config file
436 function authenticateSession(auth_url, auth_domain, pp2_url) {
437 mkws.authenticating = true;
438 mkws.info("service proxy authentication on URL: " + auth_url);
441 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
442 mkws.info("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
445 var request = new pzHttpRequest(auth_url, function(err) {
446 alert("HTTP call for authentication failed: " + err)
450 request.get(null, function(data) {
451 mkws.authenticating = false;
452 if (!$.isXMLDoc(data)) {
453 alert("Service Proxy authentication response is not a valid XML document");
456 var status = $(data).find("status");
457 if (status.text() != "OK") {
458 var message = $(data).find("message");
459 alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
463 mkws.info("service proxy authentication successful");
464 mkws.authenticated = true;
465 var authName = $(data).find("displayName").text();
466 // You'd think there would be a better way to do this:
467 var realm = $(data).find("realm:not(realmAttributes realm)").text();
468 for (var teamName in mkws.teams) {
469 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
477 function runAutoSearches() {
478 mkws.info("running auto searches");
480 for (var teamName in mkws.teams) {
481 mkws.teams[teamName].queue("ready").publish();
486 function selectorForAllWidgets() {
487 if (mkws.config && mkws.config.scan_all_nodes) {
488 // This is the old version, which works by telling jQuery to
489 // find every node that has a class beginning with "mkws". In
490 // theory it should be slower than the class-based selector; but
491 // instrumentation suprisingly shows this is consistently
492 // faster. It also has the advantage that any widgets of
493 // non-registered types are logged as warnings rather than
495 return '[class^="mkws"],[class*=" mkws"]';
497 // This is the new version, which works by looking up the
498 // specific classes of all registered widget types and their
499 // resize containers. Because all it requires jQuery to do is
500 // some hash lookups in pre-built tables, it should be very
501 // fast; but it silently ignores widgets of unregistered types.
503 for (var type in mkws.widgetType2function) {
505 s += '.mkws-' + type;
506 s += ',.mkws-' + type + "-container-wide";
507 s += ',.mkws-' + type + "-container-narrow";
508 // Annoyingly, we also need to recognise old-style names
509 var oldtype = _new2old[type] || type.charAt(0).toUpperCase() + type.slice(1);
510 s += ',.mkws' + oldtype;
511 s += ',.mkws' + oldtype + "-Container-wide";
512 s += ',.mkws' + oldtype + "-Container-narrow";
519 function makeWidgetsWithin(level, node) {
520 if (node) var widgetNodes = node.find(selectorForAllWidgets());
521 else widgetNodes = $(selectorForAllWidgets());
522 // Return false if we parse no widgets
523 if (widgetNodes.length < 1) return false;
524 widgetNodes.each(function() {
525 handleNodeWithTeam(this, function(tname, type) {
526 var myTeam = mkws.teams[tname];
528 myTeam = mkws.teams[tname] = mkws.makeTeam($, tname);
531 var oldHTML = this.innerHTML;
532 var myWidget = mkws.makeWidget($, myTeam, type, this);
533 myTeam.addWidget(myWidget);
534 var newHTML = this.innerHTML;
535 if (newHTML !== oldHTML) {
536 myTeam.info("widget " + type + " HTML changed: reparsing");
537 makeWidgetsWithin(level+1, $(this));
545 // The second "rootsel" parameter is passed to jQuery and is a DOM node
546 // or a selector string you would like to constrain the search for widgets to.
548 // This function has no side effects if run again on an operating session,
549 // even if the element/selector passed causes existing widgets to be reparsed:
551 // (TODO: that last bit isn't true and we currently have to avoid reinitialising
552 // widgets, MKWS-261)
554 // * configuration is not regenerated
555 // * authentication is not performed again
556 // * autosearches are not re-run
557 mkws.init = function(message, rootsel) {
558 var greet = "MKWS initialised";
559 if (rootsel) greet += " (limited to " + rootsel + ")"
560 if (message) greet += " :: " + message;
563 // MKWS is not active until init() has been run against an object with widget nodes.
564 // We only set initial configuration when MKWS is first activated.
565 if (!mkws.isActive) {
566 var widgetSelector = selectorForAllWidgets();
567 if ($(widgetSelector).length < 1) {
568 mkws.warn("no widgets found");
572 // Initial configuration
573 mkws.autoHasAuto = false;
575 if (typeof mkws_config === 'undefined') {
576 mkws.info("setting empty config");
579 mkws.info("using config: " + $.toJSON(mkws_config));
580 saved_config = mkws_config;
582 mkws.setMkwsConfig(saved_config);
584 for (var key in mkws.config) {
585 if (mkws.config.hasOwnProperty(key)) {
586 if (key.match(/^language_/)) {
587 var lang = key.replace(/^language_/, "");
588 // Copy custom languages into list
589 mkws.locale_lang[lang] = mkws.config[key];
590 mkws.info("added locally configured language '" + lang + "'");
595 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
596 if (!lang || !mkws.locale_lang[lang]) {
597 mkws.config.lang = ""
599 mkws.config.lang = lang;
602 mkws.info("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
604 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
605 if (mkws.pazpar2_url().match(/^\/\//)) {
606 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
607 mkws.info("adjusted protocol independent link to " + mkws.pazpar2_url());
610 if (mkws.config.responsive_design_width) {
611 // Responsive web design - change layout on the fly based on
612 // current screen width. Required for mobile devices.
613 $(window).resize(resizePage);
614 // initial check after page load
615 $(document).ready(resizePage);
620 // If we've made no widgets, return without starting an SP session
621 // or marking MKWS active.
622 if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) {
627 mkws.info("walking MKWS nodes took " + (now-then) + " ms");
628 for (var tName in mkws.teams) {
629 var myTeam = mkws.teams[tName]
631 myTeam.info("made PZ2 object");
633 myTeam.visitWidgets(function(t, w) {
634 mkws.debug(" has widget of type '" + t + "': " + w);
639 function sp_auth_url(config) {
640 if (config.service_proxy_auth) {
641 mkws.info("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'");
642 return config.service_proxy_auth;
645 s += config.sp_auth_hostname ? config.sp_auth_hostname : config.pp2_hostname;
647 s += config.sp_auth_path ? config.sp_auth_path : config.pp2_path;
648 var q = config.sp_auth_query;
652 var c = config.sp_auth_credentials;
654 s += ('&username=' + c.substr(0, c.indexOf('/')) +
655 '&password=' + c.substr(c.indexOf('/')+1));
657 mkws.info("generated sp_auth_url '" + s + "'");
662 if (mkws.config.use_service_proxy && !mkws.authenticated && !mkws.authenticating) {
663 authenticateSession(sp_auth_url(mkws.config),
664 mkws.config.service_proxy_auth_domain,
666 } else if (!mkws.authenticating) {
667 // raw pp2 or we have a session already open
669 for (var teamName in mkws.teams) {
670 mkws.teams[teamName].queue("authenticated").publish();
674 mkws.isActive = true;
678 $(document).ready(function() {
679 if (!window.mkws_noready && !mkws.authenticating && !mkws.active) {
684 // Set global log_level flag early so that _log() works
685 if (typeof mkws_config !== 'undefined') {
686 var tmp = mkws_config.log_level;
687 if (typeof tmp !== 'undefined') {
688 mkws.logger.setOptions({ "level": mkws.stringToLevel(tmp) });