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 team.debug("made targets widget(node=" + node + ")");
164 } else if (type === 'Stat') {
166 team.debug("made stat widget(node=" + node + ")");
167 } else if (type === 'Termlists') {
169 team.debug("made termlists widget(node=" + node + ")");
170 } else if (type === 'Pager') {
172 team.debug("made pager widget(node=" + node + ")");
173 } else if (type === 'Records') {
175 team.debug("made records widget(node=" + node + ")");
177 // ### Handle other types here
178 team.debug("made unencapsulated widget(type=" + type + ", node=" + node + ")");
184 // Functions follow for promoting the regular widget object into
185 // widgets of specific types. These could be moved outside of the
186 // widget object, or even into their own source files.
188 function promoteTargets() {
189 team.queue("targets").subscribe(function(data) {
190 if (node.length === 0) alert("huh?!");
192 var table ='<table><thead><tr>' +
193 '<td>' + M('Target ID') + '</td>' +
194 '<td>' + M('Hits') + '</td>' +
195 '<td>' + M('Diags') + '</td>' +
196 '<td>' + M('Records') + '</td>' +
197 '<td>' + M('State') + '</td>' +
198 '</tr></thead><tbody>';
200 for (var i = 0; i < data.length; i++) {
201 table += "<tr><td>" + data[i].id +
202 "</td><td>" + data[i].hits +
203 "</td><td>" + data[i].diagnostic +
204 "</td><td>" + data[i].records +
205 "</td><td>" + data[i].state + "</td></tr>";
208 table += '</tbody></table>';
209 var subnode = $(node).children('.mkwsBytarget');
215 function promoteStat() {
216 team.queue("stat").subscribe(function(data) {
217 if (node.length === 0) alert("huh?!");
219 $(node).html('<span class="head">' + M('Status info') + '</span>' +
221 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
223 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
228 function promoteTermlists() {
229 team.queue("termlists").subscribe(function(data) {
230 mkws.debug("in termlist consumer");
232 alert("termlists event when there are no termlists");
236 // no facets: this should never happen
237 if (!mkws_config.facets || mkws_config.facets.length == 0) {
238 alert("onTerm called even though we have no facets: " + $.toJSON(data));
243 // display if we first got results
247 acc.push('<div class="title">' + M('Termlists') + '</div>');
248 var facets = mkws_config.facets;
250 for (var i = 0; i < facets.length; i++) {
251 if (facets[i] == "xtargets") {
252 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
253 } else if (facets[i] == "subject") {
254 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
255 } else if (facets[i] == "author") {
256 addSingleFacet(acc, "Authors", data.author, 10, "author");
258 alert("bad facet configuration: '" + facets[i] + "'");
262 $(node).html(acc.join(''));
264 function addSingleFacet(acc, caption, data, max, pzIndex) {
265 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
266 acc.push('<div class="termtitle">' + M(caption) + '</div>');
267 for (var i = 0; i < data.length && i < max; i++) {
268 acc.push('<div class="term">');
269 acc.push('<a href="#" ');
272 // Special case: target selection
273 acc.push('target_id='+data[i].id+' ');
274 if (!team.targetFiltered(data[i].id)) {
275 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
278 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
280 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
281 + ' <span>' + data[i].freq + '</span>');
290 function promotePager() {
291 team.queue("pager").subscribe(function(data) {
292 $(node).html(drawPager(data))
294 function drawPager(data) {
295 var s = '<div style="float: right">' + M('Displaying') + ': '
296 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
297 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
298 + data.total + ')</div>';
300 //client indexes pages from 1 but pz2 from 0
302 var pages = Math.ceil(team.totalRecordCount() / team.perpage());
303 var currentPage = team.currentPage();
305 var firstClkbl = (currentPage - onsides > 0)
306 ? currentPage - onsides
309 var lastClkbl = firstClkbl + 2*onsides < pages
310 ? firstClkbl + 2*onsides
313 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
315 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
316 +'<< ' + M('Prev') + '</a><b> | </b>';
319 for(var i = firstClkbl; i <= lastClkbl; i++) {
322 numLabel = '<b>' + i + '</b>';
324 middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
325 + numLabel + ' </a>';
328 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
329 if (pages - currentPage > 0)
330 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
331 + M('Next') + ' >></a>';
338 if (lastClkbl < pages)
341 s += '<div style="float: clear">'
342 + prev + predots + middle + postdots + next + '</div>';
350 function promoteRecords() {
351 team.queue("records").subscribe(function(data) {
353 for (var i = 0; i < data.hits.length; i++) {
354 var hit = data.hits[i];
355 html.push('<div class="record" id="mkwsRecdiv_' + team.name() + '_' + hit.recid + '" >',
358 // ### At some point, we may be able to move the
359 // m_currentRecordId and m_currentRecordData members
360 // from the team object into this widget.
361 if (hit.recid == team.currentRecordId()) {
362 if (team.currentRecordData())
363 html.push(team.renderDetails(team.currentRecordData()));
366 $(node).html(html.join(''));
368 function renderSummary(hit)
370 var template = team.loadTemplate("Summary");
371 hit._id = "mkwsRec_" + hit.recid;
372 hit._onclick = "mkws.showDetails('" + team.name() + "', this.id);return false;"
373 return template(hit);
380 // Factory function for team objects. As much as possible, this uses
381 // only member variables (prefixed "m_") and inner functions with
382 // private scope. Some functions are visibl as member-functions to be
383 // called from outside code -- specifically, from generated
384 // HTML. These functions are that.switchView(), showDetails(),
385 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
386 // pagerPrev(), pagerNext(), showPage().
388 function team($, teamName) {
390 var m_teamName = teamName;
391 var m_submitted = false;
392 var m_query; // initially undefined
393 var m_sortOrder; // will be set below
394 var m_perpage; // will be set below
396 var m_totalRecordCount = 0;
397 var m_currentPage = 1;
398 var m_currentRecordId = '';
399 var m_currentRecordData = null;
401 // Timestamps for logging
405 var m_paz; // will be initialised below
408 that.name = function() { return m_teamName; }
409 that.perpage = function() { return m_perpage; }
410 that.totalRecordCount = function() { return m_totalRecordCount; }
411 that.currentPage = function() { return m_currentPage; }
412 that.currentRecordId = function() { return m_currentRecordId; }
413 that.currentRecordData = function() { return m_currentRecordData; }
415 var debug = function (s) {
417 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
418 m_debugTime.last = now;
420 mkws.debug(m_teamName + ": " + timestamp + s);
424 debug("start running MKWS");
426 m_sortOrder = mkws_config.sort_default;
427 m_perpage = mkws_config.perpage_default;
429 debug("Create main pz2 object");
430 // create a parameters array and pass it to the pz2's constructor
431 // then register the form submit event with the pz2.search function
432 // autoInit is set to true on default
433 m_paz = new pz2({ "windowid": teamName,
434 "pazpar2path": mkws_config.pazpar2_url,
435 "usesessions" : mkws_config.use_service_proxy ? false : true,
437 "onbytarget": onBytarget,
439 "onterm": (mkws_config.facets.length ? onTerm : undefined),
441 "onrecord": onRecord,
442 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
443 "termlist": mkws_config.facets.join(',')
448 // pz2.js event handlers:
457 function onBytarget(data) {
459 queue("targets").publish(data);
463 function onStat(data) {
465 queue("stat").publish(data);
469 function onTerm(data) {
471 queue("termlists").publish(data);
475 function onShow(data, teamName) {
477 m_totalRecordCount = data.merged;
478 queue("pager").publish(data);
479 queue("records").publish(data);
483 function onRecord(data, args, teamName) {
485 // FIXME: record is async!!
486 clearTimeout(m_paz.recordTimer);
487 // in case on_show was faster to redraw element
488 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
489 if (detRecordDiv) return;
490 m_currentRecordData = data;
491 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
492 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
493 var html = renderDetails(m_currentRecordData);
494 $(recordDiv).append(html);
498 that.targetFiltered = function(id) {
499 for (var i = 0; i < m_filters.length; i++) {
500 if (m_filters[i].id === id ||
501 m_filters[i].id === 'pz:id=' + id) {
509 ////////////////////////////////////////////////////////////////////////////////
510 ////////////////////////////////////////////////////////////////////////////////
513 // when search button pressed
514 function onFormSubmitEventHandler()
516 var val = findnode('.mkwsQuery').val();
522 function newSearch(query, sortOrder, targets)
524 debug("newSearch: " + query);
526 if (mkws_config.use_service_proxy && !mkws.authenticated) {
527 alert("searching before authentication");
535 triggerSearch(query, sortOrder, targets);
536 switchView('records'); // In case it's configured to start off as hidden
541 function onSelectDdChange()
543 if (!m_submitted) return false;
546 m_paz.show(0, m_perpage, m_sortOrder);
551 function redrawNavi ()
553 var navi = findnode('.mkwsNavi');
557 for (var i in m_filters) {
561 var filter = m_filters[i];
563 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
564 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
566 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
567 "', '" + filter.field + "', '" + filter.value + "'" +
568 ');return false;">' + filter.value + '</a>';
579 m_totalRecordCount = 0;
583 function loadSelect ()
585 var node = findnode('.mkwsSort');
586 if (node.length && node.val() != m_sortOrder) {
587 debug("changing m_sortOrder from " + m_sortOrder + " to " + node.val());
588 m_sortOrder = node.val();
590 node = findnode('.mkwsPerpage');
591 if (node.length && node.val() != m_perpage) {
592 debug("changing m_perpage from " + m_perpage + " to " + node.val());
593 m_perpage = node.val();
598 function triggerSearch (query, sortOrder, targets)
603 // Continue to use previous query/sort-order unless new ones are specified
608 m_sortOrder = sortOrder;
611 m_filters.push({ id: targets, name: targets });
614 for (var i in m_filters) {
615 var filter = m_filters[i];
619 if (filter.id.match(/^[a-z:]+[=~]/)) {
620 debug("filter '" + filter.id + "' already begins with SETTING OP");
622 filter.id = 'pz:id=' + filter.id;
624 pp2filter += filter.id;
628 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
634 params.limit = pp2limit;
637 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
639 // We can use: params.torusquery = "udb=NAME"
640 // Note: that won't work when running against raw pazpar2
641 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
645 // limit by target functions
646 that.limitTarget = function (id, name)
648 debug("limitTarget(id=" + id + ", name=" + name + ")");
649 m_filters.push({ id: id, name: name });
658 // limit the query after clicking the facet
659 that.limitQuery = function (field, value)
661 debug("limitQuery(field=" + field + ", value=" + value + ")");
662 m_filters.push({ field: field, value: value });
671 that.delimitTarget = function (id)
673 debug("delimitTarget(id=" + id + ")");
675 for (var i in m_filters) {
676 var filter = m_filters[i];
678 debug("delimitTarget() removing filter " + $.toJSON(filter));
680 debug("delimitTarget() keeping filter " + $.toJSON(filter));
681 newFilters.push(filter);
684 m_filters = newFilters;
694 that.delimitQuery = function (field, value)
696 debug("delimitQuery(field=" + field + ", value=" + value + ")");
698 for (var i in m_filters) {
699 var filter = m_filters[i];
701 field == filter.field &&
702 value == filter.value) {
703 debug("delimitQuery() removing filter " + $.toJSON(filter));
705 debug("delimitQuery() keeping filter " + $.toJSON(filter));
706 newFilters.push(filter);
709 m_filters = newFilters;
719 that.showPage = function (pageNum)
721 m_currentPage = pageNum;
722 m_paz.showPage(m_currentPage - 1);
726 // simple paging functions
727 that.pagerNext = function () {
728 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
735 that.pagerPrev = function () {
736 if (m_paz.showPrev() != false)
741 // switching view between targets and records
742 function switchView(view) {
743 var targets = findnode('.mkwsTargets');
744 var results = findnode('.mkwsResults,.mkwsRecords');
745 var blanket = findnode('.mkwsBlanket');
746 var motd = findnode('.mkwsMOTD');
750 if (targets) targets.css('display', 'block');
751 if (results) results.css('display', 'none');
752 if (blanket) blanket.css('display', 'none');
753 if (motd) motd.css('display', 'none');
756 if (targets) targets.css('display', 'none');
757 if (results) results.css('display', 'block');
758 if (blanket) blanket.css('display', 'block');
759 if (motd) motd.css('display', 'none');
762 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
763 if (targets) targets.css('display', 'none');
764 if (results) results.css('display', 'none');
765 if (blanket) blanket.css('display', 'none');
766 if (motd) motd.css('display', 'none');
769 alert("Unknown view '" + view + "'");
774 that.switchView = switchView;
777 // detailed record drawing
778 that.showDetails = function (prefixRecId) {
779 var recId = prefixRecId.replace('mkwsRec_', '');
780 var oldRecordId = m_currentRecordId;
781 m_currentRecordId = recId;
783 // remove current detailed view if any
784 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
787 detRecordDiv.parentNode.removeChild(detRecordDiv);
789 // if the same clicked, just hide
790 if (recId == oldRecordId) {
791 m_currentRecordId = '';
792 m_currentRecordData = null;
795 // request the record
796 debug("showDetails() requesting record '" + recId + "'");
802 * All the HTML stuff to render the search forms and
805 function mkwsHtmlAll() {
807 if (mkws_config.show_lang)
810 debug("HTML search form");
811 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
813 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
814 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
815 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
819 debug("HTML records");
820 // If the team has a .mkwsResults, populate it in the usual
821 // way. If not, assume that it's a smarter application that
822 // defines its own subcomponents, some or all of the
829 if (findnode(".mkwsResults").length) {
830 findnode(".mkwsResults").html('\
831 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
833 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
834 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
836 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
837 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
838 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
839 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
840 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
845 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
851 var node = findnode(".mkwsRanking");
853 var ranking_data = '';
854 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
855 if (mkws_config.show_sort) {
856 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
858 if (mkws_config.show_perpage) {
859 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
861 ranking_data += '</form>';
863 node.html(ranking_data);
869 node = findnode('.mkwsSearchForm');
871 node.submit(onFormSubmitEventHandler);
872 node = findnode('.mkwsSort');
874 node.change(onSelectDdChange);
875 node = findnode('.mkwsPerpage');
877 node.change(onSelectDdChange);
879 // on first page, hide the termlist
880 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
881 var motd = findnode(".mkwsMOTD");
882 var container = findnode(".mkwsMOTDContainer");
883 if (motd.length && container.length) {
884 // Move the MOTD from the provided element down into the container
885 motd.appendTo(container);
890 function mkwsSetLang() {
891 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
892 if (!lang || !mkws.locale_lang[lang]) {
893 mkws_config.lang = ""
895 mkws_config.lang = lang;
898 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
899 return mkws_config.lang;
903 /* create locale language menu */
904 function mkwsHtmlLang() {
905 var lang_default = "en";
906 var lang = mkws_config.lang || lang_default;
909 /* display a list of configured languages, or all */
910 var lang_options = mkws_config.lang_options || [];
911 var toBeIncluded = {};
912 for (var i = 0; i < lang_options.length; i++) {
913 toBeIncluded[lang_options[i]] = true;
916 for (var k in mkws.locale_lang) {
917 if (toBeIncluded[k] || lang_options.length == 0)
922 if (lang_options.length == 0 || toBeIncluded[lang_default])
923 list.push(lang_default);
925 debug("Language menu for: " + list.join(", "));
929 for(var i = 0; i < list.length; i++) {
936 data += ' <span>' + l + '</span> ';
938 data += ' <a href="?lang=' + l + '">' + l + '</a> '
942 findnode(".mkwsLang").html(data);
946 function mkwsHtmlSort() {
947 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
948 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
950 for(var i = 0; i < mkws_config.sort_options.length; i++) {
951 var opt = mkws_config.sort_options[i];
953 var val = opt.length == 1 ? opt[0] : opt[1];
955 sort_html += '<option value="' + key + '"';
956 if (m_sortOrder == key || m_sortOrder == val) {
957 sort_html += ' selected="selected"';
959 sort_html += '>' + M(val) + '</option>';
961 sort_html += '</select>';
967 function mkwsHtmlPerpage() {
968 debug("HTML perpage, m_perpage = " + m_perpage);
969 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
971 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
972 var key = mkws_config.perpage_options[i];
974 perpage_html += '<option value="' + key + '"';
975 if (key == m_perpage) {
976 perpage_html += ' selected="selected"';
978 perpage_html += '>' + key + '</option>';
980 perpage_html += '</select>';
986 function mkwsHtmlSwitch() {
987 debug("HTML switch for team " + m_teamName);
989 var node = findnode(".mkwsSwitch");
990 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
991 node.append($("<span/>", { text: " | " }));
992 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
994 debug("HTML targets");
995 var node = findnode(".mkwsTargets");
997 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
998 No information available yet.\
1000 node.css("display", "none");
1004 that.runAutoSearch = function() {
1005 var node = findnode('.mkwsRecords,.mkwsTermlists');
1006 var query = node.attr('autosearch');
1010 if (query.match(/^!param!/)) {
1011 var param = query.replace(/^!param!/, '');
1012 query = mkws.getParameterByName(param);
1013 debug("obtained query '" + query + "' from param '" + param + "'");
1015 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1017 } else if (query.match(/^!path!/)) {
1018 var index = query.replace(/^!path!/, '');
1019 var path = window.location.pathname.split('/');
1020 query = path[path.length - index];
1021 debug("obtained query '" + query + "' from path-component '" + index + "'");
1023 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1027 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1029 var sortOrder = node.attr('sort');
1030 var targets = node.attr('targets');
1031 var s = "running auto search: '" + query + "'";
1032 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1033 if (targets) s += " in targets '" + targets + "'";
1036 newSearch(query, sortOrder, targets);
1040 // Translation function. At present, this is properly a
1041 // global-level function (hence the assignment to mkws.M) but we
1042 // want to make it per-team so different teams can operate in
1043 // different languages.
1046 var lang = mkws_config.lang;
1048 if (!lang || !mkws.locale_lang[lang])
1051 return mkws.locale_lang[lang][word] || word;
1053 mkws.M = M; // so the Handlebars helper can use it
1056 // Finds the node of the specified class within the current team
1057 // Multiple OR-clauses separated by commas are handled
1058 // More complex cases may not work
1060 function findnode(selector, teamName) {
1061 teamName = teamName || m_teamName;
1063 selector = $.map(selector.split(','), function(s, i) {
1064 return s + '.mkwsTeam_' + teamName;
1071 function renderDetails(data, marker)
1073 var template = loadTemplate("Record");
1074 var details = template(data);
1075 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1077 that.renderDetails = renderDetails;
1080 function loadTemplate(name)
1082 var template = m_template[name];
1084 if (template === undefined) {
1085 // Fall back to generic template if there is no team-specific one
1086 var node = findnode(".mkwsTemplate_" + name);
1088 node = findnode(".mkwsTemplate_" + name, "ALL");
1091 var source = node.html();
1093 source = mkws.defaultTemplate(name);
1096 template = Handlebars.compile(source);
1097 debug("compiled template '" + name + "'");
1098 m_template[name] = template;
1103 that.loadTemplate = loadTemplate;
1106 // The following PubSub code is modified from the jQuery manual:
1107 // https://api.jquery.com/jQuery.Callbacks/
1110 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1111 // team.queue("eventName").publish(arg1, arg2, ...);
1114 var queue = function(id) {
1116 var callbacks = $.Callbacks();
1118 publish: callbacks.fire,
1119 subscribe: callbacks.add,
1120 unsubscribe: callbacks.remove
1136 mkws_config.error = e.message;
1137 // alert(e.message);
1141 // Bizarrely, 'that' is just an empty hash. All its state is in
1142 // the closure variables defined earlier in this function.
1147 // wrapper to call team() after page load
1149 mkws.debug = function (string) {
1150 if (!mkws.debug_level)
1153 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1157 // you need to disable use strict at the top of the file!!!
1158 if (mkws.debug_level >= 3) {
1159 console.log(arguments.callee.caller);
1160 } else if (mkws.debug_level >= 2) {
1161 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1163 console.log(string);
1165 var debug = mkws.debug;
1168 mkws.handleNodeWithTeam = function(node, callback) {
1169 // First branch for DOM objects; second branch for jQuery objects
1170 var classes = node.className || node.attr('class');
1172 // For some reason, if we try to proceed when classes is
1173 // undefined, we don't get an error message, but this
1174 // function and its callers, up several stack level,
1175 // silently return. What a crock.
1176 mkws.debug("handleNodeWithTeam() called on node with no classes");
1179 var list = classes.split(/\s+/)
1182 for (var i = 0; i < list.length; i++) {
1183 var cname = list[i];
1184 if (cname.match(/^mkwsTeam_/)) {
1185 teamName = cname.replace(/^mkwsTeam_/, '');
1186 } else if (cname.match(/^mkws/)) {
1187 type = cname.replace(/^mkws/, '');
1190 callback.call(node, teamName, type);
1194 mkws.resizePage = function () {
1195 var list = ["mkwsSwitch", "mkwsLang"];
1197 var width = mkws_config.responsive_design_width;
1198 var parent = $(".mkwsTermlists").parent();
1200 if ($(window).width() <= width &&
1201 parent.hasClass("mkwsTermlistContainer1")) {
1202 debug("changing from wide to narrow: " + $(window).width());
1203 $(".mkwsTermlistContainer1").hide();
1204 $(".mkwsTermlistContainer2").show();
1205 for (var tname in mkws.teams) {
1206 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1207 for(var i = 0; i < list.length; i++) {
1208 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1211 } else if ($(window).width() > width &&
1212 parent.hasClass("mkwsTermlistContainer2")) {
1213 debug("changing from narrow to wide: " + $(window).width());
1214 $(".mkwsTermlistContainer1").show();
1215 $(".mkwsTermlistContainer2").hide();
1216 for (var tname in mkws.teams) {
1217 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1218 for(var i = 0; i < list.length; i++) {
1219 $("." + list[i] + ".mkwsTeam_" + tname).show();
1226 mkws.switchView = function(tname, view) {
1227 mkws.teams[tname].switchView(view);
1230 mkws.showDetails = function (tname, prefixRecId) {
1231 mkws.teams[tname].showDetails(prefixRecId);
1234 mkws.limitTarget = function (tname, id, name) {
1235 mkws.teams[tname].limitTarget(id, name);
1238 mkws.limitQuery = function (tname, field, value) {
1239 mkws.teams[tname].limitQuery(field, value);
1242 mkws.delimitTarget = function (tname, id) {
1243 mkws.teams[tname].delimitTarget(id);
1246 mkws.delimitQuery = function (tname, field, value) {
1247 mkws.teams[tname].delimitQuery(field, value);
1250 mkws.showPage = function (tname, pageNum) {
1251 mkws.teams[tname].showPage(pageNum);
1254 mkws.pagerPrev = function (tname) {
1255 mkws.teams[tname].pagerPrev();
1258 mkws.pagerNext = function (tname) {
1259 mkws.teams[tname].pagerNext();
1263 // This function is taken from a StackOverflow answer
1264 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1265 mkws.getParameterByName = function(name) {
1266 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1267 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1268 results = regex.exec(location.search);
1269 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1273 mkws.defaultTemplate = function(name)
1275 if (name === 'Record') {
1279 <th>{{translate "Title"}}</th>\
1282 {{#if md-title-remainder}}\
1283 ({{md-title-remainder}})\
1285 {{#if md-title-responsibility}}\
1286 <i>{{md-title-responsibility}}</i>\
1292 <th>{{translate "Date"}}</th>\
1293 <td>{{md-date}}</td>\
1298 <th>{{translate "Author"}}</th>\
1299 <td>{{md-author}}</td>\
1302 {{#if md-electronic-url}}\
1304 <th>{{translate "Links"}}</th>\
1306 {{#each md-electronic-url}}\
1307 <a href="{{this}}">Link{{index1}}</a>\
1312 {{#if-any location having="md-subject"}}\
1314 <th>{{translate "Subject"}}</th>\
1316 {{#first location having="md-subject"}}\
1318 {{#commaList md-subject}}\
1319 {{this}}{{/commaList}}\
1326 <th>{{translate "Locations"}}</th>\
1328 {{#commaList location}}\
1329 {{attr "@name"}}{{/commaList}}\
1334 } else if (name === "Summary") {
1336 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1337 <b>{{md-title}}</b>\
1339 {{#if md-title-remainder}}\
1340 <span>{{md-title-remainder}}</span>\
1342 {{#if md-title-responsibility}}\
1343 <span><i>{{md-title-responsibility}}</i></span>\
1348 var s = "There is no default '" + name +"' template!";
1354 function defaultMkwsConfig() {
1355 /* default mkws config */
1356 var config_default = {
1357 use_service_proxy: true,
1358 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1359 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1361 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1362 perpage_options: [10, 20, 30, 50],
1363 sort_default: "relevance",
1364 perpage_default: 20,
1366 show_lang: true, /* show/hide language menu */
1367 show_sort: true, /* show/hide sort menu */
1368 show_perpage: true, /* show/hide perpage menu */
1369 lang_options: [], /* display languages links for given languages, [] for all */
1370 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1371 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1372 debug_level: 1, /* debug level for development: 0..2 */
1377 /* Set global debug_level flag early so that debug() works */
1378 if (typeof mkws_config.debug_level !== 'undefined') {
1379 mkws.debug_level = mkws_config.debug_level;
1380 } else if (typeof config_default.debug_level !== 'undefined') {
1381 mkws.debug_level = config_default.debug_level;
1384 // make sure the mkws_config is a valid hash
1385 if (!$.isPlainObject(mkws_config)) {
1386 debug("ERROR: mkws_config is not an JS object, ignore it....");
1390 /* override standard config values by function parameters */
1391 for (var k in config_default) {
1392 if (typeof mkws_config[k] === 'undefined')
1393 mkws_config[k] = config_default[k];
1394 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1400 * Run service-proxy authentication in background (after page load).
1401 * The username/password is configured in the apache config file
1404 function authenticateSession(auth_url, auth_domain, pp2_url) {
1405 debug("Run service proxy auth URL: " + auth_url);
1408 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1409 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1412 var request = new pzHttpRequest(auth_url, function(err) {
1413 alert("HTTP call for authentication failed: " + err)
1417 request.get(null, function(data) {
1418 if (!$.isXMLDoc(data)) {
1419 alert("service proxy auth response document is not valid XML document, give up!");
1422 var status = $(data).find("status");
1423 if (status.text() != "OK") {
1424 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1428 debug("Service proxy auth successfully done");
1429 mkws.authenticated = true;
1435 function runAutoSearches() {
1436 debug("running auto searches");
1438 for (var teamName in mkws.teams) {
1439 mkws.teams[teamName].runAutoSearch();
1444 $(document).ready(function() {
1445 debug("on load ready");
1446 defaultMkwsConfig();
1448 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1449 debug("Reset query width: " + mkws_config.query_width);
1450 mkws_config.query_width = 50;
1453 for (var key in mkws_config) {
1454 if (mkws_config.hasOwnProperty(key)) {
1455 if (key.match(/^language_/)) {
1456 var lang = key.replace(/^language_/, "");
1457 // Copy custom languages into list
1458 mkws.locale_lang[lang] = mkws_config[key];
1459 debug("Added locally configured language '" + lang + "'");
1464 if (mkws_config.responsive_design_width) {
1465 // Responsive web design - change layout on the fly based on
1466 // current screen width. Required for mobile devices.
1467 $(window).resize(function(e) { mkws.resizePage() });
1468 // initial check after page load
1469 $(document).ready(function() { mkws.resizePage() });
1472 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1473 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1474 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1475 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1478 // Backwards compatibility: set new magic class names on any
1479 // elements that have the old magic IDs.
1480 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1481 "Results", "Records", "Targets", "Ranking",
1482 "Termlists", "Stat", "MOTD" ];
1483 for (var i = 0; i < ids.length; i++) {
1484 var id = 'mkws' + ids[i];
1485 var node = $('#' + id);
1486 if (node.attr('id')) {
1488 debug("added magic class to '" + node.attr('id') + "'");
1492 // For all MKWS-classed nodes that don't have a team
1493 // specified, set the team to AUTO.
1494 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1495 if (!this.className.match(/mkwsTeam_/)) {
1496 debug("adding AUTO team to node with class '" + this.className + "'");
1497 $(this).addClass('mkwsTeam_AUTO');
1501 // Find all nodes with an MKWS class, and determine their team from
1502 // the mkwsTeam_* class. Make all team objects.
1504 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1505 mkws.handleNodeWithTeam(this, function(tname, type) {
1506 if (!mkws.teams[tname]) {
1507 mkws.teams[tname] = team(j, tname);
1508 debug("Made MKWS team '" + tname + "'");
1512 // Second pass: make the individual widget objects. This has
1513 // to be done separately, and after the team-creation, since
1514 // that sometimes makes new widget nodes (e.g. creating
1515 // mkwsTermlists instead mkwsResults.
1516 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1517 mkws.handleNodeWithTeam(this, function(tname, type) {
1518 var myTeam = mkws.teams[tname];
1519 var myWidget = widget(j, myTeam, type, this);
1523 debug("Walking MKWS nodes took " + (now-then) + " ms");
1525 if (mkws_config.use_service_proxy) {
1526 authenticateSession(mkws_config.service_proxy_auth,
1527 mkws_config.service_proxy_auth_domain,
1528 mkws_config.pazpar2_url);