Better fix for #407 issue
[jquery.git] / src / ajax / ajax.js
1 jQuery.fn.extend({
2
3         /**
4          * Load HTML from a remote file and inject it into the DOM, only if it's
5          * been modified by the server.
6          *
7          * @example $("#feeds").loadIfModified("feeds.html")
8          * @before <div id="feeds"></div>
9          * @result <div id="feeds"><b>45</b> feeds found.</div>
10          *
11          * @name loadIfModified
12          * @type jQuery
13          * @param String url The URL of the HTML file to load.
14          * @param Hash params A set of key/value pairs that will be sent to the server.
15          * @param Function callback A function to be executed whenever the data is loaded.
16          * @cat AJAX
17          */
18         loadIfModified: function( url, params, callback ) {
19                 this.load( url, params, callback, 1 );
20         },
21
22         /**
23          * Load HTML from a remote file and inject it into the DOM.
24          *
25          * @example $("#feeds").load("feeds.html")
26          * @before <div id="feeds"></div>
27          * @result <div id="feeds"><b>45</b> feeds found.</div>
28          *
29          * @example $("#feeds").load("feeds.html",
30          *   {test: true},
31          *   function() { alert("load is done"); }
32          * );
33          * @desc Same as above, but with an additional parameter
34          * and a callback that is executed when the data was loaded.
35          *
36          * @name load
37          * @type jQuery
38          * @param String url The URL of the HTML file to load.
39          * @param Object params A set of key/value pairs that will be sent as data to the server.
40          * @param Function callback A function to be executed whenever the data is loaded (parameters: responseText, status and reponse itself).
41          * @cat AJAX
42          */
43         load: function( url, params, callback, ifModified ) {
44                 if ( url.constructor == Function )
45                         return this.bind("load", url);
46
47                 callback = callback || function(){};
48
49                 // Default to a GET request
50                 var type = "GET";
51
52                 // If the second parameter was provided
53                 if ( params ) {
54                         // If it's a function
55                         if ( params.constructor == Function ) {
56                                 // We assume that it's the callback
57                                 callback = params;
58                                 params = null;
59
60                         // Otherwise, build a param string
61                         } else {
62                                 params = jQuery.param( params );
63                                 type = "POST";
64                         }
65                 }
66
67                 var self = this;
68
69                 // Request the remote document
70                 jQuery.ajax({
71                         url: url,
72                         type: type,
73                         data: params,
74                         ifModified: ifModified,
75                         complete: function(res, status){
76                                 if ( status == "success" || !ifModified && status == "notmodified" ) {
77                                         // Inject the HTML into all the matched elements
78                                         self.html(res.responseText)
79                                           // Execute all the scripts inside of the newly-injected HTML
80                                           .evalScripts()
81                                           // Execute callback
82                                           .each( callback, [res.responseText, status, res] );
83                                 } else
84                                         callback.apply( self, [res.responseText, status, res] );
85                         }
86                 });
87                 return this;
88         },
89
90         /**
91          * Serializes a set of input elements into a string of data.
92          * This will serialize all given elements. If you need
93          * serialization similar to the form submit of a browser,
94          * you should use the form plugin. This is also true for
95          * selects with multiple attribute set, only a single option
96          * is serialized.
97          *
98          * @example $("input[@type=text]").serialize();
99          * @before <input type='text' name='name' value='John'/>
100          * <input type='text' name='location' value='Boston'/>
101          * @after name=John&location=Boston
102          * @desc Serialize a selection of input elements to a string
103          *
104          * @name serialize
105          * @type String
106          * @cat AJAX
107          */
108         serialize: function() {
109                 return jQuery.param( this );
110         },
111
112         /**
113          * Evaluate all script tags inside this jQuery. If they have a src attribute,
114          * the script is loaded, otherwise it's content is evaluated.
115          *
116          * @name evalScripts
117          * @type jQuery
118          * @private
119          * @cat AJAX
120          */
121         evalScripts: function() {
122                 return this.find('script').each(function(){
123                         if ( this.src )
124                                 // for some weird reason, it doesn't work if the callback is ommited
125                                 jQuery.getScript( this.src );
126                         else {
127                                 // TODO extract into $.eval
128                                 var data = this.text || this.textContent || this.innerHTML || "";
129                                 if (window.execScript)
130                                         window.execScript( data );
131                                 else
132                                         window.setTimeout( data, 0 );
133                         }
134                 }).end();
135         }
136
137 });
138
139 // If IE is used, create a wrapper for the XMLHttpRequest object
140 if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
141         XMLHttpRequest = function(){
142                 return new ActiveXObject(
143                         navigator.userAgent.indexOf("MSIE 5") >= 0 ?
144                         "Microsoft.XMLHTTP" : "Msxml2.XMLHTTP"
145                 );
146         };
147
148 // Attach a bunch of functions for handling common AJAX events
149
150 /**
151  * Attach a function to be executed whenever an AJAX request begins.
152  *
153  * @example $("#loading").ajaxStart(function(){
154  *   $(this).show();
155  * });
156  * @desc Show a loading message whenever an AJAX request starts.
157  *
158  * @name ajaxStart
159  * @type jQuery
160  * @param Function callback The function to execute.
161  * @cat AJAX
162  */
163
164 /**
165  * Attach a function to be executed whenever all AJAX requests have ended.
166  *
167  * @example $("#loading").ajaxStop(function(){
168  *   $(this).hide();
169  * });
170  * @desc Hide a loading message after all the AJAX requests have stopped.
171  *
172  * @name ajaxStop
173  * @type jQuery
174  * @param Function callback The function to execute.
175  * @cat AJAX
176  */
177
178 /**
179  * Attach a function to be executed whenever an AJAX request completes.
180  *
181  * @example $("#msg").ajaxComplete(function(){
182  *   $(this).append("<li>Request Complete.</li>");
183  * });
184  * @desc Show a message when an AJAX request completes.
185  *
186  * @name ajaxComplete
187  * @type jQuery
188  * @param Function callback The function to execute.
189  * @cat AJAX
190  */
191
192 /**
193  * Attach a function to be executed whenever an AJAX request completes
194  * successfully.
195  *
196  * @example $("#msg").ajaxSuccess(function(){
197  *   $(this).append("<li>Successful Request!</li>");
198  * });
199  * @desc Show a message when an AJAX request completes successfully.
200  *
201  * @name ajaxSuccess
202  * @type jQuery
203  * @param Function callback The function to execute.
204  * @cat AJAX
205  */
206
207 /**
208  * Attach a function to be executed whenever an AJAX request fails.
209  *
210  * @example $("#msg").ajaxError(function(){
211  *   $(this).append("<li>Error requesting page.</li>");
212  * });
213  * @desc Show a message when an AJAX request fails.
214  *
215  * @name ajaxError
216  * @type jQuery
217  * @param Function callback The function to execute.
218  * @cat AJAX
219  */
220
221 new function(){
222         var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess".split(",");
223
224         for ( var i = 0; i < e.length; i++ ) new function(){
225                 var o = e[i];
226                 jQuery.fn[o] = function(f){
227                         return this.bind(o, f);
228                 };
229         };
230 };
231
232 jQuery.extend({
233
234         /**
235          * Load a remote page using an HTTP GET request. All of the arguments to
236          * the method (except URL) are optional.
237          *
238          * @example $.get("test.cgi")
239          *
240          * @example $.get("test.cgi", { name: "John", time: "2pm" } )
241          *
242          * @example $.get("test.cgi", function(data){
243          *   alert("Data Loaded: " + data);
244          * })
245          *
246          * @example $.get("test.cgi",
247          *   { name: "John", time: "2pm" },
248          *   function(data){
249          *     alert("Data Loaded: " + data);
250          *   }
251          * )
252          *
253          * @name $.get
254          * @type undefined
255          * @param String url The URL of the page to load.
256          * @param Hash params A set of key/value pairs that will be sent to the server.
257          * @param Function callback A function to be executed whenever the data is loaded.
258          * @cat AJAX
259          */
260         get: function( url, data, callback, type, ifModified ) {
261                 // shift arguments if data argument was ommited
262                 if ( data && data.constructor == Function ) {
263                         callback = data;
264                         data = null;
265                 }
266
267                 // Delegate
268                 jQuery.ajax({
269                         url: url,
270                         data: data,
271                         success: callback,
272                         dataType: type,
273                         ifModified: ifModified
274                 });
275         },
276
277         /**
278          * Load a remote page using an HTTP GET request, only if it hasn't
279          * been modified since it was last retrieved. All of the arguments to
280          * the method (except URL) are optional.
281          *
282          * @example $.getIfModified("test.html")
283          *
284          * @example $.getIfModified("test.html", { name: "John", time: "2pm" } )
285          *
286          * @example $.getIfModified("test.cgi", function(data){
287          *   alert("Data Loaded: " + data);
288          * })
289          *
290          * @example $.getifModified("test.cgi",
291          *   { name: "John", time: "2pm" },
292          *   function(data){
293          *     alert("Data Loaded: " + data);
294          *   }
295          * )
296          *
297          * @name $.getIfModified
298          * @type undefined
299          * @param String url The URL of the page to load.
300          * @param Hash params A set of key/value pairs that will be sent to the server.
301          * @param Function callback A function to be executed whenever the data is loaded.
302          * @cat AJAX
303          */
304         getIfModified: function( url, data, callback, type ) {
305                 jQuery.get(url, data, callback, type, 1);
306         },
307
308         /**
309          * Loads, and executes, a remote JavaScript file using an HTTP GET request.
310          * All of the arguments to the method (except URL) are optional.
311          *
312          * @example $.getScript("test.js")
313          *
314          * @example $.getScript("test.js", function(){
315          *   alert("Script loaded and executed.");
316          * })
317          *
318          * @name $.getScript
319          * @type undefined
320          * @param String url The URL of the page to load.
321          * @param Function callback A function to be executed whenever the data is loaded.
322          * @cat AJAX
323          */
324         getScript: function( url, callback ) {
325                 if(callback)
326                         jQuery.get(url, null, callback, "script");
327                 else {
328                         jQuery.get(url, null, null, "script");
329                 }
330         },
331
332         /**
333          * Load a remote JSON object using an HTTP GET request.
334          * All of the arguments to the method (except URL) are optional.
335          *
336          * @example $.getJSON("test.js", function(json){
337          *   alert("JSON Data: " + json.users[3].name);
338          * })
339          *
340          * @example $.getJSON("test.js",
341          *   { name: "John", time: "2pm" },
342          *   function(json){
343          *     alert("JSON Data: " + json.users[3].name);
344          *   }
345          * )
346          *
347          * @name $.getJSON
348          * @type undefined
349          * @param String url The URL of the page to load.
350          * @param Hash params A set of key/value pairs that will be sent to the server.
351          * @param Function callback A function to be executed whenever the data is loaded.
352          * @cat AJAX
353          */
354         getJSON: function( url, data, callback ) {
355                 jQuery.get(url, data, callback, "json");
356         },
357
358         /**
359          * Load a remote page using an HTTP POST request. All of the arguments to
360          * the method (except URL) are optional.
361          *
362          * @example $.post("test.cgi")
363          *
364          * @example $.post("test.cgi", { name: "John", time: "2pm" } )
365          *
366          * @example $.post("test.cgi", function(data){
367          *   alert("Data Loaded: " + data);
368          * })
369          *
370          * @example $.post("test.cgi",
371          *   { name: "John", time: "2pm" },
372          *   function(data){
373          *     alert("Data Loaded: " + data);
374          *   }
375          * )
376          *
377          * @name $.post
378          * @type undefined
379          * @param String url The URL of the page to load.
380          * @param Hash params A set of key/value pairs that will be sent to the server.
381          * @param Function callback A function to be executed whenever the data is loaded.
382          * @cat AJAX
383          */
384         post: function( url, data, callback, type ) {
385                 // Delegate
386                 jQuery.ajax({
387                         type: "POST",
388                         url: url,
389                         data: data,
390                         success: callback,
391                         dataType: type
392                 });
393         },
394
395         // timeout (ms)
396         timeout: 0,
397
398         /**
399          * Set the timeout of all AJAX requests to a specific amount of time.
400          * This will make all future AJAX requests timeout after a specified amount
401          * of time (the default is no timeout).
402          *
403          * @example $.ajaxTimeout( 5000 );
404          * @desc Make all AJAX requests timeout after 5 seconds.
405          *
406          * @name $.ajaxTimeout
407          * @type undefined
408          * @param Number time How long before an AJAX request times out.
409          * @cat AJAX
410          */
411         ajaxTimeout: function(timeout) {
412                 jQuery.timeout = timeout;
413         },
414
415         // Last-Modified header cache for next request
416         lastModified: {},
417
418         /**
419          * Load a remote page using an HTTP request. This function is the primary
420          * means of making AJAX requests using jQuery. 
421          *
422          * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
423          * need that object to manipulate directly, but it is available if you need to
424          * abort the request manually.
425          *
426          * Please note: Make sure the server sends the right mimetype (eg. xml as
427          * "text/xml"). Sending the wrong mimetype will get you into serious
428          * trouble that jQuery can't solve.
429          *
430          * Supported datatypes (see dataType option) are:
431          *
432          * "xml": Returns a XML document that can be processed via jQuery.
433          *
434          * "html": Returns HTML as plain text, included script tags are evaluated.
435          *
436          * "script": Evaluates the response as Javascript and returns it as plain text.
437          *
438          * "json": Evaluates the response as JSON and returns a Javascript Object
439          *
440          * $.ajax() takes one property, an object of key/value pairs, that are
441          * used to initalize the request. These are all the key/values that can
442          * be passed in to 'prop':
443          *
444          * (String) url - The URL of the page to request.
445          *
446          * (String) type - The type of request to make (e.g. "POST" or "GET"), default is "GET".
447          *
448          * (String) dataType - The type of data that you're expecting back from
449          * the server. No default: If the server sends xml, the responseXML, otherwise
450          * the responseText is is passed to the success callback.
451          *
452          * (Boolean) ifModified - Allow the request to be successful only if the
453          * response has changed since the last request, default is false, ignoring
454          * the Last-Modified header
455          *
456          * (Number) timeout - Local timeout to override global timeout, eg. to give a
457          * single request a longer timeout while all others timeout after 1 seconds,
458          * see $.ajaxTimeout()
459          *
460          * (Boolean) global - Wheather to trigger global AJAX event handlers for
461          * this request, default is true. Set to false to prevent that global handlers
462          * like ajaxStart or ajaxStop are triggered.
463          *
464          * (Function) error - A function to be called if the request fails. The
465          * function gets passed two arguments: The XMLHttpRequest object and a
466          * string describing the type of error that occurred.
467          *
468          * (Function) success - A function to be called if the request succeeds. The
469          * function gets passed one argument: The data returned from the server,
470          * formatted according to the 'dataType' parameter.
471          *
472          * (Function) complete - A function to be called when the request finishes. The
473          * function gets passed two arguments: The XMLHttpRequest object and a
474          * string describing the type the success of the request.
475          *
476          * (String) data - Data to be sent to the server. Converted to a query
477          * string, if not already a string. Is appended to the url for GET-requests.
478          * Override processData option to prevent processing.
479          *
480          * (String) contentType - When sending data to the server, use this content-type,
481          * default is "application/x-www-form-urlencoded", which is fine for most cases.
482          *
483          * (Boolean) processData - By default, data passed in as an object other as string
484          * will be processed and transformed into a query string, fitting to the default
485          * content-type "application/x-www-form-urlencoded". If you want to send DOMDocuments,
486          * set this option to false.
487          *
488          * (Boolean) async - By default, all requests are send asynchronous (set to true).
489          * If you need synchronous requests, set this option to false.
490          *
491          * @example $.ajax({
492          *   type: "GET",
493          *   url: "test.js",
494          *   dataType: "script"
495          * })
496          * @desc Load and execute a JavaScript file.
497          *
498          * @example $.ajax({
499          *   type: "POST",
500          *   url: "some.php",
501          *   data: "name=John&location=Boston",
502          *   success: function(msg){
503          *     alert( "Data Saved: " + msg );
504          *   }
505          * });
506          * @desc Save some data to the server and notify the user once its complete.
507          *
508          * @name $.ajax
509          * @type XMLHttpRequest
510          * @param Hash prop A set of properties to initialize the request with.
511          * @cat AJAX
512          */
513         ajax: function( s ) {
514                 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
515                 s = jQuery.extend({
516                         global: true,
517                         ifModified: false,
518                         type: "GET",
519                         timeout: jQuery.timeout,
520                         complete: null,
521                         success: null,
522                         error: null,
523                         dataType: null,
524                         url: null,
525                         data: null,
526                         contentType: "application/x-www-form-urlencoded",
527                         processData: true,
528                         async: true
529                 }, s);
530
531                 // if data available
532                 if ( s.data ) {
533                         // convert data if not already a string
534                         if (s.processData && typeof s.data != 'string')
535                         s.data = jQuery.param(s.data);
536                         // append data to url for get requests
537                         if( s.type.toLowerCase() == "get" )
538                                 // "?" + data or "&" + data (in case there are already params)
539                                 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
540                 }
541
542                 // Watch for a new set of requests
543                 if ( s.global && ! jQuery.active++ )
544                         jQuery.event.trigger( "ajaxStart" );
545
546                 var requestDone = false;
547
548                 // Create the request object
549                 var xml = new XMLHttpRequest();
550
551                 // Open the socket
552                 xml.open(s.type, s.url, s.async);
553
554                 // Set the correct header, if data is being sent
555                 if ( s.data )
556                         xml.setRequestHeader("Content-Type", s.contentType);
557
558                 // Set the If-Modified-Since header, if ifModified mode.
559                 if ( s.ifModified )
560                         xml.setRequestHeader("If-Modified-Since",
561                                 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
562
563                 // Set header so the called script knows that it's an XMLHttpRequest
564                 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
565
566                 // Make sure the browser sends the right content length
567                 if ( xml.overrideMimeType )
568                         xml.setRequestHeader("Connection", "close");
569
570                 // Wait for a response to come back
571                 var onreadystatechange = function(isTimeout){
572                         // The transfer is complete and the data is available, or the request timed out
573                         if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
574                                 requestDone = true;
575
576                                 var status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
577                                         s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
578
579                                 // Make sure that the request was successful or notmodified
580                                 if ( status != "error" ) {
581                                         // Cache Last-Modified header, if ifModified mode.
582                                         var modRes;
583                                         try {
584                                                 modRes = xml.getResponseHeader("Last-Modified");
585                                         } catch(e) {} // swallow exception thrown by FF if header is not available
586
587                                         if ( s.ifModified && modRes )
588                                                 jQuery.lastModified[s.url] = modRes;
589
590                                         // process the data (runs the xml through httpData regardless of callback)
591                                         var data = jQuery.httpData( xml, s.dataType );
592
593                                         // If a local callback was specified, fire it and pass it the data
594                                         if ( s.success )
595                                                 s.success( data, status );
596
597                                         // Fire the global callback
598                                         if( s.global )
599                                                 jQuery.event.trigger( "ajaxSuccess" );
600
601                                 // Otherwise, the request was not successful
602                                 } else {
603                                         // If a local callback was specified, fire it
604                                         if ( s.error ) s.error( xml, status );
605
606                                         // Fire the global callback
607                                         if( s.global )
608                                                 jQuery.event.trigger( "ajaxError" );
609                                 }
610
611                                 // The request was completed
612                                 if( s.global )
613                                         jQuery.event.trigger( "ajaxComplete" );
614
615                                 // Handle the global AJAX counter
616                                 if ( s.global && ! --jQuery.active )
617                                         jQuery.event.trigger( "ajaxStop" );
618
619                                 // Process result
620                                 if ( s.complete ) s.complete(xml, status);
621
622                                 // Stop memory leaks
623                                 xml.onreadystatechange = function(){};
624                                 xml = null;
625
626                         }
627                 };
628                 xml.onreadystatechange = onreadystatechange;
629
630                 // Timeout checker
631                 if(s.timeout > 0)
632                         setTimeout(function(){
633                                 // Check to see if the request is still happening
634                                 if (xml) {
635                                         // Cancel the request
636                                         xml.abort();
637
638                                         if ( !requestDone ) onreadystatechange( "timeout" );
639
640                                         // Clear from memory
641                                         xml = null;
642                                 }
643                         }, s.timeout);
644
645                 // Send the data
646                 xml.send(s.data);
647                 
648                 // return XMLHttpRequest to allow aborting the request etc.
649                 return xml;
650         },
651
652         // Counter for holding the number of active queries
653         active: 0,
654
655         // Determines if an XMLHttpRequest was successful or not
656         httpSuccess: function(r) {
657                 try {
658                         return !r.status && location.protocol == "file:" ||
659                                 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
660                                 jQuery.browser.safari && r.status == undefined;
661                 } catch(e){}
662
663                 return false;
664         },
665
666         // Determines if an XMLHttpRequest returns NotModified
667         httpNotModified: function(xml, url) {
668                 try {
669                         var xmlRes = xml.getResponseHeader("Last-Modified");
670
671                         // Firefox always returns 200. check Last-Modified date
672                         return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
673                                 jQuery.browser.safari && xml.status == undefined;
674                 } catch(e){}
675
676                 return false;
677         },
678
679         /* Get the data out of an XMLHttpRequest.
680          * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
681          * otherwise return plain text.
682          * (String) data - The type of data that you're expecting back,
683          * (e.g. "xml", "html", "script")
684          */
685         httpData: function(r,type) {
686                 var ct = r.getResponseHeader("content-type");
687                 var data = !type && ct && ct.indexOf("xml") >= 0;
688                 data = type == "xml" || data ? r.responseXML : r.responseText;
689
690                 // If the type is "script", eval it´in global context
691                 // TODO extract as $.eval
692                 if ( type == "script" ) {
693                         if (window.execScript)
694                                 window.execScript( data );
695                         else
696                                 window.setTimeout( data, 0 );
697                 }
698
699                 // Get the JavaScript object, if JSON is used.
700                 if ( type == "json" ) eval( "data = " + data );
701
702                 // evaluate scripts within html
703                 if ( type == "html" ) jQuery("<div>").html(data).evalScripts();
704
705                 return data;
706         },
707
708         // Serialize an array of form elements or a set of
709         // key/values into a query string
710         param: function(a) {
711                 var s = [];
712
713                 // If an array was passed in, assume that it is an array
714                 // of form elements
715                 if ( a.constructor == Array || a.jquery ) {
716                         // Serialize the form elements
717                         for ( var i = 0; i < a.length; i++ )
718                                 s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) );
719
720                 // Otherwise, assume that it's an object of key/value pairs
721                 } else {
722                         // Serialize the key/values
723                         for ( var j in a ) {
724                                 //if one value is array then treat each array value in part
725                                 if (typeof a[j] == 'object') {
726                                         for (var k = 0; k < a[j].length; k++) {
727                                                 s.push( j + "[]=" + encodeURIComponent( a[j][k] ) );
728                                         }
729                                 } else {
730                                         s.push( j + "=" + encodeURIComponent( a[j] ) );
731                                 }
732                         }
733                 }
734
735                 // Return the resulting serialization
736                 return s.join("&");
737         }
738
739 });