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 // The following PubSub code is modified from the jQuery manual:
146 // https://api.jquery.com/jQuery.Callbacks/
149 // mkws.queue("eventName").subscribe(function(param1, param2 ...) { ... });
150 // mkws.queue("eventName").publish(arg1, arg2, ...);
154 mkws.queue = function(id) {
156 var callbacks = $.Callbacks();
158 publish: callbacks.fire,
159 subscribe: callbacks.add,
160 unsubscribe: callbacks.remove
168 // Define empty mkws_config for simple applications that don't define it.
169 if (mkws_config == null || typeof mkws_config != 'object') {
170 var mkws_config = {};
174 // Factory function for widget objects.
175 function widget($, team, type, node) {
182 // ### More to do here, surely: e.g. wiring into the team
183 mkws.debug("made widget(team=" + team + ", type=" + type + ", node=" + node);
189 // Factory function for team objects. As much as possible, this uses
190 // only member variables (prefixed "m_") and inner functions with
191 // private scope. Some functions are visibl as member-functions to be
192 // called from outside code -- specifically, from generated
193 // HTML. These functions are that.switchView(), showDetails(),
194 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
195 // pagerPrev(), pagerNext(), showPage().
197 function team($, teamName) {
199 var m_teamName = teamName;
200 var m_submitted = false;
201 var m_query; // initially undefined
202 var m_sort; // will be set below
203 var m_perpage; // will be set below
207 var m_curDetRecId = '';
208 var m_curDetRecData = null;
210 // Timestamps for logging
214 var m_paz; // will be initialised below
218 var debug = function (s) {
220 var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
221 m_debug_time.last = now;
223 mkws.debug(m_teamName + ": " + timestamp + s);
226 debug("start running MKWS");
228 m_sort = mkws_config.sort_default;
229 debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort");
231 if (!isNaN(parseInt(mkws_config.perpage_default))) {
232 m_perpage = parseInt(mkws_config.perpage_default);
235 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
236 if (mkws_config.pazpar2_url.match(/^\/\//)) {
237 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
238 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
241 debug("Create main pz2 object");
242 // create a parameters array and pass it to the pz2's constructor
243 // then register the form submit event with the pz2.search function
244 // autoInit is set to true on default
245 m_paz = new pz2({ "windowid": teamName,
246 "pazpar2path": mkws_config.pazpar2_url,
247 "usesessions" : mkws_config.use_service_proxy ? false : true,
249 "onbytarget": onBytarget,
251 "onterm": (mkws_config.facets.length ? onTerm : undefined),
253 "onrecord": onRecord,
254 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
255 "termlist": mkws_config.facets.join(',')
259 // Finds the node of the specified class within the current team
260 // Multiple OR-clauses separated by commas are handled
261 // More complex cases may not work
263 function findnode(selector, teamName) {
264 teamName = teamName || m_teamName;
266 selector = selector.split(',').map(function(s) {
267 return s + '.mkwsTeam_' + teamName;
275 // pz2.js event handlers:
277 function onInit(teamName) {
284 function onBytarget(data, teamName) {
286 var targetDiv = findnode('.mkwsBytarget');
291 var table ='<table><thead><tr>' +
292 '<td>' + M('Target ID') + '</td>' +
293 '<td>' + M('Hits') + '</td>' +
294 '<td>' + M('Diags') + '</td>' +
295 '<td>' + M('Records') + '</td>' +
296 '<td>' + M('State') + '</td>' +
297 '</tr></thead><tbody>';
299 for (var i = 0; i < data.length; i++) {
300 table += "<tr><td>" + data[i].id +
301 "</td><td>" + data[i].hits +
302 "</td><td>" + data[i].diagnostic +
303 "</td><td>" + data[i].records +
304 "</td><td>" + data[i].state + "</td></tr>";
307 table += '</tbody></table>';
308 targetDiv.html(table);
312 function onStat(data, teamName) {
314 var stat = findnode('.mkwsStat');
315 if (stat.length === 0)
318 stat.html('<span class="head">' + M('Status info') + '</span>' +
320 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
322 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
326 function onTerm(data, teamName) {
328 var node = findnode(".mkwsTermlists");
329 if (node.length == 0) return;
331 // no facets: this should never happen
332 if (!mkws_config.facets || mkws_config.facets.length == 0) {
333 alert("onTerm called even though we have no facets: " + $.toJSON(data));
338 // display if we first got results
342 acc.push('<div class="title">' + M('Termlists') + '</div>');
343 var facets = mkws_config.facets;
345 for(var i = 0; i < facets.length; i++) {
346 if (facets[i] == "xtargets") {
347 addSingleFacet(acc, "Sources", data.xtargets, 16, null);
348 } else if (facets[i] == "subject") {
349 addSingleFacet(acc, "Subjects", data.subject, 10, "subject");
350 } else if (facets[i] == "author") {
351 addSingleFacet(acc, "Authors", data.author, 10, "author");
353 alert("bad facet configuration: '" + facets[i] + "'");
357 node.html(acc.join(''));
361 function onShow(data, teamName) {
363 m_totalRec = data.merged;
365 var pager = findnode(".mkwsPager");
367 pager.html(drawPager(data))
370 var results = findnode(".mkwsRecords");
375 for (var i = 0; i < data.hits.length; i++) {
376 var hit = data.hits[i];
377 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
380 if (hit.recid == m_curDetRecId) {
382 html.push(renderDetails(m_curDetRecData));
385 results.html(html.join(''));
389 function onRecord(data, args, teamName) {
390 debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
391 // FIXME: record is async!!
392 clearTimeout(m_paz.recordTimer);
393 // in case on_show was faster to redraw element
394 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
395 if (detRecordDiv) return;
396 m_curDetRecData = data;
397 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
398 var html = renderDetails(m_curDetRecData);
399 recordDiv.innerHTML += html;
403 function renderSummary(hit)
405 var template = loadTemplate("Summary");
406 hit._id = "mkwsRec_" + hit.recid;
407 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
408 return template(hit);
412 function addSingleFacet(acc, caption, data, max, pzIndex) {
413 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
414 acc.push('<div class="termtitle">' + M(caption) + '</div>');
415 for (var i = 0; i < data.length && i < max; i++) {
416 acc.push('<div class="term">');
417 acc.push('<a href="#" ');
420 // Special case: target selection
421 acc.push('target_id='+data[i].id+' ');
422 if (!targetFiltered(data[i].id)) {
423 action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
426 action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
428 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
429 + ' <span>' + data[i].freq + '</span>');
436 function targetFiltered(id) {
437 for (var i = 0; i < m_filters.length; i++) {
438 if (m_filters[i].id === id ||
439 m_filters[i].id === 'pz:id=' + id) {
447 ////////////////////////////////////////////////////////////////////////////////
448 ////////////////////////////////////////////////////////////////////////////////
451 // when search button pressed
452 function onFormSubmitEventHandler()
454 var val = findnode('.mkwsQuery').val();
460 function newSearch(query, sort, targets)
462 debug("newSearch: " + query);
464 if (mkws_config.use_service_proxy && !mkws.authenticated) {
465 alert("searching before authentication");
473 triggerSearch(query, sort, targets);
474 switchView('records'); // In case it's configured to start off as hidden
479 function onSelectDdChange()
481 if (!m_submitted) return false;
484 m_paz.show(0, m_perpage, m_sort);
496 function triggerSearch (query, sort, targets)
501 // Re-use previous query/sort if new ones are not specified
509 m_filters.push({ id: targets, name: targets });
512 for (var i in m_filters) {
513 var filter = m_filters[i];
517 if (filter.id.match(/^[a-z:]+[=~]/)) {
518 debug("filter '" + filter.id + "' already begins with SETTING OP");
520 filter.id = 'pz:id=' + filter.id;
522 pp2filter += filter.id;
526 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
532 params.limit = pp2limit;
535 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
537 // We can use: params.torusquery = "udb=NAME"
538 // Note: that won't work when running against raw pazpar2
539 m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
543 function loadSelect ()
545 var node = findnode('.mkwsSort');
546 if (node.length && node.val() != m_sort) {
547 debug("changing m_sort from " + m_sort + " to " + node.val());
550 node = findnode('.mkwsPerpage');
551 if (node.length && node.val() != m_perpage) {
552 debug("changing m_perpage from " + m_perpage + " to " + node.val());
553 m_perpage = node.val();
558 // limit by target functions
559 that.limitTarget = function (id, name)
561 debug("limitTarget(id=" + id + ", name=" + name + ")");
562 m_filters.push({ id: id, name: name });
571 // limit the query after clicking the facet
572 that.limitQuery = function (field, value)
574 debug("limitQuery(field=" + field + ", value=" + value + ")");
575 m_filters.push({ field: field, value: value });
584 that.delimitTarget = function (id)
586 debug("delimitTarget(id=" + id + ")");
588 for (var i in m_filters) {
589 var filter = m_filters[i];
591 debug("delimitTarget() removing filter " + $.toJSON(filter));
593 debug("delimitTarget() keeping filter " + $.toJSON(filter));
594 newFilters.push(filter);
597 m_filters = newFilters;
607 that.delimitQuery = function (field, value)
609 debug("delimitQuery(field=" + field + ", value=" + value + ")");
611 for (var i in m_filters) {
612 var filter = m_filters[i];
614 field == filter.field &&
615 value == filter.value) {
616 debug("delimitQuery() removing filter " + $.toJSON(filter));
618 debug("delimitQuery() keeping filter " + $.toJSON(filter));
619 newFilters.push(filter);
622 m_filters = newFilters;
632 function redrawNavi ()
634 var navi = findnode('.mkwsNavi');
638 for (var i in m_filters) {
642 var filter = m_filters[i];
644 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
645 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
647 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
648 "', '" + filter.field + "', '" + filter.value + "'" +
649 ');return false;">' + filter.value + '</a>';
657 function drawPager (data)
659 var s = '<div style="float: right">' + M('Displaying') + ': '
660 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
661 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
662 + data.total + ')</div>';
664 //client indexes pages from 1 but pz2 from 0
666 var pages = Math.ceil(m_totalRec / m_perpage);
668 var firstClkbl = (m_curPage - onsides > 0)
669 ? m_curPage - onsides
672 var lastClkbl = firstClkbl + 2*onsides < pages
673 ? firstClkbl + 2*onsides
676 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
678 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
679 +'<< ' + M('Prev') + '</a><b> | </b>';
682 for(var i = firstClkbl; i <= lastClkbl; i++) {
685 numLabel = '<b>' + i + '</b>';
687 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
688 + numLabel + ' </a>';
691 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
692 if (pages - m_curPage > 0)
693 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
694 + M('Next') + ' >></a>';
701 if (lastClkbl < pages)
704 s += '<div style="float: clear">'
705 + prev + predots + middle + postdots + next + '</div>';
711 that.showPage = function (pageNum)
714 m_paz.showPage(m_curPage - 1);
718 // simple paging functions
719 that.pagerNext = function () {
720 if (m_totalRec - m_perpage*m_curPage > 0) {
727 that.pagerPrev = function () {
728 if (m_paz.showPrev() != false)
733 // switching view between targets and records
734 function switchView(view) {
735 var targets = findnode('.mkwsTargets');
736 var results = findnode('.mkwsResults,.mkwsRecords');
737 var blanket = findnode('.mkwsBlanket');
738 var motd = findnode('.mkwsMOTD');
742 if (targets) targets.css('display', 'block');
743 if (results) results.css('display', 'none');
744 if (blanket) blanket.css('display', 'none');
745 if (motd) motd.css('display', 'none');
748 if (targets) targets.css('display', 'none');
749 if (results) results.css('display', 'block');
750 if (blanket) blanket.css('display', 'block');
751 if (motd) motd.css('display', 'none');
754 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
755 if (targets) targets.css('display', 'none');
756 if (results) results.css('display', 'none');
757 if (blanket) blanket.css('display', 'none');
758 if (motd) motd.css('display', 'none');
761 alert("Unknown view '" + view + "'");
766 that.switchView = switchView;
769 // detailed record drawing
770 that.showDetails = function (prefixRecId) {
771 var recId = prefixRecId.replace('mkwsRec_', '');
772 var oldRecId = m_curDetRecId;
773 m_curDetRecId = recId;
775 // remove current detailed view if any
776 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
779 detRecordDiv.parentNode.removeChild(detRecordDiv);
781 // if the same clicked, just hide
782 if (recId == oldRecId) {
784 m_curDetRecData = null;
787 // request the record
788 debug("showDetails() requesting record '" + recId + "'");
793 function renderDetails(data, marker)
795 var template = loadTemplate("Record");
796 var details = template(data);
797 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
801 function loadTemplate(name)
803 var template = m_template[name];
805 if (template === undefined) {
806 // Fall back to generic template if there is no team-specific one
807 var node = findnode(".mkwsTemplate_" + name);
809 node = findnode(".mkwsTemplate_" + name, "ALL");
812 var source = node.html();
814 source = defaultTemplate(name);
817 template = Handlebars.compile(source);
818 debug("compiled template '" + name + "'");
819 m_template[name] = template;
826 function defaultTemplate(name)
828 if (name === 'Record') {
832 <th>{{translate "Title"}}</th>\
835 {{#if md-title-remainder}}\
836 ({{md-title-remainder}})\
838 {{#if md-title-responsibility}}\
839 <i>{{md-title-responsibility}}</i>\
845 <th>{{translate "Date"}}</th>\
846 <td>{{md-date}}</td>\
851 <th>{{translate "Author"}}</th>\
852 <td>{{md-author}}</td>\
855 {{#if md-electronic-url}}\
857 <th>{{translate "Links"}}</th>\
859 {{#each md-electronic-url}}\
860 <a href="{{this}}">Link{{index1}}</a>\
865 {{#if-any location having="md-subject"}}\
867 <th>{{translate "Subject"}}</th>\
869 {{#first location having="md-subject"}}\
871 {{#commaList md-subject}}\
872 {{this}}{{/commaList}}\
879 <th>{{translate "Locations"}}</th>\
881 {{#commaList location}}\
882 {{attr "@name"}}{{/commaList}}\
887 } else if (name === "Summary") {
889 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
892 {{#if md-title-remainder}}\
893 <span>{{md-title-remainder}}</span>\
895 {{#if md-title-responsibility}}\
896 <span><i>{{md-title-responsibility}}</i></span>\
901 var s = "There is no default '" + name +"' template!";
908 * All the HTML stuff to render the search forms and
911 function mkwsHtmlAll() {
913 if (mkws_config.show_lang)
916 debug("HTML search form");
917 mkws.handleNodeWithTeam(findnode('.mkwsSearch'), function(tname) {
919 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
920 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
921 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
925 debug("HTML records");
926 // If the team has a .mkwsResults, populate it in the usual
927 // way. If not, assume that it's a smarter application that
928 // defines its own subcomponents, some or all of the
935 if (findnode(".mkwsResults").length) {
936 findnode(".mkwsResults").html('\
937 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
939 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
940 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
942 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
943 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
944 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
945 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
946 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
951 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
957 var node = findnode(".mkwsRanking");
959 var ranking_data = '';
960 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
961 if (mkws_config.show_sort) {
962 ranking_data += M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
964 if (mkws_config.show_perpage) {
965 ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
967 ranking_data += '</form>';
969 node.html(ranking_data);
975 node = findnode('.mkwsSearchForm');
977 node.submit(onFormSubmitEventHandler);
978 node = findnode('.mkwsSort');
980 node.change(onSelectDdChange);
981 node = findnode('.mkwsPerpage');
983 node.change(onSelectDdChange);
985 // on first page, hide the termlist
986 $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
987 var motd = findnode(".mkwsMOTD");
988 var container = findnode(".mkwsMOTDContainer");
989 if (motd.length && container.length) {
990 // Move the MOTD from the provided element down into the container
991 motd.appendTo(container);
996 // implement $.parseQuerystring() for parsing URL parameters
997 function parseQuerystring() {
999 var qs = window.location.search.replace('?', '');
1000 var pairs = qs.split('&');
1001 $.each(pairs, function(i, v){
1002 var pair = v.split('=');
1003 nvpair[pair[0]] = pair[1];
1009 function mkwsSetLang() {
1010 var lang = parseQuerystring().lang || mkws_config.lang;
1011 if (!lang || !mkws.locale_lang[lang]) {
1012 mkws_config.lang = ""
1014 mkws_config.lang = lang;
1017 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
1018 return mkws_config.lang;
1022 function mkwsHtmlSwitch() {
1023 debug("HTML switch for team " + m_teamName);
1025 var node = findnode(".mkwsSwitch");
1026 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1027 node.append($("<span/>", { text: " | " }));
1028 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1030 debug("HTML targets");
1031 var node = findnode(".mkwsTargets");
1033 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1034 No information available yet.\
1036 node.css("display", "none");
1040 function mkwsHtmlSort() {
1041 debug("HTML sort, m_sort = '" + m_sort + "'");
1042 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1044 for(var i = 0; i < mkws_config.sort_options.length; i++) {
1045 var opt = mkws_config.sort_options[i];
1047 var val = opt.length == 1 ? opt[0] : opt[1];
1049 sort_html += '<option value="' + key + '"';
1050 if (m_sort == key || m_sort == val) {
1051 sort_html += ' selected="selected"';
1053 sort_html += '>' + M(val) + '</option>';
1055 sort_html += '</select>';
1061 function mkwsHtmlPerpage() {
1062 debug("HTML perpage, m_perpage = " + m_perpage);
1063 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1065 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1066 var key = mkws_config.perpage_options[i];
1068 perpage_html += '<option value="' + key + '"';
1069 if (key == m_perpage) {
1070 perpage_html += ' selected="selected"';
1072 perpage_html += '>' + key + '</option>';
1074 perpage_html += '</select>';
1076 return perpage_html;
1080 /* create locale language menu */
1081 function mkwsHtmlLang() {
1082 var lang_default = "en";
1083 var lang = mkws_config.lang || lang_default;
1086 /* display a list of configured languages, or all */
1087 var lang_options = mkws_config.lang_options || [];
1088 var toBeIncluded = {};
1089 for (var i = 0; i < lang_options.length; i++) {
1090 toBeIncluded[lang_options[i]] = true;
1093 for (var k in mkws.locale_lang) {
1094 if (toBeIncluded[k] || lang_options.length == 0)
1099 if (lang_options.length == 0 || toBeIncluded[lang_default])
1100 list.push(lang_default);
1102 debug("Language menu for: " + list.join(", "));
1106 for(var i = 0; i < list.length; i++) {
1113 data += ' <span>' + l + '</span> ';
1115 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1119 findnode(".mkwsLang").html(data);
1123 that.runAutoSearch = function() {
1124 // ### should check mkwsTermlist as well, for facet-only teams
1125 var node = findnode('.mkwsRecords');
1126 var query = node.attr('autosearch');
1130 if (query.match(/^!param!/)) {
1131 var param = query.replace(/^!param!/, '');
1132 query = getParameterByName(param);
1133 debug("obtained query '" + query + "' from param '" + param + "'");
1135 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1137 } else if (query.match(/^!path!/)) {
1138 var index = query.replace(/^!path!/, '');
1139 var path = window.location.pathname.split('/');
1140 query = path[path.length - index];
1141 debug("obtained query '" + query + "' from path-component '" + index + "'");
1143 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1147 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1149 var sort = node.attr('sort');
1150 var targets = node.attr('targets');
1151 var s = "running auto search: '" + query + "'";
1152 if (sort) s += " sorted by '" + sort + "'";
1153 if (targets) s += " in targets '" + targets + "'";
1156 newSearch(query, sort, targets);
1160 // This function is taken from a StackOverflow answer
1161 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1162 // ### should we unify this and parseQuerystring()?
1163 function getParameterByName(name) {
1164 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1165 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1166 results = regex.exec(location.search);
1167 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1173 var lang = mkws_config.lang;
1175 if (!lang || !mkws.locale_lang[lang])
1178 return mkws.locale_lang[lang][word] || word;
1180 mkws.M = M; // so the Handlebars helper can use it
1190 mkws_config.error = e.message;
1191 // alert(e.message);
1195 // Bizarrely, 'that' is just an empty hash. All its state is in
1196 // the closure variables defined earlier in this function.
1201 // wrapper to call team() after page load
1203 mkws.debug = function (string) {
1204 if (!mkws.debug_level)
1207 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1211 // you need to disable use strict at the top of the file!!!
1212 if (mkws.debug_level >= 3) {
1213 console.log(arguments.callee.caller);
1214 } else if (mkws.debug_level >= 2) {
1215 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1217 console.log(string);
1219 var debug = mkws.debug;
1222 mkws.handleNodeWithTeam = function(node, callback) {
1223 // First branch for DOM objects; second branch for jQuery objects
1224 var classes = node.className || node.attr('class');
1226 // For some reason, if we try to proceed when classes is
1227 // undefined, we don't get an error message, but this
1228 // function and its callers, up several stack level,
1229 // silently return. What a crock.
1230 mkws.debug("handleNodeWithTeam() called on node with no classes");
1233 var list = classes.split(/\s+/)
1236 for (var i = 0; i < list.length; i++) {
1237 var cname = list[i];
1238 if (cname.match(/^mkwsTeam_/)) {
1239 teamName = cname.replace(/^mkwsTeam_/, '');
1240 } else if (cname.match(/^mkws/)) {
1241 type = cname.replace(/^mkws/, '');
1244 callback.call(node, teamName, type);
1248 mkws.resizePage = function () {
1249 var list = ["mkwsSwitch", "mkwsLang"];
1251 var width = mkws_config.responsive_design_width;
1252 var parent = $(".mkwsTermlists").parent();
1254 if ($(window).width() <= width &&
1255 parent.hasClass("mkwsTermlistContainer1")) {
1256 debug("changing from wide to narrow: " + $(window).width());
1257 $(".mkwsTermlistContainer1").hide();
1258 $(".mkwsTermlistContainer2").show();
1259 for (var tname in mkws.teams) {
1260 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1261 for(var i = 0; i < list.length; i++) {
1262 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1265 } else if ($(window).width() > width &&
1266 parent.hasClass("mkwsTermlistContainer2")) {
1267 debug("changing from narrow to wide: " + $(window).width());
1268 $(".mkwsTermlistContainer1").show();
1269 $(".mkwsTermlistContainer2").hide();
1270 for (var tname in mkws.teams) {
1271 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1272 for(var i = 0; i < list.length; i++) {
1273 $("." + list[i] + ".mkwsTeam_" + tname).show();
1280 mkws.switchView = function(tname, view) {
1281 mkws.teams[tname].switchView(view);
1284 mkws.showDetails = function (tname, prefixRecId) {
1285 mkws.teams[tname].showDetails(prefixRecId);
1288 mkws.limitTarget = function (tname, id, name) {
1289 mkws.teams[tname].limitTarget(id, name);
1292 mkws.limitQuery = function (tname, field, value) {
1293 mkws.teams[tname].limitQuery(field, value);
1296 mkws.delimitTarget = function (tname, id) {
1297 mkws.teams[tname].delimitTarget(id);
1300 mkws.delimitQuery = function (tname, field, value) {
1301 mkws.teams[tname].delimitQuery(field, value);
1304 mkws.showPage = function (tname, pageNum) {
1305 mkws.teams[tname].showPage(pageNum);
1308 mkws.pagerPrev = function (tname) {
1309 mkws.teams[tname].pagerPrev();
1312 mkws.pagerNext = function (tname) {
1313 mkws.teams[tname].pagerNext();
1317 function defaultMkwsConfig() {
1318 /* default mkws config */
1319 var config_default = {
1320 use_service_proxy: true,
1321 pazpar2_url: "//mkws.indexdata.com/service-proxy/",
1322 service_proxy_auth: "//mkws.indexdata.com/service-proxy-auth",
1324 sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
1325 perpage_options: [10, 20, 30, 50],
1326 sort_default: "relevance",
1327 perpage_default: 20,
1329 show_lang: true, /* show/hide language menu */
1330 show_sort: true, /* show/hide sort menu */
1331 show_perpage: true, /* show/hide perpage menu */
1332 lang_options: [], /* display languages links for given languages, [] for all */
1333 facets: ["xtargets", "subject", "author"], /* display facets, in this order, [] for none */
1334 responsive_design_width: undefined, /* a page with less pixel width considered as narrow */
1335 debug_level: 1, /* debug level for development: 0..2 */
1340 /* Set global debug_level flag early so that debug() works */
1341 if (typeof mkws_config.debug_level !== 'undefined') {
1342 mkws.debug_level = mkws_config.debug_level;
1343 } else if (typeof config_default.debug_level !== 'undefined') {
1344 mkws.debug_level = config_default.debug_level;
1347 // make sure the mkws_config is a valid hash
1348 if (!$.isPlainObject(mkws_config)) {
1349 debug("ERROR: mkws_config is not an JS object, ignore it....");
1353 /* override standard config values by function parameters */
1354 for (var k in config_default) {
1355 if (typeof mkws_config[k] === 'undefined')
1356 mkws_config[k] = config_default[k];
1357 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1363 * Run service-proxy authentication in background (after page load).
1364 * The username/password is configured in the apache config file
1367 function authenticateSession(auth_url, auth_domain, pp2_url) {
1368 debug("Run service proxy auth URL: " + auth_url);
1371 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1372 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1375 var request = new pzHttpRequest(auth_url, function(err) {
1376 alert("HTTP call for authentication failed: " + err)
1380 request.get(null, function(data) {
1381 if (!$.isXMLDoc(data)) {
1382 alert("service proxy auth response document is not valid XML document, give up!");
1385 var status = $(data).find("status");
1386 if (status.text() != "OK") {
1387 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1391 debug("Service proxy auth successfully done");
1392 mkws.authenticated = true;
1398 function runAutoSearches() {
1399 debug("running auto searches");
1401 for (var teamName in mkws.teams) {
1402 mkws.teams[teamName].runAutoSearch();
1407 $(document).ready(function() {
1408 debug("on load ready");
1409 defaultMkwsConfig();
1411 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
1412 debug("Reset query width: " + mkws_config.query_width);
1413 mkws_config.query_width = 50;
1416 for (var key in mkws_config) {
1417 if (mkws_config.hasOwnProperty(key)) {
1418 if (key.match(/^language_/)) {
1419 var lang = key.replace(/^language_/, "");
1420 // Copy custom languages into list
1421 mkws.locale_lang[lang] = mkws_config[key];
1422 debug("Added locally configured language '" + lang + "'");
1427 if (mkws_config.responsive_design_width) {
1428 // Responsive web design - change layout on the fly based on
1429 // current screen width. Required for mobile devices.
1430 $(window).resize(function(e) { mkws.resizePage() });
1431 // initial check after page load
1432 $(document).ready(function() { mkws.resizePage() });
1435 // Backwards compatibility: set new magic class names on any
1436 // elements that have the old magic IDs.
1437 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1438 "Results", "Records", "Targets", "Ranking",
1439 "Termlists", "Stat", "MOTD" ];
1440 for (var i = 0; i < ids.length; i++) {
1441 var id = 'mkws' + ids[i];
1442 var node = $('#' + id);
1443 if (node.attr('id')) {
1445 debug("added magic class to '" + node.attr('id') + "'");
1449 // For all MKWS-classed nodes that don't have a team
1450 // specified, set the team to AUTO.
1451 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1452 if (!this.className.match(/mkwsTeam_/)) {
1453 debug("adding AUTO team to node with class '" + this.className + "'");
1454 $(this).addClass('mkwsTeam_AUTO');
1458 // Find all nodes with an class, and determine their team from
1459 // the mkwsTeam_* class. Make all team objects.
1461 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1462 mkws.handleNodeWithTeam(this, function(tname, type) {
1463 if (!mkws.teams[tname]) {
1464 mkws.teams[tname] = team(j, tname);
1465 debug("Made MKWS team '" + tname + "'");
1467 var myTeam = mkws.teams[tname];
1468 var myWidget = widget(j, myTeam, type, this);
1472 debug("Walking MKWS nodes took " + (now-then) + " ms");
1474 if (mkws_config.use_service_proxy) {
1475 authenticateSession(mkws_config.service_proxy_auth,
1476 mkws_config.service_proxy_auth_domain,
1477 mkws_config.pazpar2_url);