2 ** $Id: pz2.js,v 1.12 2007-05-02 19:32:13 jakub Exp $
3 ** pz2.js - pazpar2's javascript client library.
6 //since explorer is flawed
8 window.Node = new Object();
10 Node.ATTRIBUTE_NODE = 2;
12 Node.CDATA_SECTION_NODE = 4;
13 Node.ENTITY_REFERENCE_NODE = 5;
15 Node.PROCESSING_INSTRUCTION_NODE = 7;
16 Node.COMMENT_NODE = 8;
17 Node.DOCUMENT_NODE = 9;
18 Node.DOCUMENT_TYPE_NODE = 10;
19 Node.DOCUMENT_FRAGMENT_NODE = 11;
20 Node.NOTATION_NODE = 12;
23 if(typeof window.jQuery == "undefined"){
24 throw new Error("pz2.js requires jQuery library");
26 // prevent execution of more than once
27 if(typeof window.pz2 == "undefined") {
28 window.undefined = window.undefined;
30 var pz2 = function(paramArray) {
34 // at least one callback required
36 throw new Error("An array with parameters has to be suplied when instantiating a class");
38 //supported pazpar2's protocol version
39 __myself.suppProtoVer = '1';
40 __myself.errorHandler = paramArray.errorhandler || null;
43 __myself.statCallback = paramArray.onstat || null;
44 __myself.showCallback = paramArray.onshow || null;
45 __myself.termlistCallback = paramArray.onterm || null;
46 __myself.recordCallback = paramArray.onrecord || null;
47 __myself.bytargetCallback = paramArray.onbytarget || null;
50 __myself.termKeys = paramArray.termlist || "subject";
52 // some configurational stuff
53 __myself.pz2String = "search.pz2";
54 __myself.keepAlive = 50000;
56 __myself.sessionID = null;
57 __myself.initStatusOK = false;
58 __myself.pingStatusOK = false;
59 __myself.searchStatusOK = false;
61 if ( paramArray.keepAlive < __myself.keepAlive )
62 __myself.keepAlive = paramArray.keepAlive;
65 __myself.currentSort = "relevance";
67 __myself.currentStart = 0;
68 __myself.currentNum = 20;
70 // last full record retrieved
71 __myself.currRecID = null;
73 __myself.currQuery = null;
76 __myself.statTime = paramArray.stattime || 2000;
77 __myself.statTimer = null;
78 __myself.termTime = paramArray.termtime || 1000;
79 __myself.termTimer = null;
80 __myself.showTime = paramArray.showtime || 1000;
81 __myself.showTimer = null;
82 __myself.showFastCount = 4;
83 __myself.bytargetTime = paramArray.bytargettime || 1000;
84 __myself.bytargetTimer = null;
87 __myself.dumpFactor = 500;
88 __myself.showCounter = 0;
89 __myself.termCounter = 0;
91 // active clients, updated by stat and show
92 // might be an issue since bytarget will poll accordingly
93 __myself.activeClients = 1;
96 $(document).ajaxError(
97 function (ajaxError, xhr, reqSettings, prevException)
99 if ( xhr.responseXML && xhr.responseXML.getElementsByTagName("error").length )
101 var errMsg = xhr.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
102 var errCode = xhr.responseXML.getElementsByTagName("error")[0].getAttribute("code");
104 var err = new Error(errMsg);
107 if (__myself.errorHandler) {
108 __myself.errorHandler(err);
114 // ensure the errors are propagated
115 else if (prevException != undefined ) {
119 throw new Error("XMLHttpRequest error. STATUS: " + xhr.status + " STATUS TEXT: " + xhr.statusText);
123 // auto init session?
124 if (paramArray.autoInit !== false)
128 init: function ( sessionId )
130 if ( sessionId != undefined ) {
131 __myself.initStatusOK = true;
132 __myself.sessionID = sessionId;
135 $.get( __myself.pz2String,
136 { "command": "init" },
138 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
139 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
140 throw new Error("Server's protocol not supported by the client");
141 __myself.initStatusOK = true;
142 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
143 setTimeout("__myself.ping()", __myself.keepAlive);
146 // if it gets here the http return code was 200 (pz2 errors are 417)
147 // but the response was invalid, it should never occur
148 setTimeout("__myself.init()", 1000);
153 // no need to ping explicitly
156 if( !__myself.initStatusOK )
158 // session is not initialized code here
160 $.get( __myself.pz2String,
161 { "command": "ping", "session": __myself.sessionID },
163 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
164 __myself.pingStatusOK = true;
165 setTimeout("__myself.ping()", __myself.keepAlive);
168 // if it gets here the http return code was 200 (pz2 errors are 417)
169 // but the response was invalid, it should never occur
170 setTimeout("__myself.ping()", 1000);
174 search: function (query, num, sort, filter)
176 clearTimeout(__myself.statTimer);
177 clearTimeout(__myself.showTimer);
178 clearTimeout(__myself.termTimer);
179 clearTimeout(__myself.bytargetTimer);
181 __myself.showCounter = 0;
182 __myself.termCounter = 0;
184 if( !__myself.initStatusOK )
187 if( query !== undefined )
188 __myself.currQuery = query;
190 throw new Error("You need to supply query to the search command");
192 if( filter !== undefined )
193 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
195 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
197 $.get( __myself.pz2String,
200 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
201 __myself.searchStatusOK = true;
203 __myself.show(0, num, sort);
204 if ( __myself.statCallback )
205 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
206 if ( __myself.termlistCallback )
207 //__myself.termlist();
208 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
209 if ( __myself.bytargetCallback )
210 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
213 // if it gets here the http return code was 200 (pz2 errors are 417)
214 // but the response was invalid, it should never occur
215 setTimeout("__myself.search(__myself.currQuery)", 1000);
221 if( !__myself.searchStatusOK )
223 // if called explicitly takes precedence
224 clearTimeout(__myself.statTimer);
226 $.get( __myself.pz2String,
227 { "command": "stat", "session": __myself.sessionID },
229 if ( data.getElementsByTagName("stat") ) {
230 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
231 __myself.activeClients = activeClients;
233 "activeclients": activeClients,
234 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
235 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
236 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
237 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
238 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
239 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
240 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
241 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
242 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
244 __myself.statCallback(stat);
245 if (activeClients > 0)
246 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
249 // if it gets here the http return code was 200 (pz2 errors are 417)
250 // but the response was invalid, it should never occur
251 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
255 show: function(start, num, sort)
257 if( !__myself.searchStatusOK )
259 // if called explicitly takes precedence
260 clearTimeout(__myself.showTimer);
262 if( sort !== undefined )
263 __myself.currentSort = sort;
264 if( start !== undefined )
265 __myself.currentStart = Number( start );
266 if( num !== undefined )
267 __myself.currentNum = Number( num );
269 $.get( __myself.pz2String,
270 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
271 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
273 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
274 // first parse the status data send along with records
275 // this is strictly bound to the format
276 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
278 "activeclients": activeClients,
279 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
280 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
281 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
282 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
285 // parse all the first-level nodes for all <hit> tags
286 var hits = data.getElementsByTagName("hit");
287 var hit = new Array();
288 for (i = 0; i < hits.length; i++) {
289 show.hits[i] = new Array();
290 show.hits[i]['location'] = new Array();
291 for ( j = 0; j < hits[i].childNodes.length; j++) {
293 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
294 if (hits[i].childNodes[j].nodeName == 'location') {
295 var locNode = hits[i].childNodes[j];
296 var id = locNode.getAttribute('id');
297 show.hits[i]['location'][id] = {
298 "id": locNode.getAttribute("id"),
299 "name": locNode.getAttribute("name")
303 var nodeName = hits[i].childNodes[j].nodeName;
304 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
305 show.hits[i][nodeName] = nodeText;
310 __myself.showCallback(show);
311 __myself.showCounter++;
312 var delay = __myself.showTime;
313 if (__myself.showCounter > __myself.showFastCount)
315 if (activeClients > 0)
316 __myself.showTimer = setTimeout("__myself.show()", delay);
319 // if it gets here the http return code was 200 (pz2 errors are 417)
320 // but the response was invalid, it should never occur
321 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
327 if( !__myself.searchStatusOK )
330 if( id !== undefined )
331 __myself.currRecID = id;
333 $.get( __myself.pz2String,
334 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
337 var record = new Array();
338 if ( recordNode = data.getElementsByTagName("record")[0] ) {
339 for ( i = 0; i < recordNode.childNodes.length; i++) {
340 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
341 var nodeName = recordNode.childNodes[i].nodeName;
342 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
343 record[nodeName] = nodeText;
346 // the location is hard coded
347 var locationNodes = recordNode.getElementsByTagName("location");
348 record["location"] = new Array();
349 for ( i = 0; i < locationNodes.length; i++ ) {
350 record["location"][i] = {
351 "id": locationNodes[i].getAttribute("id"),
352 "name": locationNodes[i].getAttribute("name")
354 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
355 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
356 var nodeName = locationNodes[i].childNodes[j].nodeName;
358 if (locationNodes[i].childNodes[j].firstChild)
359 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
362 record["location"][i][nodeName] = nodeText;
366 __myself.recordCallback(record);
369 // if it gets here the http return code was 200 (pz2 errors are 417)
370 // but the response was invalid, it should never occur
371 setTimeout("__myself.record(__myself.currRecID)", 1000);
377 if( !__myself.searchStatusOK )
379 // if called explicitly takes precedence
380 clearTimeout(__myself.termTimer);
382 $.get( __myself.pz2String,
383 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
385 if ( data.getElementsByTagName("termlist") ) {
386 var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
387 var termLists = data.getElementsByTagName("list");
389 for (i = 0; i < termLists.length; i++) {
390 var listName = termLists[i].getAttribute('name');
391 termList[listName] = new Array();
392 var terms = termLists[i].getElementsByTagName('term');
393 //for each term in the list
394 for (j = 0; j < terms.length; j++) {
396 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
397 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
400 var termIdNode = terms[j].getElementsByTagName("id");
401 if(terms[j].getElementsByTagName("id").length)
402 term["id"] = termIdNode[0].childNodes[0].nodeValue;
404 termList[listName][j] = term;
408 __myself.termlistCallback(termList);
409 __myself.termCounter++;
410 if (termList["activeclients"] > 0)
411 __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor));
414 // if it gets here the http return code was 200 (pz2 errors are 417)
415 // but the response was invalid, it should never occur
416 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
423 if( !__myself.searchStatusOK )
425 // if called explicitly takes precedence
426 clearTimeout(__myself.bytargetTimer);
428 $.get( __myself.pz2String,
429 { "command": "bytarget", "session": __myself.sessionID },
431 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
432 var targetNodes = data.getElementsByTagName("target");
433 var bytarget = new Array();
434 for ( i = 0; i < targetNodes.length; i++) {
435 bytarget[i] = new Array();
436 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
437 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
438 var nodeName = targetNodes[i].childNodes[j].nodeName;
439 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
440 bytarget[i][nodeName] = nodeText;
444 __myself.bytargetCallback(bytarget);
445 if ( __myself.activeClients > 0 )
446 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
449 // if it gets here the http return code was 200 (pz2 errors are 417)
450 // but the response was invalid, it should never occur
451 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
455 // just for testing, probably shouldn't be here
456 showNext: function(page)
458 var step = page || 1;
459 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
461 showPrev: function(page)
463 if (__myself.currentStart == 0 )
465 var step = page || 1;
466 var newStart = __myself.currentStart - (step * __myself.currentNum );
467 __myself.show( newStart > 0 ? newStart : 0 );
469 showPage: function(pageNum)
471 //var page = pageNum || 1;
472 __myself.show(pageNum * __myself.currentNum);