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 windowid.
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 team objects. As much as possible, this uses
152 // only member variables (prefixed "m_") and inner functions with
153 // private scope. Some functions are visibl as member-functions to be
154 // called from outside code -- specifically, from generated
155 // HTML. These functions are that.switchView(), showDetails(),
156 // limitTarget(), limitQuery(), delimitTarget(), delimitQuery(),
157 // pagerPrev(), pagerNext(), showPage().
159 function team($, teamName) {
161 var m_teamName = teamName;
162 var m_submitted = false;
163 var m_query; // initially undefined
164 var m_sort; // will be set below
165 var m_perpage; // will be set below
169 var m_curDetRecId = '';
170 var m_curDetRecData = null;
172 // Timestamps for logging
176 var m_paz; // will be initialised below
180 var debug = function (s) {
182 var timestamp = ((now - m_debug_time.start)/1000).toFixed(3) + " (+" + ((now - m_debug_time.last)/1000).toFixed(3) + ") "
183 m_debug_time.last = now;
185 mkws.debug(m_teamName + ": " + timestamp + s);
188 debug("start running MKWS");
190 m_sort = mkws_config.sort_default;
191 debug("copied mkws_config.sort_default '" + mkws_config.sort_default + "' to m_sort");
193 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
194 debug("Reset query width: " + mkws_config.query_width);
195 mkws_config.query_width = 50;
198 for (var key in mkws_config) {
199 if (mkws_config.hasOwnProperty(key)) {
200 if (key.match(/^language_/)) {
201 var lang = key.replace(/^language_/, "");
202 // Copy custom languages into list
203 mkws.locale_lang[lang] = mkws_config[key];
204 debug("Added locally configured language '" + lang + "'");
209 // protocol independent link for pazpar2: "//mkws/sp" -> "https://mkws/sp"
210 if (mkws_config.pazpar2_url.match(/^\/\//)) {
211 mkws_config.pazpar2_url = document.location.protocol + mkws_config.pazpar2_url;
212 debug("adjust protocol independent links: " + mkws_config.pazpar2_url);
215 debug("Create main pz2 object");
216 // create a parameters array and pass it to the pz2's constructor
217 // then register the form submit event with the pz2.search function
218 // autoInit is set to true on default
219 m_paz = new pz2({ "onshow": my_onshow,
220 "windowid": teamName,
221 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
222 "pazpar2path": mkws_config.pazpar2_url,
225 "onterm": (mkws_config.facets.length ? my_onterm : undefined),
226 "termlist": mkws_config.facets.join(','),
227 "onbytarget": my_onbytarget,
228 "usesessions" : mkws_config.use_service_proxy ? false : true,
229 "showResponseType": '', // or "json" (for debugging?)
230 "onrecord": my_onrecord });
232 if (!isNaN(parseInt(mkws_config.perpage_default))) {
233 m_perpage = parseInt(mkws_config.perpage_default);
238 // pz2.js event handlers:
240 function my_oninit(teamName) {
247 function my_onshow(data, teamName) {
249 m_totalRec = data.merged;
251 var pager = $(".mkwsPager.mkwsTeam_" + m_teamName);
253 pager.html(drawPager(data))
256 var results = $(".mkwsRecords.mkwsTeam_" + m_teamName);
261 for (var i = 0; i < data.hits.length; i++) {
262 var hit = data.hits[i];
263 html.push('<div class="record" id="mkwsRecdiv_' + teamName + '_' + hit.recid + '" >',
266 if (hit.recid == m_curDetRecId) {
268 html.push(renderDetails(m_curDetRecData));
271 results.html(html.join(''));
275 function renderSummary(hit)
277 var template = loadTemplate("Summary");
278 hit._id = "mkwsRec_" + hit.recid;
279 hit._onclick = "mkws.showDetails('" + m_teamName + "', this.id);return false;"
280 return template(hit);
284 function my_onstat(data, teamName) {
286 var stat = $('.mkwsStat.mkwsTeam_' + teamName);
287 if (stat.length === 0)
290 stat.html('<span class="head">' + M('Status info') + '</span>' +
292 '<span class="clients">' + M('Active clients') + ': ' + data.activeclients + '/' + data.clients + '</span>' +
294 '<span class="records">' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + '</span>');
298 function my_onterm(data, teamName) {
300 var node = $(".mkwsTermlists.mkwsTeam_" + teamName);
301 if (node.length == 0) return;
303 // no facets: this should never happen
304 if (!mkws_config.facets || mkws_config.facets.length == 0) {
305 alert("my_onterm called even though we have no facets: " + $.toJSON(data));
310 // display if we first got results
314 acc.push('<div class="title">' + M('Termlists') + '</div>');
315 var facets = mkws_config.facets;
317 for(var i = 0; i < facets.length; i++) {
318 if (facets[i] == "xtargets") {
319 add_single_facet(acc, "Sources", data.xtargets, 16, null);
320 } else if (facets[i] == "subject") {
321 add_single_facet(acc, "Subjects", data.subject, 10, "subject");
322 } else if (facets[i] == "author") {
323 add_single_facet(acc, "Authors", data.author, 10, "author");
325 alert("bad facet configuration: '" + facets[i] + "'");
329 node.html(acc.join(''));
333 function add_single_facet(acc, caption, data, max, pzIndex) {
334 acc.push('<div class="facet mkwsFacet' + caption + ' mkwsTeam_' + m_teamName + '">');
335 acc.push('<div class="termtitle">' + M(caption) + '</div>');
336 for (var i = 0; i < data.length && i < max; i++) {
337 acc.push('<div class="term">');
338 acc.push('<a href="#" ');
341 // Special case: target selection
342 acc.push('target_id='+data[i].id+' ');
343 if (!target_filtered(data[i].id)) {
344 action = 'mkws.limitTarget(\'' + m_teamName + '\', this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
347 action = 'mkws.limitQuery(\'' + m_teamName + '\', \'' + pzIndex + '\', this.firstChild.nodeValue)';
349 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
350 + ' <span>' + data[i].freq + '</span>');
357 function target_filtered(id) {
358 for (var i = 0; i < m_filters.length; i++) {
359 if (m_filters[i].id === id ||
360 m_filters[i].id === 'pz:id=' + id) {
368 function my_onrecord(data, args, teamName) {
369 debug("record: teamName=" + teamName + ", m_teamName=" + m_teamName);
370 // FIXME: record is async!!
371 clearTimeout(m_paz.recordTimer);
372 // in case on_show was faster to redraw element
373 var detRecordDiv = document.getElementById('mkwsDet_' + teamName + '_' + data.recid);
374 if (detRecordDiv) return;
375 m_curDetRecData = data;
376 var recordDiv = document.getElementById('mkwsRecdiv_' + teamName + '_' + m_curDetRecData.recid);
377 var html = renderDetails(m_curDetRecData);
378 recordDiv.innerHTML += html;
382 function my_onbytarget(data, teamName) {
384 var targetDiv = $('.mkwsBytarget.mkwsTeam_' + teamName);
389 var table ='<table><thead><tr>' +
390 '<td>' + M('Target ID') + '</td>' +
391 '<td>' + M('Hits') + '</td>' +
392 '<td>' + M('Diags') + '</td>' +
393 '<td>' + M('Records') + '</td>' +
394 '<td>' + M('State') + '</td>' +
395 '</tr></thead><tbody>';
397 for (var i = 0; i < data.length; i++) {
398 table += "<tr><td>" + data[i].id +
399 "</td><td>" + data[i].hits +
400 "</td><td>" + data[i].diagnostic +
401 "</td><td>" + data[i].records +
402 "</td><td>" + data[i].state + "</td></tr>";
405 table += '</tbody></table>';
406 targetDiv.html(table);
409 ////////////////////////////////////////////////////////////////////////////////
410 ////////////////////////////////////////////////////////////////////////////////
413 // when search button pressed
414 function onFormSubmitEventHandler()
416 mkws.handle_node_with_team(this, function (tname) {
417 var val = $('.mkwsQuery.mkwsTeam_' + tname).val();
418 mkws.teams[tname].newSearch(val);
425 that.newSearch = function(query, sort, targets, windowid)
427 debug("newSearch: " + query);
429 if (mkws_config.use_service_proxy && !mkws.authenticated) {
430 alert("searching before authentication");
438 triggerSearch(query, sort, targets, windowid);
439 that.switchView('records'); // In case it's configured to start off as hidden
444 function onSelectDdChange()
446 if (!m_submitted) return false;
449 m_paz.show(0, m_perpage, m_sort);
461 function triggerSearch (query, sort, targets, windowid)
466 // Re-use previous query/sort if new ones are not specified
474 // ### should support multiple |-separated targets
475 m_filters.push({ id: targets, name: targets });
478 for (var i in m_filters) {
479 var filter = m_filters[i];
483 if (filter.id.match(/^[a-z:]+[=~]/)) {
484 debug("filter '" + filter.id + "' already begins with SETTING OP");
486 filter.id = 'pz:id=' + filter.id;
488 pp2filter += filter.id;
492 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
498 params.limit = pp2limit;
501 params.windowid = windowid;
503 debug("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
505 // We can use: params.torusquery = "udb=NAME"
506 m_paz.search(m_query, m_perpage, m_sort, pp2filter, undefined, params);
510 function loadSelect ()
512 var node = $('.mkwsSort.mkwsTeam_' + m_teamName);
513 if (node.length && node.val() != m_sort) {
514 debug("changing m_sort from " + m_sort + " to " + node.val());
517 node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
518 if (node.length && node.val() != m_perpage) {
519 debug("changing m_perpage from " + m_perpage + " to " + node.val());
520 m_perpage = node.val();
525 // limit by target functions
526 that.limitTarget = function (id, name)
528 debug("limitTarget(id=" + id + ", name=" + name + ")");
529 m_filters.push({ id: id, name: name });
538 // limit the query after clicking the facet
539 that.limitQuery = function (field, value)
541 debug("limitQuery(field=" + field + ", value=" + value + ")");
542 m_filters.push({ field: field, value: value });
551 that.delimitTarget = function (id)
553 debug("delimitTarget(id=" + id + ")");
555 for (var i in m_filters) {
556 var filter = m_filters[i];
558 debug("delimitTarget() removing filter " + $.toJSON(filter));
560 debug("delimitTarget() keeping filter " + $.toJSON(filter));
561 newFilters.push(filter);
564 m_filters = newFilters;
574 that.delimitQuery = function (field, value)
576 debug("delimitQuery(field=" + field + ", value=" + value + ")");
578 for (var i in m_filters) {
579 var filter = m_filters[i];
581 field == filter.field &&
582 value == filter.value) {
583 debug("delimitQuery() removing filter " + $.toJSON(filter));
585 debug("delimitQuery() keeping filter " + $.toJSON(filter));
586 newFilters.push(filter);
589 m_filters = newFilters;
599 function redraw_navi ()
601 var navi = $('.mkwsNavi.mkwsTeam_' + m_teamName);
605 for (var i in m_filters) {
609 var filter = m_filters[i];
611 text += M('source') + ': <a class="crossout" href="#" onclick="mkws.delimitTarget(\'' + m_teamName +
612 "', '" + filter.id + "'" + ');return false;">' + filter.name + '</a>';
614 text += M(filter.field) + ': <a class="crossout" href="#" onclick="mkws.delimitQuery(\'' + m_teamName +
615 "', '" + filter.field + "', '" + filter.value + "'" +
616 ');return false;">' + filter.value + '</a>';
624 function drawPager (data)
626 var s = '<div style="float: right">' + M('Displaying') + ': '
627 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
628 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
629 + data.total + ')</div>';
631 //client indexes pages from 1 but pz2 from 0
633 var pages = Math.ceil(m_totalRec / m_perpage);
635 var firstClkbl = (m_curPage - onsides > 0)
636 ? m_curPage - onsides
639 var lastClkbl = firstClkbl + 2*onsides < pages
640 ? firstClkbl + 2*onsides
643 var prev = '<span class="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
645 prev = '<a href="#" class="mkwsPrev" onclick="mkws.pagerPrev(\'' + m_teamName + '\');">'
646 +'<< ' + M('Prev') + '</a><b> | </b>';
649 for(var i = firstClkbl; i <= lastClkbl; i++) {
652 numLabel = '<b>' + i + '</b>';
654 middle += '<a href="#" onclick="mkws.showPage(\'' + m_teamName + '\', ' + i + ')"> '
655 + numLabel + ' </a>';
658 var next = '<b> | </b><span class="mkwsNext">' + M('Next') + ' >></span>';
659 if (pages - m_curPage > 0)
660 next = '<b> | </b><a href="#" class="mkwsNext" onclick="mkws.pagerNext(\'' + m_teamName + '\')">'
661 + M('Next') + ' >></a>';
668 if (lastClkbl < pages)
671 s += '<div style="float: clear">'
672 + prev + predots + middle + postdots + next + '</div>';
678 that.showPage = function (pageNum)
681 m_paz.showPage(m_curPage - 1);
685 // simple paging functions
686 that.pagerNext = function () {
687 if (m_totalRec - m_perpage*m_curPage > 0) {
694 that.pagerPrev = function () {
695 if (m_paz.showPrev() != false)
700 // switching view between targets and records
701 that.switchView = function(view) {
702 var targets = $('.mkwsTargets.mkwsTeam_' + m_teamName);
703 var results = $('.mkwsResults.mkwsTeam_' + m_teamName + ',.mkwsRecords.mkwsTeam_' + m_teamName);
704 var blanket = $('.mkwsBlanket.mkwsTeam_' + m_teamName);
705 var motd = $('.mkwsMOTD.mkwsTeam_' + m_teamName);
709 if (targets) targets.css('display', 'block');
710 if (results) results.css('display', 'none');
711 if (blanket) blanket.css('display', 'none');
712 if (motd) motd.css('display', 'none');
715 if (targets) targets.css('display', 'none');
716 if (results) results.css('display', 'block');
717 if (blanket) blanket.css('display', 'block');
718 if (motd) motd.css('display', 'none');
721 alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
722 if (targets) targets.css('display', 'none');
723 if (results) results.css('display', 'none');
724 if (blanket) blanket.css('display', 'none');
725 if (motd) motd.css('display', 'none');
728 alert("Unknown view '" + view + "'");
733 // detailed record drawing
734 that.showDetails = function (prefixRecId) {
735 var recId = prefixRecId.replace('mkwsRec_', '');
736 var oldRecId = m_curDetRecId;
737 m_curDetRecId = recId;
739 // remove current detailed view if any
740 var detRecordDiv = document.getElementById('mkwsDet_' + m_teamName + '_' + oldRecId);
743 detRecordDiv.parentNode.removeChild(detRecordDiv);
745 // if the same clicked, just hide
746 if (recId == oldRecId) {
748 m_curDetRecData = null;
751 // request the record
752 debug("showDetails() requesting record '" + recId + "'");
757 function renderDetails(data, marker)
759 var template = loadTemplate("Record");
760 var details = template(data);
761 return '<div class="details" id="mkwsDet_' + m_teamName + '_' + data.recid + '">' + details + '</div>';
765 function loadTemplate(name)
767 var template = m_template[name];
769 if (template === undefined) {
770 // Fall back to generic template if there is no team-specific one
771 var node = $(".mkwsTemplate_" + name + ".mkwsTeam_" + m_teamName)
773 node = $(".mkwsTemplate_" + name + ".mkwsTeam_ALL")
776 var source = node.html();
778 source = defaultTemplate(name);
781 template = Handlebars.compile(source);
782 debug("compiled template '" + name + "'");
783 m_template[name] = template;
790 function defaultTemplate(name)
792 if (name === 'Record') {
796 <th>{{translate "Title"}}</th>\
799 {{#if md-title-remainder}}\
800 ({{md-title-remainder}})\
802 {{#if md-title-responsibility}}\
803 <i>{{md-title-responsibility}}</i>\
809 <th>{{translate "Date"}}</th>\
810 <td>{{md-date}}</td>\
815 <th>{{translate "Author"}}</th>\
816 <td>{{md-author}}</td>\
819 {{#if md-electronic-url}}\
821 <th>{{translate "Links"}}</th>\
823 {{#each md-electronic-url}}\
824 <a href="{{this}}">Link{{index1}}</a>\
829 {{#if-any location having="md-subject"}}\
831 <th>{{translate "Subject"}}</th>\
833 {{#first location having="md-subject"}}\
835 {{#commaList md-subject}}\
836 {{this}}{{/commaList}}\
843 <th>{{translate "Locations"}}</th>\
845 {{#commaList location}}\
846 {{attr "@name"}}{{/commaList}}\
851 } else if (name === "Summary") {
853 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
856 {{#if md-title-remainder}}\
857 <span>{{md-title-remainder}}</span>\
859 {{#if md-title-responsibility}}\
860 <span><i>{{md-title-responsibility}}</i></span>\
865 var s = "There is no default '" + name +"' template!";
872 * All the HTML stuff to render the search forms and
875 function mkws_html_all() {
877 if (mkws_config.show_lang)
880 debug("HTML search form");
881 // ### There is only one match here by design: fix not to bother looping
882 $('.mkwsSearch.mkwsTeam_' + m_teamName).each(function (i, obj) {
884 mkws.handle_node_with_team(node, function(tname) {
886 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + tname + '" action="" >\
887 <input class="mkwsQuery mkwsTeam_' + tname + '" type="text" size="' + mkws_config.query_width + '" />\
888 <input class="mkwsButton mkwsTeam_' + tname + '" type="submit" value="' + M('Search') + '" />\
893 debug("HTML records");
894 // If the team has a .mkwsResults, populate it in the usual
895 // way. If not, assume that it's a smarter application that
896 // defines its own subcomponents, some or all of the
903 if ($(".mkwsResults.mkwsTeam_" + m_teamName).length) {
904 $(".mkwsResults.mkwsTeam_" + m_teamName).html('\
905 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
907 <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
908 <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
910 <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
911 <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
912 <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
913 <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
914 <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
919 <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
925 var node = $(".mkwsRanking.mkwsTeam_" + m_teamName);
927 var ranking_data = '';
928 ranking_data += '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
929 if (mkws_config.show_sort) {
930 ranking_data += M('Sort by') + ' ' + mkws_html_sort() + ' ';
932 if (mkws_config.show_perpage) {
933 ranking_data += M('and show') + ' ' + mkws_html_perpage() + ' ' + M('per page') + '.';
935 ranking_data += '</form>';
937 node.html(ranking_data);
942 // ### Should not be in the team code, since window size is global
943 if (mkws_config.responsive_design_width) {
944 // Responsive web design - change layout on the fly based on
945 // current screen width. Required for mobile devices.
946 $(window).resize(function(e) { mkws.resize_page() });
947 // initial check after page load
948 $(document).ready(function() { mkws.resize_page() });
951 $('.mkwsSearchForm.mkwsTeam_' + m_teamName).each(function (i, obj) {
952 debug("adding search-forms for team '" + m_teamName + "'");
954 mkws.handle_node_with_team(node, function(tname) {
955 debug("adding search-form '" + tname + "' for team '" + m_teamName + "'");
956 $(node).submit(onFormSubmitEventHandler);
960 node = $('.mkwsSort.mkwsTeam_' + m_teamName);
962 node.change(onSelectDdChange);
963 node = $('.mkwsPerpage.mkwsTeam_' + m_teamName);
965 node.change(onSelectDdChange);
967 // on first page, hide the termlist
968 $(document).ready(function() { $(".mkwsTermlists.mkwsTeam_" + m_teamName).hide(); });
969 var motd = $(".mkwsMOTD.mkwsTeam_" + m_teamName);
970 var container = $(".mkwsMOTDContainer.mkwsTeam_" + m_teamName);
971 if (motd.length && container.length) {
972 // Move the MOTD from the provided element down into the container
973 motd.appendTo(container);
978 // implement $.parseQuerystring() for parsing URL parameters
979 function parseQuerystring() {
981 var qs = window.location.search.replace('?', '');
982 var pairs = qs.split('&');
983 $.each(pairs, function(i, v){
984 var pair = v.split('=');
985 nvpair[pair[0]] = pair[1];
991 function mkws_set_lang() {
992 var lang = parseQuerystring().lang || mkws_config.lang;
993 if (!lang || !mkws.locale_lang[lang]) {
994 mkws_config.lang = ""
996 mkws_config.lang = lang;
999 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
1000 return mkws_config.lang;
1004 function mkws_html_switch() {
1005 debug("HTML switch for team " + m_teamName);
1007 var node = $(".mkwsSwitch.mkwsTeam_" + m_teamName);
1008 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
1009 node.append($("<span/>", { text: " | " }));
1010 node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
1012 debug("HTML targets");
1013 var node = $(".mkwsTargets.mkwsTeam_" + m_teamName);
1015 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
1016 No information available yet.\
1018 node.css("display", "none");
1022 function mkws_html_sort() {
1023 debug("HTML sort, m_sort = '" + m_sort + "'");
1024 var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
1026 for(var i = 0; i < mkws_config.sort_options.length; i++) {
1027 var opt = mkws_config.sort_options[i];
1029 var val = opt.length == 1 ? opt[0] : opt[1];
1031 sort_html += '<option value="' + key + '"';
1032 if (m_sort == key || m_sort == val) {
1033 sort_html += ' selected="selected"';
1035 sort_html += '>' + M(val) + '</option>';
1037 sort_html += '</select>';
1043 function mkws_html_perpage() {
1044 debug("HTML perpage, m_perpage = " + m_perpage);
1045 var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
1047 for(var i = 0; i < mkws_config.perpage_options.length; i++) {
1048 var key = mkws_config.perpage_options[i];
1050 perpage_html += '<option value="' + key + '"';
1051 if (key == m_perpage) {
1052 perpage_html += ' selected="selected"';
1054 perpage_html += '>' + key + '</option>';
1056 perpage_html += '</select>';
1058 return perpage_html;
1062 /* create locale language menu */
1063 function mkws_html_lang() {
1064 var lang_default = "en";
1065 var lang = mkws_config.lang || lang_default;
1068 /* display a list of configured languages, or all */
1069 var lang_options = mkws_config.lang_options || [];
1070 var toBeIncluded = {};
1071 for (var i = 0; i < lang_options.length; i++) {
1072 toBeIncluded[lang_options[i]] = true;
1075 for (var k in mkws.locale_lang) {
1076 if (toBeIncluded[k] || lang_options.length == 0)
1081 if (lang_options.length == 0 || toBeIncluded[lang_default])
1082 list.push(lang_default);
1084 debug("Language menu for: " + list.join(", "));
1088 for(var i = 0; i < list.length; i++) {
1095 data += ' <span>' + l + '</span> ';
1097 data += ' <a href="?lang=' + l + '">' + l + '</a> '
1101 $(".mkwsLang.mkwsTeam_" + m_teamName).html(data);
1105 that.run_auto_search = function() {
1106 // ### should check mkwsTermlist as well, for facet-only teams
1107 var node = $('.mkwsRecords.mkwsTeam_' + m_teamName);
1108 var query = node.attr('autosearch');
1112 if (query.match(/^!param!/)) {
1113 var param = query.replace(/^!param!/, '');
1114 query = getParameterByName(param);
1115 debug("obtained query '" + query + "' from param '" + param + "'");
1117 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
1119 } else if (query.match(/^!path!/)) {
1120 var index = query.replace(/^!path!/, '');
1121 var path = window.location.pathname.split('/');
1122 query = path[path.length - index];
1123 debug("obtained query '" + query + "' from path-component '" + index + "'");
1125 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
1129 debug("node=" + node + ", class='" + node.className + "', query=" + query);
1131 var sort = node.attr('sort');
1132 var targets = node.attr('targets');
1133 var s = "running auto search: '" + query + "'";
1134 if (sort) s += " sorted by '" + sort + "'";
1135 if (targets) s += " in targets '" + targets + "'";
1138 this.newSearch(query, sort, targets, m_teamName);
1142 // This function is taken from a StackOverflow answer
1143 // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
1144 function getParameterByName(name) {
1145 name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
1146 var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
1147 results = regex.exec(location.search);
1148 return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
1154 var lang = mkws_config.lang;
1156 if (!lang || !mkws.locale_lang[lang])
1159 return mkws.locale_lang[lang][word] || word;
1161 mkws.M = M; // so the Handlebars helper can use it
1171 mkws_config.error = e.message;
1172 // alert(e.message);
1176 // Bizarrely, 'that' is just an empty hash. All its state is in
1177 // the closure variables defined earlier in this function.
1182 // wrapper to call team() after page load
1184 mkws.debug = function (string) {
1185 if (!mkws.debug_level)
1188 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
1192 // you need to disable use strict at the top of the file!!!
1193 if (mkws.debug_level >= 3) {
1194 console.log(arguments.callee.caller);
1195 } else if (mkws.debug_level >= 2) {
1196 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
1198 console.log(string);
1200 var debug = mkws.debug;
1203 mkws.handle_node_with_team = function(node, callback) {
1204 var classes = node.className;
1205 var list = classes.split(/\s+/)
1207 for (var i = 0; i < list.length; i++) {
1208 var cname = list[i];
1209 if (cname.match(/^mkwsTeam_/)) {
1210 tname = cname.replace(/^mkwsTeam_/, '');
1217 mkws.resize_page = function () {
1218 var list = ["mkwsSwitch", "mkwsLang"];
1220 var width = mkws_config.responsive_design_width;
1221 var parent = $(".mkwsTermlists").parent();
1223 if ($(window).width() <= width &&
1224 parent.hasClass("mkwsTermlistContainer1")) {
1225 debug("changing from wide to narrow: " + $(window).width());
1226 $(".mkwsTermlistContainer1").hide();
1227 $(".mkwsTermlistContainer2").show();
1228 for (var tname in mkws.teams) {
1229 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer2.mkwsTeam_" + tname));
1230 for(var i = 0; i < list.length; i++) {
1231 $("." + list[i] + ".mkwsTeam_" + tname).hide();
1234 } else if ($(window).width() > width &&
1235 parent.hasClass("mkwsTermlistContainer2")) {
1236 debug("changing from narrow to wide: " + $(window).width());
1237 $(".mkwsTermlistContainer1").show();
1238 $(".mkwsTermlistContainer2").hide();
1239 for (var tname in mkws.teams) {
1240 $(".mkwsTermlists.mkwsTeam_" + tname).appendTo($(".mkwsTermlistContainer1.mkwsTeam_" + tname));
1241 for(var i = 0; i < list.length; i++) {
1242 $("." + list[i] + ".mkwsTeam_" + tname).show();
1249 mkws.switchView = function(tname, view) {
1250 mkws.teams[tname].switchView(view);
1253 mkws.showDetails = function (tname, prefixRecId) {
1254 mkws.teams[tname].showDetails(prefixRecId);
1257 mkws.limitTarget = function (tname, id, name) {
1258 mkws.teams[tname].limitTarget(id, name);
1261 mkws.limitQuery = function (tname, field, value) {
1262 mkws.teams[tname].limitQuery(field, value);
1265 mkws.delimitTarget = function (tname, id) {
1266 mkws.teams[tname].delimitTarget(id);
1269 mkws.delimitQuery = function (tname, field, value) {
1270 mkws.teams[tname].delimitQuery(field, value);
1273 mkws.showPage = function (tname, pageNum) {
1274 mkws.teams[tname].showPage(pageNum);
1277 mkws.pagerPrev = function (tname) {
1278 mkws.teams[tname].pagerPrev();
1281 mkws.pagerNext = function (tname) {
1282 mkws.teams[tname].pagerNext();
1286 function default_mkws_config() {
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 debug_level: 1, /* debug level for development: 0..2 */
1309 /* Set global debug_level flag early so that debug() works */
1310 if (typeof mkws_config.debug_level !== 'undefined') {
1311 mkws.debug_level = mkws_config.debug_level;
1312 } else if (typeof config_default.debug_level !== 'undefined') {
1313 mkws.debug_level = config_default.debug_level;
1316 // make sure the mkws_config is a valid hash
1317 if (!$.isPlainObject(mkws_config)) {
1318 debug("ERROR: mkws_config is not an JS object, ignore it....");
1322 /* override standard config values by function parameters */
1323 for (var k in config_default) {
1324 if (typeof mkws_config[k] === 'undefined')
1325 mkws_config[k] = config_default[k];
1326 //debug("Set config: " + k + ' => ' + mkws_config[k]);
1332 * Run service-proxy authentication in background (after page load).
1333 * The username/password is configured in the apache config file
1336 function authenticate_session(auth_url, auth_domain, pp2_url) {
1337 debug("Run service proxy auth URL: " + auth_url);
1340 auth_domain = pp2_url.replace(/^(https?:)?\/\/(.*?)\/.*/, '$2');
1341 debug("guessed auth_domain '" + auth_domain + "' from pp2_url '" + pp2_url + "'");
1344 var request = new pzHttpRequest(auth_url, function(err) {
1345 alert("HTTP call for authentication failed: " + err)
1349 request.get(null, function(data) {
1350 if (!$.isXMLDoc(data)) {
1351 alert("service proxy auth response document is not valid XML document, give up!");
1354 var status = $(data).find("status");
1355 if (status.text() != "OK") {
1356 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
1360 debug("Service proxy auth successfully done");
1361 mkws.authenticated = true;
1362 run_auto_searches();
1367 function run_auto_searches() {
1368 debug("running auto searches");
1370 for (var teamName in mkws.teams) {
1371 mkws.teams[teamName].run_auto_search();
1376 $(document).ready(function() {
1377 debug("on load ready");
1378 default_mkws_config();
1380 // Backwards compatibility: set new magic class names on any
1381 // elements that have the old magic IDs.
1382 var ids = [ "Switch", "Lang", "Search", "Pager", "Navi",
1383 "Results", "Records", "Targets", "Ranking",
1384 "Termlists", "Stat" ];
1385 for (var i = 0; i < ids.length; i++) {
1386 var id = 'mkws' + ids[i];
1387 var node = $('#' + id);
1388 if (node.attr('id')) {
1390 debug("added magic class to '" + node.attr('id') + "'");
1394 // For all MKWS-classed nodes that don't have a team
1395 // specified, set the team to AUTO.
1396 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1397 if (!this.className.match(/mkwsTeam_/)) {
1398 debug("adding AUTO team to node with class '" + this.className + "'");
1399 $(this).addClass('mkwsTeam_AUTO');
1403 // Find all nodes with an class, and determine their team from
1404 // the mkwsTeam_* class. Make all team objects.
1406 $('[class^="mkws"],[class*=" mkws"]').each(function () {
1408 mkws.handle_node_with_team(node, function(tname) {
1409 if (!mkws.teams[tname]) {
1410 mkws.teams[tname] = team(j, tname);
1411 debug("Made MKWS team '" + tname + "'");
1416 debug("Walking MKWS nodes took " + (now-then) + " ms");
1418 if (mkws_config.use_service_proxy) {
1419 authenticate_session(mkws_config.service_proxy_auth,
1420 mkws_config.service_proxy_auth_domain,
1421 mkws_config.pazpar2_url);
1424 run_auto_searches();