X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=js%2Fpz2.js;h=6d173a9349f7f5710ea257099affa45e1ff10a10;hb=b1d27db97fd80ec83559efd8620a6f641486ec31;hp=ff5ca24238850405097ed91c5ee3dcfda6b38ab2;hpb=514963d836ba78fb09d1c574cf2ea479433e668a;p=pazpar2-moved-to-github.git diff --git a/js/pz2.js b/js/pz2.js index ff5ca24..6d173a9 100644 --- a/js/pz2.js +++ b/js/pz2.js @@ -1,5 +1,5 @@ /* -** $Id: pz2.js,v 1.5 2007-04-03 14:27:21 jakub Exp $ +** $Id: pz2.js,v 1.42 2007-07-02 12:52:03 jakub Exp $ ** pz2.js - pazpar2's javascript client library. */ @@ -19,10 +19,7 @@ if (!window['Node']) { Node.DOCUMENT_FRAGMENT_NODE = 11; Node.NOTATION_NODE = 12; } -// check for jQuery -if(typeof window.jQuery == "undefined"){ - throw new Error("pz2.js requires jQuery library"); -} + // prevent execution of more than once if(typeof window.pz2 == "undefined") { window.undefined = window.undefined; @@ -31,9 +28,32 @@ var pz2 = function(paramArray) { //for convenience __myself = this; + //supported pazpar2's protocol version + __myself.suppProtoVer = '1'; + __myself.pz2String = paramArray.pazpar2path || "search.pz2"; + __myself.stylesheet = paramArray.detailstylesheet || null; + __myself.useSessions = true; + if (paramArray.usesessions != undefined) { + __myself.useSessions = paramArray.usesessions; + } + + //load stylesheet if required in async mode + if( __myself.stylesheet ) { + var request = new pzHttpRequest( __myself.stylesheet ); + request.async = false; + request.get( + [], + function ( doc ) { + __myself.xslDoc = doc; + } + ); + } + // at least one callback required if ( !paramArray ) - throw new Error("An array with parameters has to be suplied when instantiating a class"); + throw new Error("An array with parameters has to be suplied when instantiating a class"); + + __myself.errorHandler = paramArray.errorhandler || null; // function callbacks __myself.statCallback = paramArray.onstat || null; @@ -41,12 +61,12 @@ var pz2 = function(paramArray) { __myself.termlistCallback = paramArray.onterm || null; __myself.recordCallback = paramArray.onrecord || null; __myself.bytargetCallback = paramArray.onbytarget || null; + __myself.resetCallback = paramArray.onreset || null; // termlist keys __myself.termKeys = paramArray.termlist || "subject"; // some configurational stuff - __myself.pz2String = "search.pz2"; __myself.keepAlive = 50000; __myself.sessionID = null; @@ -69,64 +89,91 @@ var pz2 = function(paramArray) { __myself.currQuery = null; //timers - __myself.statTime = paramArray.stattime || 2000; + __myself.statTime = paramArray.stattime || 1000; __myself.statTimer = null; __myself.termTime = paramArray.termtime || 1000; __myself.termTimer = null; __myself.showTime = paramArray.showtime || 1000; __myself.showTimer = null; + __myself.showFastCount = 4; __myself.bytargetTime = paramArray.bytargettime || 1000; __myself.bytargetTimer = null; - //useful? + // counters for each command and applied delay __myself.dumpFactor = 500; __myself.showCounter = 0; __myself.termCounter = 0; + __myself.statCounter = 0; + __myself.bytargetCounter = 0; // active clients, updated by stat and show // might be an issue since bytarget will poll accordingly __myself.activeClients = 1; - - // error handling - $(document).ajaxError( - function (request, settings, exception) { - if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") ) - throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue); - }); // auto init session? if (paramArray.autoInit !== false) - __myself.init(__myself.keepAlive); + __myself.init(); }; -pz2.prototype = { - init: function(keepAlive) +pz2.prototype = +{ + stop: function () + { + clearTimeout(__myself.statTimer); + clearTimeout(__myself.showTimer); + clearTimeout(__myself.termTimer); + clearTimeout(__myself.bytargetTimer); + }, + + reset: function () { - if ( keepAlive < __myself.keepAlive ) - __myself.keepAlive = keepAlive; - - $.get( __myself.pz2String, - { "command": "init" }, - function(data) { - if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) { - __myself.initStatusOK = true; - __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue; - setTimeout(__myself.ping, __myself.keepAlive); + __myself.sessionID = null; + __myself.initStatusOK = false; + __myself.pingStatusOK = false; + __myself.searchStatusOK = false; + + __myself.stop(); + + if ( __myself.resetCallback ) + __myself.resetCallback(); + }, + init: function ( sessionId ) + { + __myself.reset(); + + if ( sessionId != undefined ) { + __myself.initStatusOK = true; + __myself.sessionID = sessionId; + __myself.ping(); + } else if (__myself.useSessions) { + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( + { "command": "init" }, + function(data) { + if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) { + if ( data.getElementsByTagName("protocol")[0].childNodes[0].nodeValue != __myself.suppProtoVer ) + throw new Error("Server's protocol not supported by the client"); + __myself.initStatusOK = true; + __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue; + setTimeout("__myself.ping()", __myself.keepAlive); + } + else + // if it gets here the http return code was 200 (pz2 errors are 417) + // but the response was invalid, it should never occur + setTimeout("__myself.init()", 1000); } - else - // if it gets here the http return code was 200 (pz2 errors are 417) - // but the response was invalid, it should never occur - setTimeout("__myself.init()", 1000); - } - ); + ); + } else { + __myself.initStatusOK = true; + } }, // no need to ping explicitly - ping: function() + ping: function () { if( !__myself.initStatusOK ) return; // session is not initialized code here - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( { "command": "ping", "session": __myself.sessionID }, function(data) { if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) { @@ -140,7 +187,7 @@ pz2.prototype = { } ); }, - search: function(query, num, sort, filter) + search: function (query, num, sort, filter) { clearTimeout(__myself.statTimer); clearTimeout(__myself.showTimer); @@ -149,6 +196,8 @@ pz2.prototype = { __myself.showCounter = 0; __myself.termCounter = 0; + __myself.bytargetCounter = 0; + __myself.statCounter = 0; if( !__myself.initStatusOK ) return; @@ -158,12 +207,13 @@ pz2.prototype = { else throw new Error("You need to supply query to the search command"); - if( filter !== undefined ) - var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery, "filter": filter }; - else - var searchParams = { "command": "search", "session": __myself.sessionID, "query": __myself.currQuery }; - - $.get( __myself.pz2String, + var searchParams = { "command": "search", "query": __myself.currQuery, "session": __myself.sessionID }; + + if (filter !== undefined) + searchParams["filter"] = filter; + + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( searchParams, function(data) { if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) { @@ -171,28 +221,30 @@ pz2.prototype = { //piggyback search __myself.show(0, num, sort); if ( __myself.statCallback ) - __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 2); + __myself.stat(); + //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4); if ( __myself.termlistCallback ) - //__myself.termlist(); - __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 2); + __myself.termlist(); + //__myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4); if ( __myself.bytargetCallback ) - __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 2); + __myself.bytarget(); + //__myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4); } else // if it gets here the http return code was 200 (pz2 errors are 417) // but the response was invalid, it should never occur - setTimeout("__myself.search(__myself.currQuery)", 1000); + setTimeout("__myself.search(__myself.currQuery)", 500); } ); }, stat: function() { - if( !__myself.searchStatusOK ) + if( !__myself.initStatusOK ) return; // if called explicitly takes precedence clearTimeout(__myself.statTimer); - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( { "command": "stat", "session": __myself.sessionID }, function(data) { if ( data.getElementsByTagName("stat") ) { @@ -210,9 +262,13 @@ pz2.prototype = { "failed": Number( data.getElementsByTagName("failed")[0].childNodes[0].nodeValue ), "error": Number( data.getElementsByTagName("error")[0].childNodes[0].nodeValue ) }; + + __myself.statCounter++; + var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor; + if ( activeClients > 0 ) + __myself.statTimer = setTimeout("__myself.stat()", delay); + __myself.statCallback(stat); - if (activeClients > 0) - __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime); } else // if it gets here the http return code was 200 (pz2 errors are 417) @@ -234,8 +290,9 @@ pz2.prototype = { __myself.currentStart = Number( start ); if( num !== undefined ) __myself.currentNum = Number( num ); - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + var context = this; + request.get( { "command": "show", "session": __myself.sessionID, "start": __myself.currentStart, "num": __myself.currentNum, "sort": __myself.currentSort, "block": 1 }, function(data) { @@ -243,6 +300,7 @@ pz2.prototype = { // first parse the status data send along with records // this is strictly bound to the format var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ); + __myself.activeClients = activeClients; var show = { "activeclients": activeClients, "merged": Number( data.getElementsByTagName("merged")[0].childNodes[0].nodeValue ), @@ -256,18 +314,36 @@ pz2.prototype = { var hit = new Array(); for (i = 0; i < hits.length; i++) { show.hits[i] = new Array(); + show.hits[i]['location'] = new Array(); for ( j = 0; j < hits[i].childNodes.length; j++) { + var locCount = 0; if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) { - var nodeName = hits[i].childNodes[j].nodeName; - var nodeText = hits[i].childNodes[j].firstChild.nodeValue; - show.hits[i][nodeName] = nodeText; + if (hits[i].childNodes[j].nodeName == 'location') { + var locNode = hits[i].childNodes[j]; + var id = locNode.getAttribute('id'); + show.hits[i]['location'][id] = { + "id": locNode.getAttribute("id"), + "name": locNode.getAttribute("name") + }; + } + else { + var nodeName = hits[i].childNodes[j].nodeName; + var nodeText = 'ERROR' + if ( hits[i].childNodes[j].firstChild ) + nodeText = hits[i].childNodes[j].firstChild.nodeValue; + show.hits[i][nodeName] = nodeText; + } } } } - __myself.showCallback(show); __myself.showCounter++; - if (activeClients > 0) - __myself.showTimer = setTimeout("__myself.show()", (__myself.showTime + __myself.showCounter*__myself.dumpFactor)); + var delay = __myself.showTime; + if (__myself.showCounter > __myself.showFastCount) + delay += __myself.showCounter * __myself.dumpFactor; + if ( activeClients > 0 ) + __myself.showTimer = setTimeout("__myself.show()", delay); + + __myself.showCallback(show); } else // if it gets here the http return code was 200 (pz2 errors are 417) @@ -283,42 +359,54 @@ pz2.prototype = { if( id !== undefined ) __myself.currRecID = id; - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID }, function(data) { var recordNode; var record = new Array(); if ( recordNode = data.getElementsByTagName("record")[0] ) { - for ( i = 0; i < recordNode.childNodes.length; i++) { - if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE ) { - var nodeName = recordNode.childNodes[i].nodeName; - var nodeText = recordNode.childNodes[i].firstChild.nodeValue; - record[nodeName] = nodeText; + // if stylesheet was fetched do not parse the response + if ( __myself.xslDoc ) { + record['recid'] = recordNode.getElementsByTagName("recid")[0].firstChild.nodeValue; + record['xmlDoc'] = data; + record['xslDoc'] = __myself.xslDoc; + } else { + for ( i = 0; i < recordNode.childNodes.length; i++) { + if ( recordNode.childNodes[i].nodeType == Node.ELEMENT_NODE + && recordNode.childNodes[i].nodeName != 'location' ) { + var nodeName = recordNode.childNodes[i].nodeName; + var nodeText = recordNode.childNodes[i].firstChild.nodeValue; + record[nodeName] = nodeText; + } } - } - // the location is hard coded - var locationNodes = recordNode.getElementsByTagName("location"); - record["location"] = new Array(); - for ( i = 0; i < locationNodes.length; i++ ) { - record["location"][i] = { - "id": locationNodes[i].getAttribute("id"), - "name": locationNodes[i].getAttribute("name") - }; - for ( j = 0; j < locationNodes[i].childNodes.length; j++) { - if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) { - var nodeName = locationNodes[i].childNodes[j].nodeName; - var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue; - record["location"][i][nodeName] = nodeText; + // the location might be empty!! + var locationNodes = recordNode.getElementsByTagName("location"); + record["location"] = new Array(); + for ( i = 0; i < locationNodes.length; i++ ) { + record["location"][i] = { + "id": locationNodes[i].getAttribute("id"), + "name": locationNodes[i].getAttribute("name") + }; + + for ( j = 0; j < locationNodes[i].childNodes.length; j++) { + if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) { + var nodeName = locationNodes[i].childNodes[j].nodeName; + var nodeText = ''; + if (locationNodes[i].childNodes[j].firstChild) + nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue; + record["location"][i][nodeName] = nodeText; + } } } } + __myself.recordCallback(record); } else // if it gets here the http return code was 200 (pz2 errors are 417) // but the response was invalid, it should never occur - setTimeout("__myself.record(__myself.currRecID)", 1000); + setTimeout("__myself.record(__myself.currRecID)", 500); } ); }, @@ -328,12 +416,14 @@ pz2.prototype = { return; // if called explicitly takes precedence clearTimeout(__myself.termTimer); - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( { "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys }, function(data) { if ( data.getElementsByTagName("termlist") ) { - var termList = { "activeclients": Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ) }; + var activeClients = Number( data.getElementsByTagName("activeclients")[0].childNodes[0].nodeValue ); + __myself.activeClients = activeClients; + var termList = { "activeclients": activeClients }; var termLists = data.getElementsByTagName("list"); //for each termlist for (i = 0; i < termLists.length; i++) { @@ -343,8 +433,10 @@ pz2.prototype = { //for each term in the list for (j = 0; j < terms.length; j++) { var term = { - "name": terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue, - "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue + "name": (terms[j].getElementsByTagName("name")[0].childNodes.length + ? terms[j].getElementsByTagName("name")[0].childNodes[0].nodeValue + : 'ERROR'), + "freq": terms[j].getElementsByTagName("frequency")[0].childNodes[0].nodeValue || 'ERROR' }; var termIdNode = terms[j].getElementsByTagName("id"); @@ -355,10 +447,12 @@ pz2.prototype = { } } - __myself.termlistCallback(termList); __myself.termCounter++; - if (termList["activeclients"] > 0) - __myself.termTimer = setTimeout("__myself.termlist()", (__myself.termTime + __myself.termCounter*__myself.dumpFactor)); + var delay = __myself.termTime + __myself.termCounter * __myself.dumpFactor; + if ( activeClients > 0 ) + __myself.termTimer = setTimeout("__myself.termlist()", delay); + + __myself.termlistCallback(termList); } else // if it gets here the http return code was 200 (pz2 errors are 417) @@ -374,8 +468,8 @@ pz2.prototype = { return; // if called explicitly takes precedence clearTimeout(__myself.bytargetTimer); - - $.get( __myself.pz2String, + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); + request.get( { "command": "bytarget", "session": __myself.sessionID }, function(data) { if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) { @@ -391,9 +485,13 @@ pz2.prototype = { } } } - __myself.bytargetCallback(bytarget); + + __myself.bytargetCounter++; + var delay = __myself.bytargetTime + __myself.bytargetCounter * __myself.dumpFactor; if ( __myself.activeClients > 0 ) - __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime); + __myself.bytargetTimer = setTimeout("__myself.bytarget()", delay); + + __myself.bytargetCallback(bytarget); } else // if it gets here the http return code was 200 (pz2 errors are 417) @@ -422,4 +520,251 @@ pz2.prototype = { __myself.show(pageNum * __myself.currentNum); } }; + +/* +********************************************************************************* +** AJAX HELPER CLASS ************************************************************ +********************************************************************************* +*/ +var pzHttpRequest = function ( url, errorHandler ) { + this.request = null; + this.url = url; + this.errorHandler = errorHandler || null; + this.async = true; + + if ( window.XMLHttpRequest ) { + this.request = new XMLHttpRequest(); + } else if ( window.ActiveXObject ) { + try { + this.request = new ActiveXObject( 'Msxml2.XMLHTTP' ); + } catch (err) { + this.request = new ActiveXObject( 'Microsoft.XMLHTTP' ); + } + } +}; + +pzHttpRequest.prototype = +{ + get: function ( params, callback ) + { + this._send( 'GET', params, null, callback ); + }, + + post: function ( params, data, callback ) + { + this._send( 'POST', params, data, callback ); + }, + + _send: function ( type, params, data, callback ) + { + this.callback = callback; + var context = this; + this.request.open( type, this._urlAppendParams(params), this.async ); + //this.request.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); + this.request.onreadystatechange = function () { + context._handleResponse(); + } + this.request.send(data); + }, + + _urlAppendParams: function (params) + { + var getUrl = this.url; + + var sep = '?'; + var el = params; + for (var key in el) { + if (el[key] != null) { + getUrl += sep + key + '=' + encodeURI(el[key]); + sep = '&'; + } + } + return getUrl; + }, + + _handleResponse: function () + { + if ( this.request.readyState == 4 ) { + if ( this.request.status == 200 ) { + this.callback( this.request.responseXML ); + } + // pz errors + else if ( this.request.status == 417 ) { + var errMsg = this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue; + var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code"); + + var err = new Error(errMsg); + err.code = errCode; + + if (this.errorHandler) { + this.errorHandler(err); + } + else { + throw err; + } + } + else { + var err = new Error("XMLHttpRequest error. STATUS: " + + this.request.status + " STATUS TEXT: " + + this.request.statusText ); + err.code = 'HTTP'; + + if (this.errorHandler) { + this.errorHandler(err); + } + else { + throw err; + } + } + } + } +}; + +/* +********************************************************************************* +** QUERY CLASS ****************************************************************** +********************************************************************************* +*/ +var pzQuery = function() +{ + this.simpleQuery = ''; + this.singleFilter = null; + this.advTerms = new Array(); + this.filterHash = new Array(); + this.numTerms = 0; + this.filterNums = 0; +}; +pzQuery.prototype = { + reset: function() + { + this.simpleQuery = ''; + this.advTerms = new Array(); + this.simpleFilter = null; + this.numTerms = 0; + }, + clearSimpleQuery: function() + { + this.simpleQuery = ''; + }, + addTerm: function(field, value) + { + var term = {"field": field, "value": value}; + this.advTerms[this.numTerms] = term; + this.numTerms++; + }, + getTermValueByIdx: function(index) + { + return this.advTerms[index].value; + }, + getTermFieldByIdx: function(index) + { + return this.advTerms[index].field; + }, + /* semicolon separated list of terms for given field*/ + getTermsByField: function(field) + { + var terms = ''; + for(var i = 0; i < this.advTerms.length; i++) + { + if( this.advTerms[i].field == field ) + terms = terms + this.queryHas[i].value + ';'; + } + return terms; + }, + addTermsFromList: function(inputString, field) + { + var inputArr = inputString.split(';'); + for(var i=0; i < inputArr.length; i++) + { + if(inputArr[i].length < 3) continue; + this.advTerms[this.numTerms] = {"field": field, "value": inputArr[i] }; + this.numTerms++; + } + }, + removeTermByIdx: function(index) + { + this.advTerms.splice(index, 1); + this.numTerms--; + }, + toCCL: function() + { + var ccl = ''; + if( this.simpleQuery != '') + ccl = this.simpleQuery; + for(var i = 0; i < this.advTerms.length; i++) + { + if (ccl != '') ccl = ccl + ' and '; + ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"'; + } + return ccl; + }, + addFilter: function(name, value) + { + var filter = {"name": name, "id": value }; + this.filterHash[this.filterHash.length] = filter; + this.filterNums++ + return this.filterHash.length - 1; + }, + setFilter: function(name, value) + { + this.filterHash = new Array(); + this.filterNums = 0; + this.addFilter(name, value); + }, + getFilter: function(index) + { + return this.filterHash[index].id; + }, + getFilterName: function(index) + { + return this.filterHash[index].name; + }, + removeFilter: function(index) + { + delete this.filterHash[index]; + this.filterNums--; + }, + clearFilter: function() + { + this.filterHash = new Array(); + this.filterNums = 0; + }, + getFilterString: function() + { + //temporary + if( this.singleFilter != null ) { + return 'pz:id='+this.singleFilter.id; + } + else if( this.filterNums <= 0 ) { + return undefined; + } + + var filter = 'pz:id='; + for(var i = 0; i < this.filterHash.length; i++) + { + if (this.filterHash[i] == undefined) continue; + if (filter > 'pz:id=') filter = filter + '|'; + filter += this.filterHash[i].id; + } + return filter; + }, + totalLength: function() + { + var simpleLength = this.simpleQuery != '' ? 1 : 0; + return this.advTerms.length + simpleLength; + }, + clearSingleFilter: function() + { + this.singleFilter = null; + }, + setSingleFilter: function(name, value) + { + this.singleFilter = {"name": name, "id": value }; + }, + getSingleFilterName: function() + { + return this.singleFilter.name; + } +} + }