X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=js%2Fpz2.js;h=53c0c2abc21263334d57bbc9394368afbb6976b0;hb=624d4ff2e24967bafd51c52e1eba9b4cd64ee79d;hp=e879197b6e81de2cbf11ebbc0ca3a9188b5b8389;hpb=aa622908a43254464ce8aa3099f863459b024a72;p=pazpar2-moved-to-github.git diff --git a/js/pz2.js b/js/pz2.js index e879197..53c0c2a 100644 --- a/js/pz2.js +++ b/js/pz2.js @@ -1,5 +1,5 @@ /* -** $Id: pz2.js,v 1.61 2007-10-02 11:47:50 jakub Exp $ +** $Id: pz2.js,v 1.70 2008-03-12 11:36:57 jakub Exp $ ** pz2.js - pazpar2's javascript client library. */ @@ -29,7 +29,7 @@ var pz2 = function ( paramArray ) // at least one callback required if ( !paramArray ) - throw new Error("Pz2.js: An array with parameters has to be suplied when instantiating a class"); + throw new Error("Pz2.js: Array with parameters has to be suplied."); //supported pazpar2's protocol version this.suppProtoVer = '1'; @@ -50,6 +50,7 @@ var pz2 = function ( paramArray ) this.errorHandler = paramArray.errorhandler || null; // function callbacks + this.initCallback = paramArray.oninit || null; this.statCallback = paramArray.onstat || null; this.showCallback = paramArray.onshow || null; this.termlistCallback = paramArray.onterm || null; @@ -84,6 +85,9 @@ var pz2 = function ( paramArray ) // current query this.currQuery = null; + //current raw record offset + this.currRecOffset = null; + //timers this.statTime = paramArray.stattime || 1000; this.statTimer = null; @@ -170,7 +174,7 @@ pz2.prototype = } else if (this.useSessions) { var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "init" }, function(data) { if ( data.getElementsByTagName("status")[0] @@ -178,7 +182,9 @@ pz2.prototype = if ( data.getElementsByTagName("protocol")[0] .childNodes[0].nodeValue != context.suppProtoVer ) - throw new Error("Server's protocol not supported by the client"); + throw new Error( + "Server's protocol not supported by the client" + ); context.initStatusOK = true; context.sessionID = data.getElementsByTagName("session")[0] @@ -189,6 +195,8 @@ pz2.prototype = }, context.keepAlive ); + if ( context.initCallback ) + context.initCallback(); } else context.throwError('Init failed. Malformed WS resonse.', @@ -205,12 +213,12 @@ pz2.prototype = { // pinging only makes sense when using pazpar2 directly if( !this.initStatusOK || !this.useSessions ) - throw new Error('Pz2.js: Ping not allowed (proxy mode) or session not initialized.'); - // session is not initialized code here - + throw new Error( + 'Pz2.js: Ping not allowed (proxy mode) or session not initialized.' + ); var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "ping", "session": this.sessionID }, function(data) { if ( data.getElementsByTagName("status")[0] @@ -229,7 +237,7 @@ pz2.prototype = } ); }, - search: function (query, num, sort, filter, showfrom) + search: function (query, num, sort, filter, showfrom, addParamsArr) { clearTimeout(this.statTimer); clearTimeout(this.showTimer); @@ -263,10 +271,18 @@ pz2.prototype = if (filter !== undefined) searchParams["filter"] = filter; + + // copy additional parmeters, do not overwrite + if (addParamsArr != undefined) { + for (var prop in addParamsArr) { + if (!searchParams.hasOwnProperty(prop)) + searchParams[prop] = addParamsArr[prop]; + } + } var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( searchParams, function(data) { if ( data.getElementsByTagName("status")[0] @@ -297,7 +313,7 @@ pz2.prototype = var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "stat", "session": this.sessionID }, function(data) { if ( data.getElementsByTagName("stat") ) { @@ -359,7 +375,9 @@ pz2.prototype = show: function(start, num, sort) { if( !this.searchStatusOK && this.useSessions ) - throw new Error('Pz2.js: show command has to be preceded with a search command.'); + throw new Error( + 'Pz2.js: show command has to be preceded with a search command.' + ); // if called explicitly takes precedence clearTimeout(this.showTimer); @@ -373,7 +391,7 @@ pz2.prototype = var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "show", "session": this.sessionID, @@ -409,36 +427,9 @@ pz2.prototype = }; // parse all the first-level nodes for all tags var hits = data.getElementsByTagName("hit"); - 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 ) { - 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; - } - } - } - } + for (i = 0; i < hits.length; i++) + show.hits[i] = Element_parseChildNodes(hits[i]); + context.showCounter++; var delay = context.showTime; if (context.showCounter > context.showFastCount) @@ -449,7 +440,7 @@ pz2.prototype = context.show(); }, delay); - + global_show = show; context.showCallback(show); } else @@ -458,108 +449,70 @@ pz2.prototype = } ); }, - record: function(id, offset, params) + record: function(id, offset, syntax, handler) { // we may call record with no previous search if in proxy mode - if( !this.searchStatusOK && this.useSessions) + if(!this.searchStatusOK && this.useSessions) throw new Error( 'Pz2.js: record command has to be preceded with a search command.' - ); - if ( params == undefined ) - params = {}; - - if ( params.callback != undefined ) { - callback = params.callback; - } else { - callback = this.recordCallback; - } + ); - // what is that? - if ( params['handle'] == undefined ) - handle = {}; - else - handle = params['handle']; - if( id !== undefined ) this.currRecID = id; - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - - var recordParams = { "command": "record", - "session": this.sessionID, - "id": this.currRecID }; + var recordParams = { + "command": "record", + "session": this.sessionID, + "id": this.currRecID + }; - if (offset !== undefined) { + this.currRecOffset = null; + if (offset != undefined) { recordParams["offset"] = offset; - } - - if (params.syntax != undefined) { - recordParams['syntax'] = params.syntax; + this.currRecOffset = offset; } - this.currRecOffset = offset; + if (syntax != undefined) + recordParams['syntax'] = syntax; - request.get( + //overwrite default callback id needed + var callback = this.recordCallback; + var args = undefined; + if (handler != undefined) { + callback = handler['callback']; + args = handler['args']; + } + + var context = this; + var request = new pzHttpRequest(this.pz2String, this.errorHandler); + + request.safeGet( recordParams, function(data) { var recordNode; - var record = new Array(); - record['xmlDoc'] = data; - if (context.currRecOffset !== undefined) { + var record; + //raw record + if (context.currRecOffset !== null) { + record = new Array(); + record['xmlDoc'] = data; record['offset'] = context.currRecOffset; - callback(record, handle); + callback(record, args); + //pz2 record } else if ( recordNode = data.getElementsByTagName("record")[0] ) { // if stylesheet was fetched do not parse the response if ( context.xslDoc ) { + record = new Array(); + record['xmlDoc'] = data; + record['xslDoc'] = context.xslDoc; record['recid'] = recordNode.getElementsByTagName("recid")[0] .firstChild.nodeValue; - record['xslDoc'] = - context.xslDoc; + //parse record } 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 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; - } - } - } - } - - callback(record, handle); + record = Element_parseChildNodes(recordNode); + } + callback(record, args); } else context.throwError('Record failed. Malformed WS resonse.', @@ -571,14 +524,16 @@ pz2.prototype = termlist: function() { if( !this.searchStatusOK && this.useSessions ) - throw new Error('Pz2.js: termlist command has to be preceded with a search command.'); + throw new Error( + 'Pz2.js: termlist command has to be preceded with a search command.' + ); // if called explicitly takes precedence clearTimeout(this.termTimer); var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "termlist", "session": this.sessionID, @@ -645,7 +600,9 @@ pz2.prototype = bytarget: function() { if( !this.initStatusOK && this.useSessions ) - throw new Error('Pz2.js: bytarget command has to be preceded with a search command.'); + throw new Error( + 'Pz2.js: bytarget command has to be preceded with a search command.' + ); // no need to continue if( !this.searchStatusOK ) @@ -656,7 +613,7 @@ pz2.prototype = var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "bytarget", "session": this.sessionID }, function(data) { if ( data.getElementsByTagName("status")[0] @@ -728,10 +685,12 @@ pz2.prototype = ******************************************************************************** */ var pzHttpRequest = function ( url, errorHandler ) { + this.maxUrlLength = 2048; this.request = null; this.url = url; this.errorHandler = errorHandler || null; this.async = true; + this.requestHeaders = {}; if ( window.XMLHttpRequest ) { this.request = new XMLHttpRequest(); @@ -746,14 +705,29 @@ var pzHttpRequest = function ( url, errorHandler ) { pzHttpRequest.prototype = { + safeGet: function ( params, callback ) + { + var encodedParams = this.encodeParams(params); + var url = this._urlAppendParams(encodedParams); + if (url.length >= this.maxUrlLength) { + this.requestHeaders["Content-Type"] + = "application/x-www-form-urlencoded"; + this._send( 'POST', this.url, encodedParams, callback ); + } else { + this._send( 'GET', url, '', callback ); + } + }, + get: function ( params, callback ) { - this._send( 'GET', params, '', callback ); + this._send( 'GET', this._urlAppendParams(this.encodeParams(params)), + '', callback ); }, post: function ( params, data, callback ) { - this._send( 'POST', params, data, callback ); + this._send( 'POST', this._urlAppendParams(this.encodeParams(params)), + data, callback ); }, load: function () @@ -765,46 +739,55 @@ pzHttpRequest.prototype = return this.request.responseXML; }, - _send: function ( type, params, data, callback ) + encodeParams: function (params) + { + var sep = ""; + var encoded = ""; + for (var key in params) { + if (params[key] != null) { + encoded += sep + key + '=' + encodeURIComponent(params[key]); + sep = '&'; + } + } + return encoded; + }, + + _send: function ( type, url, data, callback) { - this.callback = callback; var context = this; + this.callback = callback; this.async = true; - this.request.open( type, this._urlAppendParams(params), this.async ); + this.request.open( type, url, this.async ); + for (var key in this.requestHeaders) + this.request.setRequestHeader(key, this.requestHeaders[key]); this.request.onreadystatechange = function () { context._handleResponse(); } this.request.send(data); }, - _urlAppendParams: function (params) + _urlAppendParams: function (encodedParams) { - var getUrl = this.url; - - var sep = '?'; - var el = params; - for (var key in el) { - if (el[key] != null) { - getUrl += sep + key + '=' + encodeURIComponent(el[key]); - sep = '&'; - } - } - return getUrl; + if (encodedParams) + return this.url + "?" + encodedParams; + else + return this.url; }, _handleResponse: function () { if ( this.request.readyState == 4 ) { - // pick up pazpr2 errors first - if ( this.request.responseXML - && this.request.responseXML.documentElement.nodeName == 'error' - && this.request.responseXML.getElementsByTagName("error").length ) { + // pick up appplication errors first + var errNode = null; + if (this.request.responseXML && + (errNode = this.request.responseXML.documentElement) + && errNode.nodeName == 'error') { + var errMsg = errNode.getAttribute("msg"); + var errCode = errNode.getAttribute("code"); var errAddInfo = ''; - if ( this.request.responseXML.getElementsByTagName("error")[0].childNodes.length ) - errAddInfo = ': ' + this.request.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue; - var errMsg = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("msg"); - var errCode = this.request.responseXML.getElementsByTagName("error")[0].getAttribute("code"); - + if (errNode.childNodes.length) + errAddInfo = ': ' + errNode.childNodes[0].nodeValue; + var err = new Error(errMsg + errAddInfo); err.code = errCode; @@ -814,13 +797,13 @@ pzHttpRequest.prototype = else { throw err; } - } else if ( this.request.status == 200 ) { - this.callback( this.request.responseXML ); + } else if (this.request.status == 200) { + this.callback(this.request.responseXML); } else { - var err = new Error("Pz2.js: HTTP request error (AJAX). Code: " - + this.request.status + " Info: " + var err = new Error("HTTP response not OK: " + + this.request.status + " - " + this.request.statusText ); - err.code = 'HTTP'; + err.code = '00' + this.request.status; if (this.errorHandler) { this.errorHandler(err); @@ -834,9 +817,9 @@ pzHttpRequest.prototype = }; /* -********************************************************************************* -** XML HELPER CLASS ************************************************************ -********************************************************************************* +******************************************************************************** +** XML HELPER FUNCTIONS ******************************************************** +******************************************************************************** */ // DOMDocument @@ -956,4 +939,42 @@ Element_getTextContent = function (DOM_Element) } } +Element_parseChildNodes = function (node) +{ + var parsed = {}; + var hasChildElems = false; + + if (node.hasChildNodes()) { + var children = node.childNodes; + for (var i = 0; i < children.length; i++) { + var child = children[i]; + if (child.nodeType == Node.ELEMENT_NODE) { + hasChildElems = true; + var nodeName = child.nodeName; + if (!(nodeName in parsed)) + parsed[nodeName] = []; + parsed[nodeName].push(Element_parseChildNodes(child)); + } + } + } + + var attrs = node.attributes; + for (var i = 0; i < attrs.length; i++) { + var attrName = '@' + attrs[i].nodeName; + var attrValue = attrs[i].nodeValue; + parsed[attrName] = attrValue; + } + + // if no nested elements, get text content + if (node.hasChildNodes() && !hasChildElems) { + if (node.attributes.length) + parsed['textContent'] = node.firstChild.nodeValue; + else + parsed = node.firstChild.nodeValue; + } + + return parsed; +} + +/* do not remove trailing bracket */ }