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.
16 paz: undefined, // will be set up during initialisation
21 "Subjects": "Schlagwörter",
22 "Sources": "Daten und Quellen",
23 "source": "datenquelle",
24 "Termlists": "Termlisten",
26 "Prev": "Zurück",
28 "Sort by": "Sortieren nach",
29 "and show": "und zeige",
30 "per page": "pro Seite",
31 "Displaying": "Zeige",
39 "Subject": "Schlagwort",
40 "subject": "schlagwort",
42 "Records": "Datensätze",
43 "Targets": "Datenbanken",
49 "Authors": "Forfattere",
53 "Termlists": "Termlists",
54 "Next": "Næste",
56 "Search": "Søg",
57 "Sort by": "Sorter efter",
59 "per page": "per side",
60 "Displaying": "Viser",
65 "Author": "Forfatter",
66 "author": "forfatter",
70 "Location": "Lokation",
80 // Define empty mkws_config for simple applications that don't define it.
81 if (mkws_config == null || typeof mkws_config != 'object') {
86 // wrapper to call team() after page load
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 console.log(arguments.callee.caller);
99 } else if (mkws.log_level >= 2) {
100 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
107 mkws.handleNodeWithTeam = function(node, callback) {
108 // First branch for DOM objects; second branch for jQuery objects
109 var classes = node.className || node.attr('class');
111 // For some reason, if we try to proceed when classes is
112 // undefined, we don't get an error message, but this
113 // function and its callers, up several stack level,
114 // silently return. What a crock.
115 mkws.log("handleNodeWithTeam() called on node with no classes");
118 var list = classes.split(/\s+/)
121 for (var i = 0; i < list.length; i++) {
123 if (cname.match(/^mkwsTeam_/)) {
124 teamName = cname.replace(/^mkwsTeam_/, '');
125 } else if (cname.match(/^mkws/)) {
126 type = cname.replace(/^mkws/, '');
129 callback.call(node, teamName, type);
133 mkws.resizePage = function () {
134 var list = ["mkwsSwitch", "mkwsLang"];
136 var width = mkws_config.responsive_design_width;
137 var parent = $(".mkwsTermlists").parent();
139 if ($(window).width() <= width &&
140 parent.hasClass("mkwsTermlistContainer1")) {
141 log("changing from wide to narrow: " + $(window).width());
142 $(".mkwsTermlistContainer1").hide();
143 $(".mkwsTermlistContainer2").show();
144 for (var tname in mkws.teams) {
145 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
146 for(var i = 0; i < list.length; i++) {
147 $("." + list[i] + ".mkwsTeam_" + tname).hide();
150 } else if ($(window).width() > width &&
151 parent.hasClass("mkwsTermlistContainer2")) {
152 log("changing from narrow to wide: " + $(window).width());
153 $(".mkwsTermlistContainer1").show();
154 $(".mkwsTermlistContainer2").hide();
155 for (var tname in mkws.teams) {
156 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
157 for(var i = 0; i < list.length; i++) {
158 $("." + list[i] + ".mkwsTeam_" + tname).show();
165 mkws.switchView = function(tname, view) {
166 mkws.teams[tname].switchView(view);
169 mkws.showDetails = function (tname, prefixRecId) {
170 mkws.teams[tname].showDetails(prefixRecId);
173 mkws.limitTarget = function (tname, id, name) {
174 mkws.teams[tname].limitTarget(id, name);
177 mkws.limitQuery = function (tname, field, value) {
178 mkws.teams[tname].limitQuery(field, value);
181 mkws.delimitTarget = function (tname, id) {
182 mkws.teams[tname].delimitTarget(id);
185 mkws.delimitQuery = function (tname, field, value) {
186 mkws.teams[tname].delimitQuery(field, value);
189 mkws.showPage = function (tname, pageNum) {
190 mkws.teams[tname].showPage(pageNum);
193 mkws.pagerPrev = function (tname) {
194 mkws.teams[tname].pagerPrev();
197 mkws.pagerNext = function (tname) {
198 mkws.teams[tname].pagerNext();
202 // This function is taken from a StackOverflow answer
203 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
204 mkws.getParameterByName = function(name) {
205 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
206 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
207 results = regex.exec(location.search);
208 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
212 mkws.defaultTemplate = function(name)
214 if (name === 'Record') {
218 <th>{{translate "Title"}}</th>\
221 {{#if md-title-remainder}}\
222 ({{md-title-remainder}})\
224 {{#if md-title-responsibility}}\
225 <i>{{md-title-responsibility}}</i>\
231 <th>{{translate "Date"}}</th>\
232 <td>{{md-date}}</td>\
237 <th>{{translate "Author"}}</th>\
238 <td>{{md-author}}</td>\
241 {{#if md-electronic-url}}\
243 <th>{{translate "Links"}}</th>\
245 {{#each md-electronic-url}}\
246 <a href="{{this}}">Link{{index1}}</a>\
251 {{#if-any location having="md-subject"}}\
253 <th>{{translate "Subject"}}</th>\
255 {{#first location having="md-subject"}}\
257 {{#commaList md-subject}}\
258 {{this}}{{/commaList}}\
265 <th>{{translate "Locations"}}</th>\
267 {{#commaList location}}\
268 {{attr "@name"}}{{/commaList}}\
273 } else if (name === "Summary") {
275 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
278 {{#if md-title-remainder}}\
279 <span>{{md-title-remainder}}</span>\
281 {{#if md-title-responsibility}}\
282 <span><i>{{md-title-responsibility}}</i></span>\
287 var s = "There is no default '" + name +"' template!";
293 function defaultMkwsConfig() {
294 /* default mkws config */
295 var config_default = {
296 use_service_proxy: true,
297 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
298 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
300 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
301 perpage_options: [10, 20, 30, 50],
302 sort_default: "relevance",
305 show_lang: true, /* show/hide language menu */
306 show_sort: true, /* show/hide sort menu */
307 show_perpage: true, /* show/hide perpage menu */
308 lang_options: [], /* display languages links for given languages, [] for all */
309 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
310 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
311 log_level: 1, /* log level for development: 0..2 */
316 // Set global log_level flag early so that log() works
317 // Fall back to old "debug_level" setting for backwards compatibility
318 var tmp = mkws_config.log_level;
319 if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
321 if (typeof(tmp) !== 'undefined') {
322 mkws.log_level = tmp;
323 } else if (typeof(config_default.log_level) !== 'undefined') {
324 mkws.log_level = config_default.log_level;
327 // make sure the mkws_config is a valid hash
328 if (!$.isPlainObject(mkws_config)) {
329 log("ERROR: mkws_config is not an JS object, ignore it....");
333 /* override standard config values by function parameters */
334 for (var k in config_default) {
335 if (typeof mkws_config[k] === 'undefined')
336 mkws_config[k] = config_default[k];
337 //log("Set config: " + k + ' => ' + mkws_config[k]);
343 * Run service-proxy authentication in background (after page load).
344 * The username/password is configured in the apache config file
347 function authenticateSession(auth_url, auth_domain, pp2_url) {
348 log("Run service proxy auth URL: " + auth_url);
351 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
352 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
355 var request = new pzHttpRequest(auth_url, function(err) {
356 alert("HTTP call for authentication failed: " + err)
360 request.get(null, function(data) {
361 if (!$.isXMLDoc(data)) {
362 alert("service proxy auth response document is not valid XML document, give up!");
365 var status = $(data).find("status");
366 if (status.text() != "OK") {
367 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
371 log("Service proxy auth successfully done");
372 mkws.authenticated = true;
378 function runAutoSearches() {
379 log("running auto searches");
381 for (var teamName in mkws.teams) {
382 mkws.teams[teamName].runAutoSearch();
387 $(document).ready(function() {
388 log("on load ready");
391 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
392 log("Reset query width: " + mkws_config.query_width);
393 mkws_config.query_width = 50;
396 for (var key in mkws_config) {
397 if (mkws_config.hasOwnProperty(key)) {
398 if (key.match(/^language_/)) {
399 var lang = key.replace(/^language_/, "");
400 // Copy custom languages into list
401 mkws.locale_lang[lang] = mkws_config[key];
402 log("Added locally configured language '" + lang + "'");
407 if (mkws_config.responsive_design_width) {
408 // Responsive web design - change layout on the fly based on
409 // current screen width. Required for mobile devices.
410 $(window).resize(function(e) { mkws.resizePage() });
411 // initial check after page load
412 $(document).ready(function() { mkws.resizePage() });
415 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
416 if (mkws_config.pazpar2_url.match(/^\/\//)) {
417 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
418 log("adjust protocol independent links: " + mkws_config.pazpar2_url);
421 // Backwards compatibility: set new magic class names on any
422 // elements that have the old magic IDs.
423 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
424 "Results", "Records", "Targets", "Ranking",
425 "Termlists", "Stat", "MOTD" ];
426 for (var i = 0; i < ids.length; i++) {
427 var id = 'mkws' + ids[i];
428 var node = $('#' + id);
429 if (node.attr('id')) {
431 log("added magic class to '" + node.attr('id') + "'");
435 // For all MKWS-classed nodes that don't have a team
436 // specified, set the team to AUTO.
437 $('[class^="mkws"],[class*=" mkws"]').each(function () {
438 if (!this.className.match(/mkwsTeam_/)) {
439 log("adding AUTO team to node with class '" + this.className + "'");
440 $(this).addClass('mkwsTeam_AUTO');
444 // Find all nodes with an MKWS class, and determine their team from
445 // the mkwsTeam_* class. Make all team objects.
447 $('[class^="mkws"],[class*=" mkws"]').each(function () {
448 mkws.handleNodeWithTeam(this, function(tname, type) {
449 if (!mkws.teams[tname]) {
450 mkws.teams[tname] = team(j, tname);
451 log("Made MKWS team '" + tname + "'");
455 // Second pass: make the individual widget objects. This has
456 // to be done separately, and after the team-creation, since
457 // that sometimes makes new widget nodes (e.g. creating
458 // mkwsTermlists inside mkwsResults.
459 $('[class^="mkws"],[class*=" mkws"]').each(function () {
460 mkws.handleNodeWithTeam(this, function(tname, type) {
461 var myTeam = mkws.teams[tname];
462 var myWidget = widget(j, myTeam, type, this);
466 log("Walking MKWS nodes took " + (now-then) + " ms");
468 if (mkws_config.use_service_proxy) {
469 authenticateSession(mkws_config.service_proxy_auth,
470 mkws_config.service_proxy_auth_domain,
471 mkws_config.pazpar2_url);