/*
-** $Id: pz2.js,v 1.69 2008-02-14 12:20:24 jakub Exp $
+ * Mine
** pz2.js - pazpar2's javascript client library.
*/
}
this.errorHandler = paramArray.errorhandler || null;
+ this.showResponseType = paramArray.showResponseType || "xml";
// function callbacks
this.initCallback = paramArray.oninit || null;
this.keepAlive = paramArray.keepAlive;
this.sessionID = null;
+ this.serviceId = paramArray.serviceId || null;
this.initStatusOK = false;
this.pingStatusOK = false;
this.searchStatusOK = false;
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;
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
}
// else, auto init session or wait for a user init?
if (this.useSessions && paramArray.autoInit !== false) {
- this.init();
+ this.init(this.sessionId, this.serviceId);
}
};
this.resetCallback();
},
- init: function ( sessionId )
+ init: function (sessionId, serviceId)
{
this.reset();
// session id as a param
- if ( sessionId != undefined && this.useSessions ) {
+ if (sessionId && this.useSessions ) {
this.initStatusOK = true;
this.sessionID = sessionId;
this.ping();
} else if (this.useSessions) {
var context = this;
var request = new pzHttpRequest(this.pz2String, this.errorHandler);
- request.get(
- { "command": "init" },
+ var opts = {'command' : 'init'};
+ if (serviceId) opts.service = serviceId;
+ request.safeGet(
+ opts,
function(data) {
if ( data.getElementsByTagName("status")[0]
.childNodes[0].nodeValue == "OK" ) {
);
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]
}
);
},
- search: function (query, num, sort, filter, showfrom)
+ search: function (query, num, sort, filter, showfrom, addParamsArr)
{
clearTimeout(this.statTimer);
clearTimeout(this.showTimer);
this.termCounter = 0;
this.bytargetCounter = 0;
this.statCounter = 0;
+ this.activeClients = 1;
// no proxy mode
if( !this.initStatusOK )
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]
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
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") ) {
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;
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 <hit> tags
- var hits = data.getElementsByTagName("hit");
- 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)
- delay += context.showCounter * context.dumpFactor;
- if ( activeClients > 0 )
- context.showTimer = setTimeout(
- function () {
- context.show();
- },
- delay);
- global_show = show;
- 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;
+ var activeClients = 0;
+ if (type === "json") {
+ show = {};
+ activeClients = Number(data.activeclients[0]);
+ show.activeclients = 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
+ activeClients =
+ Number(data.getElementsByTagName("activeclients")[0]
+ .childNodes[0].nodeValue);
+ 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 <hit> 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.activeClients = activeClients;
+ 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);
+ }
);
},
record: function(id, offset, syntax, handler)
var context = this;
var request = new pzHttpRequest(this.pz2String, this.errorHandler);
- request.get(
+ request.safeGet(
recordParams,
function(data) {
var recordNode;
- var record;
+ var record;
//raw record
if (context.currRecOffset !== null) {
record = new Array();
//parse record
} else {
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
var context = this;
var request = new pzHttpRequest(this.pz2String, this.errorHandler);
- request.get(
+ request.safeGet(
{
"command": "termlist",
"session": this.sessionID,
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]
********************************************************************************
*/
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();
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 ()
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;
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);
}
}
}
- if (node.hasAttributes()) {
- 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;
- }
+ 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.hasAttributes())
- parsed['textContent'] = node.firstChild.nodeValue;
+ if (node.attributes.length)
+ parsed['#text'] = node.firstChild.nodeValue;
else
parsed = node.firstChild.nodeValue;
}