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("mkwsResults");
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(''));
190 function add_single_facet(acc, caption, data, max, cclIndex) {
191 acc.push('<div class="facet">');
192 acc.push('<div class="termtitle">' + M(caption) + '</div>');
193 for (var i = 0; i < data.length && i < max; i++ ) {
194 acc.push('<a href="#" ');
197 // Special case: target selection
198 acc.push('target_id='+data[i].id+' ');
199 action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
201 action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
203 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
204 + '<span> (' + data[i].freq + ')</span><br/>');
209 function my_onrecord(data) {
210 // FIXME: record is async!!
211 clearTimeout(my_paz.recordTimer);
212 // in case on_show was faster to redraw element
213 var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
214 if (detRecordDiv) return;
215 curDetRecData = data;
216 var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
217 var html = renderDetails(curDetRecData);
218 recordDiv.innerHTML += html;
221 function my_onbytarget(data) {
222 var targetDiv = document.getElementById("mkwsBytarget");
223 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
224 +'<td>Records</td><td>State</td></tr></thead><tbody>';
226 for (var i = 0; i < data.length; i++ ) {
227 table += "<tr><td>" + data[i].id +
228 "</td><td>" + data[i].hits +
229 "</td><td>" + data[i].diagnostic +
230 "</td><td>" + data[i].records +
231 "</td><td>" + data[i].state + "</td></tr>";
234 table += '</tbody></table>';
235 targetDiv.innerHTML = table;
238 ////////////////////////////////////////////////////////////////////////////////
239 ////////////////////////////////////////////////////////////////////////////////
241 // wait until the DOM is ready
244 document.search.onsubmit = onFormSubmitEventHandler;
245 document.search.mkwsQuery.value = '';
246 document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
247 document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
250 // when search button pressed
251 function onFormSubmitEventHandler()
256 switchView('records'); // In case it's configured to start off as hidden
261 function onSelectDdChange()
263 if (!submitted) return false;
266 my_paz.show(0, recPerPage, curSort);
276 function triggerSearch ()
278 my_paz.search(document.search.mkwsQuery.value, recPerPage, curSort, curFilter);
281 function loadSelect ()
283 curSort = document.mkwsSelect.mkwsSort.value;
284 recPerPage = document.mkwsSelect.mkwsPerpage.value;
287 // limit the query after clicking the facet
288 function limitQuery (field, value)
290 document.search.query.value += ' and ' + field + '="' + value + '"';
291 onFormSubmitEventHandler();
294 // limit by target functions
295 function limitTarget (id, name)
297 var navi = document.getElementById('mkwsNavi');
299 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
301 navi.innerHTML += '<hr/>';
302 curFilter = 'pz:id=' + id;
309 function delimitTarget ()
311 var navi = document.getElementById('mkwsNavi');
320 function drawPager (pagerDiv)
322 //client indexes pages from 1 but pz2 from 0
324 var pages = Math.ceil(totalRec / recPerPage);
326 var firstClkbl = ( curPage - onsides > 0 )
330 var lastClkbl = firstClkbl + 2*onsides < pages
331 ? firstClkbl + 2*onsides
334 var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
336 prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
337 +'<< ' + M('Prev') + '</a><b> | </b>';
340 for(var i = firstClkbl; i <= lastClkbl; i++) {
343 numLabel = '<b>' + i + '</b>';
345 middle += '<a href="#" onclick="showPage(' + i + ')"> '
346 + numLabel + ' </a>';
349 var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
350 if (pages - curPage > 0)
351 next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
352 + M('Next') + ' >></a>';
359 if (lastClkbl < pages)
362 pagerDiv.innerHTML += '<div style="float: clear">'
363 + prev + predots + middle + postdots + next + '</div><hr/>';
366 function showPage (pageNum)
369 my_paz.showPage( curPage - 1 );
372 // simple paging functions
374 function pagerNext() {
375 if ( totalRec - recPerPage*curPage > 0) {
381 function pagerPrev() {
382 if ( my_paz.showPrev() != false )
386 // swithing view between targets and records
388 function switchView(view) {
390 var targets = document.getElementById('mkwsTargets');
391 var records = document.getElementById('mkwsRecords');
392 var blanket = document.getElementById('mkwsBlanket');
396 targets.style.display = "block";
397 records.style.display = "none";
398 if (blanket) { blanket.style.display = "none"; }
401 targets.style.display = "none";
402 records.style.display = "block";
403 if (blanket) { blanket.style.display = "block"; }
406 targets.style.display = "none";
407 records.style.display = "none";
408 if (blanket) { blanket.style.display = "none"; }
411 alert('Unknown view.');
415 // detailed record drawing
416 function showDetails (prefixRecId) {
417 var recId = prefixRecId.replace('mkwsRec_', '');
418 var oldRecId = curDetRecId;
421 // remove current detailed view if any
422 var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
425 detRecordDiv.parentNode.removeChild(detRecordDiv);
427 // if the same clicked, just hide
428 if (recId == oldRecId) {
430 curDetRecData = null;
433 // request the record
434 my_paz.record(recId);
437 function replaceHtml(el, html) {
438 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
439 /*@cc_on // Pure innerHTML is slightly faster in IE
440 oldEl.innerHTML = html;
443 var newEl = oldEl.cloneNode(false);
444 newEl.innerHTML = html;
445 oldEl.parentNode.replaceChild(newEl, oldEl);
446 /* Since we just removed the old element from the DOM, return a reference
447 to the new element, which can be used to restore variable references. */
451 function renderDetails(data, marker)
453 var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
454 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
456 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
457 details += renderField("Date", data["md-date"]);
458 details += renderField("Author", data["md-author"]);
459 details += renderField("URL", data["md-electronic-url"]);
460 details += renderField("Subject", data["location"][0]["md-subject"]);
461 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
462 details += '</table></div>';
467 function renderField(caption, data, data2, data3) {
468 if (data === undefined) {
472 if (caption == "URL") {
473 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
476 if (data2 != undefined) {
477 data = data + " (" + data2 + ")";
480 if (data3 != undefined) {
481 data = data + " <i>" + data3 + "</i>";
484 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
489 * All the HTML stuff to render the search forms and
492 function mkws_html_all(config) {
494 /* default mkws config */
495 var mkws_config_default = {
496 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
497 perpage: [10, 20, 30, 50],
498 sort_default: "relevance",
501 switch_menu: true, /* show/hide Records|Targets menu */
502 lang_menu: true, /* show/hide language menu */
503 lang_display: [], /* display languages links for given languages, [] for all */
504 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
505 responsive_design_width: 980, /* a page with less pixel width considered as mobile */
507 debug: 0, /* debug level for development: 0..2 */
513 /* set global debug flag early */
514 if (config.debug !== 'undefined') {
515 mkws_debug = config.debug;
516 } else if (mkws_config_default.debug !== 'undefined') {
517 mkws_debug = mkws_config_default.debug;
520 /* override standard config values by function parameters */
521 for (var k in mkws_config_default) {
522 if (typeof config[k] === 'undefined')
523 mkws_config[k] = mkws_config_default[k];
524 debug("Set config: " + k + ' => ' + mkws_config[k]);
527 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
528 debug("Reset query width: " + mkws_config.query_width);
529 mkws_config.query_width = 50;
532 mkws_set_lang(mkws_config);
533 if (mkws_config.lang_menu)
534 mkws_html_lang(mkws_config);
536 // For some reason, doing this programmatically results in
537 // document.search.mkwsQuery being undefined, hence the raw HTML.
538 debug("HTML search form");
539 $("#mkwsSearch").html('\
540 <form name="search" action="" >\
541 <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
542 <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
545 debug("HTML records");
546 $("#mkwsRecords").html('\
547 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
549 <td width="250" valign="top">\
550 <div id="mkwsTermlists"></div>\
553 <div id="mkwsRanking">\
554 <form name="mkwsSelect" id="mkwsSelect" action="" >\
555 ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
556 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
557 ' + M('per page') + '.\
560 <div id="mkwsPager"></div>\
561 <div id="mkwsNavi"></div>\
562 <div id="mkwsResults"></div>\
567 mkws_html_switch(config);
569 if (mkws_config.use_service_proxy)
570 mkws_service_proxy_auth(config.service_proxy_auth);
572 if (mkws_config.responsive_design)
573 mkws_responsive_design();
577 // on first page, hide the termlist
578 $(document).ready(function() { $("#mkwsTermlists").parent().hide(); } );
581 /* Responsive web design - change layout on the fly depending on
582 * the current screen size width/height. Required for mobile devices.
584 function mkws_responsive_design () {
587 $(window).resize( function(e) {
589 clearTimeout(timeout);
590 timeout = setTimeout(function () { mkws_mobile_resize() }, 50);
593 // initial check after page load
594 $(document).ready(function() { mkws_mobile_resize() });
597 function mkws_set_lang(mkws_config) {
598 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
599 if (!lang || !mkws_locale_lang[lang]) {
600 mkws_config.lang = ""
602 mkws_config.lang = lang;
605 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
606 return mkws_config.lang;
609 function mkws_html_switch(config) {
610 debug("HTML switch");
612 $("#mkwsSwitch").html($("<a/>", {
614 onclick: "switchView(\'records\')",
617 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
618 $("#mkwsSwitch").append($("<a/>", {
620 onclick: "switchView(\'targets\')",
624 debug("HTML targets");
625 $("#mkwsTargets").html('\
626 <div id="mkwsBytarget">\
627 No information available yet.\
629 $("#mkwsTargets").css("display", "none");
631 if (!config.switch_menu) {
632 debug("disable switch menu");
633 $("#mkwsSwitch").css("display", "none");
637 function mkws_html_sort(config) {
639 var sort_html = '<select name="mkwsSort" id="mkwsSort">';
641 for(var i = 0; i < config.sort.length; i++) {
642 var key = config.sort[i][0];
643 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
645 sort_html += '<option value="' + key + '"';
646 if (key == config.sort_default) {
647 sort_html += ' selected="selected"';
649 sort_html += '>' + val + '</option>';
651 sort_html += '</select>';
656 function mkws_html_perpage(config) {
657 debug("HTML perpage");
658 var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
660 for(var i = 0; i < config.perpage.length; i++) {
661 var key = config.perpage[i];
663 perpage_html += '<option value="' + key + '"';
664 if (key == config.perpage_default) {
665 perpage_html += ' selected="selected"';
667 perpage_html += '>' + key + '</option>';
669 perpage_html += '</select>';
675 * Run service-proxy authentication in background (after page load).
676 * The username/password is configured in the apache config file
679 function mkws_service_proxy_auth(auth_url) {
681 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
683 debug("Run service proxy auth URL: " + auth_url);
685 var request = new pzHttpRequest(auth_url);
686 request.get(null, function(data) {
687 if (!jQuery.isXMLDoc(data)) {
688 alert("service proxy auth response document is not valid XML document, give up!");
691 var status = $(data).find("status");
692 if (status.text() != "OK") {
693 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
699 /* create locale language menu */
700 function mkws_html_lang(mkws_config) {
701 var lang_default = "en";
702 var lang = mkws_config.lang || lang_default;
705 /* display a list of configured languages, or all */
706 var lang_display = mkws_config.lang_display || [];
708 for (var i = 0; i < lang_display.length; i++) {
709 hash[lang_display[i]] = 1;
712 for (var k in mkws_locale_lang) {
713 if (hash[k] == 1 || lang_display.length == 0)
718 if (lang_display.length == 0 || hash[lang_default] == 1)
719 list.push(lang_default);
721 debug("Language menu for: " + list.join(", "));
725 for(var i = 0; i < list.length; i++) {
732 data += ' <span>' + l + '</span> ';
734 data += ' <a href="?lang=' + l + '">' + l + '</a> '
738 $("#mkwsLang").html(data);
741 function mkws_mobile_resize () {
742 debug("resize width: " + $(window).height() + ", width: " + $(window).width());
743 var list = ["mkwsSwitch"];
745 // alert($(window).width());
747 var width = mkws_config.responsive_design_width || 980;
749 if ($(window).width() <= width) {
750 for(var i = 0; i < list.length; i++) {
751 $("#" + list[i]).hide();
754 $("#mkwsTermlists").parent().hide();
755 obj = $("#mkwsTermlists").parent().html();
756 $("#mkwsShiftedTermlists").html("<hr/>" + obj);
758 for(var i = 0; i < list.length; i++) {
759 $("#" + list[i]).show();
761 $("#mkwsTermlists").parent().show();
762 $("#mkwsShiftedTermlists").html("");
768 var lang = mkws_config.lang;
770 if (!lang || !mkws_locale_lang[lang])
773 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
776 /* implement jQuery.parseQuerystring() for parsing URL parameters */
778 parseQuerystring: function() {
780 var qs = window.location.search.replace('?', '');
781 var pairs = qs.split('&');
782 $.each(pairs, function(i, v){
783 var pair = v.split('=');
784 nvpair[pair[0]] = pair[1];
788 pazpar2: function(data) {
789 document.write('<div id="mkwsSwitch"></div>\
790 <div id="mkwsLang"></div>\
791 <div id="mkwsSearch"></div>\
792 <div id="mkwsRecords"></div>\
793 <div id="mkwsTargets"></div>\
794 <div id="mkwsFooter">\
795 <div id="mkwsStat"></div>\
796 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
799 mkws_html_all(mkws_config);
803 function debug(string) {
807 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
811 // you need to disable use strict at the top of the file!!!
812 if (mkws_debug >= 3) {
813 console.log(arguments.callee.caller);
814 } else if (mkws_debug >= 2) {
815 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
821 $(document).ready(function() { mkws_html_all(mkws_config) });