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 console.log(arguments.callee.caller);
92 } else if (mkws.log_level >= 2) {
93 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
99 // This function is taken from a StackOverflow answer
100 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
101 mkws.getParameterByName = function(name) {
102 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
103 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
104 results = regex.exec(location.search);
105 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
109 mkws.registerWidgetType = function(name, fn) {
110 mkws.widgetType2function[name] = fn;
111 mkws.log("registered widget-type '" + name + "'");
114 mkws.promotionFunction = function(name) {
115 return mkws.widgetType2function[name];
119 mkws.setMkwsConfig = function(overrides) {
120 // Set global log_level flag early so that mkws.log() works
121 // Fall back to old "debug_level" setting for backwards compatibility
122 var tmp = overrides.log_level;
123 if (typeof(tmp) === 'undefined') tmp = overrides.debug_level;
124 if (typeof(tmp) !== 'undefined') mkws.log_level = tmp;
126 var config_default = {
127 use_service_proxy: true,
128 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
129 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
131 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
132 perpage_options: [10, 20, 30, 50],
133 sort_default: "relevance",
136 show_lang: true, /* show/hide language menu */
137 show_sort: true, /* show/hide sort menu */
138 show_perpage: true, /* show/hide perpage menu */
139 lang_options: [], /* display languages links for given languages, [] for all */
140 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
141 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
142 log_level: 1, /* log level for development: 0..2 */
147 mkws.config = mkws.objectInheritingFrom(config_default);
148 for (var k in overrides) {
149 mkws.config[k] = overrides[k];
154 // This code is from Douglas Crockford's article "Prototypal Inheritance in JavaScript"
155 // http://javascript.crockford.com/prototypal.html
156 // mkws.objectInheritingFrom behaves the same as Object.create,
157 // but since the latter is not available in IE8 we can't use it.
159 mkws.objectInheritingFrom = function(o) {
166 // The following functions are dispatchers for team methods that
167 // are called from the UI using a team-name rather than implicit
169 mkws.switchView = function(tname, view) {
170 mkws.teams[tname].switchView(view);
173 mkws.showDetails = function(tname, prefixRecId) {
174 mkws.teams[tname].showDetails(prefixRecId);
177 mkws.limitTarget = function(tname, id, name) {
178 mkws.teams[tname].limitTarget(id, name);
181 mkws.limitQuery = function(tname, field, value) {
182 mkws.teams[tname].limitQuery(field, value);
185 mkws.delimitTarget = function(tname, id) {
186 mkws.teams[tname].delimitTarget(id);
189 mkws.delimitQuery = function(tname, field, value) {
190 mkws.teams[tname].delimitQuery(field, value);
193 mkws.showPage = function(tname, pageNum) {
194 mkws.teams[tname].showPage(pageNum);
197 mkws.pagerPrev = function(tname) {
198 mkws.teams[tname].pagerPrev();
201 mkws.pagerNext = function(tname) {
202 mkws.teams[tname].pagerNext();
206 // wrapper to call team() after page load
210 function handleNodeWithTeam(node, callback) {
211 // First branch for DOM objects; second branch for jQuery objects
212 var classes = node.className || node.attr('class');
214 // For some reason, if we try to proceed when classes is
215 // undefined, we don't get an error message, but this
216 // function and its callers, up several stack level,
217 // silently return. What a crock.
218 log("handleNodeWithTeam() called on node with no classes");
221 var list = classes.split(/\s+/)
224 for (var i = 0; i < list.length; i++) {
226 if (cname.match(/^mkwsTeam_/)) {
227 teamName = cname.replace(/^mkwsTeam_/, '');
228 } else if (cname.match(/^mkws/)) {
229 type = cname.replace(/^mkws/, '');
233 if (!teamName) teamName = "AUTO";
234 callback.call(node, teamName, type);
238 function resizePage() {
239 var list = ["mkwsSwitch", "mkwsLang"];
241 var width = mkws.config.responsive_design_width;
242 var parent = $(".mkwsTermlists").parent();
244 if ($(window).width() <= width &&
245 parent.hasClass("mkwsTermlistContainer1")) {
246 log("changing from wide to narrow: " + $(window).width());
247 $(".mkwsTermlistContainer1").hide();
248 $(".mkwsTermlistContainer2").show();
249 for (var tname in mkws.teams) {
250 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
251 for(var i = 0; i < list.length; i++) {
252 $("." + list[i] + ".mkwsTeam_" + tname).hide();
255 } else if ($(window).width() > width &&
256 parent.hasClass("mkwsTermlistContainer2")) {
257 log("changing from narrow to wide: " + $(window).width());
258 $(".mkwsTermlistContainer1").show();
259 $(".mkwsTermlistContainer2").hide();
260 for (var tname in mkws.teams) {
261 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
262 for(var i = 0; i < list.length; i++) {
263 $("." + list[i] + ".mkwsTeam_" + tname).show();
271 * Run service-proxy authentication in background (after page load).
272 * The username/password is configured in the apache config file
275 function authenticateSession(auth_url, auth_domain, pp2_url) {
276 log("Run service proxy auth URL: " + auth_url);
279 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
280 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
283 var request = new pzHttpRequest(auth_url, function(err) {
284 alert("HTTP call for authentication failed: " + err)
288 request.get(null, function(data) {
289 if (!$.isXMLDoc(data)) {
290 alert("service proxy auth response document is not valid XML document, give up!");
293 var status = $(data).find("status");
294 if (status.text() != "OK") {
295 alert("service proxy auth response status: " + status.text() + ", give up!");
299 log("Service proxy auth successfully done");
300 mkws.authenticated = true;
301 var authName = $(data).find("displayName").text();
302 for (var teamName in mkws.teams) {
303 mkws.teams[teamName].queue("authenticated").publish(authName);
311 function runAutoSearches() {
312 log("running auto searches");
314 for (var teamName in mkws.teams) {
315 mkws.teams[teamName].queue("ready").publish();
319 $(document).ready(function() {
321 if (typeof mkws_config === 'undefined') {
322 log("setting empty config");
325 log("using config: " + $.toJSON(mkws_config));
326 saved_config = mkws_config;
328 mkws.setMkwsConfig(saved_config);
330 for (var key in mkws.config) {
331 if (mkws.config.hasOwnProperty(key)) {
332 if (key.match(/^language_/)) {
333 var lang = key.replace(/^language_/, "");
334 // Copy custom languages into list
335 mkws.locale_lang[lang] = mkws.config[key];
336 log("Added locally configured language '" + lang + "'");
341 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
342 log("Reset query width: " + mkws.config.query_width);
343 mkws.config.query_width = 50;
346 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
347 if (mkws.config.pazpar2_url.match(/^\/\//)) {
348 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
349 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
352 if (mkws.config.responsive_design_width) {
353 // Responsive web design - change layout on the fly based on
354 // current screen width. Required for mobile devices.
355 $(window).resize(resizePage);
356 // initial check after page load
357 $(document).ready(resizePage);
360 // Backwards compatibility: set new magic class names on any
361 // elements that have the old magic IDs.
362 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
363 "Results", "Records", "Targets", "Ranking",
364 "Termlists", "Stat", "MOTD" ];
365 for (var i = 0; i < ids.length; i++) {
366 var id = 'mkws' + ids[i];
367 var node = $('#' + id);
368 if (node.attr('id')) {
370 log("added magic class to '" + node.attr('id') + "'");
374 // Find all nodes with an MKWS class, and determine their team from
375 // the mkwsTeam_* class. Make all team objects.
377 $('[class^="mkws"],[class*=" mkws"]').each(function() {
378 handleNodeWithTeam(this, function(tname, type) {
379 if (!mkws.teams[tname]) {
380 mkws.teams[tname] = team(j, tname);
381 log("Made MKWS team '" + tname + "'");
385 // Second pass: make the individual widget objects. This has
386 // to be done separately, and after the team-creation, since
387 // that sometimes makes new widget nodes (e.g. creating
388 // mkwsTermlists inside mkwsResults.
389 $('[class^="mkws"],[class*=" mkws"]').each(function() {
390 handleNodeWithTeam(this, function(tname, type) {
391 var myTeam = mkws.teams[tname];
392 var myWidget = widget(j, myTeam, type, this);
393 myTeam.addWidget(myWidget);
397 log("Walking MKWS nodes took " + (now-then) + " ms");
399 if (mkws.config.use_service_proxy) {
400 authenticateSession(mkws.config.service_proxy_auth,
401 mkws.config.service_proxy_auth_domain,
402 mkws.config.pazpar2_url);