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 debug_level >= 2
10 Handlebars.registerHelper('json', function(obj) {
15 Handlebars.registerHelper('translate', function(s) {
20 // We need {{attr '@name'}} because Handlebars can't parse {{@name}}
21 Handlebars.registerHelper('attr', function(attrName) {
22 return this[attrName];
27 * Use as follows: {{#if-any NAME1 having="NAME2"}}
28 * Applicable when NAME1 is the name of an array
29 * The guarded code runs only if at least one element of the NAME1
30 * array has a subelement called NAME2.
32 Handlebars.registerHelper('if-any', function(items, options) {
33 var having = options.hash.having;
34 for (var i in items) {
36 if (!having || item[having]) {
37 return options.fn(this);
44 Handlebars.registerHelper('first', function(items, options) {
45 var having = options.hash.having;
46 for (var i in items) {
48 if (!having || item[having]) {
49 return options.fn(item);
56 Handlebars.registerHelper('commaList', function(items, options) {
59 for (var i in items) {
60 if (i > 0) out += ", ";
61 out += options.fn(items[i])
68 Handlebars.registerHelper('index1', function(obj) {
69 return obj.data.index + 1;
74 // Set up global mkws object. Contains truly global state such as SP
75 // authentication, and a hash of team objects, indexed by team-name.
79 debug_level: 1, // Will be overridden from mkws_config, but
80 // initial value allows jQuery popup to use logging.
81 paz: undefined, // will be set up during initialisation
86 "Subjects": "Schlagwörter",
87 "Sources": "Daten und Quellen",
88 "source": "datenquelle",
89 "Termlists": "Termlisten",
91 "Prev": "Zurück",
93 "Sort by": "Sortieren nach",
94 "and show": "und zeige",
95 "per page": "pro Seite",
96 "Displaying": "Zeige",
104 "Subject": "Schlagwort",
105 "subject": "schlagwort",
107 "Records": "Datensätze",
108 "Targets": "Datenbanken",
114 "Authors": "Forfattere",
118 "Termlists": "Termlists",
119 "Next": "Næste",
121 "Search": "Søg",
122 "Sort by": "Sorter efter",
123 "and show": "og vis",
124 "per page": "per side",
125 "Displaying": "Viser",
130 "Author": "Forfatter",
131 "author": "forfatter",
133 "Subject": "Emneord",
134 "subject": "emneord",
135 "Location": "Lokation",
145 // Define empty mkws_config for simple applications that don't define it.
146 if (mkws_config == null || typeof mkws_config != 'object') {
147 var mkws_config = {};
151 // Factory function for widget objects.
152 function widget($, team, type, node) {
161 if (type === 'Targets') {
163 } else if (type === 'Stat') {
166 // ### Handle other types here
169 mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
173 function promoteTargets() {
174 team.queue("targets").subscribe(function(data) {
175 if (node.length === 0) alert("huh?!");
177 var table ='<table><thead><tr>' +
178 '<td>' + M('Target ID') + '</td>' +
179 '<td>' + M('Hits') + '</td>' +
180 '<td>' + M('Diags') + '</td>' +
181 '<td>' + M('Records') + '</td>' +
182 '<td>' + M('State') + '</td>' +
183 '</tr></thead><tbody>';
185 for (var i = 0; i < data.length; i++) {
186 table += "<tr><td>" + data[i].id +
187 "</td><td>" + data[i].hits +
188 "</td><td>" + data[i].diagnostic +
189 "</td><td>" + data[i].records +
190 "</td><td>" + data[i].state + "</td></tr>";
193 table += '</tbody></table>';
194 var subnode = $(node).children('.mkwsBytarget');
200 function promoteStat() {
201 team.queue("stat").subscribe(function(data) {
202 if (node.length === 0) alert("huh?!");
204 $(node).html('<span class="head">' + M('Status info') + '</span>' +
206 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
208 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
214 // Factory function for team objects. As much as possible, this uses
215 // only member variables (prefixed "m_") and inner functions with
216 // private scope. Some functions are visibl as member-functions to be
217 // called from outside code -- specifically, from generated
218 // HTML. These functions are that.switchView(), showDetails(),
219 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
220 // pagerPrev(), pagerNext(), showPage().
222 function team($, teamName) {
224 var m_teamName = teamName;
225 that.name = function() { return m_teamName; }
226 var m_submitted = false;
227 var m_query; // initially undefined
228 var m_sort; // will be set below
229 var m_perpage; // will be set below
233 var m_curDetRecId = '';
234 var m_curDetRecData = null;
236 // Timestamps for logging
240 var m_paz; // will be initialised below
244 var debug = function (s) {
246 var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
247 m_debug_time.last = now;
249 mkws.debug(m_teamName + ": " + timestamp + s);
252 debug("start running MKWS");
254 m_sort = mkws_config.sort_default;
255 m_perpage = mkws_config.perpage_default;
257 debug("Create main pz2 object");
258 // create a parameters array and pass it to the pz2's constructor
259 // then register the form submit event with the pz2.search function
260 // autoInit is set to true on default
261 m_paz = new pz2({ "windowid": teamName,
262 "pazpar2path": mkws_config.pazpar2_url,
263 "usesessions" : mkws_config.use_service_proxy ? false : true,
265 "onbytarget": onBytarget,
267 "onterm": (mkws_config.facets.length ? onTerm : undefined),
269 "onrecord": onRecord,
270 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
271 "termlist": mkws_config.facets.join(',')
276 // pz2.js event handlers:
285 function onBytarget(data) {
287 queue("targets").publish(data);
291 function onStat(data) {
293 queue("stat").publish(data);
297 function onTerm(data) {
299 var node = findnode(".mkwsTermlists");
300 if (node.length == 0) return;
302 // no facets: this should never happen
303 if (!mkws_config.facets || mkws_config.facets.length == 0) {
304 alert("onTerm called even though we have no facets: " + $.toJSON(data));
309 // display if we first got results
313 acc.push('<div class="title">' + M('Termlists') + '</div>');
314 var facets = mkws_config.facets;
316 for(var i = 0; i < facets.length; i++) {
317 if (facets[i] == "xtargets") {
318 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
319 } else if (facets[i] == "subject") {
320 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
321 } else if (facets[i] == "author") {
322 addSingleFacet(acc, "Authors", data.author, 10, "author");
324 alert("bad facet configuration: '" + facets[i] + "'");
328 node.html(acc.join(''));
332 function onShow(data, teamName) {
334 m_totalRec = data.merged;
336 var pager = findnode(".mkwsPager");
338 pager.html(drawPager(data))
341 var results = findnode(".mkwsRecords");
346 for (var i = 0; i < data.hits.length; i++) {
347 var hit = data.hits[i];
348 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
351 if (hit.recid == m_curDetRecId) {
353 html.push(renderDetails(m_curDetRecData));
356 results.html(html.join(''));
360 function onRecord(data, args, teamName) {
362 // FIXME: record is async!!
363 clearTimeout(m_paz.recordTimer);
364 // in case on_show was faster to redraw element
365 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
366 if (detRecordDiv) return;
367 m_curDetRecData = data;
368 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
369 var html = renderDetails(m_curDetRecData);
370 recordDiv.innerHTML += html;
374 function addSingleFacet(acc, caption, data, max, pzIndex) {
375 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
376 acc.push('<div class="termtitle">' + M(caption) + '</div>');
377 for (var i = 0; i < data.length && i < max; i++) {
378 acc.push('<div class="term">');
379 acc.push('<a href="#" ');
382 // Special case: target selection
383 acc.push('target_id='+data[i].id+' ');
384 if (!targetFiltered(data[i].id)) {
385 action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
388 action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
390 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
391 + ' <span>' + data[i].freq + '</span>');
398 function targetFiltered(id) {
399 for (var i = 0; i < m_filters.length; i++) {
400 if (m_filters[i].id === id ||
401 m_filters[i].id === 'pz:id=' + id) {
409 function drawPager (data)
411 var s = '<div style="float: right">' + M('Displaying') + ': '
412 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
413 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
414 + data.total + ')</div>';
416 //client indexes pages from 1 but pz2 from 0
418 var pages = Math.ceil(m_totalRec / m_perpage);
420 var firstClkbl = (m_curPage - onsides > 0)
421 ? m_curPage - onsides
424 var lastClkbl = firstClkbl + 2*onsides < pages
425 ? firstClkbl + 2*onsides
428 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
430 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
431 +'<< ' + M('Prev') + '</a><b> | </b>';
434 for(var i = firstClkbl; i <= lastClkbl; i++) {
437 numLabel = '<b>' + i + '</b>';
439 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
440 + numLabel + ' </a>';
443 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
444 if (pages - m_curPage > 0)
445 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
446 + M('Next') + ' >></a>';
453 if (lastClkbl < pages)
456 s += '<div style="float: clear">'
457 + prev + predots + middle + postdots + next + '</div>';
463 ////////////////////////////////////////////////////////////////////////////////
464 ////////////////////////////////////////////////////////////////////////////////
467 // when search button pressed
468 function onFormSubmitEventHandler()
470 var val = findnode('.mkwsQuery').val();
476 function newSearch(query, sort, targets)
478 debug("newSearch: " + query);
480 if (mkws_config.use_service_proxy && !mkws.authenticated) {
481 alert("searching before authentication");
489 triggerSearch(query, sort, targets);
490 switchView('records'); // In case it's configured to start off as hidden
495 function onSelectDdChange()
497 if (!m_submitted) return false;
500 m_paz.show(0, m_perpage, m_sort);
505 function redrawNavi ()
507 var navi = findnode('.mkwsNavi');
511 for (var i in m_filters) {
515 var filter = m_filters[i];
517 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
518 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
520 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
521 "', '" + filter.field + "', '" + filter.value + "'" +
522 ');return false;">' + filter.value + '</a>';
537 function loadSelect ()
539 var node = findnode('.mkwsSort');
540 if (node.length && node.val() != m_sort) {
541 debug("changing m_sort from " + m_sort + " to " + node.val());
544 node = findnode('.mkwsPerpage');
545 if (node.length && node.val() != m_perpage) {
546 debug("changing m_perpage from " + m_perpage + " to " + node.val());
547 m_perpage = node.val();
552 function triggerSearch (query, sort, targets)
557 // Re-use previous query/sort if new ones are not specified
565 m_filters.push({ id: targets, name: targets });
568 for (var i in m_filters) {
569 var filter = m_filters[i];
573 if (filter.id.match(/^[a-z:]+[=~]/)) {
574 debug("filter '" + filter.id + "' already begins with SETTING OP");
576 filter.id = 'pz:id=' + filter.id;
578 pp2filter += filter.id;
582 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
588 params.limit = pp2limit;
591 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
593 // We can use: params.torusquery = "udb=NAME"
594 // Note: that won't work when running against raw pazpar2
595 m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
599 // limit by target functions
600 that.limitTarget = function (id, name)
602 debug("limitTarget(id=" + id + ", name=" + name + ")");
603 m_filters.push({ id: id, name: name });
612 // limit the query after clicking the facet
613 that.limitQuery = function (field, value)
615 debug("limitQuery(field=" + field + ", value=" + value + ")");
616 m_filters.push({ field: field, value: value });
625 that.delimitTarget = function (id)
627 debug("delimitTarget(id=" + id + ")");
629 for (var i in m_filters) {
630 var filter = m_filters[i];
632 debug("delimitTarget() removing filter " + $.toJSON(filter));
634 debug("delimitTarget() keeping filter " + $.toJSON(filter));
635 newFilters.push(filter);
638 m_filters = newFilters;
648 that.delimitQuery = function (field, value)
650 debug("delimitQuery(field=" + field + ", value=" + value + ")");
652 for (var i in m_filters) {
653 var filter = m_filters[i];
655 field == filter.field &&
656 value == filter.value) {
657 debug("delimitQuery() removing filter " + $.toJSON(filter));
659 debug("delimitQuery() keeping filter " + $.toJSON(filter));
660 newFilters.push(filter);
663 m_filters = newFilters;
673 that.showPage = function (pageNum)
676 m_paz.showPage(m_curPage - 1);
680 // simple paging functions
681 that.pagerNext = function () {
682 if (m_totalRec - m_perpage*m_curPage > 0) {
689 that.pagerPrev = function () {
690 if (m_paz.showPrev() != false)
695 // switching view between targets and records
696 function switchView(view) {
697 var targets = findnode('.mkwsTargets');
698 var results = findnode('.mkwsResults,.mkwsRecords');
699 var blanket = findnode('.mkwsBlanket');
700 var motd = findnode('.mkwsMOTD');
704 if (targets) targets.css('display', 'block');
705 if (results) results.css('display', 'none');
706 if (blanket) blanket.css('display', 'none');
707 if (motd) motd.css('display', 'none');
710 if (targets) targets.css('display', 'none');
711 if (results) results.css('display', 'block');
712 if (blanket) blanket.css('display', 'block');
713 if (motd) motd.css('display', 'none');
716 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
717 if (targets) targets.css('display', 'none');
718 if (results) results.css('display', 'none');
719 if (blanket) blanket.css('display', 'none');
720 if (motd) motd.css('display', 'none');
723 alert("Unknown view '" + view + "'");
728 that.switchView = switchView;
731 // detailed record drawing
732 that.showDetails = function (prefixRecId) {
733 var recId = prefixRecId.replace('mkwsRec_', '');
734 var oldRecId = m_curDetRecId;
735 m_curDetRecId = recId;
737 // remove current detailed view if any
738 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
741 detRecordDiv.parentNode.removeChild(detRecordDiv);
743 // if the same clicked, just hide
744 if (recId == oldRecId) {
746 m_curDetRecData = null;
749 // request the record
750 debug("showDetails() requesting record '" + recId + "'");
756 * All the HTML stuff to render the search forms and
759 function mkwsHtmlAll() {
761 if (mkws_config.show_lang)
764 debug("HTML search form");
765 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
767 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
768 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
769 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
773 debug("HTML records");
774 // If the team has a .mkwsResults, populate it in the usual
775 // way. If not, assume that it's a smarter application that
776 // defines its own subcomponents, some or all of the
783 if (findnode(".mkwsResults").length) {
784 findnode(".mkwsResults").html('\
785 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
787 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
788 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
790 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
791 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
792 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
793 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
794 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
799 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
805 var node = findnode(".mkwsRanking");
807 var ranking_data = '';
808 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
809 if (mkws_config.show_sort) {
810 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
812 if (mkws_config.show_perpage) {
813 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
815 ranking_data += '</form>';
817 node.html(ranking_data);
823 node = findnode('.mkwsSearchForm');
825 node.submit(onFormSubmitEventHandler);
826 node = findnode('.mkwsSort');
828 node.change(onSelectDdChange);
829 node = findnode('.mkwsPerpage');
831 node.change(onSelectDdChange);
833 // on first page, hide the termlist
834 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
835 var motd = findnode(".mkwsMOTD");
836 var container = findnode(".mkwsMOTDContainer");
837 if (motd.length && container.length) {
838 // Move the MOTD from the provided element down into the container
839 motd.appendTo(container);
844 function mkwsSetLang() {
845 var lang = parseQuerystring().lang || mkws_config.lang;
846 if (!lang || !mkws.locale_lang[lang]) {
847 mkws_config.lang = ""
849 mkws_config.lang = lang;
852 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
853 return mkws_config.lang;
857 /* create locale language menu */
858 function mkwsHtmlLang() {
859 var lang_default = "en";
860 var lang = mkws_config.lang || lang_default;
863 /* display a list of configured languages, or all */
864 var lang_options = mkws_config.lang_options || [];
865 var toBeIncluded = {};
866 for (var i = 0; i < lang_options.length; i++) {
867 toBeIncluded[lang_options[i]] = true;
870 for (var k in mkws.locale_lang) {
871 if (toBeIncluded[k] || lang_options.length == 0)
876 if (lang_options.length == 0 || toBeIncluded[lang_default])
877 list.push(lang_default);
879 debug("Language menu for: " + list.join(", "));
883 for(var i = 0; i < list.length; i++) {
890 data += ' <span>' + l + '</span> ';
892 data += ' <a href="?lang=' + l + '">' + l + '</a> '
896 findnode(".mkwsLang").html(data);
900 function mkwsHtmlSort() {
901 debug("HTML sort, m_sort = '" + m_sort + "'");
902 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
904 for(var i = 0; i < mkws_config.sort_options.length; i++) {
905 var opt = mkws_config.sort_options[i];
907 var val = opt.length == 1 ? opt[0] : opt[1];
909 sort_html += '<option value="' + key + '"';
910 if (m_sort == key || m_sort == val) {
911 sort_html += ' selected="selected"';
913 sort_html += '>' + M(val) + '</option>';
915 sort_html += '</select>';
921 function mkwsHtmlPerpage() {
922 debug("HTML perpage, m_perpage = " + m_perpage);
923 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
925 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
926 var key = mkws_config.perpage_options[i];
928 perpage_html += '<option value="' + key + '"';
929 if (key == m_perpage) {
930 perpage_html += ' selected="selected"';
932 perpage_html += '>' + key + '</option>';
934 perpage_html += '</select>';
940 function mkwsHtmlSwitch() {
941 debug("HTML switch for team " + m_teamName);
943 var node = findnode(".mkwsSwitch");
944 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
945 node.append($("<span/>", { text: " | " }));
946 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
948 debug("HTML targets");
949 var node = findnode(".mkwsTargets");
951 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
952 No information available yet.\
954 node.css("display", "none");
958 that.runAutoSearch = function() {
959 // ### should check mkwsTermlist as well, for facet-only teams
960 var node = findnode('.mkwsRecords');
961 var query = node.attr('autosearch');
965 if (query.match(/^!param!/)) {
966 var param = query.replace(/^!param!/, '');
967 query = getParameterByName(param);
968 debug("obtained query '" + query + "' from param '" + param + "'");
970 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
972 } else if (query.match(/^!path!/)) {
973 var index = query.replace(/^!path!/, '');
974 var path = window.location.pathname.split('/');
975 query = path[path.length - index];
976 debug("obtained query '" + query + "' from path-component '" + index + "'");
978 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
982 debug("node=" + node + ", class='" + node.className + "', query=" + query);
984 var sort = node.attr('sort');
985 var targets = node.attr('targets');
986 var s = "running auto search: '" + query + "'";
987 if (sort) s += " sorted by '" + sort + "'";
988 if (targets) s += " in targets '" + targets + "'";
991 newSearch(query, sort, targets);
995 // implement $.parseQuerystring() for parsing URL parameters
996 function parseQuerystring() {
998 var qs = window.location.search.replace('?', '');
999 var pairs = qs.split('&');
1000 $.each(pairs, function(i, v){
1001 var pair = v.split('=');
1002 nvpair[pair[0]] = pair[1];
1008 // This function is taken from a StackOverflow answer
1009 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1010 // ### should we unify this and parseQuerystring()?
1011 function getParameterByName(name) {
1012 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1013 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1014 results = regex.exec(location.search);
1015 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1021 var lang = mkws_config.lang;
1023 if (!lang || !mkws.locale_lang[lang])
1026 return mkws.locale_lang[lang][word] || word;
1028 mkws.M = M; // so the Handlebars helper can use it
1031 // Finds the node of the specified class within the current team
1032 // Multiple OR-clauses separated by commas are handled
1033 // More complex cases may not work
1035 function findnode(selector, teamName) {
1036 teamName = teamName || m_teamName;
1038 selector = selector.split(',').map(function(s) {
1039 return s + '.mkwsTeam_' + teamName;
1046 function renderSummary(hit)
1048 var template = loadTemplate("Summary");
1049 hit._id = "mkwsRec_" + hit.recid;
1050 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
1051 return template(hit);
1055 function renderDetails(data, marker)
1057 var template = loadTemplate("Record");
1058 var details = template(data);
1059 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1063 function loadTemplate(name)
1065 var template = m_template[name];
1067 if (template === undefined) {
1068 // Fall back to generic template if there is no team-specific one
1069 var node = findnode(".mkwsTemplate_" + name);
1071 node = findnode(".mkwsTemplate_" + name, "ALL");
1074 var source = node.html();
1076 source = defaultTemplate(name);
1079 template = Handlebars.compile(source);
1080 debug("compiled template '" + name + "'");
1081 m_template[name] = template;
1088 function defaultTemplate(name)
1090 if (name === 'Record') {
1094 <th>{{translate "Title"}}</th>\
1097 {{#if md-title-remainder}}\
1098 ({{md-title-remainder}})\
1100 {{#if md-title-responsibility}}\
1101 <i>{{md-title-responsibility}}</i>\
1107 <th>{{translate "Date"}}</th>\
1108 <td>{{md-date}}</td>\
1113 <th>{{translate "Author"}}</th>\
1114 <td>{{md-author}}</td>\
1117 {{#if md-electronic-url}}\
1119 <th>{{translate "Links"}}</th>\
1121 {{#each md-electronic-url}}\
1122 <a href="{{this}}">Link{{index1}}</a>\
1127 {{#if-any location having="md-subject"}}\
1129 <th>{{translate "Subject"}}</th>\
1131 {{#first location having="md-subject"}}\
1133 {{#commaList md-subject}}\
1134 {{this}}{{/commaList}}\
1141 <th>{{translate "Locations"}}</th>\
1143 {{#commaList location}}\
1144 {{attr "@name"}}{{/commaList}}\
1149 } else if (name === "Summary") {
1151 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1152 <b>{{md-title}}</b>\
1154 {{#if md-title-remainder}}\
1155 <span>{{md-title-remainder}}</span>\
1157 {{#if md-title-responsibility}}\
1158 <span><i>{{md-title-responsibility}}</i></span>\
1163 var s = "There is no default '" + name +"' template!";
1169 // The following PubSub code is modified from the jQuery manual:
1170 // https://api.jquery.com/jQuery.Callbacks/
1173 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1174 // team.queue("eventName").publish(arg1, arg2, ...);
1177 var queue = function(id) {
1179 var callbacks = $.Callbacks();
1181 publish: callbacks.fire,
1182 subscribe: callbacks.add,
1183 unsubscribe: callbacks.remove
1199 mkws_config.error = e.message;
1200 // alert(e.message);
1204 // Bizarrely, 'that' is just an empty hash. All its state is in
1205 // the closure variables defined earlier in this function.
1210 // wrapper to call team() after page load
1212 mkws.debug = function (string) {
1213 if (!mkws.debug_level)
1216 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1220 // you need to disable use strict at the top of the file!!!
1221 if (mkws.debug_level >= 3) {
1222 console.log(arguments.callee.caller);
1223 } else if (mkws.debug_level >= 2) {
1224 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1226 console.log(string);
1228 var debug = mkws.debug;
1231 mkws.handleNodeWithTeam = function(node, callback) {
1232 // First branch for DOM objects; second branch for jQuery objects
1233 var classes = node.className || node.attr('class');
1235 // For some reason, if we try to proceed when classes is
1236 // undefined, we don't get an error message, but this
1237 // function and its callers, up several stack level,
1238 // silently return. What a crock.
1239 mkws.debug("handleNodeWithTeam() called on node with no classes");
1242 var list = classes.split(/\s+/)
1245 for (var i = 0; i < list.length; i++) {
1246 var cname = list[i];
1247 if (cname.match(/^mkwsTeam_/)) {
1248 teamName = cname.replace(/^mkwsTeam_/, '');
1249 } else if (cname.match(/^mkws/)) {
1250 type = cname.replace(/^mkws/, '');
1253 callback.call(node, teamName, type);
1257 mkws.resizePage = function () {
1258 var list = ["mkwsSwitch", "mkwsLang"];
1260 var width = mkws_config.responsive_design_width;
1261 var parent = $(".mkwsTermlists").parent();
1263 if ($(window).width() <= width &&
1264 parent.hasClass("mkwsTermlistContainer1")) {
1265 debug("changing from wide to narrow: " + $(window).width());
1266 $(".mkwsTermlistContainer1").hide();
1267 $(".mkwsTermlistContainer2").show();
1268 for (var tname in mkws.teams) {
1269 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1270 for(var i = 0; i < list.length; i++) {
1271 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1274 } else if ($(window).width() > width &&
1275 parent.hasClass("mkwsTermlistContainer2")) {
1276 debug("changing from narrow to wide: " + $(window).width());
1277 $(".mkwsTermlistContainer1").show();
1278 $(".mkwsTermlistContainer2").hide();
1279 for (var tname in mkws.teams) {
1280 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1281 for(var i = 0; i < list.length; i++) {
1282 $("." + list[i] + ".mkwsTeam_" + tname).show();
1289 mkws.switchView = function(tname, view) {
1290 mkws.teams[tname].switchView(view);
1293 mkws.showDetails = function (tname, prefixRecId) {
1294 mkws.teams[tname].showDetails(prefixRecId);
1297 mkws.limitTarget = function (tname, id, name) {
1298 mkws.teams[tname].limitTarget(id, name);
1301 mkws.limitQuery = function (tname, field, value) {
1302 mkws.teams[tname].limitQuery(field, value);
1305 mkws.delimitTarget = function (tname, id) {
1306 mkws.teams[tname].delimitTarget(id);
1309 mkws.delimitQuery = function (tname, field, value) {
1310 mkws.teams[tname].delimitQuery(field, value);
1313 mkws.showPage = function (tname, pageNum) {
1314 mkws.teams[tname].showPage(pageNum);
1317 mkws.pagerPrev = function (tname) {
1318 mkws.teams[tname].pagerPrev();
1321 mkws.pagerNext = function (tname) {
1322 mkws.teams[tname].pagerNext();
1326 function defaultMkwsConfig() {
1327 /* default mkws config */
1328 var config_default = {
1329 use_service_proxy: true,
1330 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1331 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1333 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1334 perpage_options: [10, 20, 30, 50],
1335 sort_default: "relevance",
1336 perpage_default: 20,
1338 show_lang: true, /* show/hide language menu */
1339 show_sort: true, /* show/hide sort menu */
1340 show_perpage: true, /* show/hide perpage menu */
1341 lang_options: [], /* display languages links for given languages, [] for all */
1342 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1343 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1344 debug_level: 1, /* debug level for development: 0..2 */
1349 /* Set global debug_level flag early so that debug() works */
1350 if (typeof mkws_config.debug_level !== 'undefined') {
1351 mkws.debug_level = mkws_config.debug_level;
1352 } else if (typeof config_default.debug_level !== 'undefined') {
1353 mkws.debug_level = config_default.debug_level;
1356 // make sure the mkws_config is a valid hash
1357 if (!$.isPlainObject(mkws_config)) {
1358 debug("ERROR: mkws_config is not an JS object, ignore it....");
1362 /* override standard config values by function parameters */
1363 for (var k in config_default) {
1364 if (typeof mkws_config[k] === 'undefined')
1365 mkws_config[k] = config_default[k];
1366 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1372 * Run service-proxy authentication in background (after page load).
1373 * The username/password is configured in the apache config file
1376 function authenticateSession(auth_url, auth_domain, pp2_url) {
1377 debug("Run service proxy auth URL: " + auth_url);
1380 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1381 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1384 var request = new pzHttpRequest(auth_url, function(err) {
1385 alert("HTTP call for authentication failed: " + err)
1389 request.get(null, function(data) {
1390 if (!$.isXMLDoc(data)) {
1391 alert("service proxy auth response document is not valid XML document, give up!");
1394 var status = $(data).find("status");
1395 if (status.text() != "OK") {
1396 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1400 debug("Service proxy auth successfully done");
1401 mkws.authenticated = true;
1407 function runAutoSearches() {
1408 debug("running auto searches");
1410 for (var teamName in mkws.teams) {
1411 mkws.teams[teamName].runAutoSearch();
1416 $(document).ready(function() {
1417 debug("on load ready");
1418 defaultMkwsConfig();
1420 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1421 debug("Reset query width: " + mkws_config.query_width);
1422 mkws_config.query_width = 50;
1425 for (var key in mkws_config) {
1426 if (mkws_config.hasOwnProperty(key)) {
1427 if (key.match(/^language_/)) {
1428 var lang = key.replace(/^language_/, "");
1429 // Copy custom languages into list
1430 mkws.locale_lang[lang] = mkws_config[key];
1431 debug("Added locally configured language '" + lang + "'");
1436 if (mkws_config.responsive_design_width) {
1437 // Responsive web design - change layout on the fly based on
1438 // current screen width. Required for mobile devices.
1439 $(window).resize(function(e) { mkws.resizePage() });
1440 // initial check after page load
1441 $(document).ready(function() { mkws.resizePage() });
1444 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1445 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1446 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1447 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1450 // Backwards compatibility: set new magic class names on any
1451 // elements that have the old magic IDs.
1452 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1453 "Results", "Records", "Targets", "Ranking",
1454 "Termlists", "Stat", "MOTD" ];
1455 for (var i = 0; i < ids.length; i++) {
1456 var id = 'mkws' + ids[i];
1457 var node = $('#' + id);
1458 if (node.attr('id')) {
1460 debug("added magic class to '" + node.attr('id') + "'");
1464 // For all MKWS-classed nodes that don't have a team
1465 // specified, set the team to AUTO.
1466 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1467 if (!this.className.match(/mkwsTeam_/)) {
1468 debug("adding AUTO team to node with class '" + this.className + "'");
1469 $(this).addClass('mkwsTeam_AUTO');
1473 // Find all nodes with an class, and determine their team from
1474 // the mkwsTeam_* class. Make all team objects.
1476 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1477 mkws.handleNodeWithTeam(this, function(tname, type) {
1478 if (!mkws.teams[tname]) {
1479 mkws.teams[tname] = team(j, tname);
1480 debug("Made MKWS team '" + tname + "'");
1482 var myTeam = mkws.teams[tname];
1483 var myWidget = widget(j, myTeam, type, this);
1487 debug("Walking MKWS nodes took " + (now-then) + " ms");
1489 if (mkws_config.use_service_proxy) {
1490 authenticateSession(mkws_config.service_proxy_auth,
1491 mkws_config.service_proxy_auth_domain,
1492 mkws_config.pazpar2_url);