Add <progress /> tag to support a progress bar. The value is between 0 ... 1
[pazpar2-moved-to-github.git] / js / pz2.js
index 21990d0..4f089a1 100644 (file)
--- a/js/pz2.js
+++ b/js/pz2.js
@@ -1,5 +1,5 @@
 /*
-** $Id: pz2.js,v 1.69 2008-02-14 12:20:24 jakub Exp $
+** $Id: pz2.js,v 1.70 2008-03-12 11:36:57 jakub Exp $
 ** pz2.js - pazpar2's javascript client library.
 */
 
@@ -174,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]
@@ -218,7 +218,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]
@@ -237,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);
@@ -271,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]
@@ -305,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") ) {
@@ -324,14 +332,14 @@ pz2.prototype =
                         "clients": 
                             Number( data.getElementsByTagName("clients")[0]
                                         .childNodes[0].nodeValue ),
-                        "initializing": 
-                            Number( data.getElementsByTagName("initializing")[0]
+                        "unconnected": 
+                            Number( data.getElementsByTagName("unconnected")[0]
                                         .childNodes[0].nodeValue ),
-                        "searching": 
-                            Number( data.getElementsByTagName("searching")[0]
+                        "connecting": 
+                            Number( data.getElementsByTagName("connecting")[0]
                                         .childNodes[0].nodeValue ),
-                        "presenting": 
-                            Number( data.getElementsByTagName("presenting")[0]
+                        "working": 
+                            Number( data.getElementsByTagName("working")[0]
                                         .childNodes[0].nodeValue ),
                         "idle": 
                             Number( data.getElementsByTagName("idle")[0]
@@ -341,6 +349,9 @@ pz2.prototype =
                                         .childNodes[0].nodeValue ),
                         "error": 
                             Number( data.getElementsByTagName("error")[0]
+                                        .childNodes[0].nodeValue ),
+                        "progress": 
+                            Number( data.getElementsByTagName("progress")[0]
                                         .childNodes[0].nodeValue )
                     };
                     
@@ -383,7 +394,7 @@ pz2.prototype =
 
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.get(
+        request.safeGet(
             { 
                 "command": "show", 
                 "session": this.sessionID, 
@@ -478,7 +489,7 @@ pz2.prototype =
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
 
-        request.get(
+        request.safeGet(
            recordParams,
             function(data) {
                 var recordNode;
@@ -525,7 +536,7 @@ pz2.prototype =
         
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.get(
+        request.safeGet(
             { 
                 "command": "termlist", 
                 "session": this.sessionID, 
@@ -605,7 +616,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]
@@ -677,10 +688,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();
@@ -695,14 +708,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 ()
@@ -714,55 +742,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;
            
@@ -772,13 +800,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);
@@ -933,18 +961,16 @@ Element_parseChildNodes = function (node)
         }
     }
 
-    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()) 
+        if (node.attributes.length) 
             parsed['textContent'] = node.firstChild.nodeValue;
         else
             parsed = node.firstChild.nodeValue;