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 mkws.objectWithParent = function(parent) {
100 function thing() {} // Must be function so `prototype' works
102 thing.prototype = parent;
103 var res = new thing();
104 thing.prototype = null;
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 = Object.create(config_default);
148 for (var k in overrides) {
149 mkws.config[k] = overrides[k];
154 // The following functions are dispatchers for team methods that
155 // are called from the UI using a team-name rather than implicit
157 mkws.switchView = function(tname, view) {
158 mkws.teams[tname].switchView(view);
161 mkws.showDetails = function(tname, prefixRecId) {
162 mkws.teams[tname].showDetails(prefixRecId);
165 mkws.limitTarget = function(tname, id, name) {
166 mkws.teams[tname].limitTarget(id, name);
169 mkws.limitQuery = function(tname, field, value) {
170 mkws.teams[tname].limitQuery(field, value);
173 mkws.delimitTarget = function(tname, id) {
174 mkws.teams[tname].delimitTarget(id);
177 mkws.delimitQuery = function(tname, field, value) {
178 mkws.teams[tname].delimitQuery(field, value);
181 mkws.showPage = function(tname, pageNum) {
182 mkws.teams[tname].showPage(pageNum);
185 mkws.pagerPrev = function(tname) {
186 mkws.teams[tname].pagerPrev();
189 mkws.pagerNext = function(tname) {
190 mkws.teams[tname].pagerNext();
194 // wrapper to call team() after page load
198 function handleNodeWithTeam(node, callback) {
199 // First branch for DOM objects; second branch for jQuery objects
200 var classes = node.className || node.attr('class');
202 // For some reason, if we try to proceed when classes is
203 // undefined, we don't get an error message, but this
204 // function and its callers, up several stack level,
205 // silently return. What a crock.
206 log("handleNodeWithTeam() called on node with no classes");
209 var list = classes.split(/\s+/)
212 for (var i = 0; i < list.length; i++) {
214 if (cname.match(/^mkwsTeam_/)) {
215 teamName = cname.replace(/^mkwsTeam_/, '');
216 } else if (cname.match(/^mkws/)) {
217 type = cname.replace(/^mkws/, '');
220 callback.call(node, teamName, type);
224 function resizePage() {
225 var list = ["mkwsSwitch", "mkwsLang"];
227 var width = mkws.config.responsive_design_width;
228 var parent = $(".mkwsTermlists").parent();
230 if ($(window).width() <= width &&
231 parent.hasClass("mkwsTermlistContainer1")) {
232 log("changing from wide to narrow: " + $(window).width());
233 $(".mkwsTermlistContainer1").hide();
234 $(".mkwsTermlistContainer2").show();
235 for (var tname in mkws.teams) {
236 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
237 for(var i = 0; i < list.length; i++) {
238 $("." + list[i] + ".mkwsTeam_" + tname).hide();
241 } else if ($(window).width() > width &&
242 parent.hasClass("mkwsTermlistContainer2")) {
243 log("changing from narrow to wide: " + $(window).width());
244 $(".mkwsTermlistContainer1").show();
245 $(".mkwsTermlistContainer2").hide();
246 for (var tname in mkws.teams) {
247 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
248 for(var i = 0; i < list.length; i++) {
249 $("." + list[i] + ".mkwsTeam_" + tname).show();
257 * Run service-proxy authentication in background (after page load).
258 * The username/password is configured in the apache config file
261 function authenticateSession(auth_url, auth_domain, pp2_url) {
262 log("Run service proxy auth URL: " + auth_url);
265 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
266 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
269 var request = new pzHttpRequest(auth_url, function(err) {
270 alert("HTTP call for authentication failed: " + err)
274 request.get(null, function(data) {
275 if (!$.isXMLDoc(data)) {
276 alert("service proxy auth response document is not valid XML document, give up!");
279 var status = $(data).find("status");
280 if (status.text() != "OK") {
281 alert("service proxy auth response status: " + status.text() + ", give up!");
285 log("Service proxy auth successfully done");
286 mkws.authenticated = true;
287 var authName = $(data).find("displayName").text();
288 for (var teamName in mkws.teams) {
289 mkws.teams[teamName].queue("authenticated").publish(authName);
297 function runAutoSearches() {
298 log("running auto searches");
300 for (var teamName in mkws.teams) {
301 mkws.teams[teamName].queue("ready").publish();
306 // I don't understand why I need this copy, but I do: mkws_config
307 // is not visible inside the document.ready function, but the
310 if (typeof mkws_config === 'undefined') {
311 log("setting empty config");
314 log("using config: " + $.toJSON(mkws_config));
315 saved_config = mkws_config;
319 $(document).ready(function() {
320 mkws.setMkwsConfig(saved_config);
322 for (var key in mkws.config) {
323 if (mkws.config.hasOwnProperty(key)) {
324 if (key.match(/^language_/)) {
325 var lang = key.replace(/^language_/, "");
326 // Copy custom languages into list
327 mkws.locale_lang[lang] = mkws.config[key];
328 log("Added locally configured language '" + lang + "'");
333 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
334 log("Reset query width: " + mkws.config.query_width);
335 mkws.config.query_width = 50;
338 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
339 if (mkws.config.pazpar2_url.match(/^\/\//)) {
340 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
341 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
344 if (mkws.config.responsive_design_width) {
345 // Responsive web design - change layout on the fly based on
346 // current screen width. Required for mobile devices.
347 $(window).resize(resizePage);
348 // initial check after page load
349 $(document).ready(resizePage);
352 // Backwards compatibility: set new magic class names on any
353 // elements that have the old magic IDs.
354 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
355 "Results", "Records", "Targets", "Ranking",
356 "Termlists", "Stat", "MOTD" ];
357 for (var i = 0; i < ids.length; i++) {
358 var id = 'mkws' + ids[i];
359 var node = $('#' + id);
360 if (node.attr('id')) {
362 log("added magic class to '" + node.attr('id') + "'");
366 // For all MKWS-classed nodes that don't have a team
367 // specified, set the team to AUTO.
368 $('[class^="mkws"],[class*=" mkws"]').each(function() {
369 if (!this.className.match(/mkwsTeam_/)) {
370 log("adding AUTO team to node with class '" + this.className + "'");
371 $(this).addClass('mkwsTeam_AUTO');
375 // Find all nodes with an MKWS class, and determine their team from
376 // the mkwsTeam_* class. Make all team objects.
378 $('[class^="mkws"],[class*=" mkws"]').each(function() {
379 handleNodeWithTeam(this, function(tname, type) {
380 if (!mkws.teams[tname]) {
381 mkws.teams[tname] = team(j, tname);
382 log("Made MKWS team '" + tname + "'");
386 // Second pass: make the individual widget objects. This has
387 // to be done separately, and after the team-creation, since
388 // that sometimes makes new widget nodes (e.g. creating
389 // mkwsTermlists inside mkwsResults.
390 $('[class^="mkws"],[class*=" mkws"]').each(function() {
391 handleNodeWithTeam(this, function(tname, type) {
392 var myTeam = mkws.teams[tname];
393 var myWidget = widget(j, myTeam, type, this);
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);