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) {
162 Targets: promoteTargets,
164 Termlists: promoteTermlists,
166 Records: promoteRecords,
170 var promote = type2fn[type];
173 team.debug("made " + type + " widget(node=" + node + ")");
175 team.debug("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
181 // Functions follow for promoting the regular widget object into
182 // widgets of specific types. These could be moved outside of the
183 // widget object, or even into their own source files.
185 function promoteTargets() {
186 team.queue("targets").subscribe(function(data) {
187 if (node.length === 0) alert("huh?!");
189 var table ='<table><thead><tr>' +
190 '<td>' + M('Target ID') + '</td>' +
191 '<td>' + M('Hits') + '</td>' +
192 '<td>' + M('Diags') + '</td>' +
193 '<td>' + M('Records') + '</td>' +
194 '<td>' + M('State') + '</td>' +
195 '</tr></thead><tbody>';
197 for (var i = 0; i < data.length; i++) {
198 table += "<tr><td>" + data[i].id +
199 "</td><td>" + data[i].hits +
200 "</td><td>" + data[i].diagnostic +
201 "</td><td>" + data[i].records +
202 "</td><td>" + data[i].state + "</td></tr>";
205 table += '</tbody></table>';
206 var subnode = $(node).children('.mkwsBytarget');
212 function promoteStat() {
213 team.queue("stat").subscribe(function(data) {
214 if (node.length === 0) alert("huh?!");
216 $(node).html('<span class="head">' + M('Status info') + '</span>' +
218 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
220 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
225 function promoteTermlists() {
226 team.queue("termlists").subscribe(function(data) {
227 mkws.debug("in termlist consumer");
229 alert("termlists event when there are no termlists");
233 // no facets: this should never happen
234 if (!mkws_config.facets || mkws_config.facets.length == 0) {
235 alert("onTerm called even though we have no facets: " + $.toJSON(data));
240 // display if we first got results
244 acc.push('<div class="title">' + M('Termlists') + '</div>');
245 var facets = mkws_config.facets;
247 for (var i = 0; i < facets.length; i++) {
248 if (facets[i] == "xtargets") {
249 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
250 } else if (facets[i] == "subject") {
251 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
252 } else if (facets[i] == "author") {
253 addSingleFacet(acc, "Authors", data.author, 10, "author");
255 alert("bad facet configuration: '" + facets[i] + "'");
259 $(node).html(acc.join(''));
261 function addSingleFacet(acc, caption, data, max, pzIndex) {
262 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
263 acc.push('<div class="termtitle">' + M(caption) + '</div>');
264 for (var i = 0; i < data.length && i < max; i++) {
265 acc.push('<div class="term">');
266 acc.push('<a href="#" ');
269 // Special case: target selection
270 acc.push('target_id='+data[i].id+' ');
271 if (!team.targetFiltered(data[i].id)) {
272 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
275 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
277 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
278 + ' <span>' + data[i].freq + '</span>');
287 function promotePager() {
288 team.queue("pager").subscribe(function(data) {
289 $(node).html(drawPager(data))
291 function drawPager(data) {
292 var s = '<div style="float: right">' + M('Displaying') + ': '
293 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
294 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
295 + data.total + ')</div>';
297 //client indexes pages from 1 but pz2 from 0
299 var pages = Math.ceil(team.totalRecordCount() / team.perpage());
300 var currentPage = team.currentPage();
302 var firstClkbl = (currentPage - onsides > 0)
303 ? currentPage - onsides
306 var lastClkbl = firstClkbl + 2*onsides < pages
307 ? firstClkbl + 2*onsides
310 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
312 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
313 +'<< ' + M('Prev') + '</a><b> | </b>';
316 for(var i = firstClkbl; i <= lastClkbl; i++) {
319 numLabel = '<b>' + i + '</b>';
321 middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
322 + numLabel + ' </a>';
325 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
326 if (pages - currentPage > 0)
327 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
328 + M('Next') + ' >></a>';
335 if (lastClkbl < pages)
338 s += '<div style="float: clear">'
339 + prev + predots + middle + postdots + next + '</div>';
347 function promoteRecords() {
348 team.queue("records").subscribe(function(data) {
350 for (var i = 0; i < data.hits.length; i++) {
351 var hit = data.hits[i];
352 html.push('<div class="record" id="mkwsRecdiv_' + team.name() + '_' + hit.recid + '" >',
355 // ### At some point, we may be able to move the
356 // m_currentRecordId and m_currentRecordData members
357 // from the team object into this widget.
358 if (hit.recid == team.currentRecordId()) {
359 if (team.currentRecordData())
360 html.push(team.renderDetails(team.currentRecordData()));
363 $(node).html(html.join(''));
365 function renderSummary(hit)
367 var template = team.loadTemplate("Summary");
368 hit._id = "mkwsRec_" + hit.recid;
369 hit._onclick = "mkws.showDetails('" + team.name() + "', this.id);return false;"
370 return template(hit);
376 function promoteNavi() {
377 team.queue("navi").subscribe(function() {
378 var filters = team.filters();
381 for (var i in filters) {
385 var filter = filters[i];
387 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
388 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
390 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
391 "', '" + filter.field + "', '" + filter.value + "'" +
392 ');return false;">' + filter.value + '</a>';
402 // Factory function for team objects. As much as possible, this uses
403 // only member variables (prefixed "m_") and inner functions with
404 // private scope. Some functions are visibl as member-functions to be
405 // called from outside code -- specifically, from generated
406 // HTML. These functions are that.switchView(), showDetails(),
407 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
408 // pagerPrev(), pagerNext(), showPage().
410 function team($, teamName) {
412 var m_teamName = teamName;
413 var m_submitted = false;
414 var m_query; // initially undefined
415 var m_sortOrder; // will be set below
416 var m_perpage; // will be set below
418 var m_totalRecordCount = 0;
419 var m_currentPage = 1;
420 var m_currentRecordId = '';
421 var m_currentRecordData = null;
423 // Timestamps for logging
427 var m_paz; // will be initialised below
430 that.name = function() { return m_teamName; }
431 that.perpage = function() { return m_perpage; }
432 that.totalRecordCount = function() { return m_totalRecordCount; }
433 that.currentPage = function() { return m_currentPage; }
434 that.currentRecordId = function() { return m_currentRecordId; }
435 that.currentRecordData = function() { return m_currentRecordData; }
436 that.filters = function() { return m_filters; }
438 var debug = function (s) {
440 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
441 m_debugTime.last = now;
443 mkws.debug(m_teamName + ": " + timestamp + s);
447 debug("start running MKWS");
449 m_sortOrder = mkws_config.sort_default;
450 m_perpage = mkws_config.perpage_default;
452 debug("Create main pz2 object");
453 // create a parameters array and pass it to the pz2's constructor
454 // then register the form submit event with the pz2.search function
455 // autoInit is set to true on default
456 m_paz = new pz2({ "windowid": teamName,
457 "pazpar2path": mkws_config.pazpar2_url,
458 "usesessions" : mkws_config.use_service_proxy ? false : true,
460 "onbytarget": onBytarget,
462 "onterm": (mkws_config.facets.length ? onTerm : undefined),
464 "onrecord": onRecord,
465 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
466 "termlist": mkws_config.facets.join(',')
471 // pz2.js event handlers:
480 function onBytarget(data) {
482 queue("targets").publish(data);
486 function onStat(data) {
488 queue("stat").publish(data);
492 function onTerm(data) {
494 queue("termlists").publish(data);
498 function onShow(data, teamName) {
500 m_totalRecordCount = data.merged;
501 queue("pager").publish(data);
502 queue("records").publish(data);
506 function onRecord(data, args, teamName) {
508 // FIXME: record is async!!
509 clearTimeout(m_paz.recordTimer);
510 // in case on_show was faster to redraw element
511 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
512 if (detRecordDiv) return;
513 m_currentRecordData = data;
514 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
515 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
516 var html = renderDetails(m_currentRecordData);
517 $(recordDiv).append(html);
521 that.targetFiltered = function(id) {
522 for (var i = 0; i < m_filters.length; i++) {
523 if (m_filters[i].id === id ||
524 m_filters[i].id === 'pz:id=' + id) {
532 ////////////////////////////////////////////////////////////////////////////////
533 ////////////////////////////////////////////////////////////////////////////////
536 // when search button pressed
537 function onFormSubmitEventHandler()
539 var val = findnode('.mkwsQuery').val();
545 function newSearch(query, sortOrder, targets)
547 debug("newSearch: " + query);
549 if (mkws_config.use_service_proxy && !mkws.authenticated) {
550 alert("searching before authentication");
558 triggerSearch(query, sortOrder, targets);
559 switchView('records'); // In case it's configured to start off as hidden
564 function onSelectDdChange()
566 if (!m_submitted) return false;
569 m_paz.show(0, m_perpage, m_sortOrder);
574 function redrawNavi ()
576 queue("navi").publish();
583 m_totalRecordCount = 0;
587 function loadSelect ()
589 var node = findnode('.mkwsSort');
590 if (node.length && node.val() != m_sortOrder) {
591 debug("changing m_sortOrder from " + m_sortOrder + " to " + node.val());
592 m_sortOrder = node.val();
594 node = findnode('.mkwsPerpage');
595 if (node.length && node.val() != m_perpage) {
596 debug("changing m_perpage from " + m_perpage + " to " + node.val());
597 m_perpage = node.val();
602 function triggerSearch (query, sortOrder, targets)
607 // Continue to use previous query/sort-order unless new ones are specified
612 m_sortOrder = sortOrder;
615 m_filters.push({ id: targets, name: targets });
618 for (var i in m_filters) {
619 var filter = m_filters[i];
623 if (filter.id.match(/^[a-z:]+[=~]/)) {
624 debug("filter '" + filter.id + "' already begins with SETTING OP");
626 filter.id = 'pz:id=' + filter.id;
628 pp2filter += filter.id;
632 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
638 params.limit = pp2limit;
641 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
643 // We can use: params.torusquery = "udb=NAME"
644 // Note: that won't work when running against raw pazpar2
645 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
649 // limit by target functions
650 that.limitTarget = function (id, name)
652 debug("limitTarget(id=" + id + ", name=" + name + ")");
653 m_filters.push({ id: id, name: name });
662 // limit the query after clicking the facet
663 that.limitQuery = function (field, value)
665 debug("limitQuery(field=" + field + ", value=" + value + ")");
666 m_filters.push({ field: field, value: value });
675 that.delimitTarget = function (id)
677 debug("delimitTarget(id=" + id + ")");
679 for (var i in m_filters) {
680 var filter = m_filters[i];
682 debug("delimitTarget() removing filter " + $.toJSON(filter));
684 debug("delimitTarget() keeping filter " + $.toJSON(filter));
685 newFilters.push(filter);
688 m_filters = newFilters;
698 that.delimitQuery = function (field, value)
700 debug("delimitQuery(field=" + field + ", value=" + value + ")");
702 for (var i in m_filters) {
703 var filter = m_filters[i];
705 field == filter.field &&
706 value == filter.value) {
707 debug("delimitQuery() removing filter " + $.toJSON(filter));
709 debug("delimitQuery() keeping filter " + $.toJSON(filter));
710 newFilters.push(filter);
713 m_filters = newFilters;
723 that.showPage = function (pageNum)
725 m_currentPage = pageNum;
726 m_paz.showPage(m_currentPage - 1);
730 // simple paging functions
731 that.pagerNext = function () {
732 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
739 that.pagerPrev = function () {
740 if (m_paz.showPrev() != false)
745 // switching view between targets and records
746 function switchView(view) {
747 var targets = findnode('.mkwsTargets');
748 var results = findnode('.mkwsResults,.mkwsRecords');
749 var blanket = findnode('.mkwsBlanket');
750 var motd = findnode('.mkwsMOTD');
754 if (targets) targets.css('display', 'block');
755 if (results) results.css('display', 'none');
756 if (blanket) blanket.css('display', 'none');
757 if (motd) motd.css('display', 'none');
760 if (targets) targets.css('display', 'none');
761 if (results) results.css('display', 'block');
762 if (blanket) blanket.css('display', 'block');
763 if (motd) motd.css('display', 'none');
766 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
767 if (targets) targets.css('display', 'none');
768 if (results) results.css('display', 'none');
769 if (blanket) blanket.css('display', 'none');
770 if (motd) motd.css('display', 'none');
773 alert("Unknown view '" + view + "'");
778 that.switchView = switchView;
781 // detailed record drawing
782 that.showDetails = function (prefixRecId) {
783 var recId = prefixRecId.replace('mkwsRec_', '');
784 var oldRecordId = m_currentRecordId;
785 m_currentRecordId = recId;
787 // remove current detailed view if any
788 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
791 detRecordDiv.parentNode.removeChild(detRecordDiv);
793 // if the same clicked, just hide
794 if (recId == oldRecordId) {
795 m_currentRecordId = '';
796 m_currentRecordData = null;
799 // request the record
800 debug("showDetails() requesting record '" + recId + "'");
806 * All the HTML stuff to render the search forms and
809 function mkwsHtmlAll() {
811 if (mkws_config.show_lang)
814 debug("HTML search form");
815 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
817 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
818 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
819 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
823 debug("HTML records");
824 // If the team has a .mkwsResults, populate it in the usual
825 // way. If not, assume that it's a smarter application that
826 // defines its own subcomponents, some or all of the
833 if (findnode(".mkwsResults").length) {
834 findnode(".mkwsResults").html('\
835 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
837 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
838 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
840 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
841 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
842 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
843 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
844 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
849 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
855 var node = findnode(".mkwsRanking");
857 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
858 if (mkws_config.show_sort) {
859 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
861 if (mkws_config.show_perpage) {
862 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
864 ranking_data += '</form>';
866 node.html(ranking_data);
872 node = findnode('.mkwsSearchForm');
874 node.submit(onFormSubmitEventHandler);
875 node = findnode('.mkwsSort');
877 node.change(onSelectDdChange);
878 node = findnode('.mkwsPerpage');
880 node.change(onSelectDdChange);
882 // on first page, hide the termlist
883 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
884 var motd = findnode(".mkwsMOTD");
885 var container = findnode(".mkwsMOTDContainer");
886 if (motd.length && container.length) {
887 // Move the MOTD from the provided element down into the container
888 motd.appendTo(container);
893 function mkwsSetLang() {
894 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
895 if (!lang || !mkws.locale_lang[lang]) {
896 mkws_config.lang = ""
898 mkws_config.lang = lang;
901 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
902 return mkws_config.lang;
906 /* create locale language menu */
907 function mkwsHtmlLang() {
908 var lang_default = "en";
909 var lang = mkws_config.lang || lang_default;
912 /* display a list of configured languages, or all */
913 var lang_options = mkws_config.lang_options || [];
914 var toBeIncluded = {};
915 for (var i = 0; i < lang_options.length; i++) {
916 toBeIncluded[lang_options[i]] = true;
919 for (var k in mkws.locale_lang) {
920 if (toBeIncluded[k] || lang_options.length == 0)
925 if (lang_options.length == 0 || toBeIncluded[lang_default])
926 list.push(lang_default);
928 debug("Language menu for: " + list.join(", "));
932 for(var i = 0; i < list.length; i++) {
939 data += ' <span>' + l + '</span> ';
941 data += ' <a href="?lang=' + l + '">' + l + '</a> '
945 findnode(".mkwsLang").html(data);
949 function mkwsHtmlSort() {
950 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
951 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
953 for(var i = 0; i < mkws_config.sort_options.length; i++) {
954 var opt = mkws_config.sort_options[i];
956 var val = opt.length == 1 ? opt[0] : opt[1];
958 sort_html += '<option value="' + key + '"';
959 if (m_sortOrder == key || m_sortOrder == val) {
960 sort_html += ' selected="selected"';
962 sort_html += '>' + M(val) + '</option>';
964 sort_html += '</select>';
970 function mkwsHtmlPerpage() {
971 debug("HTML perpage, m_perpage = " + m_perpage);
972 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
974 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
975 var key = mkws_config.perpage_options[i];
977 perpage_html += '<option value="' + key + '"';
978 if (key == m_perpage) {
979 perpage_html += ' selected="selected"';
981 perpage_html += '>' + key + '</option>';
983 perpage_html += '</select>';
989 function mkwsHtmlSwitch() {
990 debug("HTML switch for team " + m_teamName);
992 var node = findnode(".mkwsSwitch");
993 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
994 node.append($("<span/>", { text: " | " }));
995 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
997 debug("HTML targets");
998 var node = findnode(".mkwsTargets");
1000 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1001 No information available yet.\
1003 node.css("display", "none");
1007 that.runAutoSearch = function() {
1008 var node = findnode('.mkwsRecords,.mkwsTermlists');
1009 var query = node.attr('autosearch');
1013 if (query.match(/^!param!/)) {
1014 var param = query.replace(/^!param!/, '');
1015 query = mkws.getParameterByName(param);
1016 debug("obtained query '" + query + "' from param '" + param + "'");
1018 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1020 } else if (query.match(/^!path!/)) {
1021 var index = query.replace(/^!path!/, '');
1022 var path = window.location.pathname.split('/');
1023 query = path[path.length - index];
1024 debug("obtained query '" + query + "' from path-component '" + index + "'");
1026 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1030 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1032 var sortOrder = node.attr('sort');
1033 var targets = node.attr('targets');
1034 var s = "running auto search: '" + query + "'";
1035 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1036 if (targets) s += " in targets '" + targets + "'";
1039 newSearch(query, sortOrder, targets);
1043 // Translation function. At present, this is properly a
1044 // global-level function (hence the assignment to mkws.M) but we
1045 // want to make it per-team so different teams can operate in
1046 // different languages.
1049 var lang = mkws_config.lang;
1051 if (!lang || !mkws.locale_lang[lang])
1054 return mkws.locale_lang[lang][word] || word;
1056 mkws.M = M; // so the Handlebars helper can use it
1059 // Finds the node of the specified class within the current team
1060 // Multiple OR-clauses separated by commas are handled
1061 // More complex cases may not work
1063 function findnode(selector, teamName) {
1064 teamName = teamName || m_teamName;
1066 selector = $.map(selector.split(','), function(s, i) {
1067 return s + '.mkwsTeam_' + teamName;
1074 function renderDetails(data, marker)
1076 var template = loadTemplate("Record");
1077 var details = template(data);
1078 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1080 that.renderDetails = renderDetails;
1083 function loadTemplate(name)
1085 var template = m_template[name];
1087 if (template === undefined) {
1088 // Fall back to generic template if there is no team-specific one
1089 var node = findnode(".mkwsTemplate_" + name);
1091 node = findnode(".mkwsTemplate_" + name, "ALL");
1094 var source = node.html();
1096 source = mkws.defaultTemplate(name);
1099 template = Handlebars.compile(source);
1100 debug("compiled template '" + name + "'");
1101 m_template[name] = template;
1106 that.loadTemplate = loadTemplate;
1109 // The following PubSub code is modified from the jQuery manual:
1110 // https://api.jquery.com/jQuery.Callbacks/
1113 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1114 // team.queue("eventName").publish(arg1, arg2, ...);
1117 var queue = function(id) {
1119 var callbacks = $.Callbacks();
1121 publish: callbacks.fire,
1122 subscribe: callbacks.add,
1123 unsubscribe: callbacks.remove
1139 mkws_config.error = e.message;
1140 // alert(e.message);
1144 // Bizarrely, 'that' is just an empty hash. All its state is in
1145 // the closure variables defined earlier in this function.
1150 // wrapper to call team() after page load
1152 mkws.debug = function (string) {
1153 if (!mkws.debug_level)
1156 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1160 // you need to disable use strict at the top of the file!!!
1161 if (mkws.debug_level >= 3) {
1162 console.log(arguments.callee.caller);
1163 } else if (mkws.debug_level >= 2) {
1164 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1166 console.log(string);
1168 var debug = mkws.debug;
1171 mkws.handleNodeWithTeam = function(node, callback) {
1172 // First branch for DOM objects; second branch for jQuery objects
1173 var classes = node.className || node.attr('class');
1175 // For some reason, if we try to proceed when classes is
1176 // undefined, we don't get an error message, but this
1177 // function and its callers, up several stack level,
1178 // silently return. What a crock.
1179 mkws.debug("handleNodeWithTeam() called on node with no classes");
1182 var list = classes.split(/\s+/)
1185 for (var i = 0; i < list.length; i++) {
1186 var cname = list[i];
1187 if (cname.match(/^mkwsTeam_/)) {
1188 teamName = cname.replace(/^mkwsTeam_/, '');
1189 } else if (cname.match(/^mkws/)) {
1190 type = cname.replace(/^mkws/, '');
1193 callback.call(node, teamName, type);
1197 mkws.resizePage = function () {
1198 var list = ["mkwsSwitch", "mkwsLang"];
1200 var width = mkws_config.responsive_design_width;
1201 var parent = $(".mkwsTermlists").parent();
1203 if ($(window).width() <= width &&
1204 parent.hasClass("mkwsTermlistContainer1")) {
1205 debug("changing from wide to narrow: " + $(window).width());
1206 $(".mkwsTermlistContainer1").hide();
1207 $(".mkwsTermlistContainer2").show();
1208 for (var tname in mkws.teams) {
1209 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1210 for(var i = 0; i < list.length; i++) {
1211 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1214 } else if ($(window).width() > width &&
1215 parent.hasClass("mkwsTermlistContainer2")) {
1216 debug("changing from narrow to wide: " + $(window).width());
1217 $(".mkwsTermlistContainer1").show();
1218 $(".mkwsTermlistContainer2").hide();
1219 for (var tname in mkws.teams) {
1220 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1221 for(var i = 0; i < list.length; i++) {
1222 $("." + list[i] + ".mkwsTeam_" + tname).show();
1229 mkws.switchView = function(tname, view) {
1230 mkws.teams[tname].switchView(view);
1233 mkws.showDetails = function (tname, prefixRecId) {
1234 mkws.teams[tname].showDetails(prefixRecId);
1237 mkws.limitTarget = function (tname, id, name) {
1238 mkws.teams[tname].limitTarget(id, name);
1241 mkws.limitQuery = function (tname, field, value) {
1242 mkws.teams[tname].limitQuery(field, value);
1245 mkws.delimitTarget = function (tname, id) {
1246 mkws.teams[tname].delimitTarget(id);
1249 mkws.delimitQuery = function (tname, field, value) {
1250 mkws.teams[tname].delimitQuery(field, value);
1253 mkws.showPage = function (tname, pageNum) {
1254 mkws.teams[tname].showPage(pageNum);
1257 mkws.pagerPrev = function (tname) {
1258 mkws.teams[tname].pagerPrev();
1261 mkws.pagerNext = function (tname) {
1262 mkws.teams[tname].pagerNext();
1266 // This function is taken from a StackOverflow answer
1267 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1268 mkws.getParameterByName = function(name) {
1269 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1270 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1271 results = regex.exec(location.search);
1272 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1276 mkws.defaultTemplate = function(name)
1278 if (name === 'Record') {
1282 <th>{{translate "Title"}}</th>\
1285 {{#if md-title-remainder}}\
1286 ({{md-title-remainder}})\
1288 {{#if md-title-responsibility}}\
1289 <i>{{md-title-responsibility}}</i>\
1295 <th>{{translate "Date"}}</th>\
1296 <td>{{md-date}}</td>\
1301 <th>{{translate "Author"}}</th>\
1302 <td>{{md-author}}</td>\
1305 {{#if md-electronic-url}}\
1307 <th>{{translate "Links"}}</th>\
1309 {{#each md-electronic-url}}\
1310 <a href="{{this}}">Link{{index1}}</a>\
1315 {{#if-any location having="md-subject"}}\
1317 <th>{{translate "Subject"}}</th>\
1319 {{#first location having="md-subject"}}\
1321 {{#commaList md-subject}}\
1322 {{this}}{{/commaList}}\
1329 <th>{{translate "Locations"}}</th>\
1331 {{#commaList location}}\
1332 {{attr "@name"}}{{/commaList}}\
1337 } else if (name === "Summary") {
1339 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1340 <b>{{md-title}}</b>\
1342 {{#if md-title-remainder}}\
1343 <span>{{md-title-remainder}}</span>\
1345 {{#if md-title-responsibility}}\
1346 <span><i>{{md-title-responsibility}}</i></span>\
1351 var s = "There is no default '" + name +"' template!";
1357 function defaultMkwsConfig() {
1358 /* default mkws config */
1359 var config_default = {
1360 use_service_proxy: true,
1361 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1362 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1364 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1365 perpage_options: [10, 20, 30, 50],
1366 sort_default: "relevance",
1367 perpage_default: 20,
1369 show_lang: true, /* show/hide language menu */
1370 show_sort: true, /* show/hide sort menu */
1371 show_perpage: true, /* show/hide perpage menu */
1372 lang_options: [], /* display languages links for given languages, [] for all */
1373 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1374 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1375 debug_level: 1, /* debug level for development: 0..2 */
1380 /* Set global debug_level flag early so that debug() works */
1381 if (typeof mkws_config.debug_level !== 'undefined') {
1382 mkws.debug_level = mkws_config.debug_level;
1383 } else if (typeof config_default.debug_level !== 'undefined') {
1384 mkws.debug_level = config_default.debug_level;
1387 // make sure the mkws_config is a valid hash
1388 if (!$.isPlainObject(mkws_config)) {
1389 debug("ERROR: mkws_config is not an JS object, ignore it....");
1393 /* override standard config values by function parameters */
1394 for (var k in config_default) {
1395 if (typeof mkws_config[k] === 'undefined')
1396 mkws_config[k] = config_default[k];
1397 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1403 * Run service-proxy authentication in background (after page load).
1404 * The username/password is configured in the apache config file
1407 function authenticateSession(auth_url, auth_domain, pp2_url) {
1408 debug("Run service proxy auth URL: " + auth_url);
1411 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1412 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1415 var request = new pzHttpRequest(auth_url, function(err) {
1416 alert("HTTP call for authentication failed: " + err)
1420 request.get(null, function(data) {
1421 if (!$.isXMLDoc(data)) {
1422 alert("service proxy auth response document is not valid XML document, give up!");
1425 var status = $(data).find("status");
1426 if (status.text() != "OK") {
1427 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1431 debug("Service proxy auth successfully done");
1432 mkws.authenticated = true;
1438 function runAutoSearches() {
1439 debug("running auto searches");
1441 for (var teamName in mkws.teams) {
1442 mkws.teams[teamName].runAutoSearch();
1447 $(document).ready(function() {
1448 debug("on load ready");
1449 defaultMkwsConfig();
1451 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1452 debug("Reset query width: " + mkws_config.query_width);
1453 mkws_config.query_width = 50;
1456 for (var key in mkws_config) {
1457 if (mkws_config.hasOwnProperty(key)) {
1458 if (key.match(/^language_/)) {
1459 var lang = key.replace(/^language_/, "");
1460 // Copy custom languages into list
1461 mkws.locale_lang[lang] = mkws_config[key];
1462 debug("Added locally configured language '" + lang + "'");
1467 if (mkws_config.responsive_design_width) {
1468 // Responsive web design - change layout on the fly based on
1469 // current screen width. Required for mobile devices.
1470 $(window).resize(function(e) { mkws.resizePage() });
1471 // initial check after page load
1472 $(document).ready(function() { mkws.resizePage() });
1475 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1476 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1477 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1478 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1481 // Backwards compatibility: set new magic class names on any
1482 // elements that have the old magic IDs.
1483 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1484 "Results", "Records", "Targets", "Ranking",
1485 "Termlists", "Stat", "MOTD" ];
1486 for (var i = 0; i < ids.length; i++) {
1487 var id = 'mkws' + ids[i];
1488 var node = $('#' + id);
1489 if (node.attr('id')) {
1491 debug("added magic class to '" + node.attr('id') + "'");
1495 // For all MKWS-classed nodes that don't have a team
1496 // specified, set the team to AUTO.
1497 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1498 if (!this.className.match(/mkwsTeam_/)) {
1499 debug("adding AUTO team to node with class '" + this.className + "'");
1500 $(this).addClass('mkwsTeam_AUTO');
1504 // Find all nodes with an MKWS class, and determine their team from
1505 // the mkwsTeam_* class. Make all team objects.
1507 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1508 mkws.handleNodeWithTeam(this, function(tname, type) {
1509 if (!mkws.teams[tname]) {
1510 mkws.teams[tname] = team(j, tname);
1511 debug("Made MKWS team '" + tname + "'");
1515 // Second pass: make the individual widget objects. This has
1516 // to be done separately, and after the team-creation, since
1517 // that sometimes makes new widget nodes (e.g. creating
1518 // mkwsTermlists inside mkwsResults.
1519 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1520 mkws.handleNodeWithTeam(this, function(tname, type) {
1521 var myTeam = mkws.teams[tname];
1522 var myWidget = widget(j, myTeam, type, this);
1526 debug("Walking MKWS nodes took " + (now-then) + " ms");
1528 if (mkws_config.use_service_proxy) {
1529 authenticateSession(mkws_config.service_proxy_auth,
1530 mkws_config.service_proxy_auth_domain,
1531 mkws_config.pazpar2_url);