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 log_level >= 2
9 // Set up global mkws object. Contains truly global state such as SP
10 // authentication, and a hash of team objects, indexed by team-name.
14 log_level: 1, // Will be overridden from mkws_config, but
15 // initial value allows jQuery popup to use logging.
16 paz: undefined, // will be set up during initialisation
21 "Subjects": "Schlagwörter",
22 "Sources": "Daten und Quellen",
23 "source": "datenquelle",
24 "Termlists": "Termlisten",
26 "Prev": "Zurück",
28 "Sort by": "Sortieren nach",
29 "and show": "und zeige",
30 "per page": "pro Seite",
31 "Displaying": "Zeige",
39 "Subject": "Schlagwort",
40 "subject": "schlagwort",
42 "Records": "Datensätze",
43 "Targets": "Datenbanken",
49 "Authors": "Forfattere",
53 "Termlists": "Termlists",
54 "Next": "Næste",
56 "Search": "Søg",
57 "Sort by": "Sorter efter",
59 "per page": "per side",
60 "Displaying": "Viser",
65 "Author": "Forfatter",
66 "author": "forfatter",
70 "Location": "Lokation",
80 // Define empty mkws_config for simple applications that don't define it.
81 if (mkws_config == null || typeof mkws_config != 'object') {
86 // Factory function for widget objects.
87 function widget($, team, type, node) {
97 Targets: promoteTargets,
99 Termlists: promoteTermlists,
101 Records: promoteRecords,
104 Perpage: promotePerpage
107 var promote = type2fn[type];
110 log("made " + type + " widget(node=" + node + ")");
112 log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")");
122 // Functions follow for promoting the regular widget object into
123 // widgets of specific types. These could be moved outside of the
124 // widget object, or even into their own source files.
126 function promoteTargets() {
127 team.queue("targets").subscribe(function(data) {
128 var table ='<table><thead><tr>' +
129 '<td>' + M('Target ID') + '</td>' +
130 '<td>' + M('Hits') + '</td>' +
131 '<td>' + M('Diags') + '</td>' +
132 '<td>' + M('Records') + '</td>' +
133 '<td>' + M('State') + '</td>' +
134 '</tr></thead><tbody>';
136 for (var i = 0; i < data.length; i++) {
137 table += "<tr><td>" + data[i].id +
138 "</td><td>" + data[i].hits +
139 "</td><td>" + data[i].diagnostic +
140 "</td><td>" + data[i].records +
141 "</td><td>" + data[i].state + "</td></tr>";
144 table += '</tbody></table>';
145 var subnode = $(node).children('.mkwsBytarget');
151 function promoteStat() {
152 team.queue("stat").subscribe(function(data) {
153 if (node.length === 0) alert("huh?!");
155 $(node).html('<span class="head">' + M('Status info') + '</span>' +
157 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
159 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
164 function promoteTermlists() {
165 team.queue("termlists").subscribe(function(data) {
167 alert("termlists event when there are no termlists");
171 // no facets: this should never happen
172 if (!mkws_config.facets || mkws_config.facets.length == 0) {
173 alert("onTerm called even though we have no facets: " + $.toJSON(data));
178 // display if we first got results
182 acc.push('<div class="title">' + M('Termlists') + '</div>');
183 var facets = mkws_config.facets;
185 for (var i = 0; i < facets.length; i++) {
186 if (facets[i] == "xtargets") {
187 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
188 } else if (facets[i] == "subject") {
189 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
190 } else if (facets[i] == "author") {
191 addSingleFacet(acc, "Authors", data.author, 10, "author");
193 alert("bad facet configuration: '" + facets[i] + "'");
197 $(node).html(acc.join(''));
199 function addSingleFacet(acc, caption, data, max, pzIndex) {
200 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + team.name() + '">');
201 acc.push('<div class="termtitle">' + M(caption) + '</div>');
202 for (var i = 0; i < data.length && i < max; i++) {
203 acc.push('<div class="term">');
204 acc.push('<a href="#" ');
207 // Special case: target selection
208 acc.push('target_id='+data[i].id+' ');
209 if (!team.targetFiltered(data[i].id)) {
210 action = 'mkws.limitTarget(\'' + team.name() + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
213 action = 'mkws.limitQuery(\'' + team.name() + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
215 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
216 + ' <span>' + data[i].freq + '</span>');
225 function promotePager() {
226 team.queue("pager").subscribe(function(data) {
227 $(node).html(drawPager(data))
229 function drawPager(data) {
230 var s = '<div style="float: right">' + M('Displaying') + ': '
231 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
232 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
233 + data.total + ')</div>';
235 //client indexes pages from 1 but pz2 from 0
237 var pages = Math.ceil(team.totalRecordCount() / team.perpage());
238 var currentPage = team.currentPage();
240 var firstClkbl = (currentPage - onsides > 0)
241 ? currentPage - onsides
244 var lastClkbl = firstClkbl + 2*onsides < pages
245 ? firstClkbl + 2*onsides
248 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
250 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + team.name() + '\');">'
251 +'<< ' + M('Prev') + '</a><b> | </b>';
254 for(var i = firstClkbl; i <= lastClkbl; i++) {
257 numLabel = '<b>' + i + '</b>';
259 middle += '<a href="#" onclick="mkws.showPage(\'' + team.name() + '\', ' + i + ')"> '
260 + numLabel + ' </a>';
263 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
264 if (pages - currentPage > 0)
265 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + team.name() + '\')">'
266 + M('Next') + ' >></a>';
273 if (lastClkbl < pages)
276 s += '<div style="float: clear">'
277 + prev + predots + middle + postdots + next + '</div>';
285 function promoteRecords() {
286 team.queue("records").subscribe(function(data) {
288 for (var i = 0; i < data.hits.length; i++) {
289 var hit = data.hits[i];
290 var divId = team.recordElementId(hit.recid[0]);
291 html.push('<div class="record mkwsTeam_' + team.name() + ' ' + divId + '">', renderSummary(hit), '</div>');
292 // ### At some point, we may be able to move the
293 // m_currentRecordId and m_currentRecordData members
294 // from the team object into this widget.
295 if (hit.recid == team.currentRecordId()) {
296 if (team.currentRecordData())
297 html.push(team.renderDetails(team.currentRecordData()));
300 $(node).html(html.join(''));
302 function renderSummary(hit)
304 var template = team.loadTemplate("Summary");
305 hit._id = team.recordElementId(hit.recid[0]);
306 hit._onclick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;"
307 return template(hit);
313 function promoteNavi() {
314 team.queue("navi").subscribe(function() {
315 var filters = team.filters();
318 for (var i in filters) {
322 var filter = filters[i];
324 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + team.name() +
325 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
327 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + team.name() +
328 "', '" + filter.field + "', '" + filter.value + "'" +
329 ');return false;">' + filter.value + '</a>';
338 function promoteSort() {
339 // It seems this and the Perpage widget doen't need to
340 // subscribe to anything, since they produce events rather
341 // than consuming them.
342 $(node).change(function () {
343 team.set_sortOrder($(node).val());
344 if (team.submitted()) {
353 function promotePerpage() {
354 $(node).change(function() {
355 team.set_perpage($(node).val());
356 if (team.submitted()) {
366 // Factory function for team objects. As much as possible, this uses
367 // only member variables (prefixed "m_") and inner functions with
368 // private scope. Some functions are visibl as member-functions to be
369 // called from outside code -- specifically, from generated
370 // HTML. These functions are that.switchView(), showDetails(),
371 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
372 // pagerPrev(), pagerNext(), showPage().
374 function team($, teamName) {
376 var m_teamName = teamName;
377 var m_submitted = false;
378 var m_query; // initially undefined
379 var m_sortOrder; // will be set below
380 var m_perpage; // will be set below
382 var m_totalRecordCount = 0;
383 var m_currentPage = 1;
384 var m_currentRecordId = '';
385 var m_currentRecordData = null;
387 // Timestamps for logging
391 var m_paz; // will be initialised below
394 that.name = function() { return m_teamName; }
395 that.submitted = function() { return m_submitted; }
396 that.perpage = function() { return m_perpage; }
397 that.totalRecordCount = function() { return m_totalRecordCount; }
398 that.currentPage = function() { return m_currentPage; }
399 that.currentRecordId = function() { return m_currentRecordId; }
400 that.currentRecordData = function() { return m_currentRecordData; }
401 that.filters = function() { return m_filters; }
403 that.set_sortOrder = function(val) { m_sortOrder = val };
404 that.set_perpage = function(val) { m_perpage = val };
407 var log = function (s) {
409 var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
410 m_logTime.last = now;
412 mkws.log(m_teamName + ": " + timestamp + s);
416 log("start running MKWS");
418 m_sortOrder = mkws_config.sort_default;
419 m_perpage = mkws_config.perpage_default;
421 log("Create main pz2 object");
422 // create a parameters array and pass it to the pz2's constructor
423 // then register the form submit event with the pz2.search function
424 // autoInit is set to true on default
425 m_paz = new pz2({ "windowid": teamName,
426 "pazpar2path": mkws_config.pazpar2_url,
427 "usesessions" : mkws_config.use_service_proxy ? false : true,
429 "onbytarget": onBytarget,
431 "onterm": (mkws_config.facets.length ? onTerm : undefined),
433 "onrecord": onRecord,
434 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
435 "termlist": mkws_config.facets.join(',')
440 // pz2.js event handlers:
449 function onBytarget(data) {
451 queue("targets").publish(data);
455 function onStat(data) {
457 queue("stat").publish(data);
461 function onTerm(data) {
463 queue("termlists").publish(data);
467 function onShow(data, teamName) {
469 m_totalRecordCount = data.merged;
470 queue("pager").publish(data);
471 queue("records").publish(data);
475 function onRecord(data, args, teamName) {
477 // FIXME: record is async!!
478 clearTimeout(m_paz.recordTimer);
479 // ##### restrict to current team
480 var detRecordDiv = document.getElementById(recordDetailsId(data.recid[0]));
482 // in case on_show was faster to redraw element
485 m_currentRecordData = data;
486 var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
487 var html = renderDetails(m_currentRecordData);
488 $(recordDiv).append(html);
492 // Used by promoteRecords() and onRecord()
493 function recordElementId(s) {
494 return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
496 that.recordElementId = recordElementId;
498 // Used by onRecord(), showDetails() and renderDetails()
499 function recordDetailsId(s) {
500 return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
502 that.recordElementId = recordElementId;
505 that.targetFiltered = function(id) {
506 for (var i = 0; i < m_filters.length; i++) {
507 if (m_filters[i].id === id ||
508 m_filters[i].id === 'pz:id=' + id) {
516 ////////////////////////////////////////////////////////////////////////////////
517 ////////////////////////////////////////////////////////////////////////////////
520 // when search button pressed
521 function onFormSubmitEventHandler()
523 var val = findnode('.mkwsQuery').val();
529 function newSearch(query, sortOrder, targets)
531 log("newSearch: " + query);
533 if (mkws_config.use_service_proxy && !mkws.authenticated) {
534 alert("searching before authentication");
539 triggerSearch(query, sortOrder, targets);
540 switchView('records'); // In case it's configured to start off as hidden
545 // limit by target functions
546 that.limitTarget = function (id, name)
548 log("limitTarget(id=" + id + ", name=" + name + ")");
549 m_filters.push({ id: id, name: name });
555 // limit the query after clicking the facet
556 that.limitQuery = function (field, value)
558 log("limitQuery(field=" + field + ", value=" + value + ")");
559 m_filters.push({ field: field, value: value });
565 that.delimitTarget = function (id)
567 log("delimitTarget(id=" + id + ")");
569 for (var i in m_filters) {
570 var filter = m_filters[i];
572 log("delimitTarget() removing filter " + $.toJSON(filter));
574 log("delimitTarget() keeping filter " + $.toJSON(filter));
575 newFilters.push(filter);
578 m_filters = newFilters;
585 that.delimitQuery = function (field, value)
587 log("delimitQuery(field=" + field + ", value=" + value + ")");
589 for (var i in m_filters) {
590 var filter = m_filters[i];
592 field == filter.field &&
593 value == filter.value) {
594 log("delimitQuery() removing filter " + $.toJSON(filter));
596 log("delimitQuery() keeping filter " + $.toJSON(filter));
597 newFilters.push(filter);
600 m_filters = newFilters;
610 m_totalRecordCount = 0;
612 that.resetPage = resetPage;
615 function triggerSearch (query, sortOrder, targets)
618 queue("navi").publish();
623 // Continue to use previous query/sort-order unless new ones are specified
628 m_sortOrder = sortOrder;
631 m_filters.push({ id: targets, name: targets });
634 for (var i in m_filters) {
635 var filter = m_filters[i];
639 if (filter.id.match(/^[a-z:]+[=~]/)) {
640 log("filter '" + filter.id + "' already begins with SETTING OP");
642 filter.id = 'pz:id=' + filter.id;
644 pp2filter += filter.id;
648 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
654 params.limit = pp2limit;
657 log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
659 // We can use: params.torusquery = "udb=NAME"
660 // Note: that won't work when running against raw pazpar2
661 m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
665 that.reShow = function() {
666 m_paz.show(0, m_perpage, m_sortOrder);
671 that.showPage = function (pageNum)
673 m_currentPage = pageNum;
674 m_paz.showPage(m_currentPage - 1);
678 // simple paging functions
679 that.pagerNext = function () {
680 if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
687 that.pagerPrev = function () {
688 if (m_paz.showPrev() != false)
693 // switching view between targets and records
694 function switchView(view) {
695 var targets = findnode('.mkwsTargets');
696 var results = findnode('.mkwsResults,.mkwsRecords');
697 var blanket = findnode('.mkwsBlanket');
698 var motd = findnode('.mkwsMOTD');
702 if (targets) targets.css('display', 'block');
703 if (results) results.css('display', 'none');
704 if (blanket) blanket.css('display', 'none');
705 if (motd) motd.css('display', 'none');
708 if (targets) targets.css('display', 'none');
709 if (results) results.css('display', 'block');
710 if (blanket) blanket.css('display', 'block');
711 if (motd) motd.css('display', 'none');
714 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
715 if (targets) targets.css('display', 'none');
716 if (results) results.css('display', 'none');
717 if (blanket) blanket.css('display', 'none');
718 if (motd) motd.css('display', 'none');
721 alert("Unknown view '" + view + "'");
724 that.switchView = switchView;
727 // detailed record drawing
728 that.showDetails = function (recId) {
729 var oldRecordId = m_currentRecordId;
730 m_currentRecordId = recId;
732 // remove current detailed view if any
733 // ##### restrict to current team
734 var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
737 detRecordDiv.parentNode.removeChild(detRecordDiv);
739 // if the same clicked, just hide
740 if (recId == oldRecordId) {
741 m_currentRecordId = '';
742 m_currentRecordData = null;
745 // request the record
746 log("showDetails() requesting record '" + recId + "'");
752 * All the HTML stuff to render the search forms and
755 function mkwsHtmlAll() {
757 if (mkws_config.show_lang)
760 log("HTML search form");
761 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
763 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
764 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
765 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
770 // If the team has a .mkwsResults, populate it in the usual
771 // way. If not, assume that it's a smarter application that
772 // defines its own subcomponents, some or all of the
779 findnode(".mkwsResults").html('\
780 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
782 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
783 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
785 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
786 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
787 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
788 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
789 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
794 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
799 var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
800 if (mkws_config.show_sort) {
801 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
803 if (mkws_config.show_perpage) {
804 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
806 ranking_data += '</form>';
807 findnode(".mkwsRanking").html(ranking_data);
811 findnode('.mkwsSearchForm').submit(onFormSubmitEventHandler);
813 // on first page, hide the termlist
814 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
815 var container = findnode(".mkwsMOTDContainer");
816 if (container.length) {
817 // Move the MOTD from the provided element down into the container
818 findnode(".mkwsMOTD").appendTo(container);
823 function mkwsSetLang() {
824 var lang = mkws.getParameterByName("lang") || mkws_config.lang;
825 if (!lang || !mkws.locale_lang[lang]) {
826 mkws_config.lang = ""
828 mkws_config.lang = lang;
831 log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
832 return mkws_config.lang;
836 /* create locale language menu */
837 function mkwsHtmlLang() {
838 var lang_default = "en";
839 var lang = mkws_config.lang || lang_default;
842 /* display a list of configured languages, or all */
843 var lang_options = mkws_config.lang_options || [];
844 var toBeIncluded = {};
845 for (var i = 0; i < lang_options.length; i++) {
846 toBeIncluded[lang_options[i]] = true;
849 for (var k in mkws.locale_lang) {
850 if (toBeIncluded[k] || lang_options.length == 0)
855 if (lang_options.length == 0 || toBeIncluded[lang_default])
856 list.push(lang_default);
858 log("Language menu for: " + list.join(", "));
862 for(var i = 0; i < list.length; i++) {
869 data += ' <span>' + l + '</span> ';
871 data += ' <a href="?lang=' + l + '">' + l + '</a> '
875 findnode(".mkwsLang").html(data);
879 function mkwsHtmlSort() {
880 log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
881 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
883 for(var i = 0; i < mkws_config.sort_options.length; i++) {
884 var opt = mkws_config.sort_options[i];
886 var val = opt.length == 1 ? opt[0] : opt[1];
888 sort_html += '<option value="' + key + '"';
889 if (m_sortOrder == key || m_sortOrder == val) {
890 sort_html += ' selected="selected"';
892 sort_html += '>' + M(val) + '</option>';
894 sort_html += '</select>';
900 function mkwsHtmlPerpage() {
901 log("HTML perpage, m_perpage = " + m_perpage);
902 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
904 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
905 var key = mkws_config.perpage_options[i];
907 perpage_html += '<option value="' + key + '"';
908 if (key == m_perpage) {
909 perpage_html += ' selected="selected"';
911 perpage_html += '>' + key + '</option>';
913 perpage_html += '</select>';
919 function mkwsHtmlSwitch() {
920 log("HTML switch for team " + m_teamName);
922 var node = findnode(".mkwsSwitch");
923 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
924 node.append($("<span/>", { text: " | " }));
925 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
928 var node = findnode(".mkwsTargets");
930 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
931 No information available yet.\
933 node.css("display", "none");
937 that.runAutoSearch = function() {
938 var node = findnode('.mkwsRecords,.mkwsTermlists');
939 var query = node.attr('autosearch');
943 if (query.match(/^!param!/)) {
944 var param = query.replace(/^!param!/, '');
945 query = mkws.getParameterByName(param);
946 log("obtained query '" + query + "' from param '" + param + "'");
948 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
950 } else if (query.match(/^!path!/)) {
951 var index = query.replace(/^!path!/, '');
952 var path = window.location.pathname.split('/');
953 query = path[path.length - index];
954 log("obtained query '" + query + "' from path-component '" + index + "'");
956 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
960 log("node=" + node + ", class='" + node.className + "', query=" + query);
962 var sortOrder = node.attr('sort');
963 var targets = node.attr('targets');
964 var s = "running auto search: '" + query + "'";
965 if (sortOrder) s += " sorted by '" + sortOrder + "'";
966 if (targets) s += " in targets '" + targets + "'";
969 newSearch(query, sortOrder, targets);
973 // Translation function. At present, this is properly a
974 // global-level function (hence the assignment to mkws.M) but we
975 // want to make it per-team so different teams can operate in
976 // different languages.
979 var lang = mkws_config.lang;
981 if (!lang || !mkws.locale_lang[lang])
984 return mkws.locale_lang[lang][word] || word;
986 mkws.M = M; // so the Handlebars helper can use it
989 // Finds the node of the specified class within the current team
990 // Multiple OR-clauses separated by commas are handled
991 // More complex cases may not work
993 function findnode(selector, teamName) {
994 teamName = teamName || m_teamName;
996 selector = $.map(selector.split(','), function(s, i) {
997 return s + '.mkwsTeam_' + teamName;
1004 function renderDetails(data, marker)
1006 var template = loadTemplate("Record");
1007 var details = template(data);
1008 return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
1010 that.renderDetails = renderDetails;
1013 function loadTemplate(name)
1015 var template = m_template[name];
1017 if (template === undefined) {
1018 // Fall back to generic template if there is no team-specific one
1019 var node = findnode(".mkwsTemplate_" + name);
1021 node = findnode(".mkwsTemplate_" + name, "ALL");
1024 var source = node.html();
1026 source = mkws.defaultTemplate(name);
1029 template = Handlebars.compile(source);
1030 log("compiled template '" + name + "'");
1031 m_template[name] = template;
1036 that.loadTemplate = loadTemplate;
1039 // The following PubSub code is modified from the jQuery manual:
1040 // https://api.jquery.com/jQuery.Callbacks/
1043 // team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
1044 // team.queue("eventName").publish(arg1, arg2, ...);
1047 var queue = function(id) {
1049 var callbacks = $.Callbacks();
1051 publish: callbacks.fire,
1052 subscribe: callbacks.add,
1053 unsubscribe: callbacks.remove
1068 mkws_config.error = e.message;
1069 // alert(e.message);
1073 // Bizarrely, 'that' is just an empty hash. All its state is in
1074 // the closure variables defined earlier in this function.
1079 // wrapper to call team() after page load
1081 mkws.log = function (string) {
1082 if (!mkws.log_level)
1085 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1089 // you need to disable use strict at the top of the file!!!
1090 if (mkws.log_level >= 3) {
1091 console.log(arguments.callee.caller);
1092 } else if (mkws.log_level >= 2) {
1093 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1095 console.log(string);
1100 mkws.handleNodeWithTeam = function(node, callback) {
1101 // First branch for DOM objects; second branch for jQuery objects
1102 var classes = node.className || node.attr('class');
1104 // For some reason, if we try to proceed when classes is
1105 // undefined, we don't get an error message, but this
1106 // function and its callers, up several stack level,
1107 // silently return. What a crock.
1108 mkws.log("handleNodeWithTeam() called on node with no classes");
1111 var list = classes.split(/\s+/)
1114 for (var i = 0; i < list.length; i++) {
1115 var cname = list[i];
1116 if (cname.match(/^mkwsTeam_/)) {
1117 teamName = cname.replace(/^mkwsTeam_/, '');
1118 } else if (cname.match(/^mkws/)) {
1119 type = cname.replace(/^mkws/, '');
1122 callback.call(node, teamName, type);
1126 mkws.resizePage = function () {
1127 var list = ["mkwsSwitch", "mkwsLang"];
1129 var width = mkws_config.responsive_design_width;
1130 var parent = $(".mkwsTermlists").parent();
1132 if ($(window).width() <= width &&
1133 parent.hasClass("mkwsTermlistContainer1")) {
1134 log("changing from wide to narrow: " + $(window).width());
1135 $(".mkwsTermlistContainer1").hide();
1136 $(".mkwsTermlistContainer2").show();
1137 for (var tname in mkws.teams) {
1138 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1139 for(var i = 0; i < list.length; i++) {
1140 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1143 } else if ($(window).width() > width &&
1144 parent.hasClass("mkwsTermlistContainer2")) {
1145 log("changing from narrow to wide: " + $(window).width());
1146 $(".mkwsTermlistContainer1").show();
1147 $(".mkwsTermlistContainer2").hide();
1148 for (var tname in mkws.teams) {
1149 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1150 for(var i = 0; i < list.length; i++) {
1151 $("." + list[i] + ".mkwsTeam_" + tname).show();
1158 mkws.switchView = function(tname, view) {
1159 mkws.teams[tname].switchView(view);
1162 mkws.showDetails = function (tname, prefixRecId) {
1163 mkws.teams[tname].showDetails(prefixRecId);
1166 mkws.limitTarget = function (tname, id, name) {
1167 mkws.teams[tname].limitTarget(id, name);
1170 mkws.limitQuery = function (tname, field, value) {
1171 mkws.teams[tname].limitQuery(field, value);
1174 mkws.delimitTarget = function (tname, id) {
1175 mkws.teams[tname].delimitTarget(id);
1178 mkws.delimitQuery = function (tname, field, value) {
1179 mkws.teams[tname].delimitQuery(field, value);
1182 mkws.showPage = function (tname, pageNum) {
1183 mkws.teams[tname].showPage(pageNum);
1186 mkws.pagerPrev = function (tname) {
1187 mkws.teams[tname].pagerPrev();
1190 mkws.pagerNext = function (tname) {
1191 mkws.teams[tname].pagerNext();
1195 // This function is taken from a StackOverflow answer
1196 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1197 mkws.getParameterByName = function(name) {
1198 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1199 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1200 results = regex.exec(location.search);
1201 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1205 mkws.defaultTemplate = function(name)
1207 if (name === 'Record') {
1211 <th>{{translate "Title"}}</th>\
1214 {{#if md-title-remainder}}\
1215 ({{md-title-remainder}})\
1217 {{#if md-title-responsibility}}\
1218 <i>{{md-title-responsibility}}</i>\
1224 <th>{{translate "Date"}}</th>\
1225 <td>{{md-date}}</td>\
1230 <th>{{translate "Author"}}</th>\
1231 <td>{{md-author}}</td>\
1234 {{#if md-electronic-url}}\
1236 <th>{{translate "Links"}}</th>\
1238 {{#each md-electronic-url}}\
1239 <a href="{{this}}">Link{{index1}}</a>\
1244 {{#if-any location having="md-subject"}}\
1246 <th>{{translate "Subject"}}</th>\
1248 {{#first location having="md-subject"}}\
1250 {{#commaList md-subject}}\
1251 {{this}}{{/commaList}}\
1258 <th>{{translate "Locations"}}</th>\
1260 {{#commaList location}}\
1261 {{attr "@name"}}{{/commaList}}\
1266 } else if (name === "Summary") {
1268 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
1269 <b>{{md-title}}</b>\
1271 {{#if md-title-remainder}}\
1272 <span>{{md-title-remainder}}</span>\
1274 {{#if md-title-responsibility}}\
1275 <span><i>{{md-title-responsibility}}</i></span>\
1280 var s = "There is no default '" + name +"' template!";
1286 function defaultMkwsConfig() {
1287 /* default mkws config */
1288 var config_default = {
1289 use_service_proxy: true,
1290 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1291 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1293 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1294 perpage_options: [10, 20, 30, 50],
1295 sort_default: "relevance",
1296 perpage_default: 20,
1298 show_lang: true, /* show/hide language menu */
1299 show_sort: true, /* show/hide sort menu */
1300 show_perpage: true, /* show/hide perpage menu */
1301 lang_options: [], /* display languages links for given languages, [] for all */
1302 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1303 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1304 log_level: 1, /* log level for development: 0..2 */
1309 // Set global log_level flag early so that log() works
1310 // Fall back to old "debug_level" setting for backwards compatibility
1311 var tmp = mkws_config.log_level;
1312 if (typeof(tmp) === 'undefined') tmp = mkws_config.debug_level;
1314 if (typeof(tmp) !== 'undefined') {
1315 mkws.log_level = tmp;
1316 } else if (typeof(config_default.log_level) !== 'undefined') {
1317 mkws.log_level = config_default.log_level;
1320 // make sure the mkws_config is a valid hash
1321 if (!$.isPlainObject(mkws_config)) {
1322 log("ERROR: mkws_config is not an JS object, ignore it....");
1326 /* override standard config values by function parameters */
1327 for (var k in config_default) {
1328 if (typeof mkws_config[k] === 'undefined')
1329 mkws_config[k] = config_default[k];
1330 //log("Set config: " + k + ' => ' + mkws_config[k]);
1336 * Run service-proxy authentication in background (after page load).
1337 * The username/password is configured in the apache config file
1340 function authenticateSession(auth_url, auth_domain, pp2_url) {
1341 log("Run service proxy auth URL: " + auth_url);
1344 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1345 log("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1348 var request = new pzHttpRequest(auth_url, function(err) {
1349 alert("HTTP call for authentication failed: " + err)
1353 request.get(null, function(data) {
1354 if (!$.isXMLDoc(data)) {
1355 alert("service proxy auth response document is not valid XML document, give up!");
1358 var status = $(data).find("status");
1359 if (status.text() != "OK") {
1360 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1364 log("Service proxy auth successfully done");
1365 mkws.authenticated = true;
1371 function runAutoSearches() {
1372 log("running auto searches");
1374 for (var teamName in mkws.teams) {
1375 mkws.teams[teamName].runAutoSearch();
1380 $(document).ready(function() {
1381 log("on load ready");
1382 defaultMkwsConfig();
1384 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1385 log("Reset query width: " + mkws_config.query_width);
1386 mkws_config.query_width = 50;
1389 for (var key in mkws_config) {
1390 if (mkws_config.hasOwnProperty(key)) {
1391 if (key.match(/^language_/)) {
1392 var lang = key.replace(/^language_/, "");
1393 // Copy custom languages into list
1394 mkws.locale_lang[lang] = mkws_config[key];
1395 log("Added locally configured language '" + lang + "'");
1400 if (mkws_config.responsive_design_width) {
1401 // Responsive web design - change layout on the fly based on
1402 // current screen width. Required for mobile devices.
1403 $(window).resize(function(e) { mkws.resizePage() });
1404 // initial check after page load
1405 $(document).ready(function() { mkws.resizePage() });
1408 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
1409 if (mkws_config.pazpar2_url.match(/^\/\//)) {
1410 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
1411 log("adjust protocol independent links: " + mkws_config.pazpar2_url);
1414 // Backwards compatibility: set new magic class names on any
1415 // elements that have the old magic IDs.
1416 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1417 "Results", "Records", "Targets", "Ranking",
1418 "Termlists", "Stat", "MOTD" ];
1419 for (var i = 0; i < ids.length; i++) {
1420 var id = 'mkws' + ids[i];
1421 var node = $('#' + id);
1422 if (node.attr('id')) {
1424 log("added magic class to '" + node.attr('id') + "'");
1428 // For all MKWS-classed nodes that don't have a team
1429 // specified, set the team to AUTO.
1430 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1431 if (!this.className.match(/mkwsTeam_/)) {
1432 log("adding AUTO team to node with class '" + this.className + "'");
1433 $(this).addClass('mkwsTeam_AUTO');
1437 // Find all nodes with an MKWS class, and determine their team from
1438 // the mkwsTeam_* class. Make all team objects.
1440 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1441 mkws.handleNodeWithTeam(this, function(tname, type) {
1442 if (!mkws.teams[tname]) {
1443 mkws.teams[tname] = team(j, tname);
1444 log("Made MKWS team '" + tname + "'");
1448 // Second pass: make the individual widget objects. This has
1449 // to be done separately, and after the team-creation, since
1450 // that sometimes makes new widget nodes (e.g. creating
1451 // mkwsTermlists inside mkwsResults.
1452 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1453 mkws.handleNodeWithTeam(this, function(tname, type) {
1454 var myTeam = mkws.teams[tname];
1455 var myWidget = widget(j, myTeam, type, this);
1459 log("Walking MKWS nodes took " + (now-then) + " ms");
1461 if (mkws_config.use_service_proxy) {
1462 authenticateSession(mkws_config.service_proxy_auth,
1463 mkws_config.service_proxy_auth_domain,
1464 mkws_config.pazpar2_url);