2 ** $Id: pz2.js,v 1.39 2007-06-22 10:52:09 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);
166 // no need to ping explicitly
169 if( !__myself.initStatusOK )
171 // session is not initialized code here
172 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
174 [ { "command": "ping", "session": __myself.sessionID } ],
176 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
177 __myself.pingStatusOK = true;
178 setTimeout("__myself.ping()", __myself.keepAlive);
181 // if it gets here the http return code was 200 (pz2 errors are 417)
182 // but the response was invalid, it should never occur
183 setTimeout("__myself.ping()", 1000);
187 search: function (query, num, sort, filter)
189 clearTimeout(__myself.statTimer);
190 clearTimeout(__myself.showTimer);
191 clearTimeout(__myself.termTimer);
192 clearTimeout(__myself.bytargetTimer);
194 __myself.showCounter = 0;
195 __myself.termCounter = 0;
196 __myself.bytargetCounter = 0;
197 __myself.statCounter = 0;
199 if( !__myself.initStatusOK )
202 if( query !== undefined )
203 __myself.currQuery = query;
205 throw new Error("You need to supply query to the search command");
207 var searchParams = [{ "command": "search", "query": __myself.currQuery }];
208 searchParams.push({"session":__myself.sessionID});
209 if (filter !== undefined)
210 searchParams.push({"filter": filter});
211 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
215 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
216 __myself.searchStatusOK = true;
218 __myself.show(0, num, sort);
219 if ( __myself.statCallback )
221 //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
222 if ( __myself.termlistCallback )
224 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
225 if ( __myself.bytargetCallback )
227 //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
230 // if it gets here the http return code was 200 (pz2 errors are 417)
231 // but the response was invalid, it should never occur
232 setTimeout("__myself.search(__myself.currQuery)", 500);
238 if( !__myself.initStatusOK )
240 // if called explicitly takes precedence
241 clearTimeout(__myself.statTimer);
242 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
244 [ { "command": "stat", "session": __myself.sessionID } ],
246 if ( data.getElementsByTagName("stat") ) {
247 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
248 __myself.activeClients = activeClients;
250 "activeclients": activeClients,
251 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
252 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
253 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
254 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
255 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
256 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
257 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
258 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
259 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
262 __myself.statCounter++;
263 var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
264 if ( activeClients > 0 )
265 __myself.statTimer = setTimeout("__myself.stat()", delay);
267 __myself.statCallback(stat);
270 // if it gets here the http return code was 200 (pz2 errors are 417)
271 // but the response was invalid, it should never occur
272 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
276 show: function(start, num, sort)
278 if( !__myself.searchStatusOK )
280 // if called explicitly takes precedence
281 clearTimeout(__myself.showTimer);
283 if( sort !== undefined )
284 __myself.currentSort = sort;
285 if( start !== undefined )
286 __myself.currentStart = Number( start );
287 if( num !== undefined )
288 __myself.currentNum = Number( num );
289 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
292 [ { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
293 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 } ],
295 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
296 // first parse the status data send along with records
297 // this is strictly bound to the format
298 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
299 __myself.activeClients = activeClients;
301 "activeclients": activeClients,
302 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
303 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
304 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
305 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
308 // parse all the first-level nodes for all <hit> tags
309 var hits = data.getElementsByTagName("hit");
310 var hit = new Array();
311 for (i = 0; i < hits.length; i++) {
312 show.hits[i] = new Array();
313 show.hits[i]['location'] = new Array();
314 for ( j = 0; j < hits[i].childNodes.length; j++) {
316 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
317 if (hits[i].childNodes[j].nodeName == 'location') {
318 var locNode = hits[i].childNodes[j];
319 var id = locNode.getAttribute('id');
320 show.hits[i]['location'][id] = {
321 "id": locNode.getAttribute("id"),
322 "name": locNode.getAttribute("name")
326 var nodeName = hits[i].childNodes[j].nodeName;
327 var nodeText = 'ERROR'
328 if ( hits[i].childNodes[j].firstChild )
329 nodeText = hits[i].childNodes[j].firstChild.nodeValue;
330 show.hits[i][nodeName] = nodeText;
335 __myself.showCounter++;
336 var delay = __myself.showTime;
337 if (__myself.showCounter > __myself.showFastCount)
338 delay += __myself.showCounter * __myself.dumpFactor;
339 if ( activeClients > 0 )
340 __myself.showTimer = setTimeout("__myself.show()", delay);
342 __myself.showCallback(show);
345 // if it gets here the http return code was 200 (pz2 errors are 417)
346 // but the response was invalid, it should never occur
347 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
353 if( !__myself.searchStatusOK )
356 if( id !== undefined )
357 __myself.currRecID = id;
358 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
360 [ { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID } ],
363 var record = new Array();
364 if ( recordNode = data.getElementsByTagName("record")[0] ) {
365 // if stylesheet was fetched do not parse the response
366 if ( __myself.xslDoc ) {
367 record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue;
368 record['xmlDoc'] = data;
369 record['xslDoc'] = __myself.xslDoc;
371 for ( i = 0; i < recordNode.childNodes.length; i++) {
372 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
373 && recordNode.childNodes[i].nodeName != 'location' ) {
374 var nodeName = recordNode.childNodes[i].nodeName;
375 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
376 record[nodeName] = nodeText;
379 // the location might be empty!!
380 var locationNodes = recordNode.getElementsByTagName("location");
381 record["location"] = new Array();
382 for ( i = 0; i < locationNodes.length; i++ ) {
383 record["location"][i] = {
384 "id": locationNodes[i].getAttribute("id"),
385 "name": locationNodes[i].getAttribute("name")
388 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
389 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
390 var nodeName = locationNodes[i].childNodes[j].nodeName;
392 if (locationNodes[i].childNodes[j].firstChild)
393 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
394 record["location"][i][nodeName] = nodeText;
400 __myself.recordCallback(record);
403 // if it gets here the http return code was 200 (pz2 errors are 417)
404 // but the response was invalid, it should never occur
405 setTimeout("__myself.record(__myself.currRecID)", 500);
411 if( !__myself.searchStatusOK )
413 // if called explicitly takes precedence
414 clearTimeout(__myself.termTimer);
415 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
417 [ { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys } ],
419 if ( data.getElementsByTagName("termlist") ) {
420 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
421 __myself.activeClients = activeClients;
422 var termList = { "activeclients": activeClients };
423 var termLists = data.getElementsByTagName("list");
425 for (i = 0; i < termLists.length; i++) {
426 var listName = termLists[i].getAttribute('name');
427 termList[listName] = new Array();
428 var terms = termLists[i].getElementsByTagName('term');
429 //for each term in the list
430 for (j = 0; j < terms.length; j++) {
432 "name": (terms[j].getElementsByTagName("name")[0].childNodes.length
433 ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue
435 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR'
438 var termIdNode = terms[j].getElementsByTagName("id");
439 if(terms[j].getElementsByTagName("id").length)
440 term["id"] = termIdNode[0].childNodes[0].nodeValue;
442 termList[listName][j] = term;
446 __myself.termCounter++;
447 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
448 if ( activeClients > 0 )
449 __myself.termTimer = setTimeout("__myself.termlist()", delay);
451 __myself.termlistCallback(termList);
454 // if it gets here the http return code was 200 (pz2 errors are 417)
455 // but the response was invalid, it should never occur
456 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
463 if( !__myself.searchStatusOK )
465 // if called explicitly takes precedence
466 clearTimeout(__myself.bytargetTimer);
467 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
469 [ { "command": "bytarget", "session": __myself.sessionID } ],
471 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
472 var targetNodes = data.getElementsByTagName("target");
473 var bytarget = new Array();
474 for ( i = 0; i < targetNodes.length; i++) {
475 bytarget[i] = new Array();
476 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
477 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
478 var nodeName = targetNodes[i].childNodes[j].nodeName;
479 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
480 bytarget[i][nodeName] = nodeText;
485 __myself.bytargetCounter++;
486 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
487 if ( __myself.activeClients > 0 )
488 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
490 __myself.bytargetCallback(bytarget);
493 // if it gets here the http return code was 200 (pz2 errors are 417)
494 // but the response was invalid, it should never occur
495 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
499 // just for testing, probably shouldn't be here
500 showNext: function(page)
502 var step = page || 1;
503 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
505 showPrev: function(page)
507 if (__myself.currentStart == 0 )
509 var step = page || 1;
510 var newStart = __myself.currentStart - (step * __myself.currentNum );
511 __myself.show( newStart > 0 ? newStart : 0 );
513 showPage: function(pageNum)
515 //var page = pageNum || 1;
516 __myself.show(pageNum * __myself.currentNum);
521 *********************************************************************************
522 ** AJAX HELPER CLASS ************************************************************
523 *********************************************************************************
525 var pzHttpRequest = function ( url, errorHandler ) {
528 this.errorHandler = errorHandler || null;
531 if ( window.XMLHttpRequest ) {
532 this.request = new XMLHttpRequest();
533 } else if ( window.ActiveXObject ) {
535 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
537 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
542 pzHttpRequest.prototype =
544 get: function ( params, callback )
546 this._send( 'GET', params, null, callback );
549 post: function ( params, data, callback )
551 this._send( 'POST', params, data, callback );
554 _send: function ( type, params, data, callback )
556 this.callback = callback;
558 this.request.open( type, this._urlAppendParams(params), this.async );
559 //this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
560 this.request.onreadystatechange = function () {
561 context._handleResponse();
563 this.request.send(data);
566 _urlAppendParams: function (params)
568 var getUrl = this.url;
571 for (var i = 0; i < params.length; i++) {
573 for (var key in el) {
574 if (el[key] != null) {
575 getUrl += sep + key + '=' + encodeURI(el[key]);
583 _handleResponse: function ()
585 if ( this.request.readyState == 4 ) {
586 if ( this.request.status == 200 ) {
587 this.callback( this.request.responseXML );
590 else if ( this.request.status == 417 ) {
591 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
592 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
594 var err = new Error(errMsg);
597 if (this.errorHandler) {
598 this.errorHandler(err);
605 var err = new Error("XMLHttpRequest error. STATUS: "
606 + this.request.status + " STATUS TEXT: "
607 + this.request.statusText );
610 if (this.errorHandler) {
611 this.errorHandler(err);
622 *********************************************************************************
623 ** QUERY CLASS ******************************************************************
624 *********************************************************************************
626 var pzQuery = function()
628 this.simpleQuery = '';
629 this.singleFilter = null;
630 this.advTerms = new Array();
631 this.filterHash = new Array();
635 pzQuery.prototype = {
638 this.simpleQuery = '';
639 this.advTerms = new Array();
640 this.simpleFilter = null;
643 clearSimpleQuery: function()
645 this.simpleQuery = '';
647 addTerm: function(field, value)
649 var term = {"field": field, "value": value};
650 this.advTerms[this.numTerms] = term;
653 getTermValueByIdx: function(index)
655 return this.advTerms[index].value;
657 getTermFieldByIdx: function(index)
659 return this.advTerms[index].field;
661 /* semicolon separated list of terms for given field*/
662 getTermsByField: function(field)
665 for(var i = 0; i < this.advTerms.length; i++)
667 if( this.advTerms[i].field == field )
668 terms = terms + this.queryHas[i].value + ';';
672 addTermsFromList: function(inputString, field)
674 var inputArr = inputString.split(';');
675 for(var i=0; i < inputArr.length; i++)
677 if(inputArr[i].length < 3) continue;
678 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
682 removeTermByIdx: function(index)
684 this.advTerms.splice(index, 1);
690 if( this.simpleQuery != '')
691 ccl = this.simpleQuery;
692 for(var i = 0; i < this.advTerms.length; i++)
694 if (ccl != '') ccl = ccl + ' and ';
695 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
699 addFilter: function(name, value)
701 var filter = {"name": name, "id": value };
702 this.filterHash[this.filterHash.length] = filter;
704 return this.filterHash.length - 1;
706 setFilter: function(name, value)
708 this.filterHash = new Array();
710 this.addFilter(name, value);
712 getFilter: function(index)
714 return this.filterHash[index].id;
716 getFilterName: function(index)
718 return this.filterHash[index].name;
720 removeFilter: function(index)
722 delete this.filterHash[index];
725 clearFilter: function()
727 this.filterHash = new Array();
730 getFilterString: function()
733 if( this.singleFilter != null ) {
734 return 'pz:id='+this.singleFilter.id;
736 else if( this.filterNums <= 0 ) {
740 var filter = 'pz:id=';
741 for(var i = 0; i < this.filterHash.length; i++)
743 if (this.filterHash[i] == undefined) continue;
744 if (filter > 'pz:id=') filter = filter + '|';
745 filter += this.filterHash[i].id;
749 totalLength: function()
751 var simpleLength = this.simpleQuery != '' ? 1 : 0;
752 return this.advTerms.length + simpleLength;
754 clearSingleFilter: function()
756 this.singleFilter = null;
758 setSingleFilter: function(name, value)
760 this.singleFilter = {"name": name, "id": value };
762 getSingleFilterName: function()
764 return this.singleFilter.name;