X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=src%2Fajax%2Fajax.js;h=9a9e0eb624423f8a2579c3f7330a3f488ec4a898;hb=d7b73ea5c7440c49c804b3cafe67e84aafbdd064;hp=2c86812b34b48076c0ba423d68c586935d95f6b0;hpb=2abdbd4e30f28347840a1861968b2f8a73d8883a;p=jquery.git diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index 2c86812..9a9e0eb 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -11,9 +11,9 @@ jQuery.fn.extend({ * @name loadIfModified * @type jQuery * @param String url The URL of the HTML file to load. - * @param Hash params (optional) 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 (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself). - * @cat AJAX + * @cat Ajax */ loadIfModified: function( url, params, callback ) { this.load( url, params, callback, 1 ); @@ -22,6 +22,9 @@ jQuery.fn.extend({ /** * 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.
@@ -38,7 +41,7 @@ jQuery.fn.extend({ * @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 + * @cat Ajax */ load: function( url, params, callback, ifModified ) { if ( url.constructor == Function ) @@ -50,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 @@ -62,7 +65,6 @@ jQuery.fn.extend({ params = jQuery.param( params ); type = "POST"; } - } var self = this; @@ -73,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] ); } }); @@ -103,7 +105,7 @@ jQuery.fn.extend({ * * @name serialize * @type String - * @cat AJAX + * @cat Ajax */ serialize: function() { return jQuery.param( this ); @@ -116,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 ) jQuery.getScript( this.src ); - else { + else jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" ); - } }).end(); } @@ -151,7 +152,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxStart * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -165,7 +166,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxStop * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -182,7 +183,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxComplete * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -200,14 +201,15 @@ 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. * * The XMLHttpRequest and settings used for that request are passed - * as arguments to the callback. + * 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 + "
  • "); @@ -217,7 +219,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxError * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -234,19 +236,13 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxSend * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ - -new function(){ - var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".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({ @@ -271,9 +267,9 @@ jQuery.extend({ * @name $.get * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params (optional) 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 (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ get: function( url, data, callback, type, ifModified ) { // shift arguments if data argument was ommited @@ -281,6 +277,7 @@ jQuery.extend({ callback = data; data = null; } + return jQuery.ajax({ url: url, data: data, @@ -312,9 +309,9 @@ jQuery.extend({ * @name $.getIfModified * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params (optional) 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 (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ getIfModified: function( url, data, callback, type ) { return jQuery.get(url, data, callback, type, 1); @@ -337,7 +334,7 @@ jQuery.extend({ * @type XMLHttpRequest * @param String url The URL of the page to load. * @param Function callback (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ getScript: function( url, callback ) { return jQuery.get(url, null, callback, "script"); @@ -360,9 +357,9 @@ jQuery.extend({ * @name $.getJSON * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params (optional) 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 ) { return jQuery.get(url, data, callback, "json"); @@ -389,9 +386,9 @@ jQuery.extend({ * @name $.post * @type XMLHttpRequest * @param String url The URL of the page to load. - * @param Hash params (optional) 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 (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ post: function( url, data, callback, type ) { return jQuery.ajax({ @@ -404,7 +401,7 @@ jQuery.extend({ }, // timeout (ms) - timeout: 0, + //timeout: 0, /** * Set the timeout of all AJAX requests to a specific amount of time. @@ -416,18 +413,53 @@ jQuery.extend({ * 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 undefined * @param Number time How long before an AJAX request times out. - * @cat AJAX + * @cat Ajax */ - ajaxTimeout: function(timeout) { - jQuery.timeout = timeout; + 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 + */ + 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: {}, @@ -472,7 +504,7 @@ jQuery.extend({ * 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. + * 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 @@ -480,8 +512,9 @@ jQuery.extend({ * 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, @@ -546,27 +579,13 @@ jQuery.extend({ * * @name $.ajax * @type XMLHttpRequest - * @param Hash prop A set of properties to initialize the request with. - * @cat AJAX + * @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, - beforeSend: null - }, s); + s = jQuery.extend({}, jQuery.ajaxSettings, s); // if data available if ( s.data ) { @@ -610,7 +629,8 @@ jQuery.extend({ // Allow custom headers/mimetypes if( s.beforeSend ) s.beforeSend(xml); - if (s.global) + + if ( s.global ) jQuery.event.trigger("ajaxSend", [xml, s]); // Wait for a response to come back @@ -618,40 +638,36 @@ jQuery.extend({ // 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; - - // 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] ); - - // 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", [xml, s] ); + 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 @@ -663,7 +679,8 @@ jQuery.extend({ 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(){}; @@ -673,17 +690,15 @@ jQuery.extend({ 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); @@ -691,17 +706,34 @@ jQuery.extend({ var xml2 = xml; // Send the data - xml2.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 || @@ -711,7 +743,7 @@ jQuery.extend({ }, // Determines if an XMLHttpRequest returns NotModified - httpNotModified: function(xml, url) { + httpNotModified: function( xml, url ) { try { var xmlRes = xml.getResponseHeader("Last-Modified"); @@ -728,51 +760,48 @@ 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 in global context - if ( type == "script" ) { + 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 ) { + 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++) { + if ( a[j].constructor == Array ) + for ( var k = 0; k < a[j].length; k++ ) s.push( j + "=" + encodeURIComponent( a[j][k] ) ); - } - } else { + else s.push( j + "=" + encodeURIComponent( a[j] ) ); - } - } - } // Return the resulting serialization return s.join("&"); @@ -780,10 +809,10 @@ jQuery.extend({ // evalulates a script in global context // not reliable for safari - globalEval: function(data) { - if (window.execScript) + globalEval: function( data ) { + if ( window.execScript ) window.execScript( data ); - else if(jQuery.browser.safari) + else if ( jQuery.browser.safari ) // safari doesn't provide a synchronous global eval window.setTimeout( data, 0 ); else