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) {
161 if (type === 'Targets') {
163 } else if (type === 'Stat') {
165 } else if (type === 'Termlists') {
167 } else if (type === 'Pager') {
170 // ### Handle other types here
173 mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
177 // Functions follow for promoting the regular widget object into
178 // widgets of specific types. These could be moved outside of the
179 // widget object, or even into their own source files.
181 function promoteTargets() {
182 team.queue("targets").subscribe(function(data) {
183 if (node.length === 0) alert("huh?!");
185 var table ='<table><thead><tr>' +
186 '<td>' + M('Target ID') + '</td>' +
187 '<td>' + M('Hits') + '</td>' +
188 '<td>' + M('Diags') + '</td>' +
189 '<td>' + M('Records') + '</td>' +
190 '<td>' + M('State') + '</td>' +
191 '</tr></thead><tbody>';
193 for (var i = 0; i < data.length; i++) {
194 table += "<tr><td>" + data[i].id +
195 "</td><td>" + data[i].hits +
196 "</td><td>" + data[i].diagnostic +
197 "</td><td>" + data[i].records +
198 "</td><td>" + data[i].state + "</td></tr>";
201 table += '</tbody></table>';
202 var subnode = $(node).children('.mkwsBytarget');
208 function promoteStat() {
209 team.queue("stat").subscribe(function(data) {
210 if (node.length === 0) alert("huh?!");
212 $(node).html('<span class="head">' + M('Status info') + '</span>' +
214 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
216 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
221 function promoteTermlists() {
222 team.queue("termlists").subscribe(function(data) {
223 mkws.debug("in termlist consumer");
225 alert("termlists event when there are no termlists");
229 // no facets: this should never happen
230 if (!mkws_config.facets || mkws_config.facets.length == 0) {
231 alert("onTerm called even though we have no facets: " + $.toJSON(data));
236 // display if we first got results
240 acc.push('<div class="title">' + M('Termlists') + '</div>');
241 var facets = mkws_config.facets;
243 for (var i = 0; i < facets.length; i++) {
244 if (facets[i] == "xtargets") {
245 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
246 } else if (facets[i] == "subject") {
247 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
248 } else if (facets[i] == "author") {
249 addSingleFacet(acc, "Authors", data.author, 10, "author");
251 alert("bad facet configuration: '" + facets[i] + "'");
255 $(node).html(acc.join(''));
257 function addSingleFacet(acc, caption, data, max, pzIndex) {
258 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
259 acc.push('<div class="termtitle">' + M(caption) + '</div>');
260 for (var i = 0; i < data.length && i < max; i++) {
261 acc.push('<div class="term">');
262 acc.push('<a href="#" ');
265 // Special case: target selection
266 acc.push('target_id='+data[i].id+' ');
267 if (!team.targetFiltered(data[i].id)) {
268 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
271 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
273 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
274 + ' <span>' + data[i].freq + '</span>');
283 function promotePager() {
284 team.queue("pager").subscribe(function(data) {
286 $(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>';
346 // Factory function for team objects. As much as possible, this uses
347 // only member variables (prefixed "m_") and inner functions with
348 // private scope. Some functions are visibl as member-functions to be
349 // called from outside code -- specifically, from generated
350 // HTML. These functions are that.switchView(), showDetails(),
351 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
352 // pagerPrev(), pagerNext(), showPage().
354 function team($, teamName) {
356 var m_teamName = teamName;
357 var m_submitted = false;
358 var m_query; // initially undefined
359 var m_sortOrder; // will be set below
360 var m_perpage; // will be set below
362 var m_totalRecordCount = 0;
363 var m_currentPage = 1;
364 var m_currentRecordId = '';
365 var m_currentRecordData = null;
367 // Timestamps for logging
371 var m_paz; // will be initialised below
374 that.name = function() { return m_teamName; }
375 that.perpage = function() { return m_perpage; }
376 that.totalRecordCount = function() { return m_totalRecordCount; }
377 that.currentPage = function() { return m_currentPage; }
379 var debug = function (s) {
381 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
382 m_debugTime.last = now;
384 mkws.debug(m_teamName + ": " + timestamp + s);
387 debug("start running MKWS");
389 m_sortOrder = mkws_config.sort_default;
390 m_perpage = mkws_config.perpage_default;
392 debug("Create main pz2 object");
393 // create a parameters array and pass it to the pz2's constructor
394 // then register the form submit event with the pz2.search function
395 // autoInit is set to true on default
396 m_paz = new pz2({ "windowid": teamName,
397 "pazpar2path": mkws_config.pazpar2_url,
398 "usesessions" : mkws_config.use_service_proxy ? false : true,
400 "onbytarget": onBytarget,
402 "onterm": (mkws_config.facets.length ? onTerm : undefined),
404 "onrecord": onRecord,
405 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
406 "termlist": mkws_config.facets.join(',')
411 // pz2.js event handlers:
420 function onBytarget(data) {
422 queue("targets").publish(data);
426 function onStat(data) {
428 queue("stat").publish(data);
432 function onTerm(data) {
434 queue("termlists").publish(data);
438 function onShow(data, teamName) {
440 m_totalRecordCount = data.merged;
442 queue("pager").publish(data);
444 var results = findnode(".mkwsRecords");
449 for (var i = 0; i < data.hits.length; i++) {
450 var hit = data.hits[i];
451 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
454 if (hit.recid == m_currentRecordId) {
455 if (m_currentRecordData)
456 html.push(renderDetails(m_currentRecordData));
459 results.html(html.join(''));
463 function onRecord(data, args, teamName) {
465 // FIXME: record is async!!
466 clearTimeout(m_paz.recordTimer);
467 // in case on_show was faster to redraw element
468 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
469 if (detRecordDiv) return;
470 m_currentRecordData = data;
471 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
472 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
473 var html = renderDetails(m_currentRecordData);
474 $(recordDiv).append(html);
478 that.targetFiltered = function(id) {
479 for (var i = 0; i < m_filters.length; i++) {
480 if (m_filters[i].id === id ||
481 m_filters[i].id === 'pz:id=' + id) {
489 ////////////////////////////////////////////////////////////////////////////////
490 ////////////////////////////////////////////////////////////////////////////////
493 // when search button pressed
494 function onFormSubmitEventHandler()
496 var val = findnode('.mkwsQuery').val();
502 function newSearch(query, sortOrder, targets)
504 debug("newSearch: " + query);
506 if (mkws_config.use_service_proxy && !mkws.authenticated) {
507 alert("searching before authentication");
515 triggerSearch(query, sortOrder, targets);
516 switchView('records'); // In case it's configured to start off as hidden
521 function onSelectDdChange()
523 if (!m_submitted) return false;
526 m_paz.show(0, m_perpage, m_sortOrder);
531 function redrawNavi ()
533 var navi = findnode('.mkwsNavi');
537 for (var i in m_filters) {
541 var filter = m_filters[i];
543 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
544 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
546 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
547 "', '" + filter.field + "', '" + filter.value + "'" +
548 ');return false;">' + filter.value + '</a>';
559 m_totalRecordCount = 0;
563 function loadSelect ()
565 var node = findnode('.mkwsSort');
566 if (node.length && node.val() != m_sortOrder) {
567 debug("changing m_sortOrder from " + m_sortOrder + " to " + node.val());
568 m_sortOrder = node.val();
570 node = findnode('.mkwsPerpage');
571 if (node.length && node.val() != m_perpage) {
572 debug("changing m_perpage from " + m_perpage + " to " + node.val());
573 m_perpage = node.val();
578 function triggerSearch (query, sortOrder, targets)
583 // Continue to use previous query/sort-order unless new ones are specified
588 m_sortOrder = sortOrder;
591 m_filters.push({ id: targets, name: targets });
594 for (var i in m_filters) {
595 var filter = m_filters[i];
599 if (filter.id.match(/^[a-z:]+[=~]/)) {
600 debug("filter '" + filter.id + "' already begins with SETTING OP");
602 filter.id = 'pz:id=' + filter.id;
604 pp2filter += filter.id;
608 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
614 params.limit = pp2limit;
617 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
619 // We can use: params.torusquery = "udb=NAME"
620 // Note: that won't work when running against raw pazpar2
621 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
625 // limit by target functions
626 that.limitTarget = function (id, name)
628 debug("limitTarget(id=" + id + ", name=" + name + ")");
629 m_filters.push({ id: id, name: name });
638 // limit the query after clicking the facet
639 that.limitQuery = function (field, value)
641 debug("limitQuery(field=" + field + ", value=" + value + ")");
642 m_filters.push({ field: field, value: value });
651 that.delimitTarget = function (id)
653 debug("delimitTarget(id=" + id + ")");
655 for (var i in m_filters) {
656 var filter = m_filters[i];
658 debug("delimitTarget() removing filter " + $.toJSON(filter));
660 debug("delimitTarget() keeping filter " + $.toJSON(filter));
661 newFilters.push(filter);
664 m_filters = newFilters;
674 that.delimitQuery = function (field, value)
676 debug("delimitQuery(field=" + field + ", value=" + value + ")");
678 for (var i in m_filters) {
679 var filter = m_filters[i];
681 field == filter.field &&
682 value == filter.value) {
683 debug("delimitQuery() removing filter " + $.toJSON(filter));
685 debug("delimitQuery() keeping filter " + $.toJSON(filter));
686 newFilters.push(filter);
689 m_filters = newFilters;
699 that.showPage = function (pageNum)
701 m_currentPage = pageNum;
702 m_paz.showPage(m_currentPage - 1);
706 // simple paging functions
707 that.pagerNext = function () {
708 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
715 that.pagerPrev = function () {
716 if (m_paz.showPrev() != false)
721 // switching view between targets and records
722 function switchView(view) {
723 var targets = findnode('.mkwsTargets');
724 var results = findnode('.mkwsResults,.mkwsRecords');
725 var blanket = findnode('.mkwsBlanket');
726 var motd = findnode('.mkwsMOTD');
730 if (targets) targets.css('display', 'block');
731 if (results) results.css('display', 'none');
732 if (blanket) blanket.css('display', 'none');
733 if (motd) motd.css('display', 'none');
736 if (targets) targets.css('display', 'none');
737 if (results) results.css('display', 'block');
738 if (blanket) blanket.css('display', 'block');
739 if (motd) motd.css('display', 'none');
742 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
743 if (targets) targets.css('display', 'none');
744 if (results) results.css('display', 'none');
745 if (blanket) blanket.css('display', 'none');
746 if (motd) motd.css('display', 'none');
749 alert("Unknown view '" + view + "'");
754 that.switchView = switchView;
757 // detailed record drawing
758 that.showDetails = function (prefixRecId) {
759 var recId = prefixRecId.replace('mkwsRec_', '');
760 var oldRecordId = m_currentRecordId;
761 m_currentRecordId = recId;
763 // remove current detailed view if any
764 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
767 detRecordDiv.parentNode.removeChild(detRecordDiv);
769 // if the same clicked, just hide
770 if (recId == oldRecordId) {
771 m_currentRecordId = '';
772 m_currentRecordData = null;
775 // request the record
776 debug("showDetails() requesting record '" + recId + "'");
782 * All the HTML stuff to render the search forms and
785 function mkwsHtmlAll() {
787 if (mkws_config.show_lang)
790 debug("HTML search form");
791 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
793 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
794 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
795 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
799 debug("HTML records");
800 // If the team has a .mkwsResults, populate it in the usual
801 // way. If not, assume that it's a smarter application that
802 // defines its own subcomponents, some or all of the
809 if (findnode(".mkwsResults").length) {
810 findnode(".mkwsResults").html('\
811 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
813 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
814 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
816 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
817 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
818 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
819 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
820 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
825 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
831 var node = findnode(".mkwsRanking");
833 var ranking_data = '';
834 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
835 if (mkws_config.show_sort) {
836 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
838 if (mkws_config.show_perpage) {
839 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
841 ranking_data += '</form>';
843 node.html(ranking_data);
849 node = findnode('.mkwsSearchForm');
851 node.submit(onFormSubmitEventHandler);
852 node = findnode('.mkwsSort');
854 node.change(onSelectDdChange);
855 node = findnode('.mkwsPerpage');
857 node.change(onSelectDdChange);
859 // on first page, hide the termlist
860 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
861 var motd = findnode(".mkwsMOTD");
862 var container = findnode(".mkwsMOTDContainer");
863 if (motd.length && container.length) {
864 // Move the MOTD from the provided element down into the container
865 motd.appendTo(container);
870 function mkwsSetLang() {
871 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
872 if (!lang || !mkws.locale_lang[lang]) {
873 mkws_config.lang = ""
875 mkws_config.lang = lang;
878 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
879 return mkws_config.lang;
883 /* create locale language menu */
884 function mkwsHtmlLang() {
885 var lang_default = "en";
886 var lang = mkws_config.lang || lang_default;
889 /* display a list of configured languages, or all */
890 var lang_options = mkws_config.lang_options || [];
891 var toBeIncluded = {};
892 for (var i = 0; i < lang_options.length; i++) {
893 toBeIncluded[lang_options[i]] = true;
896 for (var k in mkws.locale_lang) {
897 if (toBeIncluded[k] || lang_options.length == 0)
902 if (lang_options.length == 0 || toBeIncluded[lang_default])
903 list.push(lang_default);
905 debug("Language menu for: " + list.join(", "));
909 for(var i = 0; i < list.length; i++) {
916 data += ' <span>' + l + '</span> ';
918 data += ' <a href="?lang=' + l + '">' + l + '</a> '
922 findnode(".mkwsLang").html(data);
926 function mkwsHtmlSort() {
927 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
928 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
930 for(var i = 0; i < mkws_config.sort_options.length; i++) {
931 var opt = mkws_config.sort_options[i];
933 var val = opt.length == 1 ? opt[0] : opt[1];
935 sort_html += '<option value="' + key + '"';
936 if (m_sortOrder == key || m_sortOrder == val) {
937 sort_html += ' selected="selected"';
939 sort_html += '>' + M(val) + '</option>';
941 sort_html += '</select>';
947 function mkwsHtmlPerpage() {
948 debug("HTML perpage, m_perpage = " + m_perpage);
949 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
951 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
952 var key = mkws_config.perpage_options[i];
954 perpage_html += '<option value="' + key + '"';
955 if (key == m_perpage) {
956 perpage_html += ' selected="selected"';
958 perpage_html += '>' + key + '</option>';
960 perpage_html += '</select>';
966 function mkwsHtmlSwitch() {
967 debug("HTML switch for team " + m_teamName);
969 var node = findnode(".mkwsSwitch");
970 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
971 node.append($("<span/>", { text: " | " }));
972 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
974 debug("HTML targets");
975 var node = findnode(".mkwsTargets");
977 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
978 No information available yet.\
980 node.css("display", "none");
984 that.runAutoSearch = function() {
985 var node = findnode('.mkwsRecords,.mkwsTermlists');
986 var query = node.attr('autosearch');
990 if (query.match(/^!param!/)) {
991 var param = query.replace(/^!param!/, '');
992 query = mkws.getParameterByName(param);
993 debug("obtained query '" + query + "' from param '" + param + "'");
995 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
997 } else if (query.match(/^!path!/)) {
998 var index = query.replace(/^!path!/, '');
999 var path = window.location.pathname.split('/');
1000 query = path[path.length - index];
1001 debug("obtained query '" + query + "' from path-component '" + index + "'");
1003 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1007 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1009 var sortOrder = node.attr('sort');
1010 var targets = node.attr('targets');
1011 var s = "running auto search: '" + query + "'";
1012 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1013 if (targets) s += " in targets '" + targets + "'";
1016 newSearch(query, sortOrder, targets);
1020 // Translation function. At present, this is properly a
1021 // global-level function (hence the assignment to mkws.M) but we
1022 // want to make it per-team so different teams can operate in
1023 // different languages.
1026 var lang = mkws_config.lang;
1028 if (!lang || !mkws.locale_lang[lang])
1031 return mkws.locale_lang[lang][word] || word;
1033 mkws.M = M; // so the Handlebars helper can use it
1036 // Finds the node of the specified class within the current team
1037 // Multiple OR-clauses separated by commas are handled
1038 // More complex cases may not work
1040 function findnode(selector, teamName) {
1041 teamName = teamName || m_teamName;
1043 selector = $.map(selector.split(','), function(s, i) {
1044 return s + '.mkwsTeam_' + teamName;
1051 function renderSummary(hit)
1053 var template = loadTemplate("Summary");
1054 hit._id = "mkwsRec_" + hit.recid;
1055 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
1056 return template(hit);
1060 function renderDetails(data, marker)
1062 var template = loadTemplate("Record");
1063 var details = template(data);
1064 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1068 function loadTemplate(name)
1070 var template = m_template[name];
1072 if (template === undefined) {
1073 // Fall back to generic template if there is no team-specific one
1074 var node = findnode(".mkwsTemplate_" + name);
1076 node = findnode(".mkwsTemplate_" + name, "ALL");
1079 var source = node.html();
1081 source = mkws.defaultTemplate(name);
1084 template = Handlebars.compile(source);
1085 debug("compiled template '" + name + "'");
1086 m_template[name] = template;
1093 // The following PubSub code is modified from the jQuery manual:
1094 // https://api.jquery.com/jQuery.Callbacks/
1097 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1098 // team.queue("eventName").publish(arg1, arg2, ...);
1101 var queue = function(id) {
1103 var callbacks = $.Callbacks();
1105 publish: callbacks.fire,
1106 subscribe: callbacks.add,
1107 unsubscribe: callbacks.remove
1123 mkws_config.error = e.message;
1124 // alert(e.message);
1128 // Bizarrely, 'that' is just an empty hash. All its state is in
1129 // the closure variables defined earlier in this function.
1134 // wrapper to call team() after page load
1136 mkws.debug = function (string) {
1137 if (!mkws.debug_level)
1140 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1144 // you need to disable use strict at the top of the file!!!
1145 if (mkws.debug_level >= 3) {
1146 console.log(arguments.callee.caller);
1147 } else if (mkws.debug_level >= 2) {
1148 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1150 console.log(string);
1152 var debug = mkws.debug;
1155 mkws.handleNodeWithTeam = function(node, callback) {
1156 // First branch for DOM objects; second branch for jQuery objects
1157 var classes = node.className || node.attr('class');
1159 // For some reason, if we try to proceed when classes is
1160 // undefined, we don't get an error message, but this
1161 // function and its callers, up several stack level,
1162 // silently return. What a crock.
1163 mkws.debug("handleNodeWithTeam() called on node with no classes");
1166 var list = classes.split(/\s+/)
1169 for (var i = 0; i < list.length; i++) {
1170 var cname = list[i];
1171 if (cname.match(/^mkwsTeam_/)) {
1172 teamName = cname.replace(/^mkwsTeam_/, '');
1173 } else if (cname.match(/^mkws/)) {
1174 type = cname.replace(/^mkws/, '');
1177 callback.call(node, teamName, type);
1181 mkws.resizePage = function () {
1182 var list = ["mkwsSwitch", "mkwsLang"];
1184 var width = mkws_config.responsive_design_width;
1185 var parent = $(".mkwsTermlists").parent();
1187 if ($(window).width() <= width &&
1188 parent.hasClass("mkwsTermlistContainer1")) {
1189 debug("changing from wide to narrow: " + $(window).width());
1190 $(".mkwsTermlistContainer1").hide();
1191 $(".mkwsTermlistContainer2").show();
1192 for (var tname in mkws.teams) {
1193 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1194 for(var i = 0; i < list.length; i++) {
1195 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1198 } else if ($(window).width() > width &&
1199 parent.hasClass("mkwsTermlistContainer2")) {
1200 debug("changing from narrow to wide: " + $(window).width());
1201 $(".mkwsTermlistContainer1").show();
1202 $(".mkwsTermlistContainer2").hide();
1203 for (var tname in mkws.teams) {
1204 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1205 for(var i = 0; i < list.length; i++) {
1206 $("." + list[i] + ".mkwsTeam_" + tname).show();
1213 mkws.switchView = function(tname, view) {
1214 mkws.teams[tname].switchView(view);
1217 mkws.showDetails = function (tname, prefixRecId) {
1218 mkws.teams[tname].showDetails(prefixRecId);
1221 mkws.limitTarget = function (tname, id, name) {
1222 mkws.teams[tname].limitTarget(id, name);
1225 mkws.limitQuery = function (tname, field, value) {
1226 mkws.teams[tname].limitQuery(field, value);
1229 mkws.delimitTarget = function (tname, id) {
1230 mkws.teams[tname].delimitTarget(id);
1233 mkws.delimitQuery = function (tname, field, value) {
1234 mkws.teams[tname].delimitQuery(field, value);
1237 mkws.showPage = function (tname, pageNum) {
1238 mkws.teams[tname].showPage(pageNum);
1241 mkws.pagerPrev = function (tname) {
1242 mkws.teams[tname].pagerPrev();
1245 mkws.pagerNext = function (tname) {
1246 mkws.teams[tname].pagerNext();
1250 // This function is taken from a StackOverflow answer
1251 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1252 mkws.getParameterByName = function(name) {
1253 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1254 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1255 results = regex.exec(location.search);
1256 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1260 mkws.defaultTemplate = function(name)
1262 if (name === 'Record') {
1266 <th>{{translate "Title"}}</th>\
1269 {{#if md-title-remainder}}\
1270 ({{md-title-remainder}})\
1272 {{#if md-title-responsibility}}\
1273 <i>{{md-title-responsibility}}</i>\
1279 <th>{{translate "Date"}}</th>\
1280 <td>{{md-date}}</td>\
1285 <th>{{translate "Author"}}</th>\
1286 <td>{{md-author}}</td>\
1289 {{#if md-electronic-url}}\
1291 <th>{{translate "Links"}}</th>\
1293 {{#each md-electronic-url}}\
1294 <a href="{{this}}">Link{{index1}}</a>\
1299 {{#if-any location having="md-subject"}}\
1301 <th>{{translate "Subject"}}</th>\
1303 {{#first location having="md-subject"}}\
1305 {{#commaList md-subject}}\
1306 {{this}}{{/commaList}}\
1313 <th>{{translate "Locations"}}</th>\
1315 {{#commaList location}}\
1316 {{attr "@name"}}{{/commaList}}\
1321 } else if (name === "Summary") {
1323 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1324 <b>{{md-title}}</b>\
1326 {{#if md-title-remainder}}\
1327 <span>{{md-title-remainder}}</span>\
1329 {{#if md-title-responsibility}}\
1330 <span><i>{{md-title-responsibility}}</i></span>\
1335 var s = "There is no default '" + name +"' template!";
1341 function defaultMkwsConfig() {
1342 /* default mkws config */
1343 var config_default = {
1344 use_service_proxy: true,
1345 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1346 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1348 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1349 perpage_options: [10, 20, 30, 50],
1350 sort_default: "relevance",
1351 perpage_default: 20,
1353 show_lang: true, /* show/hide language menu */
1354 show_sort: true, /* show/hide sort menu */
1355 show_perpage: true, /* show/hide perpage menu */
1356 lang_options: [], /* display languages links for given languages, [] for all */
1357 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1358 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1359 debug_level: 1, /* debug level for development: 0..2 */
1364 /* Set global debug_level flag early so that debug() works */
1365 if (typeof mkws_config.debug_level !== 'undefined') {
1366 mkws.debug_level = mkws_config.debug_level;
1367 } else if (typeof config_default.debug_level !== 'undefined') {
1368 mkws.debug_level = config_default.debug_level;
1371 // make sure the mkws_config is a valid hash
1372 if (!$.isPlainObject(mkws_config)) {
1373 debug("ERROR: mkws_config is not an JS object, ignore it....");
1377 /* override standard config values by function parameters */
1378 for (var k in config_default) {
1379 if (typeof mkws_config[k] === 'undefined')
1380 mkws_config[k] = config_default[k];
1381 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1387 * Run service-proxy authentication in background (after page load).
1388 * The username/password is configured in the apache config file
1391 function authenticateSession(auth_url, auth_domain, pp2_url) {
1392 debug("Run service proxy auth URL: " + auth_url);
1395 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1396 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1399 var request = new pzHttpRequest(auth_url, function(err) {
1400 alert("HTTP call for authentication failed: " + err)
1404 request.get(null, function(data) {
1405 if (!$.isXMLDoc(data)) {
1406 alert("service proxy auth response document is not valid XML document, give up!");
1409 var status = $(data).find("status");
1410 if (status.text() != "OK") {
1411 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1415 debug("Service proxy auth successfully done");
1416 mkws.authenticated = true;
1422 function runAutoSearches() {
1423 debug("running auto searches");
1425 for (var teamName in mkws.teams) {
1426 mkws.teams[teamName].runAutoSearch();
1431 $(document).ready(function() {
1432 debug("on load ready");
1433 defaultMkwsConfig();
1435 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1436 debug("Reset query width: " + mkws_config.query_width);
1437 mkws_config.query_width = 50;
1440 for (var key in mkws_config) {
1441 if (mkws_config.hasOwnProperty(key)) {
1442 if (key.match(/^language_/)) {
1443 var lang = key.replace(/^language_/, "");
1444 // Copy custom languages into list
1445 mkws.locale_lang[lang] = mkws_config[key];
1446 debug("Added locally configured language '" + lang + "'");
1451 if (mkws_config.responsive_design_width) {
1452 // Responsive web design - change layout on the fly based on
1453 // current screen width. Required for mobile devices.
1454 $(window).resize(function(e) { mkws.resizePage() });
1455 // initial check after page load
1456 $(document).ready(function() { mkws.resizePage() });
1459 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1460 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1461 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1462 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1465 // Backwards compatibility: set new magic class names on any
1466 // elements that have the old magic IDs.
1467 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1468 "Results", "Records", "Targets", "Ranking",
1469 "Termlists", "Stat", "MOTD" ];
1470 for (var i = 0; i < ids.length; i++) {
1471 var id = 'mkws' + ids[i];
1472 var node = $('#' + id);
1473 if (node.attr('id')) {
1475 debug("added magic class to '" + node.attr('id') + "'");
1479 // For all MKWS-classed nodes that don't have a team
1480 // specified, set the team to AUTO.
1481 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1482 if (!this.className.match(/mkwsTeam_/)) {
1483 debug("adding AUTO team to node with class '" + this.className + "'");
1484 $(this).addClass('mkwsTeam_AUTO');
1488 // Find all nodes with an MKWS class, and determine their team from
1489 // the mkwsTeam_* class. Make all team objects.
1491 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1492 mkws.handleNodeWithTeam(this, function(tname, type) {
1493 if (!mkws.teams[tname]) {
1494 mkws.teams[tname] = team(j, tname);
1495 debug("Made MKWS team '" + tname + "'");
1499 // Second pass: make the individual widget objects. This has
1500 // to be done separately, and after the team-creation, since
1501 // that sometimes makes new widget nodes (e.g. creating
1502 // mkwsTermlists instead mkwsResults.
1503 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1504 mkws.handleNodeWithTeam(this, function(tname, type) {
1505 var myTeam = mkws.teams[tname];
1506 var myWidget = widget(j, myTeam, type, this);
1510 debug("Walking MKWS nodes took " + (now-then) + " ms");
1512 if (mkws_config.use_service_proxy) {
1513 authenticateSession(mkws_config.service_proxy_auth,
1514 mkws_config.service_proxy_auth_domain,
1515 mkws_config.pazpar2_url);