2 ** $Id: pz2.js,v 1.34 2007-06-13 16:07:43 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 // 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 = "search.pz2";
34 __myself.stylesheet = paramArray.detailstylesheet || null;
36 //load stylesheet if required in async mode
37 if( __myself.stylesheet ) {
38 var request = new pzHttpRequest( __myself.stylesheet );
42 __myself.xslDoc = doc;
47 // at least one callback required
49 throw new Error("An array with parameters has to be suplied when instantiating a class");
51 __myself.errorHandler = paramArray.errorhandler || null;
54 __myself.statCallback = paramArray.onstat || null;
55 __myself.showCallback = paramArray.onshow || null;
56 __myself.termlistCallback = paramArray.onterm || null;
57 __myself.recordCallback = paramArray.onrecord || null;
58 __myself.bytargetCallback = paramArray.onbytarget || null;
59 __myself.resetCallback = paramArray.onreset || null;
62 __myself.termKeys = paramArray.termlist || "subject";
64 // some configurational stuff
65 __myself.keepAlive = 50000;
67 __myself.sessionID = null;
68 __myself.initStatusOK = false;
69 __myself.pingStatusOK = false;
70 __myself.searchStatusOK = false;
72 if ( paramArray.keepAlive < __myself.keepAlive )
73 __myself.keepAlive = paramArray.keepAlive;
76 __myself.currentSort = "relevance";
78 __myself.currentStart = 0;
79 __myself.currentNum = 20;
81 // last full record retrieved
82 __myself.currRecID = null;
84 __myself.currQuery = null;
87 __myself.statTime = paramArray.stattime || 1000;
88 __myself.statTimer = null;
89 __myself.termTime = paramArray.termtime || 1000;
90 __myself.termTimer = null;
91 __myself.showTime = paramArray.showtime || 1000;
92 __myself.showTimer = null;
93 __myself.showFastCount = 4;
94 __myself.bytargetTime = paramArray.bytargettime || 1000;
95 __myself.bytargetTimer = null;
97 // counters for each command and applied delay
98 __myself.dumpFactor = 500;
99 __myself.showCounter = 0;
100 __myself.termCounter = 0;
101 __myself.statCounter = 0;
102 __myself.bytargetCounter = 0;
104 // active clients, updated by stat and show
105 // might be an issue since bytarget will poll accordingly
106 __myself.activeClients = 1;
108 // auto init session?
109 if (paramArray.autoInit !== false)
115 __myself.sessionID = null;
116 __myself.initStatusOK = false;
117 __myself.pingStatusOK = false;
118 __myself.searchStatusOK = false;
120 clearTimeout(__myself.statTimer);
121 clearTimeout(__myself.showTimer);
122 clearTimeout(__myself.termTimer);
123 clearTimeout(__myself.bytargetTimer);
125 if ( __myself.resetCallback )
126 __myself.resetCallback();
128 init: function ( sessionId )
131 if ( sessionId != undefined ) {
132 __myself.initStatusOK = true;
133 __myself.sessionID = sessionId;
137 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
139 { "command": "init" },
141 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
142 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
143 throw new Error("Server's protocol not supported by the client");
144 __myself.initStatusOK = true;
145 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
146 setTimeout("__myself.ping()", __myself.keepAlive);
149 // if it gets here the http return code was 200 (pz2 errors are 417)
150 // but the response was invalid, it should never occur
151 setTimeout("__myself.init()", 1000);
156 // no need to ping explicitly
159 if( !__myself.initStatusOK )
161 // session is not initialized code here
162 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
164 { "command": "ping", "session": __myself.sessionID },
166 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
167 __myself.pingStatusOK = true;
168 setTimeout("__myself.ping()", __myself.keepAlive);
171 // if it gets here the http return code was 200 (pz2 errors are 417)
172 // but the response was invalid, it should never occur
173 setTimeout("__myself.ping()", 1000);
177 search: function (query, num, sort, filter)
179 clearTimeout(__myself.statTimer);
180 clearTimeout(__myself.showTimer);
181 clearTimeout(__myself.termTimer);
182 clearTimeout(__myself.bytargetTimer);
184 __myself.showCounter = 0;
185 __myself.termCounter = 0;
186 __myself.bytargetCounter = 0;
187 __myself.statCounter = 0;
189 if( !__myself.initStatusOK )
192 if( query !== undefined )
193 __myself.currQuery = query;
195 throw new Error("You need to supply query to the search command");
197 if( filter !== undefined )
198 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
200 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
201 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
205 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
206 __myself.searchStatusOK = true;
208 __myself.show(0, num, sort);
209 if ( __myself.statCallback )
211 //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
212 if ( __myself.termlistCallback )
214 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
215 if ( __myself.bytargetCallback )
217 //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
220 // if it gets here the http return code was 200 (pz2 errors are 417)
221 // but the response was invalid, it should never occur
222 setTimeout("__myself.search(__myself.currQuery)", 500);
228 if( !__myself.initStatusOK )
230 // if called explicitly takes precedence
231 clearTimeout(__myself.statTimer);
232 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
234 { "command": "stat", "session": __myself.sessionID },
236 if ( data.getElementsByTagName("stat") ) {
237 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
238 __myself.activeClients = activeClients;
240 "activeclients": activeClients,
241 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
242 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
243 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
244 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
245 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
246 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
247 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
248 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
249 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
252 __myself.statCounter++;
253 var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
254 if ( activeClients > 0 )
255 __myself.statTimer = setTimeout("__myself.stat()", delay);
257 __myself.statCallback(stat);
260 // if it gets here the http return code was 200 (pz2 errors are 417)
261 // but the response was invalid, it should never occur
262 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
266 show: function(start, num, sort)
268 if( !__myself.searchStatusOK )
270 // if called explicitly takes precedence
271 clearTimeout(__myself.showTimer);
273 if( sort !== undefined )
274 __myself.currentSort = sort;
275 if( start !== undefined )
276 __myself.currentStart = Number( start );
277 if( num !== undefined )
278 __myself.currentNum = Number( num );
279 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
282 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
283 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
285 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
286 // first parse the status data send along with records
287 // this is strictly bound to the format
288 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
289 __myself.activeClients = activeClients;
291 "activeclients": activeClients,
292 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
293 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
294 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
295 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
298 // parse all the first-level nodes for all <hit> tags
299 var hits = data.getElementsByTagName("hit");
300 var hit = new Array();
301 for (i = 0; i < hits.length; i++) {
302 show.hits[i] = new Array();
303 show.hits[i]['location'] = new Array();
304 for ( j = 0; j < hits[i].childNodes.length; j++) {
306 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
307 if (hits[i].childNodes[j].nodeName == 'location') {
308 var locNode = hits[i].childNodes[j];
309 var id = locNode.getAttribute('id');
310 show.hits[i]['location'][id] = {
311 "id": locNode.getAttribute("id"),
312 "name": locNode.getAttribute("name")
316 var nodeName = hits[i].childNodes[j].nodeName;
317 var nodeText = 'ERROR'
318 if ( hits[i].childNodes[j].firstChild )
319 nodeText = hits[i].childNodes[j].firstChild.nodeValue;
320 show.hits[i][nodeName] = nodeText;
325 __myself.showCounter++;
326 var delay = __myself.showTime;
327 if (__myself.showCounter > __myself.showFastCount)
328 delay += __myself.showCounter * __myself.dumpFactor;
329 if ( activeClients > 0 )
330 __myself.showTimer = setTimeout("__myself.show()", delay);
332 __myself.showCallback(show);
335 // if it gets here the http return code was 200 (pz2 errors are 417)
336 // but the response was invalid, it should never occur
337 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
343 if( !__myself.searchStatusOK )
346 if( id !== undefined )
347 __myself.currRecID = id;
348 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
350 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
353 var record = new Array();
354 if ( recordNode = data.getElementsByTagName("record")[0] ) {
355 // if stylesheet was fetched do not parse the response
356 if ( __myself.xslDoc ) {
357 record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue;
358 record['xmlDoc'] = data;
359 record['xslDoc'] = __myself.xslDoc;
361 for ( i = 0; i < recordNode.childNodes.length; i++) {
362 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
363 && recordNode.childNodes[i].nodeName != 'location' ) {
364 var nodeName = recordNode.childNodes[i].nodeName;
365 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
366 record[nodeName] = nodeText;
369 // the location might be empty!!
370 var locationNodes = recordNode.getElementsByTagName("location");
371 record["location"] = new Array();
372 for ( i = 0; i < locationNodes.length; i++ ) {
373 record["location"][i] = {
374 "id": locationNodes[i].getAttribute("id"),
375 "name": locationNodes[i].getAttribute("name")
378 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
379 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
380 var nodeName = locationNodes[i].childNodes[j].nodeName;
382 if (locationNodes[i].childNodes[j].firstChild)
383 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
384 record["location"][i][nodeName] = nodeText;
390 __myself.recordCallback(record);
393 // if it gets here the http return code was 200 (pz2 errors are 417)
394 // but the response was invalid, it should never occur
395 setTimeout("__myself.record(__myself.currRecID)", 500);
401 if( !__myself.searchStatusOK )
403 // if called explicitly takes precedence
404 clearTimeout(__myself.termTimer);
405 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
407 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
409 if ( data.getElementsByTagName("termlist") ) {
410 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
411 __myself.activeClients = activeClients;
412 var termList = { "activeclients": activeClients };
413 var termLists = data.getElementsByTagName("list");
415 for (i = 0; i < termLists.length; i++) {
416 var listName = termLists[i].getAttribute('name');
417 termList[listName] = new Array();
418 var terms = termLists[i].getElementsByTagName('term');
419 //for each term in the list
420 for (j = 0; j < terms.length; j++) {
422 "name": (terms[j].getElementsByTagName("name")[0].childNodes.length
423 ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue
425 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR'
428 var termIdNode = terms[j].getElementsByTagName("id");
429 if(terms[j].getElementsByTagName("id").length)
430 term["id"] = termIdNode[0].childNodes[0].nodeValue;
432 termList[listName][j] = term;
436 __myself.termCounter++;
437 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
438 if ( activeClients > 0 )
439 __myself.termTimer = setTimeout("__myself.termlist()", delay);
441 __myself.termlistCallback(termList);
444 // if it gets here the http return code was 200 (pz2 errors are 417)
445 // but the response was invalid, it should never occur
446 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
453 if( !__myself.searchStatusOK )
455 // if called explicitly takes precedence
456 clearTimeout(__myself.bytargetTimer);
457 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
459 { "command": "bytarget", "session": __myself.sessionID },
461 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
462 var targetNodes = data.getElementsByTagName("target");
463 var bytarget = new Array();
464 for ( i = 0; i < targetNodes.length; i++) {
465 bytarget[i] = new Array();
466 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
467 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
468 var nodeName = targetNodes[i].childNodes[j].nodeName;
469 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
470 bytarget[i][nodeName] = nodeText;
475 __myself.bytargetCounter++;
476 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
477 if ( __myself.activeClients > 0 )
478 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
480 __myself.bytargetCallback(bytarget);
483 // if it gets here the http return code was 200 (pz2 errors are 417)
484 // but the response was invalid, it should never occur
485 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
489 // just for testing, probably shouldn't be here
490 showNext: function(page)
492 var step = page || 1;
493 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
495 showPrev: function(page)
497 if (__myself.currentStart == 0 )
499 var step = page || 1;
500 var newStart = __myself.currentStart - (step * __myself.currentNum );
501 __myself.show( newStart > 0 ? newStart : 0 );
503 showPage: function(pageNum)
505 //var page = pageNum || 1;
506 __myself.show(pageNum * __myself.currentNum);
511 *********************************************************************************
512 ** AJAX HELPER CLASS ************************************************************
513 *********************************************************************************
515 var pzHttpRequest = function ( url, errorHandler ) {
518 this.errorHandler = errorHandler || null;
521 if ( window.XMLHttpRequest ) {
522 this.request = new XMLHttpRequest();
523 } else if ( window.ActiveXObject ) {
525 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
527 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
532 pzHttpRequest.prototype =
534 get: function ( params, callback )
536 this._send( 'GET', params, null, callback );
539 post: function ( params, data, callback )
541 this._send( 'POST', params, data, callback );
544 _send: function ( type, params, data, callback )
546 this.callback = callback;
548 this.request.open( type, this._urlAppendParams(params), this.async );
549 //this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
550 this.request.onreadystatechange = function () {
551 context._handleResponse();
553 this.request.send(data);
556 _urlAppendParams: function (params)
558 var getUrl = this.url;
559 var paramArr = new Array();
561 for ( var key in params ) {
562 paramArr.push(key + '=' + encodeURI(params[key]) );
565 if ( paramArr.length )
566 getUrl += '?' + paramArr.join('&');
571 _handleResponse: function ()
573 if ( this.request.readyState == 4 ) {
574 if ( this.request.status == 200 ) {
575 this.callback( this.request.responseXML );
578 else if ( this.request.status == 417 ) {
579 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
580 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
582 var err = new Error(errMsg);
585 if (this.errorHandler) {
586 this.errorHandler(err);
593 var err = new Error("XMLHttpRequest error. STATUS: "
594 + this.request.status + " STATUS TEXT: "
595 + this.request.statusText );
598 if (this.errorHandler) {
599 this.errorHandler(err);
610 *********************************************************************************
611 ** QUERY CLASS ******************************************************************
612 *********************************************************************************
614 var pzQuery = function()
616 this.simpleQuery = '';
617 this.singleFilter = null;
618 this.advTerms = new Array();
619 this.filterHash = new Array();
623 pzQuery.prototype = {
626 this.simpleQuery = '';
627 this.advTerms = new Array();
628 this.simpleFilter = null;
631 addTerm: function(field, value)
633 var term = {"field": field, "value": value};
634 this.advTerms[this.numTerms] = term;
637 getTermValueByIdx: function(index)
639 return this.advTerms[index].value;
641 getTermFieldByIdx: function(index)
643 return this.advTerms[index].field;
645 /* semicolon separated list of terms for given field*/
646 getTermsByField: function(field)
649 for(var i = 0; i < this.advTerms.length; i++)
651 if( this.advTerms[i].field == field )
652 terms = terms + this.queryHas[i].value + ';';
656 addTermsFromList: function(inputString, field)
658 var inputArr = inputString.split(';');
659 for(var i=0; i < inputArr.length; i++)
661 if(inputArr[i].length < 3) continue;
662 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
666 removeTermByIdx: function(index)
668 this.advTerms.splice(index, 1);
674 if( this.simpleQuery != '')
675 ccl = this.simpleQuery;
676 for(var i = 0; i < this.advTerms.length; i++)
678 if (ccl != '') ccl = ccl + ' and ';
679 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
683 addFilter: function(name, value)
685 var filter = {"name": name, "id": value };
686 this.filterHash[this.filterHash.length] = filter;
688 return this.filterHash.length - 1;
690 setFilter: function(name, value)
692 this.filterHash = new Array();
694 this.addFilter(name, value);
696 getFilter: function(index)
698 return this.filterHash[index].id;
700 getFilterName: function(index)
702 return this.filterHash[index].name;
704 removeFilter: function(index)
706 delete this.filterHash[index];
709 clearFilter: function()
711 this.filterHash = new Array();
714 getFilterString: function()
717 if( this.singleFilter != null ) {
718 return 'pz:id='+this.singleFilter.id;
720 else if( this.filterNums <= 0 ) {
724 var filter = 'pz:id=';
725 for(var i = 0; i < this.filterHash.length; i++)
727 if (this.filterHash[i] == undefined) continue;
728 if (filter > 'pz:id=') filter = filter + '|';
729 filter += this.filterHash[i].id;
733 totalLength: function()
735 var simpleLength = this.simpleQuery != '' ? 1 : 0;
736 return this.advTerms.length + simpleLength;
738 clearSingleFilter: function()
740 this.singleFilter = null;
742 setSingleFilter: function(name, value)
744 this.singleFilter = {"name": name, "id": value };
746 getSingleFilterName: function()
748 return this.singleFilter.name;