2 ** $Id: pz2.js,v 1.5 2007-04-03 14:27:21 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");
39 __myself.statCallback = paramArray.onstat || null;
40 __myself.showCallback = paramArray.onshow || null;
41 __myself.termlistCallback = paramArray.onterm || null;
42 __myself.recordCallback = paramArray.onrecord || null;
43 __myself.bytargetCallback = paramArray.onbytarget || null;
46 __myself.termKeys = paramArray.termlist || "subject";
48 // some configurational stuff
49 __myself.pz2String = "search.pz2";
50 __myself.keepAlive = 50000;
52 __myself.sessionID = null;
53 __myself.initStatusOK = false;
54 __myself.pingStatusOK = false;
55 __myself.searchStatusOK = false;
57 if ( paramArray.keepAlive < __myself.keepAlive )
58 __myself.keepAlive = paramArray.keepAlive;
61 __myself.currentSort = "relevance";
63 __myself.currentStart = 0;
64 __myself.currentNum = 20;
66 // last full record retrieved
67 __myself.currRecID = null;
69 __myself.currQuery = null;
72 __myself.statTime = paramArray.stattime || 2000;
73 __myself.statTimer = null;
74 __myself.termTime = paramArray.termtime || 1000;
75 __myself.termTimer = null;
76 __myself.showTime = paramArray.showtime || 1000;
77 __myself.showTimer = null;
78 __myself.bytargetTime = paramArray.bytargettime || 1000;
79 __myself.bytargetTimer = null;
82 __myself.dumpFactor = 500;
83 __myself.showCounter = 0;
84 __myself.termCounter = 0;
86 // active clients, updated by stat and show
87 // might be an issue since bytarget will poll accordingly
88 __myself.activeClients = 1;
91 $(document).ajaxError(
92 function (request, settings, exception) {
93 if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
94 throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
98 if (paramArray.autoInit !== false)
99 __myself.init(__myself.keepAlive);
102 init: function(keepAlive)
104 if ( keepAlive < __myself.keepAlive )
105 __myself.keepAlive = keepAlive;
107 $.get( __myself.pz2String,
108 { "command": "init" },
110 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
111 __myself.initStatusOK = true;
112 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
113 setTimeout(__myself.ping, __myself.keepAlive);
116 // if it gets here the http return code was 200 (pz2 errors are 417)
117 // but the response was invalid, it should never occur
118 setTimeout("__myself.init()", 1000);
122 // no need to ping explicitly
125 if( !__myself.initStatusOK )
127 // session is not initialized code here
129 $.get( __myself.pz2String,
130 { "command": "ping", "session": __myself.sessionID },
132 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
133 __myself.pingStatusOK = true;
134 setTimeout("__myself.ping()", __myself.keepAlive);
137 // if it gets here the http return code was 200 (pz2 errors are 417)
138 // but the response was invalid, it should never occur
139 setTimeout("__myself.ping()", 1000);
143 search: function(query, num, sort, filter)
145 clearTimeout(__myself.statTimer);
146 clearTimeout(__myself.showTimer);
147 clearTimeout(__myself.termTimer);
148 clearTimeout(__myself.bytargetTimer);
150 __myself.showCounter = 0;
151 __myself.termCounter = 0;
153 if( !__myself.initStatusOK )
156 if( query !== undefined )
157 __myself.currQuery = query;
159 throw new Error("You need to supply query to the search command");
161 if( filter !== undefined )
162 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
164 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
166 $.get( __myself.pz2String,
169 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
170 __myself.searchStatusOK = true;
172 __myself.show(0, num, sort);
173 if ( __myself.statCallback )
174 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
175 if ( __myself.termlistCallback )
176 //__myself.termlist();
177 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
178 if ( __myself.bytargetCallback )
179 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
182 // if it gets here the http return code was 200 (pz2 errors are 417)
183 // but the response was invalid, it should never occur
184 setTimeout("__myself.search(__myself.currQuery)", 1000);
190 if( !__myself.searchStatusOK )
192 // if called explicitly takes precedence
193 clearTimeout(__myself.statTimer);
195 $.get( __myself.pz2String,
196 { "command": "stat", "session": __myself.sessionID },
198 if ( data.getElementsByTagName("stat") ) {
199 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
200 __myself.activeClients = activeClients;
202 "activeclients": activeClients,
203 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
204 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
205 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
206 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
207 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
208 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
209 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
210 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
211 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
213 __myself.statCallback(stat);
214 if (activeClients > 0)
215 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
218 // if it gets here the http return code was 200 (pz2 errors are 417)
219 // but the response was invalid, it should never occur
220 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
224 show: function(start, num, sort)
226 if( !__myself.searchStatusOK )
228 // if called explicitly takes precedence
229 clearTimeout(__myself.showTimer);
231 if( sort !== undefined )
232 __myself.currentSort = sort;
233 if( start !== undefined )
234 __myself.currentStart = Number( start );
235 if( num !== undefined )
236 __myself.currentNum = Number( num );
238 $.get( __myself.pz2String,
239 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
240 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
242 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
243 // first parse the status data send along with records
244 // this is strictly bound to the format
245 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
247 "activeclients": activeClients,
248 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
249 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
250 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
251 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
254 // parse all the first-level nodes for all <hit> tags
255 var hits = data.getElementsByTagName("hit");
256 var hit = new Array();
257 for (i = 0; i < hits.length; i++) {
258 show.hits[i] = new Array();
259 for ( j = 0; j < hits[i].childNodes.length; j++) {
260 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
261 var nodeName = hits[i].childNodes[j].nodeName;
262 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
263 show.hits[i][nodeName] = nodeText;
267 __myself.showCallback(show);
268 __myself.showCounter++;
269 if (activeClients > 0)
270 __myself.showTimer = setTimeout("__myself.show()", (__myself.showTime + __myself.showCounter*__myself.dumpFactor));
273 // if it gets here the http return code was 200 (pz2 errors are 417)
274 // but the response was invalid, it should never occur
275 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
281 if( !__myself.searchStatusOK )
284 if( id !== undefined )
285 __myself.currRecID = id;
287 $.get( __myself.pz2String,
288 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
291 var record = new Array();
292 if ( recordNode = data.getElementsByTagName("record")[0] ) {
293 for ( i = 0; i < recordNode.childNodes.length; i++) {
294 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
295 var nodeName = recordNode.childNodes[i].nodeName;
296 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
297 record[nodeName] = nodeText;
300 // the location is hard coded
301 var locationNodes = recordNode.getElementsByTagName("location");
302 record["location"] = new Array();
303 for ( i = 0; i < locationNodes.length; i++ ) {
304 record["location"][i] = {
305 "id": locationNodes[i].getAttribute("id"),
306 "name": locationNodes[i].getAttribute("name")
308 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
309 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
310 var nodeName = locationNodes[i].childNodes[j].nodeName;
311 var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
312 record["location"][i][nodeName] = nodeText;
316 __myself.recordCallback(record);
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 setTimeout("__myself.record(__myself.currRecID)", 1000);
327 if( !__myself.searchStatusOK )
329 // if called explicitly takes precedence
330 clearTimeout(__myself.termTimer);
332 $.get( __myself.pz2String,
333 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
335 if ( data.getElementsByTagName("termlist") ) {
336 var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) };
337 var termLists = data.getElementsByTagName("list");
339 for (i = 0; i < termLists.length; i++) {
340 var listName = termLists[i].getAttribute('name');
341 termList[listName] = new Array();
342 var terms = termLists[i].getElementsByTagName('term');
343 //for each term in the list
344 for (j = 0; j < terms.length; j++) {
346 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
347 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
350 var termIdNode = terms[j].getElementsByTagName("id");
351 if(terms[j].getElementsByTagName("id").length)
352 term["id"] = termIdNode[0].childNodes[0].nodeValue;
354 termList[listName][j] = term;
358 __myself.termlistCallback(termList);
359 __myself.termCounter++;
360 if (termList["activeclients"] > 0)
361 __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor));
364 // if it gets here the http return code was 200 (pz2 errors are 417)
365 // but the response was invalid, it should never occur
366 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
373 if( !__myself.searchStatusOK )
375 // if called explicitly takes precedence
376 clearTimeout(__myself.bytargetTimer);
378 $.get( __myself.pz2String,
379 { "command": "bytarget", "session": __myself.sessionID },
381 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
382 var targetNodes = data.getElementsByTagName("target");
383 var bytarget = new Array();
384 for ( i = 0; i < targetNodes.length; i++) {
385 bytarget[i] = new Array();
386 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
387 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
388 var nodeName = targetNodes[i].childNodes[j].nodeName;
389 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
390 bytarget[i][nodeName] = nodeText;
394 __myself.bytargetCallback(bytarget);
395 if ( __myself.activeClients > 0 )
396 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
399 // if it gets here the http return code was 200 (pz2 errors are 417)
400 // but the response was invalid, it should never occur
401 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
405 // just for testing, probably shouldn't be here
406 showNext: function(page)
408 var step = page || 1;
409 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
411 showPrev: function(page)
413 if (__myself.currentStart == 0 )
415 var step = page || 1;
416 var newStart = __myself.currentStart - (step * __myself.currentNum );
417 __myself.show( newStart > 0 ? newStart : 0 );
419 showPage: function(pageNum)
421 //var page = pageNum || 1;
422 __myself.show(pageNum * __myself.currentNum);