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 Hash params (optional) A set of 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.
27 * @example $("#feeds").load("feeds.html");
28 * @before <div id="feeds"></div>
29 * @result <div id="feeds"><b>45</b> feeds found.</div>
31 * @example $("#feeds").load("feeds.html",
33 * function() { alert("The last 25 entries in the feed have been loaded"); }
35 * @desc Same as above, but with an additional parameter
36 * and a callback that is executed when the data was loaded.
40 * @param String url The URL of the HTML file to load.
41 * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
42 * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
45 load: function( url, params, callback, ifModified ) {
46 if ( url.constructor == Function )
47 return this.bind("load", url);
49 callback = callback || function(){};
51 // Default to a GET request
54 // If the second parameter was provided
57 if ( params.constructor == Function ) {
58 // We assume that it's the callback
62 // Otherwise, build a param string
64 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.html(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 form plugin. It also takes multiple-selects
98 * into account, while this method recognizes only a single option.
100 * @example $("input[@type=text]").serialize();
101 * @before <input type='text' name='name' value='John'/>
102 * <input type='text' name='location' value='Boston'/>
103 * @after name=John&location=Boston
104 * @desc Serialize a selection of input elements to a string
110 serialize: function() {
111 return jQuery.param( this );
115 * Evaluate all script tags inside this jQuery. If they have a src attribute,
116 * the script is loaded, otherwise it's content is evaluated.
123 evalScripts: function() {
124 return this.find('script').each(function(){
126 jQuery.getScript( this.src );
128 jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
135 // If IE is used, create a wrapper for the XMLHttpRequest object
136 if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
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 send.
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 send.
239 * @param Function callback The function to execute.
244 var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(",");
246 for ( var i = 0; i < e.length; i++ ) new function(){
248 jQuery.fn[o] = function(f){
249 return this.bind(o, f);
257 * Load a remote page using an HTTP GET request.
259 * @example $.get("test.cgi");
261 * @example $.get("test.cgi", { name: "John", time: "2pm" } );
263 * @example $.get("test.cgi", function(data){
264 * alert("Data Loaded: " + data);
267 * @example $.get("test.cgi",
268 * { name: "John", time: "2pm" },
270 * alert("Data Loaded: " + data);
275 * @type XMLHttpRequest
276 * @param String url The URL of the page to load.
277 * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
278 * @param Function callback (optional) A function to be executed whenever the data is loaded.
281 get: function( url, data, callback, type, ifModified ) {
282 // shift arguments if data argument was ommited
283 if ( data && data.constructor == Function ) {
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 Hash params (optional) A set of 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.
322 getIfModified: function( url, data, callback, type ) {
323 return jQuery.get(url, data, callback, type, 1);
327 * Loads, and executes, a remote JavaScript file using an HTTP GET request.
329 * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
330 * context synchronously. If you load functions via getScript, make sure
331 * to call them after a delay.
333 * @example $.getScript("test.js");
335 * @example $.getScript("test.js", function(){
336 * alert("Script loaded and executed.");
340 * @type XMLHttpRequest
341 * @param String url The URL of the page to load.
342 * @param Function callback (optional) A function to be executed whenever the data is loaded.
345 getScript: function( url, callback ) {
346 return jQuery.get(url, null, callback, "script");
350 * Load JSON data using an HTTP GET request.
352 * @example $.getJSON("test.js", function(json){
353 * alert("JSON Data: " + json.users[3].name);
356 * @example $.getJSON("test.js",
357 * { name: "John", time: "2pm" },
359 * alert("JSON Data: " + json.users[3].name);
364 * @type XMLHttpRequest
365 * @param String url The URL of the page to load.
366 * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
367 * @param Function callback A function to be executed whenever the data is loaded.
370 getJSON: function( url, data, callback ) {
371 return jQuery.get(url, data, callback, "json");
375 * Load a remote page using an HTTP POST request.
377 * @example $.post("test.cgi");
379 * @example $.post("test.cgi", { name: "John", time: "2pm" } );
381 * @example $.post("test.cgi", function(data){
382 * alert("Data Loaded: " + data);
385 * @example $.post("test.cgi",
386 * { name: "John", time: "2pm" },
388 * alert("Data Loaded: " + data);
393 * @type XMLHttpRequest
394 * @param String url The URL of the page to load.
395 * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
396 * @param Function callback (optional) A function to be executed whenever the data is loaded.
399 post: function( url, data, callback, type ) {
413 * Set the timeout of all AJAX requests to a specific amount of time.
414 * This will make all future AJAX requests timeout after a specified amount
417 * Set to null or 0 to disable timeouts (default).
419 * You can manually abort requests with the XMLHttpRequest's (returned by
420 * all ajax functions) abort() method.
422 * Deprecated. Use $.ajaxSetup instead.
424 * @example $.ajaxTimeout( 5000 );
425 * @desc Make all AJAX requests timeout after 5 seconds.
427 * @name $.ajaxTimeout
429 * @param Number time How long before an AJAX request times out.
432 ajaxTimeout: function(timeout) {
433 jQuery.ajaxSettings.timeout = timeout;
437 * Setup global settings for AJAX requests.
439 * See $.ajax for a description of all available options.
441 * @example $.ajaxSetup( {
446 * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
447 * disables global handlers and uses POST instead of GET
451 * @param Object settings Key/value pairs for ajax options
454 ajaxSetup: function(settings) {
455 jQuery.extend(jQuery.ajaxSettings, settings);
462 contentType: "application/x-www-form-urlencoded",
467 // Last-Modified header cache for next request
471 * Load a remote page using an HTTP request.
473 * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
474 * higher-level abstractions.
476 * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
477 * need that object to manipulate directly, but it is available if you need to
478 * abort the request manually.
480 * Note: Make sure the server sends the right mimetype (eg. xml as
481 * "text/xml"). Sending the wrong mimetype will get you into serious
482 * trouble that jQuery can't solve.
484 * Supported datatypes are (see dataType option):
486 * "xml": Returns a XML document that can be processed via jQuery.
488 * "html": Returns HTML as plain text, included script tags are evaluated.
490 * "script": Evaluates the response as Javascript and returns it as plain text.
492 * "json": Evaluates the response as JSON and returns a Javascript Object
494 * $.ajax() takes one argument, an object of key/value pairs, that are
495 * used to initalize and handle the request. These are all the key/values that can
498 * (String) url - The URL to request.
500 * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
502 * (String) dataType - The type of data that you're expecting back from
503 * the server. No default: If the server sends xml, the responseXML, otherwise
504 * the responseText is passed to the success callback.
506 * (Boolean) ifModified - Allow the request to be successful only if the
507 * response has changed since the last request. This is done by checking the
508 * Last-Modified header. Default value is false, ignoring the header.
510 * (Number) timeout - Local timeout to override global timeout, eg. to give a
511 * single request a longer timeout while all others timeout after 1 second.
512 * See $.ajaxTimeout() for global timeouts.
514 * (Boolean) global - Whether to trigger global AJAX event handlers for
515 * this request, default is true. Set to false to prevent that global handlers
516 * like ajaxStart or ajaxStop are triggered.
518 * (Function) error - A function to be called if the request fails. The
519 * function gets passed tree arguments: The XMLHttpRequest object, a
520 * string describing the type of error that occurred and an optional
521 * exception object, if one occured.
523 * (Function) success - A function to be called if the request succeeds. The
524 * function gets passed one argument: The data returned from the server,
525 * formatted according to the 'dataType' parameter.
527 * (Function) complete - A function to be called when the request finishes. The
528 * function gets passed two arguments: The XMLHttpRequest object and a
529 * string describing the type of success of the request.
531 * (Object|String) data - Data to be sent to the server. Converted to a query
532 * string, if not already a string. Is appended to the url for GET-requests.
533 * See processData option to prevent this automatic processing.
535 * (String) contentType - When sending data to the server, use this content-type.
536 * Default is "application/x-www-form-urlencoded", which is fine for most cases.
538 * (Boolean) processData - By default, data passed in to the data option as an object
539 * other as string will be processed and transformed into a query string, fitting to
540 * the default content-type "application/x-www-form-urlencoded". If you want to send
541 * DOMDocuments, set this option to false.
543 * (Boolean) async - By default, all requests are send asynchronous (set to true).
544 * If you need synchronous requests, set this option to false.
546 * (Function) beforeSend - A pre-callback to set custom headers etc., the
547 * XMLHttpRequest is passed as the only argument.
554 * @desc Load and execute a JavaScript file.
559 * data: "name=John&location=Boston",
560 * success: function(msg){
561 * alert( "Data Saved: " + msg );
564 * @desc Save some data to the server and notify the user once its complete.
566 * @example var html = $.ajax({
570 * @desc Loads data synchronously. Blocks the browser while the requests is active.
571 * It is better to block user interaction with others means when synchronization is
572 * necessary, instead to block the complete browser.
574 * @example var xmlDocument = [create xml document];
577 * processData: false,
579 * success: handleResponse
581 * @desc Sends an xml document as data to the server. By setting the processData
582 * option to false, the automatic conversion of data to strings is prevented.
585 * @type XMLHttpRequest
586 * @param Hash prop A set of properties to initialize the request with.
589 ajax: function( s ) {
590 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
591 s = jQuery.extend({}, jQuery.ajaxSettings, s);
595 // convert data if not already a string
596 if (s.processData && typeof s.data != 'string')
597 s.data = jQuery.param(s.data);
598 // append data to url for get requests
599 if( s.type.toLowerCase() == "get" )
600 // "?" + data or "&" + data (in case there are already params)
601 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
604 // Watch for a new set of requests
605 if ( s.global && ! jQuery.active++ )
606 jQuery.event.trigger( "ajaxStart" );
608 var requestDone = false;
610 // Create the request object
611 var xml = new XMLHttpRequest();
614 xml.open(s.type, s.url, s.async);
616 // Set the correct header, if data is being sent
618 xml.setRequestHeader("Content-Type", s.contentType);
620 // Set the If-Modified-Since header, if ifModified mode.
622 xml.setRequestHeader("If-Modified-Since",
623 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
625 // Set header so the called script knows that it's an XMLHttpRequest
626 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
628 // Make sure the browser sends the right content length
629 if ( xml.overrideMimeType )
630 xml.setRequestHeader("Connection", "close");
632 // Allow custom headers/mimetypes
636 jQuery.event.trigger("ajaxSend", [xml, s]);
638 // Wait for a response to come back
639 var onreadystatechange = function(isTimeout){
640 // The transfer is complete and the data is available, or the request timed out
641 if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
645 status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
646 s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
647 // Make sure that the request was successful or notmodified
648 if ( status != "error" ) {
649 // Cache Last-Modified header, if ifModified mode.
652 modRes = xml.getResponseHeader("Last-Modified");
653 } catch(e) {} // swallow exception thrown by FF if header is not available
655 if ( s.ifModified && modRes )
656 jQuery.lastModified[s.url] = modRes;
658 // process the data (runs the xml through httpData regardless of callback)
659 var data = jQuery.httpData( xml, s.dataType );
661 // If a local callback was specified, fire it and pass it the data
663 s.success( data, status );
665 // Fire the global callback
667 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
669 jQuery.handleError(s, xml, status);
673 jQuery.handleError(s, xml, status, e);
676 // The request was completed
678 jQuery.event.trigger( "ajaxComplete", [xml, s] );
680 // Handle the global AJAX counter
681 if ( s.global && ! --jQuery.active )
682 jQuery.event.trigger( "ajaxStop" );
685 if ( s.complete ) s.complete(xml, status);
688 xml.onreadystatechange = function(){};
692 xml.onreadystatechange = onreadystatechange;
696 setTimeout(function(){
697 // Check to see if the request is still happening
699 // Cancel the request
703 onreadystatechange( "timeout" );
707 // save non-leaking reference
714 jQuery.handleError(s, xml, null, e);
717 // firefox 1.5 doesn't fire statechange for sync requests
719 onreadystatechange();
721 // return XMLHttpRequest to allow aborting the request etc.
725 handleError: function(s, xml, status, e) {
726 // If a local callback was specified, fire it
727 if ( s.error ) s.error( xml, status, e );
729 // Fire the global callback
731 jQuery.event.trigger( "ajaxError", [xml, s, e] );
734 // Counter for holding the number of active queries
737 // Determines if an XMLHttpRequest was successful or not
738 httpSuccess: function(r) {
740 return !r.status && location.protocol == "file:" ||
741 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
742 jQuery.browser.safari && r.status == undefined;
747 // Determines if an XMLHttpRequest returns NotModified
748 httpNotModified: function(xml, url) {
750 var xmlRes = xml.getResponseHeader("Last-Modified");
752 // Firefox always returns 200. check Last-Modified date
753 return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
754 jQuery.browser.safari && xml.status == undefined;
759 /* Get the data out of an XMLHttpRequest.
760 * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
761 * otherwise return plain text.
762 * (String) data - The type of data that you're expecting back,
763 * (e.g. "xml", "html", "script")
765 httpData: function(r,type) {
766 var ct = r.getResponseHeader("content-type");
767 var data = !type && ct && ct.indexOf("xml") >= 0;
768 data = type == "xml" || data ? r.responseXML : r.responseText;
770 // If the type is "script", eval it in global context
771 if ( type == "script" ) {
772 jQuery.globalEval( data );
775 // Get the JavaScript object, if JSON is used.
776 if ( type == "json" ) eval( "data = " + data );
778 // evaluate scripts within html
779 if ( type == "html" ) jQuery("<div>").html(data).evalScripts();
784 // Serialize an array of form elements or a set of
785 // key/values into a query string
789 // If an array was passed in, assume that it is an array
791 if ( a.constructor == Array || a.jquery ) {
792 // Serialize the form elements
793 for ( var i = 0; i < a.length; i++ )
794 s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) );
796 // Otherwise, assume that it's an object of key/value pairs
798 // Serialize the key/values
800 // If the value is an array then the key names need to be repeated
801 if( a[j].constructor == Array ) {
802 for (var k = 0; k < a[j].length; k++) {
803 s.push( j + "=" + encodeURIComponent( a[j][k] ) );
806 s.push( j + "=" + encodeURIComponent( a[j] ) );
811 // Return the resulting serialization
815 // evalulates a script in global context
816 // not reliable for safari
817 globalEval: function(data) {
818 if (window.execScript)
819 window.execScript( data );
820 else if(jQuery.browser.safari)
821 // safari doesn't provide a synchronous global eval
822 window.setTimeout( data, 0 );
824 eval.call( window, data );