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 // Incredible that the standard JavaScript runtime doesn't define a
10 // unique windowId. Instead, we have to make one up. And since there's
11 // no global area shared between windows, the best we can do for
12 // ensuring uniqueness is generating a random ID and crossing our
13 // fingers. We stash this in window.name, as it's the only place to
14 // keep data that is preserved across reloads and within-site
15 // navigation. pz2.js picks this up and uses it as part of the
16 // cookie-name, to ensure each tab gets its own session.
18 console.log("Using existing window.name '" + window.name + "'");
20 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
21 // At one per second, it will take 116 million years to duplicate a session
22 window.name = Math.random().toString(36).slice(2, 12);
23 console.log("Generated new window.name '" + window.name + "'");
26 // Set up global mkws object. Contains truly global state such as SP
27 // authentication, and a hash of team objects, indexed by team-name.
30 $: $, // Our own local copy of the jQuery object
32 log_level: 1, // Will be overridden from mkws.config, but
33 // initial value allows jQuery popup to use logging.
35 widgetType2function: {},
40 "Subjects": "Schlagwörter",
41 "Sources": "Daten und Quellen",
42 "source": "datenquelle",
43 "Termlists": "Termlisten",
45 "Prev": "Zurück",
47 "Sort by": "Sortieren nach",
48 "and show": "und zeige",
49 "per page": "pro Seite",
50 "Displaying": "Zeige",
58 "Subject": "Schlagwort",
59 "subject": "schlagwort",
61 "Records": "Datensätze",
62 "Targets": "Datenbanken",
68 "Authors": "Forfattere",
72 "Termlists": "Termlists",
73 "Next": "Næste",
75 "Search": "Søg",
76 "Sort by": "Sorter efter",
78 "per page": "per side",
79 "Displaying": "Viser",
84 "Author": "Forfatter",
85 "author": "forfatter",
89 "Location": "Lokation",
98 // We may be using a separate copy
99 if (!mkws_jQuery) mkws_jQuery = jQuery;
100 mkws.$ = mkws_jQuery;
102 mkws.log = function(string) {
106 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
110 // you need to disable use strict at the top of the file!!!
111 if (mkws.log_level >= 3) {
112 // Works in Chrome; not sure about elsewhere
114 } else if (mkws.log_level >= 2) {
115 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
121 // Translation function.
122 mkws.M = function(word) {
123 var lang = mkws.config.lang;
125 if (!lang || !mkws.locale_lang[lang])
128 return mkws.locale_lang[lang][word] || word;
132 // This function is taken from a StackOverflow answer
133 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
134 mkws.getParameterByName = function(name, url) {
135 if (!url) url = location.search;
136 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
137 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
138 results = regex.exec(url);
139 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
143 mkws.registerWidgetType = function(name, fn) {
144 mkws.widgetType2function[name] = fn;
145 mkws.log("registered widget-type '" + name + "'");
148 mkws.promotionFunction = function(name) {
149 return mkws.widgetType2function[name];
153 mkws.setMkwsConfig = function(overrides) {
154 // Set global log_level flag early so that mkws.log() works
155 // Fall back to old "debug_level" setting for backwards compatibility
156 var tmp = overrides.log_level;
157 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
158 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
160 var config_default = {
161 use_service_proxy: true,
162 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
163 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
165 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
166 perpage_options: [10, 20, 30, 50],
167 sort_default: "relevance",
170 show_lang: true, /* show/hide language menu */
171 show_sort: true, /* show/hide sort menu */
172 show_perpage: true, /* show/hide perpage menu */
173 show_switch: true, /* show/hide switch menu */
174 lang_options: [], /* display languages links for given languages, [] for all */
175 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
176 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
177 log_level: 1, /* log level for development: 0..2 */
182 mkws.config = mkws.objectInheritingFrom(config_default);
183 for (var k in overrides) {
184 mkws.config[k] = overrides[k];
189 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
190 // http://javascript.crockford.com/prototypal.html
191 // mkws.objectInheritingFrom behaves the same as Object.create,
192 // but since the latter is not available in IE8 we can't use it.
194 mkws.objectInheritingFrom = function(o) {
201 mkws.defaultTemplate = function(name) {
202 if (name === 'Record') {
206 <th>{{mkws-translate "Title"}}</th>\
209 {{#if md-title-remainder}}\
210 ({{md-title-remainder}})\
212 {{#if md-title-responsibility}}\
213 <i>{{md-title-responsibility}}</i>\
219 <th>{{mkws-translate "Date"}}</th>\
220 <td>{{md-date}}</td>\
225 <th>{{mkws-translate "Author"}}</th>\
226 <td>{{md-author}}</td>\
229 {{#if md-electronic-url}}\
231 <th>{{mkws-translate "Links"}}</th>\
233 {{#each md-electronic-url}}\
234 <a href="{{this}}">Link{{mkws-index1}}</a>\
239 {{#mkws-if-any location having="md-subject"}}\
241 <th>{{mkws-translate "Subject"}}</th>\
243 {{#mkws-first location having="md-subject"}}\
245 {{#mkws-commaList md-subject}}\
246 {{this}}{{/mkws-commaList}}\
253 <th>{{mkws-translate "Locations"}}</th>\
255 {{#mkws-commaList location}}\
256 {{mkws-attr "@name"}}{{/mkws-commaList}}\
261 } else if (name === "Summary") {
263 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
266 {{#if md-title-remainder}}\
267 <span>{{md-title-remainder}}</span>\
269 {{#if md-title-responsibility}}\
270 <span><i>{{md-title-responsibility}}</i></span>\
272 {{#if md-date}}, {{md-date}}\
274 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
277 <span>, {{md-medium}}</span>\
281 } else if (name === "Image") {
283 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
284 {{#mkws-first md-thumburl}}\
285 <img src="{{this}}" alt="{{../md-title}}"/>\
290 } else if (name === 'Facet') {
294 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
297 <span>{{count}}</span>\
305 // The following functions are dispatchers for team methods that
306 // are called from the UI using a team-name rather than implicit
308 mkws.switchView = function(tname, view) {
309 mkws.teams[tname].switchView(view);
312 mkws.showDetails = function(tname, prefixRecId) {
313 mkws.teams[tname].showDetails(prefixRecId);
316 mkws.limitTarget = function(tname, id, name) {
317 mkws.teams[tname].limitTarget(id, name);
320 mkws.limitQuery = function(tname, field, value) {
321 mkws.teams[tname].limitQuery(field, value);
324 mkws.limitCategory = function(tname, id) {
325 mkws.teams[tname].limitCategory(id);
328 mkws.delimitTarget = function(tname, id) {
329 mkws.teams[tname].delimitTarget(id);
332 mkws.delimitQuery = function(tname, field, value) {
333 mkws.teams[tname].delimitQuery(field, value);
336 mkws.showPage = function(tname, pageNum) {
337 mkws.teams[tname].showPage(pageNum);
340 mkws.pagerPrev = function(tname) {
341 mkws.teams[tname].pagerPrev();
344 mkws.pagerNext = function(tname) {
345 mkws.teams[tname].pagerNext();
349 // wrapper to provide local copy of the jQuery object.
353 function handleNodeWithTeam(node, callback) {
354 // First branch for DOM objects; second branch for jQuery objects
355 var classes = node.className || node.attr('class');
357 // For some reason, if we try to proceed when classes is
358 // undefined, we don't get an error message, but this
359 // function and its callers, up several stack level,
360 // silently return. What a crock.
361 log("handleNodeWithTeam() called on node with no classes");
364 var list = classes.split(/\s+/)
367 for (var i = 0; i < list.length; i++) {
369 if (cname.match(/^mkwsTeam_/)) {
370 teamName = cname.replace(/^mkwsTeam_/, '');
371 } else if (cname.match(/^mkws/)) {
372 type = cname.replace(/^mkws/, '');
376 if (!teamName) teamName = "AUTO";
377 callback.call(node, teamName, type);
381 function resizePage() {
382 var threshhold = mkws.config.responsive_design_width;
383 var width = $(window).width();
384 var from, to, method;
386 if ((mkws.width === undefined || mkws.width > threshhold) &&
387 width <= threshhold) {
388 from = "wide"; to = "narrow"; method = "hide";
389 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
390 width > threshhold) {
391 from = "narrow"; to = "wide"; method = "show";
396 log("changing from " + from + " to " + to + ": " + width);
397 for (var tname in mkws.teams) {
398 var team = mkws.teams[tname];
399 team.visitWidgets(function(t, w) {
400 var w1 = team.widget(t + "-Container-" + from);
401 var w2 = team.widget(t + "-Container-" + to);
407 w.node.appendTo(w2.node);
410 team.queue("resize-" + to).publish();
417 * Run service-proxy authentication in background (after page load).
418 * The username/password is configured in the apache config file
421 function authenticateSession(auth_url, auth_domain, pp2_url) {
422 log("service proxy authentication on URL: " + auth_url);
425 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
426 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
429 var request = new pzHttpRequest(auth_url, function(err) {
430 alert("HTTP call for authentication failed: " + err)
434 request.get(null, function(data) {
435 if (!$.isXMLDoc(data)) {
436 alert("service proxy auth response document is not valid XML document, give up!");
439 var status = $(data).find("status");
440 if (status.text() != "OK") {
441 alert("service proxy auth response status: " + status.text() + ", give up!");
445 log("service proxy authentication successful");
446 mkws.authenticated = true;
447 var authName = $(data).find("displayName").text();
448 // You'd think there would be a better way to do this:
449 var realm = $(data).find("realm:not(realmAttributes realm)").text();
450 for (var teamName in mkws.teams) {
451 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
459 function runAutoSearches() {
460 log("running auto searches");
462 for (var teamName in mkws.teams) {
463 mkws.teams[teamName].queue("ready").publish();
468 function selectorForAllWidgets() {
469 if (mkws.config && mkws.config.scan_all_nodes) {
470 // This is the old version, which works by telling jQuery to
471 // find every node that has a class beginning with "mkws". In
472 // theory it should be slower than the class-based selector; but
473 // instrumentation suprisnigly shows this is consistently
474 // faster. It also has the advantage that any widgets of
475 // non-registered types are logged as warnings rather than
477 return '[class^="mkws"],[class*=" mkws"]';
479 // This is the new version, which works by looking up the
480 // specific classes of all registered widget types and their
481 // resize containers. Because all it requires jQuery to do is
482 // some hash lookups in pre-built tables, it should be very
483 // fast; but it silently ignores widgets of unregistered types.
485 for (var type in mkws.widgetType2function) {
488 s += ',.mkws' + type + "-Container-wide";
489 s += ',.mkws' + type + "-Container-narrow";
496 function makeWidgetsWithin(level, node) {
497 node.find(selectorForAllWidgets()).each(function() {
498 handleNodeWithTeam(this, function(tname, type) {
499 var myTeam = mkws.teams[tname];
501 myTeam = mkws.teams[tname] = team($, tname);
502 log("made MKWS team '" + tname + "'");
505 var oldHTML = this.innerHTML;
506 var myWidget = widget($, myTeam, type, this);
507 myTeam.addWidget(myWidget);
508 var newHTML = this.innerHTML;
509 if (newHTML !== oldHTML) {
510 log("widget " + tname + ":" + type + " HTML changed: reparsing");
511 makeWidgetsWithin(level+1, $(this));
518 function init(rootsel) {
519 if (!rootsel) var rootsel = ':root';
521 if (typeof mkws_config === 'undefined') {
522 log("setting empty config");
525 log("using config: " + $.toJSON(mkws_config));
526 saved_config = mkws_config;
528 mkws.setMkwsConfig(saved_config);
530 for (var key in mkws.config) {
531 if (mkws.config.hasOwnProperty(key)) {
532 if (key.match(/^language_/)) {
533 var lang = key.replace(/^language_/, "");
534 // Copy custom languages into list
535 mkws.locale_lang[lang] = mkws.config[key];
536 log("added locally configured language '" + lang + "'");
541 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
542 if (!lang || !mkws.locale_lang[lang]) {
543 mkws.config.lang = ""
545 mkws.config.lang = lang;
548 log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
550 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
551 log("reset query width to " + mkws.config.query_width);
552 mkws.config.query_width = 50;
555 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
556 if (mkws.config.pazpar2_url.match(/^\/\//)) {
557 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
558 log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
561 if (mkws.config.responsive_design_width) {
562 // Responsive web design - change layout on the fly based on
563 // current screen width. Required for mobile devices.
564 $(window).resize(resizePage);
565 // initial check after page load
566 $(document).ready(resizePage);
569 // Backwards compatibility: set new magic class names on any
570 // elements that have the old magic IDs.
571 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
572 "Results", "Records", "Targets", "Ranking",
573 "Termlists", "Stat", "MOTD" ];
574 for (var i = 0; i < ids.length; i++) {
575 var id = 'mkws' + ids[i];
576 var node = $('#' + id);
577 if (node.attr('id')) {
579 log("added magic class to '" + node.attr('id') + "'");
584 makeWidgetsWithin(1, $(rootsel));
587 log("walking MKWS nodes took " + (now-then) + " ms");
590 for (var tName in mkws.teams) {
591 var myTeam = mkws.teams[tName]
592 log("team '" + tName + "' = " + myTeam + " ...");
593 myTeam.visitWidgets(function(t, w) {
594 log(" has widget of type '" + t + "': " + w);
599 if (mkws.config.use_service_proxy) {
600 authenticateSession(mkws.config.service_proxy_auth,
601 mkws.config.service_proxy_auth_domain,
602 mkws.config.pazpar2_url);
608 $(document).ready(function() {
609 var widgetSelector = selectorForAllWidgets();
610 if (widgetSelector && $(widgetSelector).length !== 0) init();