1 /*! MKWS, the MasterKey Widget Set.
2 * Copyright (C) 2013-2014 Index Data
3 * See the file LICENSE for details
6 "use strict"; // HTML5: disable for log_level >= 2
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,
19 log_level: 1, // Will be overridden from mkws.config, but
20 // initial value allows jQuery popup to use logging.
22 widgetType2function: {},
27 "Subjects": "Schlagwörter",
28 "Sources": "Daten und Quellen",
29 "source": "datenquelle",
30 "Termlists": "Termlisten",
32 "Prev": "Zurück",
34 "Sort by": "Sortieren nach",
35 "and show": "und zeige",
36 "per page": "pro Seite",
37 "Displaying": "Zeige",
45 "Subject": "Schlagwort",
46 "subject": "schlagwort",
48 "Records": "Datensätze",
49 "Targets": "Datenbanken",
55 "Authors": "Forfattere",
59 "Termlists": "Termlists",
60 "Next": "Næste",
62 "Search": "Søg",
63 "Sort by": "Sorter efter",
65 "per page": "per side",
66 "Displaying": "Viser",
71 "Author": "Forfatter",
72 "author": "forfatter",
76 "Location": "Lokation",
85 // We may be using a separate copy
86 if (typeof(mkws_jQuery) !== "undefined") {
92 mkws.log = function(string) {
96 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
100 // you need to disable use strict at the top of the file!!!
101 if (mkws.log_level >= 3) {
102 // Works in Chrome; not sure about elsewhere
104 } else if (mkws.log_level >= 2) {
105 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
111 // Incredible that the standard JavaScript runtime doesn't define a
112 // unique windowId. Instead, we have to make one up. And since there's
113 // no global area shared between windows, the best we can do for
114 // ensuring uniqueness is generating a random ID and crossing our
115 // fingers. We stash this in window.name, as it's the only place to
116 // keep data that is preserved across reloads and within-site
117 // navigation. pz2.js picks this up and uses it as part of the
118 // cookie-name, to ensure each tab gets its own session.
120 mkws.log("Using existing window.name '" + window.name + "'");
122 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
123 // At one per second, it will take 116 million years to duplicate a session
124 window.name = Math.random().toString(36).slice(2, 12);
125 mkws.log("Generated new window.name '" + window.name + "'");
129 // Translation function.
130 mkws.M = function(word) {
131 var lang = mkws.config.lang;
133 if (!lang || !mkws.locale_lang[lang])
136 return mkws.locale_lang[lang][word] || word;
140 // This function is taken from a StackOverflow answer
141 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
142 mkws.getParameterByName = function(name, url) {
143 if (!url) url = location.search;
144 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
145 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
146 results = regex.exec(url);
147 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
151 mkws.registerWidgetType = function(name, fn) {
152 mkws.widgetType2function[name] = fn;
153 mkws.log("registered widget-type '" + name + "'");
156 mkws.promotionFunction = function(name) {
157 return mkws.widgetType2function[name];
161 mkws.setMkwsConfig = function(overrides) {
162 // Set global log_level flag early so that mkws.log() works
163 // Fall back to old "debug_level" setting for backwards compatibility
164 var tmp = overrides.log_level;
165 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
166 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
168 var config_default = {
169 use_service_proxy: true,
170 pazpar2_url: undefined,
171 pp2_hostname: "mkws.indexdata.com",
172 pp2_path: "service-proxy",
173 service_proxy_auth: undefined,
174 sp_auth_path: "service-proxy-auth",
175 sp_auth_query: undefined, // Will be: "command=auth&action=perconfig",
176 sp_auth_credentials: undefined,
178 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
179 perpage_options: [10, 20, 30, 50],
180 sort_default: "relevance",
183 show_lang: true, /* show/hide language menu */
184 show_sort: true, /* show/hide sort menu */
185 show_perpage: true, /* show/hide perpage menu */
186 show_switch: true, /* show/hide switch menu */
187 lang_options: [], /* display languages links for given languages, [] for all */
188 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
189 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
190 log_level: 1, /* log level for development: 0..2 */
195 mkws.config = mkws.objectInheritingFrom(config_default);
196 for (var k in overrides) {
197 mkws.config[k] = overrides[k];
202 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
203 // http://javascript.crockford.com/prototypal.html
204 // mkws.objectInheritingFrom behaves the same as Object.create,
205 // but since the latter is not available in IE8 we can't use it.
207 mkws.objectInheritingFrom = function(o) {
214 mkws.defaultTemplate = function(name) {
215 if (name === 'Record') {
219 <th>{{mkws-translate "Title"}}</th>\
222 {{#if md-title-remainder}}\
223 ({{md-title-remainder}})\
225 {{#if md-title-responsibility}}\
226 <i>{{md-title-responsibility}}</i>\
232 <th>{{mkws-translate "Date"}}</th>\
233 <td>{{md-date}}</td>\
238 <th>{{mkws-translate "Author"}}</th>\
239 <td>{{md-author}}</td>\
242 {{#if md-electronic-url}}\
244 <th>{{mkws-translate "Links"}}</th>\
246 {{#each md-electronic-url}}\
247 <a href="{{this}}">Link{{mkws-index1}}</a>\
252 {{#mkws-if-any location having="md-subject"}}\
254 <th>{{mkws-translate "Subject"}}</th>\
256 {{#mkws-first location having="md-subject"}}\
258 {{#mkws-commaList md-subject}}\
259 {{this}}{{/mkws-commaList}}\
266 <th>{{mkws-translate "Locations"}}</th>\
268 {{#mkws-commaList location}}\
269 {{mkws-attr "@name"}}{{/mkws-commaList}}\
274 } else if (name === "Summary") {
276 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
279 {{#if md-title-remainder}}\
280 <span>{{md-title-remainder}}</span>\
282 {{#if md-title-responsibility}}\
283 <span><i>{{md-title-responsibility}}</i></span>\
285 {{#if md-date}}, {{md-date}}\
287 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
290 <span>, {{md-medium}}</span>\
294 } else if (name === "Image") {
296 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
297 {{#mkws-first md-thumburl}}\
298 <img src="{{this}}" alt="{{../md-title}}"/>\
303 } else if (name === 'Facet') {
307 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
310 <span>{{count}}</span>\
318 // The following functions are dispatchers for team methods that
319 // are called from the UI using a team-name rather than implicit
321 mkws.switchView = function(tname, view) {
322 mkws.teams[tname].switchView(view);
325 mkws.showDetails = function(tname, prefixRecId) {
326 mkws.teams[tname].showDetails(prefixRecId);
329 mkws.limitTarget = function(tname, id, name) {
330 mkws.teams[tname].limitTarget(id, name);
333 mkws.limitQuery = function(tname, field, value) {
334 mkws.teams[tname].limitQuery(field, value);
337 mkws.limitCategory = function(tname, id) {
338 mkws.teams[tname].limitCategory(id);
341 mkws.delimitTarget = function(tname, id) {
342 mkws.teams[tname].delimitTarget(id);
345 mkws.delimitQuery = function(tname, field, value) {
346 mkws.teams[tname].delimitQuery(field, value);
349 mkws.showPage = function(tname, pageNum) {
350 mkws.teams[tname].showPage(pageNum);
353 mkws.pagerPrev = function(tname) {
354 mkws.teams[tname].pagerPrev();
357 mkws.pagerNext = function(tname) {
358 mkws.teams[tname].pagerNext();
362 mkws.pazpar2_url = function() {
363 if (mkws.config.pazpar2_url) {
364 mkws.log("using pre-baked pazpar2_url '" + mkws.config.pazpar2_url + "'");
365 return mkws.config.pazpar2_url;
367 var s = document.location.protocol + "//" + mkws.config.pp2_hostname + "/" + mkws.config.pp2_path + "/";
368 mkws.log("generated pazpar2_url '" + s + "'");
374 // wrapper to provide local copy of the jQuery object.
378 function handleNodeWithTeam(node, callback) {
379 // First branch for DOM objects; second branch for jQuery objects
380 var classes = node.className || node.attr('class');
382 // For some reason, if we try to proceed when classes is
383 // undefined, we don't get an error message, but this
384 // function and its callers, up several stack level,
385 // silently return. What a crock.
386 log("handleNodeWithTeam() called on node with no classes");
389 var list = classes.split(/\s+/)
392 for (var i = 0; i < list.length; i++) {
394 if (cname.match(/^mkwsTeam_/)) {
395 teamName = cname.replace(/^mkwsTeam_/, '');
396 } else if (cname.match(/^mkws/)) {
397 type = cname.replace(/^mkws/, '');
401 // Widgets without a team are on team "AUTO"
404 // Autosearch widgets don't join team AUTO if there is already an
405 // autosearch on the team or the team has otherwise gotten a query
406 if (node.hasAttribute("autosearch")) {
407 if (mkws.autoHasAuto ||
408 mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) {
409 log("AUTO team already has a query, using unique team");
412 mkws.autoHasAuto = true;
416 // Widgets on team "UNIQUE" get a random team
417 if (teamName === "UNIQUE") {
418 teamName = Math.floor(Math.random() * 100000000).toString();
421 callback.call(node, teamName, type);
425 function resizePage() {
426 var threshhold = mkws.config.responsive_design_width;
427 var width = $(window).width();
428 var from, to, method;
430 if ((mkws.width === undefined || mkws.width > threshhold) &&
431 width <= threshhold) {
432 from = "wide"; to = "narrow"; method = "hide";
433 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
434 width > threshhold) {
435 from = "narrow"; to = "wide"; method = "show";
440 log("changing from " + from + " to " + to + ": " + width);
441 for (var tname in mkws.teams) {
442 var team = mkws.teams[tname];
443 team.visitWidgets(function(t, w) {
444 var w1 = team.widget(t + "-Container-" + from);
445 var w2 = team.widget(t + "-Container-" + to);
451 w.node.appendTo(w2.node);
454 team.queue("resize-" + to).publish();
461 * Run service-proxy authentication in background (after page load).
462 * The username/password is configured in the apache config file
465 function authenticateSession(auth_url, auth_domain, pp2_url) {
466 mkws.authenticating = true;
467 log("service proxy authentication on URL: " + auth_url);
470 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
471 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
474 var request = new pzHttpRequest(auth_url, function(err) {
475 alert("HTTP call for authentication failed: " + err)
479 request.get(null, function(data) {
480 mkws.authenticating = false;
481 if (!$.isXMLDoc(data)) {
482 alert("Service Proxy authentication response is not a valid XML document");
485 var status = $(data).find("status");
486 if (status.text() != "OK") {
487 var message = $(data).find("message");
488 alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
492 log("service proxy authentication successful");
493 mkws.authenticated = true;
494 var authName = $(data).find("displayName").text();
495 // You'd think there would be a better way to do this:
496 var realm = $(data).find("realm:not(realmAttributes realm)").text();
497 for (var teamName in mkws.teams) {
498 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
506 function runAutoSearches() {
507 log("running auto searches");
509 for (var teamName in mkws.teams) {
510 mkws.teams[teamName].queue("ready").publish();
515 function selectorForAllWidgets() {
516 if (mkws.config && mkws.config.scan_all_nodes) {
517 // This is the old version, which works by telling jQuery to
518 // find every node that has a class beginning with "mkws". In
519 // theory it should be slower than the class-based selector; but
520 // instrumentation suprisnigly shows this is consistently
521 // faster. It also has the advantage that any widgets of
522 // non-registered types are logged as warnings rather than
524 return '[class^="mkws"],[class*=" mkws"]';
526 // This is the new version, which works by looking up the
527 // specific classes of all registered widget types and their
528 // resize containers. Because all it requires jQuery to do is
529 // some hash lookups in pre-built tables, it should be very
530 // fast; but it silently ignores widgets of unregistered types.
532 for (var type in mkws.widgetType2function) {
535 s += ',.mkws' + type + "-Container-wide";
536 s += ',.mkws' + type + "-Container-narrow";
543 function makeWidgetsWithin(level, node) {
544 if (node) var widgetNodes = node.find(selectorForAllWidgets());
545 else widgetNodes = $(selectorForAllWidgets());
546 // Return false if we parse no widgets
547 if (widgetNodes.length < 1) return false;
548 widgetNodes.each(function() {
549 handleNodeWithTeam(this, function(tname, type) {
550 var myTeam = mkws.teams[tname];
552 myTeam = mkws.teams[tname] = team($, tname);
553 log("made MKWS team '" + tname + "'");
556 var oldHTML = this.innerHTML;
557 var myWidget = widget($, myTeam, type, this);
558 myTeam.addWidget(myWidget);
559 var newHTML = this.innerHTML;
560 if (newHTML !== oldHTML) {
561 log("widget " + tname + ":" + type + " HTML changed: reparsing");
562 makeWidgetsWithin(level+1, $(this));
570 // The second "rootsel" parameter is passed to jQuery and is a DOM node
571 // or a selector string you would like to constrain the search for widgets to.
573 // This function has no side effects if run again on an operating session,
574 // even if the element/selector passed causes existing widgets to be reparsed:
576 // (TODO: that last bit isn't true and we currently have to avoid reinitialising
577 // widgets, MKWS-261)
579 // * configuration is not regenerated
580 // * authentication is not performed again
581 // * autosearches are not re-run
582 mkws.init = function(message, rootsel) {
583 var greet = "MKWS initialised";
584 if (rootsel) greet += " (limited to " + rootsel + ")"
585 if (message) greet += " :: " + message;
588 // TODO: Let's remove this soon
589 // Backwards compatibility: set new magic class names on any
590 // elements that have the old magic IDs.
591 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
592 "Results", "Records", "Targets", "Ranking",
593 "Termlists", "Stat", "MOTD" ];
594 for (var i = 0; i < ids.length; i++) {
595 var id = 'mkws' + ids[i];
596 var node = $('#' + id);
597 if (node.attr('id')) {
599 log("added magic class to '" + node.attr('id') + "'");
603 // MKWS is not active until init() has been run against an object with widget nodes.
604 // We only set initial configuration when MKWS is first activated.
605 if (!mkws.isActive) {
606 var widgetSelector = selectorForAllWidgets();
607 if ($(widgetSelector).length < 1) {
608 mkws.log("no widgets found");
612 // Initial configuration
613 mkws.autoHasAuto = false;
615 if (typeof mkws_config === 'undefined') {
616 log("setting empty config");
619 log("using config: " + $.toJSON(mkws_config));
620 saved_config = mkws_config;
622 mkws.setMkwsConfig(saved_config);
624 for (var key in mkws.config) {
625 if (mkws.config.hasOwnProperty(key)) {
626 if (key.match(/^language_/)) {
627 var lang = key.replace(/^language_/, "");
628 // Copy custom languages into list
629 mkws.locale_lang[lang] = mkws.config[key];
630 log("added locally configured language '" + lang + "'");
635 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
636 if (!lang || !mkws.locale_lang[lang]) {
637 mkws.config.lang = ""
639 mkws.config.lang = lang;
642 log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
644 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
645 log("reset query width to " + mkws.config.query_width);
646 mkws.config.query_width = 50;
649 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
650 if (mkws.pazpar2_url().match(/^\/\//)) {
651 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
652 log("adjusted protocol independent link to " + mkws.pazpar2_url());
655 if (mkws.config.responsive_design_width) {
656 // Responsive web design - change layout on the fly based on
657 // current screen width. Required for mobile devices.
658 $(window).resize(resizePage);
659 // initial check after page load
660 $(document).ready(resizePage);
665 // If we've made no widgets, return without starting an SP session
666 // or marking MKWS active.
667 if (makeWidgetsWithin(1, rootsel ? $(rootsel) : undefined) === false) {
672 log("walking MKWS nodes took " + (now-then) + " ms");
675 for (var tName in mkws.teams) {
676 var myTeam = mkws.teams[tName]
677 log("team '" + tName + "' = " + myTeam + " ...");
678 myTeam.visitWidgets(function(t, w) {
679 log(" has widget of type '" + t + "': " + w);
684 function sp_auth_url(config) {
685 if (config.service_proxy_auth) {
686 mkws.log("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'");
687 return config.service_proxy_auth;
690 s += config.auth_hostname ? config.auth_hostname : config.pp2_hostname;
691 s += '/' + config.sp_auth_path;
692 var q = config.sp_auth_query;
696 var c = config.sp_auth_credentials;
698 s += ('&username=' + c.substr(0, c.indexOf('/')) +
699 '&password=' + c.substr(c.indexOf('/')+1));
701 mkws.log("generated sp_auth_url '" + s + "'");
706 if (mkws.config.use_service_proxy && !mkws.authenticated && !mkws.authenticating) {
707 authenticateSession(sp_auth_url(mkws.config),
708 mkws.config.service_proxy_auth_domain,
710 } else if (!mkws.authenticating) {
711 // raw pp2 or we have a session already open
715 mkws.isActive = true;
719 $(document).ready(function() {
720 if (!window.mkws_noready && !mkws.authenticating && !mkws.active) {