1 /*! MKWS, the MasterKey Widget Set.
2 * Copyright (C) 2013-2014 Index Data
3 * See the file LICENSE for details
6 "use strict"; // HTML5: disable for log_level >= 2
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 log_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,
169 Perpage: promotePerpage
172 var promote = type2fn[type];
175 log("made " + type + " widget(node=" + node + ")");
177 log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
187 // Functions follow for promoting the regular widget object into
188 // widgets of specific types. These could be moved outside of the
189 // widget object, or even into their own source files.
191 function promoteTargets() {
192 team.queue("targets").subscribe(function(data) {
193 var table ='<table><thead><tr>' +
194 '<td>' + M('Target ID') + '</td>' +
195 '<td>' + M('Hits') + '</td>' +
196 '<td>' + M('Diags') + '</td>' +
197 '<td>' + M('Records') + '</td>' +
198 '<td>' + M('State') + '</td>' +
199 '</tr></thead><tbody>';
201 for (var i = 0; i < data.length; i++) {
202 table += "<tr><td>" + data[i].id +
203 "</td><td>" + data[i].hits +
204 "</td><td>" + data[i].diagnostic +
205 "</td><td>" + data[i].records +
206 "</td><td>" + data[i].state + "</td></tr>";
209 table += '</tbody></table>';
210 var subnode = $(node).children('.mkwsBytarget');
216 function promoteStat() {
217 team.queue("stat").subscribe(function(data) {
218 if (node.length === 0) alert("huh?!");
220 $(node).html('<span class="head">' + M('Status info') + '</span>' +
222 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
224 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
229 function promoteTermlists() {
230 team.queue("termlists").subscribe(function(data) {
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 var divId = team.recordElementId(hit.recid[0]);
356 html.push('<div class="record mkwsTeam_' + team.name() + ' ' + divId + '">', renderSummary(hit), '</div>');
357 // ### At some point, we may be able to move the
358 // m_currentRecordId and m_currentRecordData members
359 // from the team object into this widget.
360 if (hit.recid == team.currentRecordId()) {
361 if (team.currentRecordData())
362 html.push(team.renderDetails(team.currentRecordData()));
365 $(node).html(html.join(''));
367 function renderSummary(hit)
369 var template = team.loadTemplate("Summary");
370 hit._id = team.recordElementId(hit.recid[0]);
371 hit._onclick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;"
372 return template(hit);
378 function promoteNavi() {
379 team.queue("navi").subscribe(function() {
380 var filters = team.filters();
383 for (var i in filters) {
387 var filter = filters[i];
389 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
390 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
392 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
393 "', '" + filter.field + "', '" + filter.value + "'" +
394 ');return false;">' + filter.value + '</a>';
403 function promoteSort() {
404 // It seems this and the Perpage widget doen't need to
405 // subscribe to anything, since they produce events rather
406 // than consuming them.
407 $(node).change(function () {
408 team.set_sortOrder($(node).val());
409 if (team.submitted()) {
418 function promotePerpage() {
419 $(node).change(function() {
420 team.set_perpage($(node).val());
421 if (team.submitted()) {
431 // Factory function for team objects. As much as possible, this uses
432 // only member variables (prefixed "m_") and inner functions with
433 // private scope. Some functions are visibl as member-functions to be
434 // called from outside code -- specifically, from generated
435 // HTML. These functions are that.switchView(), showDetails(),
436 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
437 // pagerPrev(), pagerNext(), showPage().
439 function team($, teamName) {
441 var m_teamName = teamName;
442 var m_submitted = false;
443 var m_query; // initially undefined
444 var m_sortOrder; // will be set below
445 var m_perpage; // will be set below
447 var m_totalRecordCount = 0;
448 var m_currentPage = 1;
449 var m_currentRecordId = '';
450 var m_currentRecordData = null;
452 // Timestamps for logging
456 var m_paz; // will be initialised below
459 that.name = function() { return m_teamName; }
460 that.submitted = function() { return m_submitted; }
461 that.perpage = function() { return m_perpage; }
462 that.totalRecordCount = function() { return m_totalRecordCount; }
463 that.currentPage = function() { return m_currentPage; }
464 that.currentRecordId = function() { return m_currentRecordId; }
465 that.currentRecordData = function() { return m_currentRecordData; }
466 that.filters = function() { return m_filters; }
468 that.set_sortOrder = function(val) { m_sortOrder = val };
469 that.set_perpage = function(val) { m_perpage = val };
472 var log = function (s) {
474 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
475 m_logTime.last = now;
477 mkws.log(m_teamName + ": " + timestamp + s);
481 log("start running MKWS");
483 m_sortOrder = mkws_config.sort_default;
484 m_perpage = mkws_config.perpage_default;
486 log("Create main pz2 object");
487 // create a parameters array and pass it to the pz2's constructor
488 // then register the form submit event with the pz2.search function
489 // autoInit is set to true on default
490 m_paz = new pz2({ "windowid": teamName,
491 "pazpar2path": mkws_config.pazpar2_url,
492 "usesessions" : mkws_config.use_service_proxy ? false : true,
494 "onbytarget": onBytarget,
496 "onterm": (mkws_config.facets.length ? onTerm : undefined),
498 "onrecord": onRecord,
499 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
500 "termlist": mkws_config.facets.join(',')
505 // pz2.js event handlers:
514 function onBytarget(data) {
516 queue("targets").publish(data);
520 function onStat(data) {
522 queue("stat").publish(data);
526 function onTerm(data) {
528 queue("termlists").publish(data);
532 function onShow(data, teamName) {
534 m_totalRecordCount = data.merged;
535 queue("pager").publish(data);
536 queue("records").publish(data);
540 function onRecord(data, args, teamName) {
542 // FIXME: record is async!!
543 clearTimeout(m_paz.recordTimer);
544 // ##### restrict to current team
545 var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
547 // in case on_show was faster to redraw element
550 m_currentRecordData = data;
551 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
552 var html = renderDetails(m_currentRecordData);
553 $(recordDiv).append(html);
557 // Used by promoteRecords() and onRecord()
558 function recordElementId(s) {
559 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
561 that.recordElementId = recordElementId;
563 // Used by onRecord(), showDetails() and renderDetails()
564 function recordDetailsId(s) {
565 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
567 that.recordElementId = recordElementId;
570 that.targetFiltered = function(id) {
571 for (var i = 0; i < m_filters.length; i++) {
572 if (m_filters[i].id === id ||
573 m_filters[i].id === 'pz:id=' + id) {
581 ////////////////////////////////////////////////////////////////////////////////
582 ////////////////////////////////////////////////////////////////////////////////
585 // when search button pressed
586 function onFormSubmitEventHandler()
588 var val = findnode('.mkwsQuery').val();
594 function newSearch(query, sortOrder, targets)
596 log("newSearch: " + query);
598 if (mkws_config.use_service_proxy && !mkws.authenticated) {
599 alert("searching before authentication");
604 triggerSearch(query, sortOrder, targets);
605 switchView('records'); // In case it's configured to start off as hidden
610 // limit by target functions
611 that.limitTarget = function (id, name)
613 log("limitTarget(id=" + id + ", name=" + name + ")");
614 m_filters.push({ id: id, name: name });
620 // limit the query after clicking the facet
621 that.limitQuery = function (field, value)
623 log("limitQuery(field=" + field + ", value=" + value + ")");
624 m_filters.push({ field: field, value: value });
630 that.delimitTarget = function (id)
632 log("delimitTarget(id=" + id + ")");
634 for (var i in m_filters) {
635 var filter = m_filters[i];
637 log("delimitTarget() removing filter " + $.toJSON(filter));
639 log("delimitTarget() keeping filter " + $.toJSON(filter));
640 newFilters.push(filter);
643 m_filters = newFilters;
650 that.delimitQuery = function (field, value)
652 log("delimitQuery(field=" + field + ", value=" + value + ")");
654 for (var i in m_filters) {
655 var filter = m_filters[i];
657 field == filter.field &&
658 value == filter.value) {
659 log("delimitQuery() removing filter " + $.toJSON(filter));
661 log("delimitQuery() keeping filter " + $.toJSON(filter));
662 newFilters.push(filter);
665 m_filters = newFilters;
675 m_totalRecordCount = 0;
677 that.resetPage = resetPage;
680 function triggerSearch (query, sortOrder, targets)
683 queue("navi").publish();
688 // Continue to use previous query/sort-order unless new ones are specified
693 m_sortOrder = sortOrder;
696 m_filters.push({ id: targets, name: targets });
699 for (var i in m_filters) {
700 var filter = m_filters[i];
704 if (filter.id.match(/^[a-z:]+[=~]/)) {
705 log("filter '" + filter.id + "' already begins with SETTING OP");
707 filter.id = 'pz:id=' + filter.id;
709 pp2filter += filter.id;
713 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
719 params.limit = pp2limit;
722 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
724 // We can use: params.torusquery = "udb=NAME"
725 // Note: that won't work when running against raw pazpar2
726 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
730 that.reShow = function() {
731 m_paz.show(0, m_perpage, m_sortOrder);
736 that.showPage = function (pageNum)
738 m_currentPage = pageNum;
739 m_paz.showPage(m_currentPage - 1);
743 // simple paging functions
744 that.pagerNext = function () {
745 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
752 that.pagerPrev = function () {
753 if (m_paz.showPrev() != false)
758 // switching view between targets and records
759 function switchView(view) {
760 var targets = findnode('.mkwsTargets');
761 var results = findnode('.mkwsResults,.mkwsRecords');
762 var blanket = findnode('.mkwsBlanket');
763 var motd = findnode('.mkwsMOTD');
767 if (targets) targets.css('display', 'block');
768 if (results) results.css('display', 'none');
769 if (blanket) blanket.css('display', 'none');
770 if (motd) motd.css('display', 'none');
773 if (targets) targets.css('display', 'none');
774 if (results) results.css('display', 'block');
775 if (blanket) blanket.css('display', 'block');
776 if (motd) motd.css('display', 'none');
779 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
780 if (targets) targets.css('display', 'none');
781 if (results) results.css('display', 'none');
782 if (blanket) blanket.css('display', 'none');
783 if (motd) motd.css('display', 'none');
786 alert("Unknown view '" + view + "'");
789 that.switchView = switchView;
792 // detailed record drawing
793 that.showDetails = function (recId) {
794 var oldRecordId = m_currentRecordId;
795 m_currentRecordId = recId;
797 // remove current detailed view if any
798 // ##### restrict to current team
799 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
802 detRecordDiv.parentNode.removeChild(detRecordDiv);
804 // if the same clicked, just hide
805 if (recId == oldRecordId) {
806 m_currentRecordId = '';
807 m_currentRecordData = null;
810 // request the record
811 log("showDetails() requesting record '" + recId + "'");
817 * All the HTML stuff to render the search forms and
820 function mkwsHtmlAll() {
822 if (mkws_config.show_lang)
825 log("HTML search form");
826 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
828 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
829 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
830 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
835 // If the team has a .mkwsResults, populate it in the usual
836 // way. If not, assume that it's a smarter application that
837 // defines its own subcomponents, some or all of the
844 findnode(".mkwsResults").html('\
845 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
847 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
848 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
850 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
851 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
852 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
853 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
854 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
859 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
864 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
865 if (mkws_config.show_sort) {
866 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
868 if (mkws_config.show_perpage) {
869 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
871 ranking_data += '</form>';
872 findnode(".mkwsRanking").html(ranking_data);
876 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
878 // on first page, hide the termlist
879 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
880 var container = findnode(".mkwsMOTDContainer");
881 if (container.length) {
882 // Move the MOTD from the provided element down into the container
883 findnode(".mkwsMOTD").appendTo(container);
888 function mkwsSetLang() {
889 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
890 if (!lang || !mkws.locale_lang[lang]) {
891 mkws_config.lang = ""
893 mkws_config.lang = lang;
896 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
897 return mkws_config.lang;
901 /* create locale language menu */
902 function mkwsHtmlLang() {
903 var lang_default = "en";
904 var lang = mkws_config.lang || lang_default;
907 /* display a list of configured languages, or all */
908 var lang_options = mkws_config.lang_options || [];
909 var toBeIncluded = {};
910 for (var i = 0; i < lang_options.length; i++) {
911 toBeIncluded[lang_options[i]] = true;
914 for (var k in mkws.locale_lang) {
915 if (toBeIncluded[k] || lang_options.length == 0)
920 if (lang_options.length == 0 || toBeIncluded[lang_default])
921 list.push(lang_default);
923 log("Language menu for: " + list.join(", "));
927 for(var i = 0; i < list.length; i++) {
934 data += ' <span>' + l + '</span> ';
936 data += ' <a href="?lang=' + l + '">' + l + '</a> '
940 findnode(".mkwsLang").html(data);
944 function mkwsHtmlSort() {
945 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
946 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
948 for(var i = 0; i < mkws_config.sort_options.length; i++) {
949 var opt = mkws_config.sort_options[i];
951 var val = opt.length == 1 ? opt[0] : opt[1];
953 sort_html += '<option value="' + key + '"';
954 if (m_sortOrder == key || m_sortOrder == val) {
955 sort_html += ' selected="selected"';
957 sort_html += '>' + M(val) + '</option>';
959 sort_html += '</select>';
965 function mkwsHtmlPerpage() {
966 log("HTML perpage, m_perpage = " + m_perpage);
967 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
969 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
970 var key = mkws_config.perpage_options[i];
972 perpage_html += '<option value="' + key + '"';
973 if (key == m_perpage) {
974 perpage_html += ' selected="selected"';
976 perpage_html += '>' + key + '</option>';
978 perpage_html += '</select>';
984 function mkwsHtmlSwitch() {
985 log("HTML switch for team " + m_teamName);
987 var node = findnode(".mkwsSwitch");
988 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
989 node.append($("<span/>", { text: " | " }));
990 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
993 var node = findnode(".mkwsTargets");
995 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
996 No information available yet.\
998 node.css("display", "none");
1002 that.runAutoSearch = function() {
1003 var node = findnode('.mkwsRecords,.mkwsTermlists');
1004 var query = node.attr('autosearch');
1008 if (query.match(/^!param!/)) {
1009 var param = query.replace(/^!param!/, '');
1010 query = mkws.getParameterByName(param);
1011 log("obtained query '" + query + "' from param '" + param + "'");
1013 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1015 } else if (query.match(/^!path!/)) {
1016 var index = query.replace(/^!path!/, '');
1017 var path = window.location.pathname.split('/');
1018 query = path[path.length - index];
1019 log("obtained query '" + query + "' from path-component '" + index + "'");
1021 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1025 log("node=" + node + ", class='" + node.className + "', query=" + query);
1027 var sortOrder = node.attr('sort');
1028 var targets = node.attr('targets');
1029 var s = "running auto search: '" + query + "'";
1030 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1031 if (targets) s += " in targets '" + targets + "'";
1034 newSearch(query, sortOrder, targets);
1038 // Translation function. At present, this is properly a
1039 // global-level function (hence the assignment to mkws.M) but we
1040 // want to make it per-team so different teams can operate in
1041 // different languages.
1044 var lang = mkws_config.lang;
1046 if (!lang || !mkws.locale_lang[lang])
1049 return mkws.locale_lang[lang][word] || word;
1051 mkws.M = M; // so the Handlebars helper can use it
1054 // Finds the node of the specified class within the current team
1055 // Multiple OR-clauses separated by commas are handled
1056 // More complex cases may not work
1058 function findnode(selector, teamName) {
1059 teamName = teamName || m_teamName;
1061 selector = $.map(selector.split(','), function(s, i) {
1062 return s + '.mkwsTeam_' + teamName;
1069 function renderDetails(data, marker)
1071 var template = loadTemplate("Record");
1072 var details = template(data);
1073 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
1075 that.renderDetails = renderDetails;
1078 function loadTemplate(name)
1080 var template = m_template[name];
1082 if (template === undefined) {
1083 // Fall back to generic template if there is no team-specific one
1084 var node = findnode(".mkwsTemplate_" + name);
1086 node = findnode(".mkwsTemplate_" + name, "ALL");
1089 var source = node.html();
1091 source = mkws.defaultTemplate(name);
1094 template = Handlebars.compile(source);
1095 log("compiled template '" + name + "'");
1096 m_template[name] = template;
1101 that.loadTemplate = loadTemplate;
1104 // The following PubSub code is modified from the jQuery manual:
1105 // https://api.jquery.com/jQuery.Callbacks/
1108 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1109 // team.queue("eventName").publish(arg1, arg2, ...);
1112 var queue = function(id) {
1114 var callbacks = $.Callbacks();
1116 publish: callbacks.fire,
1117 subscribe: callbacks.add,
1118 unsubscribe: callbacks.remove
1133 mkws_config.error = e.message;
1134 // alert(e.message);
1138 // Bizarrely, 'that' is just an empty hash. All its state is in
1139 // the closure variables defined earlier in this function.
1144 // wrapper to call team() after page load
1146 mkws.log = function (string) {
1147 if (!mkws.log_level)
1150 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1154 // you need to disable use strict at the top of the file!!!
1155 if (mkws.log_level >= 3) {
1156 console.log(arguments.callee.caller);
1157 } else if (mkws.log_level >= 2) {
1158 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1160 console.log(string);
1165 mkws.handleNodeWithTeam = function(node, callback) {
1166 // First branch for DOM objects; second branch for jQuery objects
1167 var classes = node.className || node.attr('class');
1169 // For some reason, if we try to proceed when classes is
1170 // undefined, we don't get an error message, but this
1171 // function and its callers, up several stack level,
1172 // silently return. What a crock.
1173 mkws.log("handleNodeWithTeam() called on node with no classes");
1176 var list = classes.split(/\s+/)
1179 for (var i = 0; i < list.length; i++) {
1180 var cname = list[i];
1181 if (cname.match(/^mkwsTeam_/)) {
1182 teamName = cname.replace(/^mkwsTeam_/, '');
1183 } else if (cname.match(/^mkws/)) {
1184 type = cname.replace(/^mkws/, '');
1187 callback.call(node, teamName, type);
1191 mkws.resizePage = function () {
1192 var list = ["mkwsSwitch", "mkwsLang"];
1194 var width = mkws_config.responsive_design_width;
1195 var parent = $(".mkwsTermlists").parent();
1197 if ($(window).width() <= width &&
1198 parent.hasClass("mkwsTermlistContainer1")) {
1199 log("changing from wide to narrow: " + $(window).width());
1200 $(".mkwsTermlistContainer1").hide();
1201 $(".mkwsTermlistContainer2").show();
1202 for (var tname in mkws.teams) {
1203 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1204 for(var i = 0; i < list.length; i++) {
1205 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1208 } else if ($(window).width() > width &&
1209 parent.hasClass("mkwsTermlistContainer2")) {
1210 log("changing from narrow to wide: " + $(window).width());
1211 $(".mkwsTermlistContainer1").show();
1212 $(".mkwsTermlistContainer2").hide();
1213 for (var tname in mkws.teams) {
1214 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1215 for(var i = 0; i < list.length; i++) {
1216 $("." + list[i] + ".mkwsTeam_" + tname).show();
1223 mkws.switchView = function(tname, view) {
1224 mkws.teams[tname].switchView(view);
1227 mkws.showDetails = function (tname, prefixRecId) {
1228 mkws.teams[tname].showDetails(prefixRecId);
1231 mkws.limitTarget = function (tname, id, name) {
1232 mkws.teams[tname].limitTarget(id, name);
1235 mkws.limitQuery = function (tname, field, value) {
1236 mkws.teams[tname].limitQuery(field, value);
1239 mkws.delimitTarget = function (tname, id) {
1240 mkws.teams[tname].delimitTarget(id);
1243 mkws.delimitQuery = function (tname, field, value) {
1244 mkws.teams[tname].delimitQuery(field, value);
1247 mkws.showPage = function (tname, pageNum) {
1248 mkws.teams[tname].showPage(pageNum);
1251 mkws.pagerPrev = function (tname) {
1252 mkws.teams[tname].pagerPrev();
1255 mkws.pagerNext = function (tname) {
1256 mkws.teams[tname].pagerNext();
1260 // This function is taken from a StackOverflow answer
1261 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1262 mkws.getParameterByName = function(name) {
1263 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1264 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1265 results = regex.exec(location.search);
1266 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1270 mkws.defaultTemplate = function(name)
1272 if (name === 'Record') {
1276 <th>{{translate "Title"}}</th>\
1279 {{#if md-title-remainder}}\
1280 ({{md-title-remainder}})\
1282 {{#if md-title-responsibility}}\
1283 <i>{{md-title-responsibility}}</i>\
1289 <th>{{translate "Date"}}</th>\
1290 <td>{{md-date}}</td>\
1295 <th>{{translate "Author"}}</th>\
1296 <td>{{md-author}}</td>\
1299 {{#if md-electronic-url}}\
1301 <th>{{translate "Links"}}</th>\
1303 {{#each md-electronic-url}}\
1304 <a href="{{this}}">Link{{index1}}</a>\
1309 {{#if-any location having="md-subject"}}\
1311 <th>{{translate "Subject"}}</th>\
1313 {{#first location having="md-subject"}}\
1315 {{#commaList md-subject}}\
1316 {{this}}{{/commaList}}\
1323 <th>{{translate "Locations"}}</th>\
1325 {{#commaList location}}\
1326 {{attr "@name"}}{{/commaList}}\
1331 } else if (name === "Summary") {
1333 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1334 <b>{{md-title}}</b>\
1336 {{#if md-title-remainder}}\
1337 <span>{{md-title-remainder}}</span>\
1339 {{#if md-title-responsibility}}\
1340 <span><i>{{md-title-responsibility}}</i></span>\
1345 var s = "There is no default '" + name +"' template!";
1351 function defaultMkwsConfig() {
1352 /* default mkws config */
1353 var config_default = {
1354 use_service_proxy: true,
1355 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1356 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1358 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1359 perpage_options: [10, 20, 30, 50],
1360 sort_default: "relevance",
1361 perpage_default: 20,
1363 show_lang: true, /* show/hide language menu */
1364 show_sort: true, /* show/hide sort menu */
1365 show_perpage: true, /* show/hide perpage menu */
1366 lang_options: [], /* display languages links for given languages, [] for all */
1367 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1368 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1369 log_level: 1, /* log level for development: 0..2 */
1374 // Set global log_level flag early so that log() works
1375 // Fall back to old "debug_level" setting for backwards compatibility
1376 var tmp = mkws_config.log_level;
1377 if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
1379 if (typeof(tmp) !== 'undefined') {
1380 mkws.log_level = tmp;
1381 } else if (typeof(config_default.log_level) !== 'undefined') {
1382 mkws.log_level = config_default.log_level;
1385 // make sure the mkws_config is a valid hash
1386 if (!$.isPlainObject(mkws_config)) {
1387 log("ERROR: mkws_config is not an JS object, ignore it....");
1391 /* override standard config values by function parameters */
1392 for (var k in config_default) {
1393 if (typeof mkws_config[k] === 'undefined')
1394 mkws_config[k] = config_default[k];
1395 //log("Set config: " + k + ' => ' + mkws_config[k]);
1401 * Run service-proxy authentication in background (after page load).
1402 * The username/password is configured in the apache config file
1405 function authenticateSession(auth_url, auth_domain, pp2_url) {
1406 log("Run service proxy auth URL: " + auth_url);
1409 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1410 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1413 var request = new pzHttpRequest(auth_url, function(err) {
1414 alert("HTTP call for authentication failed: " + err)
1418 request.get(null, function(data) {
1419 if (!$.isXMLDoc(data)) {
1420 alert("service proxy auth response document is not valid XML document, give up!");
1423 var status = $(data).find("status");
1424 if (status.text() != "OK") {
1425 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1429 log("Service proxy auth successfully done");
1430 mkws.authenticated = true;
1436 function runAutoSearches() {
1437 log("running auto searches");
1439 for (var teamName in mkws.teams) {
1440 mkws.teams[teamName].runAutoSearch();
1445 $(document).ready(function() {
1446 log("on load ready");
1447 defaultMkwsConfig();
1449 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1450 log("Reset query width: " + mkws_config.query_width);
1451 mkws_config.query_width = 50;
1454 for (var key in mkws_config) {
1455 if (mkws_config.hasOwnProperty(key)) {
1456 if (key.match(/^language_/)) {
1457 var lang = key.replace(/^language_/, "");
1458 // Copy custom languages into list
1459 mkws.locale_lang[lang] = mkws_config[key];
1460 log("Added locally configured language '" + lang + "'");
1465 if (mkws_config.responsive_design_width) {
1466 // Responsive web design - change layout on the fly based on
1467 // current screen width. Required for mobile devices.
1468 $(window).resize(function(e) { mkws.resizePage() });
1469 // initial check after page load
1470 $(document).ready(function() { mkws.resizePage() });
1473 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1474 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1475 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1476 log("adjust protocol independent links: " + mkws_config.pazpar2_url);
1479 // Backwards compatibility: set new magic class names on any
1480 // elements that have the old magic IDs.
1481 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1482 "Results", "Records", "Targets", "Ranking",
1483 "Termlists", "Stat", "MOTD" ];
1484 for (var i = 0; i < ids.length; i++) {
1485 var id = 'mkws' + ids[i];
1486 var node = $('#' + id);
1487 if (node.attr('id')) {
1489 log("added magic class to '" + node.attr('id') + "'");
1493 // For all MKWS-classed nodes that don't have a team
1494 // specified, set the team to AUTO.
1495 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1496 if (!this.className.match(/mkwsTeam_/)) {
1497 log("adding AUTO team to node with class '" + this.className + "'");
1498 $(this).addClass('mkwsTeam_AUTO');
1502 // Find all nodes with an MKWS class, and determine their team from
1503 // the mkwsTeam_* class. Make all team objects.
1505 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1506 mkws.handleNodeWithTeam(this, function(tname, type) {
1507 if (!mkws.teams[tname]) {
1508 mkws.teams[tname] = team(j, tname);
1509 log("Made MKWS team '" + tname + "'");
1513 // Second pass: make the individual widget objects. This has
1514 // to be done separately, and after the team-creation, since
1515 // that sometimes makes new widget nodes (e.g. creating
1516 // mkwsTermlists inside mkwsResults.
1517 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1518 mkws.handleNodeWithTeam(this, function(tname, type) {
1519 var myTeam = mkws.teams[tname];
1520 var myWidget = widget(j, myTeam, type, this);
1524 log("Walking MKWS nodes took " + (now-then) + " ms");
1526 if (mkws_config.use_service_proxy) {
1527 authenticateSession(mkws_config.service_proxy_auth,
1528 mkws_config.service_proxy_auth_domain,
1529 mkws_config.pazpar2_url);