Added support for the new .andSelf() method. This method combines the previous two...
[jquery.git] / src / ajax / ajax.js
index e9580aa..dd54d0c 100644 (file)
-// AJAX Plugin
-// Docs Here:
-// http://jquery.com/docs/ajax/
-
-/**
- * Load HTML from a remote file and inject it into the DOM
- */
-jQuery.fn.loadIfModified = function( url, params, callback ) {
-       this.load( url, params, callback, 1 );
-};
-
-jQuery.fn.load = function( url, params, callback, ifModified ) {
-       if ( url.constructor == Function )
-               return this.bind("load", url);
-
-       callback = callback || function(){};
-
-       // Default to a GET request
-       var type = "GET";
-
-       // If the second parameter was provided
-       if ( params ) {
-               // If it's a function
-               if ( params.constructor == Function ) {
-                       // We assume that it's the callback
-                       callback = params;
-                       params = null;
-                       
-               // Otherwise, build a param string
-               } else {
-                       params = jQuery.param( params );
-                       type = "POST";
+jQuery.fn.extend({
+       load: function( url, params, callback ) {
+               if ( jQuery.isFunction( url ) )
+                       return this.bind("load", url);
+
+               var off = url.indexOf(" ");
+               if ( off >= 0 ) {
+                       var selector = url.slice(off, url.length);
+                       url = url.slice(0, off);
                }
+
+               callback = callback || function(){};
+
+               // Default to a GET request
+               var type = "GET";
+
+               // If the second parameter was provided
+               if ( params )
+                       // If it's a function
+                       if ( jQuery.isFunction( params ) ) {
+                               // We assume that it's the callback
+                               callback = params;
+                               params = null;
+
+                       // Otherwise, build a param string
+                       } else {
+                               params = jQuery.param( params );
+                               type = "POST";
+                       }
+
+               var self = this;
+
+               // Request the remote document
+               jQuery.ajax({
+                       url: url,
+                       type: type,
+                       data: params,
+                       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 ?
+                                               // Create a dummy div to hold the results
+                                               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, ""))
+
+                                                       // Locate the specified elements
+                                                       .find(selector) :
+
+                                               // If not, just inject the full result
+                                               res.responseText );
+
+                               // Add delay to account for Safari's delay in globalEval
+                               setTimeout(function(){
+                                       self.each( callback, [res.responseText, status, res] );
+                               }, 13);
+                       }
+               });
+               return this;
+       },
+
+       serialize: function() {
+               return jQuery.param( this );
        }
-       
-       var self = this;
-       
-       // Request the remote document
-       jQuery.ajax( type, url, params,function(res, status){
-               
-               if ( status == "success" || !ifModified && status == "notmodified" ) {
-                       // Inject the HTML into all the matched elements
-                       self.html(res.responseText).each( callback, [res.responseText, status] );
-                       
-                       // Execute all the scripts inside of the newly-injected HTML
-                       $("script", self).each(function(){
-                               if ( this.src )
-                                       $.getScript( this.src );
-                               else
-                                       eval.call( window, this.text || this.textContent || this.innerHTML || "" );
-                       });
-               } else
-                       callback.apply( self, [res.responseText, status] );
 
-       }, ifModified);
-       
-       return this;
-};
-
-// If IE is used, create a wrapper for the XMLHttpRequest object
-if ( jQuery.browser.msie )
-       XMLHttpRequest = function(){
-               return new ActiveXObject(
-                       navigator.userAgent.indexOf("MSIE 5") >= 0 ?
-                       "Microsoft.XMLHTTP" : "Msxml2.XMLHTTP"
-               );
-       };
+});
 
 // Attach a bunch of functions for handling common AJAX events
-new function(){
-       var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(',');
-       
-       for ( var i = 0; i < e.length; i++ ) new function(){
-               var o = e[i];
-               jQuery.fn[o] = function(f){
-                       return this.bind(o, f);
-               };
+jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
+       jQuery.fn[o] = function(f){
+               return this.bind(o, f);
        };
-};
+});
 
