Make sure that the contents of the element is still in place when html(Function)...
[jquery.git] / src / ajax.js
1 (function( jQuery ) {
2
3 var jsc = jQuery.now(),
4         rscript = /<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,
5         rselectTextarea = /^(?:select|textarea)/i,
6         rinput = /^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,
7         rnoContent = /^(?:GET|HEAD|DELETE)$/,
8         rbracket = /\[\]$/,
9         jsre = /\=\?(&|$)/,
10         rquery = /\?/,
11         rts = /([?&])_=[^&]*/,
12         rurl = /^(\w+:)?\/\/([^\/?#]+)/,
13         r20 = /%20/g,
14         rhash = /#.*$/,
15
16         // Keep a copy of the old load method
17         _load = jQuery.fn.load;
18
19 jQuery.fn.extend({
20         load: function( url, params, callback ) {
21                 if ( typeof url !== "string" && _load ) {
22                         return _load.apply( this, arguments );
23
24                 // Don't do a request if no elements are being requested
25                 } else if ( !this.length ) {
26                         return this;
27                 }
28
29                 var off = url.indexOf(" ");
30                 if ( off >= 0 ) {
31                         var selector = url.slice(off, url.length);
32                         url = url.slice(0, off);
33                 }
34
35                 // Default to a GET request
36                 var type = "GET";
37
38                 // If the second parameter was provided
39                 if ( params ) {
40                         // If it's a function
41                         if ( jQuery.isFunction( params ) ) {
42                                 // We assume that it's the callback
43                                 callback = params;
44                                 params = null;
45
46                         // Otherwise, build a param string
47                         } else if ( typeof params === "object" ) {
48                                 params = jQuery.param( params, jQuery.ajaxSettings.traditional );
49                                 type = "POST";
50                         }
51                 }
52
53                 var self = this;
54
55                 // Request the remote document
56                 jQuery.ajax({
57                         url: url,
58                         type: type,
59                         dataType: "html",
60                         data: params,
61                         complete: function( res, status ) {
62                                 // If successful, inject the HTML into all the matched elements
63                                 if ( status === "success" || status === "notmodified" ) {
64                                         // See if a selector was specified
65                                         self.html( selector ?
66                                                 // Create a dummy div to hold the results
67                                                 jQuery("<div>")
68                                                         // inject the contents of the document in, removing the scripts
69                                                         // to avoid any 'Permission Denied' errors in IE
70                                                         .append(res.responseText.replace(rscript, ""))
71
72                                                         // Locate the specified elements
73                                                         .find(selector) :
74
75                                                 // If not, just inject the full result
76                                                 res.responseText );
77                                 }
78
79                                 if ( callback ) {
80                                         self.each( callback, [res.responseText, status, res] );
81                                 }
82                         }
83                 });
84
85                 return this;
86         },
87
88         serialize: function() {
89                 return jQuery.param(this.serializeArray());
90         },
91
92         serializeArray: function() {
93                 return this.map(function() {
94                         return this.elements ? jQuery.makeArray(this.elements) : this;
95                 })
96                 .filter(function() {
97                         return this.name && !this.disabled &&
98                                 (this.checked || rselectTextarea.test(this.nodeName) ||
99                                         rinput.test(this.type));
100                 })
101                 .map(function( i, elem ) {
102                         var val = jQuery(this).val();
103
104                         return val == null ?
105                                 null :
106                                 jQuery.isArray(val) ?
107                                         jQuery.map( val, function( val, i ) {
108                                                 return { name: elem.name, value: val };
109                                         }) :
110                                         { name: elem.name, value: val };
111                 }).get();
112         }
113 });
114
115 // Attach a bunch of functions for handling common AJAX events
116 jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), function( i, o ) {
117         jQuery.fn[o] = function( f ) {
118                 return this.bind(o, f);
119         };
120 });
121
122 jQuery.extend({
123         get: function( url, data, callback, type ) {
124                 // shift arguments if data argument was omited
125                 if ( jQuery.isFunction( data ) ) {
126                         type = type || callback;
127                         callback = data;
128                         data = null;
129                 }
130
131                 return jQuery.ajax({
132                         type: "GET",
133                         url: url,
134                         data: data,
135                         success: callback,
136                         dataType: type
137                 });
138         },
139
140         getScript: function( url, callback ) {
141                 return jQuery.get(url, null, callback, "script");
142         },
143
144         getJSON: function( url, data, callback ) {
145                 return jQuery.get(url, data, callback, "json");
146         },
147
148         post: function( url, data, callback, type ) {
149                 // shift arguments if data argument was omited
150                 if ( jQuery.isFunction( data ) ) {
151                         type = type || callback;
152                         callback = data;
153                         data = {};
154                 }
155
156                 return jQuery.ajax({
157                         type: "POST",
158                         url: url,
159                         data: data,
160                         success: callback,
161                         dataType: type
162                 });
163         },
164
165         ajaxSetup: function( settings ) {
166                 jQuery.extend( jQuery.ajaxSettings, settings );
167         },
168
169         ajaxSettings: {
170                 url: location.href,
171                 global: true,
172                 type: "GET",
173                 contentType: "application/x-www-form-urlencoded",
174                 processData: true,
175                 async: true,
176                 /*
177                 timeout: 0,
178                 data: null,
179                 username: null,
180                 password: null,
181                 traditional: false,
182                 */
183                 // Create the request object; Microsoft failed to properly
184                 // implement the XMLHttpRequest in IE7 (can't request local files),
185                 // so we use the ActiveXObject when it is available
186                 // This function can be overriden by calling jQuery.ajaxSetup
187                 xhr: window.XMLHttpRequest && (window.location.protocol !== "file:" || !window.ActiveXObject) ?
188                         function() {
189                                 return new window.XMLHttpRequest();
190                         } :
191                         function() {
192                                 try {
193                                         return new window.ActiveXObject("Microsoft.XMLHTTP");
194                                 } catch(e) {}
195                         },
196                 accepts: {
197                         xml: "application/xml, text/xml",
198                         html: "text/html",
199                         script: "text/javascript, application/javascript",
200                         json: "application/json, text/javascript",
201                         text: "text/plain",
202                         _default: "*/*"
203                 }
204         },
205
206         ajax: function( origSettings ) {
207                 var s = jQuery.extend(true, {}, jQuery.ajaxSettings, origSettings),
208                         jsonp, status, data, type = s.type.toUpperCase(), noContent = rnoContent.test(type);
209
210                 s.url = s.url.replace( rhash, "" );
211
212                 // Use original (not extended) context object if it was provided
213                 s.context = origSettings && origSettings.context != null ? origSettings.context : s;
214
215                 // convert data if not already a string
216                 if ( s.data && s.processData && typeof s.data !== "string" ) {
217                         s.data = jQuery.param( s.data, s.traditional );
218                 }
219
220                 // Handle JSONP Parameter Callbacks
221                 if ( s.dataType === "jsonp" ) {
222                         if ( type === "GET" ) {
223                                 if ( !jsre.test( s.url ) ) {
224                                         s.url += (rquery.test( s.url ) ? "&" : "?") + (s.jsonp || "callback") + "=?";
225                                 }
226                         } else if ( !s.data || !jsre.test(s.data) ) {
227                                 s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
228                         }
229                         s.dataType = "json";
230                 }
231
232                 // Build temporary JSONP function
233                 if ( s.dataType === "json" && (s.data && jsre.test(s.data) || jsre.test(s.url)) ) {
234                         jsonp = s.jsonpCallback || ("jsonp" + jsc++);
235
236                         // Replace the =? sequence both in the query string and the data
237                         if ( s.data ) {
238                                 s.data = (s.data + "").replace(jsre, "=" + jsonp + "$1");
239                         }
240
241                         s.url = s.url.replace(jsre, "=" + jsonp + "$1");
242
243                         // We need to make sure
244                         // that a JSONP style response is executed properly
245                         s.dataType = "script";
246
247                         // Handle JSONP-style loading
248                         var customJsonp = window[ jsonp ];
249
250                         window[ jsonp ] = function( tmp ) {
251                                 data = tmp;
252                                 jQuery.ajax.handleSuccess( s, xhr, status, data );
253                                 jQuery.ajax.handleComplete( s, xhr, status, data );
254                                 
255                                 if ( jQuery.isFunction( customJsonp ) ) {
256                                         customJsonp( tmp );
257
258                                 } else {
259                                         // Garbage collect
260                                         window[ jsonp ] = undefined;
261
262                                         try {
263                                                 delete window[ jsonp ];
264                                         } catch( jsonpError ) {}
265                                 }
266                                 
267                                 if ( head ) {
268                                         head.removeChild( script );
269                                 }
270                         };
271                 }
272
273                 if ( s.dataType === "script" && s.cache === null ) {
274                         s.cache = false;
275                 }
276
277                 if ( s.cache === false && type === "GET" ) {
278                         var ts = jQuery.now();
279
280                         // try replacing _= if it is there
281                         var ret = s.url.replace(rts, "$1_=" + ts);
282
283                         // if nothing was replaced, add timestamp to the end
284                         s.url = ret + ((ret === s.url) ? (rquery.test(s.url) ? "&" : "?") + "_=" + ts : "");
285                 }
286
287                 // If data is available, append data to url for get requests
288                 if ( s.data && type === "GET" ) {
289                         s.url += (rquery.test(s.url) ? "&" : "?") + s.data;
290                 }
291
292                 // Watch for a new set of requests
293                 if ( s.global && jQuery.ajax.active++ === 0 ) {
294                         jQuery.event.trigger( "ajaxStart" );
295                 }
296
297                 // Matches an absolute URL, and saves the domain
298                 var parts = rurl.exec( s.url ),
299                         remote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host);
300
301                 // If we're requesting a remote document
302                 // and trying to load JSON or Script with a GET
303                 if ( s.dataType === "script" && type === "GET" && remote ) {
304                         var head = document.getElementsByTagName("head")[0] || document.documentElement;
305                         var script = document.createElement("script");
306                         if ( s.scriptCharset ) {
307                                 script.charset = s.scriptCharset;
308                         }
309                         script.src = s.url;
310
311                         // Handle Script loading
312                         if ( !jsonp ) {
313                                 var done = false;
314
315                                 // Attach handlers for all browsers
316                                 script.onload = script.onreadystatechange = function() {
317                                         if ( !done && (!this.readyState ||
318                                                         this.readyState === "loaded" || this.readyState === "complete") ) {
319                                                 done = true;
320                                                 jQuery.ajax.handleSuccess( s, xhr, status, data );
321                                                 jQuery.ajax.handleComplete( s, xhr, status, data );
322
323                                                 // Handle memory leak in IE
324                                                 script.onload = script.onreadystatechange = null;
325                                                 if ( head && script.parentNode ) {
326                                                         head.removeChild( script );
327                                                 }
328                                         }
329                                 };
330                         }
331
332                         // Use insertBefore instead of appendChild  to circumvent an IE6 bug.
333                         // This arises when a base node is used (#2709 and #4378).
334                         head.insertBefore( script, head.firstChild );
335
336                         // We handle everything using the script element injection
337                         return undefined;
338                 }
339
340                 var requestDone = false;
341
342                 // Create the request object
343                 var xhr = s.xhr();
344
345                 if ( !xhr ) {
346                         return;
347                 }
348
349                 // Open the socket
350                 // Passing null username, generates a login popup on Opera (#2865)
351                 if ( s.username ) {
352                         xhr.open(type, s.url, s.async, s.username, s.password);
353                 } else {
354                         xhr.open(type, s.url, s.async);
355                 }
356
357                 // Need an extra try/catch for cross domain requests in Firefox 3
358                 try {
359                         // Set content-type if data specified and content-body is valid for this type
360                         if ( (s.data != null && !noContent) || (origSettings && origSettings.contentType) ) {
361                                 xhr.setRequestHeader("Content-Type", s.contentType);
362                         }
363
364                         // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
365                         if ( s.ifModified ) {
366                                 if ( jQuery.lastModified[s.url] ) {
367                                         xhr.setRequestHeader("If-Modified-Since", jQuery.lastModified[s.url]);
368                                 }
369
370                                 if ( jQuery.ajax.etag[s.url] ) {
371                                         xhr.setRequestHeader("If-None-Match", jQuery.ajax.etag[s.url]);
372                                 }
373                         }
374
375                         // Set header so the called script knows that it's an XMLHttpRequest
376                         // Only send the header if it's not a remote XHR
377                         if ( !remote ) {
378                                 xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
379                         }
380
381                         // Set the Accepts header for the server, depending on the dataType
382                         xhr.setRequestHeader("Accept", s.dataType && s.accepts[ s.dataType ] ?
383                                 s.accepts[ s.dataType ] + ", */*; q=0.01" :
384                                 s.accepts._default );
385                 } catch( headerError ) {}
386
387                 // Allow custom headers/mimetypes and early abort
388                 if ( s.beforeSend && s.beforeSend.call(s.context, xhr, s) === false ) {
389                         // Handle the global AJAX counter
390                         if ( s.global && jQuery.ajax.active-- === 1 ) {
391                                 jQuery.event.trigger( "ajaxStop" );
392                         }
393
394                         // close opended socket
395                         xhr.abort();
396                         return false;
397                 }
398
399                 if ( s.global ) {
400                         jQuery.ajax.triggerGlobal( s, "ajaxSend", [xhr, s] );
401                 }
402
403                 // Wait for a response to come back
404                 var onreadystatechange = xhr.onreadystatechange = function( isTimeout ) {
405                         // The request was aborted
406                         if ( !xhr || xhr.readyState === 0 || isTimeout === "abort" ) {
407                                 // Opera doesn't call onreadystatechange before this point
408                                 // so we simulate the call
409                                 if ( !requestDone ) {
410                                         jQuery.ajax.handleComplete( s, xhr, status, data );
411                                 }
412
413                                 requestDone = true;
414                                 if ( xhr ) {
415                                         xhr.onreadystatechange = jQuery.noop;
416                                 }
417
418                         // The transfer is complete and the data is available, or the request timed out
419                         } else if ( !requestDone && xhr && (xhr.readyState === 4 || isTimeout === "timeout") ) {
420                                 requestDone = true;
421                                 xhr.onreadystatechange = jQuery.noop;
422
423                                 status = isTimeout === "timeout" ?
424                                         "timeout" :
425                                         !jQuery.ajax.httpSuccess( xhr ) ?
426                                                 "error" :
427                                                 s.ifModified && jQuery.ajax.httpNotModified( xhr, s.url ) ?
428                                                         "notmodified" :
429                                                         "success";
430
431                                 var errMsg;
432
433                                 if ( status === "success" ) {
434                                         // Watch for, and catch, XML document parse errors
435                                         try {
436                                                 // process the data (runs the xml through httpData regardless of callback)
437                                                 data = jQuery.ajax.httpData( xhr, s.dataType, s );
438                                         } catch( parserError ) {
439                                                 status = "parsererror";
440                                                 errMsg = parserError;
441                                         }
442                                 }
443
444                                 // Make sure that the request was successful or notmodified
445                                 if ( status === "success" || status === "notmodified" ) {
446                                         // JSONP handles its own success callback
447                                         if ( !jsonp ) {
448                                                 jQuery.ajax.handleSuccess( s, xhr, status, data );
449                                         }
450                                 } else {
451                                         jQuery.ajax.handleError( s, xhr, status, errMsg );
452                                 }
453
454                                 // Fire the complete handlers
455                                 if ( !jsonp ) {
456                                         jQuery.ajax.handleComplete( s, xhr, status, data );
457                                 }
458
459                                 if ( isTimeout === "timeout" ) {
460                                         xhr.abort();
461                                 }
462
463                                 // Stop memory leaks
464                                 if ( s.async ) {
465                                         xhr = null;
466                                 }
467                         }
468                 };
469
470                 // Override the abort handler, if we can (IE doesn't allow it, but that's OK)
471                 // Opera doesn't fire onreadystatechange at all on abort
472                 try {
473                         var oldAbort = xhr.abort;
474                         xhr.abort = function() {
475                                 if ( xhr ) {
476                                         oldAbort.call( xhr );
477                                 }
478
479                                 onreadystatechange( "abort" );
480                         };
481                 } catch( abortError ) {}
482
483                 // Timeout checker
484                 if ( s.async && s.timeout > 0 ) {
485                         setTimeout(function() {
486                                 // Check to see if the request is still happening
487                                 if ( xhr && !requestDone ) {
488                                         onreadystatechange( "timeout" );
489                                 }
490                         }, s.timeout);
491                 }
492
493                 // Send the data
494                 try {
495                         xhr.send( noContent || s.data == null ? null : s.data );
496
497                 } catch( sendError ) {
498                         jQuery.ajax.handleError( s, xhr, null, sendError );
499
500                         // Fire the complete handlers
501                         jQuery.ajax.handleComplete( s, xhr, status, data );
502                 }
503
504                 // firefox 1.5 doesn't fire statechange for sync requests
505                 if ( !s.async ) {
506                         onreadystatechange();
507                 }
508
509                 // return XMLHttpRequest to allow aborting the request etc.
510                 return xhr;
511         },
512
513         // Serialize an array of form elements or a set of
514         // key/values into a query string
515         param: function( a, traditional ) {
516                 var s = [], add = function( key, value ) {
517                         // If value is a function, invoke it and return its value
518                         value = jQuery.isFunction(value) ? value() : value;
519                         s[ s.length ] = encodeURIComponent(key) + "=" + encodeURIComponent(value);
520                 };
521                 
522                 // Set traditional to true for jQuery <= 1.3.2 behavior.
523                 if ( traditional === undefined ) {
524                         traditional = jQuery.ajaxSettings.traditional;
525                 }
526                 
527                 // If an array was passed in, assume that it is an array of form elements.
528                 if ( jQuery.isArray(a) || a.jquery ) {
529                         // Serialize the form elements
530                         jQuery.each( a, function() {
531                                 add( this.name, this.value );
532                         });
533                         
534                 } else {
535                         // If traditional, encode the "old" way (the way 1.3.2 or older
536                         // did it), otherwise encode params recursively.
537                         for ( var prefix in a ) {
538                                 buildParams( prefix, a[prefix], traditional, add );
539                         }
540                 }
541
542                 // Return the resulting serialization
543                 return s.join("&").replace(r20, "+");
544         }
545 });
546
547 function buildParams( prefix, obj, traditional, add ) {
548         if ( jQuery.isArray(obj) && obj.length ) {
549                 // Serialize array item.
550                 jQuery.each( obj, function( i, v ) {
551                         if ( traditional || rbracket.test( prefix ) ) {
552                                 // Treat each array item as a scalar.
553                                 add( prefix, v );
554
555                         } else {
556                                 // If array item is non-scalar (array or object), encode its
557                                 // numeric index to resolve deserialization ambiguity issues.
558                                 // Note that rack (as of 1.0.0) can't currently deserialize
559                                 // nested arrays properly, and attempting to do so may cause
560                                 // a server error. Possible fixes are to modify rack's
561                                 // deserialization algorithm or to provide an option or flag
562                                 // to force array serialization to be shallow.
563                                 buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v, traditional, add );
564                         }
565                 });
566                         
567         } else if ( !traditional && obj != null && typeof obj === "object" ) {
568                 if ( jQuery.isEmptyObject( obj ) ) {
569                         add( prefix, "" );
570
571                 // Serialize object item.
572                 } else {
573                         jQuery.each( obj, function( k, v ) {
574                                 buildParams( prefix + "[" + k + "]", v, traditional, add );
575                         });
576                 }
577                                         
578         } else {
579                 // Serialize scalar item.
580                 add( prefix, obj );
581         }
582 }
583
584 jQuery.extend( jQuery.ajax, {
585
586         // Counter for holding the number of active queries
587         active: 0,
588
589         // Last-Modified header cache for next request
590         lastModified: {},
591         etag: {},
592
593         handleError: function( s, xhr, status, e ) {
594                 // If a local callback was specified, fire it
595                 if ( s.error ) {
596                         s.error.call( s.context, xhr, status, e );
597                 }
598
599                 // Fire the global callback
600                 if ( s.global ) {
601                         jQuery.ajax.triggerGlobal( s, "ajaxError", [xhr, s, e] );
602                 }
603         },
604
605         handleSuccess: function( s, xhr, status, data ) {
606                 // If a local callback was specified, fire it and pass it the data
607                 if ( s.success ) {
608                         s.success.call( s.context, data, status, xhr );
609                 }
610
611                 // Fire the global callback
612                 if ( s.global ) {
613                         jQuery.ajax.triggerGlobal( s, "ajaxSuccess", [xhr, s] );
614                 }
615         },
616
617         handleComplete: function( s, xhr, status ) {
618                 // Process result
619                 if ( s.complete ) {
620                         s.complete.call( s.context, xhr, status );
621                 }
622
623                 // The request was completed
624                 if ( s.global ) {
625                         jQuery.ajax.triggerGlobal( s, "ajaxComplete", [xhr, s] );
626                 }
627
628                 // Handle the global AJAX counter
629                 if ( s.global && jQuery.ajax.active-- === 1 ) {
630                         jQuery.event.trigger( "ajaxStop" );
631                 }
632         },
633                 
634         triggerGlobal: function( s, type, args ) {
635                 (s.context && s.context.url == null ? jQuery(s.context) : jQuery.event).trigger(type, args);
636         },
637
638         // Determines if an XMLHttpRequest was successful or not
639         httpSuccess: function( xhr ) {
640                 try {
641                         // IE error sometimes returns 1223 when it should be 204 so treat it as success, see #1450
642                         return !xhr.status && location.protocol === "file:" ||
643                                 xhr.status >= 200 && xhr.status < 300 ||
644                                 xhr.status === 304 || xhr.status === 1223;
645                 } catch(e) {}
646
647                 return false;
648         },
649
650         // Determines if an XMLHttpRequest returns NotModified
651         httpNotModified: function( xhr, url ) {
652                 var lastModified = xhr.getResponseHeader("Last-Modified"),
653                         etag = xhr.getResponseHeader("Etag");
654
655                 if ( lastModified ) {
656                         jQuery.ajax.lastModified[url] = lastModified;
657                 }
658
659                 if ( etag ) {
660                         jQuery.ajax.etag[url] = etag;
661                 }
662
663                 return xhr.status === 304;
664         },
665
666         httpData: function( xhr, type, s ) {
667                 var ct = xhr.getResponseHeader("content-type") || "",
668                         xml = type === "xml" || !type && ct.indexOf("xml") >= 0,
669                         data = xml ? xhr.responseXML : xhr.responseText;
670
671                 if ( xml && data.documentElement.nodeName === "parsererror" ) {
672                         jQuery.error( "parsererror" );
673                 }
674
675                 // Allow a pre-filtering function to sanitize the response
676                 // s is checked to keep backwards compatibility
677                 if ( s && s.dataFilter ) {
678                         data = s.dataFilter( data, type );
679                 }
680
681                 // The filter can actually parse the response
682                 if ( typeof data === "string" ) {
683                         // Get the JavaScript object, if JSON is used.
684                         if ( type === "json" || !type && ct.indexOf("json") >= 0 ) {
685                                 data = jQuery.parseJSON( data );
686
687                         // If the type is "script", eval it in global context
688                         } else if ( type === "script" || !type && ct.indexOf("javascript") >= 0 ) {
689                                 jQuery.globalEval( data );
690                         }
691                 }
692
693                 return data;
694         }
695
696 });
697
698 // Does this browser support XHR requests?
699 jQuery.support.ajax = !!jQuery.ajaxSettings.xhr();
700
701 // For backwards compatibility
702 jQuery.extend( jQuery.ajax );
703
704 })( jQuery );