Don't use for-in loops on Arrays. Fixes #7817. Thanks to dmethvin.
[jquery.git] / src / ajax.js
1 (function( jQuery ) {
2         
3 var rscript = /<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,
4         rselectTextarea = /^(?:select|textarea)/i,
5         rinput = /^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,
6         rbracket = /\[\]$/,
7         rquery = /\?/,
8         r20 = /%20/g,
9
10         // Keep a copy of the old load method
11         _load = jQuery.fn.load;
12
13 jQuery.fn.extend({
14         load: function( url, params, callback ) {
15                 if ( typeof url !== "string" && _load ) {
16                         return _load.apply( this, arguments );
17
18                 // Don't do a request if no elements are being requested
19                 } else if ( !this.length ) {
20                         return this;
21                 }
22
23                 var off = url.indexOf(" ");
24                 if ( off >= 0 ) {
25                         var selector = url.slice(off, url.length);
26                         url = url.slice(0, off);
27                 }
28
29                 // Default to a GET request
30                 var type = "GET";
31
32                 // If the second parameter was provided
33                 if ( params ) {
34                         // If it's a function
35                         if ( jQuery.isFunction( params ) ) {
36                                 // We assume that it's the callback
37                                 callback = params;
38                                 params = null;
39
40                         // Otherwise, build a param string
41                         } else if ( typeof params === "object" ) {
42                                 params = jQuery.param( params, jQuery.ajaxSettings.traditional );
43                                 type = "POST";
44                         }
45                 }
46                 
47                 var self = this;
48                 
49                 // Request the remote document
50                 jQuery.ajax({
51                         url: url,
52                         type: type,
53                         dataType: "html",
54                         data: params,
55                         complete: function( res, status ) {
56                                 // If successful, inject the HTML into all the matched elements
57                                 if ( status === "success" || status === "notmodified" ) {
58                                         // See if a selector was specified
59                                         self.html( selector ?
60                                                 // Create a dummy div to hold the results
61                                                 jQuery("<div>")
62                                                         // inject the contents of the document in, removing the scripts
63                                                         // to avoid any 'Permission Denied' errors in IE
64                                                         .append(res.responseText.replace(rscript, ""))
65
66                                                         // Locate the specified elements
67                                                         .find(selector) :
68
69                                                 // If not, just inject the full result
70                                                 res.responseText );
71                                 }
72
73                                 if ( callback ) {
74                                         self.each( callback, [res.responseText, status, res] );
75                                 }
76                         }
77                 });
78
79                 return this;
80         },
81
82         serialize: function() {
83                 return jQuery.param(this.serializeArray());
84         },
85
86         serializeArray: function() {
87                 return this.map(function(){
88                         return this.elements ? jQuery.makeArray(this.elements) : this;
89                 })
90                 .filter(function(){
91                         return this.name && !this.disabled &&
92                                 (this.checked || rselectTextarea.test(this.nodeName) ||
93                                         rinput.test(this.type));
94                 })
95                 .map(function(i, elem){
96                         var val = jQuery(this).val();
97
98                         return val == null ?
99                                 null :
100                                 jQuery.isArray(val) ?
101                                         jQuery.map( val, function(val, i){
102                                                 return {name: elem.name, value: val};
103                                         }) :
104                                         {name: elem.name, value: val};
105                 }).get();
106         }
107 });
108
109 // Attach a bunch of functions for handling common AJAX events
110 jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), function(i,o){
111         jQuery.fn[o] = function(f){
112                 return this.bind(o, f);
113         };
114 });
115
116 jQuery.extend({
117
118         get: function( url, data, callback, type ) {
119                 // shift arguments if data argument was omited
120                 if ( jQuery.isFunction( data ) ) {
121                         type = type || callback;
122                         callback = data;
123                         data = null;
124                 }
125
126                 return jQuery.ajax({
127                         type: "GET",
128                         url: url,
129                         data: data,
130                         success: callback,
131                         dataType: type
132                 });
133         },
134
135         getScript: function( url, callback ) {
136                 return jQuery.get(url, null, callback, "script");
137         },
138
139         getJSON: function( url, data, callback ) {
140                 return jQuery.get(url, data, callback, "json");
141         },
142
143         post: function( url, data, callback, type ) {
144                 // shift arguments if data argument was omited
145                 if ( jQuery.isFunction( data ) ) {
146                         type = type || callback;
147                         callback = data;
148                         data = {};
149                 }
150
151                 return jQuery.ajax({
152                         type: "POST",
153                         url: url,
154                         data: data,
155                         success: callback,
156                         dataType: type
157                 });
158         },
159
160         ajaxSetup: function( settings ) {
161                 jQuery.extend( jQuery.ajaxSettings, settings );
162         },
163
164         ajaxSettings: {
165                 url: location.href,
166                 global: true,
167                 type: "GET",
168                 contentType: "application/x-www-form-urlencoded",
169                 processData: true,
170                 async: true,
171                 /*
172                 timeout: 0,
173                 data: null,
174                 dataType: null,
175                 dataTypes: null,
176                 username: null,
177                 password: null,
178                 cache: null,
179                 traditional: false,
180                 */
181                 xhr: function() {
182                         return new window.XMLHttpRequest();
183                 },
184                 xhrResponseFields: {
185                         xml: "XML",
186                         text: "Text",
187                         json: "JSON"
188                 },
189                         
190                 accepts: {
191                         xml: "application/xml, text/xml",
192                         html: "text/html",
193                         text: "text/plain",
194                         json: "application/json, text/javascript",
195                         "*": "*/*"
196                 },
197                 
198                 autoDataType: {
199                         xml: /xml/,
200                         html: /html/,
201                         json: /json/
202                 },
203                 
204                 // Prefilters
205                 // 1) They are useful to introduce custom dataTypes (see transport/jsonp for an example)
206                 // 2) These are called:
207                 //    * BEFORE asking for a transport
208                 //    * AFTER param serialization (s.data is a string if s.processData is true)
209                 // 3) They MUST be order agnostic
210                 prefilters: [],
211                 
212                 // Transports bindings
213                 // 1) key is the dataType
214                 // 2) the catchall symbol "*" can be used
215                 // 3) selection will start with transport dataType and THEN go to "*" if needed
216                 transports: {
217                 },
218                 
219                 // Checkers
220                 // 1) key is dataType
221                 // 2) they are called to control successful response
222                 // 3) error throws is used as error data
223                 dataCheckers: {
224         
225                         // Check if data is a string
226                         "text": function(data) {
227                                 if ( typeof data != "string" ) {
228                                         jQuery.error("typeerror");
229                                 }
230                         },
231         
232                         // Check if xml has been properly parsed
233                         "xml": function(data) {
234                                 var documentElement = data ? data.documentElement : data;
235                                 if ( ! documentElement || ! documentElement.nodeName ) {
236                                         jQuery.error("typeerror");
237                                 }
238                                 if ( documentElement.nodeName == "parsererror" ) {
239                                         jQuery.error("parsererror");
240                                 }
241                         }
242                 },
243                 
244                 // List of data converters
245                 // 1) key format is "source_type => destination_type" (spaces required)
246                 // 2) the catchall symbol "*" can be used for source_type
247                 dataConverters: {
248                 
249                         // Convert anything to text
250                         "* => text": function(data) {
251                                 return "" + data;
252                         },
253                         
254                         // Text to html (no transformation)
255                         "text => html": function(data) {
256                                 return data;
257                         },
258                         
259                         // Evaluate text as a json expression
260                         "text => json": jQuery.parseJSON,
261                         
262                         // Parse text as xml
263                         "text => xml": function(data) {
264                                 var xml, parser;
265                                 if ( window.DOMParser ) { // Standard
266                                         parser = new DOMParser();
267                                         xml = parser.parseFromString(data,"text/xml");
268                                 } else { // IE
269                                         xml = new ActiveXObject("Microsoft.XMLDOM");
270                                         xml.async="false";
271                                         xml.loadXML(data);
272                                 }
273                                 return xml;
274                         }
275                 }
276         },
277
278         // Main method
279         ajax: function( url , s ) {
280                 
281                 if ( arguments.length === 1 ) {
282                         s = url;
283                         url = s ? s.url : undefined;
284                 }
285                 
286                 return jQuery.xhr().open( s ? s.type : undefined , url ).send( undefined , s );
287                 
288         },
289
290         // Serialize an array of form elements or a set of
291         // key/values into a query string
292         param: function( a, traditional ) {
293                 var s = [],
294                         add = function( key, value ) {
295                                 // If value is a function, invoke it and return its value
296                                 value = jQuery.isFunction(value) ? value() : value;
297                                 s[ s.length ] = encodeURIComponent(key) + "=" + encodeURIComponent(value);
298                         };
299                 
300                 // Set traditional to true for jQuery <= 1.3.2 behavior.
301                 if ( traditional === undefined ) {
302                         traditional = jQuery.ajaxSettings.traditional;
303                 }
304                 
305                 // If an array was passed in, assume that it is an array of form elements.
306                 if ( jQuery.isArray(a) || a.jquery ) {
307                         // Serialize the form elements
308                         jQuery.each( a, function() {
309                                 add( this.name, this.value );
310                         });
311                         
312                 } else {
313                         // If traditional, encode the "old" way (the way 1.3.2 or older
314                         // did it), otherwise encode params recursively.
315                         for ( var prefix in a ) {
316                                 buildParams( prefix, a[prefix], traditional, add );
317                         }
318                 }
319
320                 // Return the resulting serialization
321                 return s.join("&").replace(r20, "+");
322         }
323 });
324
325 function buildParams( prefix, obj, traditional, add ) {
326         if ( jQuery.isArray(obj) && obj.length ) {
327                 // Serialize array item.
328                 jQuery.each( obj, function( i, v ) {
329                         if ( traditional || rbracket.test( prefix ) ) {
330                                 // Treat each array item as a scalar.
331                                 add( prefix, v );
332
333                         } else {
334                                 // If array item is non-scalar (array or object), encode its
335                                 // numeric index to resolve deserialization ambiguity issues.
336                                 // Note that rack (as of 1.0.0) can't currently deserialize
337                                 // nested arrays properly, and attempting to do so may cause
338                                 // a server error. Possible fixes are to modify rack's
339                                 // deserialization algorithm or to provide an option or flag
340                                 // to force array serialization to be shallow.
341                                 buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v, traditional, add );
342                         }
343                 });
344                         
345         } else if ( !traditional && obj != null && typeof obj === "object" ) {
346                 if ( jQuery.isEmptyObject( obj ) ) {
347                         add( prefix, "" );
348
349                 // Serialize object item.
350                 } else {
351                         jQuery.each( obj, function( k, v ) {
352                                 buildParams( prefix + "[" + k + "]", v, traditional, add );
353                         });
354                 }
355                                         
356         } else {
357                 // Serialize scalar item.
358                 add( prefix, obj );
359         }
360 }
361
362 // This is still on the jQuery object... for now
363 // Want to move this to jQuery.ajax some day
364 jQuery.extend({
365
366         // Counter for holding the number of active queries
367         active: 0,
368
369         // Last-Modified header cache for next request
370         lastModified: {},
371         etag: {}
372
373 });
374
375 /*
376  * Create the request object; Microsoft failed to properly
377  * implement the XMLHttpRequest in IE7 (can't request local files),
378  * so we use the ActiveXObject when it is available
379  * Additionally XMLHttpRequest can be disabled in IE7/IE8 so
380  * we need a fallback.
381  */
382 if ( window.ActiveXObject ) {
383         jQuery.ajaxSettings.xhr = function() {
384         if ( window.location.protocol !== "file:" ) {
385                 try {
386                         return new window.XMLHttpRequest();
387                 } catch( xhrError ) {}
388         }
389         
390         try {
391                 return new window.ActiveXObject("Microsoft.XMLHTTP");
392         } catch( activeError ) {}
393         };
394 }
395
396 var testXHR = jQuery.ajaxSettings.xhr();
397
398 // Does this browser support XHR requests?
399 jQuery.support.ajax = !!testXHR;
400
401 // Does this browser support crossDomain XHR requests
402 jQuery.support.cors = testXHR && "withCredentials" in testXHR;
403
404 })( jQuery );