4 * Load HTML from a remote file and inject it into the DOM, only if it's
5 * been modified by the server.
7 * @example $("#feeds").loadIfModified("feeds.html");
8 * @before <div id="feeds"></div>
9 * @result <div id="feeds"><b>45</b> feeds found.</div>
11 * @name loadIfModified
13 * @param String url The URL of the HTML file to load.
14 * @param Map params (optional) Key/value pairs that will be sent to the server.
15 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
18 loadIfModified: function( url, params, callback ) {
19 this.load( url, params, callback, 1 );
23 * Load HTML from a remote file and inject it into the DOM.
25 * Note: Avoid to use this to load scripts, instead use $.getScript.
26 * IE strips script tags when there aren't any other characters in front of it.
28 * @example $("#feeds").load("feeds.html");
29 * @before <div id="feeds"></div>
30 * @result <div id="feeds"><b>45</b> feeds found.</div>
32 * @example $("#feeds").load("feeds.html",
34 * function() { alert("The last 25 entries in the feed have been loaded"); }
36 * @desc Same as above, but with an additional parameter
37 * and a callback that is executed when the data was loaded.
41 * @param String url The URL of the HTML file to load.
42 * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
43 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
46 load: function( url, params, callback, ifModified ) {
47 if ( jQuery.isFunction( url ) )
48 return this.bind("load", url);
50 callback = callback || function(){};
52 // Default to a GET request
55 // If the second parameter was provided
58 if ( jQuery.isFunction( params ) ) {
59 // We assume that it's the callback
63 // Otherwise, build a param string
65 params = jQuery.param( params );
71 // Request the remote document
76 ifModified: ifModified,
77 complete: function(res, status){
78 if ( status == "success" || !ifModified && status == "notmodified" )
79 // Inject the HTML into all the matched elements
80 self.attr("innerHTML", res.responseText)
81 // Execute all the scripts inside of the newly-injected HTML
84 .each( callback, [res.responseText, status, res] );
86 callback.apply( self, [res.responseText, status, res] );
93 * Serializes a set of input elements into a string of data.
94 * This will serialize all given elements.
96 * A serialization similar to the form submit of a browser is
97 * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
98 * It also takes multiple-selects
99 * into account, while this method recognizes only a single option.
101 * @example $("input[@type=text]").serialize();
102 * @before <input type='text' name='name' value='John'/>
103 * <input type='text' name='location' value='Boston'/>
104 * @after name=John&location=Boston
105 * @desc Serialize a selection of input elements to a string
111 serialize: function() {
112 return jQuery.param( this );
116 * Evaluate all script tags inside this jQuery. If they have a src attribute,
117 * the script is loaded, otherwise it's content is evaluated.
124 evalScripts: function() {
125 return this.find("script").each(function(){
127 jQuery.getScript( this.src );
129 jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
135 // If IE is used, create a wrapper for the XMLHttpRequest object
136 if ( !window.XMLHttpRequest )
137 XMLHttpRequest = function(){
138 return new ActiveXObject("Microsoft.XMLHTTP");
141 // Attach a bunch of functions for handling common AJAX events
144 * Attach a function to be executed whenever an AJAX request begins
145 * and there is none already active.
147 * @example $("#loading").ajaxStart(function(){
150 * @desc Show a loading message whenever an AJAX request starts
151 * (and none is already active).
155 * @param Function callback The function to execute.
160 * Attach a function to be executed whenever all AJAX requests have ended.
162 * @example $("#loading").ajaxStop(function(){
165 * @desc Hide a loading message after all the AJAX requests have stopped.
169 * @param Function callback The function to execute.
174 * Attach a function to be executed whenever an AJAX request completes.
176 * The XMLHttpRequest and settings used for that request are passed
177 * as arguments to the callback.
179 * @example $("#msg").ajaxComplete(function(request, settings){
180 * $(this).append("<li>Request Complete.</li>");
182 * @desc Show a message when an AJAX request completes.
186 * @param Function callback The function to execute.
191 * Attach a function to be executed whenever an AJAX request completes
194 * The XMLHttpRequest and settings used for that request are passed
195 * as arguments to the callback.
197 * @example $("#msg").ajaxSuccess(function(request, settings){
198 * $(this).append("<li>Successful Request!</li>");
200 * @desc Show a message when an AJAX request completes successfully.
204 * @param Function callback The function to execute.
209 * Attach a function to be executed whenever an AJAX request fails.
211 * The XMLHttpRequest and settings used for that request are passed
212 * as arguments to the callback. A third argument, an exception object,
213 * is passed if an exception occured while processing the request.
215 * @example $("#msg").ajaxError(function(request, settings){
216 * $(this).append("<li>Error requesting page " + settings.url + "</li>");
218 * @desc Show a message when an AJAX request fails.
222 * @param Function callback The function to execute.
227 * Attach a function to be executed before an AJAX request is sent.
229 * The XMLHttpRequest and settings used for that request are passed
230 * as arguments to the callback.
232 * @example $("#msg").ajaxSend(function(request, settings){
233 * $(this).append("<li>Starting request at " + settings.url + "</li>");
235 * @desc Show a message before an AJAX request is sent.
239 * @param Function callback The function to execute.
242 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
243 jQuery.fn[o] = function(f){
244 return this.bind(o, f);
251 * Load a remote page using an HTTP GET request.
253 * This is an easy way to send a simple GET request to a server
254 * without having to use the more complex $.ajax function. It
255 * allows a single callback function to be specified that will
256 * be executed when the request is complete (and only if the response
257 * has a successful response code). If you need to have both error
258 * and success callbacks, you may want to use $.ajax.
260 * @example $.get("test.cgi");
262 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
264 * @example $.get("test.cgi", function(data){
265 * alert("Data Loaded: " + data);
268 * @example $.get("test.cgi",
269 * { name: "John", time: "2pm" },
271 * alert("Data Loaded: " + data);
276 * @type XMLHttpRequest
277 * @param String url The URL of the page to load.
278 * @param Map params (optional) Key/value pairs that will be sent to the server.
279 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
282 get: function( url, data, callback, type, ifModified ) {
283 // shift arguments if data argument was ommited
284 if ( jQuery.isFunction( data ) ) {
295 ifModified: ifModified
300 * Load a remote page using an HTTP GET request, only if it hasn't
301 * been modified since it was last retrieved.
303 * @example $.getIfModified("test.html");
305 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
307 * @example $.getIfModified("test.cgi", function(data){
308 * alert("Data Loaded: " + data);
311 * @example $.getifModified("test.cgi",
312 * { name: "John", time: "2pm" },
314 * alert("Data Loaded: " + data);
318 * @name $.getIfModified
319 * @type XMLHttpRequest
320 * @param String url The URL of the page to load.
321 * @param Map params (optional) Key/value pairs that will be sent to the server.
322 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
325 getIfModified: function( url, data, callback, type ) {
326 return jQuery.get(url, data, callback, type, 1);
330 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
332 * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
333 * context synchronously. If you load functions via getScript, make sure
334 * to call them after a delay.
336 * @example $.getScript("test.js");
338 * @example $.getScript("test.js", function(){
339 * alert("Script loaded and executed.");
343 * @type XMLHttpRequest
344 * @param String url The URL of the page to load.
345 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
348 getScript: function( url, callback ) {
349 return jQuery.get(url, null, callback, "script");
353 * Load JSON data using an HTTP GET request.
355 * @example $.getJSON("test.js", function(json){
356 * alert("JSON Data: " + json.users[3].name);
359 * @example $.getJSON("test.js",
360 * { name: "John", time: "2pm" },
362 * alert("JSON Data: " + json.users[3].name);
367 * @type XMLHttpRequest
368 * @param String url The URL of the page to load.
369 * @param Map params (optional) Key/value pairs that will be sent to the server.
370 * @param Function callback A function to be executed whenever the data is loaded successfully.
373 getJSON: function( url, data, callback ) {
374 return jQuery.get(url, data, callback, "json");
378 * Load a remote page using an HTTP POST request.
380 * @example $.post("test.cgi");
382 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
384 * @example $.post("test.cgi", function(data){
385 * alert("Data Loaded: " + data);
388 * @example $.post("test.cgi",
389 * { name: "John", time: "2pm" },
391 * alert("Data Loaded: " + data);
396 * @type XMLHttpRequest
397 * @param String url The URL of the page to load.
398 * @param Map params (optional) Key/value pairs that will be sent to the server.
399 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
402 post: function( url, data, callback, type ) {
403 if ( jQuery.isFunction( data ) ) {
421 * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
422 * This will make all future AJAX requests timeout after a specified amount
425 * Set to null or 0 to disable timeouts (default).
427 * You can manually abort requests with the XMLHttpRequest's (returned by
428 * all ajax functions) abort() method.
430 * Deprecated. Use $.ajaxSetup instead.
432 * @example $.ajaxTimeout( 5000 );
433 * @desc Make all AJAX requests timeout after 5 seconds.
435 * @name $.ajaxTimeout
437 * @param Number time How long before an AJAX request times out, in milliseconds.
440 ajaxTimeout: function( timeout ) {
441 jQuery.ajaxSettings.timeout = timeout;
445 * Setup global settings for AJAX requests.
447 * See $.ajax for a description of all available options.
449 * @example $.ajaxSetup( {
454 * $.ajax({ data: myData });
455 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
456 * disables global handlers and uses POST instead of GET. The following
457 * AJAX requests then sends some data without having to set anything else.
461 * @param Map settings Key/value pairs to use for all AJAX requests
464 ajaxSetup: function( settings ) {
465 jQuery.extend( jQuery.ajaxSettings, settings );
472 contentType: "application/x-www-form-urlencoded",
478 // Last-Modified header cache for next request
482 * Load a remote page using an HTTP request.
484 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
485 * higher-level abstractions that are often easier to understand and use,
486 * but don't offer as much functionality (such as error callbacks).
488 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
489 * need that object to manipulate directly, but it is available if you need to
490 * abort the request manually.
492 * '''Note:''' If you specify the dataType option described below, make sure
493 * the server sends the correct MIME type in the response (eg. xml as "text/xml").
494 * Sending the wrong MIME type can lead to unexpected problems in your script.
495 * See [[Specifying the Data Type for AJAX Requests]] for more information.
497 * Supported datatypes are (see dataType option):
499 * "xml": Returns a XML document that can be processed via jQuery.
501 * "html": Returns HTML as plain text, included script tags are evaluated.
503 * "script": Evaluates the response as Javascript and returns it as plain text.
505 * "json": Evaluates the response as JSON and returns a Javascript Object
507 * $.ajax() takes one argument, an object of key/value pairs, that are
508 * used to initalize and handle the request. These are all the key/values that can
511 * (String) url - The URL to request.
513 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
515 * (String) dataType - The type of data that you're expecting back from
516 * the server. No default: If the server sends xml, the responseXML, otherwise
517 * the responseText is passed to the success callback.
519 * (Boolean) ifModified - Allow the request to be successful only if the
520 * response has changed since the last request. This is done by checking the
521 * Last-Modified header. Default value is false, ignoring the header.
523 * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
524 * single request a longer timeout while all others timeout after 1 second.
525 * See $.ajaxTimeout() for global timeouts.
527 * (Boolean) global - Whether to trigger global AJAX event handlers for
528 * this request, default is true. Set to false to prevent that global handlers
529 * like ajaxStart or ajaxStop are triggered.
531 * (Function) error - A function to be called if the request fails. The
532 * function gets passed tree arguments: The XMLHttpRequest object, a
533 * string describing the type of error that occurred and an optional
534 * exception object, if one occured.
536 * (Function) success - A function to be called if the request succeeds. The
537 * function gets passed one argument: The data returned from the server,
538 * formatted according to the 'dataType' parameter.
540 * (Function) complete - A function to be called when the request finishes. The
541 * function gets passed two arguments: The XMLHttpRequest object and a
542 * string describing the type of success of the request.
544 * (Object|String) data - Data to be sent to the server. Converted to a query
545 * string, if not already a string. Is appended to the url for GET-requests.
546 * See processData option to prevent this automatic processing.
548 * (String) contentType - When sending data to the server, use this content-type.
549 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
551 * (Boolean) processData - By default, data passed in to the data option as an object
552 * other as string will be processed and transformed into a query string, fitting to
553 * the default content-type "application/x-www-form-urlencoded". If you want to send
554 * DOMDocuments, set this option to false.
556 * (Boolean) async - By default, all requests are sent asynchronous (set to true).
557 * If you need synchronous requests, set this option to false.
559 * (Function) beforeSend - A pre-callback to set custom headers etc., the
560 * XMLHttpRequest is passed as the only argument.
567 * @desc Load and execute a JavaScript file.
572 * data: "name=John&location=Boston",
573 * success: function(msg){
574 * alert( "Data Saved: " + msg );
577 * @desc Save some data to the server and notify the user once its complete.
579 * @example var html = $.ajax({
583 * @desc Loads data synchronously. Blocks the browser while the requests is active.
584 * It is better to block user interaction by other means when synchronization is
587 * @example var xmlDocument = [create xml document];
590 * processData: false,
592 * success: handleResponse
594 * @desc Sends an xml document as data to the server. By setting the processData
595 * option to false, the automatic conversion of data to strings is prevented.
598 * @type XMLHttpRequest
599 * @param Map properties Key/value pairs to initialize the request with.
601 * @see ajaxSetup(Map)
603 ajax: function( s ) {
604 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
605 s = jQuery.extend({}, jQuery.ajaxSettings, s);
609 // convert data if not already a string
610 if (s.processData && typeof s.data != "string")
611 s.data = jQuery.param(s.data);
612 // append data to url for get requests
613 if( s.type.toLowerCase() == "get" ) {
614 // "?" + data or "&" + data (in case there are already params)
615 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
616 // IE likes to send both get and post data, prevent this
621 // Watch for a new set of requests
622 if ( s.global && ! jQuery.active++ )
623 jQuery.event.trigger( "ajaxStart" );
625 var requestDone = false;
627 // Create the request object
628 var xml = new XMLHttpRequest();
631 xml.open(s.type, s.url, s.async);
633 // Set the correct header, if data is being sent
635 xml.setRequestHeader("Content-Type", s.contentType);
637 // Set the If-Modified-Since header, if ifModified mode.
639 xml.setRequestHeader("If-Modified-Since",
640 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
642 // Set header so the called script knows that it's an XMLHttpRequest
643 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
645 // Make sure the browser sends the right content length
646 if ( xml.overrideMimeType )
647 xml.setRequestHeader("Connection", "close");
649 // Allow custom headers/mimetypes
654 jQuery.event.trigger("ajaxSend", [xml, s]);
656 // Wait for a response to come back
657 var onreadystatechange = function(isTimeout){
658 // The transfer is complete and the data is available, or the request timed out
659 if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
662 // clear poll interval
670 status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
671 s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
672 // Make sure that the request was successful or notmodified
673 if ( status != "error" ) {
674 // Cache Last-Modified header, if ifModified mode.
677 modRes = xml.getResponseHeader("Last-Modified");
678 } catch(e) {} // swallow exception thrown by FF if header is not available
680 if ( s.ifModified && modRes )
681 jQuery.lastModified[s.url] = modRes;
683 // process the data (runs the xml through httpData regardless of callback)
684 var data = jQuery.httpData( xml, s.dataType );
686 // If a local callback was specified, fire it and pass it the data
688 s.success( data, status );
690 // Fire the global callback
692 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
694 jQuery.handleError(s, xml, status);
697 jQuery.handleError(s, xml, status, e);
700 // The request was completed
702 jQuery.event.trigger( "ajaxComplete", [xml, s] );
704 // Handle the global AJAX counter
705 if ( s.global && ! --jQuery.active )
706 jQuery.event.trigger( "ajaxStop" );
710 s.complete(xml, status);
718 // don't attach the handler to the request, just poll it instead
719 var ival = setInterval(onreadystatechange, 13);
723 setTimeout(function(){
724 // Check to see if the request is still happening
726 // Cancel the request
730 onreadystatechange( "timeout" );
738 jQuery.handleError(s, xml, null, e);
741 // firefox 1.5 doesn't fire statechange for sync requests
743 onreadystatechange();
745 // return XMLHttpRequest to allow aborting the request etc.
749 handleError: function( s, xml, status, e ) {
750 // If a local callback was specified, fire it
751 if ( s.error ) s.error( xml, status, e );
753 // Fire the global callback
755 jQuery.event.trigger( "ajaxError", [xml, s, e] );
758 // Counter for holding the number of active queries
761 // Determines if an XMLHttpRequest was successful or not
762 httpSuccess: function( r ) {
764 return !r.status && location.protocol == "file:" ||
765 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
766 jQuery.browser.safari && r.status == undefined;
771 // Determines if an XMLHttpRequest returns NotModified
772 httpNotModified: function( xml, url ) {
774 var xmlRes = xml.getResponseHeader("Last-Modified");
776 // Firefox always returns 200. check Last-Modified date
777 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
778 jQuery.browser.safari && xml.status == undefined;
783 /* Get the data out of an XMLHttpRequest.
784 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
785 * otherwise return plain text.
786 * (String) data - The type of data that you're expecting back,
787 * (e.g. "xml", "html", "script")
789 httpData: function( r, type ) {
790 var ct = r.getResponseHeader("content-type");
791 var data = !type && ct && ct.indexOf("xml") >= 0;
792 data = type == "xml" || data ? r.responseXML : r.responseText;
794 // If the type is "script", eval it in global context
795 if ( type == "script" )
796 jQuery.globalEval( data );
798 // Get the JavaScript object, if JSON is used.
799 if ( type == "json" )
800 eval( "data = " + data );
802 // evaluate scripts within html
803 if ( type == "html" )
804 jQuery("<div>").html(data).evalScripts();
809 // Serialize an array of form elements or a set of
810 // key/values into a query string
811 param: function( a ) {
814 // If an array was passed in, assume that it is an array
816 if ( a.constructor == Array || a.jquery )
817 // Serialize the form elements
818 jQuery.each( a, function(){
819 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
822 // Otherwise, assume that it's an object of key/value pairs
824 // Serialize the key/values
826 // If the value is an array then the key names need to be repeated
827 if ( a[j] && a[j].constructor == Array )
828 jQuery.each( a[j], function(){
829 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
832 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
834 // Return the resulting serialization
838 // evalulates a script in global context
839 // not reliable for safari
840 globalEval: function( data ) {
841 if ( window.execScript )
842 window.execScript( data );
843 else if ( jQuery.browser.safari )
844 // safari doesn't provide a synchronous global eval
845 window.setTimeout( data, 0 );
847 eval.call( window, data );