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",
82 mkws.log = function(string) {
86 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
90 // you need to disable use strict at the top of the file!!!
91 if (mkws.log_level >= 3) {
92 // Works in Chrome; not sure about elsewhere
94 } else if (mkws.log_level >= 2) {
95 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
101 // Translation function.
102 mkws.M = function(word) {
103 var lang = mkws.config.lang;
105 if (!lang || !mkws.locale_lang[lang])
108 return mkws.locale_lang[lang][word] || word;
112 // This function is taken from a StackOverflow answer
113 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
114 mkws.getParameterByName = function(name) {
115 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
116 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
117 results = regex.exec(location.search);
118 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
122 mkws.registerWidgetType = function(name, fn) {
123 mkws.widgetType2function[name] = fn;
124 mkws.log("registered widget-type '" + name + "'");
127 mkws.promotionFunction = function(name) {
128 return mkws.widgetType2function[name];
132 mkws.setMkwsConfig = function(overrides) {
133 // Set global log_level flag early so that mkws.log() works
134 // Fall back to old "debug_level" setting for backwards compatibility
135 var tmp = overrides.log_level;
136 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
137 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
139 var config_default = {
140 use_service_proxy: true,
141 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
142 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
144 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
145 perpage_options: [10, 20, 30, 50],
146 sort_default: "relevance",
149 show_lang: true, /* show/hide language menu */
150 show_sort: true, /* show/hide sort menu */
151 show_perpage: true, /* show/hide perpage menu */
152 lang_options: [], /* display languages links for given languages, [] for all */
153 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
154 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
155 log_level: 1, /* log level for development: 0..2 */
160 mkws.config = mkws.objectInheritingFrom(config_default);
161 for (var k in overrides) {
162 mkws.config[k] = overrides[k];
167 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
168 // http://javascript.crockford.com/prototypal.html
169 // mkws.objectInheritingFrom behaves the same as Object.create,
170 // but since the latter is not available in IE8 we can't use it.
172 mkws.objectInheritingFrom = function(o) {
179 mkws.defaultTemplate = function(name) {
180 if (name === 'Record') {
184 <th>{{mkws-translate "Title"}}</th>\
187 {{#if md-title-remainder}}\
188 ({{md-title-remainder}})\
190 {{#if md-title-responsibility}}\
191 <i>{{md-title-responsibility}}</i>\
197 <th>{{mkws-translate "Date"}}</th>\
198 <td>{{md-date}}</td>\
203 <th>{{mkws-translate "Author"}}</th>\
204 <td>{{md-author}}</td>\
207 {{#if md-electronic-url}}\
209 <th>{{mkws-translate "Links"}}</th>\
211 {{#each md-electronic-url}}\
212 <a href="{{this}}">Link{{mkws-index1}}</a>\
217 {{#mkws-if-any location having="md-subject"}}\
219 <th>{{mkws-translate "Subject"}}</th>\
221 {{#mkws-first location having="md-subject"}}\
223 {{#mkws-commaList md-subject}}\
224 {{this}}{{/mkws-commaList}}\
231 <th>{{mkws-translate "Locations"}}</th>\
233 {{#mkws-commaList location}}\
234 {{mkws-attr "@name"}}{{/mkws-commaList}}\
239 } else if (name === "Summary") {
241 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
244 {{#if md-title-remainder}}\
245 <span>{{md-title-remainder}}</span>\
247 {{#if md-title-responsibility}}\
248 <span><i>{{md-title-responsibility}}</i></span>\
251 } else if (name === "Image") {
253 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
254 {{#mkws-first md-thumburl}}\
255 <img src="{{this}}" alt="{{../md-title}}"/>\
262 var s = "There is no default '" + name +"' template!";
268 // The following functions are dispatchers for team methods that
269 // are called from the UI using a team-name rather than implicit
271 mkws.switchView = function(tname, view) {
272 mkws.teams[tname].switchView(view);
275 mkws.showDetails = function(tname, prefixRecId) {
276 mkws.teams[tname].showDetails(prefixRecId);
279 mkws.limitTarget = function(tname, id, name) {
280 mkws.teams[tname].limitTarget(id, name);
283 mkws.limitQuery = function(tname, field, value) {
284 mkws.teams[tname].limitQuery(field, value);
287 mkws.limitCategory = function(tname, id) {
288 mkws.teams[tname].limitCategory(id);
291 mkws.delimitTarget = function(tname, id) {
292 mkws.teams[tname].delimitTarget(id);
295 mkws.delimitQuery = function(tname, field, value) {
296 mkws.teams[tname].delimitQuery(field, value);
299 mkws.showPage = function(tname, pageNum) {
300 mkws.teams[tname].showPage(pageNum);
303 mkws.pagerPrev = function(tname) {
304 mkws.teams[tname].pagerPrev();
307 mkws.pagerNext = function(tname) {
308 mkws.teams[tname].pagerNext();
312 // wrapper to call team() after page load
317 function handleNodeWithTeam(node, callback) {
318 // First branch for DOM objects; second branch for jQuery objects
319 var classes = node.className || node.attr('class');
321 // For some reason, if we try to proceed when classes is
322 // undefined, we don't get an error message, but this
323 // function and its callers, up several stack level,
324 // silently return. What a crock.
325 log("handleNodeWithTeam() called on node with no classes");
328 var list = classes.split(/\s+/)
331 for (var i = 0; i < list.length; i++) {
333 if (cname.match(/^mkwsTeam_/)) {
334 teamName = cname.replace(/^mkwsTeam_/, '');
335 } else if (cname.match(/^mkws/)) {
336 type = cname.replace(/^mkws/, '');
340 if (!teamName) teamName = "AUTO";
341 callback.call(node, teamName, type);
345 function resizePage() {
346 var threshhold = mkws.config.responsive_design_width;
347 var width = $(window).width();
348 var from, to, method;
350 if ((mkws.width === undefined || mkws.width > threshhold) &&
351 width <= threshhold) {
352 from = "wide"; to = "narrow"; method = "hide";
353 } else if ((mkws.width === undefined || mkws.width <= threshhold) &&
354 width > threshhold) {
355 from = "narrow"; to = "wide"; method = "show";
360 log("changing from " + from + " to " + to + ": " + width);
361 for (var tname in mkws.teams) {
362 var team = mkws.teams[tname];
363 team.visitWidgets(function(t, w) {
364 var w1 = team.widget(t + "-Container-" + from);
365 var w2 = team.widget(t + "-Container-" + to);
371 w.jqnode.appendTo(w2.jqnode);
374 team.queue("resize-" + to).publish();
381 * Run service-proxy authentication in background (after page load).
382 * The username/password is configured in the apache config file
385 function authenticateSession(auth_url, auth_domain, pp2_url) {
386 log("Run service proxy auth URL: " + auth_url);
389 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
390 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
393 var request = new pzHttpRequest(auth_url, function(err) {
394 alert("HTTP call for authentication failed: " + err)
398 request.get(null, function(data) {
399 if (!$.isXMLDoc(data)) {
400 alert("service proxy auth response document is not valid XML document, give up!");
403 var status = $(data).find("status");
404 if (status.text() != "OK") {
405 alert("service proxy auth response status: " + status.text() + ", give up!");
409 log("Service proxy auth successfully done");
410 mkws.authenticated = true;
411 var authName = $(data).find("displayName").text();
412 // You'd think there would be a better way to do this:
413 var realm = $(data).find("realm:not(realmAttributes realm)").text();
414 for (var teamName in mkws.teams) {
415 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
423 function runAutoSearches() {
424 log("running auto searches");
426 for (var teamName in mkws.teams) {
427 mkws.teams[teamName].queue("ready").publish();
432 function selectorForAllWidgets() {
433 if (mkws.config.scan_all_nodes) {
434 // This is the old version, which works by telling jQuery to
435 // find every node that has a class beginning with "mkws". In
436 // theory it should be slower than the class-based selector; but
437 // instrumentation suprisnigly shows this is consistently
438 // faster. It also has the advantage that any widgets of
439 // non-registered types are logged as warnings rather than
441 return '[class^="mkws"],[class*=" mkws"]';
443 // This is the new version, which works by looking up the
444 // specific classes of all registered widget types and their
445 // resize containers. Because all it requires jQuery to do is
446 // some hash lookups in pre-built tables, it should be very
447 // fast; but it silently ignores widgets of unregistered types.
449 for (var type in mkws.widgetType2function) {
452 s += ',.mkws' + type + "-Container-wide";
453 s += ',.mkws' + type + "-Container-narrow";
455 log("selector is '" + s + "'");
461 function makeWidgetsWithin(level, node) {
462 node.find(selectorForAllWidgets()).each(function() {
463 handleNodeWithTeam(this, function(tname, type) {
464 var myTeam = mkws.teams[tname];
466 myTeam = mkws.teams[tname] = team(j, tname);
467 log("Made MKWS team '" + tname + "'");
470 var oldHTML = this.innerHTML;
471 var myWidget = widget(j, myTeam, type, this);
472 myTeam.addWidget(myWidget);
473 var newHTML = this.innerHTML;
474 if (newHTML !== oldHTML) {
475 log("widget " + tname + ":" + type + " HTML changed: reparsing");
476 makeWidgetsWithin(level+1, $(this));
483 $(document).ready(function() {
485 if (typeof mkws_config === 'undefined') {
486 log("setting empty config");
489 log("using config: " + $.toJSON(mkws_config));
490 saved_config = mkws_config;
492 mkws.setMkwsConfig(saved_config);
494 for (var key in mkws.config) {
495 if (mkws.config.hasOwnProperty(key)) {
496 if (key.match(/^language_/)) {
497 var lang = key.replace(/^language_/, "");
498 // Copy custom languages into list
499 mkws.locale_lang[lang] = mkws.config[key];
500 log("Added locally configured language '" + lang + "'");
505 var lang = mkws.getParameterByName("lang") || mkws.config.lang;
506 if (!lang || !mkws.locale_lang[lang]) {
507 mkws.config.lang = ""
509 mkws.config.lang = lang;
512 log("Locale language: " + (mkws.config.lang ? mkws.config.lang : "none"));
514 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
515 log("Reset query width: " + mkws.config.query_width);
516 mkws.config.query_width = 50;
519 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
520 if (mkws.config.pazpar2_url.match(/^\/\//)) {
521 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
522 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
525 if (mkws.config.responsive_design_width) {
526 // Responsive web design - change layout on the fly based on
527 // current screen width. Required for mobile devices.
528 $(window).resize(resizePage);
529 // initial check after page load
530 $(document).ready(resizePage);
533 // Backwards compatibility: set new magic class names on any
534 // elements that have the old magic IDs.
535 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
536 "Results", "Records", "Targets", "Ranking",
537 "Termlists", "Stat", "MOTD" ];
538 for (var i = 0; i < ids.length; i++) {
539 var id = 'mkws' + ids[i];
540 var node = $('#' + id);
541 if (node.attr('id')) {
543 log("added magic class to '" + node.attr('id') + "'");
548 makeWidgetsWithin(1, $(':root'));
551 log("Walking MKWS nodes took " + (now-then) + " ms");
554 for (var tName in mkws.teams) {
555 var myTeam = mkws.teams[tName]
556 log("TEAM '" + tName + "' = " + myTeam + " ...");
557 myTeam.visitWidgets(function(t, w) {
558 log(" has widget of type '" + t + "': " + w);
563 if (mkws.config.use_service_proxy) {
564 authenticateSession(mkws.config.service_proxy_auth,
565 mkws.config.service_proxy_auth_domain,
566 mkws.config.pazpar2_url);