2 ** $Id: pz2.js,v 1.40 2007-06-25 07:23:56 adam 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 // prevent execution of more than once
24 if(typeof window.pz2 == "undefined") {
25 window.undefined = window.undefined;
27 var pz2 = function(paramArray) {
31 //supported pazpar2's protocol version
32 __myself.suppProtoVer = '1';
33 __myself.pz2String = paramArray.pazpar2path || "search.pz2";
34 __myself.stylesheet = paramArray.detailstylesheet || null;
35 __myself.useSessions = true;
36 if (paramArray.usesessions != undefined) {
37 __myself.useSessions = paramArray.usesessions;
40 //load stylesheet if required in async mode
41 if( __myself.stylesheet ) {
42 var request = new pzHttpRequest( __myself.stylesheet );
46 __myself.xslDoc = doc;
51 // at least one callback required
53 throw new Error("An array with parameters has to be suplied when instantiating a class");
55 __myself.errorHandler = paramArray.errorhandler || null;
58 __myself.statCallback = paramArray.onstat || null;
59 __myself.showCallback = paramArray.onshow || null;
60 __myself.termlistCallback = paramArray.onterm || null;
61 __myself.recordCallback = paramArray.onrecord || null;
62 __myself.bytargetCallback = paramArray.onbytarget || null;
63 __myself.resetCallback = paramArray.onreset || null;
66 __myself.termKeys = paramArray.termlist || "subject";
68 // some configurational stuff
69 __myself.keepAlive = 50000;
71 __myself.sessionID = null;
72 __myself.initStatusOK = false;
73 __myself.pingStatusOK = false;
74 __myself.searchStatusOK = false;
76 if ( paramArray.keepAlive < __myself.keepAlive )
77 __myself.keepAlive = paramArray.keepAlive;
80 __myself.currentSort = "relevance";
82 __myself.currentStart = 0;
83 __myself.currentNum = 20;
85 // last full record retrieved
86 __myself.currRecID = null;
88 __myself.currQuery = null;
91 __myself.statTime = paramArray.stattime || 1000;
92 __myself.statTimer = null;
93 __myself.termTime = paramArray.termtime || 1000;
94 __myself.termTimer = null;
95 __myself.showTime = paramArray.showtime || 1000;
96 __myself.showTimer = null;
97 __myself.showFastCount = 4;
98 __myself.bytargetTime = paramArray.bytargettime || 1000;
99 __myself.bytargetTimer = null;
101 // counters for each command and applied delay
102 __myself.dumpFactor = 500;
103 __myself.showCounter = 0;
104 __myself.termCounter = 0;
105 __myself.statCounter = 0;
106 __myself.bytargetCounter = 0;
108 // active clients, updated by stat and show
109 // might be an issue since bytarget will poll accordingly
110 __myself.activeClients = 1;
112 // auto init session?
113 if (paramArray.autoInit !== false)
120 clearTimeout(__myself.statTimer);
121 clearTimeout(__myself.showTimer);
122 clearTimeout(__myself.termTimer);
123 clearTimeout(__myself.bytargetTimer);
128 __myself.sessionID = null;
129 __myself.initStatusOK = false;
130 __myself.pingStatusOK = false;
131 __myself.searchStatusOK = false;
135 if ( __myself.resetCallback )
136 __myself.resetCallback();
138 init: function ( sessionId )
142 if ( sessionId != undefined ) {
143 __myself.initStatusOK = true;
144 __myself.sessionID = sessionId;
146 } else if (__myself.useSessions) {
147 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
149 [ { "command": "init" } ],
151 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
152 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
153 throw new Error("Server's protocol not supported by the client");
154 __myself.initStatusOK = true;
155 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
156 setTimeout("__myself.ping()", __myself.keepAlive);
159 // if it gets here the http return code was 200 (pz2 errors are 417)
160 // but the response was invalid, it should never occur
161 setTimeout("__myself.init()", 1000);
165 __myself.initStatusOK = true;
168 // no need to ping explicitly
171 if( !__myself.initStatusOK )
173 // session is not initialized code here
174 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
176 [ { "command": "ping", "session": __myself.sessionID } ],
178 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
179 __myself.pingStatusOK = true;
180 setTimeout("__myself.ping()", __myself.keepAlive);
183 // if it gets here the http return code was 200 (pz2 errors are 417)
184 // but the response was invalid, it should never occur
185 setTimeout("__myself.ping()", 1000);
189 search: function (query, num, sort, filter)
191 clearTimeout(__myself.statTimer);
192 clearTimeout(__myself.showTimer);
193 clearTimeout(__myself.termTimer);
194 clearTimeout(__myself.bytargetTimer);
196 __myself.showCounter = 0;
197 __myself.termCounter = 0;
198 __myself.bytargetCounter = 0;
199 __myself.statCounter = 0;
201 if( !__myself.initStatusOK )
204 if( query !== undefined )
205 __myself.currQuery = query;
207 throw new Error("You need to supply query to the search command");
209 var searchParams = [{ "command": "search", "query": __myself.currQuery }];
210 searchParams.push({"session":__myself.sessionID});
211 if (filter !== undefined)
212 searchParams.push({"filter": filter});
213 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
217 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
218 __myself.searchStatusOK = true;
220 __myself.show(0, num, sort);
221 if ( __myself.statCallback )
223 //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
224 if ( __myself.termlistCallback )
226 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
227 if ( __myself.bytargetCallback )
229 //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
232 // if it gets here the http return code was 200 (pz2 errors are 417)
233 // but the response was invalid, it should never occur
234 setTimeout("__myself.search(__myself.currQuery)", 500);
240 if( !__myself.initStatusOK )
242 // if called explicitly takes precedence
243 clearTimeout(__myself.statTimer);
244 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
246 [ { "command": "stat", "session": __myself.sessionID } ],
248 if ( data.getElementsByTagName("stat") ) {
249 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
250 __myself.activeClients = activeClients;
252 "activeclients": activeClients,
253 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
254 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
255 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
256 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
257 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
258 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
259 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
260 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
261 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
264 __myself.statCounter++;
265 var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
266 if ( activeClients > 0 )
267 __myself.statTimer = setTimeout("__myself.stat()", delay);
269 __myself.statCallback(stat);
272 // if it gets here the http return code was 200 (pz2 errors are 417)
273 // but the response was invalid, it should never occur
274 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
278 show: function(start, num, sort)
280 if( !__myself.searchStatusOK )
282 // if called explicitly takes precedence
283 clearTimeout(__myself.showTimer);
285 if( sort !== undefined )
286 __myself.currentSort = sort;
287 if( start !== undefined )
288 __myself.currentStart = Number( start );
289 if( num !== undefined )
290 __myself.currentNum = Number( num );
291 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
294 [ { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
295 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 } ],
297 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
298 // first parse the status data send along with records
299 // this is strictly bound to the format
300 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
301 __myself.activeClients = activeClients;
303 "activeclients": activeClients,
304 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
305 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
306 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
307 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
310 // parse all the first-level nodes for all <hit> tags
311 var hits = data.getElementsByTagName("hit");
312 var hit = new Array();
313 for (i = 0; i < hits.length; i++) {
314 show.hits[i] = new Array();
315 show.hits[i]['location'] = new Array();
316 for ( j = 0; j < hits[i].childNodes.length; j++) {
318 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
319 if (hits[i].childNodes[j].nodeName == 'location') {
320 var locNode = hits[i].childNodes[j];
321 var id = locNode.getAttribute('id');
322 show.hits[i]['location'][id] = {
323 "id": locNode.getAttribute("id"),
324 "name": locNode.getAttribute("name")
328 var nodeName = hits[i].childNodes[j].nodeName;
329 var nodeText = 'ERROR'
330 if ( hits[i].childNodes[j].firstChild )
331 nodeText = hits[i].childNodes[j].firstChild.nodeValue;
332 show.hits[i][nodeName] = nodeText;
337 __myself.showCounter++;
338 var delay = __myself.showTime;
339 if (__myself.showCounter > __myself.showFastCount)
340 delay += __myself.showCounter * __myself.dumpFactor;
341 if ( activeClients > 0 )
342 __myself.showTimer = setTimeout("__myself.show()", delay);
344 __myself.showCallback(show);
347 // if it gets here the http return code was 200 (pz2 errors are 417)
348 // but the response was invalid, it should never occur
349 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
355 if( !__myself.searchStatusOK )
358 if( id !== undefined )
359 __myself.currRecID = id;
360 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
362 [ { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID } ],
365 var record = new Array();
366 if ( recordNode = data.getElementsByTagName("record")[0] ) {
367 // if stylesheet was fetched do not parse the response
368 if ( __myself.xslDoc ) {
369 record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue;
370 record['xmlDoc'] = data;
371 record['xslDoc'] = __myself.xslDoc;
373 for ( i = 0; i < recordNode.childNodes.length; i++) {
374 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
375 && recordNode.childNodes[i].nodeName != 'location' ) {
376 var nodeName = recordNode.childNodes[i].nodeName;
377 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
378 record[nodeName] = nodeText;
381 // the location might be empty!!
382 var locationNodes = recordNode.getElementsByTagName("location");
383 record["location"] = new Array();
384 for ( i = 0; i < locationNodes.length; i++ ) {
385 record["location"][i] = {
386 "id": locationNodes[i].getAttribute("id"),
387 "name": locationNodes[i].getAttribute("name")
390 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
391 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
392 var nodeName = locationNodes[i].childNodes[j].nodeName;
394 if (locationNodes[i].childNodes[j].firstChild)
395 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
396 record["location"][i][nodeName] = nodeText;
402 __myself.recordCallback(record);
405 // if it gets here the http return code was 200 (pz2 errors are 417)
406 // but the response was invalid, it should never occur
407 setTimeout("__myself.record(__myself.currRecID)", 500);
413 if( !__myself.searchStatusOK )
415 // if called explicitly takes precedence
416 clearTimeout(__myself.termTimer);
417 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
419 [ { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys } ],
421 if ( data.getElementsByTagName("termlist") ) {
422 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
423 __myself.activeClients = activeClients;
424 var termList = { "activeclients": activeClients };
425 var termLists = data.getElementsByTagName("list");
427 for (i = 0; i < termLists.length; i++) {
428 var listName = termLists[i].getAttribute('name');
429 termList[listName] = new Array();
430 var terms = termLists[i].getElementsByTagName('term');
431 //for each term in the list
432 for (j = 0; j < terms.length; j++) {
434 "name": (terms[j].getElementsByTagName("name")[0].childNodes.length
435 ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue
437 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR'
440 var termIdNode = terms[j].getElementsByTagName("id");
441 if(terms[j].getElementsByTagName("id").length)
442 term["id"] = termIdNode[0].childNodes[0].nodeValue;
444 termList[listName][j] = term;
448 __myself.termCounter++;
449 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
450 if ( activeClients > 0 )
451 __myself.termTimer = setTimeout("__myself.termlist()", delay);
453 __myself.termlistCallback(termList);
456 // if it gets here the http return code was 200 (pz2 errors are 417)
457 // but the response was invalid, it should never occur
458 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
465 if( !__myself.searchStatusOK )
467 // if called explicitly takes precedence
468 clearTimeout(__myself.bytargetTimer);
469 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
471 [ { "command": "bytarget", "session": __myself.sessionID } ],
473 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
474 var targetNodes = data.getElementsByTagName("target");
475 var bytarget = new Array();
476 for ( i = 0; i < targetNodes.length; i++) {
477 bytarget[i] = new Array();
478 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
479 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
480 var nodeName = targetNodes[i].childNodes[j].nodeName;
481 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
482 bytarget[i][nodeName] = nodeText;
487 __myself.bytargetCounter++;
488 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
489 if ( __myself.activeClients > 0 )
490 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
492 __myself.bytargetCallback(bytarget);
495 // if it gets here the http return code was 200 (pz2 errors are 417)
496 // but the response was invalid, it should never occur
497 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
501 // just for testing, probably shouldn't be here
502 showNext: function(page)
504 var step = page || 1;
505 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
507 showPrev: function(page)
509 if (__myself.currentStart == 0 )
511 var step = page || 1;
512 var newStart = __myself.currentStart - (step * __myself.currentNum );
513 __myself.show( newStart > 0 ? newStart : 0 );
515 showPage: function(pageNum)
517 //var page = pageNum || 1;
518 __myself.show(pageNum * __myself.currentNum);
523 *********************************************************************************
524 ** AJAX HELPER CLASS ************************************************************
525 *********************************************************************************
527 var pzHttpRequest = function ( url, errorHandler ) {
530 this.errorHandler = errorHandler || null;
533 if ( window.XMLHttpRequest ) {
534 this.request = new XMLHttpRequest();
535 } else if ( window.ActiveXObject ) {
537 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
539 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
544 pzHttpRequest.prototype =
546 get: function ( params, callback )
548 this._send( 'GET', params, null, callback );
551 post: function ( params, data, callback )
553 this._send( 'POST', params, data, callback );
556 _send: function ( type, params, data, callback )
558 this.callback = callback;
560 this.request.open( type, this._urlAppendParams(params), this.async );
561 //this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
562 this.request.onreadystatechange = function () {
563 context._handleResponse();
565 this.request.send(data);
568 _urlAppendParams: function (params)
570 var getUrl = this.url;
573 for (var i = 0; i < params.length; i++) {
575 for (var key in el) {
576 if (el[key] != null) {
577 getUrl += sep + key + '=' + encodeURI(el[key]);
585 _handleResponse: function ()
587 if ( this.request.readyState == 4 ) {
588 if ( this.request.status == 200 ) {
589 this.callback( this.request.responseXML );
592 else if ( this.request.status == 417 ) {
593 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
594 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
596 var err = new Error(errMsg);
599 if (this.errorHandler) {
600 this.errorHandler(err);
607 var err = new Error("XMLHttpRequest error. STATUS: "
608 + this.request.status + " STATUS TEXT: "
609 + this.request.statusText );
612 if (this.errorHandler) {
613 this.errorHandler(err);
624 *********************************************************************************
625 ** QUERY CLASS ******************************************************************
626 *********************************************************************************
628 var pzQuery = function()
630 this.simpleQuery = '';
631 this.singleFilter = null;
632 this.advTerms = new Array();
633 this.filterHash = new Array();
637 pzQuery.prototype = {
640 this.simpleQuery = '';
641 this.advTerms = new Array();
642 this.simpleFilter = null;
645 clearSimpleQuery: function()
647 this.simpleQuery = '';
649 addTerm: function(field, value)
651 var term = {"field": field, "value": value};
652 this.advTerms[this.numTerms] = term;
655 getTermValueByIdx: function(index)
657 return this.advTerms[index].value;
659 getTermFieldByIdx: function(index)
661 return this.advTerms[index].field;
663 /* semicolon separated list of terms for given field*/
664 getTermsByField: function(field)
667 for(var i = 0; i < this.advTerms.length; i++)
669 if( this.advTerms[i].field == field )
670 terms = terms + this.queryHas[i].value + ';';
674 addTermsFromList: function(inputString, field)
676 var inputArr = inputString.split(';');
677 for(var i=0; i < inputArr.length; i++)
679 if(inputArr[i].length < 3) continue;
680 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
684 removeTermByIdx: function(index)
686 this.advTerms.splice(index, 1);
692 if( this.simpleQuery != '')
693 ccl = this.simpleQuery;
694 for(var i = 0; i < this.advTerms.length; i++)
696 if (ccl != '') ccl = ccl + ' and ';
697 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
701 addFilter: function(name, value)
703 var filter = {"name": name, "id": value };
704 this.filterHash[this.filterHash.length] = filter;
706 return this.filterHash.length - 1;
708 setFilter: function(name, value)
710 this.filterHash = new Array();
712 this.addFilter(name, value);
714 getFilter: function(index)
716 return this.filterHash[index].id;
718 getFilterName: function(index)
720 return this.filterHash[index].name;
722 removeFilter: function(index)
724 delete this.filterHash[index];
727 clearFilter: function()
729 this.filterHash = new Array();
732 getFilterString: function()
735 if( this.singleFilter != null ) {
736 return 'pz:id='+this.singleFilter.id;
738 else if( this.filterNums <= 0 ) {
742 var filter = 'pz:id=';
743 for(var i = 0; i < this.filterHash.length; i++)
745 if (this.filterHash[i] == undefined) continue;
746 if (filter > 'pz:id=') filter = filter + '|';
747 filter += this.filterHash[i].id;
751 totalLength: function()
753 var simpleLength = this.simpleQuery != '' ? 1 : 0;
754 return this.advTerms.length + simpleLength;
756 clearSingleFilter: function()
758 this.singleFilter = null;
760 setSingleFilter: function(name, value)
762 this.singleFilter = {"name": name, "id": value };
764 getSingleFilterName: function()
766 return this.singleFilter.name;