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 // The following functions are dispatchers for team methods that
168 // are called from the UI using a team-name rather than implicit
170 mkws.switchView = function(tname, view) {
171 mkws.teams[tname].switchView(view);
174 mkws.showDetails = function(tname, prefixRecId) {
175 mkws.teams[tname].showDetails(prefixRecId);
178 mkws.limitTarget = function(tname, id, name) {
179 mkws.teams[tname].limitTarget(id, name);
182 mkws.limitQuery = function(tname, field, value) {
183 mkws.teams[tname].limitQuery(field, value);
186 mkws.limitCategory = function(tname, id) {
187 mkws.teams[tname].limitCategory(id);
190 mkws.delimitTarget = function(tname, id) {
191 mkws.teams[tname].delimitTarget(id);
194 mkws.delimitQuery = function(tname, field, value) {
195 mkws.teams[tname].delimitQuery(field, value);
198 mkws.showPage = function(tname, pageNum) {
199 mkws.teams[tname].showPage(pageNum);
202 mkws.pagerPrev = function(tname) {
203 mkws.teams[tname].pagerPrev();
206 mkws.pagerNext = function(tname) {
207 mkws.teams[tname].pagerNext();
211 // wrapper to call team() after page load
215 function handleNodeWithTeam(node, callback) {
216 // First branch for DOM objects; second branch for jQuery objects
217 var classes = node.className || node.attr('class');
219 // For some reason, if we try to proceed when classes is
220 // undefined, we don't get an error message, but this
221 // function and its callers, up several stack level,
222 // silently return. What a crock.
223 log("handleNodeWithTeam() called on node with no classes");
226 var list = classes.split(/\s+/)
229 for (var i = 0; i < list.length; i++) {
231 if (cname.match(/^mkwsTeam_/)) {
232 teamName = cname.replace(/^mkwsTeam_/, '');
233 } else if (cname.match(/^mkws/)) {
234 type = cname.replace(/^mkws/, '');
238 if (!teamName) teamName = "AUTO";
239 callback.call(node, teamName, type);
243 function resizePage() {
244 var list = ["mkwsSwitch", "mkwsLang"];
246 var width = mkws.config.responsive_design_width;
247 var parent = $(".mkwsTermlists").parent();
249 if ($(window).width() <= width &&
250 parent.hasClass("mkwsTermlistContainer1")) {
251 log("changing from wide to narrow: " + $(window).width());
252 $(".mkwsTermlistContainer1").hide();
253 $(".mkwsTermlistContainer2").show();
254 for (var tname in mkws.teams) {
255 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
256 for(var i = 0; i < list.length; i++) {
257 $("." + list[i] + ".mkwsTeam_" + tname).hide();
260 } else if ($(window).width() > width &&
261 parent.hasClass("mkwsTermlistContainer2")) {
262 log("changing from narrow to wide: " + $(window).width());
263 $(".mkwsTermlistContainer1").show();
264 $(".mkwsTermlistContainer2").hide();
265 for (var tname in mkws.teams) {
266 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
267 for(var i = 0; i < list.length; i++) {
268 $("." + list[i] + ".mkwsTeam_" + tname).show();
276 * Run service-proxy authentication in background (after page load).
277 * The username/password is configured in the apache config file
280 function authenticateSession(auth_url, auth_domain, pp2_url) {
281 log("Run service proxy auth URL: " + auth_url);
284 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
285 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
288 var request = new pzHttpRequest(auth_url, function(err) {
289 alert("HTTP call for authentication failed: " + err)
293 request.get(null, function(data) {
294 if (!$.isXMLDoc(data)) {
295 alert("service proxy auth response document is not valid XML document, give up!");
298 var status = $(data).find("status");
299 if (status.text() != "OK") {
300 alert("service proxy auth response status: " + status.text() + ", give up!");
304 log("Service proxy auth successfully done");
305 mkws.authenticated = true;
306 var authName = $(data).find("displayName").text();
307 // You'd think there would be a better way to do this:
308 var realm = $(data).find("realm:not(realmAttributes realm)").text();
309 for (var teamName in mkws.teams) {
310 mkws.teams[teamName].queue("authenticated").publish(authName, realm);
318 function runAutoSearches() {
319 log("running auto searches");
321 for (var teamName in mkws.teams) {
322 mkws.teams[teamName].queue("ready").publish();
327 function makeWidgetsWithin(level, node) {
328 node.find('[class^="mkws"],[class*=" mkws"]').each(function() {
329 handleNodeWithTeam(this, function(tname, type) {
330 var oldHTML = this.innerHTML;
331 var myTeam = mkws.teams[tname];
332 var myWidget = widget(j, myTeam, type, this);
333 myTeam.addWidget(myWidget);
334 var newHTML = this.innerHTML;
335 if (newHTML !== oldHTML) {
336 log("widget " + tname + ":" + type + " HTML changed from '" + oldHTML + "' to '" + newHTML + "': reparse!");
337 makeWidgetsWithin(level+1, $(this));
344 $(document).ready(function() {
346 if (typeof mkws_config === 'undefined') {
347 log("setting empty config");
350 log("using config: " + $.toJSON(mkws_config));
351 saved_config = mkws_config;
353 mkws.setMkwsConfig(saved_config);
355 for (var key in mkws.config) {
356 if (mkws.config.hasOwnProperty(key)) {
357 if (key.match(/^language_/)) {
358 var lang = key.replace(/^language_/, "");
359 // Copy custom languages into list
360 mkws.locale_lang[lang] = mkws.config[key];
361 log("Added locally configured language '" + lang + "'");
366 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
367 log("Reset query width: " + mkws.config.query_width);
368 mkws.config.query_width = 50;
371 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
372 if (mkws.config.pazpar2_url.match(/^\/\//)) {
373 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
374 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
377 if (mkws.config.responsive_design_width) {
378 // Responsive web design - change layout on the fly based on
379 // current screen width. Required for mobile devices.
380 $(window).resize(resizePage);
381 // initial check after page load
382 $(document).ready(resizePage);
385 // Backwards compatibility: set new magic class names on any
386 // elements that have the old magic IDs.
387 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
388 "Results", "Records", "Targets", "Ranking",
389 "Termlists", "Stat", "MOTD" ];
390 for (var i = 0; i < ids.length; i++) {
391 var id = 'mkws' + ids[i];
392 var node = $('#' + id);
393 if (node.attr('id')) {
395 log("added magic class to '" + node.attr('id') + "'");
399 // Find all nodes with an MKWS class, and determine their team from
400 // the mkwsTeam_* class. Make all team objects.
402 $('[class^="mkws"],[class*=" mkws"]').each(function() {
403 handleNodeWithTeam(this, function(tname, type) {
404 if (!mkws.teams[tname]) {
405 mkws.teams[tname] = team(j, tname);
406 log("Made MKWS team '" + tname + "'");
411 makeWidgetsWithin(1, $(':root'));
414 log("Walking MKWS nodes took " + (now-then) + " ms");
416 // for (var tName in mkws.teams) {
417 // var myTeam = mkws.teams[tName]
418 // var types = myTeam.widgetTypes();
419 // log("TEAM '" + tName + "' = " + myTeam + " has widget types " + types);
420 // for (var i = 0; i < types.length; i++) {
421 // var type = types[i];
422 // log(" has widget of type '" + type + "': " + myTeam.widget(type));
426 if (mkws.config.use_service_proxy) {
427 authenticateSession(mkws.config.service_proxy_auth,
428 mkws.config.service_proxy_auth_domain,
429 mkws.config.pazpar2_url);