/*
-** $Id: pz2.js,v 1.49 2007-07-26 13:47:52 jakub Exp $
+** $Id: pz2.js,v 1.60 2007-10-02 10:33:18 jakub Exp $
** pz2.js - pazpar2's javascript client library.
*/
if(typeof window.pz2 == "undefined") {
window.undefined = window.undefined;
-var pz2 = function(paramArray) {
+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");
+
//for convenience
__myself = this;
//supported pazpar2's protocol version
__myself.suppProtoVer = '1';
- __myself.pz2String = paramArray.pazpar2path || "/pazpar2/search.pz2";
- __myself.stylesheet = paramArray.detailstylesheet || null;
+ if (typeof paramArray.pazpar2path != "undefined")
+ __myself.pz2String = paramArray.pazpar2path;
+ else
+ __myself.pz2String = "/pazpar2/search.pz2";
__myself.useSessions = true;
- if (paramArray.usesessions != undefined) {
- __myself.useSessions = paramArray.usesessions;
- }
-
+
+ __myself.stylesheet = paramArray.detailstylesheet || null;
//load stylesheet if required in async mode
if( __myself.stylesheet ) {
var request = new pzHttpRequest( __myself.stylesheet );
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");
__myself.errorHandler = paramArray.errorhandler || null;
// some configurational stuff
__myself.keepAlive = 50000;
+
+ if ( paramArray.keepAlive < __myself.keepAlive )
+ __myself.keepAlive = paramArray.keepAlive;
__myself.sessionID = null;
__myself.initStatusOK = false;
__myself.pingStatusOK = false;
__myself.searchStatusOK = false;
-
- if ( paramArray.keepAlive < __myself.keepAlive )
- __myself.keepAlive = paramArray.keepAlive;
-
+
// for sorting
__myself.currentSort = "relevance";
+
// where are we?
__myself.currentStart = 0;
__myself.currentNum = 20;
// last full record retrieved
__myself.currRecID = null;
+
// current query
__myself.currQuery = null;
// active clients, updated by stat and show
// might be an issue since bytarget will poll accordingly
__myself.activeClients = 1;
-
- // auto init session?
- if (paramArray.autoInit !== false)
+
+ // if in proxy mode no need to init
+ if (paramArray.usesessions != undefined) {
+ __myself.useSessions = paramArray.usesessions;
+ __myself.initStatusOK = true;
+ }
+ // else, auto init session or wait for a user init?
+ if (__myself.useSessions && paramArray.autoInit !== false) {
__myself.init();
+ }
};
+
pz2.prototype =
{
+ //error handler for async error throws
+ throwError: function (errMsg, errCode)
+ {
+ var err = new Error(errMsg);
+ if (errCode) err.code = errCode;
+
+ if (__myself.errorHandler) {
+ __myself.errorHandler(err);
+ }
+ else {
+ throw err;
+ }
+ },
+
+ // stop activity by clearing tiemouts
stop: function ()
{
clearTimeout(__myself.statTimer);
clearTimeout(__myself.bytargetTimer);
},
+ // reset status variables
reset: function ()
- {
- __myself.sessionID = null;
- __myself.initStatusOK = false;
- __myself.pingStatusOK = false;
+ {
+ if ( __myself.useSessions ) {
+ __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 ) {
+
+ // session id as a param
+ if ( sessionId != undefined && __myself.useSessions ) {
__myself.initStatusOK = true;
__myself.sessionID = sessionId;
__myself.ping();
+ // old school direct pazpar2 init
} 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 )
+ 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;
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);
+ // setTimeout("__myself.init()", 1000);
+ __myself.throwError('Init failed. Malformed WS resonse.', 110);
}
);
+ // when through proxy no need to init
} else {
__myself.initStatusOK = true;
}
// no need to ping explicitly
ping: function ()
{
- if( !__myself.initStatusOK )
- return;
+ // pinging only makes sense when using pazpar2 directly
+ if( !__myself.initStatusOK || !__myself.useSessions )
+ throw new Error('Pz2.js: Ping not allowed (proxy mode) or session not initialized.');
// session is not initialized code here
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
request.get(
{ "command": "ping", "session": __myself.sessionID },
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.ping()", 1000);
+ // setTimeout("__myself.ping()", 1000);
+ __myself.throwError('Ping failed. Malformed WS resonse.', 111);
}
);
},
- search: function (query, num, sort, filter)
+ search: function (query, num, sort, filter, showfrom)
{
clearTimeout(__myself.statTimer);
clearTimeout(__myself.showTimer);
__myself.bytargetCounter = 0;
__myself.statCounter = 0;
+ // no proxy mode
if( !__myself.initStatusOK )
- return;
+ throw new Error('Pz2.js: session not initialized.');
if( query !== undefined )
__myself.currQuery = query;
else
- throw new Error("You need to supply query to the search command");
+ throw new Error("Pz2.js: no query supplied to the search command.");
+
+ if ( showfrom !== undefined )
+ var start = showfrom;
+ else
+ var start = 0;
var searchParams = { "command": "search", "query": __myself.currQuery, "session": __myself.sessionID };
if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
__myself.searchStatusOK = true;
//piggyback search
- __myself.show(0, num, sort);
+ __myself.show(start, num, sort);
if ( __myself.statCallback )
__myself.stat();
//__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 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)", 500);
+ // setTimeout("__myself.search(__myself.currQuery)", 500);
+ __myself.throwError('Search failed. Malformed WS resonse.', 112);
}
);
},
stat: function()
{
if( !__myself.initStatusOK )
- return;
+ throw new Error('Pz2.js: session not initialized.');
+
// if called explicitly takes precedence
clearTimeout(__myself.statTimer);
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
request.get(
{ "command": "stat", "session": __myself.sessionID },
var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor;
if ( activeClients > 0 )
__myself.statTimer = setTimeout("__myself.stat()", delay);
-
__myself.statCallback(stat);
}
else
// if it gets here the http return code was 200 (pz2 errors are 417)
// but the response was invalid, it should never occur
- __myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
+ //__myself.statTimer = setTimeout("__myself.stat()", __myself.statTime / 4);
+ __myself.throwError('Stat failed. Malformed WS resonse.', 113);
}
);
},
show: function(start, num, sort)
{
- if( !__myself.searchStatusOK )
- return;
+ if( !__myself.searchStatusOK && __myself.useSessions )
+ throw new Error('Pz2.js: show command has to be preceded with a search command.');
+
// if called explicitly takes precedence
clearTimeout(__myself.showTimer);
__myself.currentStart = Number( start );
if( num !== undefined )
__myself.currentNum = Number( num );
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
var context = this;
request.get(
else
// if it gets here the http return code was 200 (pz2 errors are 417)
// but the response was invalid, it should never occur
- __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
+ // __myself.showTimer = setTimeout("__myself.show()", __myself.showTime / 4);
+ __myself.throwError('Show failed. Malformed WS resonse.', 114);
}
);
},
- record: function(id,offset, params)
+ record: function(id, offset, params)
{
+ // we may call record with no previous search if in proxy mode
+ if( !__myself.searchStatusOK && __myself.useSessions)
+ throw new Error('Pz2.js: record command has to be preceded with a search command.');
+
if ( params == undefined )
params = {};
} else {
callback = __myself.recordCallback;
}
-
+
+ // what is that?
if ( params['handle'] == undefined )
handle = {};
else
handle = params['handle'];
- if( !__myself.searchStatusOK && __myself.useSessions)
- return;
-
if( id !== undefined )
__myself.currRecID = id;
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
- var recordParams = { "command": "record", "session": __myself.sessionID, "id": __myself.currRecID };
- if (offset !== undefined) {
- recordParams["offset"] = offset;
+ var recordParams = { "command": "record",
+ "session": __myself.sessionID,
+ "id": __myself.currRecID };
+
+ if (offset !== undefined) {
+ recordParams["offset"] = offset;
}
if (params.syntax != undefined) {
}
__myself.currRecOffset = offset;
+
request.get(
recordParams,
function(data) {
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)", 500);
+ // setTimeout("__myself.record(__myself.currRecID)", 500);
+ __myself.throwError('Record failed. Malformed WS resonse.', 115);
}
);
},
+
termlist: function()
{
- if( !__myself.searchStatusOK )
- return;
+ if( !__myself.searchStatusOK && __myself.useSessions )
+ throw new Error('Pz2.js: termlist command has to be preceded with a search command.');
+
// if called explicitly takes precedence
clearTimeout(__myself.termTimer);
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
request.get(
{ "command": "termlist", "session": __myself.sessionID, "name": __myself.termKeys },
else
// if it gets here the http return code was 200 (pz2 errors are 417)
// but the response was invalid, it should never occur
- __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
+ // __myself.termTimer = setTimeout("__myself.termlist()", __myself.termTime / 4);
+ __myself.throwError('Termlist failed. Malformed WS resonse.', 116);
}
);
},
bytarget: function()
{
+ if( !__myself.initStatusOK && __myself.useSessions )
+ throw new Error('Pz2.js: bytarget command has to be preceded with a search command.');
+
+ // no need to continue
if( !__myself.searchStatusOK )
return;
+
// if called explicitly takes precedence
clearTimeout(__myself.bytargetTimer);
+
var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler);
request.get(
{ "command": "bytarget", "session": __myself.sessionID },
else
// if it gets here the http return code was 200 (pz2 errors are 417)
// but the response was invalid, it should never occur
- __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
+ // __myself.bytargetTimer = setTimeout("__myself.bytarget()", __myself.bytargetTime / 4);
+ __myself.throwError('Bytarget failed. Malformed WS resonse.', 117);
}
);
},
+
// just for testing, probably shouldn't be here
showNext: function(page)
{
var step = page || 1;
__myself.show( ( step * __myself.currentNum ) + __myself.currentStart );
},
+
showPrev: function(page)
{
if (__myself.currentStart == 0 )
var newStart = __myself.currentStart - (step * __myself.currentNum );
__myself.show( newStart > 0 ? newStart : 0 );
},
+
showPage: function(pageNum)
{
//var page = pageNum || 1;
var el = params;
for (var key in el) {
if (el[key] != null) {
- getUrl += sep + key + '=' + encodeURI(el[key]);
+ getUrl += sep + key + '=' + encodeURIComponent(el[key]);
sep = '&';
}
}
_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;
+ 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 ) {
+ 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");
- var err = new Error(errMsg);
+ var err = new Error(errMsg + errAddInfo);
err.code = errCode;
if (this.errorHandler) {
else {
throw err;
}
- }
- else {
- var err = new Error("XMLHttpRequest error. STATUS: "
- + this.request.status + " STATUS TEXT: "
+ } 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: "
+ this.request.statusText );
err.code = 'HTTP';
return doc;
}
+DOMDoc.transformToDoc = function (xmlDoc, xslDoc)
+{
+ if ( window.XSLTProcessor ) {
+ var proc = new XSLTProcessor();
+ proc.importStylesheet( xslDoc );
+ return proc.transformToDocument(xmlDoc);
+ } else if ( window.ActiveXObject ) {
+ return document.parseXmlFromString(xmlDoc.transformNode(xslDoc));
+ } else {
+ alert( 'Unable to perform XSLT transformation in this browser' );
+ }
+}
+
// DOMElement
Element_removeFromDoc = function (DOM_Element)
Element_getTextContent = function (DOM_Element)
{
- if (DOM_Element.textContent) {
+ if ( typeof DOM_Element.textContent != 'undefined' ) {
return DOM_Element.textContent;
- } else if (DOM_Element.text ) {
+ } else if (typeof DOM_Element.text != 'undefined') {
return DOM_Element.text;
} else {
throw new Error("Cannot get text content of the node, no such method.");
}
}
-/*
-*********************************************************************************
-** 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;
- }
-}
-
}
projects / pazpar2-moved-to-github.git / blobdiff