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 // Define empty mkws_config for simple applications that don't define it.
82 if (mkws_config == null || typeof mkws_config != 'object') {
87 mkws.log = function(string) {
91 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
95 // you need to disable use strict at the top of the file!!!
96 if (mkws.log_level >= 3) {
97 console.log(arguments.callee.caller);
98 } else if (mkws.log_level >= 2) {
99 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
105 mkws.objectWithParent = function(parent) {
106 function thing() {} // Must be function so `prototype' works
108 thing.prototype = parent;
109 var res = new thing();
110 thing.prototype = null;
115 mkws.registerWidgetType = function(name, fn) {
116 mkws.widgetType2function[name] = fn;
117 mkws.log("registered widget-type '" + name + "'");
120 mkws.promotionFunction = function(name) {
121 return mkws.widgetType2function[name];
125 mkws.defaultMkwsConfig = function() {
126 mkws.config = mkws_config;
128 /* default mkws config */
129 var config_default = {
130 use_service_proxy: true,
131 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
132 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
134 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
135 perpage_options: [10, 20, 30, 50],
136 sort_default: "relevance",
139 show_lang: true, /* show/hide language menu */
140 show_sort: true, /* show/hide sort menu */
141 show_perpage: true, /* show/hide perpage menu */
142 lang_options: [], /* display languages links for given languages, [] for all */
143 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
144 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
145 log_level: 1, /* log level for development: 0..2 */
150 // Set global log_level flag early so that log() works
151 // Fall back to old "debug_level" setting for backwards compatibility
152 var tmp = mkws.config.log_level;
153 if (typeof(tmp) === 'undefined') tmp = mkws.config.debug_level;
155 if (typeof(tmp) !== 'undefined') {
156 mkws.log_level = tmp;
157 } else if (typeof(config_default.log_level) !== 'undefined') {
158 mkws.log_level = config_default.log_level;
161 /* override standard config values by function parameters */
162 for (var k in config_default) {
163 if (typeof mkws.config[k] === 'undefined')
164 mkws.config[k] = config_default[k];
165 //log("Set config: " + k + ' => ' + mkws.config[k]);
170 // The following functions are dispatchers for team methods that
171 // are called from the UI using a team-name rather than implicit
173 mkws.switchView = function(tname, view) {
174 mkws.teams[tname].switchView(view);
177 mkws.showDetails = function(tname, prefixRecId) {
178 mkws.teams[tname].showDetails(prefixRecId);
181 mkws.limitTarget = function(tname, id, name) {
182 mkws.teams[tname].limitTarget(id, name);
185 mkws.limitQuery = function(tname, field, value) {
186 mkws.teams[tname].limitQuery(field, value);
189 mkws.delimitTarget = function(tname, id) {
190 mkws.teams[tname].delimitTarget(id);
193 mkws.delimitQuery = function(tname, field, value) {
194 mkws.teams[tname].delimitQuery(field, value);
197 mkws.showPage = function(tname, pageNum) {
198 mkws.teams[tname].showPage(pageNum);
201 mkws.pagerPrev = function(tname) {
202 mkws.teams[tname].pagerPrev();
205 mkws.pagerNext = function(tname) {
206 mkws.teams[tname].pagerNext();
210 // wrapper to call team() after page load
214 function handleNodeWithTeam(node, callback) {
215 // First branch for DOM objects; second branch for jQuery objects
216 var classes = node.className || node.attr('class');
218 // For some reason, if we try to proceed when classes is
219 // undefined, we don't get an error message, but this
220 // function and its callers, up several stack level,
221 // silently return. What a crock.
222 log("handleNodeWithTeam() called on node with no classes");
225 var list = classes.split(/\s+/)
228 for (var i = 0; i < list.length; i++) {
230 if (cname.match(/^mkwsTeam_/)) {
231 teamName = cname.replace(/^mkwsTeam_/, '');
232 } else if (cname.match(/^mkws/)) {
233 type = cname.replace(/^mkws/, '');
236 callback.call(node, teamName, type);
240 function resizePage() {
241 var list = ["mkwsSwitch", "mkwsLang"];
243 var width = mkws.config.responsive_design_width;
244 var parent = $(".mkwsTermlists").parent();
246 if ($(window).width() <= width &&
247 parent.hasClass("mkwsTermlistContainer1")) {
248 log("changing from wide to narrow: " + $(window).width());
249 $(".mkwsTermlistContainer1").hide();
250 $(".mkwsTermlistContainer2").show();
251 for (var tname in mkws.teams) {
252 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
253 for(var i = 0; i < list.length; i++) {
254 $("." + list[i] + ".mkwsTeam_" + tname).hide();
257 } else if ($(window).width() > width &&
258 parent.hasClass("mkwsTermlistContainer2")) {
259 log("changing from narrow to wide: " + $(window).width());
260 $(".mkwsTermlistContainer1").show();
261 $(".mkwsTermlistContainer2").hide();
262 for (var tname in mkws.teams) {
263 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
264 for(var i = 0; i < list.length; i++) {
265 $("." + list[i] + ".mkwsTeam_" + tname).show();
273 * Run service-proxy authentication in background (after page load).
274 * The username/password is configured in the apache config file
277 function authenticateSession(auth_url, auth_domain, pp2_url) {
278 log("Run service proxy auth URL: " + auth_url);
281 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
282 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
285 var request = new pzHttpRequest(auth_url, function(err) {
286 alert("HTTP call for authentication failed: " + err)
290 request.get(null, function(data) {
291 if (!$.isXMLDoc(data)) {
292 alert("service proxy auth response document is not valid XML document, give up!");
295 var status = $(data).find("status");
296 if (status.text() != "OK") {
297 alert("service proxy auth response status: " + status.text() + ", give up!");
301 log("Service proxy auth successfully done");
302 mkws.authenticated = true;
303 var authName = $(data).find("displayName").text();
304 for (var teamName in mkws.teams) {
305 mkws.teams[teamName].queue("authenticated").publish(authName);
313 function runAutoSearches() {
314 log("running auto searches");
316 for (var teamName in mkws.teams) {
317 mkws.teams[teamName].runAutoSearch();
322 $(document).ready(function() {
323 mkws.defaultMkwsConfig();
325 for (var key in mkws.config) {
326 if (mkws.config.hasOwnProperty(key)) {
327 if (key.match(/^language_/)) {
328 var lang = key.replace(/^language_/, "");
329 // Copy custom languages into list
330 mkws.locale_lang[lang] = mkws.config[key];
331 log("Added locally configured language '" + lang + "'");
336 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
337 log("Reset query width: " + mkws.config.query_width);
338 mkws.config.query_width = 50;
341 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
342 if (mkws.config.pazpar2_url.match(/^\/\//)) {
343 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
344 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
347 if (mkws.config.responsive_design_width) {
348 // Responsive web design - change layout on the fly based on
349 // current screen width. Required for mobile devices.
350 $(window).resize(resizePage);
351 // initial check after page load
352 $(document).ready(resizePage);
355 // Backwards compatibility: set new magic class names on any
356 // elements that have the old magic IDs.
357 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
358 "Results", "Records", "Targets", "Ranking",
359 "Termlists", "Stat", "MOTD" ];
360 for (var i = 0; i < ids.length; i++) {
361 var id = 'mkws' + ids[i];
362 var node = $('#' + id);
363 if (node.attr('id')) {
365 log("added magic class to '" + node.attr('id') + "'");
369 // For all MKWS-classed nodes that don't have a team
370 // specified, set the team to AUTO.
371 $('[class^="mkws"],[class*=" mkws"]').each(function() {
372 if (!this.className.match(/mkwsTeam_/)) {
373 log("adding AUTO team to node with class '" + this.className + "'");
374 $(this).addClass('mkwsTeam_AUTO');
378 // Find all nodes with an MKWS class, and determine their team from
379 // the mkwsTeam_* class. Make all team objects.
381 $('[class^="mkws"],[class*=" mkws"]').each(function() {
382 handleNodeWithTeam(this, function(tname, type) {
383 if (!mkws.teams[tname]) {
384 mkws.teams[tname] = team(j, tname);
385 log("Made MKWS team '" + tname + "'");
389 // Second pass: make the individual widget objects. This has
390 // to be done separately, and after the team-creation, since
391 // that sometimes makes new widget nodes (e.g. creating
392 // mkwsTermlists inside mkwsResults.
393 $('[class^="mkws"],[class*=" mkws"]').each(function() {
394 handleNodeWithTeam(this, function(tname, type) {
395 var myTeam = mkws.teams[tname];
396 var myWidget = widget(j, myTeam, type, this);
400 log("Walking MKWS nodes took " + (now-then) + " ms");
402 if (mkws.config.use_service_proxy) {
403 authenticateSession(mkws.config.service_proxy_auth,
404 mkws.config.service_proxy_auth_domain,
405 mkws.config.pazpar2_url);