1 /* A very simple client that shows a basic usage of the pz2.js
7 var mkws_config = {}; // for the guys who forgot to define mkws_config...
9 var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2";
10 var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "/service-proxy/";
12 var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url;
13 var usesessions = mkws_config.use_service_proxy ? false : true;
17 var mkws_locale_lang = {
20 "Subjects": "Schlagwörter",
21 "Sources": "Daten und Quellen",
22 "TERMLISTS": "Termlisten",
24 "Prev": "Zurück",
26 "Sort by": "Sortieren nach",
27 "and show": "und zeige",
28 "per page": "pro Seite",
29 "Displaying": "Zeige",
36 "Subject": "Schlagwort",
43 "Authors": "Forfattere",
46 "TERMLISTS": "TERMLISTS",
47 "Next": "Næste",
49 "Search": "Søg",
50 "Sort by": "Sorter efter",
52 "per page": "per side",
53 "Displaying": "Viser",
61 "Location": "Location",
67 // create a parameters array and pass it to the pz2's constructor
68 // then register the form submit event with the pz2.search function
69 // autoInit is set to true on default
70 var my_paz = new pz2( { "onshow": my_onshow,
71 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
72 "pazpar2path": pazpar2path,
76 "termlist": "xtargets,subject,author",
77 "onbytarget": my_onbytarget,
78 "usesessions" : usesessions,
79 "showResponseType": '', // or "json" (for debugging?)
80 "onrecord": my_onrecord } );
86 var curDetRecData = null;
87 var curSort = 'relevance';
89 var submitted = false;
95 // pz2.js event handlers:
97 function my_oninit() {
102 function my_onshow(data) {
103 totalRec = data.merged;
105 var pager = document.getElementById("pager");
106 pager.innerHTML = "";
107 pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
108 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
109 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
110 + data.total + ')</div>';
113 var results = document.getElementById("results");
116 for (var i = 0; i < data.hits.length; i++) {
117 var hit = data.hits[i];
118 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
119 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
120 +'<a href="#" id="rec_'+hit.recid
121 +'" onclick="showDetails(this.id);return false;"><b>'
122 + hit["md-title"] +' </b></a>');
123 if (hit["md-title-remainder"] !== undefined) {
124 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
126 if (hit["md-title-responsibility"] !== undefined) {
127 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
129 if (hit.recid == curDetRecId) {
130 html.push(renderDetails(curDetRecData));
134 replaceHtml(results, html.join(''));
137 function my_onstat(data) {
138 var stat = document.getElementById("mkwsStat");
142 stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
144 + '/' + data.clients + ' -- </span>'
145 + '<span>Retrieved records: ' + data.records
146 + '/' + data.hits + ' :.</span>';
149 function my_onterm(data) {
151 termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
152 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
153 termlists.push('<a href="#" target_id='+data.xtargets[i].id
154 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
155 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
158 termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
159 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
160 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
161 + data.subject[i].freq + ')</span><br/>');
164 termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
165 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
166 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
167 + data.author[i].name
169 + data.author[i].freq
172 var termlist = document.getElementById("termlist");
173 replaceHtml(termlist, termlists.join(''));
176 function my_onrecord(data) {
177 // FIXME: record is async!!
178 clearTimeout(my_paz.recordTimer);
179 // in case on_show was faster to redraw element
180 var detRecordDiv = document.getElementById('det_'+data.recid);
181 if (detRecordDiv) return;
182 curDetRecData = data;
183 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
184 var html = renderDetails(curDetRecData);
185 recordDiv.innerHTML += html;
188 function my_onbytarget(data) {
189 var targetDiv = document.getElementById("bytarget");
190 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
191 +'<td>Records</td><td>State</td></tr></thead><tbody>';
193 for (var i = 0; i < data.length; i++ ) {
194 table += "<tr><td>" + data[i].id +
195 "</td><td>" + data[i].hits +
196 "</td><td>" + data[i].diagnostic +
197 "</td><td>" + data[i].records +
198 "</td><td>" + data[i].state + "</td></tr>";
201 table += '</tbody></table>';
202 targetDiv.innerHTML = table;
205 ////////////////////////////////////////////////////////////////////////////////
206 ////////////////////////////////////////////////////////////////////////////////
208 // wait until the DOM is ready
211 document.search.onsubmit = onFormSubmitEventHandler;
212 document.search.query.value = '';
213 document.select.sort.onchange = onSelectDdChange;
214 document.select.perpage.onchange = onSelectDdChange;
217 // when search button pressed
218 function onFormSubmitEventHandler()
227 function onSelectDdChange()
229 if (!submitted) return false;
232 my_paz.show(0, recPerPage, curSort);
242 function triggerSearch ()
244 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
247 function loadSelect ()
249 curSort = document.select.sort.value;
250 recPerPage = document.select.perpage.value;
253 // limit the query after clicking the facet
254 function limitQuery (field, value)
256 document.search.query.value += ' and ' + field + '="' + value + '"';
257 onFormSubmitEventHandler();
260 // limit by target functions
261 function limitTarget (id, name)
263 var navi = document.getElementById('navi');
265 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
267 navi.innerHTML += '<hr/>';
268 curFilter = 'pz:id=' + id;
275 function delimitTarget ()
277 var navi = document.getElementById('navi');
286 function drawPager (pagerDiv)
288 //client indexes pages from 1 but pz2 from 0
290 var pages = Math.ceil(totalRec / recPerPage);
292 var firstClkbl = ( curPage - onsides > 0 )
296 var lastClkbl = firstClkbl + 2*onsides < pages
297 ? firstClkbl + 2*onsides
300 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
302 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
303 +'<< ' + M('Prev') + '</a><b> | </b>';
306 for(var i = firstClkbl; i <= lastClkbl; i++) {
309 numLabel = '<b>' + i + '</b>';
311 middle += '<a href="#" onclick="showPage(' + i + ')"> '
312 + numLabel + ' </a>';
315 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
316 if (pages - curPage > 0)
317 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
318 + M('Next') + ' >></a>';
325 if (lastClkbl < pages)
328 pagerDiv.innerHTML += '<div style="float: clear">'
329 + prev + predots + middle + postdots + next + '</div><hr/>';
332 function showPage (pageNum)
335 my_paz.showPage( curPage - 1 );
338 // simple paging functions
340 function pagerNext() {
341 if ( totalRec - recPerPage*curPage > 0) {
347 function pagerPrev() {
348 if ( my_paz.showPrev() != false )
352 // swithing view between targets and records
354 function switchView(view) {
356 var targets = document.getElementById('mkwsTargets');
357 var records = document.getElementById('mkwsRecords');
361 targets.style.display = "block";
362 records.style.display = "none";
365 targets.style.display = "none";
366 records.style.display = "block";
369 alert('Unknown view.');
373 // detailed record drawing
374 function showDetails (prefixRecId) {
375 var recId = prefixRecId.replace('rec_', '');
376 var oldRecId = curDetRecId;
379 // remove current detailed view if any
380 var detRecordDiv = document.getElementById('det_'+oldRecId);
383 detRecordDiv.parentNode.removeChild(detRecordDiv);
385 // if the same clicked, just hide
386 if (recId == oldRecId) {
388 curDetRecData = null;
391 // request the record
392 my_paz.record(recId);
395 function replaceHtml(el, html) {
396 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
397 /*@cc_on // Pure innerHTML is slightly faster in IE
398 oldEl.innerHTML = html;
401 var newEl = oldEl.cloneNode(false);
402 newEl.innerHTML = html;
403 oldEl.parentNode.replaceChild(newEl, oldEl);
404 /* Since we just removed the old element from the DOM, return a reference
405 to the new element, which can be used to restore variable references. */
409 function renderDetails(data, marker)
411 var details = '<div class="details" id="det_'+data.recid+'"><table>';
412 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
413 if (data["md-title"] != undefined) {
414 details += '<tr><td><b>' + M('Title') + '</b></td><td><b>:</b> '+data["md-title"];
415 if (data["md-title-remainder"] !== undefined) {
416 details += ' : <span>' + data["md-title-remainder"] + ' </span>';
418 if (data["md-title-responsibility"] !== undefined) {
419 details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
421 details += '</td></tr>';
423 if (data["md-date"] != undefined)
424 details += '<tr><td><b>' + M('Date') + '</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
425 if (data["md-author"] != undefined)
426 details += '<tr><td><b>' + M('Author') + '</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
427 if (data["md-electronic-url"] != undefined)
428 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>';
429 if (data["location"][0]["md-subject"] != undefined)
430 details += '<tr><td><b>' + M('Subject') + '</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
431 if (data["location"][0]["@name"] != undefined)
432 details += '<tr><td><b>' + M('Location') + '</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
433 details += '</table></div>';
438 * All the HTML stuff to render the search forms and
441 function mkws_html_all(data) {
445 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
446 perpage: [10, 20, 30, 50],
447 sort_default: "relevance",
450 switch_menu: true, /* show/hide Records|Targets menu */
451 lang_menu: true, /* show/hide language menu */
452 debug: 0, /* debug level for development: 0..2 */
457 /* set global debug flag early */
458 if (data.debug !== 'undefined') {
459 mkws_debug = data.debug;
460 } else if (config.debug !== 'undefined') {
461 mkws_debug = config.debug;
464 /* override standard config values by function parameters */
465 for (var k in data) {
467 debug("Set config: " + k + ' => ' + data[k]);
469 if (mkws_config.query_width < 5 || mkws_config.query_width > 150) {
470 debug("Reset query width: " + mkws_config.query_width);
471 mkws_config.query_width = 50;
474 mkws_set_lang(mkws_config);
475 if (mkws_config.lang_menu)
476 mkws_html_lang(mkws_config);
478 // For some reason, doing this programmatically results in
479 // document.search.query being undefined, hence the raw HTML.
480 debug("HTML search form");
481 $("#mkwsSearch").html('\
482 <form id="searchForm" name="search" action="" >\
483 <input id="query" type="text" size="' + mkws_config.query_width + '" />\
484 <input id="button" type="submit" value="' + M('Search') + '" />\
487 debug("HTML records");
488 $("#mkwsRecords").html('\
489 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
491 <td width="250" valign="top">\
492 <div id="termlist"></div>\
496 <form name="select" id="select" action="" >\
497 ' + M('Sort by') + mkws_html_sort(config) + '\
498 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
499 ' + M('per page') + '.\
502 <div id="pager"></div>\
503 <div id="navi"></div>\
504 <div id="results"></div>\
509 mkws_html_switch(config);
510 if (mkws_config.use_service_proxy)
511 mkws_service_proxy_auth(config.service_proxy_auth);
516 function mkws_set_lang(mkws_config) {
517 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
518 if (!lang || !mkws_locale_lang[lang]) {
519 mkws_config.lang = ""
521 mkws_config.lang = lang;
524 debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
525 return mkws_config.lang;
528 function mkws_html_switch(config) {
529 debug("HTML switch");
531 $("#mkwsSwitch").html($("<a/>", {
533 onclick: "switchView(\'records\')",
536 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
537 $("#mkwsSwitch").append($("<a/>", {
539 onclick: "switchView(\'targets\')",
543 debug("HTML targets");
544 $("#mkwsTargets").html('\
546 No information available yet.\
548 $("#mkwsTargets").css("display", "none");
550 if (!config.switch_menu) {
551 debug("disable switch menu");
552 $("#mkwsSwitch").css("display", "none");
556 function mkws_html_sort(config) {
558 var sort_html = '<select name="sort" id="sort">';
560 for(var i = 0; i < config.sort.length; i++) {
561 var key = config.sort[i][0];
562 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
564 sort_html += '<option value="' + key + '"';
565 if (key == config.sort_default) {
566 sort_html += ' selected="selected"';
568 sort_html += '>' + val + '</option>';
570 sort_html += '</select>';
575 function mkws_html_perpage(config) {
576 debug("HTML perpage");
577 var perpage_html = '<select name="perpage" id="perpage">';
579 for(var i = 0; i < config.perpage.length; i++) {
580 var key = config.perpage[i];
582 perpage_html += '<option value="' + key + '"';
583 if (key == config.perpage_default) {
584 perpage_html += ' selected="selected"';
586 perpage_html += '>' + key + '</option>';
588 perpage_html += '</select>';
594 * Run service-proxy authentication in background (after page load).
595 * The username/password is configured in the apache config file
598 function mkws_service_proxy_auth(auth_url) {
600 auth_url = "/service-proxy-auth";
602 debug("Run service proxy auth URL: " + auth_url);
604 var jqxhr = jQuery.get(auth_url)
606 alert("service proxy authentication failed, give up!");
608 .success(function(data) {
609 if (!jQuery.isXMLDoc(data)) {
610 alert("service proxy auth response document is not valid XML document, give up!");
613 var status = $(data).find("status");
614 if (status.text() != "OK") {
615 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
621 /* create locale language menu */
622 function mkws_html_lang(mkws_config) {
623 var lang_default = "en";
624 var lang = mkws_config.lang || lang_default;
625 var list = [lang_default];
627 for (var k in mkws_locale_lang) {
630 debug("Language menu for: " + list.join(", "));
633 for(var i = 0; i < list.length; i++) {
642 data += ' <a href="/?lang=' + l + '">' + l + '</a> '
646 $("#mkwsLang").html(data);
651 var lang = mkws_config.lang;
653 if (!lang || !mkws_locale_lang[lang])
656 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
659 /* implement jQuery.parseQuerystring() for parsing URL parameters */
661 parseQuerystring: function() {
663 var qs = window.location.search.replace('?', '');
664 var pairs = qs.split('&');
665 $.each(pairs, function(i, v){
666 var pair = v.split('=');
667 nvpair[pair[0]] = pair[1];
672 function debug(string) {
676 var console; // IE8 quirks
677 if (!console) { /* ARGH!!! */
681 // you need to disable use strict at the top of the file!!!
682 if (mkws_debug >= 3) {
683 console.log(arguments.callee.caller);
684 } else if (mkws_debug >= 2) {
685 console.log(">>> called from function " + arguments.callee.caller.name + ' <<<');
691 $(document).ready(function() { mkws_html_all(mkws_config) });