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;
15 var mkws_locale_lang = {
18 "Subjects": "Schlagwörter",
19 "Sources": "Daten und Quellen",
20 "TERMLISTS": "Termlisten",
22 "Prev": "Zurück",
24 "Sort by": "Sortieren nach",
25 "and show": "und zeige",
26 "per page": "pro Seite",
27 "Displaying": "Zeige",
36 "Authors": "Forfattere",
39 "TERMLISTS": "TERMLISTS",
40 "Next": "Næste",
42 "Search": "Søg",
43 "Sort by": "Sorter efter",
45 "per page": "per side",
46 "Displaying": "Viser",
55 // create a parameters array and pass it to the pz2's constructor
56 // then register the form submit event with the pz2.search function
57 // autoInit is set to true on default
58 var my_paz = new pz2( { "onshow": my_onshow,
59 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
60 "pazpar2path": pazpar2path,
64 "termlist": "xtargets,subject,author",
65 "onbytarget": my_onbytarget,
66 "usesessions" : usesessions,
67 "showResponseType": '', // or "json" (for debugging?)
68 "onrecord": my_onrecord } );
74 var curDetRecData = null;
75 var curSort = 'relevance';
77 var submitted = false;
83 // pz2.js event handlers:
85 function my_oninit() {
90 function my_onshow(data) {
91 totalRec = data.merged;
93 var pager = document.getElementById("pager");
95 pager.innerHTML +='<hr/><div style="float: right">' + M('Displaying') + ': '
96 + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) +
97 ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': '
98 + data.total + ')</div>';
101 var results = document.getElementById("results");
104 for (var i = 0; i < data.hits.length; i++) {
105 var hit = data.hits[i];
106 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
107 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
108 +'<a href="#" id="rec_'+hit.recid
109 +'" onclick="showDetails(this.id);return false;"><b>'
110 + hit["md-title"] +' </b></a>');
111 if (hit["md-title-remainder"] !== undefined) {
112 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
114 if (hit["md-title-responsibility"] !== undefined) {
115 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
117 if (hit.recid == curDetRecId) {
118 html.push(renderDetails(curDetRecData));
122 replaceHtml(results, html.join(''));
125 function my_onstat(data) {
126 var stat = document.getElementById("mkwsStat");
130 stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
132 + '/' + data.clients + ' -- </span>'
133 + '<span>Retrieved records: ' + data.records
134 + '/' + data.hits + ' :.</span>';
137 function my_onterm(data) {
139 termlists.push('<hr/><b>' + M('TERMLISTS') + ':</b><hr/><div class="termtitle">' + M('Sources') + '</div>');
140 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
141 termlists.push('<a href="#" target_id='+data.xtargets[i].id
142 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
143 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
146 termlists.push('<hr/><div class="termtitle">' + M('Subjects') + '</div>');
147 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
148 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
149 + data.subject[i].freq + ')</span><br/>');
152 termlists.push('<hr/><div class="termtitle">' + M('Authors') + '</div>');
153 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
154 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
155 + data.author[i].name
157 + data.author[i].freq
160 var termlist = document.getElementById("termlist");
161 replaceHtml(termlist, termlists.join(''));
164 function my_onrecord(data) {
165 // FIXME: record is async!!
166 clearTimeout(my_paz.recordTimer);
167 // in case on_show was faster to redraw element
168 var detRecordDiv = document.getElementById('det_'+data.recid);
169 if (detRecordDiv) return;
170 curDetRecData = data;
171 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
172 var html = renderDetails(curDetRecData);
173 recordDiv.innerHTML += html;
176 function my_onbytarget(data) {
177 var targetDiv = document.getElementById("bytarget");
178 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
179 +'<td>Records</td><td>State</td></tr></thead><tbody>';
181 for (var i = 0; i < data.length; i++ ) {
182 table += "<tr><td>" + data[i].id +
183 "</td><td>" + data[i].hits +
184 "</td><td>" + data[i].diagnostic +
185 "</td><td>" + data[i].records +
186 "</td><td>" + data[i].state + "</td></tr>";
189 table += '</tbody></table>';
190 targetDiv.innerHTML = table;
193 ////////////////////////////////////////////////////////////////////////////////
194 ////////////////////////////////////////////////////////////////////////////////
196 // wait until the DOM is ready
199 document.search.onsubmit = onFormSubmitEventHandler;
200 document.search.query.value = '';
201 document.select.sort.onchange = onSelectDdChange;
202 document.select.perpage.onchange = onSelectDdChange;
205 // when search button pressed
206 function onFormSubmitEventHandler()
215 function onSelectDdChange()
217 if (!submitted) return false;
220 my_paz.show(0, recPerPage, curSort);
230 function triggerSearch ()
232 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
235 function loadSelect ()
237 curSort = document.select.sort.value;
238 recPerPage = document.select.perpage.value;
241 // limit the query after clicking the facet
242 function limitQuery (field, value)
244 document.search.query.value += ' and ' + field + '="' + value + '"';
245 onFormSubmitEventHandler();
248 // limit by target functions
249 function limitTarget (id, name)
251 var navi = document.getElementById('navi');
253 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
255 navi.innerHTML += '<hr/>';
256 curFilter = 'pz:id=' + id;
263 function delimitTarget ()
265 var navi = document.getElementById('navi');
274 function drawPager (pagerDiv)
276 //client indexes pages from 1 but pz2 from 0
278 var pages = Math.ceil(totalRec / recPerPage);
280 var firstClkbl = ( curPage - onsides > 0 )
284 var lastClkbl = firstClkbl + 2*onsides < pages
285 ? firstClkbl + 2*onsides
288 var prev = '<span id="prev"><< ' + M('Prev') + '</span><b> | </b>';
290 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
291 +'<< ' + M('Prev') + '</a><b> | </b>';
294 for(var i = firstClkbl; i <= lastClkbl; i++) {
297 numLabel = '<b>' + i + '</b>';
299 middle += '<a href="#" onclick="showPage(' + i + ')"> '
300 + numLabel + ' </a>';
303 var next = '<b> | </b><span id="next">' + M('Next') + ' >></span>';
304 if (pages - curPage > 0)
305 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
306 + M('Next') + ' >></a>';
313 if (lastClkbl < pages)
316 pagerDiv.innerHTML += '<div style="float: clear">'
317 + prev + predots + middle + postdots + next + '</div><hr/>';
320 function showPage (pageNum)
323 my_paz.showPage( curPage - 1 );
326 // simple paging functions
328 function pagerNext() {
329 if ( totalRec - recPerPage*curPage > 0) {
335 function pagerPrev() {
336 if ( my_paz.showPrev() != false )
340 // swithing view between targets and records
342 function switchView(view) {
344 var targets = document.getElementById('mkwsTargets');
345 var records = document.getElementById('mkwsRecords');
349 targets.style.display = "block";
350 records.style.display = "none";
353 targets.style.display = "none";
354 records.style.display = "block";
357 alert('Unknown view.');
361 // detailed record drawing
362 function showDetails (prefixRecId) {
363 var recId = prefixRecId.replace('rec_', '');
364 var oldRecId = curDetRecId;
367 // remove current detailed view if any
368 var detRecordDiv = document.getElementById('det_'+oldRecId);
371 detRecordDiv.parentNode.removeChild(detRecordDiv);
373 // if the same clicked, just hide
374 if (recId == oldRecId) {
376 curDetRecData = null;
379 // request the record
380 my_paz.record(recId);
383 function replaceHtml(el, html) {
384 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
385 /*@cc_on // Pure innerHTML is slightly faster in IE
386 oldEl.innerHTML = html;
389 var newEl = oldEl.cloneNode(false);
390 newEl.innerHTML = html;
391 oldEl.parentNode.replaceChild(newEl, oldEl);
392 /* Since we just removed the old element from the DOM, return a reference
393 to the new element, which can be used to restore variable references. */
397 function renderDetails(data, marker)
399 var details = '<div class="details" id="det_'+data.recid+'"><table>';
400 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
401 if (data["md-title"] != undefined) {
402 details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
403 if (data["md-title-remainder"] !== undefined) {
404 details += ' : <span>' + data["md-title-remainder"] + ' </span>';
406 if (data["md-title-responsibility"] !== undefined) {
407 details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
409 details += '</td></tr>';
411 if (data["md-date"] != undefined)
412 details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
413 if (data["md-author"] != undefined)
414 details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
415 if (data["md-electronic-url"] != undefined)
416 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>';
417 if (data["location"][0]["md-subject"] != undefined)
418 details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
419 if (data["location"][0]["@name"] != undefined)
420 details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
421 details += '</table></div>';
426 * All the HTML stuff to render the search forms and
429 function mkws_html_all(data) {
433 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
434 perpage: [10, 20, 30, 50],
435 sort_default: "relevance",
438 switch: true, /* show/hide Records|Targets menu */
443 /* override standard config values by function parameters */
444 for (var k in data) {
448 mkws_set_lang(mkws_config);
450 // For some reason, doing this programmatically results in
451 // document.search.query being undefined, hence the raw HTML.
452 $("#mkwsSearch").html('\
453 <form id="searchForm" name="search">\
454 <input id="query" type="text" size="50" />\
455 <input id="button" type="submit" value="' + M('Search') + '" />\
458 $("#mkwsRecords").html('\
459 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
461 <td width="250" valign="top">\
462 <div id="termlist"></div>\
466 <form name="select" id="select">\
467 ' + M('Sort by') + mkws_html_sort(config) + '\
468 ' + M('and show') + ' ' + mkws_html_perpage(config) + '\
469 ' + M('per page') + '.\
472 <div id="pager"></div>\
473 <div id="navi"></div>\
474 <div id="results"></div>\
480 mkws_html_switch(config);
481 if (mkws_config.use_service_proxy)
482 mkws_service_proxy_auth(config.service_proxy_auth);
487 function mkws_set_lang(mkws_config) {
488 var lang = jQuery.parseQuerystring().lang || mkws_config.lang || "";
489 if (!lang || !mkws_locale_lang[lang]) {
490 mkws_config.lang = ""
492 mkws_config.lang = lang;
495 return mkws_config.lang;
498 function mkws_html_switch(config) {
499 $("#mkwsSwitch").html($("<a/>", {
501 onclick: "switchView(\'records\')",
504 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
505 $("#mkwsSwitch").append($("<a/>", {
507 onclick: "switchView(\'targets\')",
511 $("#mkwsTargets").html('\
513 No information available yet.\
515 $("#mkwsTargets").css("display", "none");
517 if (!config.switch) {
518 $("#mkwsSwitch").css("display", "none");
522 function mkws_html_sort(config) {
523 var sort_html = '<select name="sort" id="sort">';
525 for(var i = 0; i < config.sort.length; i++) {
526 var key = config.sort[i][0];
527 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
529 sort_html += '<option value="' + key + '"';
530 if (key == config.sort_default) {
531 sort_html += ' selected="selected"';
533 sort_html += '>' + val + '</option>';
535 sort_html += '</select>';
540 function mkws_html_perpage(config) {
541 var perpage_html = '<select name="perpage" id="perpage">';
543 for(var i = 0; i < config.perpage.length; i++) {
544 var key = config.perpage[i];
546 perpage_html += '<option value="' + key + '"';
547 if (key == config.perpage_default) {
548 perpage_html += ' selected="selected"';
550 perpage_html += '>' + key + '</option>';
552 perpage_html += '</select>';
558 * Run service-proxy authentication in background (after page load).
559 * The username/password is configured in the apache config file
562 function mkws_service_proxy_auth(auth_url) {
564 auth_url = "/service-proxy-auth";
566 var jqxhr = jQuery.get(auth_url)
568 alert("service proxy authentication failed, give up!");
570 .success(function(data) {
571 if (!jQuery.isXMLDoc(data)) {
572 alert("service proxy auth response document is not valid XML document, give up!");
575 var status = $(data).find("status");
576 if (status.text() != "OK") {
577 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
585 var lang = jQuery.parseQuerystring().lang || mkws_config.lang;
587 if (!lang || !mkws_locale_lang[lang])
590 return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word;
593 /* implement jQuery.parseQuerystring() for parsing URL parameters */
595 parseQuerystring: function() {
597 var qs = window.location.search.replace('?', '');
598 var pairs = qs.split('&');
599 $.each(pairs, function(i, v){
600 var pair = v.split('=');
601 nvpair[pair[0]] = pair[1];
607 $(document).ready(function() { mkws_html_all(mkws_config) });