1 /* A very simple client that shows a basic usage of the pz2.js
4 "use strict"; // HTML5: disable for debug >= 2
7 * global config object: mkws_config
9 * needs to be defined in the HTML header before
10 * including this JS file
14 var mkws_config = {}; // for the guys who forgot to define mkws_config...
16 if (typeof mkws_config.use_service_proxy === 'undefined')
17 mkws_config.use_service_proxy = true;
22 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
23 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
25 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
26 var usesessions = mkws_config.use_service_proxy ? false : true;
29 var mkws_locale_lang = {
32 "Subjects": "Schlagwörter",
33 "Sources": "Daten und Quellen",
34 "Termlists": "Termlisten",
36 "Prev": "Zurück",
38 "Sort by": "Sortieren nach",
39 "and show": "und zeige",
40 "per page": "pro Seite",
41 "Displaying": "Zeige",
48 "Subject": "Schlagwort",
55 "Authors": "Forfattere",
58 "Termlists": "Termlists",
59 "Next": "Næste",
61 "Search": "Søg",
62 "Sort by": "Sorter efter",
64 "per page": "per side",
65 "Displaying": "Viser",
70 "Author": "Forfatter",
73 "Location": "Lokation",
80 for (var key in mkws_config) {
81 if (mkws_config.hasOwnProperty(key)) {
82 if (key.match(/^language_/)) {
83 var lang = key.replace(/^language_/, "");
84 // Copy custom languages into list
85 mkws_locale_lang[lang] = mkws_config[key];
91 // create a parameters array and pass it to the pz2's constructor
92 // then register the form submit event with the pz2.search function
93 // autoInit is set to true on default
94 var my_paz = new pz2( { "onshow": my_onshow,
95 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
96 "pazpar2path": pazpar2path,
100 "termlist": "xtargets,subject,author",
101 "onbytarget": my_onbytarget,
102 "usesessions" : usesessions,
103 "showResponseType": '', // or "json" (for debugging?)
104 "onrecord": my_onrecord } );
109 var curDetRecId = '';
110 var curDetRecData = null;
111 var curSort = 'relevance';
112 var curFilter = null;
113 var submitted = false;
119 // pz2.js event handlers:
121 function my_oninit() {
126 function my_onshow(data) {
127 totalRec = data.merged;
129 var pager = document.getElementById("mkwsPager");
130 pager.innerHTML = "";
131 pager.innerHTML +='<div style="float: right">' + M('Displaying') + ': '
132 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
133 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
134 + data.total + ')</div>';
137 var results = document.getElementById("mkwsRecords");
140 for (var i = 0; i < data.hits.length; i++) {
141 var hit = data.hits[i];
142 html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
143 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
144 +'<a href="#" id="mkwsRec_'+hit.recid
145 +'" onclick="showDetails(this.id);return false;"><b>'
146 + hit["md-title"] +' </b></a>');
147 if (hit["md-title-remainder"] !== undefined) {
148 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
150 if (hit["md-title-responsibility"] !== undefined) {
151 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
153 if (hit.recid == curDetRecId) {
154 html.push(renderDetails(curDetRecData));
158 replaceHtml(results, html.join(''));
161 function my_onstat(data) {
162 var stat = document.getElementById("mkwsStat");
166 stat.innerHTML = '<span class="head">Status info</span>' +
168 '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
170 '<span class="records">' + data.records + '/' + data.hits + '</span>';
173 function my_onterm(data) {
175 if (!mkws_config.facets || mkws_config.facets.length == 0) {
176 $("#mkwsTermlists").hide();
180 // display if we first got results
181 $("#mkwsTermlists").show();
184 acc.push('<div class="title">' + M('Termlists') + '</div>');
185 var facets = mkws_config.facets;
187 for(var i = 0; i < facets.length; i++) {
188 if (facets[i] == "sources") {
189 add_single_facet(acc, "Sources", data.xtargets, SourceMax, null);
190 } else if (facets[i] == "subjects") {
191 add_single_facet(acc, "Subjects", data.subject, SubjectMax, "su");
192 } else if (facets[i] == "authors") {
193 add_single_facet(acc, "Authors", data.author, AuthorMax, "au");
195 alert("bad facet configuration: '" + facets[i] + "'");
199 var termlist = document.getElementById("mkwsTermlists");
200 replaceHtml(termlist, acc.join(''));
202 if (mkws_config.responsive_design)
203 mkws_mobile_resize();
206 function add_single_facet(acc, caption, data, max, cclIndex) {
207 acc.push('<div class="facet">');
208 acc.push('<div class="termtitle">' + M(caption) + '</div>');
209 for (var i = 0; i < data.length && i < max; i++ ) {
210 acc.push('<a href="#" ');
213 // Special case: target selection
214 acc.push('target_id='+data[i].id+' ');
215 action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
217 action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
219 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
220 + '<span> (' + data[i].freq + ')</span><br/>');
225 function my_onrecord(data) {
226 // FIXME: record is async!!
227 clearTimeout(my_paz.recordTimer);
228 // in case on_show was faster to redraw element
229 var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
230 if (detRecordDiv) return;
231 curDetRecData = data;
232 var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
233 var html = renderDetails(curDetRecData);
234 recordDiv.innerHTML += html;
237 function my_onbytarget(data) {
238 var targetDiv = document.getElementById("mkwsBytarget");
239 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
240 +'<td>Records</td><td>State</td></tr></thead><tbody>';
242 for (var i = 0; i < data.length; i++ ) {
243 table += "<tr><td>" + data[i].id +
244 "</td><td>" + data[i].hits +
245 "</td><td>" + data[i].diagnostic +
246 "</td><td>" + data[i].records +
247 "</td><td>" + data[i].state + "</td></tr>";
250 table += '</tbody></table>';
251 targetDiv.innerHTML = table;
254 ////////////////////////////////////////////////////////////////////////////////
255 ////////////////////////////////////////////////////////////////////////////////
257 // wait until the DOM is ready
260 document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
261 document.mkwsSearchForm.mkwsQuery.value = '';
262 if (document.mkwsSelect) {
263 if (document.mkwsSelect.mkwsSort)
264 document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
265 if (document.mkwsSelect.mkwsPerpage)
266 document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
270 // when search button pressed
271 function onFormSubmitEventHandler()
276 switchView('records'); // In case it's configured to start off as hidden
281 function onSelectDdChange()
283 if (!submitted) return false;
286 my_paz.show(0, recPerPage, curSort);
296 function triggerSearch ()
298 my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter);
301 function loadSelect ()
303 if (document.mkwsSelect) {
304 if (document.mkwsSelect.mkwsSort)
305 curSort = document.mkwsSelect.mkwsSort.value;
306 if (document.mkwsSelect.mkwsPerpage)
307 recPerPage = document.mkwsSelect.mkwsPerpage.value;
311 // limit the query after clicking the facet
312 function limitQuery (field, value)
314 document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
315 onFormSubmitEventHandler();
318 // limit by target functions
319 function limitTarget (id, name)
321 var navi = document.getElementById('mkwsNavi');
323 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
325 curFilter = 'pz:id=' + id;
332 function delimitTarget ()
334 var navi = document.getElementById('mkwsNavi');
343 function drawPager (pagerDiv)
345 //client indexes pages from 1 but pz2 from 0
347 var pages = Math.ceil(totalRec / recPerPage);
349 var firstClkbl = ( curPage - onsides > 0 )
353 var lastClkbl = firstClkbl + 2*onsides < pages
354 ? firstClkbl + 2*onsides
357 var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
359 prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
360 +'<< ' + M('Prev') + '</a><b> | </b>';
363 for(var i = firstClkbl; i <= lastClkbl; i++) {
366 numLabel = '<b>' + i + '</b>';
368 middle += '<a href="#" onclick="showPage(' + i + ')"> '
369 + numLabel + ' </a>';
372 var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
373 if (pages - curPage > 0)
374 next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
375 + M('Next') + ' >></a>';
382 if (lastClkbl < pages)
385 pagerDiv.innerHTML += '<div style="float: clear">'
386 + prev + predots + middle + postdots + next + '</div>';
389 function showPage (pageNum)
392 my_paz.showPage( curPage - 1 );
395 // simple paging functions
397 function pagerNext() {
398 if ( totalRec - recPerPage*curPage > 0) {
404 function pagerPrev() {
405 if ( my_paz.showPrev() != false )
409 // switching view between targets and records
411 function switchView(view) {
412 var targets = document.getElementById('mkwsTargets');
413 var results = document.getElementById('mkwsResults') ||
414 document.getElementById('mkwsRecords');
415 var blanket = document.getElementById('mkwsBlanket');
416 var motd = document.getElementById('mkwsMOTD');
420 if (targets) targets.style.display = "block";
421 if (results) results.style.display = "none";
422 if (blanket) blanket.style.display = "none";
423 if (motd) motd.style.display = "none";
426 if (targets) targets.style.display = "none";
427 if (results) results.style.display = "block";
428 if (blanket) blanket.style.display = "block";
429 if (motd) motd.style.display = "none";
432 if (targets) targets.style.display = "none";
433 if (results) results.style.display = "none";
434 if (blanket) blanket.style.display = "none";
435 if (motd) motd.style.display = "none";
438 alert("Unknown view '" + view + "'");
442 // detailed record drawing
443 function showDetails (prefixRecId) {
444 var recId = prefixRecId.replace('mkwsRec_', '');
445 var oldRecId = curDetRecId;
448 // remove current detailed view if any
449 var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
452 detRecordDiv.parentNode.removeChild(detRecordDiv);
454 // if the same clicked, just hide
455 if (recId == oldRecId) {
457 curDetRecData = null;
460 // request the record
461 my_paz.record(recId);
464 function replaceHtml(el, html) {
465 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
466 /*@cc_on // Pure innerHTML is slightly faster in IE
467 oldEl.innerHTML = html;
470 var newEl = oldEl.cloneNode(false);
471 newEl.innerHTML = html;
472 oldEl.parentNode.replaceChild(newEl, oldEl);
473 /* Since we just removed the old element from the DOM, return a reference
474 to the new element, which can be used to restore variable references. */
478 function renderDetails(data, marker)
480 var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
481 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
483 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
484 details += renderField("Date", data["md-date"]);
485 details += renderField("Author", data["md-author"]);
486 details += renderField("URL", data["md-electronic-url"]);
487 details += renderField("Subject", data["location"][0]["md-subject"]);
488 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
489 details += '</table></div>';
494 function renderField(caption, data, data2, data3) {
495 if (data === undefined) {
499 if (caption == "URL") {
500 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
503 if (data2 != undefined) {
504 data = data + " (" + data2 + ")";
507 if (data3 != undefined) {
508 data = data + " <i>" + data3 + "</i>";
511 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
516 * All the HTML stuff to render the search forms and
519 function mkws_html_all(config) {
521 /* default mkws config */
522 var mkws_config_default = {
523 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
524 perpage: [10, 20, 30, 50],
525 sort_default: "relevance",
528 switch_menu: false, /* show/hide Records|Targets menu */
529 lang_menu: true, /* show/hide language menu */
530 sort_menu: true, /* show/hide sort menu */
531 perpage_menu: true, /* show/hide perpage menu */
532 lang_display: [], /* display languages links for given languages, [] for all */
533 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
534 responsive_design_width: 980, /* a page with less pixel width considered as mobile */
535 debug: 1, /* debug level for development: 0..2 */
540 /* set global debug flag early */
541 if (typeof config.debug !== 'undefined') {
542 mkws_debug = config.debug;
543 } else if (typeof mkws_config_default.debug !== 'undefined') {
544 mkws_debug = mkws_config_default.debug;
547 /* override standard config values by function parameters */
548 for (var k in mkws_config_default) {
549 if (typeof config[k] === 'undefined')
550 mkws_config[k] = mkws_config_default[k];
551 debug("Set config: " + k + ' => ' + mkws_config[k]);
554 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
555 debug("Reset query width: " + mkws_config.query_width);
556 mkws_config.query_width = 50;
559 mkws_set_lang(mkws_config);
560 if (mkws_config.lang_menu)
561 mkws_html_lang(mkws_config);
563 // For some reason, doing this programmatically results in
564 // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
565 debug("HTML search form");
566 $("#mkwsSearch").html('\
567 <form name="mkwsSearchForm" action="" >\
568 <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
569 <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
572 debug("HTML records");
573 // If the application has an #mkwsResults, populate it in the
574 // usual way. If not, assume that it's a smarter application that
575 // defines its own subcomponents:
581 if ($("#mkwsResults").length) {
582 $("#mkwsResults").html('\
583 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
585 <td width="250" valign="top">\
586 <div id="mkwsTermlists"></div>\
588 <td id="mkwsMOTDContainer" valign="top">\
589 <div id="mkwsRanking"></div>\
590 <div id="mkwsPager"></div>\
591 <div id="mkwsNavi"></div>\
592 <div id="mkwsRecords"></div>\
598 if ($("#mkwsRanking").length) {
599 var ranking_data = '';
600 ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
601 if (config.sort_menu) {
602 ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
604 if (config.perpage_menu) {
605 ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
607 ranking_data += '</form>';
609 $("#mkwsRanking").html(ranking_data);
612 mkws_html_switch(config);
614 if (mkws_config.use_service_proxy)
615 mkws_service_proxy_auth(config.service_proxy_auth);
617 if (mkws_config.responsive_design) {
618 // Responsive web design - change layout on the fly based on
619 // current screen width. Required for mobile devices.
621 $(window).resize( function(e) {
623 clearTimeout(timeout);
624 timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
627 // initial check after page load
628 $(document).ready(function() { mkws_mobile_resize() });
633 // on first page, hide the termlist
634 $(document).ready(function() { $("#mkwsTermlists").hide(); } );
635 var motd = document.getElementById("mkwsMOTD");
636 var container = document.getElementById("mkwsMOTDContainer");
637 if (motd && container) {
638 // Move the MOTD from the provided element down into the container
639 motd.parentNode.removeChild(motd);
640 container.appendChild(motd);
644 function mkws_set_lang(mkws_config) {
645 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
646 if (!lang || !mkws_locale_lang[lang]) {
647 mkws_config.lang = ""
649 mkws_config.lang = lang;
652 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
653 return mkws_config.lang;
656 function mkws_html_switch(config) {
657 debug("HTML switch");
659 $("#mkwsSwitch").html($("<a/>", {
661 onclick: "switchView(\'records\')",
664 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
665 $("#mkwsSwitch").append($("<a/>", {
667 onclick: "switchView(\'targets\')",
671 debug("HTML targets");
672 $("#mkwsTargets").html('\
673 <div id="mkwsBytarget">\
674 No information available yet.\
676 $("#mkwsTargets").css("display", "none");
678 if (!config.switch_menu) {
679 debug("disable switch menu");
680 $("#mkwsSwitch").css("display", "none");
684 function mkws_html_sort(config) {
686 var sort_html = '<select name="mkwsSort" id="mkwsSort">';
688 for(var i = 0; i < config.sort.length; i++) {
689 var key = config.sort[i][0];
690 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
692 sort_html += '<option value="' + key + '"';
693 if (key == config.sort_default) {
694 sort_html += ' selected="selected"';
696 sort_html += '>' + val + '</option>';
698 sort_html += '</select>';
703 function mkws_html_perpage(config) {
704 debug("HTML perpage");
705 var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
707 for(var i = 0; i < config.perpage.length; i++) {
708 var key = config.perpage[i];
710 perpage_html += '<option value="' + key + '"';
711 if (key == config.perpage_default) {
712 perpage_html += ' selected="selected"';
714 perpage_html += '>' + key + '</option>';
716 perpage_html += '</select>';
722 * Run service-proxy authentication in background (after page load).
723 * The username/password is configured in the apache config file
726 function mkws_service_proxy_auth(auth_url) {
728 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
730 debug("Run service proxy auth URL: " + auth_url);
732 var request = new pzHttpRequest(auth_url);
733 request.get(null, function(data) {
734 if (!jQuery.isXMLDoc(data)) {
735 alert("service proxy auth response document is not valid XML document, give up!");
738 var status = $(data).find("status");
739 if (status.text() != "OK") {
740 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
746 /* create locale language menu */
747 function mkws_html_lang(mkws_config) {
748 var lang_default = "en";
749 var lang = mkws_config.lang || lang_default;
752 /* display a list of configured languages, or all */
753 var lang_display = mkws_config.lang_display || [];
755 for (var i = 0; i < lang_display.length; i++) {
756 hash[lang_display[i]] = 1;
759 for (var k in mkws_locale_lang) {
760 if (hash[k] == 1 || lang_display.length == 0)
765 if (lang_display.length == 0 || hash[lang_default] == 1)
766 list.push(lang_default);
768 debug("Language menu for: " + list.join(", "));
772 for(var i = 0; i < list.length; i++) {
779 data += ' <span>' + l + '</span> ';
781 data += ' <a href="?lang=' + l + '">' + l + '</a> '
785 $("#mkwsLang").html(data);
788 function mkws_mobile_resize () {
789 debug("resize width: " + $(window).height() + ", width: " + $(window).width());
790 var list = ["mkwsSwitch"];
792 // alert($(window).width());
794 var width = mkws_config.responsive_design_width || 980;
796 if ($(window).width() <= width) {
797 for(var i = 0; i < list.length; i++) {
798 $("#" + list[i]).hide();
801 $("#mkwsTermlists").hide();
802 obj = $("#mkwsTermlists").html();
803 $("#mkwsShiftedTermlists").html(obj);
805 for(var i = 0; i < list.length; i++) {
806 $("#" + list[i]).show();
808 $("#mkwsTermlists").show();
809 $("#mkwsShiftedTermlists").html("");
815 var lang = mkws_config.lang;
817 if (!lang || !mkws_locale_lang[lang])
820 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
823 /* implement jQuery.parseQuerystring() for parsing URL parameters */
825 parseQuerystring: function() {
827 var qs = window.location.search.replace('?', '');
828 var pairs = qs.split('&');
829 $.each(pairs, function(i, v){
830 var pair = v.split('=');
831 nvpair[pair[0]] = pair[1];
835 pazpar2: function(data) {
836 document.write('<div id="mkwsSwitch"></div>\
837 <div id="mkwsLang"></div>\
838 <div id="mkwsSearch"></div>\
839 <div id="mkwsResults"></div>\
840 <div id="mkwsTargets"></div>\
841 <div id="mkwsFooter">\
842 <div id="mkwsStat"></div>\
843 <span>Powered by MKWS © 2013 <a target="_new" href="http://www.indexdata.com">Index Data</a></span>\
846 mkws_html_all(mkws_config);
850 function debug(string) {
854 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
858 // you need to disable use strict at the top of the file!!!
859 if (mkws_debug >= 3) {
860 console.log(arguments.callee.caller);
861 } else if (mkws_debug >= 2) {
862 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
868 $(document).ready(function() { mkws_html_all(mkws_config) });