Fixed bug #165 (ignoring the exception) and #156 (ifModified option added to $.ajax)
[jquery.git] / src / ajax / ajax.js
index 72f87f2..1426604 100644 (file)
@@ -198,6 +198,46 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * @param Function callback The function to execute.
  * @cat AJAX
  */
+/**
+ * @test stop(); var counter = { complete: 0, success: 0, error: 0 };
+ * var success = function() { counter.success++ };
+ * var error = function() { counter.error++ };
+ * var complete = function() { counter.complete++ };
+ * $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success);
+ * // start with successful test
+ * $.ajax({url: "data/name.php", success: success, error: error, complete: function() {
+ *   ok( counter.error == 0, 'Check succesful request' );
+ *   ok( counter.success == 2, 'Check succesful request' );
+ *   ok( counter.complete == 3, 'Check succesful request' );
+ *   counter.error = 0; counter.success = 0; counter.complete = 0;
+ *   $.ajaxTimeout(500);
+ *   $.ajax({url: "data/name.php?wait=5", success: success, error: error, complete: function() {
+ *     ok( counter.error == 2, 'Check failed request' );
+ *     ok( counter.success == 0, 'Check failed request' );
+ *     ok( counter.complete == 3, 'Check failed request' );
+ *     counter.error = 0; counter.success = 0; counter.complete = 0;
+ *     $.ajaxTimeout(0);
+ *     $.ajax({url: "data/name.php?wait=5", global: false, success: success, error: error, complete: function() {
+ *       ok( counter.error == 0, 'Check sucesful request without globals' );
+ *       ok( counter.success == 1, 'Check sucesful request without globals' );
+ *       ok( counter.complete == 0, 'Check sucesful request without globals' );
+ *       counter.error = 0; counter.success = 0; counter.complete = 0;
+ *       $.ajaxTimeout(500);
+ *       $.ajax({url: "data/name.php?wait=5", global: false, success: success, error: error, complete: function() {
+ *         ok( counter.error == 1, 'Check failedrequest without globals' );
+ *         ok( counter.success == 0, 'Check failed request without globals' );
+ *         ok( counter.complete == 0, 'Check failed request without globals' );
+ *         start();
+ *       }});
+ *     }});
+ *   }});
+ * }});
+ * 
+ * @name ajaxHandlersTesting
+ * @private
+ */
 
 new function(){
        var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(",");
@@ -286,6 +326,12 @@ jQuery.extend({
         *   }
         * )
         *
+        * @test stop();
+        * $.getIfModified("data/name.php", function(msg) {
+        *     ok( msg == 'ERROR', 'Check ifModified' );
+        *     start();
+        * });
+        *
         * @name $.getIfModified
         * @type jQuery
         * @param String url The URL of the page to load.
@@ -430,11 +476,11 @@ jQuery.extend({
         *      if(passed == 2) {
         *              ok( true, 'Check local and global callbacks after timeout' );
         *              clearTimeout(timeout);
+        *      $('#main').unbind("ajaxError");
         *              start();
         *      }
         * };
-        * var fail = function(ba) {
-        *      console.debug(ba);
+        * var fail = function() {
         *      ok( false, 'Check for timeout failed' );
         *      start();
         * };
@@ -447,6 +493,22 @@ jQuery.extend({
         *   success: fail
         * });
         *
+        * @test stop(); $.ajaxTimeout(50);
+        * $.ajax({
+        *   type: "GET",
+        *   timeout: 5000,
+        *   url: "data/name.php?wait=1",
+        *   error: function() {
+        *         ok( false, 'Check for local timeout failed' );
+        *         start();
+        *   },
+        *   success: function() {
+        *     ok( true, 'Check for local timeout' );
+        *     start();
+        *   }
+        * });
+        * 
+        *
         * @name $.ajaxTimeout
         * @type jQuery
         * @param Number time How long before an AJAX request times out.
@@ -475,6 +537,18 @@ jQuery.extend({
         * (String) dataType - The type of data that you're expecting back from
         * the server (e.g. "xml", "html", "script", or "json").
         *
+        * (Boolean) ifModified - Allow the request to be successful only if the
+        * response has changed since the last request, default is false, ignoring
+        * the Last-Modified header
+        *
+        * (Number) timeout - Local timeout to override global timeout, eg. to give a
+        * single request a longer timeout while all others timeout after 1 seconds,
+        * see $.ajaxTimeout
+        *
+        * (Boolean) global - Wheather to trigger global AJAX event handlers for
+        * this request, default is true. Set to true to prevent that global handlers
+        * like ajaxStart or ajaxStop are triggered.
+        *
         * (Function) error - A function to be called if the request fails. The
         * function gets passed two arguments: The XMLHttpRequest object and a
         * string describing the type of error that occurred.
@@ -538,13 +612,16 @@ jQuery.extend({
                        var success = type.success;
                        var error = type.error;
                        var dataType = type.dataType;
+                       var global = typeof type.global == "boolean" ? type.global : true;
+                       var timeout = typeof type.timeout == "number" ? type.timeout : jQuery.timeout;
+                       var ifModified = type.ifModified || false;
                        data = type.data;
                        url = type.url;
                        type = type.type;
                }
                
                // Watch for a new set of requests
-               if ( ! jQuery.active++ )
+               if ( global && ! jQuery.active++ )
                        jQuery.event.trigger( "ajaxStart" );
 
                var requestDone = false;
@@ -583,15 +660,21 @@ jQuery.extend({
                                // Make sure that the request was successful or notmodified
                                if ( status != "error" ) {
                                        // Cache Last-Modified header, if ifModified mode.
-                                       var modRes = xml.getResponseHeader("Last-Modified");
-                                       if ( ifModified && modRes ) jQuery.lastModified[url] = modRes;
+                                       var modRes;
+                                       try {
+                                               modRes = xml.getResponseHeader("Last-Modified");
+                                       } catch(e) {} // swallow exception thrown by FF if header is not available
+                                       
+                                       if ( ifModified && modRes )
+                                               jQuery.lastModified[url] = modRes;
                                        
                                        // If a local callback was specified, fire it
                                        if ( success )
                                                success( jQuery.httpData( xml, dataType ), status );
                                        
                                        // Fire the global callback
-                                       jQuery.event.trigger( "ajaxSuccess" );
+                                       if( global )
+                                               jQuery.event.trigger( "ajaxSuccess" );
                                
                                // Otherwise, the request was not successful
                                } else {
@@ -599,14 +682,16 @@ jQuery.extend({
                                        if ( error ) error( xml, status );
                                        
                                        // Fire the global callback
-                                       jQuery.event.trigger( "ajaxError" );
+                                       if( global )
+                                               jQuery.event.trigger( "ajaxError" );
                                }
                                
                                // The request was completed
-                               jQuery.event.trigger( "ajaxComplete" );
+                               if( global )
+                                       jQuery.event.trigger( "ajaxComplete" );
                                
                                // Handle the global AJAX counter
-                               if ( ! --jQuery.active )
+                               if ( global && ! --jQuery.active )
                                        jQuery.event.trigger( "ajaxStop" );
        
                                // Process result
@@ -621,7 +706,7 @@ jQuery.extend({
                xml.onreadystatechange = onreadystatechange;
                
                // Timeout checker
-               if(jQuery.timeout > 0)
+               if(timeout > 0)
                        setTimeout(function(){
                                // Check to see if the request is still happening
                                if (xml) {
@@ -633,7 +718,7 @@ jQuery.extend({
                                        // Clear from memory
                                        xml = null;
                                }
-                       }, jQuery.timeout);
+                       }, timeout);
                
                // Send the data
                xml.send(data);