Further modified jQuery 1.4 .param() method to serialize arrays containing non-scalar...
[jquery.git] / src / ajax.js
index 4b22205..aed8dac 100644 (file)
@@ -15,6 +15,10 @@ jQuery.fn.extend({
        load: function( url, params, callback ) {
                if ( typeof url !== "string" ) {
                        return this._load( url );
+
+               // Don't do a request if no elements are being requested
+               } else if ( !this.length ) {
+                       return this;
                }
 
                var off = url.indexOf(" ");
@@ -41,21 +45,20 @@ jQuery.fn.extend({
                        }
                }
 
-               var self = this;
-
                // Request the remote document
                jQuery.ajax({
                        url: url,
                        type: type,
                        dataType: "html",
                        data: params,
+                       context:this,
                        complete: function(res, status){
                                // If successful, inject the HTML into all the matched elements
                                if ( status === "success" || status === "notmodified" ) {
                                        // See if a selector was specified
-                                       self.html( selector ?
+                                       this.html( selector ?
                                                // Create a dummy div to hold the results
-                                               jQuery("<div/>")
+                                               jQuery("<div />")
                                                        // inject the contents of the document in, removing the scripts
                                                        // to avoid any 'Permission Denied' errors in IE
                                                        .append(res.responseText.replace(rscript, ""))
@@ -68,7 +71,7 @@ jQuery.fn.extend({
                                }
 
                                if ( callback ) {
-                                       self.each( callback, [res.responseText, status, res] );
+                                       this.each( callback, [res.responseText, status, res] );
                                }
                        }
                });
@@ -103,7 +106,7 @@ jQuery.fn.extend({
 });
 
 // Attach a bunch of functions for handling common AJAX events
-jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
+jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), function(i,o){
        jQuery.fn[o] = function(f){
                return this.bind(o, f);
        };
@@ -112,8 +115,9 @@ jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".sp
 jQuery.extend({
 
        get: function( url, data, callback, type ) {
-               // shift arguments if data argument was ommited
+               // shift arguments if data argument was omited
                if ( jQuery.isFunction( data ) ) {
+                       type = type || callback;
                        callback = data;
                        data = null;
                }
@@ -136,7 +140,9 @@ jQuery.extend({
        },
 
        post: function( url, data, callback, type ) {
+               // shift arguments if data argument was omited
                if ( jQuery.isFunction( data ) ) {
+                       type = type || callback;
                        callback = data;
                        data = {};
                }
@@ -189,12 +195,11 @@ jQuery.extend({
        lastModified: {},
        etag: {},
 
-       ajax: function( s ) {
-               // Extend the settings, but re-extend 's' so that it can be
-               // checked again later (in the test suite, specifically)
-               s = jQuery.extend(true, s, jQuery.extend(true, {}, jQuery.ajaxSettings, s));
-
+       ajax: function( origSettings ) {
+               var s = jQuery.extend(true, {}, jQuery.ajaxSettings, origSettings);
+               
                var jsonp, status, data,
+                       callbackContext = s.context || window,
                        type = s.type.toUpperCase();
 
                // convert data if not already a string
@@ -216,7 +221,7 @@ jQuery.extend({
 
                // Build temporary JSONP function
                if ( s.dataType === "json" && (s.data && jsre.test(s.data) || jsre.test(s.url)) ) {
-                       jsonp = "jsonp" + jsc++;
+                       jsonp = s.jsonpCallback || ("jsonp" + jsc++);
 
                        // Replace the =? sequence both in the query string and the data
                        if ( s.data ) {
@@ -230,7 +235,7 @@ jQuery.extend({
                        s.dataType = "script";
 
                        // Handle JSONP-style loading
-                       window[ jsonp ] = function(tmp){
+                       window[ jsonp ] = window[ jsonp ] || function(tmp){
                                data = tmp;
                                success();
                                complete();
@@ -268,14 +273,13 @@ jQuery.extend({
                }
 
                // Matches an absolute URL, and saves the domain
-               var parts = rurl.exec( s.url );
+               var parts = rurl.exec( s.url ),
+                       remote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host);
 
                // If we're requesting a remote document
                // and trying to load JSON or Script with a GET
-               if ( s.dataType === "script" && type === "GET" && parts
-                       && ( parts[1] && parts[1] !== location.protocol || parts[2] !== location.host )) {
-
-                       var head = document.getElementsByTagName("head")[0];
+               if ( s.dataType === "script" && type === "GET" && remote ) {
+                       var head = document.getElementsByTagName("head")[0] || document.documentElement;
                        var script = document.createElement("script");
                        script.src = s.url;
                        if ( s.scriptCharset ) {
@@ -327,23 +331,26 @@ jQuery.extend({
                // Need an extra try/catch for cross domain requests in Firefox 3
                try {
                        // Set the correct header, if data is being sent
-                       if ( s.data ) {
+                       if ( s.data || origSettings && origSettings.contentType ) {
                                xhr.setRequestHeader("Content-Type", s.contentType);
                        }
 
-                               // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
-                               if ( s.ifModified ) {
-                                       if ( jQuery.lastModified[s.url] ) {
-                                               xhr.setRequestHeader("If-Modified-Since", jQuery.lastModified[s.url]);
-                                       }
+                       // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+                       if ( s.ifModified ) {
+                               if ( jQuery.lastModified[s.url] ) {
+                                       xhr.setRequestHeader("If-Modified-Since", jQuery.lastModified[s.url]);
+                               }
 
-                                       if ( jQuery.etag[s.url] ) {
-                                               xhr.setRequestHeader("If-None-Match", jQuery.etag[s.url]);
-                                       }
+                               if ( jQuery.etag[s.url] ) {
+                                       xhr.setRequestHeader("If-None-Match", jQuery.etag[s.url]);
                                }
+                       }
 
                        // Set header so the called script knows that it's an XMLHttpRequest
-                       xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
+                       // Only send the header if it's not a remote XHR
+                       if ( !remote ) {
+                               xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
+                       }
 
                        // Set the Accepts header for the server, depending on the dataType
                        xhr.setRequestHeader("Accept", s.dataType && s.accepts[ s.dataType ] ?
@@ -352,7 +359,7 @@ jQuery.extend({
                } catch(e){}
 
                // Allow custom headers/mimetypes and early abort
-               if ( s.beforeSend && s.beforeSend(xhr, s) === false ) {
+               if ( s.beforeSend && s.beforeSend.call(callbackContext, xhr, s) === false ) {
                        // Handle the global AJAX counter
                        if ( s.global && ! --jQuery.active ) {
                                jQuery.event.trigger( "ajaxStop" );
@@ -364,7 +371,7 @@ jQuery.extend({
                }
 
                if ( s.global ) {
-                       jQuery.event.trigger("ajaxSend", [xhr, s]);
+                       trigger("ajaxSend", [xhr, s]);
                }
 
                // Wait for a response to come back
@@ -423,7 +430,7 @@ jQuery.extend({
                                // Fire the complete handlers
                                complete();
 
-                               if ( isTimeout ) {
+                               if ( isTimeout === "timeout" ) {
                                        xhr.abort();
                                }
 
@@ -454,6 +461,8 @@ jQuery.extend({
                        xhr.send( type === "POST" || type === "PUT" ? s.data : null );
                } catch(e) {
                        jQuery.handleError(s, xhr, null, e);
+                       // Fire the complete handlers
+                       complete();
                }
 
                // firefox 1.5 doesn't fire statechange for sync requests
@@ -464,24 +473,24 @@ jQuery.extend({
                function success(){
                        // If a local callback was specified, fire it and pass it the data
                        if ( s.success ) {
-                               s.success( data, status );
+                               s.success.call( callbackContext, data, status, xhr );
                        }
 
                        // Fire the global callback
                        if ( s.global ) {
-                               jQuery.event.trigger( "ajaxSuccess", [xhr, s] );
+                               trigger( "ajaxSuccess", [xhr, s] );
                        }
                }
 
                function complete(){
                        // Process result
                        if ( s.complete ) {
-                               s.complete(xhr, status);
+                               s.complete.call( callbackContext, xhr, status);
                        }
 
                        // The request was completed
                        if ( s.global ) {
-                               jQuery.event.trigger( "ajaxComplete", [xhr, s] );
+                               trigger( "ajaxComplete", [xhr, s] );
                        }
 
                        // Handle the global AJAX counter
@@ -489,6 +498,10 @@ jQuery.extend({
                                jQuery.event.trigger( "ajaxStop" );
                        }
                }
+               
+               function trigger(type, args){
+                       (s.context ? jQuery(s.context) : jQuery.event).trigger(type, args);
+               }
 
                // return XMLHttpRequest to allow aborting the request etc.
                return xhr;
@@ -497,12 +510,12 @@ jQuery.extend({
        handleError: function( s, xhr, status, e ) {
                // If a local callback was specified, fire it
                if ( s.error ) {
-                       s.error( xhr, status, e );
+                       s.error.call( s.context || window, xhr, status, e );
                }
 
                // Fire the global callback
                if ( s.global ) {
-                       jQuery.event.trigger( "ajaxError", [xhr, s, e] );
+                       (s.context ? jQuery(s.context) : jQuery.event).trigger( "ajaxError", [xhr, s, e] );
                }
        },
 
@@ -578,40 +591,62 @@ jQuery.extend({
        // Serialize an array of form elements or a set of
        // key/values into a query string
        param: function( a ) {
-               var s = [];
-
+               
+               var s = [],
+                       
+                       // Set jQuery.param.traditional to true for jQuery <= 1.3.2 behavior.
+                       param_traditional = jQuery.param.traditional;
+               
                function add( key, value ){
+                       // If value is a function, invoke it and return its value
+                       value = jQuery.isFunction(value) ? value() : value;
                        s[ s.length ] = encodeURIComponent(key) + '=' + encodeURIComponent(value);
                }
-
-               // If an array was passed in, assume that it is an array
-               // of form elements
+               
+               // Recursively encode parameters from object.
+               function buildParams( prefix, obj ) {
+                       
+                       if ( jQuery.isArray(obj) ) {
+                               // Serialize array item.
+                               jQuery.each( obj, function(i,v){
+                                       if ( param_traditional ) {
+                                               add( prefix, v );
+                                       } else {
+                                               // If array item is non-scalar (array or object), encode its numeric
+                                               // index to resolve deserialization ambiguity issues. Note that rack
+                                               // (as of 1.0.0) can't currently deserialize nested arrays properly,
+                                               // and attempting to do so may cause a server error. Possible fixes
+                                               // are to modify rack's deserialization algorithm or to provide an
+                                               // option or flag to force array serialization to be shallow.
+                                               buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v );
+                                       }
+                               });
+                               
+                       } else if ( !param_traditional && typeof obj === "object" ) {
+                               // Serialize object item.
+                               jQuery.each( obj, function(k,v){
+                                       buildParams( prefix + "[" + k + "]", v );
+                               });
+                               
+                       } else {
+                               // Serialize scalar item.
+                               add( prefix, obj );
+                       }
+               }
+               
+               // If an array was passed in, assume that it is an array of form elements.
                if ( jQuery.isArray(a) || a.jquery ) {
                        // Serialize the form elements
                        jQuery.each( a, function() {
                                add( this.name, this.value );
                        });
+                       
                } else {
-                       // Recursively encode parameters from object, 
-                       // building a prefix path as we go down
-                       function buildParams(obj, prefix)
-                       {
-                               if ( jQuery.isArray(obj) ) {
-                                       for ( var i = 0, length = obj.length; i < length; i++ ) {
-                                               buildParams( obj[i], prefix );
-                                       };
-                               } else if( typeof(obj) == "object" ) {
-                                       for ( var j in obj ) {
-                                               var postfix = ((j.indexOf("[]") > 0) ? "[]" : ""); // move any brackets to the end
-                                               buildParams(obj[j], (prefix ? (prefix+"["+j.replace("[]", "")+"]"+postfix) : j) );
-                                       }
-                               } else {
-                                       add( prefix, jQuery.isFunction(obj) ? obj() : obj );
-                               }
-                       }
-                       buildParams(a);
+                       // If jQuery.param.traditional is set, encode the "old" way (the way
+                       // 1.3.2 or older did it), otherwise encode params recursively.
+                       jQuery.each( a, buildParams );
                }
-
+               
                // Return the resulting serialization
                return s.join("&").replace(r20, "+");
        }