X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=js%2Fpz2.js;h=581b77e66d6bdd6274730224d395fc6bc8519300;hb=0ff1a97b2a69905755b9adb24a474d30f1c52150;hp=111a2fa862d2d971b98eff6d2e4d67d609f5b63b;hpb=44fed845c16842d469977f88a49c5c6132e7345f;p=pazpar2-moved-to-github.git diff --git a/js/pz2.js b/js/pz2.js index 111a2fa..581b77e 100644 --- a/js/pz2.js +++ b/js/pz2.js @@ -1,5 +1,5 @@ /* -** $Id: pz2.js,v 1.45 2007-07-10 10:17:17 adam Exp $ +** $Id: pz2.js,v 1.56 2007-09-12 08:57:14 jakub Exp $ ** pz2.js - pazpar2's javascript client library. */ @@ -24,28 +24,30 @@ if (!window['Node']) { 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 || "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; @@ -62,23 +64,25 @@ var pz2 = function(paramArray) { // 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; @@ -103,13 +107,21 @@ var pz2 = function(paramArray) { // 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 = { + // stop activity by clearing tiemouts stop: function () { clearTimeout(__myself.statTimer); @@ -118,33 +130,39 @@ pz2.prototype = 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; @@ -156,6 +174,7 @@ pz2.prototype = setTimeout("__myself.init()", 1000); } ); + // when through proxy no need to init } else { __myself.initStatusOK = true; } @@ -163,9 +182,11 @@ pz2.prototype = // 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 }, @@ -181,7 +202,7 @@ pz2.prototype = } ); }, - search: function (query, num, sort, filter) + search: function (query, num, sort, filter, showfrom) { clearTimeout(__myself.statTimer); clearTimeout(__myself.showTimer); @@ -193,13 +214,19 @@ pz2.prototype = __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 }; @@ -213,7 +240,7 @@ pz2.prototype = 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); @@ -234,9 +261,11 @@ pz2.prototype = 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 }, @@ -261,7 +290,6 @@ pz2.prototype = var delay = __myself.statTime + __myself.statCounter * __myself.dumpFactor; if ( activeClients > 0 ) __myself.statTimer = setTimeout("__myself.stat()", delay); - __myself.statCallback(stat); } else @@ -273,8 +301,9 @@ pz2.prototype = }, 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); @@ -284,6 +313,7 @@ pz2.prototype = __myself.currentStart = Number( start ); if( num !== undefined ) __myself.currentNum = Number( num ); + var request = new pzHttpRequest(__myself.pz2String, __myself.errorHandler); var context = this; request.get( @@ -346,20 +376,46 @@ pz2.prototype = } ); }, - record: function(id,offset) + record: function(id, offset, params) { + // we may call record with no previous search if in proxy mode if( !__myself.searchStatusOK && __myself.useSessions) - return; + 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 = __myself.recordCallback; + } + + // what is that? + if ( params['handle'] == undefined ) + handle = {}; + else + handle = params['handle']; 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) { + recordParams['syntax'] = params.syntax; + } + __myself.currRecOffset = offset; + request.get( recordParams, function(data) { @@ -368,7 +424,7 @@ pz2.prototype = record['xmlDoc'] = data; if (__myself.currRecOffset !== undefined) { record['offset'] = __myself.currRecOffset; - __myself.recordCallback(record); + callback(record, handle); } else if ( recordNode = data.getElementsByTagName("record")[0] ) { // if stylesheet was fetched do not parse the response if ( __myself.xslDoc ) { @@ -404,7 +460,7 @@ pz2.prototype = } } - __myself.recordCallback(record); + callback(record, handle); } else // if it gets here the http return code was 200 (pz2 errors are 417) @@ -413,12 +469,15 @@ pz2.prototype = } ); }, + 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 }, @@ -467,10 +526,16 @@ pz2.prototype = }, 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 }, @@ -503,12 +568,14 @@ pz2.prototype = } ); }, + // 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 ) @@ -517,6 +584,7 @@ pz2.prototype = var newStart = __myself.currentStart - (step * __myself.currentNum ); __myself.show( newStart > 0 ? newStart : 0 ); }, + showPage: function(pageNum) { //var page = pageNum || 1; @@ -587,7 +655,7 @@ pzHttpRequest.prototype = var el = params; for (var key in el) { if (el[key] != null) { - getUrl += sep + key + '=' + encodeURI(el[key]); + getUrl += sep + key + '=' + escape(el[key]); sep = '&'; } } @@ -596,16 +664,16 @@ pzHttpRequest.prototype = _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 = 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) { @@ -614,10 +682,11 @@ pzHttpRequest.prototype = 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'; @@ -634,19 +703,196 @@ pzHttpRequest.prototype = /* ********************************************************************************* +** XML HELPER CLASS ************************************************************ +********************************************************************************* +*/ + +// DOMDocument + +if ( window.ActiveXObject) { + var DOMDoc = document; +} else { + var DOMDoc = Document.prototype; +} + +DOMDoc.newXmlDoc = function ( root ) +{ + var doc; + + if (document.implementation && document.implementation.createDocument) { + doc = document.implementation.createDocument('', root, null); + } else if ( window.ActiveXObject ) { + doc = new ActiveXObject("MSXML2.DOMDocument"); + doc.loadXML('<' + root + '/>'); + } else { + throw new Error ('No XML support in this browser'); + } + + return doc; +} + + +DOMDoc.parseXmlFromString = function ( xmlString ) +{ + var doc; + + if ( window.DOMParser ) { + var parser = new DOMParser(); + doc = parser.parseFromString( xmlString, "text/xml"); + } else if ( window.ActiveXObject ) { + doc = new ActiveXObject("MSXML2.DOMDocument"); + doc.loadXML( xmlString ); + } else { + throw new Error ("No XML parsing support in this browser."); + } + + return doc; +} + +// DOMElement + +Element_removeFromDoc = function (DOM_Element) +{ + DOM_Element.parentNode.removeChild(DOM_Element); +} + +Element_emptyChildren = function (DOM_Element) +{ + while( DOM_Element.firstChild ) { + DOM_Element.removeChild( DOM_Element.firstChild ) + } +} + +Element_appendTransformResult = function ( DOM_Element, xmlDoc, xslDoc ) +{ + if ( window.XSLTProcessor ) { + var proc = new XSLTProcessor(); + proc.importStylesheet( xslDoc ); + var docFrag = false; + docFrag = proc.transformToFragment( xmlDoc, DOM_Element.ownerDocument ); + DOM_Element.appendChild(docFrag); + } else if ( window.ActiveXObject ) { + DOM_Element.innerHTML = xmlDoc.transformNode( xslDoc ); + } else { + alert( 'Unable to perform XSLT transformation in this browser' ); + } +} + +Element_appendTextNode = function (DOM_Element, tagName, textContent ) +{ + var node = DOM_Element.ownerDocument.createElement(tagName); + var text = DOM_Element.ownerDocument.createTextNode(textContent); + + DOM_Element.appendChild(node); + node.appendChild(text); + + return node; +} + +Element_setTextContent = function ( DOM_Element, textContent ) +{ + if (typeof DOM_Element.textContent !== "undefined") { + DOM_Element.textContent = textContent; + } else if (typeof DOM_Element.innerText !== "undefined" ) { + DOM_Element.innerText = textContent; + } else { + throw new Error("Cannot set text content of the node, no such method."); + } +} + +Element_getTextContent = function (DOM_Element) +{ + if ( typeof DOM_Element.textContent != 'undefined' ) { + return DOM_Element.textContent; + } 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() + +var pzFilter = function() +{ + this.filterHash = new Array(); + this.filterNums = 0; +}; + +pzFilter.prototype = +{ + 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() + { + 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; + } +}; + +var mkState = function() { + this.sort = 'relevance'; + this.perPage = 20; + this.page = 0; this.simpleQuery = ''; this.singleFilter = null; this.advTerms = new Array(); - this.filterHash = new Array(); this.numTerms = 0; - this.filterNums = 0; + this.action = ''; }; -pzQuery.prototype = { + +mkState.prototype = +{ reset: function() { this.simpleQuery = ''; @@ -654,24 +900,29 @@ pzQuery.prototype = { 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) { @@ -683,21 +934,25 @@ pzQuery.prototype = { } 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.advTerms[this.numTerms] + = {"field": field, "value": inputArr[i] }; this.numTerms++; } }, + removeTermByIdx: function(index) { this.advTerms.splice(index, 1); this.numTerms--; }, + toCCL: function() { var ccl = ''; @@ -706,77 +961,40 @@ pzQuery.prototype = { for(var i = 0; i < this.advTerms.length; i++) { if (ccl != '') ccl = ccl + ' and '; - ccl = ccl + this.advTerms[i].field+'="'+this.advTerms[i].value+'"'; + 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; - } -} + }, + getSingleFilterString: function() + { + if( this.singleFilter != null ) { + return 'pz:id='+this.singleFilter.id; + } else { + return undefined; + } + } +}; }