2 if(typeof window.jQuery == "undefined")
3 throw new Error("pz2.js requires jQuery library");
4 // prevent execution of more than once
5 if(typeof window.pz2 == "undefined") {
6 window.undefined = window.undefined;
8 var pz2 = function(paramArray) {
12 // at least one callback required
14 throw new Error("An array with parameters has to be suplied when instantiating a class");
17 __myself.statCallback = paramArray.onstat || null;
18 __myself.showCallback = paramArray.onshow || null;
19 __myself.termlistCallback = paramArray.onterm || null;
20 __myself.recordCallback = paramArray.onrecord || null;
21 __myself.bytargetCallback = paramArray.onbytarget || null;
24 __myself.termKeys = paramArray.termlist || "subject";
26 // some configurational stuff
27 __myself.pz2String = "search.pz2";
28 __myself.keepAlive = 50000;
30 __myself.sessionID = null;
31 __myself.initStatusOK = false;
32 __myself.pingStatusOK = false;
33 __myself.searchStatusOK = false;
35 if ( paramArray.keepAlive < __myself.keepAlive )
36 __myself.keepAlive = paramArray.keepAlive;
39 __myself.currentSort = "relevance";
41 __myself.currentStart = 0;
42 __myself.currentNum = 20;
44 // last full record retrieved
45 __myself.currRecID = null;
47 __myself.currQuery = null;
50 __myself.statTime = paramArray.stattime || 2000;
51 __myself.statTimer = null;
52 __myself.termTime = paramArray.termtime || 1000;
53 __myself.termTimer = null;
54 __myself.showTime = paramArray.showtime || 1000;
55 __myself.showTimer = null;
56 __myself.bytargetTime = paramArray.bytargettime || 1000;
57 __myself.bytargetTimer = null;
59 // active clients, updated by stat and show
60 // might be an issue since bytarget will poll accordingly
61 __myself.activeClients = 1;
64 $(document).ajaxError(
65 function (request, settings, exception) {
66 if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
67 throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
71 if (paramArray.autoInit !== false)
72 __myself.init(__myself.keepAlive);
75 init: function(keepAlive)
77 if ( keepAlive < __myself.keepAlive )
78 __myself.keepAlive = keepAlive;
80 $.get( __myself.pz2String,
81 { "command": "init" },
83 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
84 __myself.initStatusOK = true;
85 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
86 setTimeout(__myself.ping, __myself.keepAlive);
89 // if it gets here the http return code was 200 (pz2 errors are 417)
90 // but the response was invalid, it should never occur
91 setTimeout("__myself.init()", 1000)
95 // no need to ping explicitly
98 if( !__myself.initStatusOK )
100 // session is not initialized code here
102 $.get( __myself.pz2String,
103 { "command": "ping", "session": __myself.sessionID },
105 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
106 __myself.pingStatusOK = true;
107 setTimeout("__myself.ping()", __myself.keepAlive);
110 // if it gets here the http return code was 200 (pz2 errors are 417)
111 // but the response was invalid, it should never occur
112 setTimeout("__myself.ping()", 1000)
116 search: function(query, num, sort, filter)
118 clearTimeout(__myself.statTimer);
119 clearTimeout(__myself.showTimer);
120 clearTimeout(__myself.termTimer);
121 clearTimeout(__myself.bytargetTimer);
123 if( !__myself.initStatusOK )
126 if( query !== undefined )
127 __myself.currQuery = query;
129 throw new Error("You need to supply query to the search command");
131 if( filter !== undefined )
132 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
134 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
136 $.get( __myself.pz2String,
139 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
140 __myself.searchStatusOK = true;
142 __myself.show(0, num, sort)
143 if ( __myself.statCallback )
144 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2);
145 if ( __myself.termlistCallback )
146 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
147 if ( __myself.bytargetCallback )
148 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
151 // if it gets here the http return code was 200 (pz2 errors are 417)
152 // but the response was invalid, it should never occur
153 setTimeout("__myself.search(__myself.currQuery)", 1000);
159 if( !__myself.searchStatusOK )
161 // if called explicitly takes precedence
162 clearTimeout(__myself.statTimer);
164 $.get( __myself.pz2String,
165 { "command": "stat", "session": __myself.sessionID },
167 if ( data.getElementsByTagName("stat") ) {
168 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
169 __myself.activeClients = activeClients;
171 "activeclients": activeClients,
172 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
173 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
174 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
175 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
176 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
177 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
178 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
179 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
180 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
182 __myself.statCallback(stat);
183 if (activeClients > 0)
184 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
187 // if it gets here the http return code was 200 (pz2 errors are 417)
188 // but the response was invalid, it should never occur
189 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4)
193 show: function(start, num, sort)
195 if( !__myself.searchStatusOK )
197 // if called explicitly takes precedence
198 clearTimeout(__myself.showTimer);
200 if( sort !== undefined )
201 __myself.currentSort = sort;
202 if( start !== undefined )
203 __myself.currentStart = Number( start );
204 if( num !== undefined )
205 __myself.currentNum = Number( num );
207 $.get( __myself.pz2String,
208 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
209 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
211 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
212 // first parse the status data send along with records
213 // this is strictly bound to the format
214 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
216 "activeclients": activeClients,
217 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
218 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
219 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
220 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
223 // parse all the first-level nodes for all <hit> tags
224 var hits = data.getElementsByTagName("hit");
225 var hit = new Array();
226 for (i = 0; i < hits.length; i++) {
227 show.hits[i] = new Array();
228 for ( j = 0; j < hits[i].childNodes.length; j++) {
229 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
230 var nodeName = hits[i].childNodes[j].nodeName;
231 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
232 show.hits[i][nodeName] = nodeText;
236 __myself.showCallback(show);
237 if (activeClients > 0)
238 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime);
241 // if it gets here the http return code was 200 (pz2 errors are 417)
242 // but the response was invalid, it should never occur
243 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
249 if( !__myself.searchStatusOK )
252 if( id !== undefined )
253 __myself.currRecID = id;
255 $.get( __myself.pz2String,
256 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
259 var record = new Array();
260 if ( recordNode = data.getElementsByTagName("record")[0] ) {
261 for ( i = 0; i < recordNode.childNodes.length; i++) {
262 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
263 var nodeName = recordNode.childNodes[i].nodeName;
264 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
265 record[nodeName] = nodeText;
268 // the location is hard coded
269 var locationNodes = recordNode.getElementsByTagName("location");
270 record["location"] = new Array();
271 for ( i = 0; i < locationNodes.length; i++ ) {
272 record["location"][i] = {
273 "id": locationNodes[i].getAttribute("id"),
274 "name": locationNodes[i].getAttribute("name")
276 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
277 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
278 var nodeName = locationNodes[i].childNodes[j].nodeName;
279 var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
280 record["location"][i][nodeName] = nodeText;
284 __myself.recordCallback(record);
287 // if it gets here the http return code was 200 (pz2 errors are 417)
288 // but the response was invalid, it should never occur
289 setTimeout("__myself.record(__myself.currRecID)", 1000);
295 if( !__myself.searchStatusOK )
297 // if called explicitly takes precedence
298 clearTimeout(__myself.termTimer);
300 $.get( __myself.pz2String,
301 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
303 if ( data.getElementsByTagName("termlist") ) {
304 var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) }
305 var termLists = data.getElementsByTagName("list");
307 for (i = 0; i < termLists.length; i++) {
308 var listName = termLists[i].getAttribute('name');
309 termList[listName] = new Array();
310 var terms = termLists[i].getElementsByTagName('term');
311 //for each term in the list
312 for (j = 0; j < terms.length; j++) {
314 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
315 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue,
318 var termIdNode = terms[j].getElementsByTagName("id");
319 if(terms[j].getElementsByTagName("id").length)
320 term["id"] = termIdNode[0].childNodes[0].nodeValue;
322 termList[listName][j] = term;
325 __myself.termlistCallback(termList);
326 if (termList["activeclients"] > 0)
327 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime);
330 // if it gets here the http return code was 200 (pz2 errors are 417)
331 // but the response was invalid, it should never occur
332 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
339 if( !__myself.searchStatusOK )
341 // if called explicitly takes precedence
342 clearTimeout(__myself.bytargetTimer);
344 $.get( __myself.pz2String,
345 { "command": "bytarget", "session": __myself.sessionID },
347 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
348 var targetNodes = data.getElementsByTagName("target");
349 var bytarget = new Array();
350 for ( i = 0; i < targetNodes.length; i++) {
351 bytarget[i] = new Array();
352 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
353 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
354 var nodeName = targetNodes[i].childNodes[j].nodeName;
355 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
356 bytarget[i][nodeName] = nodeText;
360 __myself.bytargetCallback(bytarget);
361 if ( __myself.activeClients > 0 )
362 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
365 // if it gets here the http return code was 200 (pz2 errors are 417)
366 // but the response was invalid, it should never occur
367 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
371 // just for testing, probably shouldn't be here
372 showNext: function(page)
374 var step = page || 1;
375 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
377 showPrev: function(page)
379 if (__myself.currentStart == 0 )
381 var step = page || 1;
382 var newStart = __myself.currentStart - (step * __myself.currentNum );
383 __myself.show( newStart > 0 ? newStart : 0 );