Fixed #471
[jquery.git] / src / ajax / ajax.js
index 8012733..fa48afa 100644 (file)
@@ -33,34 +33,6 @@ jQuery.fn.extend({
         * @desc Same as above, but with an additional parameter
         * and a callback that is executed when the data was loaded.
         *
-        * @test stop();
-        * $('#first').load("data/name.php", function() {
-        *      ok( $('#first').text() == 'ERROR', 'Check if content was injected into the DOM' );
-        *      start();
-        * });
-        *
-        * @test stop(); // check if load can be called with only url
-        * $('#first').load("data/name.php");
-        * $.get("data/name.php", function() {
-        *   ok( $('#first').text() == 'ERROR', 'Check if load works without callback');
-        *   start();
-        * });
-        *
-        * @test stop();
-        * window.foobar = undefined;
-        * window.foo = undefined;
-        * var verifyEvaluation = function() {
-        *   ok( foobar == "bar", 'Check if script src was evaluated after load' );
-        *   ok( $('#foo').html() == 'foo', 'Check if script evaluation has modified DOM');
-        *   ok( $('#ap').html() == 'bar', 'Check if script evaluation has modified DOM');
-        *   start();
-        * };
-        * $('#first').load('data/test.html', function() {
-        *   ok( $('#first').html().match(/^html text/), 'Check content after loading html' );
-        *   ok( foo == "foo", 'Check if script was evaluated after load' );
-        *   setTimeout(verifyEvaluation, 600);
-        * });
-        *
         * @name load
         * @type jQuery
         * @param String url The URL of the HTML file to load.
@@ -129,10 +101,6 @@ jQuery.fn.extend({
         * @after name=John&location=Boston
         * @desc Serialize a selection of input elements to a string
         *
-        * @test var data = $(':input').not('button').serialize();
-        * // ignore button, IE takes text content as value, not relevant for this test
-        * ok( data == 'action=Test&text2=Test&radio1=on&radio2=on&check=on&=on&hidden=&foo[bar]=&name=name&=foobar&select1=&select2=3&select3=1', 'Check form serialization as query string' );
-        *
         * @name serialize
         * @type String
         * @cat AJAX
@@ -154,9 +122,10 @@ jQuery.fn.extend({
                return this.find('script').each(function(){
                        if ( this.src )
                                // for some weird reason, it doesn't work if the callback is ommited
-                               jQuery.getScript( this.src, function() {} );
-                       else
-                               eval.call( window, this.text || this.textContent || this.innerHTML || "" );
+                               jQuery.getScript( this.src );
+                       else {
+                               jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
+                       }
                }).end();
        }
 
@@ -165,10 +134,7 @@ jQuery.fn.extend({
 // If IE is used, create a wrapper for the XMLHttpRequest object
 if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
        XMLHttpRequest = function(){
-               return new ActiveXObject(
-                       navigator.userAgent.indexOf("MSIE 5") >= 0 ?
-                       "Microsoft.XMLHTTP" : "Msxml2.XMLHTTP"
-               );
+               return new ActiveXObject("Microsoft.XMLHTTP");
        };
 
 // Attach a bunch of functions for handling common AJAX events
@@ -204,7 +170,10 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
 /**
  * Attach a function to be executed whenever an AJAX request completes.
  *
- * @example $("#msg").ajaxComplete(function(){
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxComplete(function(request, settings){
  *   $(this).append("<li>Request Complete.</li>");
  * });
  * @desc Show a message when an AJAX request completes.
@@ -219,7 +188,10 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
  * Attach a function to be executed whenever an AJAX request completes
  * successfully.
  *
- * @example $("#msg").ajaxSuccess(function(){
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxSuccess(function(request, settings){
  *   $(this).append("<li>Successful Request!</li>");
  * });
  * @desc Show a message when an AJAX request completes successfully.
@@ -233,8 +205,11 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
 /**
  * Attach a function to be executed whenever an AJAX request fails.
  *
- * @example $("#msg").ajaxError(function(){
- *   $(this).append("<li>Error requesting page.</li>");
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
+ *
+ * @example $("#msg").ajaxError(function(request, settings){
+ *   $(this).append("<li>Error requesting page " + settings.url + "</li>");
  * });
  * @desc Show a message when an AJAX request fails.
  *
@@ -243,54 +218,26 @@ 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' );
- *     start();
- *   }});
- * }});
-
- * @test stop(); var counter = { complete: 0, success: 0, error: 0 };
- * counter.error = 0; counter.success = 0; counter.complete = 0;
- * var success = function() { counter.success++ };
- * var error = function() { counter.error++ };
- * $.ajaxTimeout(0);
- * $.ajax({url: "data/name.php", 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 failed request without globals' );
- *      ok( counter.success == 0, 'Check failed request without globals' );
- *      ok( counter.complete == 0, 'Check failed request without globals' );
- *      start();
- *   }});
- * }});
+ * Attach a function to be executed before an AJAX request is send.
+ *
+ * The XMLHttpRequest and settings used for that request are passed
+ * as arguments to the callback.
  *
- * @name ajaxHandlersTesting
- * @private
+ * @example $("#msg").ajaxSend(function(request, settings){
+ *   $(this).append("<li>Starting request at " + settings.url + "</li>");
+ * });
+ * @desc Show a message before an AJAX request is send.
+ *
+ * @name ajaxSend
+ * @type jQuery
+ * @param Function callback The function to execute.
+ * @cat AJAX
  */
 
-
 new function(){
-       var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(",");
+       var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(",");
 
        for ( var i = 0; i < e.length; i++ ) new function(){
                var o = e[i];
@@ -321,17 +268,6 @@ jQuery.extend({
         *   }
         * )
         *
-        * @test stop();
-        * $.get('data/dashboard.xml', function(xml) {
-        *      var content = [];
-        *      $('tab', xml).each(function() {
-        *              content.push($(this).text());
-        *      });
-        *      ok( content[0] == 'blabla', 'Check first tab');
-        *      ok( content[1] == 'blublu', 'Check second tab');
-        *      start();
-        * });
-        *
         * @name $.get
         * @type undefined
         * @param String url The URL of the page to load.
@@ -376,12 +312,6 @@ jQuery.extend({
         *   }
         * )
         *
-        * @test stop();
-        * $.getIfModified("data/name.php", function(msg) {
-        *     ok( msg == 'ERROR', 'Check ifModified' );
-        *     start();
-        * });
-        *
         * @name $.getIfModified
         * @type undefined
         * @param String url The URL of the page to load.
@@ -397,22 +327,16 @@ jQuery.extend({
         * Loads, and executes, a remote JavaScript file using an HTTP GET request.
         * All of the arguments to the method (except URL) are optional.
         *
+        * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
+        * context sychronously. If you load functions via getScript, make sure
+        * to call them after a delay.
+        *
         * @example $.getScript("test.js")
         *
         * @example $.getScript("test.js", function(){
         *   alert("Script loaded and executed.");
         * })
         *
-        * @test stop();
-        * $.getScript("data/test.js", function() {
-        *      ok( foobar == "bar", 'Check if script was evaluated' );
-        *      start();
-        * });
-        *
-        * @test
-        * $.getScript("data/test.js");
-        * ok( true, "Check with single argument, can't verify" );
-        *
         * @name $.getScript
         * @type undefined
         * @param String url The URL of the page to load.
@@ -442,21 +366,6 @@ jQuery.extend({
         *   }
         * )
         *
-        * @test stop();
-        * $.getJSON("data/json.php", {json: "array"}, function(json) {
-        *   ok( json[0].name == 'John', 'Check JSON: first, name' );
-        *   ok( json[0].age == 21, 'Check JSON: first, age' );
-        *   ok( json[1].name == 'Peter', 'Check JSON: second, name' );
-        *   ok( json[1].age == 25, 'Check JSON: second, age' );
-        *   start();
-        * });
-        * @test stop();
-        * $.getJSON("data/json.php", function(json) {
-        *   ok( json.data.lang == 'en', 'Check JSON: lang' );
-        *   ok( json.data.length == 25, 'Check JSON: length' );
-        *   start();
-        * });
-        *
         * @name $.getJSON
         * @type undefined
         * @param String url The URL of the page to load.
@@ -487,15 +396,6 @@ jQuery.extend({
         *   }
         * )
         *
-        * @test stop();
-        * $.post("data/name.php", {xml: "5-2"}, function(xml){
-        *   $('math', xml).each(function() {
-        *          ok( $('calculation', this).text() == '5-2', 'Check for XML' );
-        *          ok( $('result', this).text() == '3', 'Check for XML' );
-        *       });
-        *   start();
-        * });
-        *
         * @name $.post
         * @type undefined
         * @param String url The URL of the page to load.
@@ -525,50 +425,6 @@ jQuery.extend({
         * @example $.ajaxTimeout( 5000 );
         * @desc Make all AJAX requests timeout after 5 seconds.
         *
-        * @test stop();
-        * var passed = 0;
-        * var timeout;
-        * $.ajaxTimeout(1000);
-        * var pass = function() {
-        *      passed++;
-        *      if(passed == 2) {
-        *              ok( true, 'Check local and global callbacks after timeout' );
-        *              clearTimeout(timeout);
-        *      $('#main').unbind("ajaxError");
-        *              start();
-        *      }
-        * };
-        * var fail = function() {
-        *      ok( false, 'Check for timeout failed' );
-        *      start();
-        * };
-        * timeout = setTimeout(fail, 1500);
-        * $('#main').ajaxError(pass);
-        * $.ajax({
-        *   type: "GET",
-        *   url: "data/name.php?wait=5",
-        *   error: pass,
-        *   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();
-        *   }
-        * });
-        * // reset timeout
-        * $.ajaxTimeout(0);
-        *
-        *
         * @name $.ajaxTimeout
         * @type undefined
         * @param Number time How long before an AJAX request times out.
@@ -583,22 +439,37 @@ jQuery.extend({
 
        /**
         * Load a remote page using an HTTP request. This function is the primary
-        * means of making AJAX requests using jQuery. $.ajax() takes one property,
-        * an object of key/value pairs, that're are used to initalize the request.
+        * means of making AJAX requests using jQuery. 
         *
         * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
         * need that object to manipulate directly, but it is available if you need to
         * abort the request manually.
         *
-        * These are all the key/values that can be passed in to 'prop':
+        * Please note: Make sure the server sends the right mimetype (eg. xml as
+        * "text/xml"). Sending the wrong mimetype will get you into serious
+        * trouble that jQuery can't solve.
+        *
+        * Supported datatypes (see dataType option) are:
+        *
+        * "xml": Returns a XML document that can be processed via jQuery.
         *
-        * (String) type - The type of request to make (e.g. "POST" or "GET").
+        * "html": Returns HTML as plain text, included script tags are evaluated.
+        *
+        * "script": Evaluates the response as Javascript and returns it as plain text.
+        *
+        * "json": Evaluates the response as JSON and returns a Javascript Object
+        *
+        * $.ajax() takes one property, an object of key/value pairs, that are
+        * used to initalize the request. These are all the key/values that can
+        * be passed in to 'prop':
         *
         * (String) url - The URL of the page to request.
         *
+        * (String) type - The type of request to make (e.g. "POST" or "GET"), default is "GET".
         *
         * (String) dataType - The type of data that you're expecting back from
-        * the server (e.g. "xml", "html", "script", or "json").
+        * the server. No default: If the server sends xml, the responseXML, otherwise
+        * the responseText is is passed to the success callback.
         *
         * (Boolean) ifModified - Allow the request to be successful only if the
         * response has changed since the last request, default is false, ignoring
@@ -606,10 +477,10 @@ jQuery.extend({
         *
         * (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
+        * 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
+        * this request, default is true. Set to false to prevent that global handlers
         * like ajaxStart or ajaxStop are triggered.
         *
         * (Function) error - A function to be called if the request fails. The
@@ -624,7 +495,7 @@ jQuery.extend({
         * function gets passed two arguments: The XMLHttpRequest object and a
         * string describing the type the success of the request.
         *
-        * (String) data - Data to be sent to the server. Converted to a query
+        * (Object|String) data - Data to be sent to the server. Converted to a query
         * string, if not already a string. Is appended to the url for GET-requests.
         * Override processData option to prevent processing.
         *
@@ -639,6 +510,9 @@ jQuery.extend({
         * (Boolean) async - By default, all requests are send asynchronous (set to true).
         * If you need synchronous requests, set this option to false.
         *
+        * (Function) beforeSend - A pre-callback to set custom headers etc., the
+        * XMLHttpRequest is passed as the only argument.
+        *
         * @example $.ajax({
         *   type: "GET",
         *   url: "test.js",
@@ -656,54 +530,6 @@ jQuery.extend({
         * });
         * @desc Save some data to the server and notify the user once its complete.
         *
-        * @test stop();
-        * $.ajax({
-        *   type: "GET",
-        *   url: "data/name.php?name=foo",
-        *   success: function(msg){
-        *     ok( msg == 'bar', 'Check for GET' );
-        *     start();
-        *   }
-        * });
-        *
-        * @test stop();
-        * $.ajax({
-        *   type: "POST",
-        *   url: "data/name.php",
-        *   data: "name=peter",
-        *   success: function(msg){
-        *     ok( msg == 'pan', 'Check for POST' );
-        *     start();
-        *   }
-        * });
-        *
-        * @test stop();
-        * window.foobar = undefined;
-        * window.foo = undefined;
-        * var verifyEvaluation = function() {
-        *   ok( foobar == "bar", 'Check if script src was evaluated for datatype html' );
-        *   start();
-        * };
-        * $.ajax({
-        *   dataType: "html",
-        *   url: "data/test.html",
-        *   success: function(data) {
-        *     ok( data.match(/^html text/), 'Check content for datatype html' );
-        *     ok( foo == "foo", 'Check if script was evaluated for datatype html' );
-        *     setTimeout(verifyEvaluation, 600);
-        *   }
-        * });
-        *
-        * @test stop();
-        * $.ajax({
-        *   url: "data/with_fries.xml", dataType: "xml", type: "GET", data: "", success: function(resp) {
-        *     ok( $("properties", resp).length == 1, 'properties in responseXML' );
-        *     ok( $("jsconf", resp).length == 1, 'jsconf in responseXML' );
-        *     ok( $("thing", resp).length == 2, 'things in responseXML' );
-        *     start();
-        *   }
-        * });
-        *
         * @name $.ajax
         * @type XMLHttpRequest
         * @param Hash prop A set of properties to initialize the request with.
@@ -724,7 +550,8 @@ jQuery.extend({
                        data: null,
                        contentType: "application/x-www-form-urlencoded",
                        processData: true,
-                       async: true
+                       async: true,
+                       beforeSend: null
                }, s);
 
                // if data available
@@ -765,6 +592,12 @@ jQuery.extend({
                // Make sure the browser sends the right content length
                if ( xml.overrideMimeType )
                        xml.setRequestHeader("Connection", "close");
+                       
+               // Allow custom headers/mimetypes
+               if( s.beforeSend )
+                       s.beforeSend(xml);
+               if (s.global)
+                   jQuery.event.trigger("ajaxSend", [xml, s]);
 
                // Wait for a response to come back
                var onreadystatechange = function(isTimeout){
@@ -786,13 +619,16 @@ jQuery.extend({
                                        if ( s.ifModified && modRes )
                                                jQuery.lastModified[s.url] = modRes;
 
-                                       // If a local callback was specified, fire it
+                                       // process the data (runs the xml through httpData regardless of callback)
+                                       var data = jQuery.httpData( xml, s.dataType );
+
+                                       // If a local callback was specified, fire it and pass it the data
                                        if ( s.success )
-                                               s.success( jQuery.httpData( xml, s.dataType ), status );
+                                               s.success( data, status );
 
                                        // Fire the global callback
                                        if( s.global )
-                                               jQuery.event.trigger( "ajaxSuccess" );
+                                               jQuery.event.trigger( "ajaxSuccess", [xml, s] );
 
                                // Otherwise, the request was not successful
                                } else {
@@ -801,12 +637,12 @@ jQuery.extend({
 
                                        // Fire the global callback
                                        if( s.global )
-                                               jQuery.event.trigger( "ajaxError" );
+                                               jQuery.event.trigger( "ajaxError", [xml, s] );
                                }
 
                                // The request was completed
                                if( s.global )
-                                       jQuery.event.trigger( "ajaxComplete" );
+                                       jQuery.event.trigger( "ajaxComplete", [xml, s] );
 
                                // Handle the global AJAX counter
                                if ( s.global && ! --jQuery.active )
@@ -883,8 +719,10 @@ jQuery.extend({
                var data = !type && ct && ct.indexOf("xml") >= 0;
                data = type == "xml" || data ? r.responseXML : r.responseText;
 
-               // If the type is "script", eval it
-               if ( type == "script" ) eval.call( window, data );
+               // If the type is "script", eval it in global context
+               if ( type == "script" ) {
+                       jQuery.globalEval( data );
+               }
 
                // Get the JavaScript object, if JSON is used.
                if ( type == "json" ) eval( "data = " + data );
@@ -911,10 +749,10 @@ jQuery.extend({
                } else {
                        // Serialize the key/values
                        for ( var j in a ) {
-                               //if one value is array then treat each array value in part
-                               if (typeof a[j] == 'object') {
+                               // If the value is an array then the key names need to be repeated
+                               if( a[j].constructor == Array ) {
                                        for (var k = 0; k < a[j].length; k++) {
-                                               s.push( j + "[]=" + encodeURIComponent( a[j][k] ) );
+                                               s.push( j + "=" + encodeURIComponent( a[j][k] ) );
                                        }
                                } else {
                                        s.push( j + "=" + encodeURIComponent( a[j] ) );
@@ -924,6 +762,18 @@ jQuery.extend({
 
                // Return the resulting serialization
                return s.join("&");
+       },
+       
+       // evalulates a script in global context
+       // not reliable for safari
+       globalEval: function(data) {
+               if (window.execScript)
+                       window.execScript( data );
+               else if(jQuery.browser.safari)
+                       // safari doesn't provide a synchronous global eval
+                       window.setTimeout( data, 0 );
+               else
+                       eval.call( window, data );
        }
 
 });