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...
18 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
19 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "/service-proxy/";
21 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
22 var usesessions = mkws_config.use_service_proxy ? false : true;
25 var mkws_locale_lang = {
28 "Subjects": "Schlagwörter",
29 "Sources": "Daten und Quellen",
30 "TERMLISTS": "Termlisten",
32 "Prev": "Zurück",
34 "Sort by": "Sortieren nach",
35 "and show": "und zeige",
36 "per page": "pro Seite",
37 "Displaying": "Zeige",
44 "Subject": "Schlagwort",
51 "Authors": "Forfattere",
54 "TERMLISTS": "TERMLISTS",
55 "Next": "Næste",
57 "Search": "Søg",
58 "Sort by": "Sorter efter",
60 "per page": "per side",
61 "Displaying": "Viser",
66 "Author": "Forfatter",
69 "Location": "Lokation",
75 // create a parameters array and pass it to the pz2's constructor
76 // then register the form submit event with the pz2.search function
77 // autoInit is set to true on default
78 var my_paz = new pz2( { "onshow": my_onshow,
79 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
80 "pazpar2path": pazpar2path,
84 "termlist": "xtargets,subject,author",
85 "onbytarget": my_onbytarget,
86 "usesessions" : usesessions,
87 "showResponseType": '', // or "json" (for debugging?)
88 "onrecord": my_onrecord } );
94 var curDetRecData = null;
95 var curSort = 'relevance';
97 var submitted = false;
103 // pz2.js event handlers:
105 function my_oninit() {
110 function my_onshow(data) {
111 totalRec = data.merged;
113 var pager = document.getElementById("pager");
114 pager.innerHTML = "";
115 pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
116 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
117 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
118 + data.total + ')</div>';
121 var results = document.getElementById("results");
124 for (var i = 0; i < data.hits.length; i++) {
125 var hit = data.hits[i];
126 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
127 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
128 +'<a href="#" id="rec_'+hit.recid
129 +'" onclick="showDetails(this.id);return false;"><b>'
130 + hit["md-title"] +' </b></a>');
131 if (hit["md-title-remainder"] !== undefined) {
132 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
134 if (hit["md-title-responsibility"] !== undefined) {
135 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
137 if (hit.recid == curDetRecId) {
138 html.push(renderDetails(curDetRecData));
142 replaceHtml(results, html.join(''));
145 function my_onstat(data) {
146 var stat = document.getElementById("mkwsStat");
150 stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
152 + '/' + data.clients + ' -- </span>'
153 + '<span>Retrieved records: ' + data.records
154 + '/' + data.hits + ' :.</span>';
157 function my_onterm(data) {
158 if (!mkws_config.termlist_menu)
162 termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
163 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
164 termlists.push('<a href="#" target_id='+data.xtargets[i].id
165 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
166 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
169 termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
170 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
171 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
172 + data.subject[i].freq + ')</span><br/>');
175 termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
176 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
177 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
178 + data.author[i].name
180 + data.author[i].freq
183 var termlist = document.getElementById("termlist");
184 replaceHtml(termlist, termlists.join(''));
187 function my_onrecord(data) {
188 // FIXME: record is async!!
189 clearTimeout(my_paz.recordTimer);
190 // in case on_show was faster to redraw element
191 var detRecordDiv = document.getElementById('det_'+data.recid);
192 if (detRecordDiv) return;
193 curDetRecData = data;
194 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
195 var html = renderDetails(curDetRecData);
196 recordDiv.innerHTML += html;
199 function my_onbytarget(data) {
200 var targetDiv = document.getElementById("bytarget");
201 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
202 +'<td>Records</td><td>State</td></tr></thead><tbody>';
204 for (var i = 0; i < data.length; i++ ) {
205 table += "<tr><td>" + data[i].id +
206 "</td><td>" + data[i].hits +
207 "</td><td>" + data[i].diagnostic +
208 "</td><td>" + data[i].records +
209 "</td><td>" + data[i].state + "</td></tr>";
212 table += '</tbody></table>';
213 targetDiv.innerHTML = table;
216 ////////////////////////////////////////////////////////////////////////////////
217 ////////////////////////////////////////////////////////////////////////////////
219 // wait until the DOM is ready
222 document.search.onsubmit = onFormSubmitEventHandler;
223 document.search.query.value = '';
224 document.select.sort.onchange = onSelectDdChange;
225 document.select.perpage.onchange = onSelectDdChange;
228 // when search button pressed
229 function onFormSubmitEventHandler()
238 function onSelectDdChange()
240 if (!submitted) return false;
243 my_paz.show(0, recPerPage, curSort);
253 function triggerSearch ()
255 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
258 function loadSelect ()
260 curSort = document.select.sort.value;
261 recPerPage = document.select.perpage.value;
264 // limit the query after clicking the facet
265 function limitQuery (field, value)
267 document.search.query.value += ' and ' + field + '="' + value + '"';
268 onFormSubmitEventHandler();
271 // limit by target functions
272 function limitTarget (id, name)
274 var navi = document.getElementById('navi');
276 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
278 navi.innerHTML += '<hr/>';
279 curFilter = 'pz:id=' + id;
286 function delimitTarget ()
288 var navi = document.getElementById('navi');
297 function drawPager (pagerDiv)
299 //client indexes pages from 1 but pz2 from 0
301 var pages = Math.ceil(totalRec / recPerPage);
303 var firstClkbl = ( curPage - onsides > 0 )
307 var lastClkbl = firstClkbl + 2*onsides < pages
308 ? firstClkbl + 2*onsides
311 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
313 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
314 +'<< ' + M('Prev') + '</a><b> | </b>';
317 for(var i = firstClkbl; i <= lastClkbl; i++) {
320 numLabel = '<b>' + i + '</b>';
322 middle += '<a href="#" onclick="showPage(' + i + ')"> '
323 + numLabel + ' </a>';
326 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
327 if (pages - curPage > 0)
328 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
329 + M('Next') + ' >></a>';
336 if (lastClkbl < pages)
339 pagerDiv.innerHTML += '<div style="float: clear">'
340 + prev + predots + middle + postdots + next + '</div><hr/>';
343 function showPage (pageNum)
346 my_paz.showPage( curPage - 1 );
349 // simple paging functions
351 function pagerNext() {
352 if ( totalRec - recPerPage*curPage > 0) {
358 function pagerPrev() {
359 if ( my_paz.showPrev() != false )
363 // swithing view between targets and records
365 function switchView(view) {
367 var targets = document.getElementById('mkwsTargets');
368 var records = document.getElementById('mkwsRecords');
372 targets.style.display = "block";
373 records.style.display = "none";
376 targets.style.display = "none";
377 records.style.display = "block";
380 alert('Unknown view.');
384 // detailed record drawing
385 function showDetails (prefixRecId) {
386 var recId = prefixRecId.replace('rec_', '');
387 var oldRecId = curDetRecId;
390 // remove current detailed view if any
391 var detRecordDiv = document.getElementById('det_'+oldRecId);
394 detRecordDiv.parentNode.removeChild(detRecordDiv);
396 // if the same clicked, just hide
397 if (recId == oldRecId) {
399 curDetRecData = null;
402 // request the record
403 my_paz.record(recId);
406 function replaceHtml(el, html) {
407 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
408 /*@cc_on // Pure innerHTML is slightly faster in IE
409 oldEl.innerHTML = html;
412 var newEl = oldEl.cloneNode(false);
413 newEl.innerHTML = html;
414 oldEl.parentNode.replaceChild(newEl, oldEl);
415 /* Since we just removed the old element from the DOM, return a reference
416 to the new element, which can be used to restore variable references. */
420 function renderDetails(data, marker)
422 var details = '<div class="details" id="det_'+data.recid+'"><table>';
423 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
424 if (data["md-title"] != undefined) {
425 details += '<tr><td><b>' + M('Title') + '</b></td><td><b>:</b> '+data["md-title"];
426 if (data["md-title-remainder"] !== undefined) {
427 details += ' : <span>' + data["md-title-remainder"] + ' </span>';
429 if (data["md-title-responsibility"] !== undefined) {
430 details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
432 details += '</td></tr>';
434 if (data["md-date"] != undefined)
435 details += '<tr><td><b>' + M('Date') + '</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
436 if (data["md-author"] != undefined)
437 details += '<tr><td><b>' + M('Author') + '</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
438 if (data["md-electronic-url"] != undefined)
439 details += '<tr><td><b>URL</b></td><td><b>:</b> <a href="' + data["md-electronic-url"] + '" target="_blank">' + data["md-electronic-url"] + '</a>' + '</td></tr>';
440 if (data["location"][0]["md-subject"] != undefined)
441 details += '<tr><td><b>' + M('Subject') + '</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
442 if (data["location"][0]["@name"] != undefined)
443 details += '<tr><td><b>' + M('Location') + '</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
444 details += '</table></div>';
449 * All the HTML stuff to render the search forms and
452 function mkws_html_all(config) {
454 /* default mkws config */
455 var mkws_config_default = {
456 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
457 perpage: [10, 20, 30, 50],
458 sort_default: "relevance",
461 switch_menu: true, /* show/hide Records|Targets menu */
462 lang_menu: true, /* show/hide language menu */
463 lang_display: [], /* display languages links for given languages, [] for all */
464 termlist_menu: true, /* show/hide termlist */
465 debug: 0, /* debug level for development: 0..2 */
470 /* set global debug flag early */
471 if (config.debug !== 'undefined') {
472 mkws_debug = config.debug;
473 } else if (mkws_config_default.debug !== 'undefined') {
474 mkws_debug = mkws_config_default.debug;
477 /* override standard config values by function parameters */
478 for (var k in mkws_config_default) {
479 if (typeof config[k] === 'undefined')
480 mkws_config[k] = mkws_config_default[k];
481 debug("Set config: " + k + ' => ' + mkws_config[k]);
484 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
485 debug("Reset query width: " + mkws_config.query_width);
486 mkws_config.query_width = 50;
489 mkws_set_lang(mkws_config);
490 if (mkws_config.lang_menu)
491 mkws_html_lang(mkws_config);
493 // For some reason, doing this programmatically results in
494 // document.search.query being undefined, hence the raw HTML.
495 debug("HTML search form");
496 $("#mkwsSearch").html('\
497 <form id="searchForm" name="search" action="" >\
498 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
499 <input id="button" type="submit" value="' + M('Search') + '" />\
502 debug("HTML records");
503 $("#mkwsRecords").html('\
504 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
506 <td width="250" valign="top">\
507 <div id="termlist"></div>\
511 <form name="select" id="select" action="" >\
512 ' + M('Sort by') + mkws_html_sort(config) + '\
513 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
514 ' + M('per page') + '.\
517 <div id="pager"></div>\
518 <div id="navi"></div>\
519 <div id="results"></div>\
524 mkws_html_switch(config);
525 if (mkws_config.use_service_proxy)
526 mkws_service_proxy_auth(config.service_proxy_auth);
531 function mkws_set_lang(mkws_config) {
532 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
533 if (!lang || !mkws_locale_lang[lang]) {
534 mkws_config.lang = ""
536 mkws_config.lang = lang;
539 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
540 return mkws_config.lang;
543 function mkws_html_switch(config) {
544 debug("HTML switch");
546 $("#mkwsSwitch").html($("<a/>", {
548 onclick: "switchView(\'records\')",
551 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
552 $("#mkwsSwitch").append($("<a/>", {
554 onclick: "switchView(\'targets\')",
558 debug("HTML targets");
559 $("#mkwsTargets").html('\
561 No information available yet.\
563 $("#mkwsTargets").css("display", "none");
565 if (!config.switch_menu) {
566 debug("disable switch menu");
567 $("#mkwsSwitch").css("display", "none");
571 function mkws_html_sort(config) {
573 var sort_html = '<select name="sort" id="sort">';
575 for(var i = 0; i < config.sort.length; i++) {
576 var key = config.sort[i][0];
577 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
579 sort_html += '<option value="' + key + '"';
580 if (key == config.sort_default) {
581 sort_html += ' selected="selected"';
583 sort_html += '>' + val + '</option>';
585 sort_html += '</select>';
590 function mkws_html_perpage(config) {
591 debug("HTML perpage");
592 var perpage_html = '<select name="perpage" id="perpage">';
594 for(var i = 0; i < config.perpage.length; i++) {
595 var key = config.perpage[i];
597 perpage_html += '<option value="' + key + '"';
598 if (key == config.perpage_default) {
599 perpage_html += ' selected="selected"';
601 perpage_html += '>' + key + '</option>';
603 perpage_html += '</select>';
609 * Run service-proxy authentication in background (after page load).
610 * The username/password is configured in the apache config file
613 function mkws_service_proxy_auth(auth_url) {
615 auth_url = "/service-proxy-auth";
617 debug("Run service proxy auth URL: " + auth_url);
619 var jqxhr = jQuery.get(auth_url)
621 alert("service proxy authentication failed, give up!");
623 .success(function(data) {
624 if (!jQuery.isXMLDoc(data)) {
625 alert("service proxy auth response document is not valid XML document, give up!");
628 var status = $(data).find("status");
629 if (status.text() != "OK") {
630 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
636 /* create locale language menu */
637 function mkws_html_lang(mkws_config) {
638 var lang_default = "en";
639 var lang = mkws_config.lang || lang_default;
642 /* display a list of configured languages, or all */
643 var lang_display = mkws_config.lang_display || [];
645 for (var i = 0; i < lang_display.length; i++) {
646 hash[lang_display[i]] = 1;
649 if (hash[lang_default] == 1)
650 list.push(lang_default);
652 for (var k in mkws_locale_lang) {
653 if (hash[k] == 1 || lang_display.length == 0)
656 debug("Language menu for: " + list.join(", "));
660 for(var i = 0; i < list.length; i++) {
669 data += ' <a href="?lang=' + l + '">' + l + '</a> '
673 $("#mkwsLang").html(data);
678 var lang = mkws_config.lang;
680 if (!lang || !mkws_locale_lang[lang])
683 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
686 /* implement jQuery.parseQuerystring() for parsing URL parameters */
688 parseQuerystring: function() {
690 var qs = window.location.search.replace('?', '');
691 var pairs = qs.split('&');
692 $.each(pairs, function(i, v){
693 var pair = v.split('=');
694 nvpair[pair[0]] = pair[1];
699 function debug(string) {
703 if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! */
707 // you need to disable use strict at the top of the file!!!
708 if (mkws_debug >= 3) {
709 console.log(arguments.callee.caller);
710 } else if (mkws_debug >= 2) {
711 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
717 $(document).ready(function() { mkws_html_all(mkws_config) });