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 || 2000;
53 __myself.termTimer = null;
54 __myself.showTime = paramArray.showtime || 2000;
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 )
147 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2);
148 if ( __myself.bytargetCallback )
149 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2);
152 // if it gets here the http return code was 200 (pz2 errors are 417)
153 // but the response was invalid, it should never occur
154 setTimeout("__myself.search(__myself.currQuery)", 1000);
160 if( !__myself.searchStatusOK )
162 // if called explicitly takes precedence
163 clearTimeout(__myself.statTimer);
165 $.get( __myself.pz2String,
166 { "command": "stat", "session": __myself.sessionID },
168 if ( data.getElementsByTagName("stat") ) {
169 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
170 __myself.activeClients = activeClients;
172 "activeclients": activeClients,
173 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
174 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
175 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
176 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
177 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
178 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
179 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
180 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
181 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
183 __myself.statCallback(stat);
184 if (activeClients > 0)
185 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime);
188 // if it gets here the http return code was 200 (pz2 errors are 417)
189 // but the response was invalid, it should never occur
190 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4)
194 show: function(start, num, sort)
196 if( !__myself.searchStatusOK )
198 // if called explicitly takes precedence
199 clearTimeout(__myself.showTimer);
201 if( sort !== undefined )
202 __myself.currentSort = sort;
203 if( start !== undefined )
204 __myself.currentStart = Number( start );
205 if( num !== undefined )
206 __myself.currentNum = Number( num );
208 $.get( __myself.pz2String,
209 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
210 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
212 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
213 // first parse the status data send along with records
214 // this is strictly bound to the format
215 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
217 "activeclients": activeClients,
218 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
219 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
220 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
221 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
224 // parse all the first-level nodes for all <hit> tags
225 var hits = data.getElementsByTagName("hit");
226 var hit = new Array();
227 for (i = 0; i < hits.length; i++) {
228 show.hits[i] = new Array();
229 for ( j = 0; j < hits[i].childNodes.length; j++) {
230 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
231 var nodeName = hits[i].childNodes[j].nodeName;
232 var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
233 show.hits[i][nodeName] = nodeText;
237 __myself.showCallback(show);
238 if (activeClients > 0)
239 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime);
242 // if it gets here the http return code was 200 (pz2 errors are 417)
243 // but the response was invalid, it should never occur
244 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
250 if( !__myself.searchStatusOK )
253 if( id !== undefined )
254 __myself.currRecID = id;
256 $.get( __myself.pz2String,
257 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
260 var record = new Array();
261 if ( recordNode = data.getElementsByTagName("record")[0] ) {
262 for ( i = 0; i < recordNode.childNodes.length; i++) {
263 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) {
264 var nodeName = recordNode.childNodes[i].nodeName;
265 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
266 record[nodeName] = nodeText;
269 // the location is hard coded
270 var locationNodes = recordNode.getElementsByTagName("location");
271 record["location"] = new Array();
272 for ( i = 0; i < locationNodes.length; i++ ) {
273 record["location"][i] = {
274 "id": locationNodes[i].getAttribute("id"),
275 "name": locationNodes[i].getAttribute("name")
277 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
278 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
279 var nodeName = locationNodes[i].childNodes[j].nodeName;
280 var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
281 record["location"][i][nodeName] = nodeText;
285 __myself.recordCallback(record);
288 // if it gets here the http return code was 200 (pz2 errors are 417)
289 // but the response was invalid, it should never occur
290 setTimeout("__myself.record(__myself.currRecID)", 1000);
296 if( !__myself.searchStatusOK )
298 // if called explicitly takes precedence
299 clearTimeout(__myself.termTimer);
301 $.get( __myself.pz2String,
302 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
304 if ( data.getElementsByTagName("termlist") ) {
305 var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) }
306 var termLists = data.getElementsByTagName("list");
308 for (i = 0; i < termLists.length; i++) {
309 var listName = termLists[i].getAttribute('name');
310 termList[listName] = new Array();
311 var terms = termLists[i].getElementsByTagName('term');
312 //for each term in the list
313 for (j = 0; j < terms.length; j++) {
315 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
316 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue,
319 var termIdNode = terms[j].getElementsByTagName("id");
320 if(terms[j].getElementsByTagName("id").length)
321 term["id"] = termIdNode[0].childNodes[0].nodeValue;
323 termList[listName][j] = term;
326 __myself.termlistCallback(termList);
327 if (termList["activeclients"] > 0)
328 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime);
331 // if it gets here the http return code was 200 (pz2 errors are 417)
332 // but the response was invalid, it should never occur
333 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
340 if( !__myself.searchStatusOK )
342 // if called explicitly takes precedence
343 clearTimeout(__myself.bytargetTimer);
345 $.get( __myself.pz2String,
346 { "command": "bytarget", "session": __myself.sessionID },
348 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
349 var targetNodes = data.getElementsByTagName("target");
350 var bytarget = new Array();
351 for ( i = 0; i < targetNodes.length; i++) {
352 bytarget[i] = new Array();
353 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
354 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
355 var nodeName = targetNodes[i].childNodes[j].nodeName;
356 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
357 bytarget[i][nodeName] = nodeText;
361 __myself.bytargetCallback(bytarget);
362 if ( __myself.activeClients > 0 )
363 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime);
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 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
372 // just for testing, probably shouldn't be here
373 showNext: function(page)
375 var step = page || 1;
376 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
378 showPrev: function(page)
380 if (__myself.currentStart == 0 )
382 var step = page || 1;
383 var newStart = __myself.currentStart - (step * __myself.currentNum );
384 __myself.show( newStart > 0 ? newStart : 0 );
386 showPage: function(pageNum)
388 //var page = pageNum || 1;
389 __myself.show(pageNum * __myself.currentNum);