2 ** $Id: pz2.js,v 1.11 2007-04-20 13:56:20 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)
125 __myself.init(__myself.keepAlive);
128 init: function(keepAlive)
130 if ( keepAlive < __myself.keepAlive )
131 __myself.keepAlive = keepAlive;
133 $.get( __myself.pz2String,
134 { "command": "init" },
136 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
137 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
138 throw new Error("Server's protocol not supported by the client");
139 __myself.initStatusOK = true;
140 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
141 setTimeout(__myself.ping, __myself.keepAlive);
144 // if it gets here the http return code was 200 (pz2 errors are 417)
145 // but the response was invalid, it should never occur
146 setTimeout("__myself.init()", 1000);
150 // no need to ping explicitly
153 if( !__myself.initStatusOK )
155 // session is not initialized code here
157 $.get( __myself.pz2String,
158 { "command": "ping", "session": __myself.sessionID },
160 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
161 __myself.pingStatusOK = true;
162 setTimeout("__myself.ping()", __myself.keepAlive);
165 // if it gets here the http return code was 200 (pz2 errors are 417)
166 // but the response was invalid, it should never occur
167 setTimeout("__myself.ping()", 1000);
171 search: function(query, num, sort, filter)
173 clearTimeout(__myself.statTimer);
174 clearTimeout(__myself.showTimer);
175 clearTimeout(__myself.termTimer);
176 clearTimeout(__myself.bytargetTimer);
178 __myself.showCounter = 0;
179 __myself.termCounter = 0;
181 if( !__myself.initStatusOK )
184 if( query !== undefined )
185 __myself.currQuery = query;
187 throw new Error("You need to supply query to the search command");
189 if( filter !== undefined )
190 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
192 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
194 $.get( __myself.pz2String,
197 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
198 __myself.searchStatusOK = true;
200 __myself.show(0, num, sort);
201 if ( __myself.statCallback )
202 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
203 if ( __myself.termlistCallback )
204 //__myself.termlist();
205 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
206 if ( __myself.bytargetCallback )
207 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
210 // if it gets here the http return code was 200 (pz2 errors are 417)
211 // but the response was invalid, it should never occur
212 setTimeout("__myself.search(__myself.currQuery)", 1000);
218 if( !__myself.searchStatusOK )
220 // if called explicitly takes precedence
221 clearTimeout(__myself.statTimer);
223 $.get( __myself.pz2String,
224 { "command": "stat", "session": __myself.sessionID },
226 if ( data.getElementsByTagName("stat") ) {
227 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
228 __myself.activeClients = activeClients;
230 "activeclients": activeClients,
231 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
232 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
233 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
234 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
235 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
236 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
237 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
238 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
239 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
241 __myself.statCallback(stat);
242 if (activeClients > 0)
243 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
246 // if it gets here the http return code was 200 (pz2 errors are 417)
247 // but the response was invalid, it should never occur
248 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
252 show: function(start, num, sort)
254 if( !__myself.searchStatusOK )
256 // if called explicitly takes precedence
257 clearTimeout(__myself.showTimer);
259 if( sort !== undefined )
260 __myself.currentSort = sort;
261 if( start !== undefined )
262 __myself.currentStart = Number( start );
263 if( num !== undefined )
264 __myself.currentNum = Number( num );
266 $.get( __myself.pz2String,
267 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
268 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
270 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
271 // first parse the status data send along with records
272 // this is strictly bound to the format
273 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
275 "activeclients": activeClients,
276 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
277 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
278 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
279 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
282 // parse all the first-level nodes for all <hit> tags
283 var hits = data.getElementsByTagName("hit");
284 var hit = new Array();
285 for (i = 0; i < hits.length; i++) {
286 show.hits[i] = new Array();
287 show.hits[i]['location'] = new Array();
288 for ( j = 0; j < hits[i].childNodes.length; j++) {
290 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
291 if (hits[i].childNodes[j].nodeName == 'location') {
292 var locNode = hits[i].childNodes[j];
293 var id = locNode.getAttribute('id');
294 show.hits[i]['location'][id] = {
295 "id": locNode.getAttribute("id"),
296 "name": locNode.getAttribute("name")
300 var nodeName = hits[i].childNodes[j].nodeName;
301 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
302 show.hits[i][nodeName] = nodeText;
307 __myself.showCallback(show);
308 __myself.showCounter++;
309 var delay = __myself.showTime;
310 if (__myself.showCounter > __myself.showFastCount)
312 if (activeClients > 0)
313 __myself.showTimer = setTimeout("__myself.show()", delay);
316 // if it gets here the http return code was 200 (pz2 errors are 417)
317 // but the response was invalid, it should never occur
318 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
324 if( !__myself.searchStatusOK )
327 if( id !== undefined )
328 __myself.currRecID = id;
330 $.get( __myself.pz2String,
331 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
334 var record = new Array();
335 if ( recordNode = data.getElementsByTagName("record")[0] ) {
336 for ( i = 0; i < recordNode.childNodes.length; i++) {
337 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
338 var nodeName = recordNode.childNodes[i].nodeName;
339 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
340 record[nodeName] = nodeText;
343 // the location is hard coded
344 var locationNodes = recordNode.getElementsByTagName("location");
345 record["location"] = new Array();
346 for ( i = 0; i < locationNodes.length; i++ ) {
347 record["location"][i] = {
348 "id": locationNodes[i].getAttribute("id"),
349 "name": locationNodes[i].getAttribute("name")
351 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
352 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
353 var nodeName = locationNodes[i].childNodes[j].nodeName;
355 if (locationNodes[i].childNodes[j].firstChild)
356 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
359 record["location"][i][nodeName] = nodeText;
363 __myself.recordCallback(record);
366 // if it gets here the http return code was 200 (pz2 errors are 417)
367 // but the response was invalid, it should never occur
368 setTimeout("__myself.record(__myself.currRecID)", 1000);
374 if( !__myself.searchStatusOK )
376 // if called explicitly takes precedence
377 clearTimeout(__myself.termTimer);
379 $.get( __myself.pz2String,
380 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
382 if ( data.getElementsByTagName("termlist") ) {
383 var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
384 var termLists = data.getElementsByTagName("list");
386 for (i = 0; i < termLists.length; i++) {
387 var listName = termLists[i].getAttribute('name');
388 termList[listName] = new Array();
389 var terms = termLists[i].getElementsByTagName('term');
390 //for each term in the list
391 for (j = 0; j < terms.length; j++) {
393 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
394 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
397 var termIdNode = terms[j].getElementsByTagName("id");
398 if(terms[j].getElementsByTagName("id").length)
399 term["id"] = termIdNode[0].childNodes[0].nodeValue;
401 termList[listName][j] = term;
405 __myself.termlistCallback(termList);
406 __myself.termCounter++;
407 if (termList["activeclients"] > 0)
408 __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor));
411 // if it gets here the http return code was 200 (pz2 errors are 417)
412 // but the response was invalid, it should never occur
413 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
420 if( !__myself.searchStatusOK )
422 // if called explicitly takes precedence
423 clearTimeout(__myself.bytargetTimer);
425 $.get( __myself.pz2String,
426 { "command": "bytarget", "session": __myself.sessionID },
428 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
429 var targetNodes = data.getElementsByTagName("target");
430 var bytarget = new Array();
431 for ( i = 0; i < targetNodes.length; i++) {
432 bytarget[i] = new Array();
433 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
434 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
435 var nodeName = targetNodes[i].childNodes[j].nodeName;
436 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
437 bytarget[i][nodeName] = nodeText;
441 __myself.bytargetCallback(bytarget);
442 if ( __myself.activeClients > 0 )
443 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
446 // if it gets here the http return code was 200 (pz2 errors are 417)
447 // but the response was invalid, it should never occur
448 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
452 // just for testing, probably shouldn't be here
453 showNext: function(page)
455 var step = page || 1;
456 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
458 showPrev: function(page)
460 if (__myself.currentStart == 0 )
462 var step = page || 1;
463 var newStart = __myself.currentStart - (step * __myself.currentNum );
464 __myself.show( newStart > 0 ? newStart : 0 );
466 showPage: function(pageNum)
468 //var page = pageNum || 1;
469 __myself.show(pageNum * __myself.currentNum);