Minor changes to make it easier for for the server side scipt to init session.

[pazpar2-moved-to-github.git] / js / pz2.js

diff --git a/js/pz2.js b/js/pz2.js
index ff5ca24..8df8061 100644 (file)
--- a/js/pz2.js
+++ b/js/pz2.js
@@ -1,5 +1,5 @@
 /*
-** $Id: pz2.js,v 1.5 2007-04-03 14:27:21 jakub Exp $
+** $Id: pz2.js,v 1.12 2007-05-02 19:32:13 jakub Exp $
 ** pz2.js - pazpar2's javascript client library.
 */
 
@@ -33,7 +33,11 @@ var pz2 = function(paramArray) {
 
     // at least one callback required
     if ( !paramArray )
-        throw new Error("An array with parameters has to be suplied when instantiating a class");   
+        throw new Error("An array with parameters has to be suplied when instantiating a class");
+
+    //supported pazpar2's protocol version
+    __myself.suppProtoVer = '1';
+    __myself.errorHandler = paramArray.errorhandler || null;
     
     // function callbacks
     __myself.statCallback = paramArray.onstat || null;
@@ -75,6 +79,7 @@ var pz2 = function(paramArray) {
     __myself.termTimer = null;
     __myself.showTime = paramArray.showtime || 1000;
     __myself.showTimer = null;
+    __myself.showFastCount = 4;
     __myself.bytargetTime = paramArray.bytargettime || 1000;
     __myself.bytargetTimer = null;
 
@@ -89,38 +94,64 @@ var pz2 = function(paramArray) {
 
     // error handling
     $(document).ajaxError( 
-    function (request, settings, exception) {
-        if ( settings.responseXML && settings.responseXML.getElementsByTagName("error") )
-            throw new Error( settings.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue);
+    function (ajaxError, xhr, reqSettings, prevException)
+    {
+        if ( xhr.responseXML && xhr.responseXML.getElementsByTagName("error").length )
+       {
+           var errMsg = xhr.responseXML.getElementsByTagName("error")[0].childNodes[0].nodeValue;
+            var errCode = xhr.responseXML.getElementsByTagName("error")[0].getAttribute("code");
+            
+            var err = new Error(errMsg);
+            err.code = errCode;
+           
+            if (__myself.errorHandler) {
+                __myself.errorHandler(err);
+            }
+            else {
+                throw err;
+            }
+       }
+        // ensure the errors are propagated
+       else if (prevException != undefined ) {
+           throw prevException;
+        }
+        else {
+                throw new Error("XMLHttpRequest error. STATUS: " + xhr.status + " STATUS TEXT: " + xhr.statusText);
+        }
     });
     
     // auto init session?
     if (paramArray.autoInit !== false)
-        __myself.init(__myself.keepAlive);
+        __myself.init();
 };
 pz2.prototype = {
-    init: function(keepAlive) 
-    {
-        if ( keepAlive < __myself.keepAlive )
-            __myself.keepAlive = keepAlive;  
-        
-        $.get( __myself.pz2String,
-            { "command": "init" },
-            function(data) {
-                if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
-                    __myself.initStatusOK = true;
-                    __myself.sessionID = data.getElementsByTagName("session")[0].childNodes[0].nodeValue;
-                    setTimeout(__myself.ping, __myself.keepAlive);
+    init: function ( sessionId ) 
+    {   
+        if ( sessionId != undefined ) {
+            __myself.initStatusOK = true;
+            __myself.sessionID = sessionId;
+            __myself.ping();
+        } else {
+            $.get( __myself.pz2String,
+                { "command": "init" },
+                function(data) {
+                    if ( data.getElementsByTagName("status")[0].childNodes[0].nodeValue == "OK" ) {
+                        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;
+                        setTimeout("__myself.ping()", __myself.keepAlive);
+                    }
+                    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);
                 }
-                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);
-            }
-        );
+            );
+        }
     },
     // no need to ping explicitly
-    ping: function() 
+    ping: function () 
     {
         if( !__myself.initStatusOK )
             return;
@@ -140,7 +171,7 @@ pz2.prototype = {
             }
         );
     },
-    search: function(query, num, sort, filter)
+    search: function (query, num, sort, filter)
     {
         clearTimeout(__myself.statTimer);
         clearTimeout(__myself.showTimer);
@@ -256,18 +287,33 @@ pz2.prototype = {
                     var hit = new Array();
                     for (i = 0; i < hits.length; i++) {
                         show.hits[i] = new Array();
+                       show.hits[i]['location'] = new Array();
                         for ( j = 0; j < hits[i].childNodes.length; j++) {
+                           var locCount = 0;
                             if ( hits[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
-                                var nodeName = hits[i].childNodes[j].nodeName;
-                                var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
-                                show.hits[i][nodeName] = nodeText;
+                               if (hits[i].childNodes[j].nodeName == 'location') {
+                                   var locNode = hits[i].childNodes[j];
+                                   var id = locNode.getAttribute('id');
+                                   show.hits[i]['location'][id] = {
+                                       "id": locNode.getAttribute("id"),
+                                       "name": locNode.getAttribute("name")
+                                   };
+                               }
+                               else {
+                                   var nodeName = hits[i].childNodes[j].nodeName;
+                                    var nodeText = hits[i].childNodes[j].firstChild.nodeValue;
+                                   show.hits[i][nodeName] = nodeText;
+                               }
                             }
                         }
                     }
                     __myself.showCallback(show);
                     __myself.showCounter++;
+                   var delay = __myself.showTime;
+                   if (__myself.showCounter > __myself.showFastCount)
+                           delay *= 2;
                     if (activeClients > 0)
-                        __myself.showTimer = setTimeout("__myself.show()", (__myself.showTime + __myself.showCounter*__myself.dumpFactor));
+                        __myself.showTimer = setTimeout("__myself.show()", delay);
                 }
                 else
                     // if it gets here the http return code was 200 (pz2 errors are 417)
@@ -308,7 +354,11 @@ pz2.prototype = {
                         for ( j = 0; j < locationNodes[i].childNodes.length; j++) {
                             if ( locationNodes[i].childNodes[j].nodeType == Node.ELEMENT_NODE ) {
                                 var nodeName = locationNodes[i].childNodes[j].nodeName;
-                                var nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
+                                var nodeText;
+                               if (locationNodes[i].childNodes[j].firstChild)
+                                       nodeText = locationNodes[i].childNodes[j].firstChild.nodeValue;
+                               else
+                                       nodeText = '';
                                 record["location"][i][nodeName] = nodeText;                            
                             }
                         }