2 ** $Id: pz2.js,v 1.33 2007-06-05 15:19:25 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 clearTimeout(__myself.statTimer);
116 clearTimeout(__myself.showTimer);
117 clearTimeout(__myself.termTimer);
118 clearTimeout(__myself.bytargetTimer);
122 __myself.sessionID = null;
123 __myself.initStatusOK = false;
124 __myself.pingStatusOK = false;
125 __myself.searchStatusOK = false;
129 if ( __myself.resetCallback )
130 __myself.resetCallback();
132 init: function ( sessionId )
135 if ( sessionId != undefined ) {
136 __myself.initStatusOK = true;
137 __myself.sessionID = sessionId;
141 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
143 { "command": "init" },
145 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
146 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
147 throw new Error("Server's protocol not supported by the client");
148 __myself.initStatusOK = true;
149 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
150 setTimeout("__myself.ping()", __myself.keepAlive);
153 // if it gets here the http return code was 200 (pz2 errors are 417)
154 // but the response was invalid, it should never occur
155 setTimeout("__myself.init()", 1000);
160 // no need to ping explicitly
163 if( !__myself.initStatusOK )
165 // session is not initialized code here
166 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
168 { "command": "ping", "session": __myself.sessionID },
170 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
171 __myself.pingStatusOK = true;
172 setTimeout("__myself.ping()", __myself.keepAlive);
175 // if it gets here the http return code was 200 (pz2 errors are 417)
176 // but the response was invalid, it should never occur
177 setTimeout("__myself.ping()", 1000);
181 search: function (query, num, sort, filter)
183 clearTimeout(__myself.statTimer);
184 clearTimeout(__myself.showTimer);
185 clearTimeout(__myself.termTimer);
186 clearTimeout(__myself.bytargetTimer);
188 __myself.showCounter = 0;
189 __myself.termCounter = 0;
190 __myself.bytargetCounter = 0;
191 __myself.statCounter = 0;
193 if( !__myself.initStatusOK )
196 if( query !== undefined )
197 __myself.currQuery = query;
199 throw new Error("You need to supply query to the search command");
201 if( filter !== undefined )
202 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
204 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
205 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
209 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
210 __myself.searchStatusOK = true;
212 __myself.show(0, num, sort);
213 if ( __myself.statCallback )
215 //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
216 if ( __myself.termlistCallback )
218 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
219 if ( __myself.bytargetCallback )
221 //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
224 // if it gets here the http return code was 200 (pz2 errors are 417)
225 // but the response was invalid, it should never occur
226 setTimeout("__myself.search(__myself.currQuery)", 500);
232 if( !__myself.initStatusOK )
234 // if called explicitly takes precedence
235 clearTimeout(__myself.statTimer);
236 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
238 { "command": "stat", "session": __myself.sessionID },
240 if ( data.getElementsByTagName("stat") ) {
241 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
242 __myself.activeClients = activeClients;
244 "activeclients": activeClients,
245 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
246 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
247 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
248 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
249 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
250 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
251 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
252 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
253 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
256 __myself.statCounter++;
257 var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
258 if ( activeClients > 0 )
259 __myself.statTimer = setTimeout("__myself.stat()", delay);
261 __myself.statCallback(stat);
264 // if it gets here the http return code was 200 (pz2 errors are 417)
265 // but the response was invalid, it should never occur
266 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
270 show: function(start, num, sort)
272 if( !__myself.searchStatusOK )
274 // if called explicitly takes precedence
275 clearTimeout(__myself.showTimer);
277 if( sort !== undefined )
278 __myself.currentSort = sort;
279 if( start !== undefined )
280 __myself.currentStart = Number( start );
281 if( num !== undefined )
282 __myself.currentNum = Number( num );
283 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
286 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
287 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
289 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
290 // first parse the status data send along with records
291 // this is strictly bound to the format
292 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
293 __myself.activeClients = activeClients;
295 "activeclients": activeClients,
296 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
297 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
298 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
299 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
302 // parse all the first-level nodes for all <hit> tags
303 var hits = data.getElementsByTagName("hit");
304 var hit = new Array();
305 for (i = 0; i < hits.length; i++) {
306 show.hits[i] = new Array();
307 show.hits[i]['location'] = new Array();
308 for ( j = 0; j < hits[i].childNodes.length; j++) {
310 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
311 if (hits[i].childNodes[j].nodeName == 'location') {
312 var locNode = hits[i].childNodes[j];
313 var id = locNode.getAttribute('id');
314 show.hits[i]['location'][id] = {
315 "id": locNode.getAttribute("id"),
316 "name": locNode.getAttribute("name")
320 var nodeName = hits[i].childNodes[j].nodeName;
321 var nodeText = 'ERROR'
322 if ( hits[i].childNodes[j].firstChild )
323 nodeText = hits[i].childNodes[j].firstChild.nodeValue;
324 show.hits[i][nodeName] = nodeText;
329 __myself.showCounter++;
330 var delay = __myself.showTime;
331 if (__myself.showCounter > __myself.showFastCount)
332 delay += __myself.showCounter * __myself.dumpFactor;
333 if ( activeClients > 0 )
334 __myself.showTimer = setTimeout("__myself.show()", delay);
336 __myself.showCallback(show);
339 // if it gets here the http return code was 200 (pz2 errors are 417)
340 // but the response was invalid, it should never occur
341 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
347 if( !__myself.searchStatusOK )
350 if( id !== undefined )
351 __myself.currRecID = id;
352 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
354 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
357 var record = new Array();
358 if ( recordNode = data.getElementsByTagName("record")[0] ) {
359 // if stylesheet was fetched do not parse the response
360 if ( __myself.xslDoc ) {
361 record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue;
362 record['xmlDoc'] = data;
363 record['xslDoc'] = __myself.xslDoc;
365 for ( i = 0; i < recordNode.childNodes.length; i++) {
366 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
367 && recordNode.childNodes[i].nodeName != 'location' ) {
368 var nodeName = recordNode.childNodes[i].nodeName;
369 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
370 record[nodeName] = nodeText;
373 // the location might be empty!!
374 var locationNodes = recordNode.getElementsByTagName("location");
375 record["location"] = new Array();
376 for ( i = 0; i < locationNodes.length; i++ ) {
377 record["location"][i] = {
378 "id": locationNodes[i].getAttribute("id"),
379 "name": locationNodes[i].getAttribute("name")
382 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
383 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
384 var nodeName = locationNodes[i].childNodes[j].nodeName;
386 if (locationNodes[i].childNodes[j].firstChild)
387 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
388 record["location"][i][nodeName] = nodeText;
394 __myself.recordCallback(record);
397 // if it gets here the http return code was 200 (pz2 errors are 417)
398 // but the response was invalid, it should never occur
399 setTimeout("__myself.record(__myself.currRecID)", 500);
405 if( !__myself.searchStatusOK )
407 // if called explicitly takes precedence
408 clearTimeout(__myself.termTimer);
409 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
411 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys, "block": "1" },
413 if ( data.getElementsByTagName("termlist") ) {
414 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
415 __myself.activeClients = activeClients;
416 var termList = { "activeclients": activeClients };
417 var termLists = data.getElementsByTagName("list");
419 for (i = 0; i < termLists.length; i++) {
420 var listName = termLists[i].getAttribute('name');
421 termList[listName] = new Array();
422 var terms = termLists[i].getElementsByTagName('term');
423 //for each term in the list
424 for (j = 0; j < terms.length; j++) {
426 "name": (terms[j].getElementsByTagName("name")[0].childNodes.length
427 ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue
429 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR'
432 var termIdNode = terms[j].getElementsByTagName("id");
433 if(terms[j].getElementsByTagName("id").length)
434 term["id"] = termIdNode[0].childNodes[0].nodeValue;
436 termList[listName][j] = term;
440 __myself.termCounter++;
441 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
442 if ( activeClients > 0 )
443 __myself.termTimer = setTimeout("__myself.termlist()", delay);
445 __myself.termlistCallback(termList);
448 // if it gets here the http return code was 200 (pz2 errors are 417)
449 // but the response was invalid, it should never occur
450 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
457 if( !__myself.searchStatusOK )
459 // if called explicitly takes precedence
460 clearTimeout(__myself.bytargetTimer);
461 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
463 { "command": "bytarget", "session": __myself.sessionID },
465 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
466 var targetNodes = data.getElementsByTagName("target");
467 var bytarget = new Array();
468 for ( i = 0; i < targetNodes.length; i++) {
469 bytarget[i] = new Array();
470 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
471 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
472 var nodeName = targetNodes[i].childNodes[j].nodeName;
473 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
474 bytarget[i][nodeName] = nodeText;
479 __myself.bytargetCounter++;
480 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
481 if ( __myself.activeClients > 0 )
482 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
484 __myself.bytargetCallback(bytarget);
487 // if it gets here the http return code was 200 (pz2 errors are 417)
488 // but the response was invalid, it should never occur
489 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
493 // just for testing, probably shouldn't be here
494 showNext: function(page)
496 var step = page || 1;
497 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
499 showPrev: function(page)
501 if (__myself.currentStart == 0 )
503 var step = page || 1;
504 var newStart = __myself.currentStart - (step * __myself.currentNum );
505 __myself.show( newStart > 0 ? newStart : 0 );
507 showPage: function(pageNum)
509 //var page = pageNum || 1;
510 __myself.show(pageNum * __myself.currentNum);
515 *********************************************************************************
516 ** AJAX HELPER CLASS ************************************************************
517 *********************************************************************************
519 var pzHttpRequest = function ( url, errorHandler ) {
522 this.errorHandler = errorHandler || null;
524 if ( window.XMLHttpRequest ) {
525 this.request = new XMLHttpRequest();
526 } else if ( window.ActiveXObject ) {
528 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
530 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
535 pzHttpRequest.prototype =
537 get: function ( params, callback )
539 this.callback = callback;
541 var getUrl = this.url;
542 var paramArr = new Array();
544 for ( var key in params ) {
545 paramArr.push(key + '=' + encodeURI(params[key]) );
548 if ( paramArr.length )
549 getUrl += '?' + paramArr.join('&');
552 this.request.open( 'GET', getUrl, true );
553 this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8');
554 //this.request.setRequestHeader('Accept-Charset', 'UTF-8');
555 this.request.onreadystatechange = function () {
556 context._handleResponse();
558 this.request.send(null);
561 _handleResponse: function ()
563 if ( this.request.readyState == 4 ) {
564 if ( this.request.status == 200 ) {
565 this.callback( this.request.responseXML );
568 else if ( this.request.status == 417 ) {
569 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
570 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
572 var err = new Error(errMsg);
575 if (this.errorHandler) {
576 this.errorHandler(err);
583 var err = new Error("XMLHttpRequest error. STATUS: "
584 + this.request.status + " STATUS TEXT: "
585 + this.request.statusText );
588 if (this.errorHandler) {
589 this.errorHandler(err);
600 *********************************************************************************
601 ** QUERY CLASS ******************************************************************
602 *********************************************************************************
604 var pzQuery = function()
606 this.simpleQuery = '';
607 this.singleFilter = null;
608 this.advTerms = new Array();
609 this.filterHash = new Array();
613 pzQuery.prototype = {
614 clearSimpleQuery: function()
616 this.simpleQuery = '';
620 this.simpleQuery = '';
621 this.advTerms = new Array();
622 this.simpleFilter = null;
625 addTerm: function(field, value)
627 var term = {"field": field, "value": value};
628 this.advTerms[this.numTerms] = term;
631 getTermValueByIdx: function(index)
633 return this.advTerms[index].value;
635 getTermFieldByIdx: function(index)
637 return this.advTerms[index].field;
639 /* semicolon separated list of terms for given field*/
640 getTermsByField: function(field)
643 for(var i = 0; i < this.advTerms.length; i++)
645 if( this.advTerms[i].field == field )
646 terms = terms + this.queryHas[i].value + ';';
650 addTermsFromList: function(inputString, field)
652 var inputArr = inputString.split(';');
653 for(var i=0; i < inputArr.length; i++)
655 if(inputArr[i].length < 3) continue;
656 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
660 removeTermByIdx: function(index)
662 this.advTerms.splice(index, 1);
668 if( this.simpleQuery != '')
669 ccl = this.simpleQuery;
670 for(var i = 0; i < this.advTerms.length; i++)
672 if (ccl != '') ccl = ccl + ' and ';
673 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
677 addFilter: function(name, value)
679 var filter = {"name": name, "id": value };
680 this.filterHash[this.filterHash.length] = filter;
682 return this.filterHash.length - 1;
684 setFilter: function(name, value)
686 this.filterHash = new Array();
688 this.addFilter(name, value);
690 getFilter: function(index)
692 return this.filterHash[index].id;
694 getFilterName: function(index)
696 return this.filterHash[index].name;
698 removeFilter: function(index)
700 delete this.filterHash[index];
703 clearFilter: function()
705 this.filterHash = new Array();
708 getFilterString: function()
711 if( this.singleFilter != null ) {
712 return 'pz:id='+this.singleFilter.id;
714 else if( this.filterNums <= 0 ) {
718 var filter = 'pz:id=';
719 for(var i = 0; i < this.filterHash.length; i++)
721 if (this.filterHash[i] == undefined) continue;
722 if (filter > 'pz:id=') filter = filter + '|';
723 filter += this.filterHash[i].id;
727 totalLength: function()
729 var simpleLength = this.simpleQuery != '' ? 1 : 0;
730 return this.advTerms.length + simpleLength;
732 clearSingleFilter: function()
734 this.singleFilter = null;
736 setSingleFilter: function(name, value)
738 this.singleFilter = {"name": name, "id": value };
740 getSingleFilterName: function()
742 return this.singleFilter.name;