2 ** $Id: pz2.js,v 1.21 2007-05-23 09:18:10 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 = hits[i].childNodes[j].firstChild.nodeValue;
318 show.hits[i][nodeName] = nodeText;
323 __myself.showCounter++;
324 var delay = __myself.showTime;
325 if (__myself.showCounter > __myself.showFastCount)
326 delay += __myself.showCounter * __myself.dumpFactor;
327 if ( activeClients > 0 )
328 __myself.showTimer = setTimeout("__myself.show()", delay);
330 __myself.showCallback(show);
333 // if it gets here the http return code was 200 (pz2 errors are 417)
334 // but the response was invalid, it should never occur
335 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
341 if( !__myself.searchStatusOK )
344 if( id !== undefined )
345 __myself.currRecID = id;
346 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
348 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
351 var record = new Array();
352 if ( recordNode = data.getElementsByTagName("record")[0] ) {
353 // if stylesheet was fetched do not parse the response
354 if ( __myself.xslDoc ) {
355 record['xmlDoc'] = data;
356 record['xslDoc'] = __myself.xslDoc;
358 for ( i = 0; i < recordNode.childNodes.length; i++) {
359 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
360 && recordNode.childNodes[i].nodeName != 'location' ) {
361 var nodeName = recordNode.childNodes[i].nodeName;
362 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
363 record[nodeName] = nodeText;
366 // the location might be empty!!
367 var locationNodes = recordNode.getElementsByTagName("location");
368 record["location"] = new Array();
369 for ( i = 0; i < locationNodes.length; i++ ) {
370 record["location"][i] = {
371 "id": locationNodes[i].getAttribute("id"),
372 "name": locationNodes[i].getAttribute("name")
375 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
376 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
377 var nodeName = locationNodes[i].childNodes[j].nodeName;
379 if (locationNodes[i].childNodes[j].firstChild)
380 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
381 record["location"][i][nodeName] = nodeText;
387 __myself.recordCallback(record);
390 // if it gets here the http return code was 200 (pz2 errors are 417)
391 // but the response was invalid, it should never occur
392 setTimeout("__myself.record(__myself.currRecID)", 500);
398 if( !__myself.searchStatusOK )
400 // if called explicitly takes precedence
401 clearTimeout(__myself.termTimer);
402 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
404 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
406 if ( data.getElementsByTagName("termlist") ) {
407 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
408 __myself.activeClients = activeClients;
409 var termList = { "activeclients": activeClients };
410 var termLists = data.getElementsByTagName("list");
412 for (i = 0; i < termLists.length; i++) {
413 var listName = termLists[i].getAttribute('name');
414 termList[listName] = new Array();
415 var terms = termLists[i].getElementsByTagName('term');
416 //for each term in the list
417 for (j = 0; j < terms.length; j++) {
419 "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue,
420 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue
423 var termIdNode = terms[j].getElementsByTagName("id");
424 if(terms[j].getElementsByTagName("id").length)
425 term["id"] = termIdNode[0].childNodes[0].nodeValue;
427 termList[listName][j] = term;
431 __myself.termCounter++;
432 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
433 if ( activeClients > 0 )
434 __myself.termTimer = setTimeout("__myself.termlist()", delay);
436 __myself.termlistCallback(termList);
439 // if it gets here the http return code was 200 (pz2 errors are 417)
440 // but the response was invalid, it should never occur
441 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
448 if( !__myself.searchStatusOK )
450 // if called explicitly takes precedence
451 clearTimeout(__myself.bytargetTimer);
452 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
454 { "command": "bytarget", "session": __myself.sessionID },
456 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
457 var targetNodes = data.getElementsByTagName("target");
458 var bytarget = new Array();
459 for ( i = 0; i < targetNodes.length; i++) {
460 bytarget[i] = new Array();
461 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
462 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
463 var nodeName = targetNodes[i].childNodes[j].nodeName;
464 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
465 bytarget[i][nodeName] = nodeText;
470 __myself.bytargetCounter++;
471 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
472 if ( __myself.activeClients > 0 )
473 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
475 __myself.bytargetCallback(bytarget);
478 // if it gets here the http return code was 200 (pz2 errors are 417)
479 // but the response was invalid, it should never occur
480 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
484 // just for testing, probably shouldn't be here
485 showNext: function(page)
487 var step = page || 1;
488 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
490 showPrev: function(page)
492 if (__myself.currentStart == 0 )
494 var step = page || 1;
495 var newStart = __myself.currentStart - (step * __myself.currentNum );
496 __myself.show( newStart > 0 ? newStart : 0 );
498 showPage: function(pageNum)
500 //var page = pageNum || 1;
501 __myself.show(pageNum * __myself.currentNum);
506 *********************************************************************************
507 ** AJAX HELPER CLASS ************************************************************
508 *********************************************************************************
510 var pzHttpRequest = function ( url, errorHandler ) {
513 this.errorHandler = errorHandler || null;
515 if ( window.XMLHttpRequest ) {
516 this.request = new XMLHttpRequest();
517 } else if ( window.ActiveXObject ) {
519 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
521 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
526 pzHttpRequest.prototype =
528 get: function ( params, callback )
530 this.callback = callback;
532 var getUrl = this.url;
533 var paramArr = new Array();
535 for ( var key in params ) {
536 paramArr.push(key + '=' + params[key] );
539 if ( paramArr.length )
540 getUrl += '?' + paramArr.join('&');
543 this.request.open( 'GET', getUrl, true );
544 this.request.onreadystatechange = function () {
545 context._handleResponse();
547 this.request.send(null);
550 _handleResponse: function ()
552 if ( this.request.readyState == 4 ) {
553 if ( this.request.status == 200 ) {
554 this.callback( this.request.responseXML );
557 else if ( this.request.status == 417 ) {
558 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
559 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
561 var err = new Error(errMsg);
564 if (this.errorHandler) {
565 this.errorHandler(err);
572 var err = new Error("XMLHttpRequest error. STATUS: "
573 + this.request.status + " STATUS TEXT: "
574 + this.request.statusText );
577 if (this.errorHandler) {
578 this.errorHandler(err);
589 *********************************************************************************
590 ** QUERY CLASS ******************************************************************
591 *********************************************************************************
593 var pzQuery = function()
595 this.simpleQuery = '';
596 this.singleFilter = null;
597 this.advTerms = new Array();
598 this.filterHash = new Array();
602 pzQuery.prototype = {
605 this.simpleQuery = '';
606 this.advTerms = new Array();
607 this.simpleFilter = null;
610 addTerm: function(field, value)
612 var term = {"field": field, "value": value};
613 this.advTerms[this.numTerms] = term;
616 getTermValueByIdx: function(index)
618 return this.advTerms[index].value;
620 getTermFieldByIdx: function(index)
622 return this.advTerms[index].field;
624 /* semicolon separated list of terms for given field*/
625 getTermsByField: function(field)
628 for(var i = 0; i < this.advTerms.length; i++)
630 if( this.advTerms[i].field == field )
631 terms = terms + this.queryHas[i].value + ';';
635 addTermsFromList: function(inputString, field)
637 var inputArr = inputString.split(';');
638 for(var i=0; i < inputArr.length; i++)
640 if(inputArr[i].length < 3) continue;
641 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
645 removeTermByIdx: function(index)
647 this.advTerms.splice(index, 1);
653 if( this.simpleQuery != '')
654 ccl = '"'+this.simpleQuery+'"';
655 for(var i = 0; i < this.advTerms.length; i++)
657 if (ccl != '') ccl = ccl + ' and ';
658 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
662 addFilter: function(name, value)
664 var filter = {"name": name, "id": value };
665 this.filterHash[this.filterHash.length] = filter;
667 return this.filterHash.length - 1;
669 setFilter: function(name, value)
671 this.filterHash = new Array();
673 this.addFilter(name, value);
675 getFilter: function(index)
677 return this.filterHash[index].id;
679 getFilterName: function(index)
681 return this.filterHash[index].name;
683 removeFilter: function(index)
685 delete this.filterHash[index];
688 clearFilter: function()
690 this.filterHash = new Array();
693 getFilterString: function()
696 if( this.singleFilter != null ) {
697 return 'pz:id='+this.singleFilter.id;
699 else if( this.filterNums <= 0 ) {
703 var filter = 'pz:id=';
704 for(var i = 0; i < this.filterHash.length; i++)
706 if (this.filterHash[i] == undefined) continue;
707 if (filter > 'pz:id=') filter = filter + '|';
708 filter += this.filterHash[i].id;
712 totalLength: function()
714 var simpleLength = this.simpleQuery != '' ? 1 : 0;
715 return this.advTerms.length + simpleLength;
717 clearSingleFilter: function()
719 this.singleFilter = null;
721 setSingleFilter: function(name, value)
723 this.singleFilter = {"name": name, "id": value };
725 getSingleFilterName: function()
727 return this.singleFilter.name;