X-Git-Url: http://git.asbjorn.biz/?p=jquery.git;a=blobdiff_plain;f=src%2Fajax%2Fajax.js;h=4f0b2e8fdd44e3abc38b3c07d19628cd620528f2;hp=bd69704de07daeb7b3d59c2b36a902a2e128f3e8;hb=2ef4093cf7f52383dd43bd361864edcda27e5c3c;hpb=b0c3711d3e8bd844d1cfa8569864df1c1f73180a diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index bd69704..4f0b2e8 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -1,131 +1,136 @@ -// AJAX Plugin -// Docs Here: -// http://jquery.com/docs/ajax/ +jQuery.fn.extend({ -/** - * Load HTML from a remote file and inject it into the DOM, only if it's - * been modified by the server. - * - * @example $("#feeds").loadIfModified("feeds.html") - * @before
- * @result
45 feeds found.
- * - * @name loadIfModified - * @type jQuery - * @param String url The URL of the HTML file to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX - */ -jQuery.fn.loadIfModified = function( url, params, callback ) { - this.load( url, params, callback, 1 ); -}; + /** + * Load HTML from a remote file and inject it into the DOM, only if it's + * been modified by the server. + * + * @example $("#feeds").loadIfModified("feeds.html"); + * @before
+ * @result
45 feeds found.
+ * + * @name loadIfModified + * @type jQuery + * @param String url The URL of the HTML file 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 (parameters: responseText, status and response itself). + * @cat Ajax + */ + loadIfModified: function( url, params, callback ) { + this.load( url, params, callback, 1 ); + }, -/** - * Load HTML from a remote file and inject it into the DOM. - * - * @example $("#feeds").load("feeds.html") - * @before
- * @result
45 feeds found.
- * - * @name load - * @type jQuery - * @param String url The URL of the HTML file to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX - */ -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"; - } - } - - 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] ); + /** + * Load HTML from a remote file and inject it into the DOM. + * + * Note: Avoid to use this to load scripts, instead use $.getScript. + * IE strips script tags when there aren't any other characters in front of it. + * + * @example $("#feeds").load("feeds.html"); + * @before
+ * @result
45 feeds found.
+ * + * @example $("#feeds").load("feeds.html", + * {limit: 25}, + * function() { alert("The last 25 entries in the feed have been loaded"); } + * ); + * @desc Same as above, but with an additional parameter + * and a callback that is executed when the data was loaded. + * + * @name load + * @type jQuery + * @param String url The URL of the HTML file to load. + * @param Object params (optional) A set of key/value pairs that will be sent as data to the server. + * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself). + * @cat Ajax + */ + load: function( url, params, callback, ifModified ) { + if ( jQuery.isFunction( url ) ) + return this.bind("load", url); - }, ifModified); - - return this; -}; + callback = callback || function(){}; -/** - * A function for serializing a set of input elements into - * a string of data. - * - * @example $("input[@type=text]").serialize(); - * @before - * - * @after name=John&location=Boston - * @desc Serialize a selection of input elements to a string - * - * @name serialize - * @type String - * @cat AJAX - */ -jQuery.fn.serialize = function(){ - return $.param( this ); -}; - -// 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" - ); - }; + // 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, + ifModified: ifModified, + complete: function(res, status){ + // If successful, inject the HTML into all the matched elements + if ( status == "success" || !ifModified && status == "notmodified" ) + 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; + }, + + /** + * Serializes a set of input elements into a string of data. + * This will serialize all given elements. + * + * A serialization similar to the form submit of a browser is + * 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 + * + * @after name=John&location=Boston + * @desc Serialize a selection of input elements to a string + * + * @name serialize + * @type String + * @cat Ajax + */ + serialize: function() { + return jQuery.param( this ); + } + +}); // Attach a bunch of functions for handling common AJAX events /** - * Attach a function to be executed whenever an AJAX request begins. + * Attach a function to be executed whenever an AJAX request begins + * and there is none already active. * * @example $("#loading").ajaxStart(function(){ * $(this).show(); * }); - * @desc Show a loading message whenever an AJAX request starts. + * @desc Show a loading message whenever an AJAX request starts + * (and none is already active). * * @name ajaxStart * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - + /** * Attach a function to be executed whenever all AJAX requests have ended. * @@ -137,13 +142,16 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxStop * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - + /** * 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("
  • Request Complete.
    • "); * }); * @desc Show a message when an AJAX request completes. @@ -151,14 +159,17 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxComplete * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - + /** * 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("
  • Successful Request!
    • "); * }); * @desc Show a message when an AJAX request completes successfully. @@ -166,243 +177,333 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxSuccess * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - + /** * Attach a function to be executed whenever an AJAX request fails. * - * @example $("#msg").ajaxError(function(){ - * $(this).append("
  • Error requesting page.
    • "); + * The XMLHttpRequest and settings used for that request are passed + * as arguments to the callback. A third argument, an exception object, + * is passed if an exception occured while processing the request. + * + * @example $("#msg").ajaxError(function(request, settings){ + * $(this).append("
  • Error requesting page " + settings.url + "
    • "); * }); * @desc Show a message when an AJAX request fails. * * @name ajaxError * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - -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); - }; + +/** + * Attach a function to be executed before an AJAX request is sent. + * + * The XMLHttpRequest and settings used for that request are passed + * as arguments to the callback. + * + * @example $("#msg").ajaxSend(function(request, settings){ + * $(this).append("
  • Starting request at " + settings.url + "
    • "); + * }); + * @desc Show a message before an AJAX request is sent. + * + * @name ajaxSend + * @type jQuery + * @param Function callback The function to execute. + * @cat Ajax + */ +jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){ + jQuery.fn[o] = function(f){ + return this.bind(o, f); }; -}; +}); jQuery.extend({ /** - * Load a remote page using an HTTP GET request. All of the arguments to - * the method (except URL) are optional. + * 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"); * - * @example $.get("test.cgi", { name: "John", time: "2pm" } ) + * @example $.get("test.cgi", { name: "John", time: "2pm" } ); * * @example $.get("test.cgi", function(data){ * alert("Data Loaded: " + data); - * }) + * }); * * @example $.get("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } - * ) - * - * @test stop(); - * $.get("data/dashboard.xml", function(xml) { - * var content = []; - * $('tab', xml).each(function(k) { - * // workaround for IE needed here, $(this).text() throws an error - * // content[k] = $.trim(this.firstChild.data) || $(this).text(); - * content[k] = $(this).text(); - * }); - * ok( content[0].match(/blabla/), 'Check first tab' ); - * ok( content[1].match(/blublu/), 'Check second tab' ); - * start(); - * }); + * ); * * @name $.get - * @type jQuery + * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @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 successfully. + * @cat Ajax */ get: function( url, data, callback, type, ifModified ) { - if ( data.constructor == Function ) { - type = callback; + // 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, + ifModified: ifModified + }); }, - + /** * Load a remote page using an HTTP GET request, only if it hasn't - * been modified since it was last retrieved. All of the arguments to - * the method (except URL) are optional. + * been modified since it was last retrieved. * - * @example $.getIfModified("test.html") + * @example $.getIfModified("test.html"); * - * @example $.getIfModified("test.html", { name: "John", time: "2pm" } ) + * @example $.getIfModified("test.html", { name: "John", time: "2pm" } ); * * @example $.getIfModified("test.cgi", function(data){ * alert("Data Loaded: " + data); - * }) + * }); * * @example $.getifModified("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } - * ) + * ); * * @name $.getIfModified - * @type jQuery + * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @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 successfully. + * @cat Ajax */ getIfModified: function( url, data, callback, type ) { - jQuery.get(url, data, callback, type, 1); + return jQuery.get(url, data, callback, type, 1); }, /** * Loads, and executes, a remote JavaScript file using an HTTP GET request. - * All of the arguments to the method (except URL) are optional. * - * @example $.getScript("test.js") + * 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. + * + * @example $.getScript("test.js"); * * @example $.getScript("test.js", function(){ * alert("Script loaded and executed."); - * }) - * + * }); * * @name $.getScript - * @type jQuery + * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @param Function callback (optional) A function to be executed whenever the data is loaded successfully. + * @cat Ajax */ - getScript: function( url, data, callback ) { - jQuery.get(url, data, callback, "script"); + getScript: function( url, callback ) { + return jQuery.get(url, null, callback, "script"); }, - + /** - * Load a remote JSON object using an HTTP GET request. - * All of the arguments to the method (except URL) are optional. + * Load JSON data using an HTTP GET request. * * @example $.getJSON("test.js", function(json){ * alert("JSON Data: " + json.users[3].name); - * }) + * }); * * @example $.getJSON("test.js", * { name: "John", time: "2pm" }, * function(json){ * alert("JSON Data: " + json.users[3].name); * } - * ) + * ); * * @name $.getJSON - * @type jQuery + * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @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 successfully. + * @cat Ajax */ getJSON: function( url, data, callback ) { - jQuery.get(url, data, callback, "json"); + return jQuery.get(url, data, callback, "json"); }, - + /** - * Load a remote page using an HTTP POST request. All of the arguments to - * the method (except URL) are optional. + * Load a remote page using an HTTP POST request. * - * @example $.post("test.cgi") + * @example $.post("test.cgi"); * - * @example $.post("test.cgi", { name: "John", time: "2pm" } ) + * @example $.post("test.cgi", { name: "John", time: "2pm" } ); * * @example $.post("test.cgi", function(data){ * alert("Data Loaded: " + data); - * }) + * }); * * @example $.post("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } - * ) + * ); * * @name $.post - * @type jQuery + * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params A set of key/value pairs that will be sent to the server. - * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @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 successfully. + * @cat Ajax */ 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, /** - * 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 (the default is no timeout). + * of time. + * + * Set to null or 0 to disable timeouts (default). + * + * You can manually abort requests with the XMLHttpRequest's (returned by + * all ajax functions) abort() method. + * + * Deprecated. Use $.ajaxSetup instead. * * @example $.ajaxTimeout( 5000 ); * @desc Make all AJAX requests timeout after 5 seconds. * * @name $.ajaxTimeout - * @type jQuery - * @param Number time How long before an AJAX request times out. - * @cat AJAX + * @type undefined + * @param Number time How long before an AJAX request times out, in milliseconds. + * @cat Ajax + */ + ajaxTimeout: function( timeout ) { + jQuery.ajaxSettings.timeout = timeout; + }, + + /** + * Setup global settings for AJAX requests. + * + * See $.ajax for a description of all available options. + * + * @example $.ajaxSetup( { + * url: "/xmlhttp/", + * global: false, + * type: "POST" + * } ); + * $.ajax({ data: myData }); + * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/", + * disables global handlers and uses POST instead of GET. The following + * AJAX requests then sends some data without having to set anything else. + * + * @name $.ajaxSetup + * @type undefined + * @param Map settings Key/value pairs to use for all AJAX requests + * @cat Ajax */ - 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: {}, - + /** - * 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. + * Load a remote page using an HTTP request. * - * These are all the key/values that can be passed in to 'prop': + * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for + * higher-level abstractions that are often easier to understand and use, + * but don't offer as much functionality (such as error callbacks). * - * (String) type - The type of request to make (e.g. "POST" or "GET"). + * $.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. * - * (String) url - The URL of the page to request. - * - * (String) data - A string of data to be sent to the server (POST only). + * '''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): + * + * "xml": Returns a XML document that can be processed via jQuery. + * + * "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 argument, an object of key/value pairs, that are + * used to initalize and handle the request. These are all the key/values that can + * be used: + * + * (String) url - The URL to request. + * + * (String) type - The type of request to make ("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 passed to the success callback. + * + * (Boolean) ifModified - Allow the request to be successful only if the + * 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 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. + * + * (Boolean) global - Whether to trigger global AJAX event handlers for + * 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 - * function gets passed two arguments: The XMLHttpRequest object and a - * string describing the type of error that occurred. + * function gets passed tree arguments: The XMLHttpRequest object, a + * string describing the type of error that occurred and an optional + * exception object, if one occured. * * (Function) success - A function to be called if the request succeeds. The * function gets passed one argument: The data returned from the server, @@ -410,7 +511,25 @@ jQuery.extend({ * * (Function) complete - A function to be called when the request finishes. The * function gets passed two arguments: The XMLHttpRequest object and a - * string describing the type the success of the request. + * string describing the type of success of the request. + * + * (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. + * See processData option to prevent this automatic processing. + * + * (String) contentType - When sending data to the server, use this content-type. + * Default is "application/x-www-form-urlencoded", which is fine for most cases. + * + * (Boolean) processData - By default, data passed in to the data option as an object + * other as string will be processed and transformed into a query string, fitting to + * the default content-type "application/x-www-form-urlencoded". If you want to send + * DOMDocuments, set this option to false. + * + * (Boolean) async - By default, all requests are sent 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", @@ -429,136 +548,206 @@ jQuery.extend({ * }); * @desc Save some data to the server and notify the user once its complete. * + * @example var html = $.ajax({ + * url: "some.php", + * async: false + * }).responseText; + * @desc Loads data synchronously. Blocks the browser while the requests is active. + * It is better to block user interaction by other means when synchronization is + * necessary. + * + * @example var xmlDocument = [create xml document]; + * $.ajax({ + * url: "page.php", + * processData: false, + * data: xmlDocument, + * success: handleResponse + * }); + * @desc Sends an xml document as data to the server. By setting the processData + * option to false, the automatic conversion of data to strings is prevented. + * * @name $.ajax - * @type jQuery - * @param Hash prop A set of properties to initialize the request with. - * @cat AJAX + * @type XMLHttpRequest + * @param Map properties Key/value pairs to initialize the request with. + * @cat Ajax + * @see ajaxSetup(Map) */ - 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; - var dataType = type.dataType; - data = type.data; - url = type.url; - type = type.type; + 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(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); + + // append data to url for get requests + if ( s.type.toLowerCase() == "get" ) { + // "?" + data or "&" + data (in case there are already params) + 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 - if ( ! jQuery.active++ ) + if ( s.global && ! jQuery.active++ ) jQuery.event.trigger( "ajaxStart" ); 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"; + // 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 != "error" ) { + if ( status == "success" ) { // 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( jQuery.httpData( xml, dataType ), 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 ); - + 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; + + // If a local callback was specified, fire it and pass it the data + if ( s.success ) + s.success( data, status ); + // Fire the global callback - jQuery.event.trigger( "ajaxError" ); - } - + if ( s.global ) + jQuery.event.trigger( "ajaxSuccess", [xml, s] ); + } else + jQuery.handleError(s, xml, status); + // The request was completed - jQuery.event.trigger( "ajaxComplete" ); - + if( s.global ) + jQuery.event.trigger( "ajaxComplete", [xml, s] ); + // Handle the global AJAX counter - if ( ! --jQuery.active ) + if ( s.global && ! --jQuery.active ) jQuery.event.trigger( "ajaxStop" ); - + // Process result - if ( ret ) ret(xml, status); - + if ( s.complete ) + s.complete(xml, status); + // 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 ( !requestDone ) onreadystatechange( "timeout" ); + if ( s.async ) { + // don't attach the handler to the request, just poll it instead + var ival = setInterval(onreadystatechange, 13); - // 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; }, - + + 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"); @@ -566,49 +755,59 @@ 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. * (String) data - The type of data that you're expecting back, * (e.g. "xml", "html", "script") */ - 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; + 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" ) eval( "data = " + data ); + 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 || a.jquery ) { + 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("&"); }