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 ( url.constructor == Function )
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 ( params.constructor == Function ) {
59 // We assume that it's the callback
63 // Otherwise, build a param string
65 params = jQuery.param( params );
72 // Request the remote document
77 ifModified: ifModified,
78 complete: function(res, status){
79 if ( status == "success" || !ifModified && status == "notmodified" ) {
80 // Inject the HTML into all the matched elements
81 self.html(res.responseText)
82 // Execute all the scripts inside of the newly-injected HTML
85 .each( callback, [res.responseText, status, res] );
87 callback.apply( self, [res.responseText, status, res] );
94 * Serializes a set of input elements into a string of data.
95 * This will serialize all given elements.
97 * A serialization similar to the form submit of a browser is
98 * provided by the form plugin. 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 || "" );
136 // If IE is used, create a wrapper for the XMLHttpRequest object
137 if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
138 XMLHttpRequest = function(){
139 return new ActiveXObject("Microsoft.XMLHTTP");
142 // Attach a bunch of functions for handling common AJAX events
145 * Attach a function to be executed whenever an AJAX request begins
146 * and there is none already active.
148 * @example $("#loading").ajaxStart(function(){
151 * @desc Show a loading message whenever an AJAX request starts
152 * (and none is already active).
156 * @param Function callback The function to execute.
161 * Attach a function to be executed whenever all AJAX requests have ended.
163 * @example $("#loading").ajaxStop(function(){
166 * @desc Hide a loading message after all the AJAX requests have stopped.
170 * @param Function callback The function to execute.
175 * Attach a function to be executed whenever an AJAX request completes.
177 * The XMLHttpRequest and settings used for that request are passed
178 * as arguments to the callback.
180 * @example $("#msg").ajaxComplete(function(request, settings){
181 * $(this).append("<li>Request Complete.</li>");
183 * @desc Show a message when an AJAX request completes.
187 * @param Function callback The function to execute.
192 * Attach a function to be executed whenever an AJAX request completes
195 * The XMLHttpRequest and settings used for that request are passed
196 * as arguments to the callback.
198 * @example $("#msg").ajaxSuccess(function(request, settings){
199 * $(this).append("<li>Successful Request!</li>");
201 * @desc Show a message when an AJAX request completes successfully.
205 * @param Function callback The function to execute.
210 * Attach a function to be executed whenever an AJAX request fails.
212 * The XMLHttpRequest and settings used for that request are passed
213 * as arguments to the callback. A third argument, an exception object,
214 * is passed if an exception occured while processing the request.
216 * @example $("#msg").ajaxError(function(request, settings){
217 * $(this).append("<li>Error requesting page " + settings.url + "</li>");
219 * @desc Show a message when an AJAX request fails.
223 * @param Function callback The function to execute.
228 * Attach a function to be executed before an AJAX request is send.
230 * The XMLHttpRequest and settings used for that request are passed
231 * as arguments to the callback.
233 * @example $("#msg").ajaxSend(function(request, settings){
234 * $(this).append("<li>Starting request at " + settings.url + "</li>");
236 * @desc Show a message before an AJAX request is send.
240 * @param Function callback The function to execute.
243 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
244 jQuery.fn[o] = function(f){
245 return this.bind(o, f);
252 * Load a remote page using an HTTP GET request.
254 * @example $.get("test.cgi");
256 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
258 * @example $.get("test.cgi", function(data){
259 * alert("Data Loaded: " + data);
262 * @example $.get("test.cgi",
263 * { name: "John", time: "2pm" },
265 * alert("Data Loaded: " + data);
270 * @type XMLHttpRequest
271 * @param String url The URL of the page to load.
272 * @param Map params (optional) Key/value pairs that will be sent to the server.
273 * @param Function callback (optional) A function to be executed whenever the data is loaded.
276 get: function( url, data, callback, type, ifModified ) {
277 // shift arguments if data argument was ommited
278 if ( data && data.constructor == Function ) {
287 ifModified: ifModified
292 * Load a remote page using an HTTP GET request, only if it hasn't
293 * been modified since it was last retrieved.
295 * @example $.getIfModified("test.html");
297 * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
299 * @example $.getIfModified("test.cgi", function(data){
300 * alert("Data Loaded: " + data);
303 * @example $.getifModified("test.cgi",
304 * { name: "John", time: "2pm" },
306 * alert("Data Loaded: " + data);
310 * @name $.getIfModified
311 * @type XMLHttpRequest
312 * @param String url The URL of the page to load.
313 * @param Map params (optional) Key/value pairs that will be sent to the server.
314 * @param Function callback (optional) A function to be executed whenever the data is loaded.
317 getIfModified: function( url, data, callback, type ) {
318 return jQuery.get(url, data, callback, type, 1);
322 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
324 * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
325 * context synchronously. If you load functions via getScript, make sure
326 * to call them after a delay.
328 * @example $.getScript("test.js");
330 * @example $.getScript("test.js", function(){
331 * alert("Script loaded and executed.");
335 * @type XMLHttpRequest
336 * @param String url The URL of the page to load.
337 * @param Function callback (optional) A function to be executed whenever the data is loaded.
340 getScript: function( url, callback ) {
341 return jQuery.get(url, null, callback, "script");
345 * Load JSON data using an HTTP GET request.
347 * @example $.getJSON("test.js", function(json){
348 * alert("JSON Data: " + json.users[3].name);
351 * @example $.getJSON("test.js",
352 * { name: "John", time: "2pm" },
354 * alert("JSON Data: " + json.users[3].name);
359 * @type XMLHttpRequest
360 * @param String url The URL of the page to load.
361 * @param Map params (optional) Key/value pairs that will be sent to the server.
362 * @param Function callback A function to be executed whenever the data is loaded.
365 getJSON: function( url, data, callback ) {
366 return jQuery.get(url, data, callback, "json");
370 * Load a remote page using an HTTP POST request.
372 * @example $.post("test.cgi");
374 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
376 * @example $.post("test.cgi", function(data){
377 * alert("Data Loaded: " + data);
380 * @example $.post("test.cgi",
381 * { name: "John", time: "2pm" },
383 * alert("Data Loaded: " + data);
388 * @type XMLHttpRequest
389 * @param String url The URL of the page to load.
390 * @param Map params (optional) Key/value pairs that will be sent to the server.
391 * @param Function callback (optional) A function to be executed whenever the data is loaded.
394 post: function( url, data, callback, type ) {
408 * Set the timeout of all AJAX requests to a specific amount of time.
409 * This will make all future AJAX requests timeout after a specified amount
412 * Set to null or 0 to disable timeouts (default).
414 * You can manually abort requests with the XMLHttpRequest's (returned by
415 * all ajax functions) abort() method.
417 * Deprecated. Use $.ajaxSetup instead.
419 * @example $.ajaxTimeout( 5000 );
420 * @desc Make all AJAX requests timeout after 5 seconds.
422 * @name $.ajaxTimeout
424 * @param Number time How long before an AJAX request times out.
427 ajaxTimeout: function(timeout) {
428 jQuery.ajaxSettings.timeout = timeout;
432 * Setup global settings for AJAX requests.
434 * See $.ajax for a description of all available options.
436 * @example $.ajaxSetup( {
441 * $.ajax({ data: myData });
442 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
443 * disables global handlers and uses POST instead of GET. The following
444 * AJAX requests then sends some data without having to set anything else.
448 * @param Map settings Key/value pairs to use for all AJAX requests
451 ajaxSetup: function(settings) {
452 jQuery.extend(jQuery.ajaxSettings, settings);
459 contentType: "application/x-www-form-urlencoded",
464 // Last-Modified header cache for next request
468 * Load a remote page using an HTTP request.
470 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
471 * higher-level abstractions.
473 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
474 * need that object to manipulate directly, but it is available if you need to
475 * abort the request manually.
477 * Note: Make sure the server sends the right mimetype (eg. xml as
478 * "text/xml"). Sending the wrong mimetype will get you into serious
479 * trouble that jQuery can't solve.
481 * Supported datatypes are (see dataType option):
483 * "xml": Returns a XML document that can be processed via jQuery.
485 * "html": Returns HTML as plain text, included script tags are evaluated.
487 * "script": Evaluates the response as Javascript and returns it as plain text.
489 * "json": Evaluates the response as JSON and returns a Javascript Object
491 * $.ajax() takes one argument, an object of key/value pairs, that are
492 * used to initalize and handle the request. These are all the key/values that can
495 * (String) url - The URL to request.
497 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
499 * (String) dataType - The type of data that you're expecting back from
500 * the server. No default: If the server sends xml, the responseXML, otherwise
501 * the responseText is passed to the success callback.
503 * (Boolean) ifModified - Allow the request to be successful only if the
504 * response has changed since the last request. This is done by checking the
505 * Last-Modified header. Default value is false, ignoring the header.
507 * (Number) timeout - Local timeout to override global timeout, eg. to give a
508 * single request a longer timeout while all others timeout after 1 second.
509 * See $.ajaxTimeout() for global timeouts.
511 * (Boolean) global - Whether to trigger global AJAX event handlers for
512 * this request, default is true. Set to false to prevent that global handlers
513 * like ajaxStart or ajaxStop are triggered.
515 * (Function) error - A function to be called if the request fails. The
516 * function gets passed tree arguments: The XMLHttpRequest object, a
517 * string describing the type of error that occurred and an optional
518 * exception object, if one occured.
520 * (Function) success - A function to be called if the request succeeds. The
521 * function gets passed one argument: The data returned from the server,
522 * formatted according to the 'dataType' parameter.
524 * (Function) complete - A function to be called when the request finishes. The
525 * function gets passed two arguments: The XMLHttpRequest object and a
526 * string describing the type of success of the request.
528 * (Object|String) data - Data to be sent to the server. Converted to a query
529 * string, if not already a string. Is appended to the url for GET-requests.
530 * See processData option to prevent this automatic processing.
532 * (String) contentType - When sending data to the server, use this content-type.
533 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
535 * (Boolean) processData - By default, data passed in to the data option as an object
536 * other as string will be processed and transformed into a query string, fitting to
537 * the default content-type "application/x-www-form-urlencoded". If you want to send
538 * DOMDocuments, set this option to false.
540 * (Boolean) async - By default, all requests are send asynchronous (set to true).
541 * If you need synchronous requests, set this option to false.
543 * (Function) beforeSend - A pre-callback to set custom headers etc., the
544 * XMLHttpRequest is passed as the only argument.
551 * @desc Load and execute a JavaScript file.
556 * data: "name=John&location=Boston",
557 * success: function(msg){
558 * alert( "Data Saved: " + msg );
561 * @desc Save some data to the server and notify the user once its complete.
563 * @example var html = $.ajax({
567 * @desc Loads data synchronously. Blocks the browser while the requests is active.
568 * It is better to block user interaction with others means when synchronization is
569 * necessary, instead to block the complete browser.
571 * @example var xmlDocument = [create xml document];
574 * processData: false,
576 * success: handleResponse
578 * @desc Sends an xml document as data to the server. By setting the processData
579 * option to false, the automatic conversion of data to strings is prevented.
582 * @type XMLHttpRequest
583 * @param Map properties Key/value pairs to initialize the request with.
585 * @see ajaxSetup(Map)
587 ajax: function( s ) {
588 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
589 s = jQuery.extend({}, jQuery.ajaxSettings, s);
593 // convert data if not already a string
594 if (s.processData && typeof s.data != 'string')
595 s.data = jQuery.param(s.data);
596 // append data to url for get requests
597 if( s.type.toLowerCase() == "get" )
598 // "?" + data or "&" + data (in case there are already params)
599 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
602 // Watch for a new set of requests
603 if ( s.global && ! jQuery.active++ )
604 jQuery.event.trigger( "ajaxStart" );
606 var requestDone = false;
608 // Create the request object
609 var xml = new XMLHttpRequest();
612 xml.open(s.type, s.url, s.async);
614 // Set the correct header, if data is being sent
616 xml.setRequestHeader("Content-Type", s.contentType);
618 // Set the If-Modified-Since header, if ifModified mode.
620 xml.setRequestHeader("If-Modified-Since",
621 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
623 // Set header so the called script knows that it's an XMLHttpRequest
624 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
626 // Make sure the browser sends the right content length
627 if ( xml.overrideMimeType )
628 xml.setRequestHeader("Connection", "close");
630 // Allow custom headers/mimetypes
634 jQuery.event.trigger("ajaxSend", [xml, s]);
636 // Wait for a response to come back
637 var onreadystatechange = function(isTimeout){
638 // The transfer is complete and the data is available, or the request timed out
639 if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
643 status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
644 s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
645 // Make sure that the request was successful or notmodified
646 if ( status != "error" ) {
647 // Cache Last-Modified header, if ifModified mode.
650 modRes = xml.getResponseHeader("Last-Modified");
651 } catch(e) {} // swallow exception thrown by FF if header is not available
653 if ( s.ifModified && modRes )
654 jQuery.lastModified[s.url] = modRes;
656 // process the data (runs the xml through httpData regardless of callback)
657 var data = jQuery.httpData( xml, s.dataType );
659 // If a local callback was specified, fire it and pass it the data
661 s.success( data, status );
663 // Fire the global callback
665 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
667 jQuery.handleError(s, xml, status);
671 jQuery.handleError(s, xml, status, e);
674 // The request was completed
676 jQuery.event.trigger( "ajaxComplete", [xml, s] );
678 // Handle the global AJAX counter
679 if ( s.global && ! --jQuery.active )
680 jQuery.event.trigger( "ajaxStop" );
683 if ( s.complete ) s.complete(xml, status);
686 xml.onreadystatechange = function(){};
690 xml.onreadystatechange = onreadystatechange;
694 setTimeout(function(){
695 // Check to see if the request is still happening
697 // Cancel the request
701 onreadystatechange( "timeout" );
705 // save non-leaking reference
712 jQuery.handleError(s, xml, null, e);
715 // firefox 1.5 doesn't fire statechange for sync requests
717 onreadystatechange();
719 // return XMLHttpRequest to allow aborting the request etc.
723 handleError: function(s, xml, status, e) {
724 // If a local callback was specified, fire it
725 if ( s.error ) s.error( xml, status, e );
727 // Fire the global callback
729 jQuery.event.trigger( "ajaxError", [xml, s, e] );
732 // Counter for holding the number of active queries
735 // Determines if an XMLHttpRequest was successful or not
736 httpSuccess: function(r) {
738 return !r.status && location.protocol == "file:" ||
739 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
740 jQuery.browser.safari && r.status == undefined;
745 // Determines if an XMLHttpRequest returns NotModified
746 httpNotModified: function(xml, url) {
748 var xmlRes = xml.getResponseHeader("Last-Modified");
750 // Firefox always returns 200. check Last-Modified date
751 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
752 jQuery.browser.safari && xml.status == undefined;
757 /* Get the data out of an XMLHttpRequest.
758 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
759 * otherwise return plain text.
760 * (String) data - The type of data that you're expecting back,
761 * (e.g. "xml", "html", "script")
763 httpData: function(r,type) {
764 var ct = r.getResponseHeader("content-type");
765 var data = !type && ct && ct.indexOf("xml") >= 0;
766 data = type == "xml" || data ? r.responseXML : r.responseText;
768 // If the type is "script", eval it in global context
769 if ( type == "script" ) {
770 jQuery.globalEval( data );
773 // Get the JavaScript object, if JSON is used.
774 if ( type == "json" ) eval( "data = " + data );
776 // evaluate scripts within html
777 if ( type == "html" ) jQuery("<div>").html(data).evalScripts();
782 // Serialize an array of form elements or a set of
783 // key/values into a query string
787 // If an array was passed in, assume that it is an array
789 if ( a.constructor == Array || a.jquery ) {
790 // Serialize the form elements
791 for ( var i = 0; i < a.length; i++ )
792 s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) );
794 // Otherwise, assume that it's an object of key/value pairs
796 // Serialize the key/values
798 // If the value is an array then the key names need to be repeated
799 if( a[j].constructor == Array ) {
800 for (var k = 0; k < a[j].length; k++) {
801 s.push( j + "=" + encodeURIComponent( a[j][k] ) );
804 s.push( j + "=" + encodeURIComponent( a[j] ) );
809 // Return the resulting serialization
813 // evalulates a script in global context
814 // not reliable for safari
815 globalEval: function(data) {
816 if (window.execScript)
817 window.execScript( data );
818 else if(jQuery.browser.safari)
819 // safari doesn't provide a synchronous global eval
820 window.setTimeout( data, 0 );
822 eval.call( window, data );