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 // create a parameters array and pass it to the pz2's constructor
16 // then register the form submit event with the pz2.search function
17 // autoInit is set to true on default
18 var my_paz = new pz2( { "onshow": my_onshow,
19 "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way
20 "pazpar2path": pazpar2path,
24 "termlist": "xtargets,subject,author",
25 "onbytarget": my_onbytarget,
26 "usesessions" : usesessions,
27 "showResponseType": '', // or "json" (for debugging?)
28 "onrecord": my_onrecord } );
34 var curDetRecData = null;
35 var curSort = 'relevance';
37 var submitted = false;
43 // pz2.js event handlers:
45 function my_oninit() {
50 function my_onshow(data) {
51 totalRec = data.merged;
53 var pager = document.getElementById("pager");
55 pager.innerHTML +='<hr/><div style="float: right">Displaying: '
56 + (data.start + 1) + ' to ' + (data.start + data.num) +
57 ' of ' + data.merged + ' (found: '
58 + data.total + ')</div>';
61 var results = document.getElementById("results");
64 for (var i = 0; i < data.hits.length; i++) {
65 var hit = data.hits[i];
66 html.push('<div class="record" id="recdiv_'+hit.recid+'" >'
67 +'<span>'+ (i + 1 + recPerPage * (curPage - 1)) +'. </span>'
68 +'<a href="#" id="rec_'+hit.recid
69 +'" onclick="showDetails(this.id);return false;"><b>'
70 + hit["md-title"] +' </b></a>');
71 if (hit["md-title-remainder"] !== undefined) {
72 html.push('<span>' + hit["md-title-remainder"] + ' </span>');
74 if (hit["md-title-responsibility"] !== undefined) {
75 html.push('<span><i>'+hit["md-title-responsibility"]+'</i></span>');
77 if (hit.recid == curDetRecId) {
78 html.push(renderDetails(curDetRecData));
82 replaceHtml(results, html.join(''));
85 function my_onstat(data) {
86 var stat = document.getElementById("mkwsStat");
90 stat.innerHTML = '<b>STATUS INFO</b> -- Active clients: '
92 + '/' + data.clients + ' -- </span>'
93 + '<span>Retrieved records: ' + data.records
94 + '/' + data.hits + ' :.</span>';
97 function my_onterm(data) {
99 termlists.push('<hr/><b>TERMLISTS:</b><hr/><div class="termtitle">Sources</div>');
100 for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) {
101 termlists.push('<a href="#" target_id='+data.xtargets[i].id
102 + ' onclick="limitTarget(this.getAttribute(\'target_id\'), this.firstChild.nodeValue);return false;">' + data.xtargets[i].name
103 + ' </a><span> (' + data.xtargets[i].freq + ')</span><br/>');
106 termlists.push('<hr/><div class="termtitle">Subjects</div>');
107 for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) {
108 termlists.push('<a href="#" onclick="limitQuery(\'su\', this.firstChild.nodeValue);return false;">' + data.subject[i].name + '</a><span> ('
109 + data.subject[i].freq + ')</span><br/>');
112 termlists.push('<hr/><div class="termtitle">Authors</div>');
113 for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) {
114 termlists.push('<a href="#" onclick="limitQuery(\'au\', this.firstChild.nodeValue);return false;">'
115 + data.author[i].name
117 + data.author[i].freq
120 var termlist = document.getElementById("termlist");
121 replaceHtml(termlist, termlists.join(''));
124 function my_onrecord(data) {
125 // FIXME: record is async!!
126 clearTimeout(my_paz.recordTimer);
127 // in case on_show was faster to redraw element
128 var detRecordDiv = document.getElementById('det_'+data.recid);
129 if (detRecordDiv) return;
130 curDetRecData = data;
131 var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid);
132 var html = renderDetails(curDetRecData);
133 recordDiv.innerHTML += html;
136 function my_onbytarget(data) {
137 var targetDiv = document.getElementById("bytarget");
138 var table ='<table><thead><tr><td>Target ID</td><td>Hits</td><td>Diags</td>'
139 +'<td>Records</td><td>State</td></tr></thead><tbody>';
141 for (var i = 0; i < data.length; i++ ) {
142 table += "<tr><td>" + data[i].id +
143 "</td><td>" + data[i].hits +
144 "</td><td>" + data[i].diagnostic +
145 "</td><td>" + data[i].records +
146 "</td><td>" + data[i].state + "</td></tr>";
149 table += '</tbody></table>';
150 targetDiv.innerHTML = table;
153 ////////////////////////////////////////////////////////////////////////////////
154 ////////////////////////////////////////////////////////////////////////////////
156 // wait until the DOM is ready
159 document.search.onsubmit = onFormSubmitEventHandler;
160 document.search.query.value = '';
161 document.select.sort.onchange = onSelectDdChange;
162 document.select.perpage.onchange = onSelectDdChange;
165 // when search button pressed
166 function onFormSubmitEventHandler()
175 function onSelectDdChange()
177 if (!submitted) return false;
180 my_paz.show(0, recPerPage, curSort);
190 function triggerSearch ()
192 my_paz.search(document.search.query.value, recPerPage, curSort, curFilter);
195 function loadSelect ()
197 curSort = document.select.sort.value;
198 recPerPage = document.select.perpage.value;
201 // limit the query after clicking the facet
202 function limitQuery (field, value)
204 document.search.query.value += ' and ' + field + '="' + value + '"';
205 onFormSubmitEventHandler();
208 // limit by target functions
209 function limitTarget (id, name)
211 var navi = document.getElementById('navi');
213 'Source: <a class="crossout" href="#" onclick="delimitTarget();return false;">'
215 navi.innerHTML += '<hr/>';
216 curFilter = 'pz:id=' + id;
223 function delimitTarget ()
225 var navi = document.getElementById('navi');
234 function drawPager (pagerDiv)
236 //client indexes pages from 1 but pz2 from 0
238 var pages = Math.ceil(totalRec / recPerPage);
240 var firstClkbl = ( curPage - onsides > 0 )
244 var lastClkbl = firstClkbl + 2*onsides < pages
245 ? firstClkbl + 2*onsides
248 var prev = '<span id="prev"><< Prev</span><b> | </b>';
250 prev = '<a href="#" id="prev" onclick="pagerPrev();">'
251 +'<< Prev</a><b> | </b>';
254 for(var i = firstClkbl; i <= lastClkbl; i++) {
257 numLabel = '<b>' + i + '</b>';
259 middle += '<a href="#" onclick="showPage(' + i + ')"> '
260 + numLabel + ' </a>';
263 var next = '<b> | </b><span id="next">Next >></span>';
264 if (pages - curPage > 0)
265 next = '<b> | </b><a href="#" id="next" onclick="pagerNext()">'
266 +'Next >></a>';
273 if (lastClkbl < pages)
276 pagerDiv.innerHTML += '<div style="float: clear">'
277 + prev + predots + middle + postdots + next + '</div><hr/>';
280 function showPage (pageNum)
283 my_paz.showPage( curPage - 1 );
286 // simple paging functions
288 function pagerNext() {
289 if ( totalRec - recPerPage*curPage > 0) {
295 function pagerPrev() {
296 if ( my_paz.showPrev() != false )
300 // swithing view between targets and records
302 function switchView(view) {
304 var targets = document.getElementById('mkwsTargets');
305 var records = document.getElementById('mkwsRecords');
309 targets.style.display = "block";
310 records.style.display = "none";
313 targets.style.display = "none";
314 records.style.display = "block";
317 alert('Unknown view.');
321 // detailed record drawing
322 function showDetails (prefixRecId) {
323 var recId = prefixRecId.replace('rec_', '');
324 var oldRecId = curDetRecId;
327 // remove current detailed view if any
328 var detRecordDiv = document.getElementById('det_'+oldRecId);
331 detRecordDiv.parentNode.removeChild(detRecordDiv);
333 // if the same clicked, just hide
334 if (recId == oldRecId) {
336 curDetRecData = null;
339 // request the record
340 my_paz.record(recId);
343 function replaceHtml(el, html) {
344 var oldEl = typeof el === "string" ? document.getElementById(el) : el;
345 /*@cc_on // Pure innerHTML is slightly faster in IE
346 oldEl.innerHTML = html;
349 var newEl = oldEl.cloneNode(false);
350 newEl.innerHTML = html;
351 oldEl.parentNode.replaceChild(newEl, oldEl);
352 /* Since we just removed the old element from the DOM, return a reference
353 to the new element, which can be used to restore variable references. */
357 function renderDetails(data, marker)
359 var details = '<div class="details" id="det_'+data.recid+'"><table>';
360 if (marker) details += '<tr><td>'+ marker + '</td></tr>';
361 if (data["md-title"] != undefined) {
362 details += '<tr><td><b>Title</b></td><td><b>:</b> '+data["md-title"];
363 if (data["md-title-remainder"] !== undefined) {
364 details += ' : <span>' + data["md-title-remainder"] + ' </span>';
366 if (data["md-title-responsibility"] !== undefined) {
367 details += ' <span><i>'+ data["md-title-responsibility"] +'</i></span>';
369 details += '</td></tr>';
371 if (data["md-date"] != undefined)
372 details += '<tr><td><b>Date</b></td><td><b>:</b> ' + data["md-date"] + '</td></tr>';
373 if (data["md-author"] != undefined)
374 details += '<tr><td><b>Author</b></td><td><b>:</b> ' + data["md-author"] + '</td></tr>';
375 if (data["md-electronic-url"] != undefined)
376 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>';
377 if (data["location"][0]["md-subject"] != undefined)
378 details += '<tr><td><b>Subject</b></td><td><b>:</b> ' + data["location"][0]["md-subject"] + '</td></tr>';
379 if (data["location"][0]["@name"] != undefined)
380 details += '<tr><td><b>Location</b></td><td><b>:</b> ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '</td></tr>';
381 details += '</table></div>';
386 * All the HTML stuff to render the search forms and
389 function mkws_html_all(data) {
393 sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
394 perpage: [10, 20, 30, 50],
395 sort_default: "relevance",
398 switch: true, /* show/hide Records|Targets menu */
403 /* override standard config values by function parameters */
404 for (var k in data) {
408 // For some reason, doing this programmatically results in
409 // document.search.query being undefined, hence the raw HTML.
410 $("#mkwsSearch").html('\
411 <form id="searchForm" name="search">\
412 <input id="query" type="text" size="50" />\
413 <input id="button" type="submit" value="Search" />\
416 $("#mkwsRecords").html('\
417 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
419 <td width="250" valign="top">\
420 <div id="termlist"></div>\
424 <form name="select" id="select">\
425 Sort by' + mkws_html_sort(config) + '\
426 and show ' + mkws_html_perpage(config) + '\
430 <div id="pager"></div>\
431 <div id="navi"></div>\
432 <div id="results"></div>\
438 mkws_html_switch(config);
439 if (mkws_config.use_service_proxy)
440 mkws_service_proxy_auth(config.service_proxy_auth);
445 function mkws_html_switch(config) {
446 $("#mkwsSwitch").html($("<a/>", {
448 onclick: "switchView(\'records\')",
451 $("#mkwsSwitch").append($("<span/>", { text: " | " }));
452 $("#mkwsSwitch").append($("<a/>", {
454 onclick: "switchView(\'targets\')",
458 $("#mkwsTargets").html('\
460 No information available yet.\
462 $("#mkwsTargets").css("display", "none");
464 if (!config.switch) {
465 $("#mkwsSwitch").css("display", "none");
469 function mkws_html_sort(config) {
470 var sort_html = '<select name="sort" id="sort">';
472 for(var i = 0; i < config.sort.length; i++) {
473 var key = config.sort[i][0];
474 var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
476 sort_html += '<option value="' + key + '"';
477 if (key == config.sort_default) {
478 sort_html += ' selected="selected"';
480 sort_html += '>' + val + '</option>';
482 sort_html += '</select>';
487 function mkws_html_perpage(config) {
488 var perpage_html = '<select name="perpage" id="perpage">';
490 for(var i = 0; i < config.perpage.length; i++) {
491 var key = config.perpage[i];
493 perpage_html += '<option value="' + key + '"';
494 if (key == config.perpage_default) {
495 perpage_html += ' selected="selected"';
497 perpage_html += '>' + key + '</option>';
499 perpage_html += '</select>';
505 * Run service-proxy authentication in background (after page load).
506 * The username/password is configured in the apache config file
509 function mkws_service_proxy_auth(auth_url) {
511 auth_url = "/service-proxy-auth";
513 var jqxhr = jQuery.get(auth_url)
515 alert("service proxy authentication failed, give up!");
517 .success(function(data) {
518 if (!jQuery.isXMLDoc(data)) {
519 alert("service proxy auth response document is not valid XML document, give up!");
522 var status = $(data).find("status");
523 if (status.text() != "OK") {
524 alert("service proxy auth repsonse status: " + status.text() + ", give up!");
531 $(document).ready(function() { mkws_html_all(mkws_config) });