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;
21 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
22 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/";
24 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
25 var usesessions = mkws_config.use_service_proxy ? false : true;
28 var mkws_locale_lang = {
31 "Subjects": "Schlagwörter",
32 "Sources": "Daten und Quellen",
33 "Termlists": "Termlisten",
35 "Prev": "Zurück",
37 "Sort by": "Sortieren nach",
38 "and show": "und zeige",
39 "per page": "pro Seite",
40 "Displaying": "Zeige",
47 "Subject": "Schlagwort",
54 "Authors": "Forfattere",
57 "Termlists": "Termlists",
58 "Next": "Næste",
60 "Search": "Søg",
61 "Sort by": "Sorter efter",
63 "per page": "per side",
64 "Displaying": "Viser",
69 "Author": "Forfatter",
72 "Location": "Lokation",
78 // create a parameters array and pass it to the pz2's constructor
79 // then register the form submit event with the pz2.search function
80 // autoInit is set to true on default
81 var my_paz = new pz2( { "onshow": my_onshow,
82 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
83 "pazpar2path": pazpar2path,
87 "termlist": "xtargets,subject,author",
88 "onbytarget": my_onbytarget,
89 "usesessions" : usesessions,
90 "showResponseType": '', // or "json" (for debugging?)
91 "onrecord": my_onrecord } );
97 var curDetRecData = null;
98 var curSort = 'relevance';
100 var submitted = false;
106 // pz2.js event handlers:
108 function my_oninit() {
113 function my_onshow(data) {
114 totalRec = data.merged;
116 var pager = document.getElementById("mkwsPager");
117 pager.innerHTML = "";
118 pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
119 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
120 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
121 + data.total + ')</div>';
124 var results = document.getElementById("mkwsRecords");
127 for (var i = 0; i < data.hits.length; i++) {
128 var hit = data.hits[i];
129 html.push('<div class="record" id="mkwsRecdiv_'+hit.recid+'" >'
130 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
131 +'<a href="#" id="mkwsRec_'+hit.recid
132 +'" onclick="showDetails(this.id);return false;"><b>'
133 + hit["md-title"] +' </b></a>');
134 if (hit["md-title-remainder"] !== undefined) {
135 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
137 if (hit["md-title-responsibility"] !== undefined) {
138 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
140 if (hit.recid == curDetRecId) {
141 html.push(renderDetails(curDetRecData));
145 replaceHtml(results, html.join(''));
148 function my_onstat(data) {
149 var stat = document.getElementById("mkwsStat");
153 stat.innerHTML = '<span class="head">Status info</span>' +
155 '<span class="clients">' + data.activeclients + '/' + data.clients + '</span>' +
157 '<span class="records">' + data.records + '/' + data.hits + '</span>';
160 function my_onterm(data) {
162 if (!mkws_config.facets || mkws_config.facets.length == 0) {
163 $("#mkwsTermlists").parent().hide();
167 // display if we first got results
168 $("#mkwsTermlists").parent().show();
171 acc.push('<div class="title">' + M('Termlists') + '</div>');
172 var facets = mkws_config.facets;
174 for(var i = 0; i < facets.length; i++) {
175 if (facets[i] == "sources") {
176 add_single_facet(acc, "Sources", data.xtargets, SourceMax, null);
177 } else if (facets[i] == "subjects") {
178 add_single_facet(acc, "Subjects", data.subject, SubjectMax, "su");
179 } else if (facets[i] == "authors") {
180 add_single_facet(acc, "Authors", data.author, AuthorMax, "au");
182 alert("bad facet configuration: '" + facets[i] + "'");
186 var termlist = document.getElementById("mkwsTermlists");
187 replaceHtml(termlist, acc.join(''));
189 if (mkws_config.responsive_design)
190 mkws_mobile_resize();
193 function add_single_facet(acc, caption, data, max, cclIndex) {
194 acc.push('<div class="facet">');
195 acc.push('<div class="termtitle">' + M(caption) + '</div>');
196 for (var i = 0; i < data.length && i < max; i++ ) {
197 acc.push('<a href="#" ');
200 // Special case: target selection
201 acc.push('target_id='+data[i].id+' ');
202 action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
204 action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
206 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
207 + '<span> (' + data[i].freq + ')</span><br/>');
212 function my_onrecord(data) {
213 // FIXME: record is async!!
214 clearTimeout(my_paz.recordTimer);
215 // in case on_show was faster to redraw element
216 var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
217 if (detRecordDiv) return;
218 curDetRecData = data;
219 var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
220 var html = renderDetails(curDetRecData);
221 recordDiv.innerHTML += html;
224 function my_onbytarget(data) {
225 var targetDiv = document.getElementById("mkwsBytarget");
226 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
227 +'<td>Records</td><td>State</td></tr></thead><tbody>';
229 for (var i = 0; i < data.length; i++ ) {
230 table += "<tr><td>" + data[i].id +
231 "</td><td>" + data[i].hits +
232 "</td><td>" + data[i].diagnostic +
233 "</td><td>" + data[i].records +
234 "</td><td>" + data[i].state + "</td></tr>";
237 table += '</tbody></table>';
238 targetDiv.innerHTML = table;
241 ////////////////////////////////////////////////////////////////////////////////
242 ////////////////////////////////////////////////////////////////////////////////
244 // wait until the DOM is ready
247 document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
248 document.mkwsSearchForm.mkwsQuery.value = '';
249 if (document.mkwsSelect) {
250 if (document.mkwsSelect.mkwsSort)
251 document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
252 if (document.mkwsSelect.mkwsPerpage)
253 document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
257 // when search button pressed
258 function onFormSubmitEventHandler()
263 switchView('records'); // In case it's configured to start off as hidden
268 function onSelectDdChange()
270 if (!submitted) return false;
273 my_paz.show(0, recPerPage, curSort);
283 function triggerSearch ()
285 my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter);
288 function loadSelect ()
290 if (document.mkwsSelect) {
291 if (document.mkwsSelect.mkwsSort)
292 curSort = document.mkwsSelect.mkwsSort.value;
293 if (document.mkwsSelect.mkwsPerpage)
294 recPerPage = document.mkwsSelect.mkwsPerpage.value;
298 // limit the query after clicking the facet
299 function limitQuery (field, value)
301 document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
302 onFormSubmitEventHandler();
305 // limit by target functions
306 function limitTarget (id, name)
308 var navi = document.getElementById('mkwsNavi');
310 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
312 navi.innerHTML += '<hr/>';
313 curFilter = 'pz:id=' + id;
320 function delimitTarget ()
322 var navi = document.getElementById('mkwsNavi');
331 function drawPager (pagerDiv)
333 //client indexes pages from 1 but pz2 from 0
335 var pages = Math.ceil(totalRec / recPerPage);
337 var firstClkbl = ( curPage - onsides > 0 )
341 var lastClkbl = firstClkbl + 2*onsides < pages
342 ? firstClkbl + 2*onsides
345 var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
347 prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
348 +'<< ' + M('Prev') + '</a><b> | </b>';
351 for(var i = firstClkbl; i <= lastClkbl; i++) {
354 numLabel = '<b>' + i + '</b>';
356 middle += '<a href="#" onclick="showPage(' + i + ')"> '
357 + numLabel + ' </a>';
360 var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
361 if (pages - curPage > 0)
362 next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
363 + M('Next') + ' >></a>';
370 if (lastClkbl < pages)
373 pagerDiv.innerHTML += '<div style="float: clear">'
374 + prev + predots + middle + postdots + next + '</div><hr/>';
377 function showPage (pageNum)
380 my_paz.showPage( curPage - 1 );
383 // simple paging functions
385 function pagerNext() {
386 if ( totalRec - recPerPage*curPage > 0) {
392 function pagerPrev() {
393 if ( my_paz.showPrev() != false )
397 // switching view between targets and records
399 function switchView(view) {
400 var targets = document.getElementById('mkwsTargets');
401 var records = document.getElementById('mkwsResults');
402 var blanket = document.getElementById('mkwsBlanket');
406 targets.style.display = "block";
407 if (records) records.style.display = "none";
408 if (blanket) { blanket.style.display = "none"; }
411 targets.style.display = "none";
412 if (records) records.style.display = "block";
413 if (blanket) { blanket.style.display = "block"; }
416 targets.style.display = "none";
417 if (records) records.style.display = "none";
418 if (blanket) { blanket.style.display = "none"; }
421 alert('Unknown view.');
425 // detailed record drawing
426 function showDetails (prefixRecId) {
427 var recId = prefixRecId.replace('mkwsRec_', '');
428 var oldRecId = curDetRecId;
431 // remove current detailed view if any
432 var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
435 detRecordDiv.parentNode.removeChild(detRecordDiv);
437 // if the same clicked, just hide
438 if (recId == oldRecId) {
440 curDetRecData = null;
443 // request the record
444 my_paz.record(recId);
447 function replaceHtml(el, html) {
448 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
449 /*@cc_on // Pure innerHTML is slightly faster in IE
450 oldEl.innerHTML = html;
453 var newEl = oldEl.cloneNode(false);
454 newEl.innerHTML = html;
455 oldEl.parentNode.replaceChild(newEl, oldEl);
456 /* Since we just removed the old element from the DOM, return a reference
457 to the new element, which can be used to restore variable references. */
461 function renderDetails(data, marker)
463 var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
464 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
466 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
467 details += renderField("Date", data["md-date"]);
468 details += renderField("Author", data["md-author"]);
469 details += renderField("URL", data["md-electronic-url"]);
470 details += renderField("Subject", data["location"][0]["md-subject"]);
471 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
472 details += '</table></div>';
477 function renderField(caption, data, data2, data3) {
478 if (data === undefined) {
482 if (caption == "URL") {
483 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
486 if (data2 != undefined) {
487 data = data + " (" + data2 + ")";
490 if (data3 != undefined) {
491 data = data + " <i>" + data3 + "</i>";
494 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
499 * All the HTML stuff to render the search forms and
502 function mkws_html_all(config) {
504 /* default mkws config */
505 var mkws_config_default = {
506 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
507 perpage: [10, 20, 30, 50],
508 sort_default: "relevance",
511 switch_menu: true, /* show/hide Records|Targets menu */
512 lang_menu: true, /* show/hide language menu */
513 sort_menu: true, /* show/hide sort menu */
514 perpage_menu: true, /* show/hide perpage menu */
515 lang_display: [], /* display languages links for given languages, [] for all */
516 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
517 responsive_design_width: 980, /* a page with less pixel width considered as mobile */
518 debug: 1, /* debug level for development: 0..2 */
523 /* set global debug flag early */
524 if (typeof config.debug !== 'undefined') {
525 mkws_debug = config.debug;
526 } else if (typeof mkws_config_default.debug !== 'undefined') {
527 mkws_debug = mkws_config_default.debug;
530 /* override standard config values by function parameters */
531 for (var k in mkws_config_default) {
532 if (typeof config[k] === 'undefined')
533 mkws_config[k] = mkws_config_default[k];
534 debug("Set config: " + k + ' => ' + mkws_config[k]);
537 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
538 debug("Reset query width: " + mkws_config.query_width);
539 mkws_config.query_width = 50;
542 mkws_set_lang(mkws_config);
543 if (mkws_config.lang_menu)
544 mkws_html_lang(mkws_config);
546 // For some reason, doing this programmatically results in
547 // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
548 debug("HTML search form");
549 $("#mkwsSearch").html('\
550 <form name="mkwsSearchForm" action="" >\
551 <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
552 <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
555 debug("HTML records");
556 // If the application has an #mkwsResults, populate it in the
557 // usual way. If not, assume that it's a smarter application that
558 // defines its own subcomponents:
564 if ($("#mkwsResults").length) {
565 $("#mkwsResults").html('\
566 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
568 <td width="250" valign="top">\
569 <div id="mkwsTermlists"></div>\
572 <div id="mkwsRanking"></div>\
573 <div id="mkwsPager"></div>\
574 <div id="mkwsNavi"></div>\
575 <div id="mkwsRecords"></div>\
581 if ($("#mkwsRanking").length) {
582 var ranking_data = '';
583 ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
584 if (config.sort_menu) {
585 ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
587 if (config.perpage_menu) {
588 ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
590 ranking_data += '</form>';
592 $("#mkwsRanking").html(ranking_data);
595 mkws_html_switch(config);
597 if (mkws_config.use_service_proxy)
598 mkws_service_proxy_auth(config.service_proxy_auth);
600 if (mkws_config.responsive_design)
601 mkws_responsive_design();
605 // on first page, hide the termlist
606 $(document).ready(function() { $("#mkwsTermlists").parent().hide(); } );
609 /* Responsive web design - change layout on the fly depending on
610 * the current screen size width/height. Required for mobile devices.
612 function mkws_responsive_design () {
615 $(window).resize( function(e) {
617 clearTimeout(timeout);
618 timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
621 // initial check after page load
622 $(document).ready(function() { mkws_mobile_resize() });
625 function mkws_set_lang(mkws_config) {
626 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
627 if (!lang || !mkws_locale_lang[lang]) {
628 mkws_config.lang = ""
630 mkws_config.lang = lang;
633 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
634 return mkws_config.lang;
637 function mkws_html_switch(config) {
638 debug("HTML switch");
640 $("#mkwsSwitch").html($("<a/>", {
642 onclick: "switchView(\'records\')",
645 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
646 $("#mkwsSwitch").append($("<a/>", {
648 onclick: "switchView(\'targets\')",
652 debug("HTML targets");
653 $("#mkwsTargets").html('\
654 <div id="mkwsBytarget">\
655 No information available yet.\
657 $("#mkwsTargets").css("display", "none");
659 if (!config.switch_menu) {
660 debug("disable switch menu");
661 $("#mkwsSwitch").css("display", "none");
665 function mkws_html_sort(config) {
667 var sort_html = '<select name="mkwsSort" id="mkwsSort">';
669 for(var i = 0; i < config.sort.length; i++) {
670 var key = config.sort[i][0];
671 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
673 sort_html += '<option value="' + key + '"';
674 if (key == config.sort_default) {
675 sort_html += ' selected="selected"';
677 sort_html += '>' + val + '</option>';
679 sort_html += '</select>';
684 function mkws_html_perpage(config) {
685 debug("HTML perpage");
686 var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
688 for(var i = 0; i < config.perpage.length; i++) {
689 var key = config.perpage[i];
691 perpage_html += '<option value="' + key + '"';
692 if (key == config.perpage_default) {
693 perpage_html += ' selected="selected"';
695 perpage_html += '>' + key + '</option>';
697 perpage_html += '</select>';
703 * Run service-proxy authentication in background (after page load).
704 * The username/password is configured in the apache config file
707 function mkws_service_proxy_auth(auth_url) {
709 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
711 debug("Run service proxy auth URL: " + auth_url);
713 var request = new pzHttpRequest(auth_url);
714 request.get(null, function(data) {
715 if (!jQuery.isXMLDoc(data)) {
716 alert("service proxy auth response document is not valid XML document, give up!");
719 var status = $(data).find("status");
720 if (status.text() != "OK") {
721 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
727 /* create locale language menu */
728 function mkws_html_lang(mkws_config) {
729 var lang_default = "en";
730 var lang = mkws_config.lang || lang_default;
733 /* display a list of configured languages, or all */
734 var lang_display = mkws_config.lang_display || [];
736 for (var i = 0; i < lang_display.length; i++) {
737 hash[lang_display[i]] = 1;
740 for (var k in mkws_locale_lang) {
741 if (hash[k] == 1 || lang_display.length == 0)
746 if (lang_display.length == 0 || hash[lang_default] == 1)
747 list.push(lang_default);
749 debug("Language menu for: " + list.join(", "));
753 for(var i = 0; i < list.length; i++) {
760 data += ' <span>' + l + '</span> ';
762 data += ' <a href="?lang=' + l + '">' + l + '</a> '
766 $("#mkwsLang").html(data);
769 function mkws_mobile_resize () {
770 debug("resize width: " + $(window).height() + ", width: " + $(window).width());
771 var list = ["mkwsSwitch"];
773 // alert($(window).width());
775 var width = mkws_config.responsive_design_width || 980;
777 if ($(window).width() <= width) {
778 for(var i = 0; i < list.length; i++) {
779 $("#" + list[i]).hide();
782 $("#mkwsTermlists").parent().hide();
783 obj = $("#mkwsTermlists").parent().html();
784 $("#mkwsShiftedTermlists").html("<hr/>" + obj);
786 for(var i = 0; i < list.length; i++) {
787 $("#" + list[i]).show();
789 $("#mkwsTermlists").parent().show();
790 $("#mkwsShiftedTermlists").html("");
796 var lang = mkws_config.lang;
798 if (!lang || !mkws_locale_lang[lang])
801 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
804 /* implement jQuery.parseQuerystring() for parsing URL parameters */
806 parseQuerystring: function() {
808 var qs = window.location.search.replace('?', '');
809 var pairs = qs.split('&');
810 $.each(pairs, function(i, v){
811 var pair = v.split('=');
812 nvpair[pair[0]] = pair[1];
816 pazpar2: function(data) {
817 document.write('<div id="mkwsSwitch"></div>\
818 <div id="mkwsLang"></div>\
819 <div id="mkwsSearch"></div>\
820 <div id="mkwsResults"></div>\
821 <div id="mkwsTargets"></div>\
822 <div id="mkwsFooter">\
823 <div id="mkwsStat"></div>\
824 <span>Powered by MKWS © 2013 <a target="_new" href="http://www.indexdata.com">Index Data</a></span>\
827 mkws_html_all(mkws_config);
831 function debug(string) {
835 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
839 // you need to disable use strict at the top of the file!!!
840 if (mkws_debug >= 3) {
841 console.log(arguments.callee.caller);
842 } else if (mkws_debug >= 2) {
843 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
849 $(document).ready(function() { mkws_html_all(mkws_config) });