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.
14 log_level: 1, // Will be overridden from mkws.config, but
15 // initial value allows jQuery popup to use logging.
17 widgetType2function: {},
22 "Subjects": "Schlagwörter",
23 "Sources": "Daten und Quellen",
24 "source": "datenquelle",
25 "Termlists": "Termlisten",
27 "Prev": "Zurück",
29 "Sort by": "Sortieren nach",
30 "and show": "und zeige",
31 "per page": "pro Seite",
32 "Displaying": "Zeige",
40 "Subject": "Schlagwort",
41 "subject": "schlagwort",
43 "Records": "Datensätze",
44 "Targets": "Datenbanken",
50 "Authors": "Forfattere",
54 "Termlists": "Termlists",
55 "Next": "Næste",
57 "Search": "Søg",
58 "Sort by": "Sorter efter",
60 "per page": "per side",
61 "Displaying": "Viser",
66 "Author": "Forfatter",
67 "author": "forfatter",
71 "Location": "Lokation",
81 mkws.log = function(string) {
85 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
89 // you need to disable use strict at the top of the file!!!
90 if (mkws.log_level >= 3) {
91 // Works in Chrome; not sure about elsewhere
93 } else if (mkws.log_level >= 2) {
94 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
100 // This function is taken from a StackOverflow answer
101 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
102 mkws.getParameterByName = function(name) {
103 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
104 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
105 results = regex.exec(location.search);
106 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
110 mkws.registerWidgetType = function(name, fn) {
111 mkws.widgetType2function[name] = fn;
112 mkws.log("registered widget-type '" + name + "'");
115 mkws.promotionFunction = function(name) {
116 return mkws.widgetType2function[name];
120 mkws.setMkwsConfig = function(overrides) {
121 // Set global log_level flag early so that mkws.log() works
122 // Fall back to old "debug_level" setting for backwards compatibility
123 var tmp = overrides.log_level;
124 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
125 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
127 var config_default = {
128 use_service_proxy: true,
129 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
130 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
132 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
133 perpage_options: [10, 20, 30, 50],
134 sort_default: "relevance",
137 show_lang: true, /* show/hide language menu */
138 show_sort: true, /* show/hide sort menu */
139 show_perpage: true, /* show/hide perpage menu */
140 lang_options: [], /* display languages links for given languages, [] for all */
141 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
142 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
143 log_level: 1, /* log level for development: 0..2 */
148 mkws.config = mkws.objectInheritingFrom(config_default);
149 for (var k in overrides) {
150 mkws.config[k] = overrides[k];
155 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
156 // http://javascript.crockford.com/prototypal.html
157 // mkws.objectInheritingFrom behaves the same as Object.create,
158 // but since the latter is not available in IE8 we can't use it.
160 mkws.objectInheritingFrom = function(o) {
167 mkws.defaultTemplate = function(name) {
168 if (name === 'Record') {
172 <th>{{translate "Title"}}</th>\
175 {{#if md-title-remainder}}\
176 ({{md-title-remainder}})\
178 {{#if md-title-responsibility}}\
179 <i>{{md-title-responsibility}}</i>\
185 <th>{{translate "Date"}}</th>\
186 <td>{{md-date}}</td>\
191 <th>{{translate "Author"}}</th>\
192 <td>{{md-author}}</td>\
195 {{#if md-electronic-url}}\
197 <th>{{translate "Links"}}</th>\
199 {{#each md-electronic-url}}\
200 <a href="{{this}}">Link{{index1}}</a>\
205 {{#if-any location having="md-subject"}}\
207 <th>{{translate "Subject"}}</th>\
209 {{#first location having="md-subject"}}\
211 {{#commaList md-subject}}\
212 {{this}}{{/commaList}}\
219 <th>{{translate "Locations"}}</th>\
221 {{#commaList location}}\
222 {{attr "@name"}}{{/commaList}}\
227 } else if (name === "Summary") {
229 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
232 {{#if md-title-remainder}}\
233 <span>{{md-title-remainder}}</span>\
235 {{#if md-title-responsibility}}\
236 <span><i>{{md-title-responsibility}}</i></span>\
239 } else if (name === "Image") {
241 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
242 {{#first md-thumburl}}\
243 <img src="{{this}}" alt="{{../md-title}}"/>\
250 var s = "There is no default '" + name +"' template!";
256 // The following functions are dispatchers for team methods that
257 // are called from the UI using a team-name rather than implicit
259 mkws.switchView = function(tname, view) {
260 mkws.teams[tname].switchView(view);
263 mkws.showDetails = function(tname, prefixRecId) {
264 mkws.teams[tname].showDetails(prefixRecId);
267 mkws.limitTarget = function(tname, id, name) {
268 mkws.teams[tname].limitTarget(id, name);
271 mkws.limitQuery = function(tname, field, value) {
272 mkws.teams[tname].limitQuery(field, value);
275 mkws.limitCategory = function(tname, id) {
276 mkws.teams[tname].limitCategory(id);
279 mkws.delimitTarget = function(tname, id) {
280 mkws.teams[tname].delimitTarget(id);
283 mkws.delimitQuery = function(tname, field, value) {
284 mkws.teams[tname].delimitQuery(field, value);
287 mkws.showPage = function(tname, pageNum) {
288 mkws.teams[tname].showPage(pageNum);
291 mkws.pagerPrev = function(tname) {
292 mkws.teams[tname].pagerPrev();
295 mkws.pagerNext = function(tname) {
296 mkws.teams[tname].pagerNext();
300 // wrapper to call team() after page load
304 function handleNodeWithTeam(node, callback) {
305 // First branch for DOM objects; second branch for jQuery objects
306 var classes = node.className || node.attr('class');
308 // For some reason, if we try to proceed when classes is
309 // undefined, we don't get an error message, but this
310 // function and its callers, up several stack level,
311 // silently return. What a crock.
312 log("handleNodeWithTeam() called on node with no classes");
315 var list = classes.split(/\s+/)
318 for (var i = 0; i < list.length; i++) {
320 if (cname.match(/^mkwsTeam_/)) {
321 teamName = cname.replace(/^mkwsTeam_/, '');
322 } else if (cname.match(/^mkws/)) {
323 type = cname.replace(/^mkws/, '');
327 if (!teamName) teamName = "AUTO";
328 callback.call(node, teamName, type);
332 function resizePage() {
333 var list = ["mkwsSwitch", "mkwsLang"];
335 var parent = $(".mkwsTermlists").parent();
336 var targetWidth = mkws.config.responsive_design_width;
337 var width = $(window).width();
339 if (mkws.width === undefined) {
340 // No state change, since we have no previous state
341 } else if (mkws.width <= targetWidth && width > targetWidth) {
342 log("narrow -> wide");
343 } else if (mkws.width > targetWidth && width <= targetWidth) {
344 log("wide -> narrow");
345 } else if (width > targetWidth) {
348 log("already narrow");
352 if (width <= targetWidth &&
353 parent.hasClass("mkwsTermlist-Container-wide")) {
354 log("changing from wide to narrow: " + width);
355 $(".mkwsTermlist-Container-wide").hide();
356 $(".mkwsTermlist-Container-narrow").show();
357 for (var tname in mkws.teams) {
358 mkws.teams[tname].queue("resize-narrow").publish();
359 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-narrow.mkwsTeam_" + tname));
360 for(var i = 0; i < list.length; i++) {
361 $("." + list[i] + ".mkwsTeam_" + tname).hide();
364 } else if (width > targetWidth &&
365 parent.hasClass("mkwsTermlist-Container-narrow")) {
366 log("changing from narrow to wide: " + width);
367 $(".mkwsTermlist-Container-wide").show();
368 $(".mkwsTermlist-Container-narrow").hide();
369 for (var tname in mkws.teams) {
370 mkws.teams[tname].queue("resize-wide").publish();
371 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlist-Container-wide.mkwsTeam_" + tname));
372 for(var i = 0; i < list.length; i++) {
373 $("." + list[i] + ".mkwsTeam_" + tname).show();
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 makeWidgetsWithin(level, node) {
433 node.find('[class^="mkws"],[class*=" mkws"]').each(function() {
434 handleNodeWithTeam(this, function(tname, type) {
435 var oldHTML = this.innerHTML;
436 var myTeam = mkws.teams[tname];
437 var myWidget = widget(j, myTeam, type, this);
438 myTeam.addWidget(myWidget);
439 var newHTML = this.innerHTML;
440 if (newHTML !== oldHTML) {
441 log("widget " + tname + ":" + type + " HTML changed from '" + oldHTML + "' to '" + newHTML + "': reparse!");
442 makeWidgetsWithin(level+1, $(this));
449 $(document).ready(function() {
451 if (typeof mkws_config === 'undefined') {
452 log("setting empty config");
455 log("using config: " + $.toJSON(mkws_config));
456 saved_config = mkws_config;
458 mkws.setMkwsConfig(saved_config);
460 for (var key in mkws.config) {
461 if (mkws.config.hasOwnProperty(key)) {
462 if (key.match(/^language_/)) {
463 var lang = key.replace(/^language_/, "");
464 // Copy custom languages into list
465 mkws.locale_lang[lang] = mkws.config[key];
466 log("Added locally configured language '" + lang + "'");
471 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
472 log("Reset query width: " + mkws.config.query_width);
473 mkws.config.query_width = 50;
476 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
477 if (mkws.config.pazpar2_url.match(/^\/\//)) {
478 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
479 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
482 if (mkws.config.responsive_design_width) {
483 // Responsive web design - change layout on the fly based on
484 // current screen width. Required for mobile devices.
485 $(window).resize(resizePage);
486 // initial check after page load
487 $(document).ready(resizePage);
490 // Backwards compatibility: set new magic class names on any
491 // elements that have the old magic IDs.
492 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
493 "Results", "Records", "Targets", "Ranking",
494 "Termlists", "Stat", "MOTD" ];
495 for (var i = 0; i < ids.length; i++) {
496 var id = 'mkws' + ids[i];
497 var node = $('#' + id);
498 if (node.attr('id')) {
500 log("added magic class to '" + node.attr('id') + "'");
504 // Find all nodes with an MKWS class, and determine their team from
505 // the mkwsTeam_* class. Make all team objects.
507 $('[class^="mkws"],[class*=" mkws"]').each(function() {
508 handleNodeWithTeam(this, function(tname, type) {
509 if (!mkws.teams[tname]) {
510 mkws.teams[tname] = team(j, tname);
511 log("Made MKWS team '" + tname + "'");
516 makeWidgetsWithin(1, $(':root'));
519 log("Walking MKWS nodes took " + (now-then) + " ms");
521 // for (var tName in mkws.teams) {
522 // var myTeam = mkws.teams[tName]
523 // var types = myTeam.widgetTypes();
524 // log("TEAM '" + tName + "' = " + myTeam + " has widget types " + types);
525 // for (var i = 0; i < types.length; i++) {
526 // var type = types[i];
527 // log(" has widget of type '" + type + "': " + myTeam.widget(type));
531 if (mkws.config.use_service_proxy) {
532 authenticateSession(mkws.config.service_proxy_auth,
533 mkws.config.service_proxy_auth_domain,
534 mkws.config.pazpar2_url);