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).
19 loadIfModified: function( url, params, callback ) {
20 this.load( url, params, callback, 1 );
24 * Load HTML from a remote file and inject it into the DOM.
26 * Note: Avoid to use this to load scripts, instead use $.getScript.
27 * IE strips script tags when there aren't any other characters in front of it.
29 * @example $("#feeds").load("feeds.html");
30 * @before <div id="feeds"></div>
31 * @result <div id="feeds"><b>45</b> feeds found.</div>
33 * @example $("#feeds").load("feeds.html",
35 * function() { alert("The last 25 entries in the feed have been loaded"); }
37 * @desc Same as above, but with an additional parameter
38 * and a callback that is executed when the data was loaded.
42 * @param String url The URL of the HTML file to load.
43 * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
44 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
47 load: function( url, params, callback, ifModified ) {
48 if ( jQuery.isFunction( url ) )
49 return this.bind("load", url);
51 var off = url.indexOf(" ");
52 var selector = url.slice(off, url.length);
53 url = url.slice(0, off);
55 callback = callback || function(){};
57 // Default to a GET request
60 // If the second parameter was provided
63 if ( jQuery.isFunction( params ) ) {
64 // We assume that it's the callback
68 // Otherwise, build a param string
70 params = jQuery.param( params );
76 // Request the remote document
81 ifModified: ifModified,
82 complete: function(res, status){
83 // If successful, inject the HTML into all the matched elements
84 if ( status == "success" || !ifModified && status == "notmodified" )
85 // See if a selector was specified
87 // Create a dummy div to hold the results
89 // inject the contents of the document in, removing the scripts
90 // to avoid any 'Permission Denied' errors in IE
91 .append(res.responseText.replace(/<script(.|\s)*?\/script>/g, ""))
93 // Locate the specified elements
96 // If not, just inject the full result
99 // Add delay to account for Safari's delay in globalEval
100 setTimeout(function(){
101 self.each( callback, [res.responseText, status, res] );
109 * Serializes a set of input elements into a string of data.
110 * This will serialize all given elements.
112 * A serialization similar to the form submit of a browser is
113 * provided by the [http://www.malsup.com/jquery/form/ Form Plugin].
114 * It also takes multiple-selects
115 * into account, while this method recognizes only a single option.
117 * @example $("input[@type=text]").serialize();
118 * @before <input type='text' name='name' value='John'/>
119 * <input type='text' name='location' value='Boston'/>
120 * @after name=John&location=Boston
121 * @desc Serialize a selection of input elements to a string
127 serialize: function() {
128 return jQuery.param( this );
132 // This method no longer does anything - all script evaluation is
133 // taken care of within the HTML injection methods.
134 evalScripts: function(){}
138 // Attach a bunch of functions for handling common AJAX events
141 * Attach a function to be executed whenever an AJAX request begins
142 * and there is none already active.
144 * @example $("#loading").ajaxStart(function(){
147 * @desc Show a loading message whenever an AJAX request starts
148 * (and none is already active).
152 * @param Function callback The function to execute.
157 * Attach a function to be executed whenever all AJAX requests have ended.
159 * @example $("#loading").ajaxStop(function(){
162 * @desc Hide a loading message after all the AJAX requests have stopped.
166 * @param Function callback The function to execute.
171 * Attach a function to be executed whenever an AJAX request completes.
173 * The XMLHttpRequest and settings used for that request are passed
174 * as arguments to the callback.
176 * @example $("#msg").ajaxComplete(function(request, settings){
177 * $(this).append("<li>Request Complete.</li>");
179 * @desc Show a message when an AJAX request completes.
183 * @param Function callback The function to execute.
188 * Attach a function to be executed whenever an AJAX request completes
191 * The XMLHttpRequest and settings used for that request are passed
192 * as arguments to the callback.
194 * @example $("#msg").ajaxSuccess(function(request, settings){
195 * $(this).append("<li>Successful Request!</li>");
197 * @desc Show a message when an AJAX request completes successfully.
201 * @param Function callback The function to execute.
206 * Attach a function to be executed whenever an AJAX request fails.
208 * The XMLHttpRequest and settings used for that request are passed
209 * as arguments to the callback. A third argument, an exception object,
210 * is passed if an exception occured while processing the request.
212 * @example $("#msg").ajaxError(function(request, settings){
213 * $(this).append("<li>Error requesting page " + settings.url + "</li>");
215 * @desc Show a message when an AJAX request fails.
219 * @param Function callback The function to execute.
224 * Attach a function to be executed before an AJAX request is sent.
226 * The XMLHttpRequest and settings used for that request are passed
227 * as arguments to the callback.
229 * @example $("#msg").ajaxSend(function(request, settings){
230 * $(this).append("<li>Starting request at " + settings.url + "</li>");
232 * @desc Show a message before an AJAX request is sent.
236 * @param Function callback The function to execute.
239 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
240 jQuery.fn[o] = function(f){
241 return this.bind(o, f);
248 * Load a remote page using an HTTP GET request.
250 * This is an easy way to send a simple GET request to a server
251 * without having to use the more complex $.ajax function. It
252 * allows a single callback function to be specified that will
253 * be executed when the request is complete (and only if the response
254 * has a successful response code). If you need to have both error
255 * and success callbacks, you may want to use $.ajax.
257 * @example $.get("test.cgi");
259 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
261 * @example $.get("test.cgi", function(data){
262 * alert("Data Loaded: " + data);
265 * @example $.get("test.cgi",
266 * { name: "John", time: "2pm" },
268 * alert("Data Loaded: " + data);
273 * @type XMLHttpRequest
274 * @param String url The URL of the page to load.
275 * @param Map params (optional) Key/value pairs that will be sent to the server.
276 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
279 get: function( url, data, callback, type, ifModified ) {
280 // shift arguments if data argument was ommited
281 if ( jQuery.isFunction( data ) ) {
292 ifModified: ifModified
297 * Load a remote page using an HTTP GET request, only if it hasn't
298 * been modified since it was last retrieved.
300 * @example $.getIfModified("test.html");
302 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
304 * @example $.getIfModified("test.cgi", function(data){
305 * alert("Data Loaded: " + data);
308 * @example $.getifModified("test.cgi",
309 * { name: "John", time: "2pm" },
311 * alert("Data Loaded: " + data);
315 * @name $.getIfModified
316 * @type XMLHttpRequest
317 * @param String url The URL of the page to load.
318 * @param Map params (optional) Key/value pairs that will be sent to the server.
319 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
323 getIfModified: function( url, data, callback, type ) {
324 return jQuery.get(url, data, callback, type, 1);
328 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
330 * Warning: Safari <= 2.0.x is unable to evaluate scripts in a global
331 * context synchronously. If you load functions via getScript, make sure
332 * to call them after a delay.
334 * @example $.getScript("test.js");
336 * @example $.getScript("test.js", function(){
337 * alert("Script loaded and executed.");
341 * @type XMLHttpRequest
342 * @param String url The URL of the page to load.
343 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
346 getScript: function( url, callback ) {
347 return jQuery.get(url, null, callback, "script");
351 * Load JSON data using an HTTP GET request.
353 * @example $.getJSON("test.js", function(json){
354 * alert("JSON Data: " + json.users[3].name);
357 * @example $.getJSON("test.js",
358 * { name: "John", time: "2pm" },
360 * alert("JSON Data: " + json.users[3].name);
365 * @type XMLHttpRequest
366 * @param String url The URL of the page to load.
367 * @param Map params (optional) Key/value pairs that will be sent to the server.
368 * @param Function callback A function to be executed whenever the data is loaded successfully.
371 getJSON: function( url, data, callback ) {
372 return jQuery.get(url, data, callback, "json");
376 * Load a remote page using an HTTP POST request.
378 * @example $.post("test.cgi");
380 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
382 * @example $.post("test.cgi", function(data){
383 * alert("Data Loaded: " + data);
386 * @example $.post("test.cgi",
387 * { name: "John", time: "2pm" },
389 * alert("Data Loaded: " + data);
394 * @type XMLHttpRequest
395 * @param String url The URL of the page to load.
396 * @param Map params (optional) Key/value pairs that will be sent to the server.
397 * @param Function callback (optional) A function to be executed whenever the data is loaded successfully.
400 post: function( url, data, callback, type ) {
401 if ( jQuery.isFunction( data ) ) {
416 * Set the timeout in milliseconds of all AJAX requests to a specific amount of time.
417 * This will make all future AJAX requests timeout after a specified amount
420 * Set to null or 0 to disable timeouts (default).
422 * You can manually abort requests with the XMLHttpRequest's (returned by
423 * all ajax functions) abort() method.
425 * Deprecated. Use $.ajaxSetup instead.
427 * @example $.ajaxTimeout( 5000 );
428 * @desc Make all AJAX requests timeout after 5 seconds.
430 * @name $.ajaxTimeout
432 * @param Number time How long before an AJAX request times out, in milliseconds.
436 ajaxTimeout: function( timeout ) {
437 jQuery.ajaxSettings.timeout = timeout;
441 * Setup global settings for AJAX requests.
443 * See $.ajax for a description of all available options.
445 * @example $.ajaxSetup( {
450 * $.ajax({ data: myData });
451 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
452 * disables global handlers and uses POST instead of GET. The following
453 * AJAX requests then sends some data without having to set anything else.
457 * @param Map settings Key/value pairs to use for all AJAX requests
460 ajaxSetup: function( settings ) {
461 jQuery.extend( jQuery.ajaxSettings, settings );
468 contentType: "application/x-www-form-urlencoded",
474 // Last-Modified header cache for next request
478 * Load a remote page using an HTTP request.
480 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
481 * higher-level abstractions that are often easier to understand and use,
482 * but don't offer as much functionality (such as error callbacks).
484 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
485 * need that object to manipulate directly, but it is available if you need to
486 * abort the request manually.
488 * '''Note:''' If you specify the dataType option described below, make sure
489 * the server sends the correct MIME type in the response (eg. xml as "text/xml").
490 * Sending the wrong MIME type can lead to unexpected problems in your script.
491 * See [[Specifying the Data Type for AJAX Requests]] for more information.
493 * Supported datatypes are (see dataType option):
495 * "xml": Returns a XML document that can be processed via jQuery.
497 * "html": Returns HTML as plain text, included script tags are evaluated.
499 * "script": Evaluates the response as Javascript and returns it as plain text.
501 * "json": Evaluates the response as JSON and returns a Javascript Object
503 * $.ajax() takes one argument, an object of key/value pairs, that are
504 * used to initalize and handle the request. These are all the key/values that can
507 * (String) url - The URL to request.
509 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
511 * (String) dataType - The type of data that you're expecting back from
512 * the server. No default: If the server sends xml, the responseXML, otherwise
513 * the responseText is passed to the success callback.
515 * (Boolean) ifModified - Allow the request to be successful only if the
516 * response has changed since the last request. This is done by checking the
517 * Last-Modified header. Default value is false, ignoring the header.
519 * (Number) timeout - Local timeout in milliseconds to override global timeout, eg. to give a
520 * single request a longer timeout while all others timeout after 1 second.
521 * See $.ajaxTimeout() for global timeouts.
523 * (Boolean) global - Whether to trigger global AJAX event handlers for
524 * this request, default is true. Set to false to prevent that global handlers
525 * like ajaxStart or ajaxStop are triggered.
527 * (Function) error - A function to be called if the request fails. The
528 * function gets passed tree arguments: The XMLHttpRequest object, a
529 * string describing the type of error that occurred and an optional
530 * exception object, if one occured.
532 * (Function) success - A function to be called if the request succeeds. The
533 * function gets passed one argument: The data returned from the server,
534 * formatted according to the 'dataType' parameter.
536 * (Function) complete - A function to be called when the request finishes. The
537 * function gets passed two arguments: The XMLHttpRequest object and a
538 * string describing the type of success of the request.
540 * (Object|String) data - Data to be sent to the server. Converted to a query
541 * string, if not already a string. Is appended to the url for GET-requests.
542 * See processData option to prevent this automatic processing.
544 * (String) contentType - When sending data to the server, use this content-type.
545 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
547 * (Boolean) processData - By default, data passed in to the data option as an object
548 * other as string will be processed and transformed into a query string, fitting to
549 * the default content-type "application/x-www-form-urlencoded". If you want to send
550 * DOMDocuments, set this option to false.
552 * (Boolean) async - By default, all requests are sent asynchronous (set to true).
553 * If you need synchronous requests, set this option to false.
555 * (Function) beforeSend - A pre-callback to set custom headers etc., the
556 * XMLHttpRequest is passed as the only argument.
563 * @desc Load and execute a JavaScript file.
568 * data: "name=John&location=Boston",
569 * success: function(msg){
570 * alert( "Data Saved: " + msg );
573 * @desc Save some data to the server and notify the user once its complete.
575 * @example var html = $.ajax({
579 * @desc Loads data synchronously. Blocks the browser while the requests is active.
580 * It is better to block user interaction by other means when synchronization is
583 * @example var xmlDocument = [create xml document];
586 * processData: false,
588 * success: handleResponse
590 * @desc Sends an xml document as data to the server. By setting the processData
591 * option to false, the automatic conversion of data to strings is prevented.
594 * @type XMLHttpRequest
595 * @param Map properties Key/value pairs to initialize the request with.
597 * @see ajaxSetup(Map)
599 ajax: function( s ) {
600 // Extend the settings, but re-extend 's' so that it can be
601 // checked again later (in the test suite, specifically)
602 s = jQuery.extend(true, s, jQuery.extend(true, {}, jQuery.ajaxSettings, s));
606 // convert data if not already a string
607 if ( s.processData && typeof s.data != "string" )
608 s.data = jQuery.param(s.data);
610 // append data to url for get requests
611 if ( s.type.toLowerCase() == "get" ) {
612 // "?" + data or "&" + data (in case there are already params)
613 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; Microsoft failed to properly
627 // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
628 var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : 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 // Allow custom headers/mimetypes
650 jQuery.event.trigger("ajaxSend", [xml, s]);
652 // Wait for a response to come back
653 var onreadystatechange = function(isTimeout){
654 // The transfer is complete and the data is available, or the request timed out
655 if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
658 // clear poll interval
664 var status = isTimeout == "timeout" && "timeout" ||
665 !jQuery.httpSuccess( xml ) && "error" ||
666 s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
669 if ( status == "success" ) {
670 // Watch for, and catch, XML document parse errors
672 // process the data (runs the xml through httpData regardless of callback)
673 var data = jQuery.httpData( xml, s.dataType );
675 status = "parsererror";
679 // Make sure that the request was successful or notmodified
680 if ( status == "success" ) {
681 // Cache Last-Modified header, if ifModified mode.
684 modRes = xml.getResponseHeader("Last-Modified");
685 } catch(e) {} // swallow exception thrown by FF if header is not available
687 if ( s.ifModified && modRes )
688 jQuery.lastModified[s.url] = modRes;
690 // If a local callback was specified, fire it and pass it the data
692 s.success( data, status );
694 // Fire the global callback
696 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
698 jQuery.handleError(s, xml, status);
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);
719 // don't attach the handler to the request, just poll it instead
720 var ival = setInterval(onreadystatechange, 13);
724 setTimeout(function(){
725 // Check to see if the request is still happening
727 // Cancel the request
731 onreadystatechange( "timeout" );
740 jQuery.handleError(s, xml, null, e);
743 // firefox 1.5 doesn't fire statechange for sync requests
745 onreadystatechange();
747 // return XMLHttpRequest to allow aborting the request etc.
751 handleError: function( s, xml, status, e ) {
752 // If a local callback was specified, fire it
753 if ( s.error ) s.error( xml, status, e );
755 // Fire the global callback
757 jQuery.event.trigger( "ajaxError", [xml, s, e] );
760 // Counter for holding the number of active queries
763 // Determines if an XMLHttpRequest was successful or not
764 httpSuccess: function( r ) {
766 return !r.status && location.protocol == "file:" ||
767 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
768 jQuery.browser.safari && r.status == undefined;
773 // Determines if an XMLHttpRequest returns NotModified
774 httpNotModified: function( xml, url ) {
776 var xmlRes = xml.getResponseHeader("Last-Modified");
778 // Firefox always returns 200. check Last-Modified date
779 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
780 jQuery.browser.safari && xml.status == undefined;
785 /* Get the data out of an XMLHttpRequest.
786 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
787 * otherwise return plain text.
788 * (String) data - The type of data that you're expecting back,
789 * (e.g. "xml", "html", "script")
791 httpData: function( r, type ) {
792 var ct = r.getResponseHeader("content-type");
793 var xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0;
794 data = xml ? r.responseXML : r.responseText;
796 if ( xml && data.documentElement.tagName == "parsererror" )
799 // If the type is "script", eval it in global context
800 if ( type == "script" )
801 jQuery.globalEval( data );
803 // Get the JavaScript object, if JSON is used.
804 if ( type == "json" )
805 data = eval("(" + data + ")");
810 // Serialize an array of form elements or a set of
811 // key/values into a query string
812 param: function( a ) {
815 // If an array was passed in, assume that it is an array
817 if ( a.constructor == Array || a.jquery )
818 // Serialize the form elements
819 jQuery.each( a, function(){
820 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
823 // Otherwise, assume that it's an object of key/value pairs
825 // Serialize the key/values
827 // If the value is an array then the key names need to be repeated
828 if ( a[j] && a[j].constructor == Array )
829 jQuery.each( a[j], function(){
830 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
833 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
835 // Return the resulting serialization