X-Git-Url: http://git.asbjorn.it/?a=blobdiff_plain;f=src%2Fajax%2Fajax.js;h=b8ccdd65220e210a0cfb3d5fa9d30156c15f1a11;hb=46faa03820f82e5b03e6b3d73bd9d5b194b2b310;hp=72f87f2e9b4ac23eb1b8a86739f1c26009043763;hpb=10532fb3ae4f18c77263a7cbc0840e9eb3805de4;p=jquery.git diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index 72f87f2..b8ccdd6 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -33,28 +33,22 @@ jQuery.fn.extend({ * @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(); - * }); - * * @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. + * @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 */ 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 @@ -62,41 +56,44 @@ jQuery.fn.extend({ // 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] ); - - }, ifModified); - + jQuery.ajax({ + url: url, + type: type, + data: params, + ifModified: ifModified, + complete: function(res, status){ + 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 + callback.apply( self, [res.responseText, status, res] ); + } + }); return this; }, /** - * A function for serializing a set of input elements into - * a string of data. + * 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. * * @example $("input[@type=text]").serialize(); * @before @@ -104,17 +101,33 @@ jQuery.fn.extend({ * @after name=John&location=Boston * @desc Serialize a selection of input elements to a string * - * @test var data = $(':input').serialize(); - * ok( data == 'action=Test&text2=Test&radio1=on&radio2=on&check=on&=on&hidden=&foo[bar]=&name=name&button=&=foobar&select1=&select2=3&select3=1', 'Check form serialization as query string' ); - * * @name serialize * @type String * @cat AJAX */ serialize: function() { - return $.param( this ); + return jQuery.param( this ); + }, + + /** + * Evaluate all script tags inside this jQuery. If they have a src attribute, + * the script is loaded, otherwise it's content is evaluated. + * + * @name evalScripts + * @type jQuery + * @private + * @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 ); + else + eval.call( window, this.text || this.textContent || this.innerHTML || "" ); + }).end(); } - + }); // If IE is used, create a wrapper for the XMLHttpRequest object @@ -141,7 +154,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @param Function callback The function to execute. * @cat AJAX */ - + /** * Attach a function to be executed whenever all AJAX requests have ended. * @@ -155,7 +168,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @param Function callback The function to execute. * @cat AJAX */ - + /** * Attach a function to be executed whenever an AJAX request completes. * @@ -169,7 +182,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @param Function callback The function to execute. * @cat AJAX */ - + /** * Attach a function to be executed whenever an AJAX request completes * successfully. @@ -184,7 +197,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @param Function callback The function to execute. * @cat AJAX */ - + /** * Attach a function to be executed whenever an AJAX request fails. * @@ -201,7 +214,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) 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){ @@ -231,41 +244,30 @@ jQuery.extend({ * } * ) * - * @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] && content[0].match(/blabla/), 'Check first tab' ); - * ok( content[1] && content[1].match(/blublu/), 'Check second tab' ); - * start(); - * }); - * * @name $.get - * @type jQuery + * @type undefined * @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 */ get: function( url, data, callback, type, ifModified ) { - if ( data.constructor == Function ) { - type = callback; + // shift arguments if data argument was ommited + if ( data && data.constructor == Function ) { 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); + + // Delegate + jQuery.ajax({ + 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 @@ -287,7 +289,7 @@ jQuery.extend({ * ) * * @name $.getIfModified - * @type jQuery + * @type undefined * @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. @@ -307,22 +309,20 @@ jQuery.extend({ * alert("Script loaded and executed."); * }) * - * @test stop(); - * $.getScript("data/test.js", function() { - * ok( foobar == "bar", 'Check if script was evaluated' ); - * start(); - * }); - * * @name $.getScript - * @type jQuery + * @type undefined * @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 */ getScript: function( url, callback ) { - jQuery.get(url, callback, "script"); + if(callback) + jQuery.get(url, null, callback, "script"); + else { + jQuery.get(url, null, null, "script"); + } }, - + /** * Load a remote JSON object using an HTTP GET request. * All of the arguments to the method (except URL) are optional. @@ -338,36 +338,17 @@ jQuery.extend({ * } * ) * - * @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 jQuery + * @type undefined * @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 */ getJSON: function( url, data, callback ) { - if(callback) - jQuery.get(url, data, callback, "json"); - else { - jQuery.get(url, data, "json"); - } + 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. @@ -387,29 +368,24 @@ jQuery.extend({ * } * ) * - * @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 jQuery + * @type undefined * @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 */ 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 ); + // Delegate + jQuery.ajax({ + type: "POST", + url: url, + data: data, + success: callback, + dataType: type }); }, - + // timeout (ms) timeout: 0, @@ -421,34 +397,8 @@ jQuery.extend({ * @example $.ajaxTimeout( 5000 ); * @desc Make all AJAX requests timeout after 5 seconds. * - * @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); - * start(); - * } - * }; - * var fail = function(ba) { - * console.debug(ba); - * 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 - * }); - * * @name $.ajaxTimeout - * @type jQuery + * @type undefined * @param Number time How long before an AJAX request times out. * @cat AJAX */ @@ -458,22 +408,52 @@ jQuery.extend({ // 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. + * means of making AJAX requests using jQuery. + * + * $.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. + * + * Please 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. + * + * Supported datatypes (see dataType option) are: + * + * "xml": Returns a XML document that can be processed via jQuery. + * + * "html": Returns HTML as plain text, included script tags are evaluated. * - * These are all the key/values that can be passed in to 'prop': + * "script": Evaluates the response as Javascript and returns it as plain text. * - * (String) type - The type of request to make (e.g. "POST" or "GET"). + * "json": Evaluates the response as JSON and returns a Javascript Object + * + * $.ajax() takes one property, an object of key/value pairs, that are + * used to initalize the request. These are all the key/values that can + * be passed in to 'prop': * * (String) url - The URL of the page to request. - * - * (String) data - A string of data to be sent to the server (POST only). + * + * (String) type - The type of request to make (e.g. "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 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 + * + * (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() + * + * (Boolean) global - Wheather 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 @@ -487,6 +467,21 @@ jQuery.extend({ * function gets passed two arguments: The XMLHttpRequest object and a * string describing the type the success of the request. * + * (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. + * + * (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) async - By default, all requests are send asynchronous (set to true). + * If you need synchronous requests, set this option to false. + * * @example $.ajax({ * type: "GET", * url: "test.js", @@ -504,124 +499,130 @@ 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(); - * } - * }); - * - * @test stop(); - * $.ajax({ - * type: "POST", - * url: "data/name.php", - * data: "name=peter", - * success: function(msg){ - * ok( msg == 'pan', 'Check for POST' ); - * start(); - * } - * }); - * * @name $.ajax - * @type jQuery + * @type XMLHttpRequest * @param Hash prop A set of properties to initialize the request with. * @cat AJAX */ - 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 ) { + // 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); + + // 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; } - + // 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(); - + // 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" ); - + 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"); - + // 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 ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) { requestDone = true; - var status = jQuery.httpSuccess( xml ) && istimeout != "timeout" ? - ifModified && jQuery.httpNotModified( xml, url ) ? "notmodified" : "success" : "error"; - + 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 = 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 ); - + 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 - jQuery.event.trigger( "ajaxSuccess" ); - + if( s.global ) + jQuery.event.trigger( "ajaxSuccess" ); + // Otherwise, the request was not successful } else { // If a local callback was specified, fire it - if ( error ) error( xml, status ); - + if ( s.error ) s.error( xml, status ); + // Fire the global callback - jQuery.event.trigger( "ajaxError" ); + if( s.global ) + jQuery.event.trigger( "ajaxError" ); } - + // The request was completed - jQuery.event.trigger( "ajaxComplete" ); - + if( s.global ) + jQuery.event.trigger( "ajaxComplete" ); + // 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; - + } }; xml.onreadystatechange = onreadystatechange; - + // Timeout checker - if(jQuery.timeout > 0) + if(s.timeout > 0) setTimeout(function(){ // Check to see if the request is still happening if (xml) { @@ -633,15 +634,18 @@ jQuery.extend({ // Clear from memory xml = null; } - }, jQuery.timeout); - + }, s.timeout); + // Send the data - xml.send(data); + xml.send(s.data); + + // return XMLHttpRequest to allow aborting the request etc. + return xml; }, - + // Counter for holding the number of active queries active: 0, - + // Determines if an XMLHttpRequest was successful or not httpSuccess: function(r) { try { @@ -665,7 +669,7 @@ jQuery.extend({ 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. @@ -677,34 +681,50 @@ jQuery.extend({ 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" ) { + if (window.execScript) + window.execScript( data ); + else + window.setTimeout( data, 0 ); + } // Get the JavaScript object, if JSON is used. if ( type == "json" ) eval( "data = " + data ); + // evaluate scripts within html + 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) { var s = []; - + // If an array was passed in, assume that it is an array // of form elements 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 { // Serialize the key/values - for ( var j in a ) - s.push( j + "=" + encodeURIComponent( a[j] ) ); + 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 { + s.push( j + "=" + encodeURIComponent( a[j] ) ); + } + } } - + // Return the resulting serialization return s.join("&"); }