Added in support for $.ajax jsonpCallback (allowing you to specify the name of the...
[jquery.git] / src / ajax.js
index ccc5d74..7c5c838 100644 (file)
@@ -1,3 +1,13 @@
+var jsc = now(),
+       rscript = /<script(.|\s)*?\/script>/g,
+       rselectTextarea = /select|textarea/i,
+       rinput = /text|hidden|password|search/i,
+       jsre = /=\?(&|$)/,
+       rquery = /\?/,
+       rts = /(\?|&)_=.*?(&|$)/,
+       rurl = /^(\w+:)?\/\/([^\/?#]+)/,
+       r20 = /%20/g;
+
 jQuery.fn.extend({
        // Keep a copy of the old load
        _load: jQuery.fn.load,
@@ -5,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(" ");
@@ -31,24 +45,23 @@ 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(/<script(.|\s)*?\/script>/g, ""))
+                                                       .append(res.responseText.replace(rscript, ""))
 
                                                        // Locate the specified elements
                                                        .find(selector) :
@@ -58,7 +71,7 @@ jQuery.fn.extend({
                                }
 
                                if ( callback ) {
-                                       self.each( callback, [res.responseText, status, res] );
+                                       this.each( callback, [res.responseText, status, res] );
                                }
                        }
                });
@@ -75,8 +88,8 @@ jQuery.fn.extend({
                })
                .filter(function(){
                        return this.name && !this.disabled &&
-                               (this.checked || /select|textarea/i.test(this.nodeName) ||
-                                       /text|hidden|password|search/i.test(this.type));
+                               (this.checked || rselectTextarea.test(this.nodeName) ||
+                                       rinput.test(this.type));
                })
                .map(function(i, elem){
                        var val = jQuery(this).val();
@@ -93,19 +106,18 @@ 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);
        };
 });
 
-var jsc = now();
-
 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;
                }
@@ -128,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 = {};
                }
@@ -181,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));
-
-               var jsonp, jsre = /=\?(&|$)/, status, data,
+       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
@@ -198,7 +211,7 @@ jQuery.extend({
                if ( s.dataType === "jsonp" ) {
                        if ( type === "GET" ) {
                                if ( !jsre.test( s.url ) ) {
-                                       s.url += (/\?/.test( s.url ) ? "&" : "?") + (s.jsonp || "callback") + "=?";
+                                       s.url += (rquery.test( s.url ) ? "&" : "?") + (s.jsonp || "callback") + "=?";
                                }
                        } else if ( !s.data || !jsre.test(s.data) ) {
                                s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
@@ -208,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 ) {
@@ -222,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();
@@ -243,15 +256,15 @@ jQuery.extend({
                        var ts = now();
 
                        // try replacing _= if it is there
-                       var ret = s.url.replace(/(\?|&)_=.*?(&|$)/, "$1_=" + ts + "$2");
+                       var ret = s.url.replace(rts, "$1_=" + ts + "$2");
 
                        // if nothing was replaced, add timestamp to the end
-                       s.url = ret + ((ret === s.url) ? (/\?/.test(s.url) ? "&" : "?") + "_=" + ts : "");
+                       s.url = ret + ((ret === s.url) ? (rquery.test(s.url) ? "&" : "?") + "_=" + ts : "");
                }
 
                // If data is available, append data to url for get requests
                if ( s.data && type === "GET" ) {
-                       s.url += (/\?/.test(s.url) ? "&" : "?") + s.data;
+                       s.url += (rquery.test(s.url) ? "&" : "?") + s.data;
                }
 
                // Watch for a new set of requests
@@ -260,14 +273,13 @@ jQuery.extend({
                }
 
                // Matches an absolute URL, and saves the domain
-               var parts = /^(\w+:)?\/\/([^\/?#]+)/.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 ) {
@@ -288,7 +300,9 @@ jQuery.extend({
 
                                                // Handle memory leak in IE
                                                script.onload = script.onreadystatechange = null;
-                                               head.removeChild( script );
+                                               if ( head && script.parentNode ) {
+                                                       head.removeChild( script );
+                                               }
                                        }
                                };
                        }
@@ -317,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 ] ?
@@ -342,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" );
@@ -354,13 +371,13 @@ jQuery.extend({
                }
 
                if ( s.global ) {
-                       jQuery.event.trigger("ajaxSend", [xhr, s]);
+                       trigger("ajaxSend", [xhr, s]);
                }
 
                // Wait for a response to come back
                var onreadystatechange = function(isTimeout){
                        // The request was aborted, clear the interval and decrement jQuery.active
-                       if ( xhr.readyState === 0 ) {
+                       if ( !xhr || xhr.readyState === 0 ) {
                                if ( ival ) {
                                        // clear poll interval
                                        clearInterval( ival );
@@ -441,9 +458,11 @@ jQuery.extend({
 
                // Send the data
                try {
-                       xhr.send( type === "POST" ? s.data : null );
+                       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
@@ -454,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
@@ -479,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;
@@ -487,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] );
                }
        },
 
@@ -514,11 +537,11 @@ jQuery.extend({
 
        // Determines if an XMLHttpRequest returns NotModified
        httpNotModified: function( xhr, url ) {
-               var last_modified = xhr.getResponseHeader("Last-Modified"),
+               var lastModified = xhr.getResponseHeader("Last-Modified"),
                        etag = xhr.getResponseHeader("Etag");
 
-               if ( last_modified ) {
-                       jQuery.lastModified[url] = last_modified;
+               if ( lastModified ) {
+                       jQuery.lastModified[url] = lastModified;
                }
 
                if ( etag ) {
@@ -568,37 +591,55 @@ 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 = [],
+                       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
                if ( jQuery.isArray(a) || a.jquery ) {
                        // Serialize the form elements
-                       jQuery.each( a, function(){
+                       jQuery.each( a, function() {
                                add( this.name, this.value );
                        });
-
-               // Otherwise, assume that it's an object of key/value pairs
+                       
                } else {
-                       // Serialize the key/values
-                       for ( var j in a ) {
-                               // If the value is an array then the key names need to be repeated
-                               if ( jQuery.isArray(a[j]) ) {
-                                       jQuery.each( a[j], function(){
-                                               add( j, this );
+                       // Encode parameters from object, recursively. If
+                       // jQuery.param.traditional is set, encode the "old" way
+                       // (the way 1.3.2 or older did it)
+                       jQuery.each( a, function buildParams( prefix, obj ) {
+                               
+                               if ( jQuery.isArray(obj) ) {
+                                       jQuery.each( obj, function(i,v){
+                                               // Due to rails' limited request param syntax, numeric array
+                                               // indices are not supported. To avoid serialization ambiguity
+                                               // issues, serialized arrays can only contain scalar values. php
+                                               // does not have this issue, but we should go with the lowest
+                                               // common denominator
+                                               add( prefix + ( param_traditional ? "" : "[]" ), v );
                                        });
+                                       
+                               } else if ( typeof obj == "object" ) {
+                                       if ( param_traditional ) {
+                                               add( prefix, obj );
+                                               
+                                       } else {
+                                               jQuery.each( obj, function(k,v){
+                                                       buildParams( prefix ? prefix + "[" + k + "]" : k, v );
+                                               });
+                                       }
                                } else {
-                                       add( j, jQuery.isFunction(a[j]) ? a[j]() : a[j] );
+                                       add( prefix, obj );
                                }
-                       }
+                       });
                }
-
                // Return the resulting serialization
-               return s.join("&").replace(/%20/g, "+");
+               return s.join("&").replace(r20, "+");
        }
 
 });