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') {
168 // ### Handle other types here
171 mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
175 // Functions follow for promoting the regular widget object into
176 // widgets of specific types. These could be moved outside of the
177 // widget object, or even into their own source files.
179 function promoteTargets() {
180 team.queue("targets").subscribe(function(data) {
181 if (node.length === 0) alert("huh?!");
183 var table ='<table><thead><tr>' +
184 '<td>' + M('Target ID') + '</td>' +
185 '<td>' + M('Hits') + '</td>' +
186 '<td>' + M('Diags') + '</td>' +
187 '<td>' + M('Records') + '</td>' +
188 '<td>' + M('State') + '</td>' +
189 '</tr></thead><tbody>';
191 for (var i = 0; i < data.length; i++) {
192 table += "<tr><td>" + data[i].id +
193 "</td><td>" + data[i].hits +
194 "</td><td>" + data[i].diagnostic +
195 "</td><td>" + data[i].records +
196 "</td><td>" + data[i].state + "</td></tr>";
199 table += '</tbody></table>';
200 var subnode = $(node).children('.mkwsBytarget');
206 function promoteStat() {
207 team.queue("stat").subscribe(function(data) {
208 if (node.length === 0) alert("huh?!");
210 $(node).html('<span class="head">' + M('Status info') + '</span>' +
212 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
214 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
219 function promoteTermlists() {
220 team.queue("termlists").subscribe(function(data) {
221 mkws.debug("in termlist consumer");
223 alert("termlists event when there are no termlists");
227 // no facets: this should never happen
228 if (!mkws_config.facets || mkws_config.facets.length == 0) {
229 alert("onTerm called even though we have no facets: " + $.toJSON(data));
234 // display if we first got results
238 acc.push('<div class="title">' + M('Termlists') + '</div>');
239 var facets = mkws_config.facets;
241 for (var i = 0; i < facets.length; i++) {
242 if (facets[i] == "xtargets") {
243 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
244 } else if (facets[i] == "subject") {
245 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
246 } else if (facets[i] == "author") {
247 addSingleFacet(acc, "Authors", data.author, 10, "author");
249 alert("bad facet configuration: '" + facets[i] + "'");
253 $(node).html(acc.join(''));
255 function addSingleFacet(acc, caption, data, max, pzIndex) {
256 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
257 acc.push('<div class="termtitle">' + M(caption) + '</div>');
258 for (var i = 0; i < data.length && i < max; i++) {
259 acc.push('<div class="term">');
260 acc.push('<a href="#" ');
263 // Special case: target selection
264 acc.push('target_id='+data[i].id+' ');
265 if (!team.targetFiltered(data[i].id)) {
266 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
269 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
271 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
272 + ' <span>' + data[i].freq + '</span>');
282 // Factory function for team objects. As much as possible, this uses
283 // only member variables (prefixed "m_") and inner functions with
284 // private scope. Some functions are visibl as member-functions to be
285 // called from outside code -- specifically, from generated
286 // HTML. These functions are that.switchView(), showDetails(),
287 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
288 // pagerPrev(), pagerNext(), showPage().
290 function team($, teamName) {
292 var m_teamName = teamName;
293 that.name = function() { return m_teamName; }
294 var m_submitted = false;
295 var m_query; // initially undefined
296 var m_sortOrder; // will be set below
297 var m_perpage; // will be set below
299 var m_totalRecordCount = 0;
300 var m_currentPage = 1;
301 var m_currentRecordId = '';
302 var m_currentRecordData = null;
304 // Timestamps for logging
308 var m_paz; // will be initialised below
312 var debug = function (s) {
314 var timestamp = ((now - m_debugTime.start)/1000).toFixed(3) + " (+" + ((now - m_debugTime.last)/1000).toFixed(3) + ") "
315 m_debugTime.last = now;
317 mkws.debug(m_teamName + ": " + timestamp + s);
320 debug("start running MKWS");
322 m_sortOrder = mkws_config.sort_default;
323 m_perpage = mkws_config.perpage_default;
325 debug("Create main pz2 object");
326 // create a parameters array and pass it to the pz2's constructor
327 // then register the form submit event with the pz2.search function
328 // autoInit is set to true on default
329 m_paz = new pz2({ "windowid": teamName,
330 "pazpar2path": mkws_config.pazpar2_url,
331 "usesessions" : mkws_config.use_service_proxy ? false : true,
333 "onbytarget": onBytarget,
335 "onterm": (mkws_config.facets.length ? onTerm : undefined),
337 "onrecord": onRecord,
338 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
339 "termlist": mkws_config.facets.join(',')
344 // pz2.js event handlers:
353 function onBytarget(data) {
355 queue("targets").publish(data);
359 function onStat(data) {
361 queue("stat").publish(data);
365 function onTerm(data) {
367 queue("termlists").publish(data);
371 function onShow(data, teamName) {
373 m_totalRecordCount = data.merged;
375 var pager = findnode(".mkwsPager");
377 pager.html(drawPager(data))
380 var results = findnode(".mkwsRecords");
385 for (var i = 0; i < data.hits.length; i++) {
386 var hit = data.hits[i];
387 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
390 if (hit.recid == m_currentRecordId) {
391 if (m_currentRecordData)
392 html.push(renderDetails(m_currentRecordData));
395 results.html(html.join(''));
399 function onRecord(data, args, teamName) {
401 // FIXME: record is async!!
402 clearTimeout(m_paz.recordTimer);
403 // in case on_show was faster to redraw element
404 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
405 if (detRecordDiv) return;
406 m_currentRecordData = data;
407 // Can't use jQuery's $('#x') syntax to find this ID, because it contains spaces.
408 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_currentRecordData.recid);
409 var html = renderDetails(m_currentRecordData);
410 $(recordDiv).append(html);
414 that.targetFiltered = function(id) {
415 for (var i = 0; i < m_filters.length; i++) {
416 if (m_filters[i].id === id ||
417 m_filters[i].id === 'pz:id=' + id) {
425 function drawPager (data)
427 var s = '<div style="float: right">' + M('Displaying') + ': '
428 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
429 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
430 + data.total + ')</div>';
432 //client indexes pages from 1 but pz2 from 0
434 var pages = Math.ceil(m_totalRecordCount / m_perpage);
436 var firstClkbl = (m_currentPage - onsides > 0)
437 ? m_currentPage - onsides
440 var lastClkbl = firstClkbl + 2*onsides < pages
441 ? firstClkbl + 2*onsides
444 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
445 if (m_currentPage > 1)
446 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
447 +'<< ' + M('Prev') + '</a><b> | </b>';
450 for(var i = firstClkbl; i <= lastClkbl; i++) {
452 if(i == m_currentPage)
453 numLabel = '<b>' + i + '</b>';
455 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
456 + numLabel + ' </a>';
459 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
460 if (pages - m_currentPage > 0)
461 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
462 + M('Next') + ' >></a>';
469 if (lastClkbl < pages)
472 s += '<div style="float: clear">'
473 + prev + predots + middle + postdots + next + '</div>';
479 ////////////////////////////////////////////////////////////////////////////////
480 ////////////////////////////////////////////////////////////////////////////////
483 // when search button pressed
484 function onFormSubmitEventHandler()
486 var val = findnode('.mkwsQuery').val();
492 function newSearch(query, sortOrder, targets)
494 debug("newSearch: " + query);
496 if (mkws_config.use_service_proxy && !mkws.authenticated) {
497 alert("searching before authentication");
505 triggerSearch(query, sortOrder, targets);
506 switchView('records'); // In case it's configured to start off as hidden
511 function onSelectDdChange()
513 if (!m_submitted) return false;
516 m_paz.show(0, m_perpage, m_sortOrder);
521 function redrawNavi ()
523 var navi = findnode('.mkwsNavi');
527 for (var i in m_filters) {
531 var filter = m_filters[i];
533 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
534 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
536 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
537 "', '" + filter.field + "', '" + filter.value + "'" +
538 ');return false;">' + filter.value + '</a>';
549 m_totalRecordCount = 0;
553 function loadSelect ()
555 var node = findnode('.mkwsSort');
556 if (node.length && node.val() != m_sortOrder) {
557 debug("changing m_sortOrder from " + m_sortOrder + " to " + node.val());
558 m_sortOrder = node.val();
560 node = findnode('.mkwsPerpage');
561 if (node.length && node.val() != m_perpage) {
562 debug("changing m_perpage from " + m_perpage + " to " + node.val());
563 m_perpage = node.val();
568 function triggerSearch (query, sortOrder, targets)
573 // Continue to use previous query/sort-order unless new ones are specified
578 m_sortOrder = sortOrder;
581 m_filters.push({ id: targets, name: targets });
584 for (var i in m_filters) {
585 var filter = m_filters[i];
589 if (filter.id.match(/^[a-z:]+[=~]/)) {
590 debug("filter '" + filter.id + "' already begins with SETTING OP");
592 filter.id = 'pz:id=' + filter.id;
594 pp2filter += filter.id;
598 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
604 params.limit = pp2limit;
607 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
609 // We can use: params.torusquery = "udb=NAME"
610 // Note: that won't work when running against raw pazpar2
611 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
615 // limit by target functions
616 that.limitTarget = function (id, name)
618 debug("limitTarget(id=" + id + ", name=" + name + ")");
619 m_filters.push({ id: id, name: name });
628 // limit the query after clicking the facet
629 that.limitQuery = function (field, value)
631 debug("limitQuery(field=" + field + ", value=" + value + ")");
632 m_filters.push({ field: field, value: value });
641 that.delimitTarget = function (id)
643 debug("delimitTarget(id=" + id + ")");
645 for (var i in m_filters) {
646 var filter = m_filters[i];
648 debug("delimitTarget() removing filter " + $.toJSON(filter));
650 debug("delimitTarget() keeping filter " + $.toJSON(filter));
651 newFilters.push(filter);
654 m_filters = newFilters;
664 that.delimitQuery = function (field, value)
666 debug("delimitQuery(field=" + field + ", value=" + value + ")");
668 for (var i in m_filters) {
669 var filter = m_filters[i];
671 field == filter.field &&
672 value == filter.value) {
673 debug("delimitQuery() removing filter " + $.toJSON(filter));
675 debug("delimitQuery() keeping filter " + $.toJSON(filter));
676 newFilters.push(filter);
679 m_filters = newFilters;
689 that.showPage = function (pageNum)
691 m_currentPage = pageNum;
692 m_paz.showPage(m_currentPage - 1);
696 // simple paging functions
697 that.pagerNext = function () {
698 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
705 that.pagerPrev = function () {
706 if (m_paz.showPrev() != false)
711 // switching view between targets and records
712 function switchView(view) {
713 var targets = findnode('.mkwsTargets');
714 var results = findnode('.mkwsResults,.mkwsRecords');
715 var blanket = findnode('.mkwsBlanket');
716 var motd = findnode('.mkwsMOTD');
720 if (targets) targets.css('display', 'block');
721 if (results) results.css('display', 'none');
722 if (blanket) blanket.css('display', 'none');
723 if (motd) motd.css('display', 'none');
726 if (targets) targets.css('display', 'none');
727 if (results) results.css('display', 'block');
728 if (blanket) blanket.css('display', 'block');
729 if (motd) motd.css('display', 'none');
732 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
733 if (targets) targets.css('display', 'none');
734 if (results) results.css('display', 'none');
735 if (blanket) blanket.css('display', 'none');
736 if (motd) motd.css('display', 'none');
739 alert("Unknown view '" + view + "'");
744 that.switchView = switchView;
747 // detailed record drawing
748 that.showDetails = function (prefixRecId) {
749 var recId = prefixRecId.replace('mkwsRec_', '');
750 var oldRecordId = m_currentRecordId;
751 m_currentRecordId = recId;
753 // remove current detailed view if any
754 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecordId);
757 detRecordDiv.parentNode.removeChild(detRecordDiv);
759 // if the same clicked, just hide
760 if (recId == oldRecordId) {
761 m_currentRecordId = '';
762 m_currentRecordData = null;
765 // request the record
766 debug("showDetails() requesting record '" + recId + "'");
772 * All the HTML stuff to render the search forms and
775 function mkwsHtmlAll() {
777 if (mkws_config.show_lang)
780 debug("HTML search form");
781 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
783 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
784 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
785 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
789 debug("HTML records");
790 // If the team has a .mkwsResults, populate it in the usual
791 // way. If not, assume that it's a smarter application that
792 // defines its own subcomponents, some or all of the
799 if (findnode(".mkwsResults").length) {
800 findnode(".mkwsResults").html('\
801 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
803 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
804 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
806 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
807 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
808 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
809 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
810 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
815 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
821 var node = findnode(".mkwsRanking");
823 var ranking_data = '';
824 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
825 if (mkws_config.show_sort) {
826 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
828 if (mkws_config.show_perpage) {
829 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
831 ranking_data += '</form>';
833 node.html(ranking_data);
839 node = findnode('.mkwsSearchForm');
841 node.submit(onFormSubmitEventHandler);
842 node = findnode('.mkwsSort');
844 node.change(onSelectDdChange);
845 node = findnode('.mkwsPerpage');
847 node.change(onSelectDdChange);
849 // on first page, hide the termlist
850 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
851 var motd = findnode(".mkwsMOTD");
852 var container = findnode(".mkwsMOTDContainer");
853 if (motd.length && container.length) {
854 // Move the MOTD from the provided element down into the container
855 motd.appendTo(container);
860 function mkwsSetLang() {
861 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
862 if (!lang || !mkws.locale_lang[lang]) {
863 mkws_config.lang = ""
865 mkws_config.lang = lang;
868 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
869 return mkws_config.lang;
873 /* create locale language menu */
874 function mkwsHtmlLang() {
875 var lang_default = "en";
876 var lang = mkws_config.lang || lang_default;
879 /* display a list of configured languages, or all */
880 var lang_options = mkws_config.lang_options || [];
881 var toBeIncluded = {};
882 for (var i = 0; i < lang_options.length; i++) {
883 toBeIncluded[lang_options[i]] = true;
886 for (var k in mkws.locale_lang) {
887 if (toBeIncluded[k] || lang_options.length == 0)
892 if (lang_options.length == 0 || toBeIncluded[lang_default])
893 list.push(lang_default);
895 debug("Language menu for: " + list.join(", "));
899 for(var i = 0; i < list.length; i++) {
906 data += ' <span>' + l + '</span> ';
908 data += ' <a href="?lang=' + l + '">' + l + '</a> '
912 findnode(".mkwsLang").html(data);
916 function mkwsHtmlSort() {
917 debug("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
918 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
920 for(var i = 0; i < mkws_config.sort_options.length; i++) {
921 var opt = mkws_config.sort_options[i];
923 var val = opt.length == 1 ? opt[0] : opt[1];
925 sort_html += '<option value="' + key + '"';
926 if (m_sortOrder == key || m_sortOrder == val) {
927 sort_html += ' selected="selected"';
929 sort_html += '>' + M(val) + '</option>';
931 sort_html += '</select>';
937 function mkwsHtmlPerpage() {
938 debug("HTML perpage, m_perpage = " + m_perpage);
939 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
941 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
942 var key = mkws_config.perpage_options[i];
944 perpage_html += '<option value="' + key + '"';
945 if (key == m_perpage) {
946 perpage_html += ' selected="selected"';
948 perpage_html += '>' + key + '</option>';
950 perpage_html += '</select>';
956 function mkwsHtmlSwitch() {
957 debug("HTML switch for team " + m_teamName);
959 var node = findnode(".mkwsSwitch");
960 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
961 node.append($("<span/>", { text: " | " }));
962 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
964 debug("HTML targets");
965 var node = findnode(".mkwsTargets");
967 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
968 No information available yet.\
970 node.css("display", "none");
974 that.runAutoSearch = function() {
975 var node = findnode('.mkwsRecords,.mkwsTermlists');
976 var query = node.attr('autosearch');
980 if (query.match(/^!param!/)) {
981 var param = query.replace(/^!param!/, '');
982 query = mkws.getParameterByName(param);
983 debug("obtained query '" + query + "' from param '" + param + "'");
985 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
987 } else if (query.match(/^!path!/)) {
988 var index = query.replace(/^!path!/, '');
989 var path = window.location.pathname.split('/');
990 query = path[path.length - index];
991 debug("obtained query '" + query + "' from path-component '" + index + "'");
993 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
997 debug("node=" + node + ", class='" + node.className + "', query=" + query);
999 var sortOrder = node.attr('sort');
1000 var targets = node.attr('targets');
1001 var s = "running auto search: '" + query + "'";
1002 if (sortOrder) s += " sorted by '" + sortOrder + "'";
1003 if (targets) s += " in targets '" + targets + "'";
1006 newSearch(query, sortOrder, targets);
1010 // Translation function. At present, this is properly a
1011 // global-level function (hence the assignment to mkws.M) but we
1012 // want to make it per-team so different teams can operate in
1013 // different languages.
1016 var lang = mkws_config.lang;
1018 if (!lang || !mkws.locale_lang[lang])
1021 return mkws.locale_lang[lang][word] || word;
1023 mkws.M = M; // so the Handlebars helper can use it
1026 // Finds the node of the specified class within the current team
1027 // Multiple OR-clauses separated by commas are handled
1028 // More complex cases may not work
1030 function findnode(selector, teamName) {
1031 teamName = teamName || m_teamName;
1033 selector = $.map(selector.split(','), function(s, i) {
1034 return s + '.mkwsTeam_' + teamName;
1041 function renderSummary(hit)
1043 var template = loadTemplate("Summary");
1044 hit._id = "mkwsRec_" + hit.recid;
1045 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
1046 return template(hit);
1050 function renderDetails(data, marker)
1052 var template = loadTemplate("Record");
1053 var details = template(data);
1054 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
1058 function loadTemplate(name)
1060 var template = m_template[name];
1062 if (template === undefined) {
1063 // Fall back to generic template if there is no team-specific one
1064 var node = findnode(".mkwsTemplate_" + name);
1066 node = findnode(".mkwsTemplate_" + name, "ALL");
1069 var source = node.html();
1071 source = mkws.defaultTemplate(name);
1074 template = Handlebars.compile(source);
1075 debug("compiled template '" + name + "'");
1076 m_template[name] = template;
1083 // The following PubSub code is modified from the jQuery manual:
1084 // https://api.jquery.com/jQuery.Callbacks/
1087 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1088 // team.queue("eventName").publish(arg1, arg2, ...);
1091 var queue = function(id) {
1093 var callbacks = $.Callbacks();
1095 publish: callbacks.fire,
1096 subscribe: callbacks.add,
1097 unsubscribe: callbacks.remove
1113 mkws_config.error = e.message;
1114 // alert(e.message);
1118 // Bizarrely, 'that' is just an empty hash. All its state is in
1119 // the closure variables defined earlier in this function.
1124 // wrapper to call team() after page load
1126 mkws.debug = function (string) {
1127 if (!mkws.debug_level)
1130 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1134 // you need to disable use strict at the top of the file!!!
1135 if (mkws.debug_level >= 3) {
1136 console.log(arguments.callee.caller);
1137 } else if (mkws.debug_level >= 2) {
1138 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1140 console.log(string);
1142 var debug = mkws.debug;
1145 mkws.handleNodeWithTeam = function(node, callback) {
1146 // First branch for DOM objects; second branch for jQuery objects
1147 var classes = node.className || node.attr('class');
1149 // For some reason, if we try to proceed when classes is
1150 // undefined, we don't get an error message, but this
1151 // function and its callers, up several stack level,
1152 // silently return. What a crock.
1153 mkws.debug("handleNodeWithTeam() called on node with no classes");
1156 var list = classes.split(/\s+/)
1159 for (var i = 0; i < list.length; i++) {
1160 var cname = list[i];
1161 if (cname.match(/^mkwsTeam_/)) {
1162 teamName = cname.replace(/^mkwsTeam_/, '');
1163 } else if (cname.match(/^mkws/)) {
1164 type = cname.replace(/^mkws/, '');
1167 callback.call(node, teamName, type);
1171 mkws.resizePage = function () {
1172 var list = ["mkwsSwitch", "mkwsLang"];
1174 var width = mkws_config.responsive_design_width;
1175 var parent = $(".mkwsTermlists").parent();
1177 if ($(window).width() <= width &&
1178 parent.hasClass("mkwsTermlistContainer1")) {
1179 debug("changing from wide to narrow: " + $(window).width());
1180 $(".mkwsTermlistContainer1").hide();
1181 $(".mkwsTermlistContainer2").show();
1182 for (var tname in mkws.teams) {
1183 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1184 for(var i = 0; i < list.length; i++) {
1185 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1188 } else if ($(window).width() > width &&
1189 parent.hasClass("mkwsTermlistContainer2")) {
1190 debug("changing from narrow to wide: " + $(window).width());
1191 $(".mkwsTermlistContainer1").show();
1192 $(".mkwsTermlistContainer2").hide();
1193 for (var tname in mkws.teams) {
1194 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1195 for(var i = 0; i < list.length; i++) {
1196 $("." + list[i] + ".mkwsTeam_" + tname).show();
1203 mkws.switchView = function(tname, view) {
1204 mkws.teams[tname].switchView(view);
1207 mkws.showDetails = function (tname, prefixRecId) {
1208 mkws.teams[tname].showDetails(prefixRecId);
1211 mkws.limitTarget = function (tname, id, name) {
1212 mkws.teams[tname].limitTarget(id, name);
1215 mkws.limitQuery = function (tname, field, value) {
1216 mkws.teams[tname].limitQuery(field, value);
1219 mkws.delimitTarget = function (tname, id) {
1220 mkws.teams[tname].delimitTarget(id);
1223 mkws.delimitQuery = function (tname, field, value) {
1224 mkws.teams[tname].delimitQuery(field, value);
1227 mkws.showPage = function (tname, pageNum) {
1228 mkws.teams[tname].showPage(pageNum);
1231 mkws.pagerPrev = function (tname) {
1232 mkws.teams[tname].pagerPrev();
1235 mkws.pagerNext = function (tname) {
1236 mkws.teams[tname].pagerNext();
1240 // This function is taken from a StackOverflow answer
1241 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1242 mkws.getParameterByName = function(name) {
1243 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1244 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1245 results = regex.exec(location.search);
1246 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1250 mkws.defaultTemplate = function(name)
1252 if (name === 'Record') {
1256 <th>{{translate "Title"}}</th>\
1259 {{#if md-title-remainder}}\
1260 ({{md-title-remainder}})\
1262 {{#if md-title-responsibility}}\
1263 <i>{{md-title-responsibility}}</i>\
1269 <th>{{translate "Date"}}</th>\
1270 <td>{{md-date}}</td>\
1275 <th>{{translate "Author"}}</th>\
1276 <td>{{md-author}}</td>\
1279 {{#if md-electronic-url}}\
1281 <th>{{translate "Links"}}</th>\
1283 {{#each md-electronic-url}}\
1284 <a href="{{this}}">Link{{index1}}</a>\
1289 {{#if-any location having="md-subject"}}\
1291 <th>{{translate "Subject"}}</th>\
1293 {{#first location having="md-subject"}}\
1295 {{#commaList md-subject}}\
1296 {{this}}{{/commaList}}\
1303 <th>{{translate "Locations"}}</th>\
1305 {{#commaList location}}\
1306 {{attr "@name"}}{{/commaList}}\
1311 } else if (name === "Summary") {
1313 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1314 <b>{{md-title}}</b>\
1316 {{#if md-title-remainder}}\
1317 <span>{{md-title-remainder}}</span>\
1319 {{#if md-title-responsibility}}\
1320 <span><i>{{md-title-responsibility}}</i></span>\
1325 var s = "There is no default '" + name +"' template!";
1331 function defaultMkwsConfig() {
1332 /* default mkws config */
1333 var config_default = {
1334 use_service_proxy: true,
1335 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1336 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1338 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1339 perpage_options: [10, 20, 30, 50],
1340 sort_default: "relevance",
1341 perpage_default: 20,
1343 show_lang: true, /* show/hide language menu */
1344 show_sort: true, /* show/hide sort menu */
1345 show_perpage: true, /* show/hide perpage menu */
1346 lang_options: [], /* display languages links for given languages, [] for all */
1347 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1348 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1349 debug_level: 1, /* debug level for development: 0..2 */
1354 /* Set global debug_level flag early so that debug() works */
1355 if (typeof mkws_config.debug_level !== 'undefined') {
1356 mkws.debug_level = mkws_config.debug_level;
1357 } else if (typeof config_default.debug_level !== 'undefined') {
1358 mkws.debug_level = config_default.debug_level;
1361 // make sure the mkws_config is a valid hash
1362 if (!$.isPlainObject(mkws_config)) {
1363 debug("ERROR: mkws_config is not an JS object, ignore it....");
1367 /* override standard config values by function parameters */
1368 for (var k in config_default) {
1369 if (typeof mkws_config[k] === 'undefined')
1370 mkws_config[k] = config_default[k];
1371 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1377 * Run service-proxy authentication in background (after page load).
1378 * The username/password is configured in the apache config file
1381 function authenticateSession(auth_url, auth_domain, pp2_url) {
1382 debug("Run service proxy auth URL: " + auth_url);
1385 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1386 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1389 var request = new pzHttpRequest(auth_url, function(err) {
1390 alert("HTTP call for authentication failed: " + err)
1394 request.get(null, function(data) {
1395 if (!$.isXMLDoc(data)) {
1396 alert("service proxy auth response document is not valid XML document, give up!");
1399 var status = $(data).find("status");
1400 if (status.text() != "OK") {
1401 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1405 debug("Service proxy auth successfully done");
1406 mkws.authenticated = true;
1412 function runAutoSearches() {
1413 debug("running auto searches");
1415 for (var teamName in mkws.teams) {
1416 mkws.teams[teamName].runAutoSearch();
1421 $(document).ready(function() {
1422 debug("on load ready");
1423 defaultMkwsConfig();
1425 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1426 debug("Reset query width: " + mkws_config.query_width);
1427 mkws_config.query_width = 50;
1430 for (var key in mkws_config) {
1431 if (mkws_config.hasOwnProperty(key)) {
1432 if (key.match(/^language_/)) {
1433 var lang = key.replace(/^language_/, "");
1434 // Copy custom languages into list
1435 mkws.locale_lang[lang] = mkws_config[key];
1436 debug("Added locally configured language '" + lang + "'");
1441 if (mkws_config.responsive_design_width) {
1442 // Responsive web design - change layout on the fly based on
1443 // current screen width. Required for mobile devices.
1444 $(window).resize(function(e) { mkws.resizePage() });
1445 // initial check after page load
1446 $(document).ready(function() { mkws.resizePage() });
1449 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1450 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1451 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1452 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
1455 // Backwards compatibility: set new magic class names on any
1456 // elements that have the old magic IDs.
1457 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1458 "Results", "Records", "Targets", "Ranking",
1459 "Termlists", "Stat", "MOTD" ];
1460 for (var i = 0; i < ids.length; i++) {
1461 var id = 'mkws' + ids[i];
1462 var node = $('#' + id);
1463 if (node.attr('id')) {
1465 debug("added magic class to '" + node.attr('id') + "'");
1469 // For all MKWS-classed nodes that don't have a team
1470 // specified, set the team to AUTO.
1471 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1472 if (!this.className.match(/mkwsTeam_/)) {
1473 debug("adding AUTO team to node with class '" + this.className + "'");
1474 $(this).addClass('mkwsTeam_AUTO');
1478 // Find all nodes with an MKWS class, and determine their team from
1479 // the mkwsTeam_* class. Make all team objects.
1481 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1482 mkws.handleNodeWithTeam(this, function(tname, type) {
1483 if (!mkws.teams[tname]) {
1484 mkws.teams[tname] = team(j, tname);
1485 debug("Made MKWS team '" + tname + "'");
1489 // Second pass: make the individual widget objects. This has
1490 // to be done separately, and after the team-creation, since
1491 // that sometimes makes new widget nodes (e.g. creating
1492 // mkwsTermlists instead mkwsResults.
1493 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1494 mkws.handleNodeWithTeam(this, function(tname, type) {
1495 var myTeam = mkws.teams[tname];
1496 var myWidget = widget(j, myTeam, type, this);
1500 debug("Walking MKWS nodes took " + (now-then) + " ms");
1502 if (mkws_config.use_service_proxy) {
1503 authenticateSession(mkws_config.service_proxy_auth,
1504 mkws_config.service_proxy_auth_domain,
1505 mkws_config.pazpar2_url);