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("pager");
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("results");
127 for (var i = 0; i < data.hits.length; i++) {
128 var hit = data.hits[i];
129 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
130 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
131 +'<a href="#" id="rec_'+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) {
161 if (!mkws_config.termlist_menu)
165 termlists.push('<div class="title">' + M('Termlists') + '</div>');
167 termlists.push('<div class="facet">');
168 termlists.push('<div class="termtitle">' + M('Sources') + '</div>');
169 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
170 termlists.push('<a href="#" target_id='+data.xtargets[i].id + ' onclick="limitTarget(this.getAttribute(\'target_id\'),this.firstChild.nodeValue);return false;">'
171 + data.xtargets[i].name
173 + data.xtargets[i].freq
176 termlists.push('</div>');
178 add_single_facet(termlists, "Subjects", data.subject, SubjectMax, "su");
179 add_single_facet(termlists, "Authors", data.author, AuthorMax, "au");
181 var termlist = document.getElementById("termlist");
182 replaceHtml(termlist, termlists.join(''));
185 function add_single_facet(termlists, caption, data, max, cclIndex) {
186 termlists.push('<div class="facet">');
187 termlists.push('<div class="termtitle">' + M(caption) + '</div>');
188 for (var i = 0; i < data.length && i < max; i++ ) {
189 termlists.push('<a href="#" onclick="limitQuery(\'' + cclIndex + '\', this.firstChild.nodeValue);return false;">'
195 termlists.push('</div>');
198 function my_onrecord(data) {
199 // FIXME: record is async!!
200 clearTimeout(my_paz.recordTimer);
201 // in case on_show was faster to redraw element
202 var detRecordDiv = document.getElementById('det_'+data.recid);
203 if (detRecordDiv) return;
204 curDetRecData = data;
205 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
206 var html = renderDetails(curDetRecData);
207 recordDiv.innerHTML += html;
210 function my_onbytarget(data) {
211 var targetDiv = document.getElementById("bytarget");
212 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
213 +'<td>Records</td><td>State</td></tr></thead><tbody>';
215 for (var i = 0; i < data.length; i++ ) {
216 table += "<tr><td>" + data[i].id +
217 "</td><td>" + data[i].hits +
218 "</td><td>" + data[i].diagnostic +
219 "</td><td>" + data[i].records +
220 "</td><td>" + data[i].state + "</td></tr>";
223 table += '</tbody></table>';
224 targetDiv.innerHTML = table;
227 ////////////////////////////////////////////////////////////////////////////////
228 ////////////////////////////////////////////////////////////////////////////////
230 // wait until the DOM is ready
233 document.search.onsubmit = onFormSubmitEventHandler;
234 document.search.query.value = '';
235 document.select.sort.onchange = onSelectDdChange;
236 document.select.perpage.onchange = onSelectDdChange;
239 // when search button pressed
240 function onFormSubmitEventHandler()
245 switchView('records'); // In case it's configured to start off as hidden
250 function onSelectDdChange()
252 if (!submitted) return false;
255 my_paz.show(0, recPerPage, curSort);
265 function triggerSearch ()
267 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
270 function loadSelect ()
272 curSort = document.select.sort.value;
273 recPerPage = document.select.perpage.value;
276 // limit the query after clicking the facet
277 function limitQuery (field, value)
279 document.search.query.value += ' and ' + field + '="' + value + '"';
280 onFormSubmitEventHandler();
283 // limit by target functions
284 function limitTarget (id, name)
286 var navi = document.getElementById('navi');
288 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
290 navi.innerHTML += '<hr/>';
291 curFilter = 'pz:id=' + id;
298 function delimitTarget ()
300 var navi = document.getElementById('navi');
309 function drawPager (pagerDiv)
311 //client indexes pages from 1 but pz2 from 0
313 var pages = Math.ceil(totalRec / recPerPage);
315 var firstClkbl = ( curPage - onsides > 0 )
319 var lastClkbl = firstClkbl + 2*onsides < pages
320 ? firstClkbl + 2*onsides
323 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
325 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
326 +'<< ' + M('Prev') + '</a><b> | </b>';
329 for(var i = firstClkbl; i <= lastClkbl; i++) {
332 numLabel = '<b>' + i + '</b>';
334 middle += '<a href="#" onclick="showPage(' + i + ')"> '
335 + numLabel + ' </a>';
338 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
339 if (pages - curPage > 0)
340 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
341 + M('Next') + ' >></a>';
348 if (lastClkbl < pages)
351 pagerDiv.innerHTML += '<div style="float: clear">'
352 + prev + predots + middle + postdots + next + '</div><hr/>';
355 function showPage (pageNum)
358 my_paz.showPage( curPage - 1 );
361 // simple paging functions
363 function pagerNext() {
364 if ( totalRec - recPerPage*curPage > 0) {
370 function pagerPrev() {
371 if ( my_paz.showPrev() != false )
375 // swithing view between targets and records
377 function switchView(view) {
379 var targets = document.getElementById('mkwsTargets');
380 var records = document.getElementById('mkwsRecords');
381 var blanket = document.getElementById('mkwsBlanket');
385 targets.style.display = "block";
386 records.style.display = "none";
387 if (blanket) { blanket.style.display = "none"; }
390 targets.style.display = "none";
391 records.style.display = "block";
392 if (blanket) { blanket.style.display = "block"; }
395 targets.style.display = "none";
396 records.style.display = "none";
397 if (blanket) { blanket.style.display = "none"; }
400 alert('Unknown view.');
404 // detailed record drawing
405 function showDetails (prefixRecId) {
406 var recId = prefixRecId.replace('rec_', '');
407 var oldRecId = curDetRecId;
410 // remove current detailed view if any
411 var detRecordDiv = document.getElementById('det_'+oldRecId);
414 detRecordDiv.parentNode.removeChild(detRecordDiv);
416 // if the same clicked, just hide
417 if (recId == oldRecId) {
419 curDetRecData = null;
422 // request the record
423 my_paz.record(recId);
426 function replaceHtml(el, html) {
427 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
428 /*@cc_on // Pure innerHTML is slightly faster in IE
429 oldEl.innerHTML = html;
432 var newEl = oldEl.cloneNode(false);
433 newEl.innerHTML = html;
434 oldEl.parentNode.replaceChild(newEl, oldEl);
435 /* Since we just removed the old element from the DOM, return a reference
436 to the new element, which can be used to restore variable references. */
440 function renderDetails(data, marker)
442 var details = '<div class="details" id="det_'+data.recid+'"><table>';
443 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
445 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
446 details += renderField("Date", data["md-date"]);
447 details += renderField("Author", data["md-author"]);
448 details += renderField("URL", data["md-electronic-url"]);
449 details += renderField("Subject", data["location"][0]["md-subject"]);
450 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
451 details += '</table></div>';
456 function renderField(caption, data, data2, data3) {
457 if (data === undefined) {
461 if (caption == "URL") {
462 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
465 if (data2 != undefined) {
466 data = data + " (" + data2 + ")";
469 if (data3 != undefined) {
470 data = data + " <i>" + data3 + "</i>";
473 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
478 * All the HTML stuff to render the search forms and
481 function mkws_html_all(config) {
483 /* default mkws config */
484 var mkws_config_default = {
485 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
486 perpage: [10, 20, 30, 50],
487 sort_default: "relevance",
490 switch_menu: true, /* show/hide Records|Targets menu */
491 lang_menu: true, /* show/hide language menu */
492 lang_display: [], /* display languages links for given languages, [] for all */
493 termlist_menu: true, /* show/hide termlist */
494 debug: 0, /* debug level for development: 0..2 */
499 /* set global debug flag early */
500 if (config.debug !== 'undefined') {
501 mkws_debug = config.debug;
502 } else if (mkws_config_default.debug !== 'undefined') {
503 mkws_debug = mkws_config_default.debug;
506 /* override standard config values by function parameters */
507 for (var k in mkws_config_default) {
508 if (typeof config[k] === 'undefined')
509 mkws_config[k] = mkws_config_default[k];
510 debug("Set config: " + k + ' => ' + mkws_config[k]);
513 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
514 debug("Reset query width: " + mkws_config.query_width);
515 mkws_config.query_width = 50;
518 mkws_set_lang(mkws_config);
519 if (mkws_config.lang_menu)
520 mkws_html_lang(mkws_config);
522 // For some reason, doing this programmatically results in
523 // document.search.query being undefined, hence the raw HTML.
524 debug("HTML search form");
525 $("#mkwsSearch").html('\
526 <form id="searchForm" name="search" action="" >\
527 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
528 <input id="button" type="submit" value="' + M('Search') + '" />\
531 debug("HTML records");
532 $("#mkwsRecords").html('\
533 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
535 <td width="250" valign="top">\
536 <div id="termlist"></div>\
540 <form name="select" id="select" action="" >\
541 ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
542 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
543 ' + M('per page') + '.\
546 <div id="pager"></div>\
547 <div id="navi"></div>\
548 <div id="results"></div>\
553 mkws_html_switch(config);
554 if (mkws_config.use_service_proxy)
555 mkws_service_proxy_auth(config.service_proxy_auth);
560 function mkws_set_lang(mkws_config) {
561 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
562 if (!lang || !mkws_locale_lang[lang]) {
563 mkws_config.lang = ""
565 mkws_config.lang = lang;
568 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
569 return mkws_config.lang;
572 function mkws_html_switch(config) {
573 debug("HTML switch");
575 $("#mkwsSwitch").html($("<a/>", {
577 onclick: "switchView(\'records\')",
580 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
581 $("#mkwsSwitch").append($("<a/>", {
583 onclick: "switchView(\'targets\')",
587 debug("HTML targets");
588 $("#mkwsTargets").html('\
590 No information available yet.\
592 $("#mkwsTargets").css("display", "none");
594 if (!config.switch_menu) {
595 debug("disable switch menu");
596 $("#mkwsSwitch").css("display", "none");
600 function mkws_html_sort(config) {
602 var sort_html = '<select name="sort" id="sort">';
604 for(var i = 0; i < config.sort.length; i++) {
605 var key = config.sort[i][0];
606 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
608 sort_html += '<option value="' + key + '"';
609 if (key == config.sort_default) {
610 sort_html += ' selected="selected"';
612 sort_html += '>' + val + '</option>';
614 sort_html += '</select>';
619 function mkws_html_perpage(config) {
620 debug("HTML perpage");
621 var perpage_html = '<select name="perpage" id="perpage">';
623 for(var i = 0; i < config.perpage.length; i++) {
624 var key = config.perpage[i];
626 perpage_html += '<option value="' + key + '"';
627 if (key == config.perpage_default) {
628 perpage_html += ' selected="selected"';
630 perpage_html += '>' + key + '</option>';
632 perpage_html += '</select>';
638 * Run service-proxy authentication in background (after page load).
639 * The username/password is configured in the apache config file
642 function mkws_service_proxy_auth(auth_url) {
644 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
646 debug("Run service proxy auth URL: " + auth_url);
648 var request = new pzHttpRequest(auth_url);
649 request.get(null, function(data) {
650 if (!jQuery.isXMLDoc(data)) {
651 alert("service proxy auth response document is not valid XML document, give up!");
654 var status = $(data).find("status");
655 if (status.text() != "OK") {
656 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
662 /* create locale language menu */
663 function mkws_html_lang(mkws_config) {
664 var lang_default = "en";
665 var lang = mkws_config.lang || lang_default;
668 /* display a list of configured languages, or all */
669 var lang_display = mkws_config.lang_display || [];
671 for (var i = 0; i < lang_display.length; i++) {
672 hash[lang_display[i]] = 1;
675 for (var k in mkws_locale_lang) {
676 if (hash[k] == 1 || lang_display.length == 0)
681 if (lang_display.length == 0 || hash[lang_default] == 1)
682 list.push(lang_default);
684 debug("Language menu for: " + list.join(", "));
688 for(var i = 0; i < list.length; i++) {
695 data += ' <span>' + l + '</span> ';
697 data += ' <a href="?lang=' + l + '">' + l + '</a> '
701 $("#mkwsLang").html(data);
706 var lang = mkws_config.lang;
708 if (!lang || !mkws_locale_lang[lang])
711 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
714 /* implement jQuery.parseQuerystring() for parsing URL parameters */
716 parseQuerystring: function() {
718 var qs = window.location.search.replace('?', '');
719 var pairs = qs.split('&');
720 $.each(pairs, function(i, v){
721 var pair = v.split('=');
722 nvpair[pair[0]] = pair[1];
726 pazpar2: function(data) {
727 document.write('<div id="mkwsSwitch"></div>\
728 <div id="mkwsLang"></div>\
729 <div id="mkwsSearch"></div>\
730 <div id="mkwsRecords"></div>\
731 <div id="mkwsTargets"></div>\
733 <div id="mkwsStat"></div>\
734 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
737 mkws_html_all(mkws_config);
741 function debug(string) {
745 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
749 // you need to disable use strict at the top of the file!!!
750 if (mkws_debug >= 3) {
751 console.log(arguments.callee.caller);
752 } else if (mkws_debug >= 2) {
753 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
759 $(document).ready(function() { mkws_html_all(mkws_config) });