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 Perpage: promotePerpage
172 var promote = type2fn[type];
175 team.debug("made " + type + " widget(node=" + node + ")");
177 team.debug("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
183 // Functions follow for promoting the regular widget object into
184 // widgets of specific types. These could be moved outside of the
185 // widget object, or even into their own source files.
187 function promoteTargets() {
188 team.queue("targets").subscribe(function(data) {
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>';
401 function promoteSort() {
402 // It seems this and the Perpage widget doen't need to
403 // subscribe to anything, since they produce events rather
404 // than consuming them.
405 $(node).change(function () {
406 team.set_sortOrder($(node).val());
407 if (team.submitted()) {
416 function promotePerpage() {
417 $(node).change(function() {
418 team.set_perpage($(node).val());
419 if (team.submitted()) {
429 // Factory function for team objects. As much as possible, this uses
430 // only member variables (prefixed "m_") and inner functions with
431 // private scope. Some functions are visibl as member-functions to be
432 // called from outside code -- specifically, from generated
433 // HTML. These functions are that.switchView(), showDetails(),
434 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
435 // pagerPrev(), pagerNext(), showPage().
437 function team($, teamName) {
439 var m_teamName = teamName;
440 var m_submitted = false;
441 var m_query; // initially undefined
442 var m_sortOrder; // will be set below
443 var m_perpage; // will be set below
445 var m_totalRecordCount = 0;
446 var m_currentPage = 1;
447 var m_currentRecordId = '';
448 var m_currentRecordData = null;
450 // Timestamps for logging
454 var m_paz; // will be initialised below
457 that.name = function() { return m_teamName; }
458 that.submitted = function() { return m_submitted; }
459 that.perpage = function() { return m_perpage; }
460 that.totalRecordCount = function() { return m_totalRecordCount; }
461 that.currentPage = function() { return m_currentPage; }
462 that.currentRecordId = function() { return m_currentRecordId; }
463 that.currentRecordData = function() { return m_currentRecordData; }
464 that.filters = function() { return m_filters; }
466 that.set_sortOrder = function(val) { m_sortOrder = val };
467 that.set_perpage = function(val) { m_perpage = val };
470 var debug = function (s) {
472 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
473 m_debugTime.last = now;
475 mkws.debug(m_teamName + ": " + timestamp + s);
479 debug("start running MKWS");
481 m_sortOrder = mkws_config.sort_default;
482 m_perpage = mkws_config.perpage_default;
484 debug("Create main pz2 object");
485 // create a parameters array and pass it to the pz2's constructor
486 // then register the form submit event with the pz2.search function
487 // autoInit is set to true on default
488 m_paz = new pz2({ "windowid": teamName,
489 "pazpar2path": mkws_config.pazpar2_url,
490 "usesessions" : mkws_config.use_service_proxy ? false : true,
492 "onbytarget": onBytarget,
494 "onterm": (mkws_config.facets.length ? onTerm : undefined),
496 "onrecord": onRecord,
497 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
498 "termlist": mkws_config.facets.join(',')
503 // pz2.js event handlers:
512 function onBytarget(data) {
514 queue("targets").publish(data);
518 function onStat(data) {
520 queue("stat").publish(data);
524 function onTerm(data) {
526 queue("termlists").publish(data);
530 function onShow(data, teamName) {
532 m_totalRecordCount = data.merged;
533 queue("pager").publish(data);
534 queue("records").publish(data);
538 function onRecord(data, args, teamName) {
540 // FIXME: record is async!!
541 clearTimeout(m_paz.recordTimer);
542 // in case on_show was faster to redraw element
543 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
544 if (detRecordDiv) return;
545 m_currentRecordData = data;
546 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
547 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
548 var html = renderDetails(m_currentRecordData);
549 $(recordDiv).append(html);
553 that.targetFiltered = function(id) {
554 for (var i = 0; i < m_filters.length; i++) {
555 if (m_filters[i].id === id ||
556 m_filters[i].id === 'pz:id=' + id) {
564 ////////////////////////////////////////////////////////////////////////////////
565 ////////////////////////////////////////////////////////////////////////////////
568 // when search button pressed
569 function onFormSubmitEventHandler()
571 var val = findnode('.mkwsQuery').val();
577 function newSearch(query, sortOrder, targets)
579 debug("newSearch: " + query);
581 if (mkws_config.use_service_proxy && !mkws.authenticated) {
582 alert("searching before authentication");
587 triggerSearch(query, sortOrder, targets);
588 switchView('records'); // In case it's configured to start off as hidden
593 // limit by target functions
594 that.limitTarget = function (id, name)
596 debug("limitTarget(id=" + id + ", name=" + name + ")");
597 m_filters.push({ id: id, name: name });
603 // limit the query after clicking the facet
604 that.limitQuery = function (field, value)
606 debug("limitQuery(field=" + field + ", value=" + value + ")");
607 m_filters.push({ field: field, value: value });
613 that.delimitTarget = function (id)
615 debug("delimitTarget(id=" + id + ")");
617 for (var i in m_filters) {
618 var filter = m_filters[i];
620 debug("delimitTarget() removing filter " + $.toJSON(filter));
622 debug("delimitTarget() keeping filter " + $.toJSON(filter));
623 newFilters.push(filter);
626 m_filters = newFilters;
633 that.delimitQuery = function (field, value)
635 debug("delimitQuery(field=" + field + ", value=" + value + ")");
637 for (var i in m_filters) {
638 var filter = m_filters[i];
640 field == filter.field &&
641 value == filter.value) {
642 debug("delimitQuery() removing filter " + $.toJSON(filter));
644 debug("delimitQuery() keeping filter " + $.toJSON(filter));
645 newFilters.push(filter);
648 m_filters = newFilters;
658 m_totalRecordCount = 0;
660 that.resetPage = resetPage;
663 function triggerSearch (query, sortOrder, targets)
666 queue("navi").publish();
671 // Continue to use previous query/sort-order unless new ones are specified
676 m_sortOrder = sortOrder;
679 m_filters.push({ id: targets, name: targets });
682 for (var i in m_filters) {
683 var filter = m_filters[i];
687 if (filter.id.match(/^[a-z:]+[=~]/)) {
688 debug("filter '" + filter.id + "' already begins with SETTING OP");
690 filter.id = 'pz:id=' + filter.id;
692 pp2filter += filter.id;
696 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
702 params.limit = pp2limit;
705 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
707 // We can use: params.torusquery = "udb=NAME"
708 // Note: that won't work when running against raw pazpar2
709 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
713 that.reShow = function() {
714 m_paz.show(0, m_perpage, m_sortOrder);
719 that.showPage = function (pageNum)
721 m_currentPage = pageNum;
722 m_paz.showPage(m_currentPage - 1);
726 // simple paging functions
727 that.pagerNext = function () {
728 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
735 that.pagerPrev = function () {
736 if (m_paz.showPrev() != false)
741 // switching view between targets and records
742 function switchView(view) {
743 var targets = findnode('.mkwsTargets');
744 var results = findnode('.mkwsResults,.mkwsRecords');
745 var blanket = findnode('.mkwsBlanket');
746 var motd = findnode('.mkwsMOTD');
750 if (targets) targets.css('display', 'block');
751 if (results) results.css('display', 'none');
752 if (blanket) blanket.css('display', 'none');
753 if (motd) motd.css('display', 'none');
756 if (targets) targets.css('display', 'none');
757 if (results) results.css('display', 'block');
758 if (blanket) blanket.css('display', 'block');
759 if (motd) motd.css('display', 'none');
762 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
763 if (targets) targets.css('display', 'none');
764 if (results) results.css('display', 'none');
765 if (blanket) blanket.css('display', 'none');
766 if (motd) motd.css('display', 'none');
769 alert("Unknown view '" + view + "'");
772 that.switchView = switchView;
775 // detailed record drawing
776 that.showDetails = function (prefixRecId) {
777 var recId = prefixRecId.replace('mkwsRec_', '');
778 var oldRecordId = m_currentRecordId;
779 m_currentRecordId = recId;
781 // remove current detailed view if any
782 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
785 detRecordDiv.parentNode.removeChild(detRecordDiv);
787 // if the same clicked, just hide
788 if (recId == oldRecordId) {
789 m_currentRecordId = '';
790 m_currentRecordData = null;
793 // request the record
794 debug("showDetails() requesting record '" + recId + "'");
800 * All the HTML stuff to render the search forms and
803 function mkwsHtmlAll() {
805 if (mkws_config.show_lang)
808 debug("HTML search form");
809 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
811 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
812 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
813 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
817 debug("HTML records");
818 // If the team has a .mkwsResults, populate it in the usual
819 // way. If not, assume that it's a smarter application that
820 // defines its own subcomponents, some or all of the
827 findnode(".mkwsResults").html('\
828 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
830 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
831 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
833 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
834 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
835 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
836 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
837 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
842 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
847 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
848 if (mkws_config.show_sort) {
849 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
851 if (mkws_config.show_perpage) {
852 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
854 ranking_data += '</form>';
855 findnode(".mkwsRanking").html(ranking_data);
859 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
861 // on first page, hide the termlist
862 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
863 var container = findnode(".mkwsMOTDContainer");
864 if (container.length) {
865 // Move the MOTD from the provided element down into the container
866 findnode(".mkwsMOTD").appendTo(container);
871 function mkwsSetLang() {
872 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
873 if (!lang || !mkws.locale_lang[lang]) {
874 mkws_config.lang = ""
876 mkws_config.lang = lang;
879 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
880 return mkws_config.lang;
884 /* create locale language menu */
885 function mkwsHtmlLang() {
886 var lang_default = "en";
887 var lang = mkws_config.lang || lang_default;
890 /* display a list of configured languages, or all */
891 var lang_options = mkws_config.lang_options || [];
892 var toBeIncluded = {};
893 for (var i = 0; i < lang_options.length; i++) {
894 toBeIncluded[lang_options[i]] = true;
897 for (var k in mkws.locale_lang) {
898 if (toBeIncluded[k] || lang_options.length == 0)
903 if (lang_options.length == 0 || toBeIncluded[lang_default])
904 list.push(lang_default);
906 debug("Language menu for: " + list.join(", "));
910 for(var i = 0; i < list.length; i++) {
917 data += ' <span>' + l + '</span> ';
919 data += ' <a href="?lang=' + l + '">' + l + '</a> '
923 findnode(".mkwsLang").html(data);
927 function mkwsHtmlSort() {
928 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
929 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
931 for(var i = 0; i < mkws_config.sort_options.length; i++) {
932 var opt = mkws_config.sort_options[i];
934 var val = opt.length == 1 ? opt[0] : opt[1];
936 sort_html += '<option value="' + key + '"';
937 if (m_sortOrder == key || m_sortOrder == val) {
938 sort_html += ' selected="selected"';
940 sort_html += '>' + M(val) + '</option>';
942 sort_html += '</select>';
948 function mkwsHtmlPerpage() {
949 debug("HTML perpage, m_perpage = " + m_perpage);
950 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
952 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
953 var key = mkws_config.perpage_options[i];
955 perpage_html += '<option value="' + key + '"';
956 if (key == m_perpage) {
957 perpage_html += ' selected="selected"';
959 perpage_html += '>' + key + '</option>';
961 perpage_html += '</select>';
967 function mkwsHtmlSwitch() {
968 debug("HTML switch for team " + m_teamName);
970 var node = findnode(".mkwsSwitch");
971 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
972 node.append($("<span/>", { text: " | " }));
973 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
975 debug("HTML targets");
976 var node = findnode(".mkwsTargets");
978 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
979 No information available yet.\
981 node.css("display", "none");
985 that.runAutoSearch = function() {
986 var node = findnode('.mkwsRecords,.mkwsTermlists');
987 var query = node.attr('autosearch');
991 if (query.match(/^!param!/)) {
992 var param = query.replace(/^!param!/, '');
993 query = mkws.getParameterByName(param);
994 debug("obtained query '" + query + "' from param '" + param + "'");
996 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
998 } else if (query.match(/^!path!/)) {
999 var index = query.replace(/^!path!/, '');
1000 var path = window.location.pathname.split('/');
1001 query = path[path.length - index];
1002 debug("obtained query '" + query + "' from path-component '" + index + "'");
1004 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1008 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1010 var sortOrder = node.attr('sort');
1011 var targets = node.attr('targets');
1012 var s = "running auto search: '" + query + "'";
1013 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1014 if (targets) s += " in targets '" + targets + "'";
1017 newSearch(query, sortOrder, targets);
1021 // Translation function. At present, this is properly a
1022 // global-level function (hence the assignment to mkws.M) but we
1023 // want to make it per-team so different teams can operate in
1024 // different languages.
1027 var lang = mkws_config.lang;
1029 if (!lang || !mkws.locale_lang[lang])
1032 return mkws.locale_lang[lang][word] || word;
1034 mkws.M = M; // so the Handlebars helper can use it
1037 // Finds the node of the specified class within the current team
1038 // Multiple OR-clauses separated by commas are handled
1039 // More complex cases may not work
1041 function findnode(selector, teamName) {
1042 teamName = teamName || m_teamName;
1044 selector = $.map(selector.split(','), function(s, i) {
1045 return s + '.mkwsTeam_' + teamName;
1052 function renderDetails(data, marker)
1054 var template = loadTemplate("Record");
1055 var details = template(data);
1056 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1058 that.renderDetails = renderDetails;
1061 function loadTemplate(name)
1063 var template = m_template[name];
1065 if (template === undefined) {
1066 // Fall back to generic template if there is no team-specific one
1067 var node = findnode(".mkwsTemplate_" + name);
1069 node = findnode(".mkwsTemplate_" + name, "ALL");
1072 var source = node.html();
1074 source = mkws.defaultTemplate(name);
1077 template = Handlebars.compile(source);
1078 debug("compiled template '" + name + "'");
1079 m_template[name] = template;
1084 that.loadTemplate = loadTemplate;
1087 // The following PubSub code is modified from the jQuery manual:
1088 // https://api.jquery.com/jQuery.Callbacks/
1091 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1092 // team.queue("eventName").publish(arg1, arg2, ...);
1095 var queue = function(id) {
1097 var callbacks = $.Callbacks();
1099 publish: callbacks.fire,
1100 subscribe: callbacks.add,
1101 unsubscribe: callbacks.remove
1116 mkws_config.error = e.message;
1117 // alert(e.message);
1121 // Bizarrely, 'that' is just an empty hash. All its state is in
1122 // the closure variables defined earlier in this function.
1127 // wrapper to call team() after page load
1129 mkws.debug = function (string) {
1130 if (!mkws.debug_level)
1133 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1137 // you need to disable use strict at the top of the file!!!
1138 if (mkws.debug_level >= 3) {
1139 console.log(arguments.callee.caller);
1140 } else if (mkws.debug_level >= 2) {
1141 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1143 console.log(string);
1145 var debug = mkws.debug;
1148 mkws.handleNodeWithTeam = function(node, callback) {
1149 // First branch for DOM objects; second branch for jQuery objects
1150 var classes = node.className || node.attr('class');
1152 // For some reason, if we try to proceed when classes is
1153 // undefined, we don't get an error message, but this
1154 // function and its callers, up several stack level,
1155 // silently return. What a crock.
1156 mkws.debug("handleNodeWithTeam() called on node with no classes");
1159 var list = classes.split(/\s+/)
1162 for (var i = 0; i < list.length; i++) {
1163 var cname = list[i];
1164 if (cname.match(/^mkwsTeam_/)) {
1165 teamName = cname.replace(/^mkwsTeam_/, '');
1166 } else if (cname.match(/^mkws/)) {
1167 type = cname.replace(/^mkws/, '');
1170 callback.call(node, teamName, type);
1174 mkws.resizePage = function () {
1175 var list = ["mkwsSwitch", "mkwsLang"];
1177 var width = mkws_config.responsive_design_width;
1178 var parent = $(".mkwsTermlists").parent();
1180 if ($(window).width() <= width &&
1181 parent.hasClass("mkwsTermlistContainer1")) {
1182 debug("changing from wide to narrow: " + $(window).width());
1183 $(".mkwsTermlistContainer1").hide();
1184 $(".mkwsTermlistContainer2").show();
1185 for (var tname in mkws.teams) {
1186 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1187 for(var i = 0; i < list.length; i++) {
1188 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1191 } else if ($(window).width() > width &&
1192 parent.hasClass("mkwsTermlistContainer2")) {
1193 debug("changing from narrow to wide: " + $(window).width());
1194 $(".mkwsTermlistContainer1").show();
1195 $(".mkwsTermlistContainer2").hide();
1196 for (var tname in mkws.teams) {
1197 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1198 for(var i = 0; i < list.length; i++) {
1199 $("." + list[i] + ".mkwsTeam_" + tname).show();
1206 mkws.switchView = function(tname, view) {
1207 mkws.teams[tname].switchView(view);
1210 mkws.showDetails = function (tname, prefixRecId) {
1211 mkws.teams[tname].showDetails(prefixRecId);
1214 mkws.limitTarget = function (tname, id, name) {
1215 mkws.teams[tname].limitTarget(id, name);
1218 mkws.limitQuery = function (tname, field, value) {
1219 mkws.teams[tname].limitQuery(field, value);
1222 mkws.delimitTarget = function (tname, id) {
1223 mkws.teams[tname].delimitTarget(id);
1226 mkws.delimitQuery = function (tname, field, value) {
1227 mkws.teams[tname].delimitQuery(field, value);
1230 mkws.showPage = function (tname, pageNum) {
1231 mkws.teams[tname].showPage(pageNum);
1234 mkws.pagerPrev = function (tname) {
1235 mkws.teams[tname].pagerPrev();
1238 mkws.pagerNext = function (tname) {
1239 mkws.teams[tname].pagerNext();
1243 // This function is taken from a StackOverflow answer
1244 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1245 mkws.getParameterByName = function(name) {
1246 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1247 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1248 results = regex.exec(location.search);
1249 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1253 mkws.defaultTemplate = function(name)
1255 if (name === 'Record') {
1259 <th>{{translate "Title"}}</th>\
1262 {{#if md-title-remainder}}\
1263 ({{md-title-remainder}})\
1265 {{#if md-title-responsibility}}\
1266 <i>{{md-title-responsibility}}</i>\
1272 <th>{{translate "Date"}}</th>\
1273 <td>{{md-date}}</td>\
1278 <th>{{translate "Author"}}</th>\
1279 <td>{{md-author}}</td>\
1282 {{#if md-electronic-url}}\
1284 <th>{{translate "Links"}}</th>\
1286 {{#each md-electronic-url}}\
1287 <a href="{{this}}">Link{{index1}}</a>\
1292 {{#if-any location having="md-subject"}}\
1294 <th>{{translate "Subject"}}</th>\
1296 {{#first location having="md-subject"}}\
1298 {{#commaList md-subject}}\
1299 {{this}}{{/commaList}}\
1306 <th>{{translate "Locations"}}</th>\
1308 {{#commaList location}}\
1309 {{attr "@name"}}{{/commaList}}\
1314 } else if (name === "Summary") {
1316 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1317 <b>{{md-title}}</b>\
1319 {{#if md-title-remainder}}\
1320 <span>{{md-title-remainder}}</span>\
1322 {{#if md-title-responsibility}}\
1323 <span><i>{{md-title-responsibility}}</i></span>\
1328 var s = "There is no default '" + name +"' template!";
1334 function defaultMkwsConfig() {
1335 /* default mkws config */
1336 var config_default = {
1337 use_service_proxy: true,
1338 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1339 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1341 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1342 perpage_options: [10, 20, 30, 50],
1343 sort_default: "relevance",
1344 perpage_default: 20,
1346 show_lang: true, /* show/hide language menu */
1347 show_sort: true, /* show/hide sort menu */
1348 show_perpage: true, /* show/hide perpage menu */
1349 lang_options: [], /* display languages links for given languages, [] for all */
1350 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1351 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1352 debug_level: 1, /* debug level for development: 0..2 */
1357 /* Set global debug_level flag early so that debug() works */
1358 if (typeof mkws_config.debug_level !== 'undefined') {
1359 mkws.debug_level = mkws_config.debug_level;
1360 } else if (typeof config_default.debug_level !== 'undefined') {
1361 mkws.debug_level = config_default.debug_level;
1364 // make sure the mkws_config is a valid hash
1365 if (!$.isPlainObject(mkws_config)) {
1366 debug("ERROR: mkws_config is not an JS object, ignore it....");
1370 /* override standard config values by function parameters */
1371 for (var k in config_default) {
1372 if (typeof mkws_config[k] === 'undefined')
1373 mkws_config[k] = config_default[k];
1374 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1380 * Run service-proxy authentication in background (after page load).
1381 * The username/password is configured in the apache config file
1384 function authenticateSession(auth_url, auth_domain, pp2_url) {
1385 debug("Run service proxy auth URL: " + auth_url);
1388 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1389 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1392 var request = new pzHttpRequest(auth_url, function(err) {
1393 alert("HTTP call for authentication failed: " + err)
1397 request.get(null, function(data) {
1398 if (!$.isXMLDoc(data)) {
1399 alert("service proxy auth response document is not valid XML document, give up!");
1402 var status = $(data).find("status");
1403 if (status.text() != "OK") {
1404 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1408 debug("Service proxy auth successfully done");
1409 mkws.authenticated = true;
1415 function runAutoSearches() {
1416 debug("running auto searches");
1418 for (var teamName in mkws.teams) {
1419 mkws.teams[teamName].runAutoSearch();
1424 $(document).ready(function() {
1425 debug("on load ready");
1426 defaultMkwsConfig();
1428 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1429 debug("Reset query width: " + mkws_config.query_width);
1430 mkws_config.query_width = 50;
1433 for (var key in mkws_config) {
1434 if (mkws_config.hasOwnProperty(key)) {
1435 if (key.match(/^language_/)) {
1436 var lang = key.replace(/^language_/, "");
1437 // Copy custom languages into list
1438 mkws.locale_lang[lang] = mkws_config[key];
1439 debug("Added locally configured language '" + lang + "'");
1444 if (mkws_config.responsive_design_width) {
1445 // Responsive web design - change layout on the fly based on
1446 // current screen width. Required for mobile devices.
1447 $(window).resize(function(e) { mkws.resizePage() });
1448 // initial check after page load
1449 $(document).ready(function() { mkws.resizePage() });
1452 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1453 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1454 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1455 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1458 // Backwards compatibility: set new magic class names on any
1459 // elements that have the old magic IDs.
1460 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1461 "Results", "Records", "Targets", "Ranking",
1462 "Termlists", "Stat", "MOTD" ];
1463 for (var i = 0; i < ids.length; i++) {
1464 var id = 'mkws' + ids[i];
1465 var node = $('#' + id);
1466 if (node.attr('id')) {
1468 debug("added magic class to '" + node.attr('id') + "'");
1472 // For all MKWS-classed nodes that don't have a team
1473 // specified, set the team to AUTO.
1474 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1475 if (!this.className.match(/mkwsTeam_/)) {
1476 debug("adding AUTO team to node with class '" + this.className + "'");
1477 $(this).addClass('mkwsTeam_AUTO');
1481 // Find all nodes with an MKWS class, and determine their team from
1482 // the mkwsTeam_* class. Make all team objects.
1484 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1485 mkws.handleNodeWithTeam(this, function(tname, type) {
1486 if (!mkws.teams[tname]) {
1487 mkws.teams[tname] = team(j, tname);
1488 debug("Made MKWS team '" + tname + "'");
1492 // Second pass: make the individual widget objects. This has
1493 // to be done separately, and after the team-creation, since
1494 // that sometimes makes new widget nodes (e.g. creating
1495 // mkwsTermlists inside mkwsResults.
1496 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1497 mkws.handleNodeWithTeam(this, function(tname, type) {
1498 var myTeam = mkws.teams[tname];
1499 var myWidget = widget(j, myTeam, type, this);
1503 debug("Walking MKWS nodes took " + (now-then) + " ms");
1505 if (mkws_config.use_service_proxy) {
1506 authenticateSession(mkws_config.service_proxy_auth,
1507 mkws_config.service_proxy_auth_domain,
1508 mkws_config.pazpar2_url);