-jQuery.extend({
+var jsc = (new Date).getTime();
 
-       /**
-        * Load a remote page using a GET request
-        */
-       get: function( url, data, callback, type, ifModified ) {
-               if ( data.constructor == Function ) {
-                       type = callback;
+jQuery.extend({
+       get: function( url, data, callback, type ) {
+               // shift arguments if data argument was ommited
+               if ( jQuery.isFunction( data ) ) {
                        callback = data;
                        data = null;
                }
                
-               if ( data ) url += "?" + jQuery.param(data);
-               
-               // Build and start the HTTP Request
-               jQuery.ajax( "GET", url, null, function(r, status) {
-                       if ( callback ) callback( jQuery.httpData(r,type), status );
-               }, ifModified);
+               return jQuery.ajax({
+                       type: "GET",
+                       url: url,
+                       data: data,
+                       success: callback,
+                       dataType: type
+               });
        },
 
-       getIfModified: function( url, data, callback, type ) {
-               jQuery.get(url, data, callback, type, 1);
+       getScript: function( url, callback ) {
+               return jQuery.get(url, null, callback, "script");
        },
 
-       getScript: function( url, data, callback ) {
-               jQuery.get(url, data, callback, "script");
+       getJSON: function( url, data, callback ) {
+               return jQuery.get(url, data, callback, "json");
        },
-       
-       /**
-        * Load a remote page using a POST request.
-        */
+
        post: function( url, data, callback, type ) {
-               // Build and start the HTTP Request
-               jQuery.ajax( "POST", url, jQuery.param(data), function(r, status) {
-                       if ( callback ) callback( jQuery.httpData(r,type), status );
+               if ( jQuery.isFunction( data ) ) {
+                       callback = data;
+                       data = {};
+               }
+
+               return jQuery.ajax({
+                       type: "POST",
+                       url: url,
+                       data: data,
+                       success: callback,
+                       dataType: type
                });
        },
-       
-       // timeout (ms)
-       timeout: 0,
 
-       ajaxTimeout: function(timeout) {
-               jQuery.timeout = timeout;
+       ajaxSetup: function( settings ) {
+               jQuery.extend( jQuery.ajaxSettings, settings );
        },
 
+       ajaxSettings: {
+               global: true,
+               type: "GET",
+               timeout: 0,
+               contentType: "application/x-www-form-urlencoded",
+               processData: true,
+               async: true,
+               data: null
+       },
+       
        // Last-Modified header cache for next request
        lastModified: {},
-       
-       /**
-        * A common wrapper for making XMLHttpRequests
-        */
-       ajax: function( type, url, data, ret, ifModified ) {
-               // If only a single argument was passed in,
-               // assume that it is a object of key/value pairs
-               if ( !url ) {
-                       ret = type.complete;
-                       var success = type.success;
-                       var error = type.error;
-                       data = type.data;
-                       url = type.url;
-                       type = type.type;
+
+       ajax: function( s ) {
+               var jsonp, jsre = /=(\?|%3F)/g, status, data;
+
+               // 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));
+
+               // convert data if not already a string
+               if ( s.data && s.processData && typeof s.data != "string" )
+                       s.data = jQuery.param(s.data);
+
+               // Break the data into one single string
+               var q = s.url.indexOf("?");
+               if ( q > -1 ) {
+                       s.data = (s.data ? s.data + "&" : "") + s.url.slice(q + 1);
+                       s.url = s.url.slice(0, q);
                }
-               
+
+               // Handle JSONP Parameter Callbacks
+               if ( s.dataType == "jsonp" ) {
+                       if ( !s.data || !s.data.match(jsre) )
+                               s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
+                       s.dataType = "json";
+               }
+
+               // Build temporary JSONP function
+               if ( s.dataType == "json" && s.data && s.data.match(jsre) ) {
+                       jsonp = "jsonp" + jsc++;
+                       s.data = s.data.replace(jsre, "=" + jsonp);
+
+                       // We need to make sure
+                       // that a JSONP style response is executed properly
+                       s.dataType = "script";
+
+                       // Handle JSONP-style loading
+                       window[ jsonp ] = function(tmp){
+                               data = tmp;
+                               success();
+                               // Garbage collect
+                               window[ jsonp ] = undefined;
+                               try{ delete window[ jsonp ]; } catch(e){}
+                       };
+               }
+
+               if ( s.dataType == "script" && s.cache == null )
+                       s.cache = false;
+
+               if ( s.cache === false && s.type.toLowerCase() == "get" )
+                       s.data = (s.data ? s.data + "&" : "") + "_=" + (new Date()).getTime();
+
+               // If data is available, append data to url for get requests
+               if ( s.data && s.type.toLowerCase() == "get" ) {
+                       s.url += "?" + s.data;
+
+                       // IE likes to send both get and post data, prevent this
+                       s.data = null;
+               }
+
                // Watch for a new set of requests
-               if ( ! jQuery.active++ )
+               if ( s.global && ! jQuery.active++ )
                        jQuery.event.trigger( "ajaxStart" );
 
+               // If we're requesting a remote document
+               // and trying to load JSON or Script
+               if ( !s.url.indexOf("http") && s.dataType == "script" ) {
+                       var script = document.createElement("script");
+                       script.src = s.url;
+
+                       // Handle Script loading
+                       if ( !jsonp && (s.success || s.complete) ) {
+                               var done = false;
+
+                               // Attach handlers for all browsers
+                               script.onload = script.onreadystatechange = function(){
+                                       if ( !done && (!this.readyState || 
+                                                       this.readyState == "loaded" || this.readyState == "complete") ) {
+                                               done = true;
+                                               success();
+                                               complete();
+                                               document.body.removeChild( script );
+                                       }
+                               };
+                       }
+
+                       document.body.appendChild(script);
+
+                       // We handle everything using the script element injection
+                       return;
+               }
+
                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(type || "GET", url, true);
-               
+               xml.open(s.type, s.url, s.async);
+
                // Set the correct header, if data is being sent
-               if ( data )
-                       xml.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
-               
+               if ( s.data )
+                       xml.setRequestHeader("Content-Type", s.contentType);
+
                // Set the If-Modified-Since header, if ifModified mode.
-               if ( ifModified )
+               if ( s.ifModified )
                        xml.setRequestHeader("If-Modified-Since",
-                               jQuery.lastModified[url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
-               
-               // Set header so calling script knows that it's an XMLHttpRequest
+                               jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
+
+               // 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);
+                       
+               if ( s.global )
+                   jQuery.event.trigger("ajaxSend", [xml, s]);
+
                // Wait for a response to come back
-               var onreadystatechange = function(istimeout){
+               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 = jQuery.httpSuccess( xml ) && istimeout != "timeout" ?
-                                       ifModified && jQuery.httpNotModified( xml, 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 = xml.getResponseHeader("Last-Modified");
-                                       if ( ifModified && modRes ) jQuery.lastModified[url] = modRes;
-                                       
-                                       // If a local callback was specified, fire it
-                                       if ( success ) success( xml, status );
-                                       
-                                       // Fire the global callback
-                                       jQuery.event.trigger( "ajaxSuccess" );
-                               
-                               // Otherwise, the request was not successful
-                               } else {
-                                       // If a local callback was specified, fire it
-                                       if ( error ) error( xml, status );
-                                       
-                                       // Fire the global callback
-                                       jQuery.event.trigger( "ajaxError" );
+                               // clear poll interval
+                               if (ival) {
+                                       clearInterval(ival);
+                                       ival = null;
                                }
                                
-                               // The request was completed
-                               jQuery.event.trigger( "ajaxComplete" );
-                               
-                               // Handle the global AJAX counter
-                               if ( ! --jQuery.active )
-                                       jQuery.event.trigger( "ajaxStop" );
+                               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)
+                                               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
        
-                               // Process result
-                               if ( ret ) ret(xml, status);
-                               
+                                       if ( s.ifModified && modRes )
+                                               jQuery.lastModified[s.url] = modRes;
+
+                                       // JSONP handles its own success callback
+                                       if ( !jsonp )
+                                               success();      
+                               } else
+                                       jQuery.handleError(s, xml, status);
+
+                               // Fire the complete handlers
+                               complete();
+
                                // Stop memory leaks
-                               xml.onreadystatechange = function(){};
-                               xml = null;
-                               
+                               if ( s.async )
+                                       xml = null;
                        }
                };
-               xml.onreadystatechange = onreadystatechange;
                
-               // Timeout checker
-               if(jQuery.timeout > 0)
-                       setTimeout(function(){
-                               // Check to see if the request is still happening
-                               if (xml) {
-                                       // Cancel the request
-                                       xml.abort();
+               if ( s.async ) {
+                       // don't attach the handler to the request, just poll it instead
+                       var ival = setInterval(onreadystatechange, 13); 
 
-                                       if ( !requestDone ) onreadystatechange( "timeout" );
-
-                                       // Clear from memory
-                                       xml = null;
-                               }
-                       }, jQuery.timeout);
-               
+                       // 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);
+               }
+                       
                // Send the data
-               xml.send(data);
+               try {
+                       xml.send(s.data);
+               } catch(e) {
+                       jQuery.handleError(s, xml, null, e);
+               }
+               
+               // firefox 1.5 doesn't fire statechange for sync requests
+               if ( !s.async )
+                       onreadystatechange();
+               
+               // return XMLHttpRequest to allow aborting the request etc.
+               return xml;
+
+               function success(){
+                       // 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] );
+               }
+
+               function complete(){
+                       // Process result
+                       if ( s.complete )
+                               s.complete(xml, status);
+
+                       // The request was completed
+                       if ( s.global )
+                               jQuery.event.trigger( "ajaxComplete", [xml, s] );
+
+                       // Handle the global AJAX counter
+                       if ( s.global && ! --jQuery.active )
+                               jQuery.event.trigger( "ajaxStop" );
+               }
        },
-       
+
+       handleError: function( s, xml, status, e ) {
+               // If a local callback was specified, fire it
+               if ( s.error ) s.error( xml, status, e );
+
+               // Fire the global callback
+               if ( s.global )
+                       jQuery.event.trigger( "ajaxError", [xml, s, e] );
+       },
+
        // Counter for holding the number of active queries
        active: 0,
-       
+
        // Determines if an XMLHttpRequest was successful or not
-       httpSuccess: function(r) {
+       httpSuccess: function( r ) {
                try {
                        return !r.status && location.protocol == "file:" ||
                                ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
                                jQuery.browser.safari && r.status == undefined;
                } catch(e){}
-
                return false;
        },
 
        // Determines if an XMLHttpRequest returns NotModified
-       httpNotModified: function(xml, url) {
+       httpNotModified: function( xml, url ) {
                try {
                        var xmlRes = xml.getResponseHeader("Last-Modified");
 
@@ -259,43 +392,53 @@ jQuery.extend({
                        return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
                                jQuery.browser.safari && xml.status == undefined;
                } catch(e){}
-
                return false;
        },
-       
-       // Get the data out of an XMLHttpRequest.
-       // Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
-       // otherwise return plain text.
-       httpData: function(r,type) {
+
+       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;
+               var data = xml ? r.responseXML : r.responseText;
+
+               if ( xml && data.documentElement.tagName == "parsererror" )
+                       throw "parsererror";
 
-               // 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" )
+                       data = eval("(" + data + ")");
 
                return data;
        },
-       
+
        // Serialize an array of form elements or a set of
        // key/values into a query string
-       param: function(a) {
+       param: function( a ) {
                var s = [];
-               
+
                // If an array was passed in, assume that it is an array
                // of form elements
-               if ( a.constructor == Array ) {
+               if ( a.constructor == Array || a.jquery )
                        // Serialize the form elements
-                       for ( var i = 0; i < a.length; i++ )
-                               s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) );
-                       
+                       jQuery.each( a, function(){
+                               s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
+                       });
+
                // Otherwise, assume that it's an object of key/value pairs
-               } else {
+               else
                        // Serialize the key/values
                        for ( var j in a )
-                               s.push( j + "=" + encodeURIComponent( a[j] ) );
-               }
-               
+                               // If the value is an array then the key names need to be repeated
+                               if ( a[j] && a[j].constructor == Array )
+                                       jQuery.each( a[j], function(){
+                                               s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
+                                       });
+                               else
+                                       s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
+
                // Return the resulting serialization
                return s.join("&");
        }