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.
16 paz: undefined, // will be set up during initialisation
21 "Subjects": "Schlagwörter",
22 "Sources": "Daten und Quellen",
23 "source": "datenquelle",
24 "Termlists": "Termlisten",
26 "Prev": "Zurück",
28 "Sort by": "Sortieren nach",
29 "and show": "und zeige",
30 "per page": "pro Seite",
31 "Displaying": "Zeige",
39 "Subject": "Schlagwort",
40 "subject": "schlagwort",
42 "Records": "Datensätze",
43 "Targets": "Datenbanken",
49 "Authors": "Forfattere",
53 "Termlists": "Termlists",
54 "Next": "Næste",
56 "Search": "Søg",
57 "Sort by": "Sorter efter",
59 "per page": "per side",
60 "Displaying": "Viser",
65 "Author": "Forfatter",
66 "author": "forfatter",
70 "Location": "Lokation",
80 // Define empty mkws_config for simple applications that don't define it.
81 if (mkws_config == null || typeof mkws_config != 'object') {
86 // Factory function for team objects. As much as possible, this uses
87 // only member variables (prefixed "m_") and inner functions with
88 // private scope. Some functions are visibl as member-functions to be
89 // called from outside code -- specifically, from generated
90 // HTML. These functions are that.switchView(), showDetails(),
91 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
92 // pagerPrev(), pagerNext(), showPage().
94 function team($, teamName) {
96 var m_teamName = teamName;
97 var m_submitted = false;
98 var m_query; // initially undefined
99 var m_sortOrder; // will be set below
100 var m_perpage; // will be set below
102 var m_totalRecordCount = 0;
103 var m_currentPage = 1;
104 var m_currentRecordId = '';
105 var m_currentRecordData = null;
107 // Timestamps for logging
111 var m_paz; // will be initialised below
114 that.name = function() { return m_teamName; }
115 that.submitted = function() { return m_submitted; }
116 that.perpage = function() { return m_perpage; }
117 that.totalRecordCount = function() { return m_totalRecordCount; }
118 that.currentPage = function() { return m_currentPage; }
119 that.currentRecordId = function() { return m_currentRecordId; }
120 that.currentRecordData = function() { return m_currentRecordData; }
121 that.filters = function() { return m_filters; }
123 that.set_sortOrder = function(val) { m_sortOrder = val };
124 that.set_perpage = function(val) { m_perpage = val };
127 var log = function (s) {
129 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
130 m_logTime.last = now;
132 mkws.log(m_teamName + ": " + timestamp + s);
136 log("start running MKWS");
138 m_sortOrder = mkws_config.sort_default;
139 m_perpage = mkws_config.perpage_default;
141 log("Create main pz2 object");
142 // create a parameters array and pass it to the pz2's constructor
143 // then register the form submit event with the pz2.search function
144 // autoInit is set to true on default
145 m_paz = new pz2({ "windowid": teamName,
146 "pazpar2path": mkws_config.pazpar2_url,
147 "usesessions" : mkws_config.use_service_proxy ? false : true,
149 "onbytarget": onBytarget,
151 "onterm": (mkws_config.facets.length ? onTerm : undefined),
153 "onrecord": onRecord,
154 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
155 "termlist": mkws_config.facets.join(',')
160 // pz2.js event handlers:
169 function onBytarget(data) {
171 queue("targets").publish(data);
175 function onStat(data) {
177 queue("stat").publish(data);
181 function onTerm(data) {
183 queue("termlists").publish(data);
187 function onShow(data, teamName) {
189 m_totalRecordCount = data.merged;
190 queue("pager").publish(data);
191 queue("records").publish(data);
195 function onRecord(data, args, teamName) {
197 // FIXME: record is async!!
198 clearTimeout(m_paz.recordTimer);
199 // ##### restrict to current team
200 var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
202 // in case on_show was faster to redraw element
205 m_currentRecordData = data;
206 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
207 var html = renderDetails(m_currentRecordData);
208 $(recordDiv).append(html);
212 // Used by promoteRecords() and onRecord()
213 function recordElementId(s) {
214 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
216 that.recordElementId = recordElementId;
218 // Used by onRecord(), showDetails() and renderDetails()
219 function recordDetailsId(s) {
220 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
222 that.recordElementId = recordElementId;
225 that.targetFiltered = function(id) {
226 for (var i = 0; i < m_filters.length; i++) {
227 if (m_filters[i].id === id ||
228 m_filters[i].id === 'pz:id=' + id) {
236 ////////////////////////////////////////////////////////////////////////////////
237 ////////////////////////////////////////////////////////////////////////////////
240 // when search button pressed
241 function onFormSubmitEventHandler()
243 var val = findnode('.mkwsQuery').val();
249 function newSearch(query, sortOrder, targets)
251 log("newSearch: " + query);
253 if (mkws_config.use_service_proxy && !mkws.authenticated) {
254 alert("searching before authentication");
259 triggerSearch(query, sortOrder, targets);
260 switchView('records'); // In case it's configured to start off as hidden
265 // limit by target functions
266 that.limitTarget = function (id, name)
268 log("limitTarget(id=" + id + ", name=" + name + ")");
269 m_filters.push({ id: id, name: name });
275 // limit the query after clicking the facet
276 that.limitQuery = function (field, value)
278 log("limitQuery(field=" + field + ", value=" + value + ")");
279 m_filters.push({ field: field, value: value });
285 that.delimitTarget = function (id)
287 log("delimitTarget(id=" + id + ")");
289 for (var i in m_filters) {
290 var filter = m_filters[i];
292 log("delimitTarget() removing filter " + $.toJSON(filter));
294 log("delimitTarget() keeping filter " + $.toJSON(filter));
295 newFilters.push(filter);
298 m_filters = newFilters;
305 that.delimitQuery = function (field, value)
307 log("delimitQuery(field=" + field + ", value=" + value + ")");
309 for (var i in m_filters) {
310 var filter = m_filters[i];
312 field == filter.field &&
313 value == filter.value) {
314 log("delimitQuery() removing filter " + $.toJSON(filter));
316 log("delimitQuery() keeping filter " + $.toJSON(filter));
317 newFilters.push(filter);
320 m_filters = newFilters;
330 m_totalRecordCount = 0;
332 that.resetPage = resetPage;
335 function triggerSearch (query, sortOrder, targets)
338 queue("navi").publish();
343 // Continue to use previous query/sort-order unless new ones are specified
348 m_sortOrder = sortOrder;
351 m_filters.push({ id: targets, name: targets });
354 for (var i in m_filters) {
355 var filter = m_filters[i];
359 if (filter.id.match(/^[a-z:]+[=~]/)) {
360 log("filter '" + filter.id + "' already begins with SETTING OP");
362 filter.id = 'pz:id=' + filter.id;
364 pp2filter += filter.id;
368 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
374 params.limit = pp2limit;
377 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
379 // We can use: params.torusquery = "udb=NAME"
380 // Note: that won't work when running against raw pazpar2
381 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
385 that.reShow = function() {
386 m_paz.show(0, m_perpage, m_sortOrder);
391 that.showPage = function (pageNum)
393 m_currentPage = pageNum;
394 m_paz.showPage(m_currentPage - 1);
398 // simple paging functions
399 that.pagerNext = function () {
400 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
407 that.pagerPrev = function () {
408 if (m_paz.showPrev() != false)
413 // switching view between targets and records
414 function switchView(view) {
415 var targets = findnode('.mkwsTargets');
416 var results = findnode('.mkwsResults,.mkwsRecords');
417 var blanket = findnode('.mkwsBlanket');
418 var motd = findnode('.mkwsMOTD');
422 if (targets) targets.css('display', 'block');
423 if (results) results.css('display', 'none');
424 if (blanket) blanket.css('display', 'none');
425 if (motd) motd.css('display', 'none');
428 if (targets) targets.css('display', 'none');
429 if (results) results.css('display', 'block');
430 if (blanket) blanket.css('display', 'block');
431 if (motd) motd.css('display', 'none');
434 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
435 if (targets) targets.css('display', 'none');
436 if (results) results.css('display', 'none');
437 if (blanket) blanket.css('display', 'none');
438 if (motd) motd.css('display', 'none');
441 alert("Unknown view '" + view + "'");
444 that.switchView = switchView;
447 // detailed record drawing
448 that.showDetails = function (recId) {
449 var oldRecordId = m_currentRecordId;
450 m_currentRecordId = recId;
452 // remove current detailed view if any
453 // ##### restrict to current team
454 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
457 detRecordDiv.parentNode.removeChild(detRecordDiv);
459 // if the same clicked, just hide
460 if (recId == oldRecordId) {
461 m_currentRecordId = '';
462 m_currentRecordData = null;
465 // request the record
466 log("showDetails() requesting record '" + recId + "'");
472 * All the HTML stuff to render the search forms and
475 function mkwsHtmlAll() {
477 if (mkws_config.show_lang)
480 log("HTML search form");
481 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
483 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
484 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
485 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
490 // If the team has a .mkwsResults, populate it in the usual
491 // way. If not, assume that it's a smarter application that
492 // defines its own subcomponents, some or all of the
499 findnode(".mkwsResults").html('\
500 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
502 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
503 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
505 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
506 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
507 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
508 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
509 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
514 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
519 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
520 if (mkws_config.show_sort) {
521 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
523 if (mkws_config.show_perpage) {
524 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
526 ranking_data += '</form>';
527 findnode(".mkwsRanking").html(ranking_data);
531 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
533 // on first page, hide the termlist
534 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
535 var container = findnode(".mkwsMOTDContainer");
536 if (container.length) {
537 // Move the MOTD from the provided element down into the container
538 findnode(".mkwsMOTD").appendTo(container);
543 function mkwsSetLang() {
544 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
545 if (!lang || !mkws.locale_lang[lang]) {
546 mkws_config.lang = ""
548 mkws_config.lang = lang;
551 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
552 return mkws_config.lang;
556 /* create locale language menu */
557 function mkwsHtmlLang() {
558 var lang_default = "en";
559 var lang = mkws_config.lang || lang_default;
562 /* display a list of configured languages, or all */
563 var lang_options = mkws_config.lang_options || [];
564 var toBeIncluded = {};
565 for (var i = 0; i < lang_options.length; i++) {
566 toBeIncluded[lang_options[i]] = true;
569 for (var k in mkws.locale_lang) {
570 if (toBeIncluded[k] || lang_options.length == 0)
575 if (lang_options.length == 0 || toBeIncluded[lang_default])
576 list.push(lang_default);
578 log("Language menu for: " + list.join(", "));
582 for(var i = 0; i < list.length; i++) {
589 data += ' <span>' + l + '</span> ';
591 data += ' <a href="?lang=' + l + '">' + l + '</a> '
595 findnode(".mkwsLang").html(data);
599 function mkwsHtmlSort() {
600 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
601 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
603 for(var i = 0; i < mkws_config.sort_options.length; i++) {
604 var opt = mkws_config.sort_options[i];
606 var val = opt.length == 1 ? opt[0] : opt[1];
608 sort_html += '<option value="' + key + '"';
609 if (m_sortOrder == key || m_sortOrder == val) {
610 sort_html += ' selected="selected"';
612 sort_html += '>' + M(val) + '</option>';
614 sort_html += '</select>';
620 function mkwsHtmlPerpage() {
621 log("HTML perpage, m_perpage = " + m_perpage);
622 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
624 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
625 var key = mkws_config.perpage_options[i];
627 perpage_html += '<option value="' + key + '"';
628 if (key == m_perpage) {
629 perpage_html += ' selected="selected"';
631 perpage_html += '>' + key + '</option>';
633 perpage_html += '</select>';
639 function mkwsHtmlSwitch() {
640 log("HTML switch for team " + m_teamName);
642 var node = findnode(".mkwsSwitch");
643 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
644 node.append($("<span/>", { text: " | " }));
645 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
648 var node = findnode(".mkwsTargets");
650 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
651 No information available yet.\
653 node.css("display", "none");
657 that.runAutoSearch = function() {
658 var node = findnode('.mkwsRecords,.mkwsTermlists');
659 var query = node.attr('autosearch');
663 if (query.match(/^!param!/)) {
664 var param = query.replace(/^!param!/, '');
665 query = mkws.getParameterByName(param);
666 log("obtained query '" + query + "' from param '" + param + "'");
668 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
670 } else if (query.match(/^!path!/)) {
671 var index = query.replace(/^!path!/, '');
672 var path = window.location.pathname.split('/');
673 query = path[path.length - index];
674 log("obtained query '" + query + "' from path-component '" + index + "'");
676 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
680 log("node=" + node + ", class='" + node.className + "', query=" + query);
682 var sortOrder = node.attr('sort');
683 var targets = node.attr('targets');
684 var s = "running auto search: '" + query + "'";
685 if (sortOrder) s += " sorted by '" + sortOrder + "'";
686 if (targets) s += " in targets '" + targets + "'";
689 newSearch(query, sortOrder, targets);
693 // Translation function. At present, this is properly a
694 // global-level function (hence the assignment to mkws.M) but we
695 // want to make it per-team so different teams can operate in
696 // different languages.
699 var lang = mkws_config.lang;
701 if (!lang || !mkws.locale_lang[lang])
704 return mkws.locale_lang[lang][word] || word;
706 mkws.M = M; // so the Handlebars helper can use it
709 // Finds the node of the specified class within the current team
710 // Multiple OR-clauses separated by commas are handled
711 // More complex cases may not work
713 function findnode(selector, teamName) {
714 teamName = teamName || m_teamName;
716 selector = $.map(selector.split(','), function(s, i) {
717 return s + '.mkwsTeam_' + teamName;
724 function renderDetails(data, marker)
726 var template = loadTemplate("Record");
727 var details = template(data);
728 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
730 that.renderDetails = renderDetails;
733 function loadTemplate(name)
735 var template = m_template[name];
737 if (template === undefined) {
738 // Fall back to generic template if there is no team-specific one
739 var node = findnode(".mkwsTemplate_" + name);
741 node = findnode(".mkwsTemplate_" + name, "ALL");
744 var source = node.html();
746 source = mkws.defaultTemplate(name);
749 template = Handlebars.compile(source);
750 log("compiled template '" + name + "'");
751 m_template[name] = template;
756 that.loadTemplate = loadTemplate;
759 // The following PubSub code is modified from the jQuery manual:
760 // https://api.jquery.com/jQuery.Callbacks/
763 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
764 // team.queue("eventName").publish(arg1, arg2, ...);
767 var queue = function(id) {
769 var callbacks = $.Callbacks();
771 publish: callbacks.fire,
772 subscribe: callbacks.add,
773 unsubscribe: callbacks.remove
788 mkws_config.error = e.message;
793 // Bizarrely, 'that' is just an empty hash. All its state is in
794 // the closure variables defined earlier in this function.
799 // wrapper to call team() after page load
801 mkws.log = function (string) {
805 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
809 // you need to disable use strict at the top of the file!!!
810 if (mkws.log_level >= 3) {
811 console.log(arguments.callee.caller);
812 } else if (mkws.log_level >= 2) {
813 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
820 mkws.handleNodeWithTeam = function(node, callback) {
821 // First branch for DOM objects; second branch for jQuery objects
822 var classes = node.className || node.attr('class');
824 // For some reason, if we try to proceed when classes is
825 // undefined, we don't get an error message, but this
826 // function and its callers, up several stack level,
827 // silently return. What a crock.
828 mkws.log("handleNodeWithTeam() called on node with no classes");
831 var list = classes.split(/\s+/)
834 for (var i = 0; i < list.length; i++) {
836 if (cname.match(/^mkwsTeam_/)) {
837 teamName = cname.replace(/^mkwsTeam_/, '');
838 } else if (cname.match(/^mkws/)) {
839 type = cname.replace(/^mkws/, '');
842 callback.call(node, teamName, type);
846 mkws.resizePage = function () {
847 var list = ["mkwsSwitch", "mkwsLang"];
849 var width = mkws_config.responsive_design_width;
850 var parent = $(".mkwsTermlists").parent();
852 if ($(window).width() <= width &&
853 parent.hasClass("mkwsTermlistContainer1")) {
854 log("changing from wide to narrow: " + $(window).width());
855 $(".mkwsTermlistContainer1").hide();
856 $(".mkwsTermlistContainer2").show();
857 for (var tname in mkws.teams) {
858 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
859 for(var i = 0; i < list.length; i++) {
860 $("." + list[i] + ".mkwsTeam_" + tname).hide();
863 } else if ($(window).width() > width &&
864 parent.hasClass("mkwsTermlistContainer2")) {
865 log("changing from narrow to wide: " + $(window).width());
866 $(".mkwsTermlistContainer1").show();
867 $(".mkwsTermlistContainer2").hide();
868 for (var tname in mkws.teams) {
869 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
870 for(var i = 0; i < list.length; i++) {
871 $("." + list[i] + ".mkwsTeam_" + tname).show();
878 mkws.switchView = function(tname, view) {
879 mkws.teams[tname].switchView(view);
882 mkws.showDetails = function (tname, prefixRecId) {
883 mkws.teams[tname].showDetails(prefixRecId);
886 mkws.limitTarget = function (tname, id, name) {
887 mkws.teams[tname].limitTarget(id, name);
890 mkws.limitQuery = function (tname, field, value) {
891 mkws.teams[tname].limitQuery(field, value);
894 mkws.delimitTarget = function (tname, id) {
895 mkws.teams[tname].delimitTarget(id);
898 mkws.delimitQuery = function (tname, field, value) {
899 mkws.teams[tname].delimitQuery(field, value);
902 mkws.showPage = function (tname, pageNum) {
903 mkws.teams[tname].showPage(pageNum);
906 mkws.pagerPrev = function (tname) {
907 mkws.teams[tname].pagerPrev();
910 mkws.pagerNext = function (tname) {
911 mkws.teams[tname].pagerNext();
915 // This function is taken from a StackOverflow answer
916 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
917 mkws.getParameterByName = function(name) {
918 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
919 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
920 results = regex.exec(location.search);
921 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
925 mkws.defaultTemplate = function(name)
927 if (name === 'Record') {
931 <th>{{translate "Title"}}</th>\
934 {{#if md-title-remainder}}\
935 ({{md-title-remainder}})\
937 {{#if md-title-responsibility}}\
938 <i>{{md-title-responsibility}}</i>\
944 <th>{{translate "Date"}}</th>\
945 <td>{{md-date}}</td>\
950 <th>{{translate "Author"}}</th>\
951 <td>{{md-author}}</td>\
954 {{#if md-electronic-url}}\
956 <th>{{translate "Links"}}</th>\
958 {{#each md-electronic-url}}\
959 <a href="{{this}}">Link{{index1}}</a>\
964 {{#if-any location having="md-subject"}}\
966 <th>{{translate "Subject"}}</th>\
968 {{#first location having="md-subject"}}\
970 {{#commaList md-subject}}\
971 {{this}}{{/commaList}}\
978 <th>{{translate "Locations"}}</th>\
980 {{#commaList location}}\
981 {{attr "@name"}}{{/commaList}}\
986 } else if (name === "Summary") {
988 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
991 {{#if md-title-remainder}}\
992 <span>{{md-title-remainder}}</span>\
994 {{#if md-title-responsibility}}\
995 <span><i>{{md-title-responsibility}}</i></span>\
1000 var s = "There is no default '" + name +"' template!";
1006 function defaultMkwsConfig() {
1007 /* default mkws config */
1008 var config_default = {
1009 use_service_proxy: true,
1010 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1011 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1013 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1014 perpage_options: [10, 20, 30, 50],
1015 sort_default: "relevance",
1016 perpage_default: 20,
1018 show_lang: true, /* show/hide language menu */
1019 show_sort: true, /* show/hide sort menu */
1020 show_perpage: true, /* show/hide perpage menu */
1021 lang_options: [], /* display languages links for given languages, [] for all */
1022 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1023 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1024 log_level: 1, /* log level for development: 0..2 */
1029 // Set global log_level flag early so that log() works
1030 // Fall back to old "debug_level" setting for backwards compatibility
1031 var tmp = mkws_config.log_level;
1032 if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
1034 if (typeof(tmp) !== 'undefined') {
1035 mkws.log_level = tmp;
1036 } else if (typeof(config_default.log_level) !== 'undefined') {
1037 mkws.log_level = config_default.log_level;
1040 // make sure the mkws_config is a valid hash
1041 if (!$.isPlainObject(mkws_config)) {
1042 log("ERROR: mkws_config is not an JS object, ignore it....");
1046 /* override standard config values by function parameters */
1047 for (var k in config_default) {
1048 if (typeof mkws_config[k] === 'undefined')
1049 mkws_config[k] = config_default[k];
1050 //log("Set config: " + k + ' => ' + mkws_config[k]);
1056 * Run service-proxy authentication in background (after page load).
1057 * The username/password is configured in the apache config file
1060 function authenticateSession(auth_url, auth_domain, pp2_url) {
1061 log("Run service proxy auth URL: " + auth_url);
1064 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1065 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1068 var request = new pzHttpRequest(auth_url, function(err) {
1069 alert("HTTP call for authentication failed: " + err)
1073 request.get(null, function(data) {
1074 if (!$.isXMLDoc(data)) {
1075 alert("service proxy auth response document is not valid XML document, give up!");
1078 var status = $(data).find("status");
1079 if (status.text() != "OK") {
1080 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1084 log("Service proxy auth successfully done");
1085 mkws.authenticated = true;
1091 function runAutoSearches() {
1092 log("running auto searches");
1094 for (var teamName in mkws.teams) {
1095 mkws.teams[teamName].runAutoSearch();
1100 $(document).ready(function() {
1101 log("on load ready");
1102 defaultMkwsConfig();
1104 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1105 log("Reset query width: " + mkws_config.query_width);
1106 mkws_config.query_width = 50;
1109 for (var key in mkws_config) {
1110 if (mkws_config.hasOwnProperty(key)) {
1111 if (key.match(/^language_/)) {
1112 var lang = key.replace(/^language_/, "");
1113 // Copy custom languages into list
1114 mkws.locale_lang[lang] = mkws_config[key];
1115 log("Added locally configured language '" + lang + "'");
1120 if (mkws_config.responsive_design_width) {
1121 // Responsive web design - change layout on the fly based on
1122 // current screen width. Required for mobile devices.
1123 $(window).resize(function(e) { mkws.resizePage() });
1124 // initial check after page load
1125 $(document).ready(function() { mkws.resizePage() });
1128 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1129 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1130 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1131 log("adjust protocol independent links: " + mkws_config.pazpar2_url);
1134 // Backwards compatibility: set new magic class names on any
1135 // elements that have the old magic IDs.
1136 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1137 "Results", "Records", "Targets", "Ranking",
1138 "Termlists", "Stat", "MOTD" ];
1139 for (var i = 0; i < ids.length; i++) {
1140 var id = 'mkws' + ids[i];
1141 var node = $('#' + id);
1142 if (node.attr('id')) {
1144 log("added magic class to '" + node.attr('id') + "'");
1148 // For all MKWS-classed nodes that don't have a team
1149 // specified, set the team to AUTO.
1150 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1151 if (!this.className.match(/mkwsTeam_/)) {
1152 log("adding AUTO team to node with class '" + this.className + "'");
1153 $(this).addClass('mkwsTeam_AUTO');
1157 // Find all nodes with an MKWS class, and determine their team from
1158 // the mkwsTeam_* class. Make all team objects.
1160 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1161 mkws.handleNodeWithTeam(this, function(tname, type) {
1162 if (!mkws.teams[tname]) {
1163 mkws.teams[tname] = team(j, tname);
1164 log("Made MKWS team '" + tname + "'");
1168 // Second pass: make the individual widget objects. This has
1169 // to be done separately, and after the team-creation, since
1170 // that sometimes makes new widget nodes (e.g. creating
1171 // mkwsTermlists inside mkwsResults.
1172 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1173 mkws.handleNodeWithTeam(this, function(tname, type) {
1174 var myTeam = mkws.teams[tname];
1175 var myWidget = widget(j, myTeam, type, this);
1179 log("Walking MKWS nodes took " + (now-then) + " ms");
1181 if (mkws_config.use_service_proxy) {
1182 authenticateSession(mkws_config.service_proxy_auth,
1183 mkws_config.service_proxy_auth_domain,
1184 mkws_config.pazpar2_url);