X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=src%2Fajax%2Fajax.js;h=9a9e0eb624423f8a2579c3f7330a3f488ec4a898;hb=d7b73ea5c7440c49c804b3cafe67e84aafbdd064;hp=686aa552453c8378eef6a5a77b23281467d7854e;hpb=c119a80ea37a6940ec55dfb7b9f9b296800c7928;p=jquery.git diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index 686aa55..9a9e0eb 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -4,16 +4,16 @@ 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") + * @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 + * @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 ); @@ -22,51 +22,26 @@ jQuery.fn.extend({ /** * Load HTML from a remote file and inject it into the DOM. * - * @example $("#feeds").load("feeds.html") + * 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", - * {test: true}, - * function() { alert("load is done"); } + * {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. * - * @test stop(); - * $('#first').load("data/name.php", function() { - * ok( $('#first').text() == 'ERROR', 'Check if content was injected into the DOM' ); - * start(); - * }); - * - * @test stop(); // check if load can be called with only url - * $('#first').load("data/name.php"); - * $.get("data/name.php", function() { - * ok( $('#first').text() == 'ERROR', 'Check if load works without callback'); - * start(); - * }); - * - * @test stop(); - * window.foobar = undefined; - * window.foo = undefined; - * var verifyEvaluation = function() { - * ok( foobar == "bar", 'Check if script src was evaluated after load' ); - * ok( $('#foo').html() == 'foo', 'Check if script evaluation has modified DOM'); - * ok( $('#ap').html() == 'bar', 'Check if script evaluation has modified DOM'); - * start(); - * }; - * $('#first').load('data/test.html', function() { - * ok( $('#first').html().match(/^html text/), 'Check content after loading html' ); - * ok( foo == "foo", 'Check if script was evaluated after load' ); - * setTimeout(verifyEvaluation, 600); - * }); - * * @name load * @type jQuery * @param String url The URL of the HTML file to load. - * @param Object params A set of key/value pairs that will be sent as data to the server. - * @param Function callback A function to be executed whenever the data is loaded (parameters: responseText, status and reponse itself). - * @cat AJAX + * @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 ( url.constructor == Function ) @@ -78,7 +53,7 @@ jQuery.fn.extend({ var type = "GET"; // If the second parameter was provided - if ( params ) { + if ( params ) // If it's a function if ( params.constructor == Function ) { // We assume that it's the callback @@ -90,7 +65,6 @@ jQuery.fn.extend({ params = jQuery.param( params ); type = "POST"; } - } var self = this; @@ -101,14 +75,14 @@ jQuery.fn.extend({ data: params, ifModified: ifModified, complete: function(res, status){ - if ( status == "success" || !ifModified && status == "notmodified" ) { + if ( status == "success" || !ifModified && status == "notmodified" ) // Inject the HTML into all the matched elements self.html(res.responseText) // Execute all the scripts inside of the newly-injected HTML .evalScripts() // Execute callback .each( callback, [res.responseText, status, res] ); - } else + else callback.apply( self, [res.responseText, status, res] ); } }); @@ -117,11 +91,11 @@ jQuery.fn.extend({ /** * Serializes a set of input elements into a string of data. - * This will serialize all given elements. If you need - * serialization similar to the form submit of a browser, - * you should use the form plugin. This is also true for - * selects with multiple attribute set, only a single option - * is serialized. + * This will serialize all given elements. + * + * A serialization similar to the form submit of a browser is + * provided by the form plugin. It also takes multiple-selects + * into account, while this method recognizes only a single option. * * @example $("input[@type=text]").serialize(); * @before @@ -129,13 +103,9 @@ jQuery.fn.extend({ * @after name=John&location=Boston * @desc Serialize a selection of input elements to a string * - * @test var data = $(':input').not('button').serialize(); - * // ignore button, IE takes text content as value, not relevant for this test - * ok( data == 'action=Test&text2=Test&radio1=on&radio2=on&check=on&=on&hidden=&foo[bar]=&name=name&=foobar&select1=&select2=3&select3=1', 'Check form serialization as query string' ); - * * @name serialize * @type String - * @cat AJAX + * @cat Ajax */ serialize: function() { return jQuery.param( this ); @@ -148,15 +118,14 @@ jQuery.fn.extend({ * @name evalScripts * @type jQuery * @private - * @cat AJAX + * @cat Ajax */ evalScripts: function() { return this.find('script').each(function(){ if ( this.src ) - // for some weird reason, it doesn't work if the callback is ommited - jQuery.getScript( this.src, function() {} ); + jQuery.getScript( this.src ); else - eval.call( window, this.text || this.textContent || this.innerHTML || "" ); + jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" ); }).end(); } @@ -165,26 +134,25 @@ jQuery.fn.extend({ // 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" - ); + return new ActiveXObject("Microsoft.XMLHTTP"); }; // 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 */ /** @@ -198,13 +166,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. @@ -212,14 +183,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. @@ -227,117 +201,75 @@ 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 */ - + /** - * @test stop(); var counter = { complete: 0, success: 0, error: 0 }; - * var success = function() { counter.success++ }; - * var error = function() { counter.error++ }; - * var complete = function() { counter.complete++ }; - * $('#foo').ajaxStart(complete).ajaxStop(complete).ajaxComplete(complete).ajaxError(error).ajaxSuccess(success); - * // start with successful test - * $.ajax({url: "data/name.php", success: success, error: error, complete: function() { - * ok( counter.error == 0, 'Check succesful request' ); - * ok( counter.success == 2, 'Check succesful request' ); - * ok( counter.complete == 3, 'Check succesful request' ); - * counter.error = 0; counter.success = 0; counter.complete = 0; - * $.ajaxTimeout(500); - * $.ajax({url: "data/name.php?wait=5", success: success, error: error, complete: function() { - * ok( counter.error == 2, 'Check failed request' ); - * ok( counter.success == 0, 'Check failed request' ); - * ok( counter.complete == 3, 'Check failed request' ); - * start(); - * }}); - * }}); - - * @test stop(); var counter = { complete: 0, success: 0, error: 0 }; - * counter.error = 0; counter.success = 0; counter.complete = 0; - * var success = function() { counter.success++ }; - * var error = function() { counter.error++ }; - * $.ajaxTimeout(0); - * $.ajax({url: "data/name.php", global: false, success: success, error: error, complete: function() { - * ok( counter.error == 0, 'Check sucesful request without globals' ); - * ok( counter.success == 1, 'Check sucesful request without globals' ); - * ok( counter.complete == 0, 'Check sucesful request without globals' ); - * counter.error = 0; counter.success = 0; counter.complete = 0; - * $.ajaxTimeout(500); - * $.ajax({url: "data/name.php?wait=5", global: false, success: success, error: error, complete: function() { - * ok( counter.error == 1, 'Check failed request without globals' ); - * ok( counter.success == 0, 'Check failed request without globals' ); - * ok( counter.complete == 0, 'Check failed request without globals' ); - * start(); - * }}); - * }}); + * Attach a function to be executed before an AJAX request is send. + * + * The XMLHttpRequest and settings used for that request are passed + * as arguments to the callback. * - * @name ajaxHandlersTesting - * @private + * @example $("#msg").ajaxSend(function(request, settings){ + * $(this).append("
  • Starting request at " + settings.url + "
    • "); + * }); + * @desc Show a message before an AJAX request is send. + * + * @name ajaxSend + * @type jQuery + * @param Function callback The function to execute. + * @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); - }; +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. * - * @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() { - * content.push($(this).text()); - * }); - * ok( content[0] == 'blabla', 'Check first tab'); - * ok( content[1] == 'blublu', 'Check second tab'); - * start(); - * }); + * ); * * @name $.get - * @type undefined + * @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. + * @cat Ajax */ get: function( url, data, callback, type, ifModified ) { // shift arguments if data argument was ommited @@ -345,9 +277,8 @@ jQuery.extend({ callback = data; data = null; } - - // Delegate - jQuery.ajax({ + + return jQuery.ajax({ url: url, data: data, success: callback, @@ -358,154 +289,109 @@ jQuery.extend({ /** * 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); * } - * ) - * - * @test stop(); - * $.getIfModified("data/name.php", function(msg) { - * ok( msg == 'ERROR', 'Check ifModified' ); - * start(); - * }); + * ); * * @name $.getIfModified - * @type undefined + * @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. + * @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 evalulate 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."); - * }) - * - * @test stop(); - * $.getScript("data/test.js", function() { - * ok( foobar == "bar", 'Check if script was evaluated' ); - * start(); * }); * - * @test - * $.getScript("data/test.js"); - * ok( true, "Check with single argument, can't verify" ); - * * @name $.getScript - * @type undefined + * @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. + * @cat Ajax */ getScript: function( url, callback ) { - if(callback) - jQuery.get(url, null, callback, "script"); - else { - jQuery.get(url, null, null, "script"); - } + 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); * } - * ) - * - * @test stop(); - * $.getJSON("data/json.php", {json: "array"}, function(json) { - * ok( json[0].name == 'John', 'Check JSON: first, name' ); - * ok( json[0].age == 21, 'Check JSON: first, age' ); - * ok( json[1].name == 'Peter', 'Check JSON: second, name' ); - * ok( json[1].age == 25, 'Check JSON: second, age' ); - * start(); - * }); - * @test stop(); - * $.getJSON("data/json.php", function(json) { - * ok( json.data.lang == 'en', 'Check JSON: lang' ); - * ok( json.data.length == 25, 'Check JSON: length' ); - * start(); - * }); + * ); * * @name $.getJSON - * @type undefined + * @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 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. - * @cat AJAX + * @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); * } - * ) - * - * @test stop(); - * $.post("data/name.php", {xml: "5-2"}, function(xml){ - * $('math', xml).each(function() { - * ok( $('calculation', this).text() == '5-2', 'Check for XML' ); - * ok( $('result', this).text() == '3', 'Check for XML' ); - * }); - * start(); - * }); + * ); * * @name $.post - * @type undefined + * @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. + * @cat Ajax */ post: function( url, data, callback, type ) { - // Delegate - jQuery.ajax({ + return jQuery.ajax({ type: "POST", url: url, data: data, @@ -515,102 +401,120 @@ jQuery.extend({ }, // timeout (ms) - timeout: 0, + //timeout: 0, /** * Set the timeout 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. * - * @example $.ajaxTimeout( 5000 ); - * @desc Make all AJAX requests timeout after 5 seconds. + * Set to null or 0 to disable timeouts (default). * - * @test stop(); - * var passed = 0; - * var timeout; - * $.ajaxTimeout(1000); - * var pass = function() { - * passed++; - * if(passed == 2) { - * ok( true, 'Check local and global callbacks after timeout' ); - * clearTimeout(timeout); - * $('#main').unbind("ajaxError"); - * start(); - * } - * }; - * var fail = function() { - * ok( false, 'Check for timeout failed' ); - * start(); - * }; - * timeout = setTimeout(fail, 1500); - * $('#main').ajaxError(pass); - * $.ajax({ - * type: "GET", - * url: "data/name.php?wait=5", - * error: pass, - * success: fail - * }); + * You can manually abort requests with the XMLHttpRequest's (returned by + * all ajax functions) abort() method. * - * @test stop(); $.ajaxTimeout(50); - * $.ajax({ - * type: "GET", - * timeout: 5000, - * url: "data/name.php?wait=1", - * error: function() { - * ok( false, 'Check for local timeout failed' ); - * start(); - * }, - * success: function() { - * ok( true, 'Check for local timeout' ); - * start(); - * } - * }); - * // reset timeout - * $.ajaxTimeout(0); + * Deprecated. Use $.ajaxSetup instead. * + * @example $.ajaxTimeout( 5000 ); + * @desc Make all AJAX requests timeout after 5 seconds. * * @name $.ajaxTimeout * @type undefined * @param Number time How long before an AJAX request times out. - * @cat AJAX + * @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 + }, + // 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. + * + * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for + * higher-level abstractions. + * + * $.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. * - * These are all the key/values that can be passed in to 'prop': + * Note: Make sure the server sends the right mimetype (eg. xml as + * "text/xml"). Sending the wrong mimetype will get you into serious + * trouble that jQuery can't solve. * - * (String) type - The type of request to make (e.g. "POST" or "GET"). + * Supported datatypes are (see dataType option): * - * (String) url - The URL of the page to request. + * "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, default is false, ignoring - * the Last-Modified header + * response has changed since the last request. This is done by checking the + * Last-Modified header. Default value is false, ignoring the header. * * (Number) timeout - Local timeout to override global timeout, eg. to give a - * single request a longer timeout while all others timeout after 1 seconds, - * see $.ajaxTimeout + * single request a longer timeout while all others timeout after 1 second. + * See $.ajaxTimeout() for global timeouts. * - * (Boolean) global - Wheather to trigger global AJAX event handlers for - * this request, default is true. Set to true to prevent that global handlers + * (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, @@ -618,23 +522,26 @@ 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. * - * (String) data - Data to be sent to the server. Converted to a query + * (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. - * Override processData option to prevent processing. + * 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. + * (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 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) 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 send 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", * url: "test.js", @@ -652,76 +559,33 @@ jQuery.extend({ * }); * @desc Save some data to the server and notify the user once its complete. * - * @test stop(); - * $.ajax({ - * type: "GET", - * url: "data/name.php?name=foo", - * success: function(msg){ - * ok( msg == 'bar', 'Check for GET' ); - * start(); - * } - * }); + * @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 with others means when synchronization is + * necessary, instead to block the complete browser. * - * @test stop(); + * @example var xmlDocument = [create xml document]; * $.ajax({ - * type: "POST", - * url: "data/name.php", - * data: "name=peter", - * success: function(msg){ - * ok( msg == 'pan', 'Check for POST' ); - * start(); - * } + * url: "page.php", + * processData: false, + * data: xmlDocument, + * success: handleResponse * }); - * - * @test stop(); - * window.foobar = undefined; - * window.foo = undefined; - * var verifyEvaluation = function() { - * ok( foobar == "bar", 'Check if script src was evaluated for datatype html' ); - * start(); - * }; - * $.ajax({ - * dataType: "html", - * url: "data/test.html", - * success: function(data) { - * ok( data.match(/^html text/), 'Check content for datatype html' ); - * ok( foo == "foo", 'Check if script was evaluated for datatype html' ); - * setTimeout(verifyEvaluation, 600); - * } - * }); - * - * @test stop(); - * $.ajax({ - * url: "data/with_fries.xml", dataType: "xml", type: "GET", data: "", success: function(resp) { - * ok( $("properties", resp).length == 1, 'properties in responseXML' ); - * ok( $("jsconf", resp).length == 1, 'jsconf in responseXML' ); - * ok( $("thing", resp).length == 2, 'things in responseXML' ); - * start(); - * } - * }); - * + * @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 undefined - * @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( s ) { // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout - s = jQuery.extend({ - global: true, - ifModified: false, - type: "GET", - timeout: jQuery.timeout, - complete: null, - success: null, - error: null, - dataType: null, - url: null, - data: null, - contentType: "application/x-www-form-urlencoded", - processData: true, - async: true - }, s); + s = jQuery.extend({}, jQuery.ajaxSettings, s); // if data available if ( s.data ) { @@ -761,99 +625,125 @@ jQuery.extend({ // 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){ // The transfer is complete and the data is available, or the request timed out if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) { requestDone = true; - - var status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ? - s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error"; - - // Make sure that the request was successful or notmodified - if ( status != "error" ) { - // Cache Last-Modified header, if ifModified mode. - var modRes; - try { - modRes = xml.getResponseHeader("Last-Modified"); - } catch(e) {} // swallow exception thrown by FF if header is not available - - if ( s.ifModified && modRes ) - jQuery.lastModified[s.url] = modRes; - - // If a local callback was specified, fire it - if ( s.success ) - s.success( jQuery.httpData( xml, s.dataType ), status ); - - // Fire the global callback - if( s.global ) - jQuery.event.trigger( "ajaxSuccess" ); - - // Otherwise, the request was not successful - } else { - // If a local callback was specified, fire it - if ( s.error ) s.error( xml, status ); - - // Fire the global callback - if( s.global ) - jQuery.event.trigger( "ajaxError" ); + var status; + try { + status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ? + s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error"; + // Make sure that the request was successful or notmodified + if ( status != "error" ) { + // Cache Last-Modified header, if ifModified mode. + var modRes; + try { + modRes = xml.getResponseHeader("Last-Modified"); + } catch(e) {} // swallow exception thrown by FF if header is not available + + if ( s.ifModified && modRes ) + jQuery.lastModified[s.url] = modRes; + + // process the data (runs the xml through httpData regardless of callback) + var data = jQuery.httpData( xml, s.dataType ); + + // If a local callback was specified, fire it and pass it the data + if ( s.success ) + s.success( data, status ); + + // Fire the global callback + if( s.global ) + jQuery.event.trigger( "ajaxSuccess", [xml, s] ); + } else + jQuery.handleError(s, xml, status); + } catch(e) { + status = "error"; + jQuery.handleError(s, xml, status, e); } // The request was completed if( s.global ) - jQuery.event.trigger( "ajaxComplete" ); + jQuery.event.trigger( "ajaxComplete", [xml, s] ); // Handle the global AJAX counter if ( s.global && ! --jQuery.active ) jQuery.event.trigger( "ajaxStop" ); // Process result - if ( s.complete ) s.complete(xml, status); + if ( s.complete ) + s.complete(xml, status); // Stop memory leaks xml.onreadystatechange = function(){}; xml = null; - } }; xml.onreadystatechange = onreadystatechange; // Timeout checker - if(s.timeout > 0) + if ( s.timeout > 0 ) setTimeout(function(){ // Check to see if the request is still happening - if (xml) { + if ( xml ) { // Cancel the request xml.abort(); - if ( !requestDone ) onreadystatechange( "timeout" ); - - // Clear from memory - xml = null; + if( !requestDone ) + onreadystatechange( "timeout" ); } }, s.timeout); + + // save non-leaking reference + var xml2 = xml; // Send the data - xml.send(s.data); + try { + xml2.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 xml2; + }, + + 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"); @@ -861,7 +751,6 @@ jQuery.extend({ return xml.status == 304 || xmlRes == jQuery.lastModified[url] || jQuery.browser.safari && xml.status == undefined; } catch(e){} - return false; }, @@ -871,52 +760,63 @@ jQuery.extend({ * (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; - // 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" ) + eval( "data = " + data ); // evaluate scripts within html - if ( type == "html" ) jQuery("
    ").html(data).evalScripts(); + if ( type == "html" ) + jQuery("
    ").html(data).evalScripts(); 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 ) ); // Otherwise, assume that it's an object of key/value pairs - } else { + else // Serialize the key/values - for ( var j in a ) { - //if one value is array then treat each array value in part - if (typeof a[j] == 'object') { - for (var k = 0; k < a[j].length; k++) { - s.push( j + "[]=" + encodeURIComponent( a[j][k] ) ); - } - } else { + for ( var j in a ) + // If the value is an array then the key names need to be repeated + if ( a[j].constructor == Array ) + for ( var k = 0; k < a[j].length; k++ ) + s.push( j + "=" + encodeURIComponent( a[j][k] ) ); + else s.push( j + "=" + encodeURIComponent( a[j] ) ); - } - } - } // Return the resulting serialization return s.join("&"); + }, + + // evalulates a script in global context + // not reliable for safari + globalEval: function( data ) { + if ( window.execScript ) + window.execScript( data ); + else if ( jQuery.browser.safari ) + // safari doesn't provide a synchronous global eval + window.setTimeout( data, 0 ); + else + eval.call( window, data ); } });