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 log_level: 1, // Will be overridden from mkws.config, but
18 // initial value allows jQuery popup to use logging.
20 widgetType2function: {},
25 "Subjects": "Schlagwörter",
26 "Sources": "Daten und Quellen",
27 "source": "datenquelle",
28 "Termlists": "Termlisten",
30 "Prev": "Zurück",
32 "Sort by": "Sortieren nach",
33 "and show": "und zeige",
34 "per page": "pro Seite",
35 "Displaying": "Zeige",
43 "Subject": "Schlagwort",
44 "subject": "schlagwort",
46 "Records": "Datensätze",
47 "Targets": "Datenbanken",
53 "Authors": "Forfattere",
57 "Termlists": "Termlists",
58 "Next": "Næste",
60 "Search": "Søg",
61 "Sort by": "Sorter efter",
63 "per page": "per side",
64 "Displaying": "Viser",
69 "Author": "Forfatter",
70 "author": "forfatter",
74 "Location": "Lokation",
83 // We may be using a separate copy
84 if (typeof(mkws_jQuery) !== "undefined") {
90 mkws.log = function(string) {
94 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
98 // you need to disable use strict at the top of the file!!!
99 if (mkws.log_level >= 3) {
100 // Works in Chrome; not sure about elsewhere
102 } else if (mkws.log_level >= 2) {
103 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
109 // Incredible that the standard JavaScript runtime doesn't define a
110 // unique windowId. Instead, we have to make one up. And since there's
111 // no global area shared between windows, the best we can do for
112 // ensuring uniqueness is generating a random ID and crossing our
113 // fingers. We stash this in window.name, as it's the only place to
114 // keep data that is preserved across reloads and within-site
115 // navigation. pz2.js picks this up and uses it as part of the
116 // cookie-name, to ensure each tab gets its own session.
118 mkws.log("Using existing window.name '" + window.name + "'");
120 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
121 // At one per second, it will take 116 million years to duplicate a session
122 window.name = Math.random().toString(36).slice(2, 12);
123 mkws.log("Generated new window.name '" + window.name + "'");
127 // Translation function.
128 mkws.M = function(word) {
129 var lang = mkws.config.lang;
131 if (!lang || !mkws.locale_lang[lang])
134 return mkws.locale_lang[lang][word] || word;
138 // This function is taken from a StackOverflow answer
139 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
140 mkws.getParameterByName = function(name, url) {
141 if (!url) url = location.search;
142 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
143 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
144 results = regex.exec(url);
145 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
149 mkws.registerWidgetType = function(name, fn) {
150 mkws.widgetType2function[name] = fn;
151 mkws.log("registered widget-type '" + name + "'");
154 mkws.promotionFunction = function(name) {
155 return mkws.widgetType2function[name];
159 mkws.setMkwsConfig = function(overrides) {
160 // Set global log_level flag early so that mkws.log() works
161 // Fall back to old "debug_level" setting for backwards compatibility
162 var tmp = overrides.log_level;
163 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
164 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
166 var config_default = {
167 use_service_proxy: true,
168 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
169 service_proxy_auth: undefined, // generally rolled from the next three properties
170 // Was: //mkws.indexdata.com/service-proxy-auth
171 pp2_hostname: "mkws.indexdata.com",
172 sp_path: "service-proxy-auth",
173 credentials: undefined,
175 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
176 perpage_options: [10, 20, 30, 50],
177 sort_default: "relevance",
180 show_lang: true, /* show/hide language menu */
181 show_sort: true, /* show/hide sort menu */
182 show_perpage: true, /* show/hide perpage menu */
183 show_switch: true, /* show/hide switch menu */
184 lang_options: [], /* display languages links for given languages, [] for all */
185 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
186 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
187 log_level: 1, /* log level for development: 0..2 */
192 mkws.config = mkws.objectInheritingFrom(config_default);
193 for (var k in overrides) {
194 mkws.config[k] = overrides[k];
199 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
200 // http://javascript.crockford.com/prototypal.html
201 // mkws.objectInheritingFrom behaves the same as Object.create,
202 // but since the latter is not available in IE8 we can't use it.
204 mkws.objectInheritingFrom = function(o) {
211 mkws.defaultTemplate = function(name) {
212 if (name === 'Record') {
216 <th>{{mkws-translate "Title"}}</th>\
219 {{#if md-title-remainder}}\
220 ({{md-title-remainder}})\
222 {{#if md-title-responsibility}}\
223 <i>{{md-title-responsibility}}</i>\
229 <th>{{mkws-translate "Date"}}</th>\
230 <td>{{md-date}}</td>\
235 <th>{{mkws-translate "Author"}}</th>\
236 <td>{{md-author}}</td>\
239 {{#if md-electronic-url}}\
241 <th>{{mkws-translate "Links"}}</th>\
243 {{#each md-electronic-url}}\
244 <a href="{{this}}">Link{{mkws-index1}}</a>\
249 {{#mkws-if-any location having="md-subject"}}\
251 <th>{{mkws-translate "Subject"}}</th>\
253 {{#mkws-first location having="md-subject"}}\
255 {{#mkws-commaList md-subject}}\
256 {{this}}{{/mkws-commaList}}\
263 <th>{{mkws-translate "Locations"}}</th>\
265 {{#mkws-commaList location}}\
266 {{mkws-attr "@name"}}{{/mkws-commaList}}\
271 } else if (name === "Summary") {
273 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
276 {{#if md-title-remainder}}\
277 <span>{{md-title-remainder}}</span>\
279 {{#if md-title-responsibility}}\
280 <span><i>{{md-title-responsibility}}</i></span>\
282 {{#if md-date}}, {{md-date}}\
284 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
287 <span>, {{md-medium}}</span>\
291 } else if (name === "Image") {
293 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
294 {{#mkws-first md-thumburl}}\
295 <img src="{{this}}" alt="{{../md-title}}"/>\
300 } else if (name === 'Facet') {
304 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
307 <span>{{count}}</span>\
315 // The following functions are dispatchers for team methods that
316 // are called from the UI using a team-name rather than implicit
318 mkws.switchView = function(tname, view) {
319 mkws.teams[tname].switchView(view);
322 mkws.showDetails = function(tname, prefixRecId) {
323 mkws.teams[tname].showDetails(prefixRecId);
326 mkws.limitTarget = function(tname, id, name) {
327 mkws.teams[tname].limitTarget(id, name);
330 mkws.limitQuery = function(tname, field, value) {
331 mkws.teams[tname].limitQuery(field, value);
334 mkws.limitCategory = function(tname, id) {
335 mkws.teams[tname].limitCategory(id);
338 mkws.delimitTarget = function(tname, id) {
339 mkws.teams[tname].delimitTarget(id);
342 mkws.delimitQuery = function(tname, field, value) {
343 mkws.teams[tname].delimitQuery(field, value);
346 mkws.showPage = function(tname, pageNum) {
347 mkws.teams[tname].showPage(pageNum);
350 mkws.pagerPrev = function(tname) {
351 mkws.teams[tname].pagerPrev();
354 mkws.pagerNext = function(tname) {
355 mkws.teams[tname].pagerNext();
359 // wrapper to provide local copy of the jQuery object.
363 function handleNodeWithTeam(node, callback) {
364 // First branch for DOM objects; second branch for jQuery objects
365 var classes = node.className || node.attr('class');
367 // For some reason, if we try to proceed when classes is
368 // undefined, we don't get an error message, but this
369 // function and its callers, up several stack level,
370 // silently return. What a crock.
371 log("handleNodeWithTeam() called on node with no classes");
374 var list = classes.split(/\s+/)
377 for (var i = 0; i < list.length; i++) {
379 if (cname.match(/^mkwsTeam_/)) {
380 teamName = cname.replace(/^mkwsTeam_/, '');
381 } else if (cname.match(/^mkws/)) {
382 type = cname.replace(/^mkws/, '');
386 // Widgets without a team are on team "AUTO"
389 // Autosearch widgets don't join team AUTO if there is already an
390 // autosearch on the team or the team has otherwise gotten a query
391 if (node.hasAttribute("autosearch")) {
392 if (mkws.autoHasAuto ||
393 mkws.teams["AUTO"] && mkws.teams["AUTO"].config["query"]) {
394 log("AUTO team already has a query, using unique team");
397 mkws.autoHasAuto = true;
401 // Widgets on team "UNIQUE" get a random team
402 if (teamName === "UNIQUE") {
403 teamName = Math.floor(Math.random() * 100000000).toString();
406 callback.call(node, teamName, type);
410 function resizePage() {
411 var threshhold = mkws.config.responsive_design_width;
412 var width = $(window).width();
413 var from, to, method;
415 if ((mkws.width === undefined || mkws.width > threshhold) &&
416 width <= threshhold) {
417 from = "wide"; to = "narrow"; method = "hide";
418 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
419 width > threshhold) {
420 from = "narrow"; to = "wide"; method = "show";
425 log("changing from " + from + " to " + to + ": " + width);
426 for (var tname in mkws.teams) {
427 var team = mkws.teams[tname];
428 team.visitWidgets(function(t, w) {
429 var w1 = team.widget(t + "-Container-" + from);
430 var w2 = team.widget(t + "-Container-" + to);
436 w.node.appendTo(w2.node);
439 team.queue("resize-" + to).publish();
446 * Run service-proxy authentication in background (after page load).
447 * The username/password is configured in the apache config file
450 function authenticateSession(auth_url, auth_domain, pp2_url) {
451 log("service proxy authentication on URL: " + auth_url);
454 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
455 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
458 var request = new pzHttpRequest(auth_url, function(err) {
459 alert("HTTP call for authentication failed: " + err)
463 request.get(null, function(data) {
464 if (!$.isXMLDoc(data)) {
465 alert("Service Proxy authentication response is not a valid XML document");
468 var status = $(data).find("status");
469 if (status.text() != "OK") {
470 var message = $(data).find("message");
471 alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
475 log("service proxy authentication successful");
476 mkws.authenticated = true;
477 var authName = $(data).find("displayName").text();
478 // You'd think there would be a better way to do this:
479 var realm = $(data).find("realm:not(realmAttributes realm)").text();
480 for (var teamName in mkws.teams) {
481 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
489 function runAutoSearches() {
490 log("running auto searches");
492 for (var teamName in mkws.teams) {
493 mkws.teams[teamName].queue("ready").publish();
498 function selectorForAllWidgets() {
499 if (mkws.config && mkws.config.scan_all_nodes) {
500 // This is the old version, which works by telling jQuery to
501 // find every node that has a class beginning with "mkws". In
502 // theory it should be slower than the class-based selector; but
503 // instrumentation suprisnigly shows this is consistently
504 // faster. It also has the advantage that any widgets of
505 // non-registered types are logged as warnings rather than
507 return '[class^="mkws"],[class*=" mkws"]';
509 // This is the new version, which works by looking up the
510 // specific classes of all registered widget types and their
511 // resize containers. Because all it requires jQuery to do is
512 // some hash lookups in pre-built tables, it should be very
513 // fast; but it silently ignores widgets of unregistered types.
515 for (var type in mkws.widgetType2function) {
518 s += ',.mkws' + type + "-Container-wide";
519 s += ',.mkws' + type + "-Container-narrow";
526 function makeWidgetsWithin(level, node) {
527 node.find(selectorForAllWidgets()).each(function() {
528 handleNodeWithTeam(this, function(tname, type) {
529 var myTeam = mkws.teams[tname];
531 myTeam = mkws.teams[tname] = team($, tname);
532 log("made MKWS team '" + tname + "'");
535 var oldHTML = this.innerHTML;
536 var myWidget = widget($, myTeam, type, this);
537 myTeam.addWidget(myWidget);
538 var newHTML = this.innerHTML;
539 if (newHTML !== oldHTML) {
540 log("widget " + tname + ":" + type + " HTML changed: reparsing");
541 makeWidgetsWithin(level+1, $(this));
548 function init(rootsel) {
549 mkws.autoHasAuto = false;
550 if (!rootsel) var rootsel = ':root';
552 if (typeof mkws_config === 'undefined') {
553 log("setting empty config");
556 log("using config: " + $.toJSON(mkws_config));
557 saved_config = mkws_config;
559 mkws.setMkwsConfig(saved_config);
561 for (var key in mkws.config) {
562 if (mkws.config.hasOwnProperty(key)) {
563 if (key.match(/^language_/)) {
564 var lang = key.replace(/^language_/, "");
565 // Copy custom languages into list
566 mkws.locale_lang[lang] = mkws.config[key];
567 log("added locally configured language '" + lang + "'");
572 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
573 if (!lang || !mkws.locale_lang[lang]) {
574 mkws.config.lang = ""
576 mkws.config.lang = lang;
579 log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
581 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
582 log("reset query width to " + mkws.config.query_width);
583 mkws.config.query_width = 50;
586 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
587 if (mkws.config.pazpar2_url.match(/^\/\//)) {
588 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
589 log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
592 if (mkws.config.responsive_design_width) {
593 // Responsive web design - change layout on the fly based on
594 // current screen width. Required for mobile devices.
595 $(window).resize(resizePage);
596 // initial check after page load
597 $(document).ready(resizePage);
600 // Backwards compatibility: set new magic class names on any
601 // elements that have the old magic IDs.
602 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
603 "Results", "Records", "Targets", "Ranking",
604 "Termlists", "Stat", "MOTD" ];
605 for (var i = 0; i < ids.length; i++) {
606 var id = 'mkws' + ids[i];
607 var node = $('#' + id);
608 if (node.attr('id')) {
610 log("added magic class to '" + node.attr('id') + "'");
615 makeWidgetsWithin(1, $(rootsel));
618 log("walking MKWS nodes took " + (now-then) + " ms");
621 for (var tName in mkws.teams) {
622 var myTeam = mkws.teams[tName]
623 log("team '" + tName + "' = " + myTeam + " ...");
624 myTeam.visitWidgets(function(t, w) {
625 log(" has widget of type '" + t + "': " + w);
630 function sp_auth_url(config) {
631 if (config.service_proxy_auth) {
632 mkws.log("using pre-baked sp_auth_url '" + config.service_proxy_auth + "'");
633 return config.service_proxy_auth;
636 s += config.auth_hostname ? config.auth_hostname : config.pp2_hostname;
637 s += '/' + config.sp_path + '?command=auth&action=perconfig';
638 var c = config.credentials;
641 s += ('&username=' + c.substr(0, c.indexOf('/')) +
642 '&password=' + c.substr(c.indexOf('/')+1));
645 mkws.log("generated sp_auth_url '" + s + "'");
650 if (mkws.config.use_service_proxy) {
651 authenticateSession(sp_auth_url(mkws.config),
652 mkws.config.service_proxy_auth_domain,
653 mkws.config.pazpar2_url);
659 $(document).ready(function() {
660 var widgetSelector = selectorForAllWidgets();
661 if (widgetSelector && $(widgetSelector).length !== 0) init();