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",
56 "Authors": "Forfattere",
60 "Facets": "Termlists",
61 "Next": "Næste",
63 "Search": "Søg",
64 "Sort by": "Sorter efter",
66 "per page": "per side",
67 "Displaying": "Viser",
72 "Author": "Forfatter",
73 "author": "forfatter",
77 "Location": "Lokation",
86 // We may be using a separate copy
87 if (typeof(mkws_jQuery) !== "undefined") {
93 // It's ridiculous that JSNLog doesn't provide this
94 mkws.stringToLevel = function(s) {
96 return JL.getTraceLevel();
97 } else if (s === 'debug') {
98 return JL.getDebugLevel();
99 } else if (s === 'info') {
100 return JL.getInfoLevel();
101 } else if (s === 'warn') {
102 return JL.getWarnLevel();
103 } else if (s === 'error') {
104 return JL.getErrorLevel();
105 } else if (s === 'fatal') {
106 return JL.getFatalLevel();
108 throw "bad log-level '" + s + "'";
112 mkws.logger = JL('mkws');
113 var consoleAppender = JL.createConsoleAppender('consoleAppender');
114 mkws.logger.setOptions({ "appenders": [consoleAppender] });
117 function _log(fn, string) {
121 // you need to disable use strict at the top of the file!!!
122 if (mkws.log_level >= 3) {
123 // Works in Chrome; not sure about elsewhere
125 } else if (mkws.log_level >= 2) {
128 fn.call(mkws.logger, string);
132 mkws.trace = function(x) { _log(mkws.logger.trace, x) };
133 mkws.debug = function(x) { _log(mkws.logger.debug, x) };
134 mkws.info = function(x) { _log(mkws.logger.info, x) };
135 mkws.warn = function(x) { _log(mkws.logger.warn, x) };
136 mkws.error = function(x) { _log(mkws.logger.error, x) };
137 mkws.fatal = function(x) { _log(mkws.logger.fatal, x) };
140 // Translation function.
141 mkws.M = function(word) {
142 var lang = mkws.config.lang;
144 if (!lang || !mkws.locale_lang[lang])
147 return mkws.locale_lang[lang][word] || word;
151 // This function is taken from a StackOverflow answer
152 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
153 mkws.getParameterByName = function(name, url) {
154 if (!url) url = location.search;
155 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
156 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
157 results = regex.exec(url);
158 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
162 mkws.registerWidgetType = function(name, fn) {
163 if(mkws._old2new.hasOwnProperty(name)) {
164 mkws.warn("registerWidgetType old widget name: " + name + " => " + mkws._old2new[name]);
165 name = mkws._old2new[name];
168 mkws.widgetType2function[name] = fn;
169 mkws.info("registered widget-type '" + name + "'");
172 mkws.promotionFunction = function(name) {
173 return mkws.widgetType2function[name];
177 mkws.setMkwsConfig = function(overrides) {
178 // Set global log_level flag early so that _log() works
179 var tmp = overrides.log_level;
180 if (typeof(tmp) !== 'undefined') {
181 console.log("setting level to '" + tmp + "'");
182 mkws.logger.setOptions({ "level": mkws.stringToLevel(tmp) });
185 var config_default = {
186 use_service_proxy: true,
187 pazpar2_url: undefined,
188 pp2_hostname: "sp-mkws.indexdata.com",
189 pp2_path: "service-proxy/",
190 service_proxy_auth: undefined,
191 sp_auth_path: undefined,
192 sp_auth_query: "command=auth&action=perconfig",
193 sp_auth_credentials: undefined,
195 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
196 perpage_options: [10, 20, 30, 50],
197 sort_default: "relevance",
199 show_lang: true, /* show/hide language menu */
200 show_sort: true, /* show/hide sort menu */
201 show_perpage: true, /* show/hide perpage menu */
202 show_switch: true, /* show/hide switch menu */
203 lang_options: [], /* display languages links for given languages, [] for all */
204 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
205 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
206 log_level: 1, /* log level for development: 0..2 */
207 template_vars: {}, /* values that may be exposed to templates */
212 mkws.config = mkws.objectInheritingFrom(config_default);
213 for (var k in overrides) {
214 mkws.config[k] = overrides[k];
219 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
220 // http://javascript.crockford.com/prototypal.html
221 // mkws.objectInheritingFrom behaves the same as Object.create,
222 // but since the latter is not available in IE8 we can't use it.
224 mkws.objectInheritingFrom = function(o) {
231 // The following functions are dispatchers for team methods that
232 // are called from the UI using a team-name rather than implicit
234 mkws.switchView = function(tname, view) {
235 mkws.teams[tname].switchView(view);
238 mkws.showDetails = function(tname, prefixRecId) {
239 mkws.teams[tname].showDetails(prefixRecId);
242 mkws.limitTarget = function(tname, id, name) {
243 mkws.teams[tname].limitTarget(id, name);
246 mkws.limitQuery = function(tname, field, value) {
247 mkws.teams[tname].limitQuery(field, value);
250 mkws.limitCategory = function(tname, id) {
251 mkws.teams[tname].limitCategory(id);
254 mkws.delimitTarget = function(tname, id) {
255 mkws.teams[tname].delimitTarget(id);
258 mkws.delimitQuery = function(tname, field, value) {
259 mkws.teams[tname].delimitQuery(field, value);
262 mkws.showPage = function(tname, pageNum) {
263 mkws.teams[tname].showPage(pageNum);
266 mkws.pagerPrev = function(tname) {
267 mkws.teams[tname].pagerPrev();
270 mkws.pagerNext = function(tname) {
271 mkws.teams[tname].pagerNext();
275 mkws.pazpar2_url = function() {
276 if (mkws.config.pazpar2_url) {
277 mkws.info("using pre-baked pazpar2_url '" + mkws.config.pazpar2_url + "'");
278 return mkws.config.pazpar2_url;
280 var s = document.location.protocol + "//" + mkws.config.pp2_hostname + "/" + mkws.config.pp2_path;
281 mkws.info("generated pazpar2_url '" + s + "'");
287 // We put a session token in window.name, as it's the only place to
288 // keep data that is preserved across reloads and within-site
289 // navigation. pz2.js picks this up and uses it as part of the
290 // cookie-name, to ensure we get a new session when we need one.
292 // We want to use different sessions for different windows/tabs (so
293 // they don't receive each other's messages), different hosts and
294 // different paths on a host (since in general these will
295 // authenticate as different libraries). So the window name needs to
296 // include the hostname and the path from the URL, plus the token.
300 token = window.name.replace(/.*\//, '');
301 mkws.debug("Reusing existing window token '" + token + "'");
303 // Incredible that the standard JavaScript runtime doesn't define a
304 // unique windowId. Instead, we have to make one up. And since there's
305 // no global area shared between windows, the best we can do for
306 // ensuring uniqueness is generating a random ID and crossing our
309 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
310 // At one per second, it will take 116 million years to duplicate a token
311 token = Math.random().toString(36).slice(2, 12);
312 mkws.debug("Generated new window token '" + token + "'");
315 window.name = window.location.hostname + window.location.pathname + '/' + token;
316 mkws.info("Using window.name '" + window.name + "'");
319 // wrapper to provide local copy of the jQuery object.
321 var _old2new = { // Maps old-style widget names to new-style
322 'Authname': 'auth-name',
323 'ConsoleBuilder': 'console-builder',
324 'Coverart': 'cover-art',
325 'GoogleImage': 'google-image',
327 'MOTDContainer': 'motd-container',
328 'Perpage': 'per-page',
329 'SearchForm': 'search-form',
330 'ReferenceUniverse': 'reference-universe',
331 'Termlists': 'facets'
333 // Annoyingly, there is no built-in way to invert a hash
335 for (var key in _old2new) {
336 if(_old2new.hasOwnProperty(key)) {
337 _new2old[_old2new[key]] = key;
341 mkws._old2new = _old2new;
343 function handleNodeWithTeam(node, callback) {
344 // First branch for DOM objects; second branch for jQuery objects
345 var classes = node.className || node.attr('class');
347 // For some reason, if we try to proceed when classes is
348 // undefined, we don't get an error message, but this
349 // function and its callers, up several stack level,
350 // silently return. What a crock.
351 mkws.fatal("handleNodeWithTeam() called on node with no classes");
354 var list = classes.split(/\s+/)
357 for (var i = 0; i < list.length; i++) {
359 if (cname.match(/^mkws-team-/)) {
360 // New-style teamnames of the form mkws-team-xyz
361 teamName = cname.replace(/^mkws-team-/, '');
362 } else if (cname.match(/^mkwsTeam_/)) {
363 // Old-style teamnames of the form mkwsTeam_xyz
364 teamName = cname.replace(/^mkwsTeam_/, '');
365 } else if (cname.match(/^mkws-/)) {
366 // New-style names of the from mkws-foo-bar
367 type = cname.replace(/^mkws-/, '');
368 } else if (cname.match(/^mkws/)) {
369 // Old-style names of the form mkwsFooBar
370 var tmp = cname.replace(/^mkws/, '');
371 type = _old2new[tmp] || tmp.toLowerCase();
375 // Widgets without a team are on team "AUTO"
378 // Autosearch widgets don't join team AUTO if there is already an
379 // autosearch on the team or the team has otherwise gotten a query
380 if (node.getAttribute("autosearch")) {
381 if (mkws.autoHasAuto ||
382 mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) {
383 mkws.warn("AUTO team already has a query, using unique team");
386 mkws.autoHasAuto = true;
390 // Widgets on team "UNIQUE" get a random team
391 if (teamName === "UNIQUE") {
392 teamName = Math.floor(Math.random() * 100000000).toString();
395 callback.call(node, teamName, type);
399 function resizePage() {
400 var threshhold = mkws.config.responsive_design_width;
401 var width = $(window).width();
402 var from, to, method;
404 if ((mkws.width === undefined || mkws.width > threshhold) &&
405 width <= threshhold) {
406 from = "wide"; to = "narrow"; method = "hide";
407 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
408 width > threshhold) {
409 from = "narrow"; to = "wide"; method = "show";
414 mkws.info("changing from " + from + " to " + to + ": " + width);
415 for (var tname in mkws.teams) {
416 var team = mkws.teams[tname];
417 team.visitWidgets(function(t, w) {
418 var w1 = team.widget(t + "-container-" + from);
419 var w2 = team.widget(t + "-container-" + to);
425 w.node.appendTo(w2.node);
428 team.queue("resize-" + to).publish();
435 * Run service-proxy authentication in background (after page load).
436 * The username/password is configured in the apache config file
439 function authenticateSession(auth_url, auth_domain, pp2_url) {
440 mkws.authenticating = true;
441 mkws.info("service proxy authentication on URL: " + auth_url);
444 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
445 mkws.info("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
448 var request = new pzHttpRequest(auth_url, function(err) {
449 alert("HTTP call for authentication failed: " + err)
453 request.get(null, function(data) {
454 mkws.authenticating = false;
455 if (!$.isXMLDoc(data)) {
456 alert("Service Proxy authentication response is not a valid XML document");
459 var status = $(data).find("status");
460 if (status.text() != "OK") {
461 var message = $(data).find("message");
462 alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
466 mkws.info("service proxy authentication successful");
467 mkws.authenticated = true;
468 var authName = $(data).find("displayName").text();
469 // You'd think there would be a better way to do this:
470 var realm = $(data).find("realm:not(realmAttributes realm)").text();
471 for (var teamName in mkws.teams) {
472 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
480 function runAutoSearches() {
481 mkws.info("running auto searches");
483 for (var teamName in mkws.teams) {
484 mkws.teams[teamName].queue("ready").publish();
489 function selectorForAllWidgets() {
490 if (mkws.config && mkws.config.scan_all_nodes) {
491 // This is the old version, which works by telling jQuery to
492 // find every node that has a class beginning with "mkws". In
493 // theory it should be slower than the class-based selector; but
494 // instrumentation suprisingly shows this is consistently
495 // faster. It also has the advantage that any widgets of
496 // non-registered types are logged as warnings rather than
498 return '[class^="mkws"],[class*=" mkws"]';
500 // This is the new version, which works by looking up the
501 // specific classes of all registered widget types and their
502 // resize containers. Because all it requires jQuery to do is
503 // some hash lookups in pre-built tables, it should be very
504 // fast; but it silently ignores widgets of unregistered types.
506 for (var type in mkws.widgetType2function) {
508 s += '.mkws-' + type;
509 s += ',.mkws-' + type + "-container-wide";
510 s += ',.mkws-' + type + "-container-narrow";
511 // Annoyingly, we also need to recognise old-style names
512 var oldtype = _new2old[type] || type.charAt(0).toUpperCase() + type.slice(1);
513 s += ',.mkws' + oldtype;
514 s += ',.mkws' + oldtype + "-Container-wide";
515 s += ',.mkws' + oldtype + "-Container-narrow";
522 function makeWidgetsWithin(level, node) {
523 if (node) var widgetNodes = node.find(selectorForAllWidgets());
524 else widgetNodes = $(selectorForAllWidgets());
525 // Return false if we parse no widgets
526 if (widgetNodes.length < 1) return false;
527 widgetNodes.each(function() {
528 handleNodeWithTeam(this, function(tname, type) {
529 var myTeam = mkws.teams[tname];
531 myTeam = mkws.teams[tname] = mkws.makeTeam($, tname);
534 var oldHTML = this.innerHTML;
535 var myWidget = mkws.makeWidget($, myTeam, type, this);
536 myTeam.addWidget(myWidget);
537 var newHTML = this.innerHTML;
538 if (newHTML !== oldHTML) {
539 myTeam.info("widget " + type + " HTML changed: reparsing");
540 makeWidgetsWithin(level+1, $(this));
548 // The second "rootsel" parameter is passed to jQuery and is a DOM node
549 // or a selector string you would like to constrain the search for widgets to.
551 // This function has no side effects if run again on an operating session,
552 // even if the element/selector passed causes existing widgets to be reparsed:
554 // (TODO: that last bit isn't true and we currently have to avoid reinitialising
555 // widgets, MKWS-261)
557 // * configuration is not regenerated
558 // * authentication is not performed again
559 // * autosearches are not re-run
560 mkws.init = function(message, rootsel) {
561 var greet = "MKWS initialised";
562 if (rootsel) greet += " (limited to " + rootsel + ")"
563 if (message) greet += " :: " + message;
566 // MKWS is not active until init() has been run against an object with widget nodes.
567 // We only set initial configuration when MKWS is first activated.
568 if (!mkws.isActive) {
569 var widgetSelector = selectorForAllWidgets();
570 if ($(widgetSelector).length < 1) {
571 mkws.warn("no widgets found");
575 // Initial configuration
576 mkws.autoHasAuto = false;
578 if (typeof mkws_config === 'undefined') {
579 mkws.info("setting empty config");
582 mkws.info("using config: " + $.toJSON(mkws_config));
583 saved_config = mkws_config;
585 mkws.setMkwsConfig(saved_config);
587 for (var key in mkws.config) {
588 if (mkws.config.hasOwnProperty(key)) {
589 if (key.match(/^language_/)) {
590 var lang = key.replace(/^language_/, "");
591 // Copy custom languages into list
592 mkws.locale_lang[lang] = mkws.config[key];
593 mkws.info("added locally configured language '" + lang + "'");
598 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
599 if (!lang || !mkws.locale_lang[lang]) {
600 mkws.config.lang = ""
602 mkws.config.lang = lang;
605 mkws.info("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
607 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
608 if (mkws.pazpar2_url().match(/^\/\//)) {
609 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
610 mkws.info("adjusted protocol independent link to " + mkws.pazpar2_url());
613 if (mkws.config.responsive_design_width) {
614 // Responsive web design - change layout on the fly based on
615 // current screen width. Required for mobile devices.
616 $(window).resize(resizePage);
617 // initial check after page load
618 $(document).ready(resizePage);
623 // If we've made no widgets, return without starting an SP session
624 // or marking MKWS active.
625 if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) {
630 mkws.info("walking MKWS nodes took " + (now-then) + " ms");
631 for (var tName in mkws.teams) {
632 var myTeam = mkws.teams[tName]
634 myTeam.info("made PZ2 object");
636 myTeam.visitWidgets(function(t, w) {
637 mkws.debug(" has widget of type '" + t + "': " + w);
642 function sp_auth_url(config) {
643 if (config.service_proxy_auth) {
644 mkws.info("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'");
645 return config.service_proxy_auth;
648 s += config.sp_auth_hostname ? config.sp_auth_hostname : config.pp2_hostname;
650 s += config.sp_auth_path ? config.sp_auth_path : config.pp2_path;
651 var q = config.sp_auth_query;
655 var c = config.sp_auth_credentials;
657 s += ('&username=' + c.substr(0, c.indexOf('/')) +
658 '&password=' + c.substr(c.indexOf('/')+1));
660 mkws.info("generated sp_auth_url '" + s + "'");
665 if (mkws.config.use_service_proxy && !mkws.authenticated && !mkws.authenticating) {
666 authenticateSession(sp_auth_url(mkws.config),
667 mkws.config.service_proxy_auth_domain,
669 } else if (!mkws.authenticating) {
670 // raw pp2 or we have a session already open
674 mkws.isActive = true;
678 $(document).ready(function() {
679 if (!window.mkws_noready && !mkws.authenticating && !mkws.active) {