Pazpar2 1.4.4-2 for squeeze
[pazpar2-moved-to-github.git] / js / pz2.js
index dc95572..3665c4e 100644 (file)
--- a/js/pz2.js
+++ b/js/pz2.js
@@ -1,5 +1,5 @@
 /*
-** $Id: pz2.js,v 1.70 2008-03-12 11:36:57 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;
@@ -68,6 +69,7 @@ var pz2 = function ( paramArray )
         this.keepAlive = paramArray.keepAlive;
 
     this.sessionID = null;
+    this.serviceId = paramArray.serviceId || null;
     this.initStatusOK = false;
     this.pingStatusOK = false;
     this.searchStatusOK = false;
@@ -98,6 +100,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;
@@ -105,6 +109,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
@@ -117,7 +122,7 @@ var pz2 = function ( paramArray )
     }
     // else, auto init session or wait for a user init?
     if (this.useSessions && paramArray.autoInit !== false) {
-        this.init();
+        this.init(this.sessionId, this.serviceId);
     }
 };
 
@@ -161,12 +166,12 @@ pz2.prototype =
                 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();
@@ -174,8 +179,10 @@ pz2.prototype =
         } else if (this.useSessions) {
             var context = this;
             var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-            request.postParams(
-                { "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" ) {
@@ -218,7 +225,7 @@ pz2.prototype =
             );
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.postParams(
+        request.safeGet(
             { "command": "ping", "session": this.sessionID },
             function(data) {
                 if ( data.getElementsByTagName("status")[0]
@@ -237,7 +244,7 @@ pz2.prototype =
             }
         );
     },
-    search: function (query, num, sort, filter, showfrom)
+    search: function (query, num, sort, filter, showfrom, addParamsArr)
     {
         clearTimeout(this.statTimer);
         clearTimeout(this.showTimer);
@@ -248,6 +255,7 @@ pz2.prototype =
         this.termCounter = 0;
         this.bytargetCounter = 0;
         this.statCounter = 0;
+        this.activeClients = 1;
         
         // no proxy mode
         if( !this.initStatusOK )
@@ -271,10 +279,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.postParams(
+        request.safeGet(
             searchParams,
             function(data) {
                 if ( data.getElementsByTagName("status")[0]
@@ -282,11 +298,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
@@ -305,7 +321,7 @@ pz2.prototype =
         
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.postParams(
+        request.safeGet(
             { "command": "stat", "session": this.sessionID },
             function(data) {
                 if ( data.getElementsByTagName("stat") ) {
@@ -313,37 +329,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;
@@ -383,62 +371,72 @@ pz2.prototype =
 
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.postParams(
-            { 
-                "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)
@@ -478,11 +476,11 @@ pz2.prototype =
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
 
-        request.postParams(
+        request.safeGet(
            recordParams,
             function(data) {
                 var recordNode;
-                var record;
+                var record;                                
                 //raw record
                 if (context.currRecOffset !== null) {
                     record = new Array();
@@ -503,7 +501,21 @@ pz2.prototype =
                     //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
@@ -525,7 +537,7 @@ pz2.prototype =
         
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.postParams(
+        request.safeGet(
             { 
                 "command": "termlist", 
                 "session": this.sessionID, 
@@ -605,7 +617,7 @@ pz2.prototype =
         
         var context = this;
         var request = new pzHttpRequest(this.pz2String, this.errorHandler);
-        request.postParams(
+        request.safeGet(
             { "command": "bytarget", "session": this.sessionID },
             function(data) {
                 if ( data.getElementsByTagName("status")[0]
@@ -625,6 +637,13 @@ pz2.prototype =
                                 bytarget[i][nodeName] = nodeText;
                             }
                         }
+                        if (bytarget[i]["state"]=="Client_Disconnected") {
+                          bytarget[i]["hits"] = "Error";
+                        } else if (bytarget[i]["state"]=="Client_Error") {
+                          bytarget[i]["hits"] = "Error";                          
+                        } else if (bytarget[i]["state"]=="Client_Working") {
+                          bytarget[i]["hits"] = "...";
+                        }
                     }
                     
                     context.bytargetCounter++;
@@ -677,6 +696,7 @@ pz2.prototype =
 ********************************************************************************
 */
 var pzHttpRequest = function ( url, errorHandler ) {
+        this.maxUrlLength = 2048;
         this.request = null;
         this.url = url;
         this.errorHandler = errorHandler || null;
@@ -694,22 +714,32 @@ var pzHttpRequest = function ( url, errorHandler ) {
         }
 };
 
+
 pzHttpRequest.prototype = 
 {
-    postParams: function ( params, callback )
+    safeGet: function ( params, callback )
     {
-        this.requestHeaders["Content-Type"]="application/x-www-form-urlencoded";
-        this._send('POST', {}, this.encodeParams(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 ()
@@ -734,51 +764,42 @@ pzHttpRequest.prototype =
         return encoded;
     },
 
-    _send: function ( type, params, data, callback )
+    _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 encodedParams = this.encodeParams(params);
         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;
            
@@ -788,14 +809,54 @@ 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 = null; 
+               var text = this.request.responseText;
+               if (typeof window.JSON == "undefined") 
+                   json = eval("(" + text + ")");
+               else { 
+                   try {
+                       json = JSON.parse(text);
+                   }
+                   catch (e) {
+                       // Safari: eval will fail as well. Considering trying JSON2 (non-native implementation) instead
+                       /* DEBUG only works in mk2-mobile
+                       if (document.getElementById("log")) 
+                           document.getElementById("log").innerHTML = "" + e + " " + length + ": " + text;
+                       */
+                       try {
+                           json = eval("(" + text + ")");
+                       }
+                       catch (e) {
+                           /* DEBUG only works in mk2-mobile
+                           if (document.getElementById("log")) 
+                               document.getElementById("log").innerHTML = "" + e + " " + length + ": " + text;
+                           */
+                       }
+                   }
+               } 
+               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);
                 }
@@ -959,7 +1020,7 @@ Element_parseChildNodes = function (node)
     // if no nested elements, get text content
     if (node.hasChildNodes() && !hasChildElems) {
         if (node.attributes.length) 
-            parsed['textContent'] = node.firstChild.nodeValue;
+            parsed['#text'] = node.firstChild.nodeValue;
         else
             parsed = node.firstChild.nodeValue;
     }