1 /*! MKWS, the MasterKey Widget Set.
2 * Copyright (C) 2013-2014 Index Data
3 * See the file LICENSE for details
6 "use strict"; // HTML5: disable for debug_level >= 2
10 Handlebars.registerHelper('json', function(obj) {
15 Handlebars.registerHelper('translate', function(s) {
20 // We need {{attr '@name'}} because Handlebars can't parse {{@name}}
21 Handlebars.registerHelper('attr', function(attrName) {
22 return this[attrName];
27 * Use as follows: {{#if-any NAME1 having="NAME2"}}
28 * Applicable when NAME1 is the name of an array
29 * The guarded code runs only if at least one element of the NAME1
30 * array has a subelement called NAME2.
32 Handlebars.registerHelper('if-any', function(items, options) {
33 var having = options.hash.having;
34 for (var i in items) {
36 if (!having || item[having]) {
37 return options.fn(this);
44 Handlebars.registerHelper('first', function(items, options) {
45 var having = options.hash.having;
46 for (var i in items) {
48 if (!having || item[having]) {
49 return options.fn(item);
56 Handlebars.registerHelper('commaList', function(items, options) {
59 for (var i in items) {
60 if (i > 0) out += ", ";
61 out += options.fn(items[i])
68 Handlebars.registerHelper('index1', function(obj) {
69 return obj.data.index + 1;
74 // Set up global mkws object. Contains truly global state such as SP
75 // authentication, and a hash of team objects, indexed by team-name.
79 debug_level: 1, // Will be overridden from mkws_config, but
80 // initial value allows jQuery popup to use logging.
81 paz: undefined, // will be set up during initialisation
86 "Subjects": "Schlagwörter",
87 "Sources": "Daten und Quellen",
88 "source": "datenquelle",
89 "Termlists": "Termlisten",
91 "Prev": "Zurück",
93 "Sort by": "Sortieren nach",
94 "and show": "und zeige",
95 "per page": "pro Seite",
96 "Displaying": "Zeige",
104 "Subject": "Schlagwort",
105 "subject": "schlagwort",
107 "Records": "Datensätze",
108 "Targets": "Datenbanken",
114 "Authors": "Forfattere",
118 "Termlists": "Termlists",
119 "Next": "Næste",
121 "Search": "Søg",
122 "Sort by": "Sorter efter",
123 "and show": "og vis",
124 "per page": "per side",
125 "Displaying": "Viser",
130 "Author": "Forfatter",
131 "author": "forfatter",
133 "Subject": "Emneord",
134 "subject": "emneord",
135 "Location": "Lokation",
145 // Define empty mkws_config for simple applications that don't define it.
146 if (mkws_config == null || typeof mkws_config != 'object') {
147 var mkws_config = {};
151 // Factory function for widget objects.
152 function widget($, team, type, node) {
162 Targets: promoteTargets,
164 Termlists: promoteTermlists,
166 Records: promoteRecords,
170 var promote = type2fn[type];
173 team.debug("made " + type + " widget(node=" + node + ")");
175 team.debug("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
181 // Functions follow for promoting the regular widget object into
182 // widgets of specific types. These could be moved outside of the
183 // widget object, or even into their own source files.
185 function promoteTargets() {
186 team.queue("targets").subscribe(function(data) {
187 var table ='<table><thead><tr>' +
188 '<td>' + M('Target ID') + '</td>' +
189 '<td>' + M('Hits') + '</td>' +
190 '<td>' + M('Diags') + '</td>' +
191 '<td>' + M('Records') + '</td>' +
192 '<td>' + M('State') + '</td>' +
193 '</tr></thead><tbody>';
195 for (var i = 0; i < data.length; i++) {
196 table += "<tr><td>" + data[i].id +
197 "</td><td>" + data[i].hits +
198 "</td><td>" + data[i].diagnostic +
199 "</td><td>" + data[i].records +
200 "</td><td>" + data[i].state + "</td></tr>";
203 table += '</tbody></table>';
204 var subnode = $(node).children('.mkwsBytarget');
210 function promoteStat() {
211 team.queue("stat").subscribe(function(data) {
212 if (node.length === 0) alert("huh?!");
214 $(node).html('<span class="head">' + M('Status info') + '</span>' +
216 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
218 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
223 function promoteTermlists() {
224 team.queue("termlists").subscribe(function(data) {
225 mkws.debug("in termlist consumer");
227 alert("termlists event when there are no termlists");
231 // no facets: this should never happen
232 if (!mkws_config.facets || mkws_config.facets.length == 0) {
233 alert("onTerm called even though we have no facets: " + $.toJSON(data));
238 // display if we first got results
242 acc.push('<div class="title">' + M('Termlists') + '</div>');
243 var facets = mkws_config.facets;
245 for (var i = 0; i < facets.length; i++) {
246 if (facets[i] == "xtargets") {
247 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
248 } else if (facets[i] == "subject") {
249 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
250 } else if (facets[i] == "author") {
251 addSingleFacet(acc, "Authors", data.author, 10, "author");
253 alert("bad facet configuration: '" + facets[i] + "'");
257 $(node).html(acc.join(''));
259 function addSingleFacet(acc, caption, data, max, pzIndex) {
260 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
261 acc.push('<div class="termtitle">' + M(caption) + '</div>');
262 for (var i = 0; i < data.length && i < max; i++) {
263 acc.push('<div class="term">');
264 acc.push('<a href="#" ');
267 // Special case: target selection
268 acc.push('target_id='+data[i].id+' ');
269 if (!team.targetFiltered(data[i].id)) {
270 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
273 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
275 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
276 + ' <span>' + data[i].freq + '</span>');
285 function promotePager() {
286 team.queue("pager").subscribe(function(data) {
287 $(node).html(drawPager(data))
289 function drawPager(data) {
290 var s = '<div style="float: right">' + M('Displaying') + ': '
291 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
292 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
293 + data.total + ')</div>';
295 //client indexes pages from 1 but pz2 from 0
297 var pages = Math.ceil(team.totalRecordCount() / team.perpage());
298 var currentPage = team.currentPage();
300 var firstClkbl = (currentPage - onsides > 0)
301 ? currentPage - onsides
304 var lastClkbl = firstClkbl + 2*onsides < pages
305 ? firstClkbl + 2*onsides
308 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
310 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
311 +'<< ' + M('Prev') + '</a><b> | </b>';
314 for(var i = firstClkbl; i <= lastClkbl; i++) {
317 numLabel = '<b>' + i + '</b>';
319 middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
320 + numLabel + ' </a>';
323 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
324 if (pages - currentPage > 0)
325 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
326 + M('Next') + ' >></a>';
333 if (lastClkbl < pages)
336 s += '<div style="float: clear">'
337 + prev + predots + middle + postdots + next + '</div>';
345 function promoteRecords() {
346 team.queue("records").subscribe(function(data) {
348 for (var i = 0; i < data.hits.length; i++) {
349 var hit = data.hits[i];
350 html.push('<div class="record" id="mkwsRecdiv_' + team.name() + '_' + hit.recid + '" >',
353 // ### At some point, we may be able to move the
354 // m_currentRecordId and m_currentRecordData members
355 // from the team object into this widget.
356 if (hit.recid == team.currentRecordId()) {
357 if (team.currentRecordData())
358 html.push(team.renderDetails(team.currentRecordData()));
361 $(node).html(html.join(''));
363 function renderSummary(hit)
365 var template = team.loadTemplate("Summary");
366 hit._id = "mkwsRec_" + hit.recid;
367 hit._onclick = "mkws.showDetails('" + team.name() + "', this.id);return false;"
368 return template(hit);
374 function promoteNavi() {
375 team.queue("navi").subscribe(function() {
376 var filters = team.filters();
379 for (var i in filters) {
383 var filter = filters[i];
385 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
386 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
388 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
389 "', '" + filter.field + "', '" + filter.value + "'" +
390 ');return false;">' + filter.value + '</a>';
400 // Factory function for team objects. As much as possible, this uses
401 // only member variables (prefixed "m_") and inner functions with
402 // private scope. Some functions are visibl as member-functions to be
403 // called from outside code -- specifically, from generated
404 // HTML. These functions are that.switchView(), showDetails(),
405 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
406 // pagerPrev(), pagerNext(), showPage().
408 function team($, teamName) {
410 var m_teamName = teamName;
411 var m_submitted = false;
412 var m_query; // initially undefined
413 var m_sortOrder; // will be set below
414 var m_perpage; // will be set below
416 var m_totalRecordCount = 0;
417 var m_currentPage = 1;
418 var m_currentRecordId = '';
419 var m_currentRecordData = null;
421 // Timestamps for logging
425 var m_paz; // will be initialised below
428 that.name = function() { return m_teamName; }
429 that.perpage = function() { return m_perpage; }
430 that.totalRecordCount = function() { return m_totalRecordCount; }
431 that.currentPage = function() { return m_currentPage; }
432 that.currentRecordId = function() { return m_currentRecordId; }
433 that.currentRecordData = function() { return m_currentRecordData; }
434 that.filters = function() { return m_filters; }
436 var debug = function (s) {
438 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
439 m_debugTime.last = now;
441 mkws.debug(m_teamName + ": " + timestamp + s);
445 debug("start running MKWS");
447 m_sortOrder = mkws_config.sort_default;
448 m_perpage = mkws_config.perpage_default;
450 debug("Create main pz2 object");
451 // create a parameters array and pass it to the pz2's constructor
452 // then register the form submit event with the pz2.search function
453 // autoInit is set to true on default
454 m_paz = new pz2({ "windowid": teamName,
455 "pazpar2path": mkws_config.pazpar2_url,
456 "usesessions" : mkws_config.use_service_proxy ? false : true,
458 "onbytarget": onBytarget,
460 "onterm": (mkws_config.facets.length ? onTerm : undefined),
462 "onrecord": onRecord,
463 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
464 "termlist": mkws_config.facets.join(',')
469 // pz2.js event handlers:
478 function onBytarget(data) {
480 queue("targets").publish(data);
484 function onStat(data) {
486 queue("stat").publish(data);
490 function onTerm(data) {
492 queue("termlists").publish(data);
496 function onShow(data, teamName) {
498 m_totalRecordCount = data.merged;
499 queue("pager").publish(data);
500 queue("records").publish(data);
504 function onRecord(data, args, teamName) {
506 // FIXME: record is async!!
507 clearTimeout(m_paz.recordTimer);
508 // in case on_show was faster to redraw element
509 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
510 if (detRecordDiv) return;
511 m_currentRecordData = data;
512 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
513 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
514 var html = renderDetails(m_currentRecordData);
515 $(recordDiv).append(html);
519 that.targetFiltered = function(id) {
520 for (var i = 0; i < m_filters.length; i++) {
521 if (m_filters[i].id === id ||
522 m_filters[i].id === 'pz:id=' + id) {
530 ////////////////////////////////////////////////////////////////////////////////
531 ////////////////////////////////////////////////////////////////////////////////
534 // when search button pressed
535 function onFormSubmitEventHandler()
537 var val = findnode('.mkwsQuery').val();
543 function newSearch(query, sortOrder, targets)
545 debug("newSearch: " + query);
547 if (mkws_config.use_service_proxy && !mkws.authenticated) {
548 alert("searching before authentication");
556 triggerSearch(query, sortOrder, targets);
557 switchView('records'); // In case it's configured to start off as hidden
562 function onSortChange()
564 m_sortOrder = findnode('.mkwsSort').val();
565 if (!m_submitted) return false;
568 m_paz.show(0, m_perpage, m_sortOrder);
573 function onPerpageChange()
575 m_perpage = findnode('.mkwsPerpage').val();
576 if (!m_submitted) return false;
579 m_paz.show(0, m_perpage, m_sortOrder);
584 function redrawNavi ()
586 queue("navi").publish();
593 m_totalRecordCount = 0;
597 function loadSelect ()
599 var node = findnode('.mkwsSort');
600 if (node.length && node.val() != m_sortOrder) {
601 alert("m_sortOrder '" + m_sortOrder + "' != node.val() '" + node.val() + "'");
603 node = findnode('.mkwsPerpage');
604 if (node.length && node.val() != m_perpage) {
605 alert("m_perpage '" + m_perpage + "' != node.val() '" + node.val() + "'");
610 function triggerSearch (query, sortOrder, targets)
615 // Continue to use previous query/sort-order unless new ones are specified
620 m_sortOrder = sortOrder;
623 m_filters.push({ id: targets, name: targets });
626 for (var i in m_filters) {
627 var filter = m_filters[i];
631 if (filter.id.match(/^[a-z:]+[=~]/)) {
632 debug("filter '" + filter.id + "' already begins with SETTING OP");
634 filter.id = 'pz:id=' + filter.id;
636 pp2filter += filter.id;
640 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
646 params.limit = pp2limit;
649 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
651 // We can use: params.torusquery = "udb=NAME"
652 // Note: that won't work when running against raw pazpar2
653 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
657 // limit by target functions
658 that.limitTarget = function (id, name)
660 debug("limitTarget(id=" + id + ", name=" + name + ")");
661 m_filters.push({ id: id, name: name });
670 // limit the query after clicking the facet
671 that.limitQuery = function (field, value)
673 debug("limitQuery(field=" + field + ", value=" + value + ")");
674 m_filters.push({ field: field, value: value });
683 that.delimitTarget = function (id)
685 debug("delimitTarget(id=" + id + ")");
687 for (var i in m_filters) {
688 var filter = m_filters[i];
690 debug("delimitTarget() removing filter " + $.toJSON(filter));
692 debug("delimitTarget() keeping filter " + $.toJSON(filter));
693 newFilters.push(filter);
696 m_filters = newFilters;
706 that.delimitQuery = function (field, value)
708 debug("delimitQuery(field=" + field + ", value=" + value + ")");
710 for (var i in m_filters) {
711 var filter = m_filters[i];
713 field == filter.field &&
714 value == filter.value) {
715 debug("delimitQuery() removing filter " + $.toJSON(filter));
717 debug("delimitQuery() keeping filter " + $.toJSON(filter));
718 newFilters.push(filter);
721 m_filters = newFilters;
731 that.showPage = function (pageNum)
733 m_currentPage = pageNum;
734 m_paz.showPage(m_currentPage - 1);
738 // simple paging functions
739 that.pagerNext = function () {
740 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
747 that.pagerPrev = function () {
748 if (m_paz.showPrev() != false)
753 // switching view between targets and records
754 function switchView(view) {
755 var targets = findnode('.mkwsTargets');
756 var results = findnode('.mkwsResults,.mkwsRecords');
757 var blanket = findnode('.mkwsBlanket');
758 var motd = findnode('.mkwsMOTD');
762 if (targets) targets.css('display', 'block');
763 if (results) results.css('display', 'none');
764 if (blanket) blanket.css('display', 'none');
765 if (motd) motd.css('display', 'none');
768 if (targets) targets.css('display', 'none');
769 if (results) results.css('display', 'block');
770 if (blanket) blanket.css('display', 'block');
771 if (motd) motd.css('display', 'none');
774 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
775 if (targets) targets.css('display', 'none');
776 if (results) results.css('display', 'none');
777 if (blanket) blanket.css('display', 'none');
778 if (motd) motd.css('display', 'none');
781 alert("Unknown view '" + view + "'");
786 that.switchView = switchView;
789 // detailed record drawing
790 that.showDetails = function (prefixRecId) {
791 var recId = prefixRecId.replace('mkwsRec_', '');
792 var oldRecordId = m_currentRecordId;
793 m_currentRecordId = recId;
795 // remove current detailed view if any
796 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
799 detRecordDiv.parentNode.removeChild(detRecordDiv);
801 // if the same clicked, just hide
802 if (recId == oldRecordId) {
803 m_currentRecordId = '';
804 m_currentRecordData = null;
807 // request the record
808 debug("showDetails() requesting record '" + recId + "'");
814 * All the HTML stuff to render the search forms and
817 function mkwsHtmlAll() {
819 if (mkws_config.show_lang)
822 debug("HTML search form");
823 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
825 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
826 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
827 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
831 debug("HTML records");
832 // If the team has a .mkwsResults, populate it in the usual
833 // way. If not, assume that it's a smarter application that
834 // defines its own subcomponents, some or all of the
841 if (findnode(".mkwsResults").length) {
842 findnode(".mkwsResults").html('\
843 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
845 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
846 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
848 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
849 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
850 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
851 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
852 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
857 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
863 var node = findnode(".mkwsRanking");
865 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
866 if (mkws_config.show_sort) {
867 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
869 if (mkws_config.show_perpage) {
870 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
872 ranking_data += '</form>';
874 node.html(ranking_data);
880 node = findnode('.mkwsSearchForm');
882 node.submit(onFormSubmitEventHandler);
883 node = findnode('.mkwsSort');
885 node.change(onSortChange);
886 node = findnode('.mkwsPerpage');
888 node.change(onPerpageChange);
890 // on first page, hide the termlist
891 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
892 var motd = findnode(".mkwsMOTD");
893 var container = findnode(".mkwsMOTDContainer");
894 if (motd.length && container.length) {
895 // Move the MOTD from the provided element down into the container
896 motd.appendTo(container);
901 function mkwsSetLang() {
902 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
903 if (!lang || !mkws.locale_lang[lang]) {
904 mkws_config.lang = ""
906 mkws_config.lang = lang;
909 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
910 return mkws_config.lang;
914 /* create locale language menu */
915 function mkwsHtmlLang() {
916 var lang_default = "en";
917 var lang = mkws_config.lang || lang_default;
920 /* display a list of configured languages, or all */
921 var lang_options = mkws_config.lang_options || [];
922 var toBeIncluded = {};
923 for (var i = 0; i < lang_options.length; i++) {
924 toBeIncluded[lang_options[i]] = true;
927 for (var k in mkws.locale_lang) {
928 if (toBeIncluded[k] || lang_options.length == 0)
933 if (lang_options.length == 0 || toBeIncluded[lang_default])
934 list.push(lang_default);
936 debug("Language menu for: " + list.join(", "));
940 for(var i = 0; i < list.length; i++) {
947 data += ' <span>' + l + '</span> ';
949 data += ' <a href="?lang=' + l + '">' + l + '</a> '
953 findnode(".mkwsLang").html(data);
957 function mkwsHtmlSort() {
958 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
959 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
961 for(var i = 0; i < mkws_config.sort_options.length; i++) {
962 var opt = mkws_config.sort_options[i];
964 var val = opt.length == 1 ? opt[0] : opt[1];
966 sort_html += '<option value="' + key + '"';
967 if (m_sortOrder == key || m_sortOrder == val) {
968 sort_html += ' selected="selected"';
970 sort_html += '>' + M(val) + '</option>';
972 sort_html += '</select>';
978 function mkwsHtmlPerpage() {
979 debug("HTML perpage, m_perpage = " + m_perpage);
980 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
982 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
983 var key = mkws_config.perpage_options[i];
985 perpage_html += '<option value="' + key + '"';
986 if (key == m_perpage) {
987 perpage_html += ' selected="selected"';
989 perpage_html += '>' + key + '</option>';
991 perpage_html += '</select>';
997 function mkwsHtmlSwitch() {
998 debug("HTML switch for team " + m_teamName);
1000 var node = findnode(".mkwsSwitch");
1001 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1002 node.append($("<span/>", { text: " | " }));
1003 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1005 debug("HTML targets");
1006 var node = findnode(".mkwsTargets");
1008 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1009 No information available yet.\
1011 node.css("display", "none");
1015 that.runAutoSearch = function() {
1016 var node = findnode('.mkwsRecords,.mkwsTermlists');
1017 var query = node.attr('autosearch');
1021 if (query.match(/^!param!/)) {
1022 var param = query.replace(/^!param!/, '');
1023 query = mkws.getParameterByName(param);
1024 debug("obtained query '" + query + "' from param '" + param + "'");
1026 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1028 } else if (query.match(/^!path!/)) {
1029 var index = query.replace(/^!path!/, '');
1030 var path = window.location.pathname.split('/');
1031 query = path[path.length - index];
1032 debug("obtained query '" + query + "' from path-component '" + index + "'");
1034 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1038 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1040 var sortOrder = node.attr('sort');
1041 var targets = node.attr('targets');
1042 var s = "running auto search: '" + query + "'";
1043 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1044 if (targets) s += " in targets '" + targets + "'";
1047 newSearch(query, sortOrder, targets);
1051 // Translation function. At present, this is properly a
1052 // global-level function (hence the assignment to mkws.M) but we
1053 // want to make it per-team so different teams can operate in
1054 // different languages.
1057 var lang = mkws_config.lang;
1059 if (!lang || !mkws.locale_lang[lang])
1062 return mkws.locale_lang[lang][word] || word;
1064 mkws.M = M; // so the Handlebars helper can use it
1067 // Finds the node of the specified class within the current team
1068 // Multiple OR-clauses separated by commas are handled
1069 // More complex cases may not work
1071 function findnode(selector, teamName) {
1072 teamName = teamName || m_teamName;
1074 selector = $.map(selector.split(','), function(s, i) {
1075 return s + '.mkwsTeam_' + teamName;
1082 function renderDetails(data, marker)
1084 var template = loadTemplate("Record");
1085 var details = template(data);
1086 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1088 that.renderDetails = renderDetails;
1091 function loadTemplate(name)
1093 var template = m_template[name];
1095 if (template === undefined) {
1096 // Fall back to generic template if there is no team-specific one
1097 var node = findnode(".mkwsTemplate_" + name);
1099 node = findnode(".mkwsTemplate_" + name, "ALL");
1102 var source = node.html();
1104 source = mkws.defaultTemplate(name);
1107 template = Handlebars.compile(source);
1108 debug("compiled template '" + name + "'");
1109 m_template[name] = template;
1114 that.loadTemplate = loadTemplate;
1117 // The following PubSub code is modified from the jQuery manual:
1118 // https://api.jquery.com/jQuery.Callbacks/
1121 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1122 // team.queue("eventName").publish(arg1, arg2, ...);
1125 var queue = function(id) {
1127 var callbacks = $.Callbacks();
1129 publish: callbacks.fire,
1130 subscribe: callbacks.add,
1131 unsubscribe: callbacks.remove
1147 mkws_config.error = e.message;
1148 // alert(e.message);
1152 // Bizarrely, 'that' is just an empty hash. All its state is in
1153 // the closure variables defined earlier in this function.
1158 // wrapper to call team() after page load
1160 mkws.debug = function (string) {
1161 if (!mkws.debug_level)
1164 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1168 // you need to disable use strict at the top of the file!!!
1169 if (mkws.debug_level >= 3) {
1170 console.log(arguments.callee.caller);
1171 } else if (mkws.debug_level >= 2) {
1172 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1174 console.log(string);
1176 var debug = mkws.debug;
1179 mkws.handleNodeWithTeam = function(node, callback) {
1180 // First branch for DOM objects; second branch for jQuery objects
1181 var classes = node.className || node.attr('class');
1183 // For some reason, if we try to proceed when classes is
1184 // undefined, we don't get an error message, but this
1185 // function and its callers, up several stack level,
1186 // silently return. What a crock.
1187 mkws.debug("handleNodeWithTeam() called on node with no classes");
1190 var list = classes.split(/\s+/)
1193 for (var i = 0; i < list.length; i++) {
1194 var cname = list[i];
1195 if (cname.match(/^mkwsTeam_/)) {
1196 teamName = cname.replace(/^mkwsTeam_/, '');
1197 } else if (cname.match(/^mkws/)) {
1198 type = cname.replace(/^mkws/, '');
1201 callback.call(node, teamName, type);
1205 mkws.resizePage = function () {
1206 var list = ["mkwsSwitch", "mkwsLang"];
1208 var width = mkws_config.responsive_design_width;
1209 var parent = $(".mkwsTermlists").parent();
1211 if ($(window).width() <= width &&
1212 parent.hasClass("mkwsTermlistContainer1")) {
1213 debug("changing from wide to narrow: " + $(window).width());
1214 $(".mkwsTermlistContainer1").hide();
1215 $(".mkwsTermlistContainer2").show();
1216 for (var tname in mkws.teams) {
1217 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1218 for(var i = 0; i < list.length; i++) {
1219 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1222 } else if ($(window).width() > width &&
1223 parent.hasClass("mkwsTermlistContainer2")) {
1224 debug("changing from narrow to wide: " + $(window).width());
1225 $(".mkwsTermlistContainer1").show();
1226 $(".mkwsTermlistContainer2").hide();
1227 for (var tname in mkws.teams) {
1228 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1229 for(var i = 0; i < list.length; i++) {
1230 $("." + list[i] + ".mkwsTeam_" + tname).show();
1237 mkws.switchView = function(tname, view) {
1238 mkws.teams[tname].switchView(view);
1241 mkws.showDetails = function (tname, prefixRecId) {
1242 mkws.teams[tname].showDetails(prefixRecId);
1245 mkws.limitTarget = function (tname, id, name) {
1246 mkws.teams[tname].limitTarget(id, name);
1249 mkws.limitQuery = function (tname, field, value) {
1250 mkws.teams[tname].limitQuery(field, value);
1253 mkws.delimitTarget = function (tname, id) {
1254 mkws.teams[tname].delimitTarget(id);
1257 mkws.delimitQuery = function (tname, field, value) {
1258 mkws.teams[tname].delimitQuery(field, value);
1261 mkws.showPage = function (tname, pageNum) {
1262 mkws.teams[tname].showPage(pageNum);
1265 mkws.pagerPrev = function (tname) {
1266 mkws.teams[tname].pagerPrev();
1269 mkws.pagerNext = function (tname) {
1270 mkws.teams[tname].pagerNext();
1274 // This function is taken from a StackOverflow answer
1275 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1276 mkws.getParameterByName = function(name) {
1277 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1278 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1279 results = regex.exec(location.search);
1280 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1284 mkws.defaultTemplate = function(name)
1286 if (name === 'Record') {
1290 <th>{{translate "Title"}}</th>\
1293 {{#if md-title-remainder}}\
1294 ({{md-title-remainder}})\
1296 {{#if md-title-responsibility}}\
1297 <i>{{md-title-responsibility}}</i>\
1303 <th>{{translate "Date"}}</th>\
1304 <td>{{md-date}}</td>\
1309 <th>{{translate "Author"}}</th>\
1310 <td>{{md-author}}</td>\
1313 {{#if md-electronic-url}}\
1315 <th>{{translate "Links"}}</th>\
1317 {{#each md-electronic-url}}\
1318 <a href="{{this}}">Link{{index1}}</a>\
1323 {{#if-any location having="md-subject"}}\
1325 <th>{{translate "Subject"}}</th>\
1327 {{#first location having="md-subject"}}\
1329 {{#commaList md-subject}}\
1330 {{this}}{{/commaList}}\
1337 <th>{{translate "Locations"}}</th>\
1339 {{#commaList location}}\
1340 {{attr "@name"}}{{/commaList}}\
1345 } else if (name === "Summary") {
1347 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1348 <b>{{md-title}}</b>\
1350 {{#if md-title-remainder}}\
1351 <span>{{md-title-remainder}}</span>\
1353 {{#if md-title-responsibility}}\
1354 <span><i>{{md-title-responsibility}}</i></span>\
1359 var s = "There is no default '" + name +"' template!";
1365 function defaultMkwsConfig() {
1366 /* default mkws config */
1367 var config_default = {
1368 use_service_proxy: true,
1369 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1370 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1372 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1373 perpage_options: [10, 20, 30, 50],
1374 sort_default: "relevance",
1375 perpage_default: 20,
1377 show_lang: true, /* show/hide language menu */
1378 show_sort: true, /* show/hide sort menu */
1379 show_perpage: true, /* show/hide perpage menu */
1380 lang_options: [], /* display languages links for given languages, [] for all */
1381 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1382 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1383 debug_level: 1, /* debug level for development: 0..2 */
1388 /* Set global debug_level flag early so that debug() works */
1389 if (typeof mkws_config.debug_level !== 'undefined') {
1390 mkws.debug_level = mkws_config.debug_level;
1391 } else if (typeof config_default.debug_level !== 'undefined') {
1392 mkws.debug_level = config_default.debug_level;
1395 // make sure the mkws_config is a valid hash
1396 if (!$.isPlainObject(mkws_config)) {
1397 debug("ERROR: mkws_config is not an JS object, ignore it....");
1401 /* override standard config values by function parameters */
1402 for (var k in config_default) {
1403 if (typeof mkws_config[k] === 'undefined')
1404 mkws_config[k] = config_default[k];
1405 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1411 * Run service-proxy authentication in background (after page load).
1412 * The username/password is configured in the apache config file
1415 function authenticateSession(auth_url, auth_domain, pp2_url) {
1416 debug("Run service proxy auth URL: " + auth_url);
1419 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1420 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1423 var request = new pzHttpRequest(auth_url, function(err) {
1424 alert("HTTP call for authentication failed: " + err)
1428 request.get(null, function(data) {
1429 if (!$.isXMLDoc(data)) {
1430 alert("service proxy auth response document is not valid XML document, give up!");
1433 var status = $(data).find("status");
1434 if (status.text() != "OK") {
1435 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1439 debug("Service proxy auth successfully done");
1440 mkws.authenticated = true;
1446 function runAutoSearches() {
1447 debug("running auto searches");
1449 for (var teamName in mkws.teams) {
1450 mkws.teams[teamName].runAutoSearch();
1455 $(document).ready(function() {
1456 debug("on load ready");
1457 defaultMkwsConfig();
1459 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1460 debug("Reset query width: " + mkws_config.query_width);
1461 mkws_config.query_width = 50;
1464 for (var key in mkws_config) {
1465 if (mkws_config.hasOwnProperty(key)) {
1466 if (key.match(/^language_/)) {
1467 var lang = key.replace(/^language_/, "");
1468 // Copy custom languages into list
1469 mkws.locale_lang[lang] = mkws_config[key];
1470 debug("Added locally configured language '" + lang + "'");
1475 if (mkws_config.responsive_design_width) {
1476 // Responsive web design - change layout on the fly based on
1477 // current screen width. Required for mobile devices.
1478 $(window).resize(function(e) { mkws.resizePage() });
1479 // initial check after page load
1480 $(document).ready(function() { mkws.resizePage() });
1483 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1484 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1485 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1486 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1489 // Backwards compatibility: set new magic class names on any
1490 // elements that have the old magic IDs.
1491 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1492 "Results", "Records", "Targets", "Ranking",
1493 "Termlists", "Stat", "MOTD" ];
1494 for (var i = 0; i < ids.length; i++) {
1495 var id = 'mkws' + ids[i];
1496 var node = $('#' + id);
1497 if (node.attr('id')) {
1499 debug("added magic class to '" + node.attr('id') + "'");
1503 // For all MKWS-classed nodes that don't have a team
1504 // specified, set the team to AUTO.
1505 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1506 if (!this.className.match(/mkwsTeam_/)) {
1507 debug("adding AUTO team to node with class '" + this.className + "'");
1508 $(this).addClass('mkwsTeam_AUTO');
1512 // Find all nodes with an MKWS class, and determine their team from
1513 // the mkwsTeam_* class. Make all team objects.
1515 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1516 mkws.handleNodeWithTeam(this, function(tname, type) {
1517 if (!mkws.teams[tname]) {
1518 mkws.teams[tname] = team(j, tname);
1519 debug("Made MKWS team '" + tname + "'");
1523 // Second pass: make the individual widget objects. This has
1524 // to be done separately, and after the team-creation, since
1525 // that sometimes makes new widget nodes (e.g. creating
1526 // mkwsTermlists inside mkwsResults.
1527 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1528 mkws.handleNodeWithTeam(this, function(tname, type) {
1529 var myTeam = mkws.teams[tname];
1530 var myWidget = widget(j, myTeam, type, this);
1534 debug("Walking MKWS nodes took " + (now-then) + " ms");
1536 if (mkws_config.use_service_proxy) {
1537 authenticateSession(mkws_config.service_proxy_auth,
1538 mkws_config.service_proxy_auth_domain,
1539 mkws_config.pazpar2_url);