X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=js%2Fpz2.js;h=1471a5e00c77c18d4258da4a8cb1894b8caf1693;hb=b40bdb2f4a3793471b478da5a691261d197cfcd4;hp=4d7f784a585173f66d51701c7d3ba7ff75d4e5d5;hpb=7182ce9776fbcadef10afe7df72e22997f68be1c;p=pazpar2-moved-to-github.git diff --git a/js/pz2.js b/js/pz2.js index 4d7f784..1471a5e 100644 --- a/js/pz2.js +++ b/js/pz2.js @@ -1,5 +1,5 @@ /* -** $Id: pz2.js,v 1.68 2007-12-20 13:09:40 jakub Exp $ + * Mine ** pz2.js - pazpar2's javascript client library. */ @@ -48,6 +48,7 @@ var pz2 = function ( paramArray ) } this.errorHandler = paramArray.errorhandler || null; + this.showResponseType = paramArray.showResponseType || "xml"; // function callbacks this.initCallback = paramArray.oninit || null; @@ -85,6 +86,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; @@ -95,6 +99,8 @@ var pz2 = function ( paramArray ) this.showFastCount = 4; this.bytargetTime = paramArray.bytargettime || 1000; this.bytargetTimer = null; + this.recordTime = paramArray.recordtime || 500; + this.recordTimer = null; // counters for each command and applied delay this.dumpFactor = 500; @@ -102,6 +108,7 @@ var pz2 = function ( paramArray ) this.termCounter = 0; this.statCounter = 0; this.bytargetCounter = 0; + this.recordCounter = 0; // active clients, updated by stat and show // might be an issue since bytarget will poll accordingly @@ -171,7 +178,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] @@ -215,7 +222,7 @@ pz2.prototype = ); 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] @@ -234,7 +241,7 @@ pz2.prototype = } ); }, - search: function (query, num, sort, filter, showfrom) + search: function (query, num, sort, filter, showfrom, addParamsArr) { clearTimeout(this.statTimer); clearTimeout(this.showTimer); @@ -245,6 +252,7 @@ pz2.prototype = this.termCounter = 0; this.bytargetCounter = 0; this.statCounter = 0; + this.activeClients = 1; // no proxy mode if( !this.initStatusOK ) @@ -268,10 +276,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] @@ -279,11 +295,11 @@ pz2.prototype = context.searchStatusOK = true; //piggyback search context.show(start, num, sort); - if ( context.statCallback ) + if (context.statCallback) context.stat(); - if ( context.termlistCallback ) + if (context.termlistCallback) context.termlist(); - if ( context.bytargetCallback ) + if (context.bytargetCallback) context.bytarget(); } else @@ -302,7 +318,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") ) { @@ -310,37 +326,9 @@ pz2.prototype = Number( data.getElementsByTagName("activeclients")[0] .childNodes[0].nodeValue ); context.activeClients = activeClients; - var stat = { - "activeclients": activeClients, - "hits": - Number( data.getElementsByTagName("hits")[0] - .childNodes[0].nodeValue ), - "records": - Number( data.getElementsByTagName("records")[0] - .childNodes[0].nodeValue ), - "clients": - Number( data.getElementsByTagName("clients")[0] - .childNodes[0].nodeValue ), - "initializing": - Number( data.getElementsByTagName("initializing")[0] - .childNodes[0].nodeValue ), - "searching": - Number( data.getElementsByTagName("searching")[0] - .childNodes[0].nodeValue ), - "presenting": - Number( data.getElementsByTagName("presenting")[0] - .childNodes[0].nodeValue ), - "idle": - Number( data.getElementsByTagName("idle")[0] - .childNodes[0].nodeValue ), - "failed": - Number( data.getElementsByTagName("failed")[0] - .childNodes[0].nodeValue ), - "error": - Number( data.getElementsByTagName("error")[0] - .childNodes[0].nodeValue ) - }; - + + var stat = Element_parseChildNodes(data.documentElement); + context.statCounter++; var delay = context.statTime + context.statCounter * context.dumpFactor; @@ -380,213 +368,152 @@ pz2.prototype = var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( - { - "command": "show", - "session": this.sessionID, - "start": this.currentStart, - "num": this.currentNum, - "sort": this.currentSort, - "block": 1 - }, - function(data) { - if ( data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK" ) { - // 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 ); - context.activeClients = activeClients; - var show = { - "activeclients": activeClients, - "merged": - Number( data.getElementsByTagName("merged")[0] - .childNodes[0].nodeValue ), - "total": - Number( data.getElementsByTagName("total")[0] - .childNodes[0].nodeValue ), - "start": - Number( data.getElementsByTagName("start")[0] - .childNodes[0].nodeValue ), - "num": - Number( data.getElementsByTagName("num")[0] - .childNodes[0].nodeValue ), - "hits": [] - }; - // 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(); - var locCount = 0; - for ( j = 0; j < hits[i].childNodes.length; j++) { - 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'][locCount] = { - "id": locNode.getAttribute("id"), - "name": locNode.getAttribute("name") - }; - locCount++; - } - 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; - } - } - } - } - context.showCounter++; - var delay = context.showTime; - if (context.showCounter > context.showFastCount) - delay += context.showCounter * context.dumpFactor; - if ( activeClients > 0 ) - context.showTimer = setTimeout( - function () { - context.show(); - }, - delay); - - context.showCallback(show); - } - else - context.throwError('Show failed. Malformed WS resonse.', - 114); + request.safeGet( + { + "command": "show", + "session": this.sessionID, + "start": this.currentStart, + "num": this.currentNum, + "sort": this.currentSort, + "block": 1, + "type": this.showResponseType + }, + function(data, type) { + var show = null; + if (type === "json") { + show = {}; + context.activeClients = Number(data.activeclients[0]); + show.activeclients = context.activeclients; + show.merged = Number(data.merged[0]); + show.total = Number(data.total[0]); + show.start = Number(data.start[0]); + show.num = Number(data.num[0]); + show.hits = data.hit; + } else if (data.getElementsByTagName("status")[0] + .childNodes[0].nodeValue == "OK") { + // 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); + context.activeClients = activeClients; + show = { + "activeclients": activeClients, + "merged": + Number( data.getElementsByTagName("merged")[0] + .childNodes[0].nodeValue ), + "total": + Number( data.getElementsByTagName("total")[0] + .childNodes[0].nodeValue ), + "start": + Number( data.getElementsByTagName("start")[0] + .childNodes[0].nodeValue ), + "num": + Number( data.getElementsByTagName("num")[0] + .childNodes[0].nodeValue ), + "hits": [] + }; + // parse all the first-level nodes for all tags + var hits = data.getElementsByTagName("hit"); + for (i = 0; i < hits.length; i++) + show.hits[i] = Element_parseChildNodes(hits[i]); + } else { + context.throwError('Show failed. Malformed WS resonse.', + 114); } + context.showCounter++; + var delay = context.showTime; + if (context.showCounter > context.showFastCount) + delay += context.showCounter * context.dumpFactor; + if ( activeClients > 0 ) + context.showTimer = setTimeout( + function () { + context.show(); + }, + delay); + global_show = show; + context.showCallback(show); + } ); }, - record: function(id, offset, pass_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.' ); - var params = {}; - if ( pass_params != undefined ) - params = pass_params; - - var callback; - if ( params.callback != undefined ) { - callback = params.callback; - } else { - callback = this.recordCallback; - } - var handle; - 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 = ''; - if (recordNode.childNodes[i].firstChild) - 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; - // this is stupid - if (nodeName == 'md-subject') { - if (record["location"][i][nodeName]) { - record["location"][i][nodeName] - .push(nodeText) - } else { - record["location"][i][nodeName] - = new Array(); - record["location"][i][nodeName] - .push(nodeText) - } - } else { - record["location"][i][nodeName] - = nodeText; - } - } - } - } - } - - callback(record, handle); + record = Element_parseChildNodes(recordNode); + } + var activeClients = + Number( data.getElementsByTagName("activeclients")[0] + .childNodes[0].nodeValue ); + context.activeClients = activeClients; + context.recordCounter++; + var delay = context.recordTime + context.recordCounter * context.dumpFactor; + if ( activeClients > 0 ) + context.recordTimer = + setTimeout ( + function() { + context.record(id, offset, syntax, handler); + }, + delay + ); + callback(record, args); } else context.throwError('Record failed. Malformed WS resonse.', @@ -607,7 +534,7 @@ pz2.prototype = var context = this; var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.get( + request.safeGet( { "command": "termlist", "session": this.sessionID, @@ -687,7 +614,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] @@ -759,10 +686,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(); @@ -777,14 +706,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 () @@ -796,55 +740,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(); + context._handleResponse(url); /// url used ONLY for error reporting } 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 () + _handleResponse: function (savedUrlForErrorReporting) { 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; @@ -854,14 +798,29 @@ pzHttpRequest.prototype = else { throw err; } - } else if ( this.request.status == 200 ) { - this.callback( this.request.responseXML ); + } else if (this.request.status == 200 && + this.request.responseXML == null) { + if (this.request.responseText != null) { + //assume JSON + var json = eval("(" + this.request.responseText + ")"); + this.callback(json, "json"); + } else { + var err = new Error("XML response is empty but no error " + + "for " + savedUrlForErrorReporting); + err.code = -1; + if (this.errorHandler) { + this.errorHandler(err); + } else { + throw err; + } + } + } 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); } @@ -996,5 +955,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['#text'] = node.firstChild.nodeValue; + else + parsed = node.firstChild.nodeValue; + } + + return parsed; +} + /* do not remove trailing bracket */ }