2 ** $Id: pz2.js,v 1.36 2007-06-13 17:25:02 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)
116 clearTimeout(__myself.statTimer);
117 clearTimeout(__myself.showTimer);
118 clearTimeout(__myself.termTimer);
119 clearTimeout(__myself.bytargetTimer);
124 __myself.sessionID = null;
125 __myself.initStatusOK = false;
126 __myself.pingStatusOK = false;
127 __myself.searchStatusOK = false;
131 if ( __myself.resetCallback )
132 __myself.resetCallback();
134 init: function ( sessionId )
137 if ( sessionId != undefined ) {
138 __myself.initStatusOK = true;
139 __myself.sessionID = sessionId;
143 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
145 { "command": "init" },
147 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
148 if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer )
149 throw new Error("Server's protocol not supported by the client");
150 __myself.initStatusOK = true;
151 __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
152 setTimeout("__myself.ping()", __myself.keepAlive);
155 // if it gets here the http return code was 200 (pz2 errors are 417)
156 // but the response was invalid, it should never occur
157 setTimeout("__myself.init()", 1000);
162 // no need to ping explicitly
165 if( !__myself.initStatusOK )
167 // session is not initialized code here
168 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
170 { "command": "ping", "session": __myself.sessionID },
172 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
173 __myself.pingStatusOK = true;
174 setTimeout("__myself.ping()", __myself.keepAlive);
177 // if it gets here the http return code was 200 (pz2 errors are 417)
178 // but the response was invalid, it should never occur
179 setTimeout("__myself.ping()", 1000);
183 search: function (query, num, sort, filter)
185 clearTimeout(__myself.statTimer);
186 clearTimeout(__myself.showTimer);
187 clearTimeout(__myself.termTimer);
188 clearTimeout(__myself.bytargetTimer);
190 __myself.showCounter = 0;
191 __myself.termCounter = 0;
192 __myself.bytargetCounter = 0;
193 __myself.statCounter = 0;
195 if( !__myself.initStatusOK )
198 if( query !== undefined )
199 __myself.currQuery = query;
201 throw new Error("You need to supply query to the search command");
203 if( filter !== undefined )
204 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter };
206 var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery };
207 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
211 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
212 __myself.searchStatusOK = true;
214 __myself.show(0, num, sort);
215 if ( __myself.statCallback )
217 //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
218 if ( __myself.termlistCallback )
220 //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
221 if ( __myself.bytargetCallback )
223 //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
226 // if it gets here the http return code was 200 (pz2 errors are 417)
227 // but the response was invalid, it should never occur
228 setTimeout("__myself.search(__myself.currQuery)", 500);
234 if( !__myself.initStatusOK )
236 // if called explicitly takes precedence
237 clearTimeout(__myself.statTimer);
238 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
240 { "command": "stat", "session": __myself.sessionID },
242 if ( data.getElementsByTagName("stat") ) {
243 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
244 __myself.activeClients = activeClients;
246 "activeclients": activeClients,
247 "hits": Number( data.getElementsByTagName("hits")[0].childNodes[0].nodeValue ),
248 "records": Number( data.getElementsByTagName("records")[0].childNodes[0].nodeValue ),
249 "clients": Number( data.getElementsByTagName("clients")[0].childNodes[0].nodeValue ),
250 "initializing": Number( data.getElementsByTagName("initializing")[0].childNodes[0].nodeValue ),
251 "searching": Number( data.getElementsByTagName("searching")[0].childNodes[0].nodeValue ),
252 "presenting": Number( data.getElementsByTagName("presenting")[0].childNodes[0].nodeValue ),
253 "idle": Number( data.getElementsByTagName("idle")[0].childNodes[0].nodeValue ),
254 "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ),
255 "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue )
258 __myself.statCounter++;
259 var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
260 if ( activeClients > 0 )
261 __myself.statTimer = setTimeout("__myself.stat()", delay);
263 __myself.statCallback(stat);
266 // if it gets here the http return code was 200 (pz2 errors are 417)
267 // but the response was invalid, it should never occur
268 __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
272 show: function(start, num, sort)
274 if( !__myself.searchStatusOK )
276 // if called explicitly takes precedence
277 clearTimeout(__myself.showTimer);
279 if( sort !== undefined )
280 __myself.currentSort = sort;
281 if( start !== undefined )
282 __myself.currentStart = Number( start );
283 if( num !== undefined )
284 __myself.currentNum = Number( num );
285 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
288 { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart,
289 "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 },
291 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
292 // first parse the status data send along with records
293 // this is strictly bound to the format
294 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
295 __myself.activeClients = activeClients;
297 "activeclients": activeClients,
298 "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ),
299 "total": Number( data.getElementsByTagName("total")[0].childNodes[0].nodeValue ),
300 "start": Number( data.getElementsByTagName("start")[0].childNodes[0].nodeValue ),
301 "num": Number( data.getElementsByTagName("num")[0].childNodes[0].nodeValue ),
304 // parse all the first-level nodes for all <hit> tags
305 var hits = data.getElementsByTagName("hit");
306 var hit = new Array();
307 for (i = 0; i < hits.length; i++) {
308 show.hits[i] = new Array();
309 show.hits[i]['location'] = new Array();
310 for ( j = 0; j < hits[i].childNodes.length; j++) {
312 if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
313 if (hits[i].childNodes[j].nodeName == 'location') {
314 var locNode = hits[i].childNodes[j];
315 var id = locNode.getAttribute('id');
316 show.hits[i]['location'][id] = {
317 "id": locNode.getAttribute("id"),
318 "name": locNode.getAttribute("name")
322 var nodeName = hits[i].childNodes[j].nodeName;
323 var nodeText = 'ERROR'
324 if ( hits[i].childNodes[j].firstChild )
325 nodeText = hits[i].childNodes[j].firstChild.nodeValue;
326 show.hits[i][nodeName] = nodeText;
331 __myself.showCounter++;
332 var delay = __myself.showTime;
333 if (__myself.showCounter > __myself.showFastCount)
334 delay += __myself.showCounter * __myself.dumpFactor;
335 if ( activeClients > 0 )
336 __myself.showTimer = setTimeout("__myself.show()", delay);
338 __myself.showCallback(show);
341 // if it gets here the http return code was 200 (pz2 errors are 417)
342 // but the response was invalid, it should never occur
343 __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
349 if( !__myself.searchStatusOK )
352 if( id !== undefined )
353 __myself.currRecID = id;
354 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
356 { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID },
359 var record = new Array();
360 if ( recordNode = data.getElementsByTagName("record")[0] ) {
361 // if stylesheet was fetched do not parse the response
362 if ( __myself.xslDoc ) {
363 record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue;
364 record['xmlDoc'] = data;
365 record['xslDoc'] = __myself.xslDoc;
367 for ( i = 0; i < recordNode.childNodes.length; i++) {
368 if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE
369 && recordNode.childNodes[i].nodeName != 'location' ) {
370 var nodeName = recordNode.childNodes[i].nodeName;
371 var nodeText = recordNode.childNodes[i].firstChild.nodeValue;
372 record[nodeName] = nodeText;
375 // the location might be empty!!
376 var locationNodes = recordNode.getElementsByTagName("location");
377 record["location"] = new Array();
378 for ( i = 0; i < locationNodes.length; i++ ) {
379 record["location"][i] = {
380 "id": locationNodes[i].getAttribute("id"),
381 "name": locationNodes[i].getAttribute("name")
384 for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
385 if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
386 var nodeName = locationNodes[i].childNodes[j].nodeName;
388 if (locationNodes[i].childNodes[j].firstChild)
389 nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
390 record["location"][i][nodeName] = nodeText;
396 __myself.recordCallback(record);
399 // if it gets here the http return code was 200 (pz2 errors are 417)
400 // but the response was invalid, it should never occur
401 setTimeout("__myself.record(__myself.currRecID)", 500);
407 if( !__myself.searchStatusOK )
409 // if called explicitly takes precedence
410 clearTimeout(__myself.termTimer);
411 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
413 { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
415 if ( data.getElementsByTagName("termlist") ) {
416 var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue );
417 __myself.activeClients = activeClients;
418 var termList = { "activeclients": activeClients };
419 var termLists = data.getElementsByTagName("list");
421 for (i = 0; i < termLists.length; i++) {
422 var listName = termLists[i].getAttribute('name');
423 termList[listName] = new Array();
424 var terms = termLists[i].getElementsByTagName('term');
425 //for each term in the list
426 for (j = 0; j < terms.length; j++) {
428 "name": (terms[j].getElementsByTagName("name")[0].childNodes.length
429 ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue
431 "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR'
434 var termIdNode = terms[j].getElementsByTagName("id");
435 if(terms[j].getElementsByTagName("id").length)
436 term["id"] = termIdNode[0].childNodes[0].nodeValue;
438 termList[listName][j] = term;
442 __myself.termCounter++;
443 var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor;
444 if ( activeClients > 0 )
445 __myself.termTimer = setTimeout("__myself.termlist()", delay);
447 __myself.termlistCallback(termList);
450 // if it gets here the http return code was 200 (pz2 errors are 417)
451 // but the response was invalid, it should never occur
452 __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
459 if( !__myself.searchStatusOK )
461 // if called explicitly takes precedence
462 clearTimeout(__myself.bytargetTimer);
463 var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
465 { "command": "bytarget", "session": __myself.sessionID },
467 if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
468 var targetNodes = data.getElementsByTagName("target");
469 var bytarget = new Array();
470 for ( i = 0; i < targetNodes.length; i++) {
471 bytarget[i] = new Array();
472 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
473 if ( targetNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
474 var nodeName = targetNodes[i].childNodes[j].nodeName;
475 var nodeText = targetNodes[i].childNodes[j].firstChild.nodeValue;
476 bytarget[i][nodeName] = nodeText;
481 __myself.bytargetCounter++;
482 var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor;
483 if ( __myself.activeClients > 0 )
484 __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay);
486 __myself.bytargetCallback(bytarget);
489 // if it gets here the http return code was 200 (pz2 errors are 417)
490 // but the response was invalid, it should never occur
491 __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
495 // just for testing, probably shouldn't be here
496 showNext: function(page)
498 var step = page || 1;
499 __myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
501 showPrev: function(page)
503 if (__myself.currentStart == 0 )
505 var step = page || 1;
506 var newStart = __myself.currentStart - (step * __myself.currentNum );
507 __myself.show( newStart > 0 ? newStart : 0 );
509 showPage: function(pageNum)
511 //var page = pageNum || 1;
512 __myself.show(pageNum * __myself.currentNum);
517 *********************************************************************************
518 ** AJAX HELPER CLASS ************************************************************
519 *********************************************************************************
521 var pzHttpRequest = function ( url, errorHandler ) {
524 this.errorHandler = errorHandler || null;
527 if ( window.XMLHttpRequest ) {
528 this.request = new XMLHttpRequest();
529 } else if ( window.ActiveXObject ) {
531 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
533 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
538 pzHttpRequest.prototype =
540 get: function ( params, callback )
542 this._send( 'GET', params, null, callback );
545 post: function ( params, data, callback )
547 this._send( 'POST', params, data, callback );
550 _send: function ( type, params, data, callback )
552 this.callback = callback;
554 this.request.open( type, this._urlAppendParams(params), this.async );
555 //this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
556 this.request.onreadystatechange = function () {
557 context._handleResponse();
559 this.request.send(data);
562 _urlAppendParams: function (params)
564 var getUrl = this.url;
565 var paramArr = new Array();
567 for ( var key in params ) {
568 paramArr.push(key + '=' + encodeURI(params[key]) );
571 if ( paramArr.length )
572 getUrl += '?' + paramArr.join('&');
577 _handleResponse: function ()
579 if ( this.request.readyState == 4 ) {
580 if ( this.request.status == 200 ) {
581 this.callback( this.request.responseXML );
584 else if ( this.request.status == 417 ) {
585 var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
586 var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code");
588 var err = new Error(errMsg);
591 if (this.errorHandler) {
592 this.errorHandler(err);
599 var err = new Error("XMLHttpRequest error. STATUS: "
600 + this.request.status + " STATUS TEXT: "
601 + this.request.statusText );
604 if (this.errorHandler) {
605 this.errorHandler(err);
616 *********************************************************************************
617 ** QUERY CLASS ******************************************************************
618 *********************************************************************************
620 var pzQuery = function()
622 this.simpleQuery = '';
623 this.singleFilter = null;
624 this.advTerms = new Array();
625 this.filterHash = new Array();
629 pzQuery.prototype = {
632 this.simpleQuery = '';
633 this.advTerms = new Array();
634 this.simpleFilter = null;
637 clearSimpleQuery: function()
639 this.simpleQuery = '';
641 addTerm: function(field, value)
643 var term = {"field": field, "value": value};
644 this.advTerms[this.numTerms] = term;
647 getTermValueByIdx: function(index)
649 return this.advTerms[index].value;
651 getTermFieldByIdx: function(index)
653 return this.advTerms[index].field;
655 /* semicolon separated list of terms for given field*/
656 getTermsByField: function(field)
659 for(var i = 0; i < this.advTerms.length; i++)
661 if( this.advTerms[i].field == field )
662 terms = terms + this.queryHas[i].value + ';';
666 addTermsFromList: function(inputString, field)
668 var inputArr = inputString.split(';');
669 for(var i=0; i < inputArr.length; i++)
671 if(inputArr[i].length < 3) continue;
672 this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] };
676 removeTermByIdx: function(index)
678 this.advTerms.splice(index, 1);
684 if( this.simpleQuery != '')
685 ccl = this.simpleQuery;
686 for(var i = 0; i < this.advTerms.length; i++)
688 if (ccl != '') ccl = ccl + ' and ';
689 ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"';
693 addFilter: function(name, value)
695 var filter = {"name": name, "id": value };
696 this.filterHash[this.filterHash.length] = filter;
698 return this.filterHash.length - 1;
700 setFilter: function(name, value)
702 this.filterHash = new Array();
704 this.addFilter(name, value);
706 getFilter: function(index)
708 return this.filterHash[index].id;
710 getFilterName: function(index)
712 return this.filterHash[index].name;
714 removeFilter: function(index)
716 delete this.filterHash[index];
719 clearFilter: function()
721 this.filterHash = new Array();
724 getFilterString: function()
727 if( this.singleFilter != null ) {
728 return 'pz:id='+this.singleFilter.id;
730 else if( this.filterNums <= 0 ) {
734 var filter = 'pz:id=';
735 for(var i = 0; i < this.filterHash.length; i++)
737 if (this.filterHash[i] == undefined) continue;
738 if (filter > 'pz:id=') filter = filter + '|';
739 filter += this.filterHash[i].id;
743 totalLength: function()
745 var simpleLength = this.simpleQuery != '' ? 1 : 0;
746 return this.advTerms.length + simpleLength;
748 clearSingleFilter: function()
750 this.singleFilter = null;
752 setSingleFilter: function(name, value)
754 this.singleFilter = {"name": name, "id": value };
756 getSingleFilterName: function()
758 return this.singleFilter.name;