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 (typeof(mkws_jQuery) !== "undefined") {
100 mkws.$ = mkws_jQuery;
105 mkws.log = function(string) {
109 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
113 // you need to disable use strict at the top of the file!!!
114 if (mkws.log_level >= 3) {
115 // Works in Chrome; not sure about elsewhere
117 } else if (mkws.log_level >= 2) {
118 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
124 // Translation function.
125 mkws.M = function(word) {
126 var lang = mkws.config.lang;
128 if (!lang || !mkws.locale_lang[lang])
131 return mkws.locale_lang[lang][word] || word;
135 // This function is taken from a StackOverflow answer
136 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
137 mkws.getParameterByName = function(name, url) {
138 if (!url) url = location.search;
139 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
140 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
141 results = regex.exec(url);
142 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
146 mkws.registerWidgetType = function(name, fn) {
147 mkws.widgetType2function[name] = fn;
148 mkws.log("registered widget-type '" + name + "'");
151 mkws.promotionFunction = function(name) {
152 return mkws.widgetType2function[name];
156 mkws.setMkwsConfig = function(overrides) {
157 // Set global log_level flag early so that mkws.log() works
158 // Fall back to old "debug_level" setting for backwards compatibility
159 var tmp = overrides.log_level;
160 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
161 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
163 var config_default = {
164 use_service_proxy: true,
165 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
166 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
168 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
169 perpage_options: [10, 20, 30, 50],
170 sort_default: "relevance",
173 show_lang: true, /* show/hide language menu */
174 show_sort: true, /* show/hide sort menu */
175 show_perpage: true, /* show/hide perpage menu */
176 show_switch: true, /* show/hide switch menu */
177 lang_options: [], /* display languages links for given languages, [] for all */
178 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
179 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
180 log_level: 1, /* log level for development: 0..2 */
185 mkws.config = mkws.objectInheritingFrom(config_default);
186 for (var k in overrides) {
187 mkws.config[k] = overrides[k];
192 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
193 // http://javascript.crockford.com/prototypal.html
194 // mkws.objectInheritingFrom behaves the same as Object.create,
195 // but since the latter is not available in IE8 we can't use it.
197 mkws.objectInheritingFrom = function(o) {
204 mkws.defaultTemplate = function(name) {
205 if (name === 'Record') {
209 <th>{{mkws-translate "Title"}}</th>\
212 {{#if md-title-remainder}}\
213 ({{md-title-remainder}})\
215 {{#if md-title-responsibility}}\
216 <i>{{md-title-responsibility}}</i>\
222 <th>{{mkws-translate "Date"}}</th>\
223 <td>{{md-date}}</td>\
228 <th>{{mkws-translate "Author"}}</th>\
229 <td>{{md-author}}</td>\
232 {{#if md-electronic-url}}\
234 <th>{{mkws-translate "Links"}}</th>\
236 {{#each md-electronic-url}}\
237 <a href="{{this}}">Link{{mkws-index1}}</a>\
242 {{#mkws-if-any location having="md-subject"}}\
244 <th>{{mkws-translate "Subject"}}</th>\
246 {{#mkws-first location having="md-subject"}}\
248 {{#mkws-commaList md-subject}}\
249 {{this}}{{/mkws-commaList}}\
256 <th>{{mkws-translate "Locations"}}</th>\
258 {{#mkws-commaList location}}\
259 {{mkws-attr "@name"}}{{/mkws-commaList}}\
264 } else if (name === "Summary") {
266 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
269 {{#if md-title-remainder}}\
270 <span>{{md-title-remainder}}</span>\
272 {{#if md-title-responsibility}}\
273 <span><i>{{md-title-responsibility}}</i></span>\
275 {{#if md-date}}, {{md-date}}\
277 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
280 <span>, {{md-medium}}</span>\
284 } else if (name === "Image") {
286 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
287 {{#mkws-first md-thumburl}}\
288 <img src="{{this}}" alt="{{../md-title}}"/>\
293 } else if (name === 'Facet') {
297 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
300 <span>{{count}}</span>\
308 // The following functions are dispatchers for team methods that
309 // are called from the UI using a team-name rather than implicit
311 mkws.switchView = function(tname, view) {
312 mkws.teams[tname].switchView(view);
315 mkws.showDetails = function(tname, prefixRecId) {
316 mkws.teams[tname].showDetails(prefixRecId);
319 mkws.limitTarget = function(tname, id, name) {
320 mkws.teams[tname].limitTarget(id, name);
323 mkws.limitQuery = function(tname, field, value) {
324 mkws.teams[tname].limitQuery(field, value);
327 mkws.limitCategory = function(tname, id) {
328 mkws.teams[tname].limitCategory(id);
331 mkws.delimitTarget = function(tname, id) {
332 mkws.teams[tname].delimitTarget(id);
335 mkws.delimitQuery = function(tname, field, value) {
336 mkws.teams[tname].delimitQuery(field, value);
339 mkws.showPage = function(tname, pageNum) {
340 mkws.teams[tname].showPage(pageNum);
343 mkws.pagerPrev = function(tname) {
344 mkws.teams[tname].pagerPrev();
347 mkws.pagerNext = function(tname) {
348 mkws.teams[tname].pagerNext();
352 // wrapper to provide local copy of the jQuery object.
356 function handleNodeWithTeam(node, callback) {
357 // First branch for DOM objects; second branch for jQuery objects
358 var classes = node.className || node.attr('class');
360 // For some reason, if we try to proceed when classes is
361 // undefined, we don't get an error message, but this
362 // function and its callers, up several stack level,
363 // silently return. What a crock.
364 log("handleNodeWithTeam() called on node with no classes");
367 var list = classes.split(/\s+/)
370 for (var i = 0; i < list.length; i++) {
372 if (cname.match(/^mkwsTeam_/)) {
373 teamName = cname.replace(/^mkwsTeam_/, '');
374 } else if (cname.match(/^mkws/)) {
375 type = cname.replace(/^mkws/, '');
379 if (!teamName) teamName = "AUTO";
380 callback.call(node, teamName, type);
384 function resizePage() {
385 var threshhold = mkws.config.responsive_design_width;
386 var width = $(window).width();
387 var from, to, method;
389 if ((mkws.width === undefined || mkws.width > threshhold) &&
390 width <= threshhold) {
391 from = "wide"; to = "narrow"; method = "hide";
392 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
393 width > threshhold) {
394 from = "narrow"; to = "wide"; method = "show";
399 log("changing from " + from + " to " + to + ": " + width);
400 for (var tname in mkws.teams) {
401 var team = mkws.teams[tname];
402 team.visitWidgets(function(t, w) {
403 var w1 = team.widget(t + "-Container-" + from);
404 var w2 = team.widget(t + "-Container-" + to);
410 w.node.appendTo(w2.node);
413 team.queue("resize-" + to).publish();
420 * Run service-proxy authentication in background (after page load).
421 * The username/password is configured in the apache config file
424 function authenticateSession(auth_url, auth_domain, pp2_url) {
425 log("service proxy authentication on URL: " + auth_url);
428 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
429 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
432 var request = new pzHttpRequest(auth_url, function(err) {
433 alert("HTTP call for authentication failed: " + err)
437 request.get(null, function(data) {
438 if (!$.isXMLDoc(data)) {
439 alert("service proxy auth response document is not valid XML document, give up!");
442 var status = $(data).find("status");
443 if (status.text() != "OK") {
444 alert("service proxy auth response status: " + status.text() + ", give up!");
448 log("service proxy authentication successful");
449 mkws.authenticated = true;
450 var authName = $(data).find("displayName").text();
451 // You'd think there would be a better way to do this:
452 var realm = $(data).find("realm:not(realmAttributes realm)").text();
453 for (var teamName in mkws.teams) {
454 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
462 function runAutoSearches() {
463 log("running auto searches");
465 for (var teamName in mkws.teams) {
466 mkws.teams[teamName].queue("ready").publish();
471 function selectorForAllWidgets() {
472 if (mkws.config && mkws.config.scan_all_nodes) {
473 // This is the old version, which works by telling jQuery to
474 // find every node that has a class beginning with "mkws". In
475 // theory it should be slower than the class-based selector; but
476 // instrumentation suprisnigly shows this is consistently
477 // faster. It also has the advantage that any widgets of
478 // non-registered types are logged as warnings rather than
480 return '[class^="mkws"],[class*=" mkws"]';
482 // This is the new version, which works by looking up the
483 // specific classes of all registered widget types and their
484 // resize containers. Because all it requires jQuery to do is
485 // some hash lookups in pre-built tables, it should be very
486 // fast; but it silently ignores widgets of unregistered types.
488 for (var type in mkws.widgetType2function) {
491 s += ',.mkws' + type + "-Container-wide";
492 s += ',.mkws' + type + "-Container-narrow";
499 function makeWidgetsWithin(level, node) {
500 node.find(selectorForAllWidgets()).each(function() {
501 handleNodeWithTeam(this, function(tname, type) {
502 var myTeam = mkws.teams[tname];
504 myTeam = mkws.teams[tname] = team($, tname);
505 log("made MKWS team '" + tname + "'");
508 var oldHTML = this.innerHTML;
509 var myWidget = widget($, myTeam, type, this);
510 myTeam.addWidget(myWidget);
511 var newHTML = this.innerHTML;
512 if (newHTML !== oldHTML) {
513 log("widget " + tname + ":" + type + " HTML changed: reparsing");
514 makeWidgetsWithin(level+1, $(this));
521 function init(rootsel) {
522 if (!rootsel) var rootsel = ':root';
524 if (typeof mkws_config === 'undefined') {
525 log("setting empty config");
528 log("using config: " + $.toJSON(mkws_config));
529 saved_config = mkws_config;
531 mkws.setMkwsConfig(saved_config);
533 for (var key in mkws.config) {
534 if (mkws.config.hasOwnProperty(key)) {
535 if (key.match(/^language_/)) {
536 var lang = key.replace(/^language_/, "");
537 // Copy custom languages into list
538 mkws.locale_lang[lang] = mkws.config[key];
539 log("added locally configured language '" + lang + "'");
544 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
545 if (!lang || !mkws.locale_lang[lang]) {
546 mkws.config.lang = ""
548 mkws.config.lang = lang;
551 log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
553 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
554 log("reset query width to " + mkws.config.query_width);
555 mkws.config.query_width = 50;
558 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
559 if (mkws.config.pazpar2_url.match(/^\/\//)) {
560 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
561 log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
564 if (mkws.config.responsive_design_width) {
565 // Responsive web design - change layout on the fly based on
566 // current screen width. Required for mobile devices.
567 $(window).resize(resizePage);
568 // initial check after page load
569 $(document).ready(resizePage);
572 // Backwards compatibility: set new magic class names on any
573 // elements that have the old magic IDs.
574 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
575 "Results", "Records", "Targets", "Ranking",
576 "Termlists", "Stat", "MOTD" ];
577 for (var i = 0; i < ids.length; i++) {
578 var id = 'mkws' + ids[i];
579 var node = $('#' + id);
580 if (node.attr('id')) {
582 log("added magic class to '" + node.attr('id') + "'");
587 makeWidgetsWithin(1, $(rootsel));
590 log("walking MKWS nodes took " + (now-then) + " ms");
593 for (var tName in mkws.teams) {
594 var myTeam = mkws.teams[tName]
595 log("team '" + tName + "' = " + myTeam + " ...");
596 myTeam.visitWidgets(function(t, w) {
597 log(" has widget of type '" + t + "': " + w);
602 if (mkws.config.use_service_proxy) {
603 authenticateSession(mkws.config.service_proxy_auth,
604 mkws.config.service_proxy_auth_domain,
605 mkws.config.pazpar2_url);
611 $(document).ready(function() {
612 var widgetSelector = selectorForAllWidgets();
613 if (widgetSelector && $(widgetSelector).length !== 0) init();