Complete overhaul of the Ajax test suite, it's now passing in all browsers. In order...
[jquery.git] / src / ajax / ajax.js
index 346fdd7..4f0b2e8 100644 (file)
@@ -75,15 +75,14 @@ jQuery.fn.extend({
                        data: params,
                        ifModified: ifModified,
                        complete: function(res, status){
+                               // If successful, inject the HTML into all the matched elements
                                if ( status == "success" || !ifModified && status == "notmodified" )
-                                       // Inject the HTML into all the matched elements
-                                       self.attr("innerHTML", res.responseText)
-                                         // Execute all the scripts inside of the newly-injected HTML
-                                         .evalScripts()
-                                         // Execute callback
-                                         .each( callback, [res.responseText, status, res] );
-                               else
-                                       callback.apply( self, [res.responseText, status, res] );
+                                       self.html(res.responseText);
+
+                               // Add delay to account for Safari's delay in globalEval
+                               setTimeout(function(){
+                                       self.each( callback, [res.responseText, status, res] );
+                               }, 13);
                        }
                });
                return this;
@@ -94,13 +93,14 @@ jQuery.fn.extend({
         * This will serialize all given elements.
         *
         * A serialization similar to the form submit of a browser is
-        * provided by the form plugin. It also takes multiple-selects 
+        * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
+        * It also takes multiple-selects 
         * into account, while this method recognizes only a single option.
         *
         * @example $("input[@type=text]").serialize();
         * @before <input type='text' name='name' value='John'/>
         * <input type='text' name='location' value='Boston'/>
-        * @after name=John&location=Boston
+        * @after name=John&amp;location=Boston
         * @desc Serialize a selection of input elements to a string
         *
         * @name serialize
@@ -109,34 +109,10 @@ jQuery.fn.extend({
         */
        serialize: function() {
                return jQuery.param( this );
-       },
-
-       /**
-        * Evaluate all script tags inside this jQuery. If they have a src attribute,
-        * the script is loaded, otherwise it's content is evaluated.
-        *
-        * @name evalScripts
-        * @type jQuery
-        * @private
-        * @cat Ajax
-        */
-       evalScripts: function() {
-               return this.find("script").each(function(){
-                       if ( this.src )
-                               jQuery.getScript( this.src );
-                       else
-                               jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
-               }).end();
        }
 
 });
 
-// If IE is used, create a wrapper for the XMLHttpRequest object
-if ( !window.XMLHttpRequest )
-       XMLHttpRequest = function(){
-               return new ActiveXObject("Microsoft.XMLHTTP");
-       };
-
 // Attach a bunch of functions for handling common AJAX events
 
 /**
@@ -249,6 +225,13 @@ jQuery.extend({
        /**
         * Load a remote page using an HTTP GET request.
         *
+        * This is an easy way to send a simple GET request to a server
+        * without having to use the more complex $.ajax function. It
+        * allows a single callback function to be specified that will
+        * be executed when the request is complete (and only if the response
+        * has a successful response code). If you need to have both error
+        * and success callbacks, you may want to use $.ajax.
+        *
         * @example $.get("test.cgi");
         *
         * @example $.get("test.cgi", { name: "John", time: "2pm" } );
@@ -268,7 +251,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        get: function( url, data, callback, type, ifModified ) {
@@ -279,6 +262,7 @@ jQuery.extend({
                }
                
                return jQuery.ajax({
+                       type: "GET",
                        url: url,
                        data: data,
                        success: callback,
@@ -310,7 +294,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getIfModified: function( url, data, callback, type ) {
@@ -320,7 +304,7 @@ jQuery.extend({
        /**
         * Loads, and executes, a remote JavaScript file using an HTTP GET request.
         *
-        * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
+        * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
         * context synchronously. If you load functions via getScript, make sure
         * to call them after a delay.
         *
@@ -333,7 +317,7 @@ jQuery.extend({
         * @name $.getScript
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getScript: function( url, callback ) {
@@ -358,7 +342,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback A function to be executed whenever the data is loaded.
+        * @param Function callback A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        getJSON: function( url, data, callback ) {
@@ -387,7 +371,7 @@ jQuery.extend({
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
         * @param Map params (optional) Key/value pairs that will be sent to the server.
-        * @param Function callback (optional) A function to be executed whenever the data is loaded.
+        * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
         * @cat Ajax
         */
        post: function( url, data, callback, type ) {
@@ -405,11 +389,8 @@ jQuery.extend({
                });
        },
 
-       // timeout (ms)
-       //timeout: 0,
-
        /**
-        * Set the timeout of all AJAX requests to a specific amount of time.
+        * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
         * This will make all future AJAX requests timeout after a specified amount
         * of time.
         *
@@ -425,7 +406,7 @@ jQuery.extend({
         *
         * @name $.ajaxTimeout
         * @type undefined
-        * @param Number time How long before an AJAX request times out.
+        * @param Number time How long before an AJAX request times out, in milliseconds.
         * @cat Ajax
         */
        ajaxTimeout: function( timeout ) {
@@ -473,15 +454,17 @@ jQuery.extend({
         * Load a remote page using an HTTP request.
         *
         * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
-        * higher-level abstractions.
+        * higher-level abstractions that are often easier to understand and use,
+        * but don't offer as much functionality (such as error callbacks).
         *
         * $.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.
         *
-        * 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.
+        * '''Note:''' If you specify the dataType option described below, make sure
+        * the server sends the correct MIME type in the response (eg. xml as "text/xml").
+        * Sending the wrong MIME type can lead to unexpected problems in your script.
+        * See [[Specifying the Data Type for AJAX Requests]] for more information.
         *
         * Supported datatypes are (see dataType option):
         *
@@ -509,7 +492,7 @@ jQuery.extend({
         * response has changed since the last request. This is done by checking the
         * Last-Modified header. Default value is false, ignoring the header.
         *
-        * (Number) timeout - Local timeout to override global timeout, eg. to give a
+        * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
         * single request a longer timeout while all others timeout after 1 second.
         * See $.ajaxTimeout() for global timeouts.
         *
@@ -570,8 +553,8 @@ jQuery.extend({
         *  async: false
         * }).responseText;
         * @desc Loads data synchronously. Blocks the browser while the requests is active.
-        * It is better to block user interaction with others means when synchronization is
-        * necessary, instead to block the complete browser.
+        * It is better to block user interaction by other means when synchronization is
+        * necessary.
         *
         * @example var xmlDocument = [create xml document];
         * $.ajax({
@@ -590,18 +573,24 @@ jQuery.extend({
         * @see ajaxSetup(Map)
         */
        ajax: function( s ) {
-               // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
-               s = jQuery.extend({}, jQuery.ajaxSettings, s);
+               // Extend the settings, but re-extend 's' so that it can be
+               // checked again later (in the test suite, specifically)
+               s = jQuery.extend(s, jQuery.extend({}, jQuery.ajaxSettings, s));
 
                // if data available
                if ( s.data ) {
                        // convert data if not already a string
-                       if (s.processData && typeof s.data != "string")
-                       s.data = jQuery.param(s.data);
+                       if ( s.processData && typeof s.data != "string" )
+                               s.data = jQuery.param(s.data);
+
                        // append data to url for get requests
-                       if( s.type.toLowerCase() == "get" )
+                       if ( s.type.toLowerCase() == "get" ) {
                                // "?" + data or "&" + data (in case there are already params)
-                               s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
+                               s.url += (s.url.indexOf("?") > -1 ? "&" : "?") + s.data;
+
+                               // IE likes to send both get and post data, prevent this
+                               s.data = null;
+                       }
                }
 
                // Watch for a new set of requests
@@ -610,8 +599,9 @@ jQuery.extend({
 
                var requestDone = false;
 
-               // Create the request object
-               var xml = new XMLHttpRequest();
+               // Create the request object; Microsoft failed to properly
+               // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
+               var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : new XMLHttpRequest();
 
                // Open the socket
                xml.open(s.type, s.url, s.async);
@@ -628,10 +618,6 @@ jQuery.extend({
                // Set header so the called script knows that it's an XMLHttpRequest
                xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
 
-               // 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);
@@ -642,39 +628,50 @@ jQuery.extend({
                // Wait for a response to come back
                var onreadystatechange = function(isTimeout){
                        // The transfer is complete and the data is available, or the request timed out
-                       if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
+                       if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
                                requestDone = true;
-                               var status;
-                               try {
-                                       status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
-                                               s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
-                                       // Make sure that the request was successful or notmodified
-                                       if ( status != "error" ) {
-                                               // Cache Last-Modified header, if ifModified mode.
-                                               var modRes;
-                                               try {
-                                                       modRes = xml.getResponseHeader("Last-Modified");
-                                               } catch(e) {} // swallow exception thrown by FF if header is not available
-       
-                                               if ( s.ifModified && modRes )
-                                                       jQuery.lastModified[s.url] = modRes;
-       
+                               
+                               // clear poll interval
+                               if (ival) {
+                                       clearInterval(ival);
+                                       ival = null;
+                               }
+                               
+                               var status = isTimeout == "timeout" && "timeout" ||
+                                       !jQuery.httpSuccess( xml ) && "error" ||
+                                       s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
+                                       "success";
+
+                               if ( status == "success" ) {
+                                       // Watch for, and catch, XML document parse errors
+                                       try {
                                                // process the data (runs the xml through httpData regardless of callback)
                                                var data = jQuery.httpData( xml, s.dataType );
+                                       } catch(e) {
+                                               status = "parsererror";
+                                       }
+                               }
+
+                               // Make sure that the request was successful or notmodified
+                               if ( status == "success" ) {
+                                       // Cache Last-Modified header, if ifModified mode.
+                                       var modRes;
+                                       try {
+                                               modRes = xml.getResponseHeader("Last-Modified");
+                                       } catch(e) {} // swallow exception thrown by FF if header is not available
        
-                                               // If a local callback was specified, fire it and pass it the data
-                                               if ( s.success )
-                                                       s.success( data, status );
+                                       if ( s.ifModified && modRes )
+                                               jQuery.lastModified[s.url] = modRes;
        
-                                               // Fire the global callback
-                                               if( s.global )
-                                                       jQuery.event.trigger( "ajaxSuccess", [xml, s] );
-                                       } else
-                                               jQuery.handleError(s, xml, status);
-                               } catch(e) {
-                                       status = "error";
-                                       jQuery.handleError(s, xml, status, e);
-                               }
+                                       // If a local callback was specified, fire it and pass it the data
+                                       if ( s.success )
+                                               s.success( data, status );
+       
+                                       // Fire the global callback
+                                       if ( s.global )
+                                               jQuery.event.trigger( "ajaxSuccess", [xml, s] );
+                               } else
+                                       jQuery.handleError(s, xml, status);
 
                                // The request was completed
                                if( s.global )
@@ -689,31 +686,32 @@ jQuery.extend({
                                        s.complete(xml, status);
 
                                // Stop memory leaks
-                               xml.onreadystatechange = function(){};
-                               xml = null;
+                               if(s.async)
+                                       xml = null;
                        }
                };
-               xml.onreadystatechange = onreadystatechange;
-
-               // Timeout checker
-               if ( s.timeout > 0 )
-                       setTimeout(function(){
-                               // Check to see if the request is still happening
-                               if ( xml ) {
-                                       // Cancel the request
-                                       xml.abort();
-
-                                       if( !requestDone )
-                                               onreadystatechange( "timeout" );
-                               }
-                       }, s.timeout);
+               
+               if ( s.async ) {
+                       // don't attach the handler to the request, just poll it instead
+                       var ival = setInterval(onreadystatechange, 13); 
+
+                       // Timeout checker
+                       if ( s.timeout > 0 )
+                               setTimeout(function(){
+                                       // Check to see if the request is still happening
+                                       if ( xml ) {
+                                               // Cancel the request
+                                               xml.abort();
+       
+                                               if( !requestDone )
+                                                       onreadystatechange( "timeout" );
+                                       }
+                               }, s.timeout);
+               }
                        
-               // save non-leaking reference 
-               var xml2 = xml;
-
                // Send the data
                try {
-                       xml2.send(s.data);
+                       xml.send(s.data);
                } catch(e) {
                        jQuery.handleError(s, xml, null, e);
                }
@@ -723,7 +721,7 @@ jQuery.extend({
                        onreadystatechange();
                
                // return XMLHttpRequest to allow aborting the request etc.
-               return xml2;
+               return xml;
        },
 
        handleError: function( s, xml, status, e ) {
@@ -768,8 +766,11 @@ jQuery.extend({
         */
        httpData: function( r, type ) {
                var ct = r.getResponseHeader("content-type");
-               var data = !type && ct && ct.indexOf("xml") >= 0;
-               data = type == "xml" || data ? r.responseXML : r.responseText;
+               var xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0;
+               data = xml ? r.responseXML : r.responseText;
+
+               if ( xml && data.documentElement.tagName == "parsererror" )
+                       throw "parsererror";
 
                // If the type is "script", eval it in global context
                if ( type == "script" )
@@ -777,11 +778,7 @@ jQuery.extend({
 
                // Get the JavaScript object, if JSON is used.
                if ( type == "json" )
-                       eval( "data = " + data );
-
-               // evaluate scripts within html
-               if ( type == "html" )
-                       jQuery("<div>").html(data).evalScripts();
+                       data = eval("(" + data + ")");
 
                return data;
        },
@@ -813,18 +810,6 @@ 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 );
        }
 
 });