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.
13 $: $, // Our own local copy of the jQuery object
15 log_level: 1, // Will be overridden from mkws.config, but
16 // initial value allows jQuery popup to use logging.
18 widgetType2function: {},
23 "Subjects": "Schlagwörter",
24 "Sources": "Daten und Quellen",
25 "source": "datenquelle",
26 "Termlists": "Termlisten",
28 "Prev": "Zurück",
30 "Sort by": "Sortieren nach",
31 "and show": "und zeige",
32 "per page": "pro Seite",
33 "Displaying": "Zeige",
41 "Subject": "Schlagwort",
42 "subject": "schlagwort",
44 "Records": "Datensätze",
45 "Targets": "Datenbanken",
51 "Authors": "Forfattere",
55 "Termlists": "Termlists",
56 "Next": "Næste",
58 "Search": "Søg",
59 "Sort by": "Sorter efter",
61 "per page": "per side",
62 "Displaying": "Viser",
67 "Author": "Forfatter",
68 "author": "forfatter",
72 "Location": "Lokation",
81 // We may be using a separate copy
82 if (typeof(mkws_jQuery) !== "undefined") {
88 mkws.log = function(string) {
92 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
96 // you need to disable use strict at the top of the file!!!
97 if (mkws.log_level >= 3) {
98 // Works in Chrome; not sure about elsewhere
100 } else if (mkws.log_level >= 2) {
101 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
107 // Incredible that the standard JavaScript runtime doesn't define a
108 // unique windowId. Instead, we have to make one up. And since there's
109 // no global area shared between windows, the best we can do for
110 // ensuring uniqueness is generating a random ID and crossing our
111 // fingers. We stash this in window.name, as it's the only place to
112 // keep data that is preserved across reloads and within-site
113 // navigation. pz2.js picks this up and uses it as part of the
114 // cookie-name, to ensure each tab gets its own session.
116 mkws.log("Using existing window.name '" + window.name + "'");
118 // Ten chars from 26 alpha-numerics = 36^10 = 3.65e15 combinations.
119 // At one per second, it will take 116 million years to duplicate a session
120 window.name = Math.random().toString(36).slice(2, 12);
121 mkws.log("Generated new window.name '" + window.name + "'");
125 // Translation function.
126 mkws.M = function(word) {
127 var lang = mkws.config.lang;
129 if (!lang || !mkws.locale_lang[lang])
132 return mkws.locale_lang[lang][word] || word;
136 // This function is taken from a StackOverflow answer
137 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
138 mkws.getParameterByName = function(name, url) {
139 if (!url) url = location.search;
140 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
141 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
142 results = regex.exec(url);
143 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
147 mkws.registerWidgetType = function(name, fn) {
148 mkws.widgetType2function[name] = fn;
149 mkws.log("registered widget-type '" + name + "'");
152 mkws.promotionFunction = function(name) {
153 return mkws.widgetType2function[name];
157 mkws.setMkwsConfig = function(overrides) {
158 // Set global log_level flag early so that mkws.log() works
159 // Fall back to old "debug_level" setting for backwards compatibility
160 var tmp = overrides.log_level;
161 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
162 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
164 var config_default = {
165 use_service_proxy: true,
166 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
167 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
169 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
170 perpage_options: [10, 20, 30, 50],
171 sort_default: "relevance",
174 show_lang: true, /* show/hide language menu */
175 show_sort: true, /* show/hide sort menu */
176 show_perpage: true, /* show/hide perpage menu */
177 show_switch: true, /* show/hide switch menu */
178 lang_options: [], /* display languages links for given languages, [] for all */
179 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
180 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
181 log_level: 1, /* log level for development: 0..2 */
186 mkws.config = mkws.objectInheritingFrom(config_default);
187 for (var k in overrides) {
188 mkws.config[k] = overrides[k];
193 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
194 // http://javascript.crockford.com/prototypal.html
195 // mkws.objectInheritingFrom behaves the same as Object.create,
196 // but since the latter is not available in IE8 we can't use it.
198 mkws.objectInheritingFrom = function(o) {
205 mkws.defaultTemplate = function(name) {
206 if (name === 'Record') {
210 <th>{{mkws-translate "Title"}}</th>\
213 {{#if md-title-remainder}}\
214 ({{md-title-remainder}})\
216 {{#if md-title-responsibility}}\
217 <i>{{md-title-responsibility}}</i>\
223 <th>{{mkws-translate "Date"}}</th>\
224 <td>{{md-date}}</td>\
229 <th>{{mkws-translate "Author"}}</th>\
230 <td>{{md-author}}</td>\
233 {{#if md-electronic-url}}\
235 <th>{{mkws-translate "Links"}}</th>\
237 {{#each md-electronic-url}}\
238 <a href="{{this}}">Link{{mkws-index1}}</a>\
243 {{#mkws-if-any location having="md-subject"}}\
245 <th>{{mkws-translate "Subject"}}</th>\
247 {{#mkws-first location having="md-subject"}}\
249 {{#mkws-commaList md-subject}}\
250 {{this}}{{/mkws-commaList}}\
257 <th>{{mkws-translate "Locations"}}</th>\
259 {{#mkws-commaList location}}\
260 {{mkws-attr "@name"}}{{/mkws-commaList}}\
265 } else if (name === "Summary") {
267 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
270 {{#if md-title-remainder}}\
271 <span>{{md-title-remainder}}</span>\
273 {{#if md-title-responsibility}}\
274 <span><i>{{md-title-responsibility}}</i></span>\
276 {{#if md-date}}, {{md-date}}\
278 , {{#mkws-first location}}{{mkws-attr "@name"}}{{/mkws-first}}\
281 <span>, {{md-medium}}</span>\
285 } else if (name === "Image") {
287 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
288 {{#mkws-first md-thumburl}}\
289 <img src="{{this}}" alt="{{../md-title}}"/>\
294 } else if (name === 'Facet') {
298 onclick="mkws.{{fn}}(\'{{team}}\', \'{{field}}\', \'{{term}}\');return false;"\
301 <span>{{count}}</span>\
309 // The following functions are dispatchers for team methods that
310 // are called from the UI using a team-name rather than implicit
312 mkws.switchView = function(tname, view) {
313 mkws.teams[tname].switchView(view);
316 mkws.showDetails = function(tname, prefixRecId) {
317 mkws.teams[tname].showDetails(prefixRecId);
320 mkws.limitTarget = function(tname, id, name) {
321 mkws.teams[tname].limitTarget(id, name);
324 mkws.limitQuery = function(tname, field, value) {
325 mkws.teams[tname].limitQuery(field, value);
328 mkws.limitCategory = function(tname, id) {
329 mkws.teams[tname].limitCategory(id);
332 mkws.delimitTarget = function(tname, id) {
333 mkws.teams[tname].delimitTarget(id);
336 mkws.delimitQuery = function(tname, field, value) {
337 mkws.teams[tname].delimitQuery(field, value);
340 mkws.showPage = function(tname, pageNum) {
341 mkws.teams[tname].showPage(pageNum);
344 mkws.pagerPrev = function(tname) {
345 mkws.teams[tname].pagerPrev();
348 mkws.pagerNext = function(tname) {
349 mkws.teams[tname].pagerNext();
353 // wrapper to provide local copy of the jQuery object.
357 function handleNodeWithTeam(node, callback) {
358 // First branch for DOM objects; second branch for jQuery objects
359 var classes = node.className || node.attr('class');
361 // For some reason, if we try to proceed when classes is
362 // undefined, we don't get an error message, but this
363 // function and its callers, up several stack level,
364 // silently return. What a crock.
365 log("handleNodeWithTeam() called on node with no classes");
368 var list = classes.split(/\s+/)
371 for (var i = 0; i < list.length; i++) {
373 if (cname.match(/^mkwsTeam_/)) {
374 teamName = cname.replace(/^mkwsTeam_/, '');
375 } else if (cname.match(/^mkws/)) {
376 type = cname.replace(/^mkws/, '');
380 if (!teamName) teamName = "AUTO";
381 callback.call(node, teamName, type);
385 function resizePage() {
386 var threshhold = mkws.config.responsive_design_width;
387 var width = $(window).width();
388 var from, to, method;
390 if ((mkws.width === undefined || mkws.width > threshhold) &&
391 width <= threshhold) {
392 from = "wide"; to = "narrow"; method = "hide";
393 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
394 width > threshhold) {
395 from = "narrow"; to = "wide"; method = "show";
400 log("changing from " + from + " to " + to + ": " + width);
401 for (var tname in mkws.teams) {
402 var team = mkws.teams[tname];
403 team.visitWidgets(function(t, w) {
404 var w1 = team.widget(t + "-Container-" + from);
405 var w2 = team.widget(t + "-Container-" + to);
411 w.node.appendTo(w2.node);
414 team.queue("resize-" + to).publish();
421 * Run service-proxy authentication in background (after page load).
422 * The username/password is configured in the apache config file
425 function authenticateSession(auth_url, auth_domain, pp2_url) {
426 log("service proxy authentication on URL: " + auth_url);
429 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
430 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
433 var request = new pzHttpRequest(auth_url, function(err) {
434 alert("HTTP call for authentication failed: " + err)
438 request.get(null, function(data) {
439 if (!$.isXMLDoc(data)) {
440 alert("Service Proxy authentication response is not a valid XML document");
443 var status = $(data).find("status");
444 if (status.text() != "OK") {
445 var message = $(data).find("message");
446 alert("Service Proxy authentication response: " + status.text() + " (" + message.text() + ")");
450 log("service proxy authentication successful");
451 mkws.authenticated = true;
452 var authName = $(data).find("displayName").text();
453 // You'd think there would be a better way to do this:
454 var realm = $(data).find("realm:not(realmAttributes realm)").text();
455 for (var teamName in mkws.teams) {
456 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
464 function runAutoSearches() {
465 log("running auto searches");
467 for (var teamName in mkws.teams) {
468 mkws.teams[teamName].queue("ready").publish();
473 function selectorForAllWidgets() {
474 if (mkws.config && mkws.config.scan_all_nodes) {
475 // This is the old version, which works by telling jQuery to
476 // find every node that has a class beginning with "mkws". In
477 // theory it should be slower than the class-based selector; but
478 // instrumentation suprisnigly shows this is consistently
479 // faster. It also has the advantage that any widgets of
480 // non-registered types are logged as warnings rather than
482 return '[class^="mkws"],[class*=" mkws"]';
484 // This is the new version, which works by looking up the
485 // specific classes of all registered widget types and their
486 // resize containers. Because all it requires jQuery to do is
487 // some hash lookups in pre-built tables, it should be very
488 // fast; but it silently ignores widgets of unregistered types.
490 for (var type in mkws.widgetType2function) {
493 s += ',.mkws' + type + "-Container-wide";
494 s += ',.mkws' + type + "-Container-narrow";
501 function makeWidgetsWithin(level, node) {
502 node.find(selectorForAllWidgets()).each(function() {
503 handleNodeWithTeam(this, function(tname, type) {
504 var myTeam = mkws.teams[tname];
506 myTeam = mkws.teams[tname] = team($, tname);
507 log("made MKWS team '" + tname + "'");
510 var oldHTML = this.innerHTML;
511 var myWidget = widget($, myTeam, type, this);
512 myTeam.addWidget(myWidget);
513 var newHTML = this.innerHTML;
514 if (newHTML !== oldHTML) {
515 log("widget " + tname + ":" + type + " HTML changed: reparsing");
516 makeWidgetsWithin(level+1, $(this));
523 function init(rootsel) {
524 if (!rootsel) var rootsel = ':root';
526 if (typeof mkws_config === 'undefined') {
527 log("setting empty config");
530 log("using config: " + $.toJSON(mkws_config));
531 saved_config = mkws_config;
533 mkws.setMkwsConfig(saved_config);
535 for (var key in mkws.config) {
536 if (mkws.config.hasOwnProperty(key)) {
537 if (key.match(/^language_/)) {
538 var lang = key.replace(/^language_/, "");
539 // Copy custom languages into list
540 mkws.locale_lang[lang] = mkws.config[key];
541 log("added locally configured language '" + lang + "'");
546 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
547 if (!lang || !mkws.locale_lang[lang]) {
548 mkws.config.lang = ""
550 mkws.config.lang = lang;
553 log("using language: " + (mkws.config.lang ? mkws.config.lang : "none"));
555 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
556 log("reset query width to " + mkws.config.query_width);
557 mkws.config.query_width = 50;
560 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
561 if (mkws.config.pazpar2_url.match(/^\/\//)) {
562 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
563 log("adjusted protocol independent link to " + mkws.config.pazpar2_url);
566 if (mkws.config.responsive_design_width) {
567 // Responsive web design - change layout on the fly based on
568 // current screen width. Required for mobile devices.
569 $(window).resize(resizePage);
570 // initial check after page load
571 $(document).ready(resizePage);
574 // Backwards compatibility: set new magic class names on any
575 // elements that have the old magic IDs.
576 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
577 "Results", "Records", "Targets", "Ranking",
578 "Termlists", "Stat", "MOTD" ];
579 for (var i = 0; i < ids.length; i++) {
580 var id = 'mkws' + ids[i];
581 var node = $('#' + id);
582 if (node.attr('id')) {
584 log("added magic class to '" + node.attr('id') + "'");
589 makeWidgetsWithin(1, $(rootsel));
592 log("walking MKWS nodes took " + (now-then) + " ms");
595 for (var tName in mkws.teams) {
596 var myTeam = mkws.teams[tName]
597 log("team '" + tName + "' = " + myTeam + " ...");
598 myTeam.visitWidgets(function(t, w) {
599 log(" has widget of type '" + t + "': " + w);
604 if (mkws.config.use_service_proxy) {
605 authenticateSession(mkws.config.service_proxy_auth,
606 mkws.config.service_proxy_auth_domain,
607 mkws.config.pazpar2_url);
613 $(document).ready(function() {
614 var widgetSelector = selectorForAllWidgets();
615 if (widgetSelector && $(widgetSelector).length !== 0) init();