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 termlists.push('<div class="facet">');
179 termlists.push('<div class="termtitle">' + M('Subjects') + '</div>');
180 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
181 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">'
182 + data.subject[i].name
184 + data.subject[i].freq
187 termlists.push('</div>');
189 termlists.push('<div class="facet">');
190 termlists.push('<div class="termtitle">' + M('Authors') + '</div>');
191 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
192 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
193 + data.author[i].name
195 + data.author[i].freq
198 termlists.push('</div>');
200 var termlist = document.getElementById("termlist");
201 replaceHtml(termlist, termlists.join(''));
204 function my_onrecord(data) {
205 // FIXME: record is async!!
206 clearTimeout(my_paz.recordTimer);
207 // in case on_show was faster to redraw element
208 var detRecordDiv = document.getElementById('det_'+data.recid);
209 if (detRecordDiv) return;
210 curDetRecData = data;
211 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
212 var html = renderDetails(curDetRecData);
213 recordDiv.innerHTML += html;
216 function my_onbytarget(data) {
217 var targetDiv = document.getElementById("bytarget");
218 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
219 +'<td>Records</td><td>State</td></tr></thead><tbody>';
221 for (var i = 0; i < data.length; i++ ) {
222 table += "<tr><td>" + data[i].id +
223 "</td><td>" + data[i].hits +
224 "</td><td>" + data[i].diagnostic +
225 "</td><td>" + data[i].records +
226 "</td><td>" + data[i].state + "</td></tr>";
229 table += '</tbody></table>';
230 targetDiv.innerHTML = table;
233 ////////////////////////////////////////////////////////////////////////////////
234 ////////////////////////////////////////////////////////////////////////////////
236 // wait until the DOM is ready
239 document.search.onsubmit = onFormSubmitEventHandler;
240 document.search.query.value = '';
241 document.select.sort.onchange = onSelectDdChange;
242 document.select.perpage.onchange = onSelectDdChange;
245 // when search button pressed
246 function onFormSubmitEventHandler()
251 switchView('records'); // In case it's configured to start off as hidden
256 function onSelectDdChange()
258 if (!submitted) return false;
261 my_paz.show(0, recPerPage, curSort);
271 function triggerSearch ()
273 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
276 function loadSelect ()
278 curSort = document.select.sort.value;
279 recPerPage = document.select.perpage.value;
282 // limit the query after clicking the facet
283 function limitQuery (field, value)
285 document.search.query.value += ' and ' + field + '="' + value + '"';
286 onFormSubmitEventHandler();
289 // limit by target functions
290 function limitTarget (id, name)
292 var navi = document.getElementById('navi');
294 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
296 navi.innerHTML += '<hr/>';
297 curFilter = 'pz:id=' + id;
304 function delimitTarget ()
306 var navi = document.getElementById('navi');
315 function drawPager (pagerDiv)
317 //client indexes pages from 1 but pz2 from 0
319 var pages = Math.ceil(totalRec / recPerPage);
321 var firstClkbl = ( curPage - onsides > 0 )
325 var lastClkbl = firstClkbl + 2*onsides < pages
326 ? firstClkbl + 2*onsides
329 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
331 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
332 +'<< ' + M('Prev') + '</a><b> | </b>';
335 for(var i = firstClkbl; i <= lastClkbl; i++) {
338 numLabel = '<b>' + i + '</b>';
340 middle += '<a href="#" onclick="showPage(' + i + ')"> '
341 + numLabel + ' </a>';
344 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
345 if (pages - curPage > 0)
346 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
347 + M('Next') + ' >></a>';
354 if (lastClkbl < pages)
357 pagerDiv.innerHTML += '<div style="float: clear">'
358 + prev + predots + middle + postdots + next + '</div><hr/>';
361 function showPage (pageNum)
364 my_paz.showPage( curPage - 1 );
367 // simple paging functions
369 function pagerNext() {
370 if ( totalRec - recPerPage*curPage > 0) {
376 function pagerPrev() {
377 if ( my_paz.showPrev() != false )
381 // swithing view between targets and records
383 function switchView(view) {
385 var targets = document.getElementById('mkwsTargets');
386 var records = document.getElementById('mkwsRecords');
387 var blanket = document.getElementById('mkwsBlanket');
391 targets.style.display = "block";
392 records.style.display = "none";
393 if (blanket) { blanket.style.display = "none"; }
396 targets.style.display = "none";
397 records.style.display = "block";
398 if (blanket) { blanket.style.display = "block"; }
401 targets.style.display = "none";
402 records.style.display = "none";
403 if (blanket) { blanket.style.display = "none"; }
406 alert('Unknown view.');
410 // detailed record drawing
411 function showDetails (prefixRecId) {
412 var recId = prefixRecId.replace('rec_', '');
413 var oldRecId = curDetRecId;
416 // remove current detailed view if any
417 var detRecordDiv = document.getElementById('det_'+oldRecId);
420 detRecordDiv.parentNode.removeChild(detRecordDiv);
422 // if the same clicked, just hide
423 if (recId == oldRecId) {
425 curDetRecData = null;
428 // request the record
429 my_paz.record(recId);
432 function replaceHtml(el, html) {
433 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
434 /*@cc_on // Pure innerHTML is slightly faster in IE
435 oldEl.innerHTML = html;
438 var newEl = oldEl.cloneNode(false);
439 newEl.innerHTML = html;
440 oldEl.parentNode.replaceChild(newEl, oldEl);
441 /* Since we just removed the old element from the DOM, return a reference
442 to the new element, which can be used to restore variable references. */
446 function renderDetails(data, marker)
448 var details = '<div class="details" id="det_'+data.recid+'"><table>';
449 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
451 details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]);
452 details += renderField("Date", data["md-date"]);
453 details += renderField("Author", data["md-author"]);
454 details += renderField("URL", data["md-electronic-url"]);
455 details += renderField("Subject", data["location"][0]["md-subject"]);
456 details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]);
457 details += '</table></div>';
462 function renderField(caption, data, data2, data3) {
463 if (data === undefined) {
467 if (caption == "URL") {
468 data = '<a href="' + data + '" target="_blank">' + data + '</a>';
471 if (data2 != undefined) {
472 data = data + " (" + data2 + ")";
475 if (data3 != undefined) {
476 data = data + " <i>" + data3 + "</i>";
479 return '<tr><th>' + M(caption) + '</th><td>' + data + '</td></tr>';
484 * All the HTML stuff to render the search forms and
487 function mkws_html_all(config) {
489 /* default mkws config */
490 var mkws_config_default = {
491 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
492 perpage: [10, 20, 30, 50],
493 sort_default: "relevance",
496 switch_menu: true, /* show/hide Records|Targets menu */
497 lang_menu: true, /* show/hide language menu */
498 lang_display: [], /* display languages links for given languages, [] for all */
499 termlist_menu: true, /* show/hide termlist */
500 debug: 0, /* debug level for development: 0..2 */
505 /* set global debug flag early */
506 if (config.debug !== 'undefined') {
507 mkws_debug = config.debug;
508 } else if (mkws_config_default.debug !== 'undefined') {
509 mkws_debug = mkws_config_default.debug;
512 /* override standard config values by function parameters */
513 for (var k in mkws_config_default) {
514 if (typeof config[k] === 'undefined')
515 mkws_config[k] = mkws_config_default[k];
516 debug("Set config: " + k + ' => ' + mkws_config[k]);
519 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
520 debug("Reset query width: " + mkws_config.query_width);
521 mkws_config.query_width = 50;
524 mkws_set_lang(mkws_config);
525 if (mkws_config.lang_menu)
526 mkws_html_lang(mkws_config);
528 // For some reason, doing this programmatically results in
529 // document.search.query being undefined, hence the raw HTML.
530 debug("HTML search form");
531 $("#mkwsSearch").html('\
532 <form id="searchForm" name="search" action="" >\
533 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
534 <input id="button" type="submit" value="' + M('Search') + '" />\
537 debug("HTML records");
538 $("#mkwsRecords").html('\
539 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
541 <td width="250" valign="top">\
542 <div id="termlist"></div>\
546 <form name="select" id="select" action="" >\
547 ' + M('Sort by') + ' ' + mkws_html_sort(config) + '\
548 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
549 ' + M('per page') + '.\
552 <div id="pager"></div>\
553 <div id="navi"></div>\
554 <div id="results"></div>\
559 mkws_html_switch(config);
560 if (mkws_config.use_service_proxy)
561 mkws_service_proxy_auth(config.service_proxy_auth);
566 function mkws_set_lang(mkws_config) {
567 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
568 if (!lang || !mkws_locale_lang[lang]) {
569 mkws_config.lang = ""
571 mkws_config.lang = lang;
574 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
575 return mkws_config.lang;
578 function mkws_html_switch(config) {
579 debug("HTML switch");
581 $("#mkwsSwitch").html($("<a/>", {
583 onclick: "switchView(\'records\')",
586 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
587 $("#mkwsSwitch").append($("<a/>", {
589 onclick: "switchView(\'targets\')",
593 debug("HTML targets");
594 $("#mkwsTargets").html('\
596 No information available yet.\
598 $("#mkwsTargets").css("display", "none");
600 if (!config.switch_menu) {
601 debug("disable switch menu");
602 $("#mkwsSwitch").css("display", "none");
606 function mkws_html_sort(config) {
608 var sort_html = '<select name="sort" id="sort">';
610 for(var i = 0; i < config.sort.length; i++) {
611 var key = config.sort[i][0];
612 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
614 sort_html += '<option value="' + key + '"';
615 if (key == config.sort_default) {
616 sort_html += ' selected="selected"';
618 sort_html += '>' + val + '</option>';
620 sort_html += '</select>';
625 function mkws_html_perpage(config) {
626 debug("HTML perpage");
627 var perpage_html = '<select name="perpage" id="perpage">';
629 for(var i = 0; i < config.perpage.length; i++) {
630 var key = config.perpage[i];
632 perpage_html += '<option value="' + key + '"';
633 if (key == config.perpage_default) {
634 perpage_html += ' selected="selected"';
636 perpage_html += '>' + key + '</option>';
638 perpage_html += '</select>';
644 * Run service-proxy authentication in background (after page load).
645 * The username/password is configured in the apache config file
648 function mkws_service_proxy_auth(auth_url) {
650 auth_url = "http://mkws.indexdata.com/service-proxy-auth";
652 debug("Run service proxy auth URL: " + auth_url);
654 var request = new pzHttpRequest(auth_url);
655 request.get(null, function(data) {
656 if (!jQuery.isXMLDoc(data)) {
657 alert("service proxy auth response document is not valid XML document, give up!");
660 var status = $(data).find("status");
661 if (status.text() != "OK") {
662 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
668 /* create locale language menu */
669 function mkws_html_lang(mkws_config) {
670 var lang_default = "en";
671 var lang = mkws_config.lang || lang_default;
674 /* display a list of configured languages, or all */
675 var lang_display = mkws_config.lang_display || [];
677 for (var i = 0; i < lang_display.length; i++) {
678 hash[lang_display[i]] = 1;
681 for (var k in mkws_locale_lang) {
682 if (hash[k] == 1 || lang_display.length == 0)
687 if (lang_display.length == 0 || hash[lang_default] == 1)
688 list.push(lang_default);
690 debug("Language menu for: " + list.join(", "));
694 for(var i = 0; i < list.length; i++) {
701 data += ' <span>' + l + '</span> ';
703 data += ' <a href="?lang=' + l + '">' + l + '</a> '
707 $("#mkwsLang").html(data);
712 var lang = mkws_config.lang;
714 if (!lang || !mkws_locale_lang[lang])
717 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
720 /* implement jQuery.parseQuerystring() for parsing URL parameters */
722 parseQuerystring: function() {
724 var qs = window.location.search.replace('?', '');
725 var pairs = qs.split('&');
726 $.each(pairs, function(i, v){
727 var pair = v.split('=');
728 nvpair[pair[0]] = pair[1];
732 pazpar2: function(data) {
733 document.write('<div id="mkwsSwitch"></div>\
734 <div id="mkwsLang"></div>\
735 <div id="mkwsSearch"></div>\
736 <div id="mkwsRecords"></div>\
737 <div id="mkwsTargets"></div>\
739 <div id="mkwsStat"></div>\
740 <span>Powered by MKWS © 2013 <a href="http://www.indexdata.com">Index Data</a></span>\
743 mkws_html_all(mkws_config);
747 function debug(string) {
751 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */
755 // you need to disable use strict at the top of the file!!!
756 if (mkws_debug >= 3) {
757 console.log(arguments.callee.caller);
758 } else if (mkws_debug >= 2) {
759 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
765 $(document).ready(function() { mkws_html_all(mkws_config) });