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.defaultMkwsConfig = function() {
120 // Define empty mkws_config for simple applications that don't define it.
121 if (mkws_config == null || typeof mkws_config != 'object') {
122 var mkws_config = {};
125 mkws.config = mkws_config;
127 /* default mkws config */
128 var config_default = {
129 use_service_proxy: true,
130 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
131 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
133 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
134 perpage_options: [10, 20, 30, 50],
135 sort_default: "relevance",
138 show_lang: true, /* show/hide language menu */
139 show_sort: true, /* show/hide sort menu */
140 show_perpage: true, /* show/hide perpage menu */
141 lang_options: [], /* display languages links for given languages, [] for all */
142 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
143 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
144 log_level: 1, /* log level for development: 0..2 */
149 // Set global log_level flag early so that log() works
150 // Fall back to old "debug_level" setting for backwards compatibility
151 var tmp = mkws.config.log_level;
152 if (typeof(tmp) === 'undefined') tmp = mkws.config.debug_level;
154 if (typeof(tmp) !== 'undefined') {
155 mkws.log_level = tmp;
156 } else if (typeof(config_default.log_level) !== 'undefined') {
157 mkws.log_level = config_default.log_level;
160 /* override standard config values by function parameters */
161 for (var k in config_default) {
162 if (typeof mkws.config[k] === 'undefined')
163 mkws.config[k] = config_default[k];
164 //log("Set config: " + k + ' => ' + mkws.config[k]);
169 // The following functions are dispatchers for team methods that
170 // are called from the UI using a team-name rather than implicit
172 mkws.switchView = function(tname, view) {
173 mkws.teams[tname].switchView(view);
176 mkws.showDetails = function(tname, prefixRecId) {
177 mkws.teams[tname].showDetails(prefixRecId);
180 mkws.limitTarget = function(tname, id, name) {
181 mkws.teams[tname].limitTarget(id, name);
184 mkws.limitQuery = function(tname, field, value) {
185 mkws.teams[tname].limitQuery(field, value);
188 mkws.delimitTarget = function(tname, id) {
189 mkws.teams[tname].delimitTarget(id);
192 mkws.delimitQuery = function(tname, field, value) {
193 mkws.teams[tname].delimitQuery(field, value);
196 mkws.showPage = function(tname, pageNum) {
197 mkws.teams[tname].showPage(pageNum);
200 mkws.pagerPrev = function(tname) {
201 mkws.teams[tname].pagerPrev();
204 mkws.pagerNext = function(tname) {
205 mkws.teams[tname].pagerNext();
209 // wrapper to call team() after page load
213 function handleNodeWithTeam(node, callback) {
214 // First branch for DOM objects; second branch for jQuery objects
215 var classes = node.className || node.attr('class');
217 // For some reason, if we try to proceed when classes is
218 // undefined, we don't get an error message, but this
219 // function and its callers, up several stack level,
220 // silently return. What a crock.
221 log("handleNodeWithTeam() called on node with no classes");
224 var list = classes.split(/\s+/)
227 for (var i = 0; i < list.length; i++) {
229 if (cname.match(/^mkwsTeam_/)) {
230 teamName = cname.replace(/^mkwsTeam_/, '');
231 } else if (cname.match(/^mkws/)) {
232 type = cname.replace(/^mkws/, '');
235 callback.call(node, teamName, type);
239 function resizePage() {
240 var list = ["mkwsSwitch", "mkwsLang"];
242 var width = mkws.config.responsive_design_width;
243 var parent = $(".mkwsTermlists").parent();
245 if ($(window).width() <= width &&
246 parent.hasClass("mkwsTermlistContainer1")) {
247 log("changing from wide to narrow: " + $(window).width());
248 $(".mkwsTermlistContainer1").hide();
249 $(".mkwsTermlistContainer2").show();
250 for (var tname in mkws.teams) {
251 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
252 for(var i = 0; i < list.length; i++) {
253 $("." + list[i] + ".mkwsTeam_" + tname).hide();
256 } else if ($(window).width() > width &&
257 parent.hasClass("mkwsTermlistContainer2")) {
258 log("changing from narrow to wide: " + $(window).width());
259 $(".mkwsTermlistContainer1").show();
260 $(".mkwsTermlistContainer2").hide();
261 for (var tname in mkws.teams) {
262 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
263 for(var i = 0; i < list.length; i++) {
264 $("." + list[i] + ".mkwsTeam_" + tname).show();
272 * Run service-proxy authentication in background (after page load).
273 * The username/password is configured in the apache config file
276 function authenticateSession(auth_url, auth_domain, pp2_url) {
277 log("Run service proxy auth URL: " + auth_url);
280 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
281 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
284 var request = new pzHttpRequest(auth_url, function(err) {
285 alert("HTTP call for authentication failed: " + err)
289 request.get(null, function(data) {
290 if (!$.isXMLDoc(data)) {
291 alert("service proxy auth response document is not valid XML document, give up!");
294 var status = $(data).find("status");
295 if (status.text() != "OK") {
296 alert("service proxy auth response status: " + status.text() + ", give up!");
300 log("Service proxy auth successfully done");
301 mkws.authenticated = true;
302 var authName = $(data).find("displayName").text();
303 for (var teamName in mkws.teams) {
304 mkws.teams[teamName].queue("authenticated").publish(authName);
312 function runAutoSearches() {
313 log("running auto searches");
315 for (var teamName in mkws.teams) {
316 mkws.teams[teamName].runAutoSearch();
321 $(document).ready(function() {
322 mkws.defaultMkwsConfig();
324 for (var key in mkws.config) {
325 if (mkws.config.hasOwnProperty(key)) {
326 if (key.match(/^language_/)) {
327 var lang = key.replace(/^language_/, "");
328 // Copy custom languages into list
329 mkws.locale_lang[lang] = mkws.config[key];
330 log("Added locally configured language '" + lang + "'");
335 if (mkws.config.query_width < 5 || mkws.config.query_width > 150) {
336 log("Reset query width: " + mkws.config.query_width);
337 mkws.config.query_width = 50;
340 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
341 if (mkws.config.pazpar2_url.match(/^\/\//)) {
342 mkws.config.pazpar2_url = document.location.protocol + mkws.config.pazpar2_url;
343 log("adjust protocol independent links: " + mkws.config.pazpar2_url);
346 if (mkws.config.responsive_design_width) {
347 // Responsive web design - change layout on the fly based on
348 // current screen width. Required for mobile devices.
349 $(window).resize(resizePage);
350 // initial check after page load
351 $(document).ready(resizePage);
354 // Backwards compatibility: set new magic class names on any
355 // elements that have the old magic IDs.
356 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
357 "Results", "Records", "Targets", "Ranking",
358 "Termlists", "Stat", "MOTD" ];
359 for (var i = 0; i < ids.length; i++) {
360 var id = 'mkws' + ids[i];
361 var node = $('#' + id);
362 if (node.attr('id')) {
364 log("added magic class to '" + node.attr('id') + "'");
368 // For all MKWS-classed nodes that don't have a team
369 // specified, set the team to AUTO.
370 $('[class^="mkws"],[class*=" mkws"]').each(function() {
371 if (!this.className.match(/mkwsTeam_/)) {
372 log("adding AUTO team to node with class '" + this.className + "'");
373 $(this).addClass('mkwsTeam_AUTO');
377 // Find all nodes with an MKWS class, and determine their team from
378 // the mkwsTeam_* class. Make all team objects.
380 $('[class^="mkws"],[class*=" mkws"]').each(function() {
381 handleNodeWithTeam(this, function(tname, type) {
382 if (!mkws.teams[tname]) {
383 mkws.teams[tname] = team(j, tname);
384 log("Made MKWS team '" + tname + "'");
388 // Second pass: make the individual widget objects. This has
389 // to be done separately, and after the team-creation, since
390 // that sometimes makes new widget nodes (e.g. creating
391 // mkwsTermlists inside mkwsResults.
392 $('[class^="mkws"],[class*=" mkws"]').each(function() {
393 handleNodeWithTeam(this, function(tname, type) {
394 var myTeam = mkws.teams[tname];
395 var myWidget = widget(j, myTeam, type, this);
399 log("Walking MKWS nodes took " + (now-then) + " ms");
401 if (mkws.config.use_service_proxy) {
402 authenticateSession(mkws.config.service_proxy_auth,
403 mkws.config.service_proxy_auth_domain,
404 mkws.config.pazpar2_url);