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
169 var promote = type2fn[type];
172 team.debug("made " + type + " widget(node=" + node + ")");
174 team.debug("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
180 // Functions follow for promoting the regular widget object into
181 // widgets of specific types. These could be moved outside of the
182 // widget object, or even into their own source files.
184 function promoteTargets() {
185 team.queue("targets").subscribe(function(data) {
186 if (node.length === 0) alert("huh?!");
188 var table ='<table><thead><tr>' +
189 '<td>' + M('Target ID') + '</td>' +
190 '<td>' + M('Hits') + '</td>' +
191 '<td>' + M('Diags') + '</td>' +
192 '<td>' + M('Records') + '</td>' +
193 '<td>' + M('State') + '</td>' +
194 '</tr></thead><tbody>';
196 for (var i = 0; i < data.length; i++) {
197 table += "<tr><td>" + data[i].id +
198 "</td><td>" + data[i].hits +
199 "</td><td>" + data[i].diagnostic +
200 "</td><td>" + data[i].records +
201 "</td><td>" + data[i].state + "</td></tr>";
204 table += '</tbody></table>';
205 var subnode = $(node).children('.mkwsBytarget');
211 function promoteStat() {
212 team.queue("stat").subscribe(function(data) {
213 if (node.length === 0) alert("huh?!");
215 $(node).html('<span class="head">' + M('Status info') + '</span>' +
217 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
219 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
224 function promoteTermlists() {
225 team.queue("termlists").subscribe(function(data) {
226 mkws.debug("in termlist consumer");
228 alert("termlists event when there are no termlists");
232 // no facets: this should never happen
233 if (!mkws_config.facets || mkws_config.facets.length == 0) {
234 alert("onTerm called even though we have no facets: " + $.toJSON(data));
239 // display if we first got results
243 acc.push('<div class="title">' + M('Termlists') + '</div>');
244 var facets = mkws_config.facets;
246 for (var i = 0; i < facets.length; i++) {
247 if (facets[i] == "xtargets") {
248 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
249 } else if (facets[i] == "subject") {
250 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
251 } else if (facets[i] == "author") {
252 addSingleFacet(acc, "Authors", data.author, 10, "author");
254 alert("bad facet configuration: '" + facets[i] + "'");
258 $(node).html(acc.join(''));
260 function addSingleFacet(acc, caption, data, max, pzIndex) {
261 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
262 acc.push('<div class="termtitle">' + M(caption) + '</div>');
263 for (var i = 0; i < data.length && i < max; i++) {
264 acc.push('<div class="term">');
265 acc.push('<a href="#" ');
268 // Special case: target selection
269 acc.push('target_id='+data[i].id+' ');
270 if (!team.targetFiltered(data[i].id)) {
271 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
274 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
276 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
277 + ' <span>' + data[i].freq + '</span>');
286 function promotePager() {
287 team.queue("pager").subscribe(function(data) {
288 $(node).html(drawPager(data))
290 function drawPager(data) {
291 var s = '<div style="float: right">' + M('Displaying') + ': '
292 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
293 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
294 + data.total + ')</div>';
296 //client indexes pages from 1 but pz2 from 0
298 var pages = Math.ceil(team.totalRecordCount() / team.perpage());
299 var currentPage = team.currentPage();
301 var firstClkbl = (currentPage - onsides > 0)
302 ? currentPage - onsides
305 var lastClkbl = firstClkbl + 2*onsides < pages
306 ? firstClkbl + 2*onsides
309 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
311 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
312 +'<< ' + M('Prev') + '</a><b> | </b>';
315 for(var i = firstClkbl; i <= lastClkbl; i++) {
318 numLabel = '<b>' + i + '</b>';
320 middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
321 + numLabel + ' </a>';
324 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
325 if (pages - currentPage > 0)
326 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
327 + M('Next') + ' >></a>';
334 if (lastClkbl < pages)
337 s += '<div style="float: clear">'
338 + prev + predots + middle + postdots + next + '</div>';
346 function promoteRecords() {
347 team.queue("records").subscribe(function(data) {
349 for (var i = 0; i < data.hits.length; i++) {
350 var hit = data.hits[i];
351 html.push('<div class="record" id="mkwsRecdiv_' + team.name() + '_' + hit.recid + '" >',
354 // ### At some point, we may be able to move the
355 // m_currentRecordId and m_currentRecordData members
356 // from the team object into this widget.
357 if (hit.recid == team.currentRecordId()) {
358 if (team.currentRecordData())
359 html.push(team.renderDetails(team.currentRecordData()));
362 $(node).html(html.join(''));
364 function renderSummary(hit)
366 var template = team.loadTemplate("Summary");
367 hit._id = "mkwsRec_" + hit.recid;
368 hit._onclick = "mkws.showDetails('" + team.name() + "', this.id);return false;"
369 return template(hit);
376 // Factory function for team objects. As much as possible, this uses
377 // only member variables (prefixed "m_") and inner functions with
378 // private scope. Some functions are visibl as member-functions to be
379 // called from outside code -- specifically, from generated
380 // HTML. These functions are that.switchView(), showDetails(),
381 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
382 // pagerPrev(), pagerNext(), showPage().
384 function team($, teamName) {
386 var m_teamName = teamName;
387 var m_submitted = false;
388 var m_query; // initially undefined
389 var m_sortOrder; // will be set below
390 var m_perpage; // will be set below
392 var m_totalRecordCount = 0;
393 var m_currentPage = 1;
394 var m_currentRecordId = '';
395 var m_currentRecordData = null;
397 // Timestamps for logging
401 var m_paz; // will be initialised below
404 that.name = function() { return m_teamName; }
405 that.perpage = function() { return m_perpage; }
406 that.totalRecordCount = function() { return m_totalRecordCount; }
407 that.currentPage = function() { return m_currentPage; }
408 that.currentRecordId = function() { return m_currentRecordId; }
409 that.currentRecordData = function() { return m_currentRecordData; }
411 var debug = function (s) {
413 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
414 m_debugTime.last = now;
416 mkws.debug(m_teamName + ": " + timestamp + s);
420 debug("start running MKWS");
422 m_sortOrder = mkws_config.sort_default;
423 m_perpage = mkws_config.perpage_default;
425 debug("Create main pz2 object");
426 // create a parameters array and pass it to the pz2's constructor
427 // then register the form submit event with the pz2.search function
428 // autoInit is set to true on default
429 m_paz = new pz2({ "windowid": teamName,
430 "pazpar2path": mkws_config.pazpar2_url,
431 "usesessions" : mkws_config.use_service_proxy ? false : true,
433 "onbytarget": onBytarget,
435 "onterm": (mkws_config.facets.length ? onTerm : undefined),
437 "onrecord": onRecord,
438 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
439 "termlist": mkws_config.facets.join(',')
444 // pz2.js event handlers:
453 function onBytarget(data) {
455 queue("targets").publish(data);
459 function onStat(data) {
461 queue("stat").publish(data);
465 function onTerm(data) {
467 queue("termlists").publish(data);
471 function onShow(data, teamName) {
473 m_totalRecordCount = data.merged;
474 queue("pager").publish(data);
475 queue("records").publish(data);
479 function onRecord(data, args, teamName) {
481 // FIXME: record is async!!
482 clearTimeout(m_paz.recordTimer);
483 // in case on_show was faster to redraw element
484 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
485 if (detRecordDiv) return;
486 m_currentRecordData = data;
487 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
488 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
489 var html = renderDetails(m_currentRecordData);
490 $(recordDiv).append(html);
494 that.targetFiltered = function(id) {
495 for (var i = 0; i < m_filters.length; i++) {
496 if (m_filters[i].id === id ||
497 m_filters[i].id === 'pz:id=' + id) {
505 ////////////////////////////////////////////////////////////////////////////////
506 ////////////////////////////////////////////////////////////////////////////////
509 // when search button pressed
510 function onFormSubmitEventHandler()
512 var val = findnode('.mkwsQuery').val();
518 function newSearch(query, sortOrder, targets)
520 debug("newSearch: " + query);
522 if (mkws_config.use_service_proxy && !mkws.authenticated) {
523 alert("searching before authentication");
531 triggerSearch(query, sortOrder, targets);
532 switchView('records'); // In case it's configured to start off as hidden
537 function onSelectDdChange()
539 if (!m_submitted) return false;
542 m_paz.show(0, m_perpage, m_sortOrder);
547 function redrawNavi ()
549 var navi = findnode('.mkwsNavi');
553 for (var i in m_filters) {
557 var filter = m_filters[i];
559 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
560 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
562 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
563 "', '" + filter.field + "', '" + filter.value + "'" +
564 ');return false;">' + filter.value + '</a>';
575 m_totalRecordCount = 0;
579 function loadSelect ()
581 var node = findnode('.mkwsSort');
582 if (node.length && node.val() != m_sortOrder) {
583 debug("changing m_sortOrder from " + m_sortOrder + " to " + node.val());
584 m_sortOrder = node.val();
586 node = findnode('.mkwsPerpage');
587 if (node.length && node.val() != m_perpage) {
588 debug("changing m_perpage from " + m_perpage + " to " + node.val());
589 m_perpage = node.val();
594 function triggerSearch (query, sortOrder, targets)
599 // Continue to use previous query/sort-order unless new ones are specified
604 m_sortOrder = sortOrder;
607 m_filters.push({ id: targets, name: targets });
610 for (var i in m_filters) {
611 var filter = m_filters[i];
615 if (filter.id.match(/^[a-z:]+[=~]/)) {
616 debug("filter '" + filter.id + "' already begins with SETTING OP");
618 filter.id = 'pz:id=' + filter.id;
620 pp2filter += filter.id;
624 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
630 params.limit = pp2limit;
633 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
635 // We can use: params.torusquery = "udb=NAME"
636 // Note: that won't work when running against raw pazpar2
637 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
641 // limit by target functions
642 that.limitTarget = function (id, name)
644 debug("limitTarget(id=" + id + ", name=" + name + ")");
645 m_filters.push({ id: id, name: name });
654 // limit the query after clicking the facet
655 that.limitQuery = function (field, value)
657 debug("limitQuery(field=" + field + ", value=" + value + ")");
658 m_filters.push({ field: field, value: value });
667 that.delimitTarget = function (id)
669 debug("delimitTarget(id=" + id + ")");
671 for (var i in m_filters) {
672 var filter = m_filters[i];
674 debug("delimitTarget() removing filter " + $.toJSON(filter));
676 debug("delimitTarget() keeping filter " + $.toJSON(filter));
677 newFilters.push(filter);
680 m_filters = newFilters;
690 that.delimitQuery = function (field, value)
692 debug("delimitQuery(field=" + field + ", value=" + value + ")");
694 for (var i in m_filters) {
695 var filter = m_filters[i];
697 field == filter.field &&
698 value == filter.value) {
699 debug("delimitQuery() removing filter " + $.toJSON(filter));
701 debug("delimitQuery() keeping filter " + $.toJSON(filter));
702 newFilters.push(filter);
705 m_filters = newFilters;
715 that.showPage = function (pageNum)
717 m_currentPage = pageNum;
718 m_paz.showPage(m_currentPage - 1);
722 // simple paging functions
723 that.pagerNext = function () {
724 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
731 that.pagerPrev = function () {
732 if (m_paz.showPrev() != false)
737 // switching view between targets and records
738 function switchView(view) {
739 var targets = findnode('.mkwsTargets');
740 var results = findnode('.mkwsResults,.mkwsRecords');
741 var blanket = findnode('.mkwsBlanket');
742 var motd = findnode('.mkwsMOTD');
746 if (targets) targets.css('display', 'block');
747 if (results) results.css('display', 'none');
748 if (blanket) blanket.css('display', 'none');
749 if (motd) motd.css('display', 'none');
752 if (targets) targets.css('display', 'none');
753 if (results) results.css('display', 'block');
754 if (blanket) blanket.css('display', 'block');
755 if (motd) motd.css('display', 'none');
758 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
759 if (targets) targets.css('display', 'none');
760 if (results) results.css('display', 'none');
761 if (blanket) blanket.css('display', 'none');
762 if (motd) motd.css('display', 'none');
765 alert("Unknown view '" + view + "'");
770 that.switchView = switchView;
773 // detailed record drawing
774 that.showDetails = function (prefixRecId) {
775 var recId = prefixRecId.replace('mkwsRec_', '');
776 var oldRecordId = m_currentRecordId;
777 m_currentRecordId = recId;
779 // remove current detailed view if any
780 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
783 detRecordDiv.parentNode.removeChild(detRecordDiv);
785 // if the same clicked, just hide
786 if (recId == oldRecordId) {
787 m_currentRecordId = '';
788 m_currentRecordData = null;
791 // request the record
792 debug("showDetails() requesting record '" + recId + "'");
798 * All the HTML stuff to render the search forms and
801 function mkwsHtmlAll() {
803 if (mkws_config.show_lang)
806 debug("HTML search form");
807 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
809 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
810 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
811 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
815 debug("HTML records");
816 // If the team has a .mkwsResults, populate it in the usual
817 // way. If not, assume that it's a smarter application that
818 // defines its own subcomponents, some or all of the
825 if (findnode(".mkwsResults").length) {
826 findnode(".mkwsResults").html('\
827 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
829 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
830 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
832 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
833 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
834 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
835 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
836 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
841 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
847 var node = findnode(".mkwsRanking");
849 var ranking_data = '';
850 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
851 if (mkws_config.show_sort) {
852 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
854 if (mkws_config.show_perpage) {
855 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
857 ranking_data += '</form>';
859 node.html(ranking_data);
865 node = findnode('.mkwsSearchForm');
867 node.submit(onFormSubmitEventHandler);
868 node = findnode('.mkwsSort');
870 node.change(onSelectDdChange);
871 node = findnode('.mkwsPerpage');
873 node.change(onSelectDdChange);
875 // on first page, hide the termlist
876 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
877 var motd = findnode(".mkwsMOTD");
878 var container = findnode(".mkwsMOTDContainer");
879 if (motd.length && container.length) {
880 // Move the MOTD from the provided element down into the container
881 motd.appendTo(container);
886 function mkwsSetLang() {
887 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
888 if (!lang || !mkws.locale_lang[lang]) {
889 mkws_config.lang = ""
891 mkws_config.lang = lang;
894 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
895 return mkws_config.lang;
899 /* create locale language menu */
900 function mkwsHtmlLang() {
901 var lang_default = "en";
902 var lang = mkws_config.lang || lang_default;
905 /* display a list of configured languages, or all */
906 var lang_options = mkws_config.lang_options || [];
907 var toBeIncluded = {};
908 for (var i = 0; i < lang_options.length; i++) {
909 toBeIncluded[lang_options[i]] = true;
912 for (var k in mkws.locale_lang) {
913 if (toBeIncluded[k] || lang_options.length == 0)
918 if (lang_options.length == 0 || toBeIncluded[lang_default])
919 list.push(lang_default);
921 debug("Language menu for: " + list.join(", "));
925 for(var i = 0; i < list.length; i++) {
932 data += ' <span>' + l + '</span> ';
934 data += ' <a href="?lang=' + l + '">' + l + '</a> '
938 findnode(".mkwsLang").html(data);
942 function mkwsHtmlSort() {
943 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
944 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
946 for(var i = 0; i < mkws_config.sort_options.length; i++) {
947 var opt = mkws_config.sort_options[i];
949 var val = opt.length == 1 ? opt[0] : opt[1];
951 sort_html += '<option value="' + key + '"';
952 if (m_sortOrder == key || m_sortOrder == val) {
953 sort_html += ' selected="selected"';
955 sort_html += '>' + M(val) + '</option>';
957 sort_html += '</select>';
963 function mkwsHtmlPerpage() {
964 debug("HTML perpage, m_perpage = " + m_perpage);
965 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
967 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
968 var key = mkws_config.perpage_options[i];
970 perpage_html += '<option value="' + key + '"';
971 if (key == m_perpage) {
972 perpage_html += ' selected="selected"';
974 perpage_html += '>' + key + '</option>';
976 perpage_html += '</select>';
982 function mkwsHtmlSwitch() {
983 debug("HTML switch for team " + m_teamName);
985 var node = findnode(".mkwsSwitch");
986 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
987 node.append($("<span/>", { text: " | " }));
988 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
990 debug("HTML targets");
991 var node = findnode(".mkwsTargets");
993 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
994 No information available yet.\
996 node.css("display", "none");
1000 that.runAutoSearch = function() {
1001 var node = findnode('.mkwsRecords,.mkwsTermlists');
1002 var query = node.attr('autosearch');
1006 if (query.match(/^!param!/)) {
1007 var param = query.replace(/^!param!/, '');
1008 query = mkws.getParameterByName(param);
1009 debug("obtained query '" + query + "' from param '" + param + "'");
1011 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1013 } else if (query.match(/^!path!/)) {
1014 var index = query.replace(/^!path!/, '');
1015 var path = window.location.pathname.split('/');
1016 query = path[path.length - index];
1017 debug("obtained query '" + query + "' from path-component '" + index + "'");
1019 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1023 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1025 var sortOrder = node.attr('sort');
1026 var targets = node.attr('targets');
1027 var s = "running auto search: '" + query + "'";
1028 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1029 if (targets) s += " in targets '" + targets + "'";
1032 newSearch(query, sortOrder, targets);
1036 // Translation function. At present, this is properly a
1037 // global-level function (hence the assignment to mkws.M) but we
1038 // want to make it per-team so different teams can operate in
1039 // different languages.
1042 var lang = mkws_config.lang;
1044 if (!lang || !mkws.locale_lang[lang])
1047 return mkws.locale_lang[lang][word] || word;
1049 mkws.M = M; // so the Handlebars helper can use it
1052 // Finds the node of the specified class within the current team
1053 // Multiple OR-clauses separated by commas are handled
1054 // More complex cases may not work
1056 function findnode(selector, teamName) {
1057 teamName = teamName || m_teamName;
1059 selector = $.map(selector.split(','), function(s, i) {
1060 return s + '.mkwsTeam_' + teamName;
1067 function renderDetails(data, marker)
1069 var template = loadTemplate("Record");
1070 var details = template(data);
1071 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1073 that.renderDetails = renderDetails;
1076 function loadTemplate(name)
1078 var template = m_template[name];
1080 if (template === undefined) {
1081 // Fall back to generic template if there is no team-specific one
1082 var node = findnode(".mkwsTemplate_" + name);
1084 node = findnode(".mkwsTemplate_" + name, "ALL");
1087 var source = node.html();
1089 source = mkws.defaultTemplate(name);
1092 template = Handlebars.compile(source);
1093 debug("compiled template '" + name + "'");
1094 m_template[name] = template;
1099 that.loadTemplate = loadTemplate;
1102 // The following PubSub code is modified from the jQuery manual:
1103 // https://api.jquery.com/jQuery.Callbacks/
1106 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1107 // team.queue("eventName").publish(arg1, arg2, ...);
1110 var queue = function(id) {
1112 var callbacks = $.Callbacks();
1114 publish: callbacks.fire,
1115 subscribe: callbacks.add,
1116 unsubscribe: callbacks.remove
1132 mkws_config.error = e.message;
1133 // alert(e.message);
1137 // Bizarrely, 'that' is just an empty hash. All its state is in
1138 // the closure variables defined earlier in this function.
1143 // wrapper to call team() after page load
1145 mkws.debug = function (string) {
1146 if (!mkws.debug_level)
1149 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1153 // you need to disable use strict at the top of the file!!!
1154 if (mkws.debug_level >= 3) {
1155 console.log(arguments.callee.caller);
1156 } else if (mkws.debug_level >= 2) {
1157 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1159 console.log(string);
1161 var debug = mkws.debug;
1164 mkws.handleNodeWithTeam = function(node, callback) {
1165 // First branch for DOM objects; second branch for jQuery objects
1166 var classes = node.className || node.attr('class');
1168 // For some reason, if we try to proceed when classes is
1169 // undefined, we don't get an error message, but this
1170 // function and its callers, up several stack level,
1171 // silently return. What a crock.
1172 mkws.debug("handleNodeWithTeam() called on node with no classes");
1175 var list = classes.split(/\s+/)
1178 for (var i = 0; i < list.length; i++) {
1179 var cname = list[i];
1180 if (cname.match(/^mkwsTeam_/)) {
1181 teamName = cname.replace(/^mkwsTeam_/, '');
1182 } else if (cname.match(/^mkws/)) {
1183 type = cname.replace(/^mkws/, '');
1186 callback.call(node, teamName, type);
1190 mkws.resizePage = function () {
1191 var list = ["mkwsSwitch", "mkwsLang"];
1193 var width = mkws_config.responsive_design_width;
1194 var parent = $(".mkwsTermlists").parent();
1196 if ($(window).width() <= width &&
1197 parent.hasClass("mkwsTermlistContainer1")) {
1198 debug("changing from wide to narrow: " + $(window).width());
1199 $(".mkwsTermlistContainer1").hide();
1200 $(".mkwsTermlistContainer2").show();
1201 for (var tname in mkws.teams) {
1202 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1203 for(var i = 0; i < list.length; i++) {
1204 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1207 } else if ($(window).width() > width &&
1208 parent.hasClass("mkwsTermlistContainer2")) {
1209 debug("changing from narrow to wide: " + $(window).width());
1210 $(".mkwsTermlistContainer1").show();
1211 $(".mkwsTermlistContainer2").hide();
1212 for (var tname in mkws.teams) {
1213 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1214 for(var i = 0; i < list.length; i++) {
1215 $("." + list[i] + ".mkwsTeam_" + tname).show();
1222 mkws.switchView = function(tname, view) {
1223 mkws.teams[tname].switchView(view);
1226 mkws.showDetails = function (tname, prefixRecId) {
1227 mkws.teams[tname].showDetails(prefixRecId);
1230 mkws.limitTarget = function (tname, id, name) {
1231 mkws.teams[tname].limitTarget(id, name);
1234 mkws.limitQuery = function (tname, field, value) {
1235 mkws.teams[tname].limitQuery(field, value);
1238 mkws.delimitTarget = function (tname, id) {
1239 mkws.teams[tname].delimitTarget(id);
1242 mkws.delimitQuery = function (tname, field, value) {
1243 mkws.teams[tname].delimitQuery(field, value);
1246 mkws.showPage = function (tname, pageNum) {
1247 mkws.teams[tname].showPage(pageNum);
1250 mkws.pagerPrev = function (tname) {
1251 mkws.teams[tname].pagerPrev();
1254 mkws.pagerNext = function (tname) {
1255 mkws.teams[tname].pagerNext();
1259 // This function is taken from a StackOverflow answer
1260 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1261 mkws.getParameterByName = function(name) {
1262 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1263 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1264 results = regex.exec(location.search);
1265 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1269 mkws.defaultTemplate = function(name)
1271 if (name === 'Record') {
1275 <th>{{translate "Title"}}</th>\
1278 {{#if md-title-remainder}}\
1279 ({{md-title-remainder}})\
1281 {{#if md-title-responsibility}}\
1282 <i>{{md-title-responsibility}}</i>\
1288 <th>{{translate "Date"}}</th>\
1289 <td>{{md-date}}</td>\
1294 <th>{{translate "Author"}}</th>\
1295 <td>{{md-author}}</td>\
1298 {{#if md-electronic-url}}\
1300 <th>{{translate "Links"}}</th>\
1302 {{#each md-electronic-url}}\
1303 <a href="{{this}}">Link{{index1}}</a>\
1308 {{#if-any location having="md-subject"}}\
1310 <th>{{translate "Subject"}}</th>\
1312 {{#first location having="md-subject"}}\
1314 {{#commaList md-subject}}\
1315 {{this}}{{/commaList}}\
1322 <th>{{translate "Locations"}}</th>\
1324 {{#commaList location}}\
1325 {{attr "@name"}}{{/commaList}}\
1330 } else if (name === "Summary") {
1332 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1333 <b>{{md-title}}</b>\
1335 {{#if md-title-remainder}}\
1336 <span>{{md-title-remainder}}</span>\
1338 {{#if md-title-responsibility}}\
1339 <span><i>{{md-title-responsibility}}</i></span>\
1344 var s = "There is no default '" + name +"' template!";
1350 function defaultMkwsConfig() {
1351 /* default mkws config */
1352 var config_default = {
1353 use_service_proxy: true,
1354 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1355 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1357 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1358 perpage_options: [10, 20, 30, 50],
1359 sort_default: "relevance",
1360 perpage_default: 20,
1362 show_lang: true, /* show/hide language menu */
1363 show_sort: true, /* show/hide sort menu */
1364 show_perpage: true, /* show/hide perpage menu */
1365 lang_options: [], /* display languages links for given languages, [] for all */
1366 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1367 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1368 debug_level: 1, /* debug level for development: 0..2 */
1373 /* Set global debug_level flag early so that debug() works */
1374 if (typeof mkws_config.debug_level !== 'undefined') {
1375 mkws.debug_level = mkws_config.debug_level;
1376 } else if (typeof config_default.debug_level !== 'undefined') {
1377 mkws.debug_level = config_default.debug_level;
1380 // make sure the mkws_config is a valid hash
1381 if (!$.isPlainObject(mkws_config)) {
1382 debug("ERROR: mkws_config is not an JS object, ignore it....");
1386 /* override standard config values by function parameters */
1387 for (var k in config_default) {
1388 if (typeof mkws_config[k] === 'undefined')
1389 mkws_config[k] = config_default[k];
1390 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1396 * Run service-proxy authentication in background (after page load).
1397 * The username/password is configured in the apache config file
1400 function authenticateSession(auth_url, auth_domain, pp2_url) {
1401 debug("Run service proxy auth URL: " + auth_url);
1404 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1405 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1408 var request = new pzHttpRequest(auth_url, function(err) {
1409 alert("HTTP call for authentication failed: " + err)
1413 request.get(null, function(data) {
1414 if (!$.isXMLDoc(data)) {
1415 alert("service proxy auth response document is not valid XML document, give up!");
1418 var status = $(data).find("status");
1419 if (status.text() != "OK") {
1420 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1424 debug("Service proxy auth successfully done");
1425 mkws.authenticated = true;
1431 function runAutoSearches() {
1432 debug("running auto searches");
1434 for (var teamName in mkws.teams) {
1435 mkws.teams[teamName].runAutoSearch();
1440 $(document).ready(function() {
1441 debug("on load ready");
1442 defaultMkwsConfig();
1444 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1445 debug("Reset query width: " + mkws_config.query_width);
1446 mkws_config.query_width = 50;
1449 for (var key in mkws_config) {
1450 if (mkws_config.hasOwnProperty(key)) {
1451 if (key.match(/^language_/)) {
1452 var lang = key.replace(/^language_/, "");
1453 // Copy custom languages into list
1454 mkws.locale_lang[lang] = mkws_config[key];
1455 debug("Added locally configured language '" + lang + "'");
1460 if (mkws_config.responsive_design_width) {
1461 // Responsive web design - change layout on the fly based on
1462 // current screen width. Required for mobile devices.
1463 $(window).resize(function(e) { mkws.resizePage() });
1464 // initial check after page load
1465 $(document).ready(function() { mkws.resizePage() });
1468 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1469 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1470 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1471 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1474 // Backwards compatibility: set new magic class names on any
1475 // elements that have the old magic IDs.
1476 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1477 "Results", "Records", "Targets", "Ranking",
1478 "Termlists", "Stat", "MOTD" ];
1479 for (var i = 0; i < ids.length; i++) {
1480 var id = 'mkws' + ids[i];
1481 var node = $('#' + id);
1482 if (node.attr('id')) {
1484 debug("added magic class to '" + node.attr('id') + "'");
1488 // For all MKWS-classed nodes that don't have a team
1489 // specified, set the team to AUTO.
1490 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1491 if (!this.className.match(/mkwsTeam_/)) {
1492 debug("adding AUTO team to node with class '" + this.className + "'");
1493 $(this).addClass('mkwsTeam_AUTO');
1497 // Find all nodes with an MKWS class, and determine their team from
1498 // the mkwsTeam_* class. Make all team objects.
1500 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1501 mkws.handleNodeWithTeam(this, function(tname, type) {
1502 if (!mkws.teams[tname]) {
1503 mkws.teams[tname] = team(j, tname);
1504 debug("Made MKWS team '" + tname + "'");
1508 // Second pass: make the individual widget objects. This has
1509 // to be done separately, and after the team-creation, since
1510 // that sometimes makes new widget nodes (e.g. creating
1511 // mkwsTermlists instead mkwsResults.
1512 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1513 mkws.handleNodeWithTeam(this, function(tname, type) {
1514 var myTeam = mkws.teams[tname];
1515 var myWidget = widget(j, myTeam, type, this);
1519 debug("Walking MKWS nodes took " + (now-then) + " ms");
1521 if (mkws_config.use_service_proxy) {
1522 authenticateSession(mkws_config.service_proxy_auth,
1523 mkws_config.service_proxy_auth_domain,
1524 mkws_config.pazpar2_url);