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 ) ) {
294 ifModified: ifModified
299 * Load a remote page using an HTTP GET request, only if it hasn't
300 * been modified since it was last retrieved.
302 * @example $.getIfModified("test.html");
304 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
306 * @example $.getIfModified("test.cgi", function(data){
307 * alert("Data Loaded: " + data);
310 * @example $.getifModified("test.cgi",
311 * { name: "John", time: "2pm" },
313 * alert("Data Loaded: " + data);
317 * @name $.getIfModified
318 * @type XMLHttpRequest
319 * @param String url The URL of the page to load.
320 * @param Map params (optional) Key/value pairs that will be sent to the server.
321 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
324 getIfModified: function( url, data, callback, type ) {
325 return jQuery.get(url, data, callback, type, 1);
329 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
331 * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
332 * context synchronously. If you load functions via getScript, make sure
333 * to call them after a delay.
335 * @example $.getScript("test.js");
337 * @example $.getScript("test.js", function(){
338 * alert("Script loaded and executed.");
342 * @type XMLHttpRequest
343 * @param String url The URL of the page to load.
344 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
347 getScript: function( url, callback ) {
348 return jQuery.get(url, null, callback, "script");
352 * Load JSON data using an HTTP GET request.
354 * @example $.getJSON("test.js", function(json){
355 * alert("JSON Data: " + json.users[3].name);
358 * @example $.getJSON("test.js",
359 * { name: "John", time: "2pm" },
361 * alert("JSON Data: " + json.users[3].name);
366 * @type XMLHttpRequest
367 * @param String url The URL of the page to load.
368 * @param Map params (optional) Key/value pairs that will be sent to the server.
369 * @param Function callback A function to be executed whenever the data is loaded successfully.
372 getJSON: function( url, data, callback ) {
373 return jQuery.get(url, data, callback, "json");
377 * Load a remote page using an HTTP POST request.
379 * @example $.post("test.cgi");
381 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
383 * @example $.post("test.cgi", function(data){
384 * alert("Data Loaded: " + data);
387 * @example $.post("test.cgi",
388 * { name: "John", time: "2pm" },
390 * alert("Data Loaded: " + data);
395 * @type XMLHttpRequest
396 * @param String url The URL of the page to load.
397 * @param Map params (optional) Key/value pairs that will be sent to the server.
398 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
401 post: function( url, data, callback, type ) {
402 if ( jQuery.isFunction( data ) ) {
420 * Set the timeout of all AJAX requests to a specific amount of time.
421 * This will make all future AJAX requests timeout after a specified amount
424 * Set to null or 0 to disable timeouts (default).
426 * You can manually abort requests with the XMLHttpRequest's (returned by
427 * all ajax functions) abort() method.
429 * Deprecated. Use $.ajaxSetup instead.
431 * @example $.ajaxTimeout( 5000 );
432 * @desc Make all AJAX requests timeout after 5 seconds.
434 * @name $.ajaxTimeout
436 * @param Number time How long before an AJAX request times out.
439 ajaxTimeout: function( timeout ) {
440 jQuery.ajaxSettings.timeout = timeout;
444 * Setup global settings for AJAX requests.
446 * See $.ajax for a description of all available options.
448 * @example $.ajaxSetup( {
453 * $.ajax({ data: myData });
454 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
455 * disables global handlers and uses POST instead of GET. The following
456 * AJAX requests then sends some data without having to set anything else.
460 * @param Map settings Key/value pairs to use for all AJAX requests
463 ajaxSetup: function( settings ) {
464 jQuery.extend( jQuery.ajaxSettings, settings );
471 contentType: "application/x-www-form-urlencoded",
477 // Last-Modified header cache for next request
481 * Load a remote page using an HTTP request.
483 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
484 * higher-level abstractions that are often easier to understand and use,
485 * but don't offer as much functionality (such as error callbacks).
487 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
488 * need that object to manipulate directly, but it is available if you need to
489 * abort the request manually.
491 * '''Note:''' If you specify the dataType option described below, make sure
492 * the server sends the correct MIME type in the response (eg. xml as "text/xml").
493 * Sending the wrong MIME type can lead to unexpected problems in your script.
494 * See [[Specifying the Data Type for AJAX Requests]] for more information.
496 * Supported datatypes are (see dataType option):
498 * "xml": Returns a XML document that can be processed via jQuery.
500 * "html": Returns HTML as plain text, included script tags are evaluated.
502 * "script": Evaluates the response as Javascript and returns it as plain text.
504 * "json": Evaluates the response as JSON and returns a Javascript Object
506 * $.ajax() takes one argument, an object of key/value pairs, that are
507 * used to initalize and handle the request. These are all the key/values that can
510 * (String) url - The URL to request.
512 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
514 * (String) dataType - The type of data that you're expecting back from
515 * the server. No default: If the server sends xml, the responseXML, otherwise
516 * the responseText is passed to the success callback.
518 * (Boolean) ifModified - Allow the request to be successful only if the
519 * response has changed since the last request. This is done by checking the
520 * Last-Modified header. Default value is false, ignoring the header.
522 * (Number) timeout - Local timeout to override global timeout, eg. to give a
523 * single request a longer timeout while all others timeout after 1 second.
524 * See $.ajaxTimeout() for global timeouts.
526 * (Boolean) global - Whether to trigger global AJAX event handlers for
527 * this request, default is true. Set to false to prevent that global handlers
528 * like ajaxStart or ajaxStop are triggered.
530 * (Function) error - A function to be called if the request fails. The
531 * function gets passed tree arguments: The XMLHttpRequest object, a
532 * string describing the type of error that occurred and an optional
533 * exception object, if one occured.
535 * (Function) success - A function to be called if the request succeeds. The
536 * function gets passed one argument: The data returned from the server,
537 * formatted according to the 'dataType' parameter.
539 * (Function) complete - A function to be called when the request finishes. The
540 * function gets passed two arguments: The XMLHttpRequest object and a
541 * string describing the type of success of the request.
543 * (Object|String) data - Data to be sent to the server. Converted to a query
544 * string, if not already a string. Is appended to the url for GET-requests.
545 * See processData option to prevent this automatic processing.
547 * (String) contentType - When sending data to the server, use this content-type.
548 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
550 * (Boolean) processData - By default, data passed in to the data option as an object
551 * other as string will be processed and transformed into a query string, fitting to
552 * the default content-type "application/x-www-form-urlencoded". If you want to send
553 * DOMDocuments, set this option to false.
555 * (Boolean) async - By default, all requests are sent asynchronous (set to true).
556 * If you need synchronous requests, set this option to false.
558 * (Function) beforeSend - A pre-callback to set custom headers etc., the
559 * XMLHttpRequest is passed as the only argument.
566 * @desc Load and execute a JavaScript file.
571 * data: "name=John&location=Boston",
572 * success: function(msg){
573 * alert( "Data Saved: " + msg );
576 * @desc Save some data to the server and notify the user once its complete.
578 * @example var html = $.ajax({
582 * @desc Loads data synchronously. Blocks the browser while the requests is active.
583 * It is better to block user interaction by other means when synchronization is
586 * @example var xmlDocument = [create xml document];
589 * processData: false,
591 * success: handleResponse
593 * @desc Sends an xml document as data to the server. By setting the processData
594 * option to false, the automatic conversion of data to strings is prevented.
597 * @type XMLHttpRequest
598 * @param Map properties Key/value pairs to initialize the request with.
600 * @see ajaxSetup(Map)
602 ajax: function( s ) {
603 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
604 s = jQuery.extend({}, jQuery.ajaxSettings, s);
608 // convert data if not already a string
609 if (s.processData && typeof s.data != "string")
610 s.data = jQuery.param(s.data);
611 // append data to url for get requests
612 if( s.type.toLowerCase() == "get" ) {
613 // "?" + data or "&" + data (in case there are already params)
614 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
615 // IE likes to send both get and post data, prevent this
620 // Watch for a new set of requests
621 if ( s.global && ! jQuery.active++ )
622 jQuery.event.trigger( "ajaxStart" );
624 var requestDone = false;
626 // Create the request object
627 var xml = new XMLHttpRequest();
630 xml.open(s.type, s.url, s.async);
632 // Set the correct header, if data is being sent
634 xml.setRequestHeader("Content-Type", s.contentType);
636 // Set the If-Modified-Since header, if ifModified mode.
638 xml.setRequestHeader("If-Modified-Since",
639 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
641 // Set header so the called script knows that it's an XMLHttpRequest
642 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
644 // Make sure the browser sends the right content length
645 if ( xml.overrideMimeType )
646 xml.setRequestHeader("Connection", "close");
648 // Allow custom headers/mimetypes
653 jQuery.event.trigger("ajaxSend", [xml, s]);
655 // Wait for a response to come back
656 var onreadystatechange = function(isTimeout){
657 // The transfer is complete and the data is available, or the request timed out
658 if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
661 // clear poll interval
669 status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
670 s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
671 // Make sure that the request was successful or notmodified
672 if ( status != "error" ) {
673 // Cache Last-Modified header, if ifModified mode.
676 modRes = xml.getResponseHeader("Last-Modified");
677 } catch(e) {} // swallow exception thrown by FF if header is not available
679 if ( s.ifModified && modRes )
680 jQuery.lastModified[s.url] = modRes;
682 // process the data (runs the xml through httpData regardless of callback)
683 var data = jQuery.httpData( xml, s.dataType );
685 // If a local callback was specified, fire it and pass it the data
687 s.success( data, status );
689 // Fire the global callback
691 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
693 jQuery.handleError(s, xml, status);
696 jQuery.handleError(s, xml, status, e);
699 // The request was completed
701 jQuery.event.trigger( "ajaxComplete", [xml, s] );
703 // Handle the global AJAX counter
704 if ( s.global && ! --jQuery.active )
705 jQuery.event.trigger( "ajaxStop" );
709 s.complete(xml, status);
717 // don't attach the handler to the request, just poll it instead
718 var ival = setInterval(onreadystatechange, 13);
722 setTimeout(function(){
723 // Check to see if the request is still happening
725 // Cancel the request
729 onreadystatechange( "timeout" );
737 jQuery.handleError(s, xml, null, e);
740 // firefox 1.5 doesn't fire statechange for sync requests
742 onreadystatechange();
744 // return XMLHttpRequest to allow aborting the request etc.
748 handleError: function( s, xml, status, e ) {
749 // If a local callback was specified, fire it
750 if ( s.error ) s.error( xml, status, e );
752 // Fire the global callback
754 jQuery.event.trigger( "ajaxError", [xml, s, e] );
757 // Counter for holding the number of active queries
760 // Determines if an XMLHttpRequest was successful or not
761 httpSuccess: function( r ) {
763 return !r.status && location.protocol == "file:" ||
764 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
765 jQuery.browser.safari && r.status == undefined;
770 // Determines if an XMLHttpRequest returns NotModified
771 httpNotModified: function( xml, url ) {
773 var xmlRes = xml.getResponseHeader("Last-Modified");
775 // Firefox always returns 200. check Last-Modified date
776 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
777 jQuery.browser.safari && xml.status == undefined;
782 /* Get the data out of an XMLHttpRequest.
783 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
784 * otherwise return plain text.
785 * (String) data - The type of data that you're expecting back,
786 * (e.g. "xml", "html", "script")
788 httpData: function( r, type ) {
789 var ct = r.getResponseHeader("content-type");
790 var data = !type && ct && ct.indexOf("xml") >= 0;
791 data = type == "xml" || data ? r.responseXML : r.responseText;
793 // If the type is "script", eval it in global context
794 if ( type == "script" )
795 jQuery.globalEval( data );
797 // Get the JavaScript object, if JSON is used.
798 if ( type == "json" )
799 eval( "data = " + data );
801 // evaluate scripts within html
802 if ( type == "html" )
803 jQuery("<div>").html(data).evalScripts();
808 // Serialize an array of form elements or a set of
809 // key/values into a query string
810 param: function( a ) {
813 // If an array was passed in, assume that it is an array
815 if ( a.constructor == Array || a.jquery )
816 // Serialize the form elements
817 jQuery.each( a, function(){
818 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
821 // Otherwise, assume that it's an object of key/value pairs
823 // Serialize the key/values
825 // If the value is an array then the key names need to be repeated
826 if ( a[j] && a[j].constructor == Array )
827 jQuery.each( a[j], function(){
828 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
831 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
833 // Return the resulting serialization
837 // evalulates a script in global context
838 // not reliable for safari
839 globalEval: function( data ) {
840 if ( window.execScript )
841 window.execScript( data );
842 else if ( jQuery.browser.safari )
843 // safari doesn't provide a synchronous global eval
844 window.setTimeout( data, 0 );
846 eval.call( window, data );