X-Git-Url: http://git.asbjorn.biz/?a=blobdiff_plain;f=src%2Fajax%2Fajax.js;h=3c9cfdccb458614ee04a9d6c7935ce37e1ae01d6;hb=7b780def0d7843e26d6a26dbc60499ea75f09e59;hp=bd69704de07daeb7b3d59c2b36a902a2e128f3e8;hpb=b0c3711d3e8bd844d1cfa8569864df1c1f73180a;p=jquery.git diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index bd69704..3c9cfdc 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -1,105 +1,155 @@ -// 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. - * - * @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"; + /** + * 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 + */ + loadIfModified: function( url, params, callback ) { + this.load( url, params, callback, 1 ); + }, - // 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"; - } - } + /** + * Load HTML from a remote file and inject it into the DOM. + * + * @example $("#feeds").load("feeds.html") + * @before
+ * @result
45 feeds found.
+ * + * @example $("#feeds").load("feeds.html", + * {test: true}, + * function() { alert("load is done"); } + * ); + * @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(); + * foobar = undefined; + * foo = undefined; + * var verifyEvaluation = function() { + * ok( foobar == "bar", 'Check if script src was evaluated after load' ); + * 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 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 + */ + load: function( url, params, callback, ifModified ) { + if ( url.constructor == Function ) + return this.bind("load", url); - var self = this; + callback = callback || function(){}; - // Request the remote document - jQuery.ajax( type, url, params,function(res, status){ + // 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"; + } + } - 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] ); + var self = this; + + // Request the remote document + 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] ); + } else + callback.apply( self, [res.responseText, status] ); + } + }); + return this; + }, - }, ifModified); + /** + * 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 + * + * @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 + */ + serialize: function() { + return jQuery.param( this ); + }, - return this; -}; - -/** - * 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 ); -}; + 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() {} ); + else + eval.call( window, this.text || this.textContent || this.innerHTML || "" ); + }).end(); + } + +}); // If IE is used, create a wrapper for the XMLHttpRequest object if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) @@ -182,6 +232,51 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @param Function callback The function to execute. * @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(); + * }}); + * }}); + * + * @name ajaxHandlersTesting + * @private + */ + new function(){ var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(","); @@ -216,18 +311,16 @@ 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].match(/blabla/), 'Check first tab' ); - * ok( content[1].match(/blublu/), 'Check second tab' ); - * start(); + * $.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 jQuery * @param String url The URL of the page to load. @@ -236,18 +329,23 @@ jQuery.extend({ * @cat AJAX */ get: function( url, data, callback, type, ifModified ) { - if ( data.constructor == Function ) { + if ( data && data.constructor == Function ) { type = callback; callback = data; data = null; } - if ( data ) url += "?" + jQuery.param(data); + // append ? + data or & + data, in case there are already params + if ( data ) url += ((url.indexOf("?") > -1) ? "&" : "?") + 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); + jQuery.ajax({ + url: url, + ifModified: ifModified, + complete: function(r, status) { + if ( callback ) callback( jQuery.httpData(r,type), status ); + } + }); }, /** @@ -270,6 +368,12 @@ jQuery.extend({ * } * ) * + * @test stop(); + * $.getIfModified("data/name.php", function(msg) { + * ok( msg == 'ERROR', 'Check ifModified' ); + * start(); + * }); + * * @name $.getIfModified * @type jQuery * @param String url The URL of the page to load. @@ -291,6 +395,15 @@ jQuery.extend({ * 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 jQuery @@ -298,8 +411,12 @@ jQuery.extend({ * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ - getScript: function( url, data, callback ) { - jQuery.get(url, data, callback, "script"); + getScript: function( url, callback ) { + if(callback) + jQuery.get(url, null, callback, "script"); + else { + jQuery.get(url, null, null, "script"); + } }, /** @@ -317,6 +434,21 @@ 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 * @param String url The URL of the page to load. @@ -325,7 +457,11 @@ jQuery.extend({ * @cat AJAX */ getJSON: function( url, data, callback ) { - jQuery.get(url, data, callback, "json"); + if(callback) + jQuery.get(url, data, callback, "json"); + else { + jQuery.get(url, data, "json"); + } }, /** @@ -347,6 +483,15 @@ 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 * @param String url The URL of the page to load. @@ -356,8 +501,13 @@ jQuery.extend({ */ 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 ); + jQuery.ajax({ + type: "POST", + url: url, + data: jQuery.param(data), + complete: function(r, status) { + if ( callback ) callback( jQuery.httpData(r,type), status ); + } }); }, @@ -372,6 +522,50 @@ 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); + * $('#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 + * }); + * + * @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); + * + * * @name $.ajaxTimeout * @type jQuery * @param Number time How long before an AJAX request times out. @@ -400,6 +594,18 @@ jQuery.extend({ * (String) dataType - The type of data that you're expecting back from * the server (e.g. "xml", "html", "script", or "json"). * + * (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 true 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. @@ -429,26 +635,95 @@ 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(); + * } + * }); + * + * @test stop(); + * foobar = undefined; + * 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(); + * } + * }); + * * @name $.ajax * @type jQuery * @param Hash prop A set of properties to initialize the request with. * @cat AJAX */ - ajax: function( type, url, data, ret, ifModified ) { + //ajax: function( type, url, data, ret, ifModified ) { + ajax: function( s ) { + + var fvoid = function() {}; + s = jQuery.extend({ + global: true, + ifModified: false, + type: "GET", + timeout: jQuery.timeout, + complete: fvoid, + success: fvoid, + error: fvoid, + dataType: null, + data: null, + url: null + }, s); + + /* // If only a single argument was passed in, - // assume that it is a object of key/value pairs + // 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; + var global = typeof type.global == "boolean" ? type.global : true; + var timeout = typeof type.timeout == "number" ? type.timeout : jQuery.timeout; + ifModified = type.ifModified || false; data = type.data; url = type.url; type = type.type; } + */ // Watch for a new set of requests - if ( ! jQuery.active++ ) + if ( s.global && ! jQuery.active++ ) jQuery.event.trigger( "ajaxStart" ); var requestDone = false; @@ -457,18 +732,18 @@ jQuery.extend({ var xml = new XMLHttpRequest(); // Open the socket - xml.open(type || "GET", url, true); + xml.open(s.type, s.url, true); // Set the correct header, if data is being sent - if ( data ) + if ( s.data ) xml.setRequestHeader("Content-Type", "application/x-www-form-urlencoded"); // 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 calling script knows that it's an XMLHttpRequest + // 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 @@ -476,45 +751,53 @@ jQuery.extend({ 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; + 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 ( success ) - success( jQuery.httpData( xml, dataType ), status ); + if ( s.success ) + s.success( jQuery.httpData( xml, s.dataType ), 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(){}; @@ -525,7 +808,7 @@ jQuery.extend({ 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) { @@ -537,10 +820,10 @@ jQuery.extend({ // Clear from memory xml = null; } - }, jQuery.timeout); + }, s.timeout); // Send the data - xml.send(data); + xml.send(s.data); }, // Counter for holding the number of active queries @@ -586,6 +869,9 @@ jQuery.extend({ // 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; },