2 ** $Id: pz2.js,v 1.70 2008-03-12 11:36:57 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 )
30 // at least one callback required
32 throw new Error("Pz2.js: Array with parameters has to be suplied.");
34 //supported pazpar2's protocol version
35 this.suppProtoVer = '1';
36 if (typeof paramArray.pazpar2path != "undefined")
37 this.pz2String = paramArray.pazpar2path;
39 this.pz2String = "/pazpar2/search.pz2";
40 this.useSessions = true;
42 this.stylesheet = paramArray.detailstylesheet || null;
43 //load stylesheet if required in async mode
44 if( this.stylesheet ) {
46 var request = new pzHttpRequest( this.stylesheet );
47 request.get( {}, function ( doc ) { context.xslDoc = doc; } );
50 this.errorHandler = paramArray.errorhandler || null;
53 this.initCallback = paramArray.oninit || null;
54 this.statCallback = paramArray.onstat || null;
55 this.showCallback = paramArray.onshow || null;
56 this.termlistCallback = paramArray.onterm || null;
57 this.recordCallback = paramArray.onrecord || null;
58 this.bytargetCallback = paramArray.onbytarget || null;
59 this.resetCallback = paramArray.onreset || null;
62 this.termKeys = paramArray.termlist || "subject";
64 // some configurational stuff
65 this.keepAlive = 50000;
67 if ( paramArray.keepAlive < this.keepAlive )
68 this.keepAlive = paramArray.keepAlive;
70 this.sessionID = null;
71 this.initStatusOK = false;
72 this.pingStatusOK = false;
73 this.searchStatusOK = false;
76 this.currentSort = "relevance";
79 this.currentStart = 0;
82 // last full record retrieved
83 this.currRecID = null;
86 this.currQuery = null;
88 //current raw record offset
89 this.currRecOffset = null;
92 this.statTime = paramArray.stattime || 1000;
93 this.statTimer = null;
94 this.termTime = paramArray.termtime || 1000;
95 this.termTimer = null;
96 this.showTime = paramArray.showtime || 1000;
97 this.showTimer = null;
98 this.showFastCount = 4;
99 this.bytargetTime = paramArray.bytargettime || 1000;
100 this.bytargetTimer = null;
102 // counters for each command and applied delay
103 this.dumpFactor = 500;
104 this.showCounter = 0;
105 this.termCounter = 0;
106 this.statCounter = 0;
107 this.bytargetCounter = 0;
109 // active clients, updated by stat and show
110 // might be an issue since bytarget will poll accordingly
111 this.activeClients = 1;
113 // if in proxy mode no need to init
114 if (paramArray.usesessions != undefined) {
115 this.useSessions = paramArray.usesessions;
116 this.initStatusOK = true;
118 // else, auto init session or wait for a user init?
119 if (this.useSessions && paramArray.autoInit !== false) {
126 //error handler for async error throws
127 throwError: function (errMsg, errCode)
129 var err = new Error(errMsg);
130 if (errCode) err.code = errCode;
132 if (this.errorHandler) {
133 this.errorHandler(err);
140 // stop activity by clearing tiemouts
143 clearTimeout(this.statTimer);
144 clearTimeout(this.showTimer);
145 clearTimeout(this.termTimer);
146 clearTimeout(this.bytargetTimer);
149 // reset status variables
152 if ( this.useSessions ) {
153 this.sessionID = null;
154 this.initStatusOK = false;
155 this.pingStatusOK = false;
157 this.searchStatusOK = false;
160 if ( this.resetCallback )
161 this.resetCallback();
164 init: function ( sessionId )
168 // session id as a param
169 if ( sessionId != undefined && this.useSessions ) {
170 this.initStatusOK = true;
171 this.sessionID = sessionId;
173 // old school direct pazpar2 init
174 } else if (this.useSessions) {
176 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
178 { "command": "init" },
180 if ( data.getElementsByTagName("status")[0]
181 .childNodes[0].nodeValue == "OK" ) {
182 if ( data.getElementsByTagName("protocol")[0]
183 .childNodes[0].nodeValue
184 != context.suppProtoVer )
186 "Server's protocol not supported by the client"
188 context.initStatusOK = true;
190 data.getElementsByTagName("session")[0]
191 .childNodes[0].nodeValue;
198 if ( context.initCallback )
199 context.initCallback();
202 context.throwError('Init failed. Malformed WS resonse.',
206 // when through proxy no need to init
208 this.initStatusOK = true;
211 // no need to ping explicitly
214 // pinging only makes sense when using pazpar2 directly
215 if( !this.initStatusOK || !this.useSessions )
217 'Pz2.js: Ping not allowed (proxy mode) or session not initialized.'
220 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
222 { "command": "ping", "session": this.sessionID },
224 if ( data.getElementsByTagName("status")[0]
225 .childNodes[0].nodeValue == "OK" ) {
226 context.pingStatusOK = true;
235 context.throwError('Ping failed. Malformed WS resonse.',
240 search: function (query, num, sort, filter, showfrom, addParamsArr)
242 clearTimeout(this.statTimer);
243 clearTimeout(this.showTimer);
244 clearTimeout(this.termTimer);
245 clearTimeout(this.bytargetTimer);
247 this.showCounter = 0;
248 this.termCounter = 0;
249 this.bytargetCounter = 0;
250 this.statCounter = 0;
253 if( !this.initStatusOK )
254 throw new Error('Pz2.js: session not initialized.');
256 if( query !== undefined )
257 this.currQuery = query;
259 throw new Error("Pz2.js: no query supplied to the search command.");
261 if ( showfrom !== undefined )
262 var start = showfrom;
268 "query": this.currQuery,
269 "session": this.sessionID
272 if (filter !== undefined)
273 searchParams["filter"] = filter;
275 // copy additional parmeters, do not overwrite
276 if (addParamsArr != undefined) {
277 for (var prop in addParamsArr) {
278 if (!searchParams.hasOwnProperty(prop))
279 searchParams[prop] = addParamsArr[prop];
284 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
288 if ( data.getElementsByTagName("status")[0]
289 .childNodes[0].nodeValue == "OK" ) {
290 context.searchStatusOK = true;
292 context.show(start, num, sort);
293 if ( context.statCallback )
295 if ( context.termlistCallback )
297 if ( context.bytargetCallback )
301 context.throwError('Search failed. Malformed WS resonse.',
308 if( !this.initStatusOK )
309 throw new Error('Pz2.js: session not initialized.');
311 // if called explicitly takes precedence
312 clearTimeout(this.statTimer);
315 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
317 { "command": "stat", "session": this.sessionID },
319 if ( data.getElementsByTagName("stat") ) {
321 Number( data.getElementsByTagName("activeclients")[0]
322 .childNodes[0].nodeValue );
323 context.activeClients = activeClients;
325 "activeclients": activeClients,
327 Number( data.getElementsByTagName("hits")[0]
328 .childNodes[0].nodeValue ),
330 Number( data.getElementsByTagName("records")[0]
331 .childNodes[0].nodeValue ),
333 Number( data.getElementsByTagName("clients")[0]
334 .childNodes[0].nodeValue ),
336 Number( data.getElementsByTagName("unconnected")[0]
337 .childNodes[0].nodeValue ),
339 Number( data.getElementsByTagName("connecting")[0]
340 .childNodes[0].nodeValue ),
342 Number( data.getElementsByTagName("working")[0]
343 .childNodes[0].nodeValue ),
345 Number( data.getElementsByTagName("idle")[0]
346 .childNodes[0].nodeValue ),
348 Number( data.getElementsByTagName("failed")[0]
349 .childNodes[0].nodeValue ),
351 Number( data.getElementsByTagName("error")[0]
352 .childNodes[0].nodeValue )
355 context.statCounter++;
356 var delay = context.statTime
357 + context.statCounter * context.dumpFactor;
359 if ( activeClients > 0 )
367 context.statCallback(stat);
370 context.throwError('Stat failed. Malformed WS resonse.',
375 show: function(start, num, sort)
377 if( !this.searchStatusOK && this.useSessions )
379 'Pz2.js: show command has to be preceded with a search command.'
382 // if called explicitly takes precedence
383 clearTimeout(this.showTimer);
385 if( sort !== undefined )
386 this.currentSort = sort;
387 if( start !== undefined )
388 this.currentStart = Number( start );
389 if( num !== undefined )
390 this.currentNum = Number( num );
393 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
397 "session": this.sessionID,
398 "start": this.currentStart,
399 "num": this.currentNum,
400 "sort": this.currentSort,
404 if ( data.getElementsByTagName("status")[0]
405 .childNodes[0].nodeValue == "OK" ) {
406 // first parse the status data send along with records
407 // this is strictly bound to the format
409 Number( data.getElementsByTagName("activeclients")[0]
410 .childNodes[0].nodeValue );
411 context.activeClients = activeClients;
413 "activeclients": activeClients,
415 Number( data.getElementsByTagName("merged")[0]
416 .childNodes[0].nodeValue ),
418 Number( data.getElementsByTagName("total")[0]
419 .childNodes[0].nodeValue ),
421 Number( data.getElementsByTagName("start")[0]
422 .childNodes[0].nodeValue ),
424 Number( data.getElementsByTagName("num")[0]
425 .childNodes[0].nodeValue ),
428 // parse all the first-level nodes for all <hit> tags
429 var hits = data.getElementsByTagName("hit");
430 for (i = 0; i < hits.length; i++)
431 show.hits[i] = Element_parseChildNodes(hits[i]);
433 context.showCounter++;
434 var delay = context.showTime;
435 if (context.showCounter > context.showFastCount)
436 delay += context.showCounter * context.dumpFactor;
437 if ( activeClients > 0 )
438 context.showTimer = setTimeout(
444 context.showCallback(show);
447 context.throwError('Show failed. Malformed WS resonse.',
452 record: function(id, offset, syntax, handler)
454 // we may call record with no previous search if in proxy mode
455 if(!this.searchStatusOK && this.useSessions)
457 'Pz2.js: record command has to be preceded with a search command.'
460 if( id !== undefined )
465 "session": this.sessionID,
469 this.currRecOffset = null;
470 if (offset != undefined) {
471 recordParams["offset"] = offset;
472 this.currRecOffset = offset;
475 if (syntax != undefined)
476 recordParams['syntax'] = syntax;
478 //overwrite default callback id needed
479 var callback = this.recordCallback;
480 var args = undefined;
481 if (handler != undefined) {
482 callback = handler['callback'];
483 args = handler['args'];
487 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
495 if (context.currRecOffset !== null) {
496 record = new Array();
497 record['xmlDoc'] = data;
498 record['offset'] = context.currRecOffset;
499 callback(record, args);
501 } else if ( recordNode =
502 data.getElementsByTagName("record")[0] ) {
503 // if stylesheet was fetched do not parse the response
504 if ( context.xslDoc ) {
505 record = new Array();
506 record['xmlDoc'] = data;
507 record['xslDoc'] = context.xslDoc;
509 recordNode.getElementsByTagName("recid")[0]
510 .firstChild.nodeValue;
513 record = Element_parseChildNodes(recordNode);
515 callback(record, args);
518 context.throwError('Record failed. Malformed WS resonse.',
526 if( !this.searchStatusOK && this.useSessions )
528 'Pz2.js: termlist command has to be preceded with a search command.'
531 // if called explicitly takes precedence
532 clearTimeout(this.termTimer);
535 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
538 "command": "termlist",
539 "session": this.sessionID,
540 "name": this.termKeys
543 if ( data.getElementsByTagName("termlist") ) {
545 Number( data.getElementsByTagName("activeclients")[0]
546 .childNodes[0].nodeValue );
547 context.activeClients = activeClients;
548 var termList = { "activeclients": activeClients };
549 var termLists = data.getElementsByTagName("list");
551 for (i = 0; i < termLists.length; i++) {
552 var listName = termLists[i].getAttribute('name');
553 termList[listName] = new Array();
554 var terms = termLists[i].getElementsByTagName('term');
555 //for each term in the list
556 for (j = 0; j < terms.length; j++) {
559 (terms[j].getElementsByTagName("name")[0]
561 ? terms[j].getElementsByTagName("name")[0]
562 .childNodes[0].nodeValue
566 .getElementsByTagName("frequency")[0]
567 .childNodes[0].nodeValue || 'ERROR'
571 terms[j].getElementsByTagName("id");
572 if(terms[j].getElementsByTagName("id").length)
574 termIdNode[0].childNodes[0].nodeValue;
575 termList[listName][j] = term;
579 context.termCounter++;
580 var delay = context.termTime
581 + context.termCounter * context.dumpFactor;
582 if ( activeClients > 0 )
591 context.termlistCallback(termList);
594 context.throwError('Termlist failed. Malformed WS resonse.',
602 if( !this.initStatusOK && this.useSessions )
604 'Pz2.js: bytarget command has to be preceded with a search command.'
607 // no need to continue
608 if( !this.searchStatusOK )
611 // if called explicitly takes precedence
612 clearTimeout(this.bytargetTimer);
615 var request = new pzHttpRequest(this.pz2String, this.errorHandler);
617 { "command": "bytarget", "session": this.sessionID },
619 if ( data.getElementsByTagName("status")[0]
620 .childNodes[0].nodeValue == "OK" ) {
621 var targetNodes = data.getElementsByTagName("target");
622 var bytarget = new Array();
623 for ( i = 0; i < targetNodes.length; i++) {
624 bytarget[i] = new Array();
625 for( j = 0; j < targetNodes[i].childNodes.length; j++ ) {
626 if ( targetNodes[i].childNodes[j].nodeType
627 == Node.ELEMENT_NODE ) {
629 targetNodes[i].childNodes[j].nodeName;
631 targetNodes[i].childNodes[j]
632 .firstChild.nodeValue;
633 bytarget[i][nodeName] = nodeText;
638 context.bytargetCounter++;
639 var delay = context.bytargetTime
640 + context.bytargetCounter * context.dumpFactor;
641 if ( context.activeClients > 0 )
642 context.bytargetTimer =
650 context.bytargetCallback(bytarget);
653 context.throwError('Bytarget failed. Malformed WS resonse.',
659 // just for testing, probably shouldn't be here
660 showNext: function(page)
662 var step = page || 1;
663 this.show( ( step * this.currentNum ) + this.currentStart );
666 showPrev: function(page)
668 if (this.currentStart == 0 )
670 var step = page || 1;
671 var newStart = this.currentStart - (step * this.currentNum );
672 this.show( newStart > 0 ? newStart : 0 );
675 showPage: function(pageNum)
677 //var page = pageNum || 1;
678 this.show(pageNum * this.currentNum);
683 ********************************************************************************
684 ** AJAX HELPER CLASS ***********************************************************
685 ********************************************************************************
687 var pzHttpRequest = function ( url, errorHandler ) {
688 this.maxUrlLength = 2048;
691 this.errorHandler = errorHandler || null;
693 this.requestHeaders = {};
695 if ( window.XMLHttpRequest ) {
696 this.request = new XMLHttpRequest();
697 } else if ( window.ActiveXObject ) {
699 this.request = new ActiveXObject( 'Msxml2.XMLHTTP' );
701 this.request = new ActiveXObject( 'Microsoft.XMLHTTP' );
706 pzHttpRequest.prototype =
708 safeGet: function ( params, callback )
710 var encodedParams = this.encodeParams(params);
711 var url = this._urlAppendParams(encodedParams);
712 if (url.length >= this.maxUrlLength) {
713 this.requestHeaders["Content-Type"]
714 = "application/x-www-form-urlencoded";
715 this._send( 'POST', this.url, encodedParams, callback );
717 this._send( 'GET', url, '', callback );
721 get: function ( params, callback )
723 this._send( 'GET', this._urlAppendParams(this.encodeParams(params)),
727 post: function ( params, data, callback )
729 this._send( 'POST', this._urlAppendParams(this.encodeParams(params)),
736 this.request.open( 'GET', this.url, this.async );
737 this.request.send('');
738 if ( this.request.status == 200 )
739 return this.request.responseXML;
742 encodeParams: function (params)
746 for (var key in params) {
747 if (params[key] != null) {
748 encoded += sep + key + '=' + encodeURIComponent(params[key]);
755 _send: function ( type, url, data, callback)
758 this.callback = callback;
760 this.request.open( type, url, this.async );
761 for (var key in this.requestHeaders)
762 this.request.setRequestHeader(key, this.requestHeaders[key]);
763 this.request.onreadystatechange = function () {
764 context._handleResponse();
766 this.request.send(data);
769 _urlAppendParams: function (encodedParams)
772 return this.url + "?" + encodedParams;
777 _handleResponse: function ()
779 if ( this.request.readyState == 4 ) {
780 // pick up appplication errors first
782 if (this.request.responseXML &&
783 (errNode = this.request.responseXML.documentElement)
784 && errNode.nodeName == 'error') {
785 var errMsg = errNode.getAttribute("msg");
786 var errCode = errNode.getAttribute("code");
788 if (errNode.childNodes.length)
789 errAddInfo = ': ' + errNode.childNodes[0].nodeValue;
791 var err = new Error(errMsg + errAddInfo);
794 if (this.errorHandler) {
795 this.errorHandler(err);
800 } else if (this.request.status == 200) {
801 this.callback(this.request.responseXML);
803 var err = new Error("HTTP response not OK: "
804 + this.request.status + " - "
805 + this.request.statusText );
806 err.code = '00' + this.request.status;
808 if (this.errorHandler) {
809 this.errorHandler(err);
820 ********************************************************************************
821 ** XML HELPER FUNCTIONS ********************************************************
822 ********************************************************************************
827 if ( window.ActiveXObject) {
828 var DOMDoc = document;
830 var DOMDoc = Document.prototype;
833 DOMDoc.newXmlDoc = function ( root )
837 if (document.implementation && document.implementation.createDocument) {
838 doc = document.implementation.createDocument('', root, null);
839 } else if ( window.ActiveXObject ) {
840 doc = new ActiveXObject("MSXML2.DOMDocument");
841 doc.loadXML('<' + root + '/>');
843 throw new Error ('No XML support in this browser');
850 DOMDoc.parseXmlFromString = function ( xmlString )
854 if ( window.DOMParser ) {
855 var parser = new DOMParser();
856 doc = parser.parseFromString( xmlString, "text/xml");
857 } else if ( window.ActiveXObject ) {
858 doc = new ActiveXObject("MSXML2.DOMDocument");
859 doc.loadXML( xmlString );
861 throw new Error ("No XML parsing support in this browser.");
867 DOMDoc.transformToDoc = function (xmlDoc, xslDoc)
869 if ( window.XSLTProcessor ) {
870 var proc = new XSLTProcessor();
871 proc.importStylesheet( xslDoc );
872 return proc.transformToDocument(xmlDoc);
873 } else if ( window.ActiveXObject ) {
874 return document.parseXmlFromString(xmlDoc.transformNode(xslDoc));
876 alert( 'Unable to perform XSLT transformation in this browser' );
882 Element_removeFromDoc = function (DOM_Element)
884 DOM_Element.parentNode.removeChild(DOM_Element);
887 Element_emptyChildren = function (DOM_Element)
889 while( DOM_Element.firstChild ) {
890 DOM_Element.removeChild( DOM_Element.firstChild )
894 Element_appendTransformResult = function ( DOM_Element, xmlDoc, xslDoc )
896 if ( window.XSLTProcessor ) {
897 var proc = new XSLTProcessor();
898 proc.importStylesheet( xslDoc );
900 docFrag = proc.transformToFragment( xmlDoc, DOM_Element.ownerDocument );
901 DOM_Element.appendChild(docFrag);
902 } else if ( window.ActiveXObject ) {
903 DOM_Element.innerHTML = xmlDoc.transformNode( xslDoc );
905 alert( 'Unable to perform XSLT transformation in this browser' );
909 Element_appendTextNode = function (DOM_Element, tagName, textContent )
911 var node = DOM_Element.ownerDocument.createElement(tagName);
912 var text = DOM_Element.ownerDocument.createTextNode(textContent);
914 DOM_Element.appendChild(node);
915 node.appendChild(text);
920 Element_setTextContent = function ( DOM_Element, textContent )
922 if (typeof DOM_Element.textContent !== "undefined") {
923 DOM_Element.textContent = textContent;
924 } else if (typeof DOM_Element.innerText !== "undefined" ) {
925 DOM_Element.innerText = textContent;
927 throw new Error("Cannot set text content of the node, no such method.");
931 Element_getTextContent = function (DOM_Element)
933 if ( typeof DOM_Element.textContent != 'undefined' ) {
934 return DOM_Element.textContent;
935 } else if (typeof DOM_Element.text != 'undefined') {
936 return DOM_Element.text;
938 throw new Error("Cannot get text content of the node, no such method.");
942 Element_parseChildNodes = function (node)
945 var hasChildElems = false;
947 if (node.hasChildNodes()) {
948 var children = node.childNodes;
949 for (var i = 0; i < children.length; i++) {
950 var child = children[i];
951 if (child.nodeType == Node.ELEMENT_NODE) {
952 hasChildElems = true;
953 var nodeName = child.nodeName;
954 if (!(nodeName in parsed))
955 parsed[nodeName] = [];
956 parsed[nodeName].push(Element_parseChildNodes(child));
961 var attrs = node.attributes;
962 for (var i = 0; i < attrs.length; i++) {
963 var attrName = '@' + attrs[i].nodeName;
964 var attrValue = attrs[i].nodeValue;
965 parsed[attrName] = attrValue;
968 // if no nested elements, get text content
969 if (node.hasChildNodes() && !hasChildElems) {
970 if (node.attributes.length)
971 parsed['textContent'] = node.firstChild.nodeValue;
973 parsed = node.firstChild.nodeValue;
979 /* do not remove trailing bracket */