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(''));
203 function add_single_facet(acc, caption, data, max, cclIndex) {
204 acc.push('<div class="facet">');
205 acc.push('<div class="termtitle">' + M(caption) + '</div>');
206 for (var i = 0; i < data.length && i < max; i++ ) {
207 acc.push('<a href="#" ');
210 // Special case: target selection
211 acc.push('target_id='+data[i].id+' ');
212 action = 'limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue)';
214 action = 'limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue)';
216 acc.push('onclick="' + action + ';return false;">' + data[i].name + '</a>'
217 + '<span> (' + data[i].freq + ')</span><br/>');
222 function my_onrecord(data) {
223 // FIXME: record is async!!
224 clearTimeout(my_paz.recordTimer);
225 // in case on_show was faster to redraw element
226 var detRecordDiv = document.getElementById('mkwsDet_'+data.recid);
227 if (detRecordDiv) return;
228 curDetRecData = data;
229 var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid);
230 var html = renderDetails(curDetRecData);
231 recordDiv.innerHTML += html;
234 function my_onbytarget(data) {
235 var targetDiv = document.getElementById("mkwsBytarget");
236 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
237 +'<td>Records</td><td>State</td></tr></thead><tbody>';
239 for (var i = 0; i < data.length; i++ ) {
240 table += "<tr><td>" + data[i].id +
241 "</td><td>" + data[i].hits +
242 "</td><td>" + data[i].diagnostic +
243 "</td><td>" + data[i].records +
244 "</td><td>" + data[i].state + "</td></tr>";
247 table += '</tbody></table>';
248 targetDiv.innerHTML = table;
251 ////////////////////////////////////////////////////////////////////////////////
252 ////////////////////////////////////////////////////////////////////////////////
254 // wait until the DOM is ready
257 document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler;
258 document.mkwsSearchForm.mkwsQuery.value = '';
259 if (document.mkwsSelect) {
260 if (document.mkwsSelect.mkwsSort)
261 document.mkwsSelect.mkwsSort.onchange = onSelectDdChange;
262 if (document.mkwsSelect.mkwsPerpage)
263 document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange;
267 // when search button pressed
268 function onFormSubmitEventHandler()
273 switchView('records'); // In case it's configured to start off as hidden
278 function onSelectDdChange()
280 if (!submitted) return false;
283 my_paz.show(0, recPerPage, curSort);
293 function triggerSearch ()
295 my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter);
298 function loadSelect ()
300 if (document.mkwsSelect) {
301 if (document.mkwsSelect.mkwsSort)
302 curSort = document.mkwsSelect.mkwsSort.value;
303 if (document.mkwsSelect.mkwsPerpage)
304 recPerPage = document.mkwsSelect.mkwsPerpage.value;
308 // limit the query after clicking the facet
309 function limitQuery (field, value)
311 document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"';
312 onFormSubmitEventHandler();
315 // limit by target functions
316 function limitTarget (id, name)
318 var navi = document.getElementById('mkwsNavi');
320 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
322 curFilter = 'pz:id=' + id;
329 function delimitTarget ()
331 var navi = document.getElementById('mkwsNavi');
340 function drawPager (pagerDiv)
342 //client indexes pages from 1 but pz2 from 0
344 var pages = Math.ceil(totalRec / recPerPage);
346 var firstClkbl = ( curPage - onsides > 0 )
350 var lastClkbl = firstClkbl + 2*onsides < pages
351 ? firstClkbl + 2*onsides
354 var prev = '<span id="mkwsPrev"><< ' + M('Prev') + '</span><b> | </b>';
356 prev = '<a href="#" id="mkwsPrev" onclick="pagerPrev();">'
357 +'<< ' + M('Prev') + '</a><b> | </b>';
360 for(var i = firstClkbl; i <= lastClkbl; i++) {
363 numLabel = '<b>' + i + '</b>';
365 middle += '<a href="#" onclick="showPage(' + i + ')"> '
366 + numLabel + ' </a>';
369 var next = '<b> | </b><span id="mkwsNext">' + M('Next') + ' >></span>';
370 if (pages - curPage > 0)
371 next = '<b> | </b><a href="#" id="mkwsNext" onclick="pagerNext()">'
372 + M('Next') + ' >></a>';
379 if (lastClkbl < pages)
382 pagerDiv.innerHTML += '<div style="float: clear">'
383 + prev + predots + middle + postdots + next + '</div>';
386 function showPage (pageNum)
389 my_paz.showPage( curPage - 1 );
392 // simple paging functions
394 function pagerNext() {
395 if ( totalRec - recPerPage*curPage > 0) {
401 function pagerPrev() {
402 if ( my_paz.showPrev() != false )
406 // switching view between targets and records
408 function switchView(view) {
409 var targets = document.getElementById('mkwsTargets');
410 var results = document.getElementById('mkwsResults') ||
411 document.getElementById('mkwsRecords');
412 var blanket = document.getElementById('mkwsBlanket');
413 var motd = document.getElementById('mkwsMOTD');
417 if (targets) targets.style.display = "block";
418 if (results) results.style.display = "none";
419 if (blanket) blanket.style.display = "none";
420 if (motd) motd.style.display = "none";
423 if (targets) targets.style.display = "none";
424 if (results) results.style.display = "block";
425 if (blanket) blanket.style.display = "block";
426 if (motd) motd.style.display = "none";
429 if (targets) targets.style.display = "none";
430 if (results) results.style.display = "none";
431 if (blanket) blanket.style.display = "none";
432 if (motd) motd.style.display = "none";
435 alert("Unknown view '" + view + "'");
439 // detailed record drawing
440 function showDetails (prefixRecId) {
441 var recId = prefixRecId.replace('mkwsRec_', '');
442 var oldRecId = curDetRecId;
445 // remove current detailed view if any
446 var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId);
449 detRecordDiv.parentNode.removeChild(detRecordDiv);
451 // if the same clicked, just hide
452 if (recId == oldRecId) {
454 curDetRecData = null;
457 // request the record
458 my_paz.record(recId);
461 function replaceHtml(el, html) {
462 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
463 /*@cc_on // Pure innerHTML is slightly faster in IE
464 oldEl.innerHTML = html;
467 var newEl = oldEl.cloneNode(false);
468 newEl.innerHTML = html;
469 oldEl.parentNode.replaceChild(newEl, oldEl);
470 /* Since we just removed the old element from the DOM, return a reference
471 to the new element, which can be used to restore variable references. */
475 function renderDetails(data, marker)
477 var details = '<div class="details" id="mkwsDet_'+data.recid+'"><table>';
478 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
480 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
481 details += renderField("Date", data["md-date"]);
482 details += renderField("Author", data["md-author"]);
483 details += renderField("URL", data["md-electronic-url"]);
484 details += renderField("Subject", data["location"][0]["md-subject"]);
485 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
486 details += '</table></div>';
491 function renderField(caption, data, data2, data3) {
492 if (data === undefined) {
496 if (caption == "URL") {
497 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
500 if (data2 != undefined) {
501 data = data + " (" + data2 + ")";
504 if (data3 != undefined) {
505 data = data + " <i>" + data3 + "</i>";
508 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
513 * All the HTML stuff to render the search forms and
516 function mkws_html_all(config) {
518 /* default mkws config */
519 var mkws_config_default = {
520 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
521 perpage: [10, 20, 30, 50],
522 sort_default: "relevance",
525 switch_menu: false, /* show/hide Records|Targets menu */
526 lang_menu: true, /* show/hide language menu */
527 sort_menu: true, /* show/hide sort menu */
528 perpage_menu: true, /* show/hide perpage menu */
529 lang_display: [], /* display languages links for given languages, [] for all */
530 facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
531 responsive_design_width: 980, /* a page with less pixel width considered as narrow */
532 debug: 1, /* debug level for development: 0..2 */
537 /* set global debug flag early */
538 if (typeof config.debug !== 'undefined') {
539 mkws_debug = config.debug;
540 } else if (typeof mkws_config_default.debug !== 'undefined') {
541 mkws_debug = mkws_config_default.debug;
544 /* override standard config values by function parameters */
545 for (var k in mkws_config_default) {
546 if (typeof config[k] === 'undefined')
547 mkws_config[k] = mkws_config_default[k];
548 debug("Set config: " + k + ' => ' + mkws_config[k]);
551 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
552 debug("Reset query width: " + mkws_config.query_width);
553 mkws_config.query_width = 50;
556 mkws_set_lang(mkws_config);
557 if (mkws_config.lang_menu)
558 mkws_html_lang(mkws_config);
560 // For some reason, doing this programmatically results in
561 // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML.
562 debug("HTML search form");
563 $("#mkwsSearch").html('\
564 <form name="mkwsSearchForm" action="" >\
565 <input id="mkwsQuery" type="text" size="' + mkws_config.query_width + '" />\
566 <input id="mkwsButton" type="submit" value="' + M('Search') + '" />\
569 debug("HTML records");
570 // If the application has an #mkwsResults, populate it in the
571 // usual way. If not, assume that it's a smarter application that
572 // defines its own subcomponents:
578 if ($("#mkwsResults").length) {
579 $("#mkwsResults").html('\
580 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
582 <td id="mkwsTermlistContainer1" width="250" valign="top">\
583 <div id="mkwsTermlists"></div>\
585 <td id="mkwsMOTDContainer" valign="top">\
586 <div id="mkwsRanking"></div>\
587 <div id="mkwsPager"></div>\
588 <div id="mkwsNavi"></div>\
589 <div id="mkwsRecords"></div>\
594 <div id="mkwsTermlistContainer2"></div>\
600 if ($("#mkwsRanking").length) {
601 var ranking_data = '';
602 ranking_data += '<form name="mkwsSelect" id="mkwsSelect" action="" >';
603 if (config.sort_menu) {
604 ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' ';
606 if (config.perpage_menu) {
607 ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.';
609 ranking_data += '</form>';
611 $("#mkwsRanking").html(ranking_data);
614 mkws_html_switch(config);
616 if (mkws_config.use_service_proxy)
617 mkws_service_proxy_auth(config.service_proxy_auth);
619 if (mkws_config.responsive_design) {
620 // Responsive web design - change layout on the fly based on
621 // current screen width. Required for mobile devices.
622 $(window).resize( function(e) { mkws_resize_page() });
623 // initial check after page load
624 $(document).ready(function() { mkws_resize_page() });
629 // on first page, hide the termlist
630 $(document).ready(function() { $("#mkwsTermlists").hide(); } );
631 var motd = document.getElementById("mkwsMOTD");
632 var container = document.getElementById("mkwsMOTDContainer");
633 if (motd && container) {
634 // Move the MOTD from the provided element down into the container
635 motd.parentNode.removeChild(motd);
636 container.appendChild(motd);
640 function mkws_set_lang(mkws_config) {
641 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
642 if (!lang || !mkws_locale_lang[lang]) {
643 mkws_config.lang = ""
645 mkws_config.lang = lang;
648 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
649 return mkws_config.lang;
652 function mkws_html_switch(config) {
653 debug("HTML switch");
655 $("#mkwsSwitch").html($("<a/>", {
657 onclick: "switchView(\'records\')",
660 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
661 $("#mkwsSwitch").append($("<a/>", {
663 onclick: "switchView(\'targets\')",
667 debug("HTML targets");
668 $("#mkwsTargets").html('\
669 <div id="mkwsBytarget">\
670 No information available yet.\
672 $("#mkwsTargets").css("display", "none");
674 if (!config.switch_menu) {
675 debug("disable switch menu");
676 $("#mkwsSwitch").css("display", "none");
680 function mkws_html_sort(config) {
682 var sort_html = '<select name="mkwsSort" id="mkwsSort">';
684 for(var i = 0; i < config.sort.length; i++) {
685 var key = config.sort[i][0];
686 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
688 sort_html += '<option value="' + key + '"';
689 if (key == config.sort_default) {
690 sort_html += ' selected="selected"';
692 sort_html += '>' + val + '</option>';
694 sort_html += '</select>';
699 function mkws_html_perpage(config) {
700 debug("HTML perpage");
701 var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
703 for(var i = 0; i < config.perpage.length; i++) {
704 var key = config.perpage[i];
706 perpage_html += '<option value="' + key + '"';
707 if (key == config.perpage_default) {
708 perpage_html += ' selected="selected"';
710 perpage_html += '>' + key + '</option>';
712 perpage_html += '</select>';
718 * Run service-proxy authentication in background (after page load).
719 * The username/password is configured in the apache config file
722 function mkws_service_proxy_auth(auth_url) {
724 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
726 debug("Run service proxy auth URL: " + auth_url);
728 var request = new pzHttpRequest(auth_url);
729 request.get(null, function(data) {
730 if (!jQuery.isXMLDoc(data)) {
731 alert("service proxy auth response document is not valid XML document, give up!");
734 var status = $(data).find("status");
735 if (status.text() != "OK") {
736 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
742 /* create locale language menu */
743 function mkws_html_lang(mkws_config) {
744 var lang_default = "en";
745 var lang = mkws_config.lang || lang_default;
748 /* display a list of configured languages, or all */
749 var lang_display = mkws_config.lang_display || [];
751 for (var i = 0; i < lang_display.length; i++) {
752 hash[lang_display[i]] = 1;
755 for (var k in mkws_locale_lang) {
756 if (hash[k] == 1 || lang_display.length == 0)
761 if (lang_display.length == 0 || hash[lang_default] == 1)
762 list.push(lang_default);
764 debug("Language menu for: " + list.join(", "));
768 for(var i = 0; i < list.length; i++) {
775 data += ' <span>' + l + '</span> ';
777 data += ' <a href="?lang=' + l + '">' + l + '</a> '
781 $("#mkwsLang").html(data);
784 function mkws_resize_page () {
785 var list = ["mkwsSwitch"];
787 var width = mkws_config.responsive_design_width || 980;
788 var parentId = $("#mkwsTermlists").parent().attr('id');
790 if ($(window).width() <= width &&
791 parentId === "mkwsTermlistContainer1") {
792 debug("changing from wide to narrow: " + $(window).width());
793 $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer2"));
794 $("#mkwsTermlistContainer1").hide();
795 $("#mkwsTermlistContainer2").show();
796 for(var i = 0; i < list.length; i++) {
797 $("#" + list[i]).hide();
799 } else if ($(window).width() > width &&
800 parentId === "mkwsTermlistContainer2") {
801 debug("changing from narrow to wide: " + $(window).width());
802 $("#mkwsTermlists").appendTo($("#mkwsTermlistContainer1"));
803 $("#mkwsTermlistContainer1").show();
804 $("#mkwsTermlistContainer2").hide();
805 for(var i = 0; i < list.length; i++) {
806 $("#" + list[i]).show();
813 var lang = mkws_config.lang;
815 if (!lang || !mkws_locale_lang[lang])
818 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
821 /* implement jQuery.parseQuerystring() for parsing URL parameters */
823 parseQuerystring: function() {
825 var qs = window.location.search.replace('?', '');
826 var pairs = qs.split('&');
827 $.each(pairs, function(i, v){
828 var pair = v.split('=');
829 nvpair[pair[0]] = pair[1];
833 pazpar2: function(config) {
836 var div = '<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>\
848 <style type="text/css">\
849 #mkwsTermlists div.facet {\
859 <table width="100%" border="0">\
862 <div id="mkwsSwitch"></div>\
863 <div id="mkwsLang"></div>\
864 <div id="mkwsSearch"></div>\
869 <div style="height:500px; overflow: auto">\
870 <div id="mkwsPager"></div>\
871 <div id="mkwsNavi"></div>\
872 <div id="mkwsRecords"></div>\
873 <div id="mkwsTargets"></div>\
874 <div id="mkwsRanking"></div>\
880 <div style="height:300px; overflow: hidden">\
881 <div id="mkwsTermlists"></div>\
887 <div id="mkwsStat"></div>\
892 if (config && config.layout == 'table') {
893 debug("jquery plugin layout: table");
894 document.write(table);
896 debug("jquery plugin layout: div");
900 mkws_html_all(mkws_config);
904 function debug(string) {
908 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
912 // you need to disable use strict at the top of the file!!!
913 if (mkws_debug >= 3) {
914 console.log(arguments.callee.caller);
915 } else if (mkws_debug >= 2) {
916 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
922 $(document).ready(function() { mkws_html_all(mkws_config) });