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 curSort = document.mkwsSelect.mkwsSort.value;
292 recPerPage = document.mkwsSelect.mkwsPerpage.value;
296 // limit the query after clicking the facet
297 function limitQuery (field, value)
299 document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
300 onFormSubmitEventHandler();
303 // limit by target functions
304 function limitTarget (id, name)
306 var navi = document.getElementById('mkwsNavi');
308 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
310 navi.innerHTML += '<hr/>';
311 curFilter = 'pz:id=' + id;
318 function delimitTarget ()
320 var navi = document.getElementById('mkwsNavi');
329 function drawPager (pagerDiv)
331 //client indexes pages from 1 but pz2 from 0
333 var pages = Math.ceil(totalRec / recPerPage);
335 var firstClkbl = ( curPage - onsides > 0 )
339 var lastClkbl = firstClkbl + 2*onsides < pages
340 ? firstClkbl + 2*onsides
343 var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
345 prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
346 +'<< ' + M('Prev') + '</a><b> | </b>';
349 for(var i = firstClkbl; i <= lastClkbl; i++) {
352 numLabel = '<b>' + i + '</b>';
354 middle += '<a href="#" onclick="showPage(' + i + ')"> '
355 + numLabel + ' </a>';
358 var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
359 if (pages - curPage > 0)
360 next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
361 + M('Next') + ' >></a>';
368 if (lastClkbl < pages)
371 pagerDiv.innerHTML += '<div style="float: clear">'
372 + prev + predots + middle + postdots + next + '</div><hr/>';
375 function showPage (pageNum)
378 my_paz.showPage( curPage - 1 );
381 // simple paging functions
383 function pagerNext() {
384 if ( totalRec - recPerPage*curPage > 0) {
390 function pagerPrev() {
391 if ( my_paz.showPrev() != false )
395 // switching view between targets and records
397 function switchView(view) {
399 var targets = document.getElementById('mkwsTargets');
400 var records = document.getElementById('mkwsResults');
401 var blanket = document.getElementById('mkwsBlanket');
405 targets.style.display = "block";
406 if (records) records.style.display = "none";
407 if (blanket) { blanket.style.display = "none"; }
410 targets.style.display = "none";
411 if (records) records.style.display = "block";
412 if (blanket) { blanket.style.display = "block"; }
415 targets.style.display = "none";
416 if (records) records.style.display = "none";
417 if (blanket) { blanket.style.display = "none"; }
420 alert('Unknown view.');
424 // detailed record drawing
425 function showDetails (prefixRecId) {
426 var recId = prefixRecId.replace('mkwsRec_', '');
427 var oldRecId = curDetRecId;
430 // remove current detailed view if any
431 var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
434 detRecordDiv.parentNode.removeChild(detRecordDiv);
436 // if the same clicked, just hide
437 if (recId == oldRecId) {
439 curDetRecData = null;
442 // request the record
443 my_paz.record(recId);
446 function replaceHtml(el, html) {
447 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
448 /*@cc_on // Pure innerHTML is slightly faster in IE
449 oldEl.innerHTML = html;
452 var newEl = oldEl.cloneNode(false);
453 newEl.innerHTML = html;
454 oldEl.parentNode.replaceChild(newEl, oldEl);
455 /* Since we just removed the old element from the DOM, return a reference
456 to the new element, which can be used to restore variable references. */
460 function renderDetails(data, marker)
462 var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
463 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
465 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
466 details += renderField("Date", data["md-date"]);
467 details += renderField("Author", data["md-author"]);
468 details += renderField("URL", data["md-electronic-url"]);
469 details += renderField("Subject", data["location"][0]["md-subject"]);
470 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
471 details += '</table></div>';
476 function renderField(caption, data, data2, data3) {
477 if (data === undefined) {
481 if (caption == "URL") {
482 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
485 if (data2 != undefined) {
486 data = data + " (" + data2 + ")";
489 if (data3 != undefined) {
490 data = data + " <i>" + data3 + "</i>";
493 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
498 * All the HTML stuff to render the search forms and
501 function mkws_html_all(config) {
503 /* default mkws config */
504 var mkws_config_default = {
505 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
506 perpage: [10, 20, 30, 50],
507 sort_default: "relevance",
510 switch_menu: true, /* show/hide Records|Targets menu */
511 lang_menu: true, /* show/hide sort menu */
512 sort_menu: true, /* show/hide perpage menu */
513 perpage_menu: true, /* show/hide language menu */
514 lang_display: [], /* display languages links for given languages, [] for all */
515 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
516 responsive_design_width: 980, /* a page with less pixel width considered as mobile */
517 debug: 1, /* debug level for development: 0..2 */
522 /* set global debug flag early */
523 if (typeof config.debug !== 'undefined') {
524 mkws_debug = config.debug;
525 } else if (typeof mkws_config_default.debug !== 'undefined') {
526 mkws_debug = mkws_config_default.debug;
529 /* override standard config values by function parameters */
530 for (var k in mkws_config_default) {
531 if (typeof config[k] === 'undefined')
532 mkws_config[k] = mkws_config_default[k];
533 debug("Set config: " + k + ' => ' + mkws_config[k]);
536 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
537 debug("Reset query width: " + mkws_config.query_width);
538 mkws_config.query_width = 50;
541 mkws_set_lang(mkws_config);
542 if (mkws_config.lang_menu)
543 mkws_html_lang(mkws_config);
545 // For some reason, doing this programmatically results in
546 // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
547 debug("HTML search form");
548 $("#mkwsSearch").html('\
549 <form name="mkwsSearchForm" action="" >\
550 <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
551 <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
554 debug("HTML records");
555 // If the application has an #mkwsResults, populate it in the
556 // usual way. If not, assume that it's a smarter application that
557 // defines its own subcomponents:
563 if ($("#mkwsResults").length) {
564 $("#mkwsResults").html('\
565 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
567 <td width="250" valign="top">\
568 <div id="mkwsTermlists"></div>\
571 <div id="mkwsRanking"></div>\
572 <div id="mkwsPager"></div>\
573 <div id="mkwsNavi"></div>\
574 <div id="mkwsRecords"></div>\
580 if ($("#mkwsRanking").length) {
581 var ranking_data = '';
582 ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
583 if (config.sort_menu) {
584 ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
586 if (config.perpage_menu) {
587 ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
589 ranking_data += '</form>';
591 $("#mkwsRanking").html(ranking_data);
594 mkws_html_switch(config);
596 if (mkws_config.use_service_proxy)
597 mkws_service_proxy_auth(config.service_proxy_auth);
599 if (mkws_config.responsive_design)
600 mkws_responsive_design();
604 // on first page, hide the termlist
605 $(document).ready(function() { $("#mkwsTermlists").parent().hide(); } );
608 /* Responsive web design - change layout on the fly depending on
609 * the current screen size width/height. Required for mobile devices.
611 function mkws_responsive_design () {
614 $(window).resize( function(e) {
616 clearTimeout(timeout);
617 timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
620 // initial check after page load
621 $(document).ready(function() { mkws_mobile_resize() });
624 function mkws_set_lang(mkws_config) {
625 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
626 if (!lang || !mkws_locale_lang[lang]) {
627 mkws_config.lang = ""
629 mkws_config.lang = lang;
632 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
633 return mkws_config.lang;
636 function mkws_html_switch(config) {
637 debug("HTML switch");
639 $("#mkwsSwitch").html($("<a/>", {
641 onclick: "switchView(\'records\')",
644 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
645 $("#mkwsSwitch").append($("<a/>", {
647 onclick: "switchView(\'targets\')",
651 debug("HTML targets");
652 $("#mkwsTargets").html('\
653 <div id="mkwsBytarget">\
654 No information available yet.\
656 $("#mkwsTargets").css("display", "none");
658 if (!config.switch_menu) {
659 debug("disable switch menu");
660 $("#mkwsSwitch").css("display", "none");
664 function mkws_html_sort(config) {
666 var sort_html = '<select name="mkwsSort" id="mkwsSort">';
668 for(var i = 0; i < config.sort.length; i++) {
669 var key = config.sort[i][0];
670 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
672 sort_html += '<option value="' + key + '"';
673 if (key == config.sort_default) {
674 sort_html += ' selected="selected"';
676 sort_html += '>' + val + '</option>';
678 sort_html += '</select>';
683 function mkws_html_perpage(config) {
684 debug("HTML perpage");
685 var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
687 for(var i = 0; i < config.perpage.length; i++) {
688 var key = config.perpage[i];
690 perpage_html += '<option value="' + key + '"';
691 if (key == config.perpage_default) {
692 perpage_html += ' selected="selected"';
694 perpage_html += '>' + key + '</option>';
696 perpage_html += '</select>';
702 * Run service-proxy authentication in background (after page load).
703 * The username/password is configured in the apache config file
706 function mkws_service_proxy_auth(auth_url) {
708 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
710 debug("Run service proxy auth URL: " + auth_url);
712 var request = new pzHttpRequest(auth_url);
713 request.get(null, function(data) {
714 if (!jQuery.isXMLDoc(data)) {
715 alert("service proxy auth response document is not valid XML document, give up!");
718 var status = $(data).find("status");
719 if (status.text() != "OK") {
720 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
726 /* create locale language menu */
727 function mkws_html_lang(mkws_config) {
728 var lang_default = "en";
729 var lang = mkws_config.lang || lang_default;
732 /* display a list of configured languages, or all */
733 var lang_display = mkws_config.lang_display || [];
735 for (var i = 0; i < lang_display.length; i++) {
736 hash[lang_display[i]] = 1;
739 for (var k in mkws_locale_lang) {
740 if (hash[k] == 1 || lang_display.length == 0)
745 if (lang_display.length == 0 || hash[lang_default] == 1)
746 list.push(lang_default);
748 debug("Language menu for: " + list.join(", "));
752 for(var i = 0; i < list.length; i++) {
759 data += ' <span>' + l + '</span> ';
761 data += ' <a href="?lang=' + l + '">' + l + '</a> '
765 $("#mkwsLang").html(data);
768 function mkws_mobile_resize () {
769 debug("resize width: " + $(window).height() + ", width: " + $(window).width());
770 var list = ["mkwsSwitch"];
772 // alert($(window).width());
774 var width = mkws_config.responsive_design_width || 980;
776 if ($(window).width() <= width) {
777 for(var i = 0; i < list.length; i++) {
778 $("#" + list[i]).hide();
781 $("#mkwsTermlists").parent().hide();
782 obj = $("#mkwsTermlists").parent().html();
783 $("#mkwsShiftedTermlists").html("<hr/>" + obj);
785 for(var i = 0; i < list.length; i++) {
786 $("#" + list[i]).show();
788 $("#mkwsTermlists").parent().show();
789 $("#mkwsShiftedTermlists").html("");
795 var lang = mkws_config.lang;
797 if (!lang || !mkws_locale_lang[lang])
800 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
803 /* implement jQuery.parseQuerystring() for parsing URL parameters */
805 parseQuerystring: function() {
807 var qs = window.location.search.replace('?', '');
808 var pairs = qs.split('&');
809 $.each(pairs, function(i, v){
810 var pair = v.split('=');
811 nvpair[pair[0]] = pair[1];
815 pazpar2: function(data) {
816 document.write('<div id="mkwsSwitch"></div>\
817 <div id="mkwsLang"></div>\
818 <div id="mkwsSearch"></div>\
819 <div id="mkwsResults"></div>\
820 <div id="mkwsTargets"></div>\
821 <div id="mkwsFooter">\
822 <div id="mkwsStat"></div>\
823 <span>Powered by MKWS © 2013 <a target="_new" href="http://www.indexdata.com">Index Data</a></span>\
826 mkws_html_all(mkws_config);
830 function debug(string) {
834 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
838 // you need to disable use strict at the top of the file!!!
839 if (mkws_debug >= 3) {
840 console.log(arguments.callee.caller);
841 } else if (mkws_debug >= 2) {
842 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
848 $(document).ready(function() { mkws_html_all(mkws_config) });