test runner: improved the shown message of 4 isFunction tests.
[jquery.git] / src / ajax.js
1 jQuery.fn.extend({
2         // Keep a copy of the old load
3         _load: jQuery.fn.load,
4
5         load: function( url, params, callback ) {
6                 if ( typeof url != 'string' )
7                         return this._load( url );
8
9                 var off = url.indexOf(" ");
10                 if ( off >= 0 ) {
11                         var selector = url.slice(off, url.length);
12                         url = url.slice(0, off);
13                 }
14
15                 callback = callback || function(){};
16
17                 // Default to a GET request
18                 var type = "GET";
19
20                 // If the second parameter was provided
21                 if ( params )
22                         // If it's a function
23                         if ( jQuery.isFunction( params ) ) {
24                                 // We assume that it's the callback
25                                 callback = params;
26                                 params = null;
27
28                         // Otherwise, build a param string
29                         } else {
30                                 params = jQuery.param( params );
31                                 type = "POST";
32                         }
33
34                 var self = this;
35
36                 // Request the remote document
37                 jQuery.ajax({
38                         url: url,
39                         type: type,
40                         dataType: "html",
41                         data: params,
42                         complete: function(res, status){
43                                 // If successful, inject the HTML into all the matched elements
44                                 if ( status == "success" || status == "notmodified" )
45                                         // See if a selector was specified
46                                         self.html( selector ?
47                                                 // Create a dummy div to hold the results
48                                                 jQuery("<div/>")
49                                                         // inject the contents of the document in, removing the scripts
50                                                         // to avoid any 'Permission Denied' errors in IE
51                                                         .append(res.responseText.replace(/<script(.|\s)*?\/script>/g, ""))
52
53                                                         // Locate the specified elements
54                                                         .find(selector) :
55
56                                                 // If not, just inject the full result
57                                                 res.responseText );
58
59                                 self.each( callback, [res.responseText, status, res] );
60                         }
61                 });
62                 return this;
63         },
64
65         serialize: function() {
66                 return jQuery.param(this.serializeArray());
67         },
68         serializeArray: function() {
69                 return this.map(function(){
70                         return jQuery.nodeName(this, "form") ?
71                                 jQuery.makeArray(this.elements) : this;
72                 })
73                 .filter(function(){
74                         return this.name && !this.disabled &&
75                                 (this.checked || /select|textarea/i.test(this.nodeName) ||
76                                         /text|hidden|password/i.test(this.type));
77                 })
78                 .map(function(i, elem){
79                         var val = jQuery(this).val();
80                         return val == null ? null :
81                                 val.constructor == Array ?
82                                         jQuery.map( val, function(val, i){
83                                                 return {name: elem.name, value: val};
84                                         }) :
85                                         {name: elem.name, value: val};
86                 }).get();
87         }
88 });
89
90 // Attach a bunch of functions for handling common AJAX events
91 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
92         jQuery.fn[o] = function(f){
93                 return this.bind(o, f);
94         };
95 });
96
97 var jsc = now();
98
99 jQuery.extend({
100         get: function( url, data, callback, type ) {
101                 // shift arguments if data argument was ommited
102                 if ( jQuery.isFunction( data ) ) {
103                         callback = data;
104                         data = null;
105                 }
106
107                 return jQuery.ajax({
108                         type: "GET",
109                         url: url,
110                         data: data,
111                         success: callback,
112                         dataType: type
113                 });
114         },
115
116         getScript: function( url, callback ) {
117                 return jQuery.get(url, null, callback, "script");
118         },
119
120         getJSON: function( url, data, callback ) {
121                 return jQuery.get(url, data, callback, "json");
122         },
123
124         post: function( url, data, callback, type ) {
125                 if ( jQuery.isFunction( data ) ) {
126                         callback = data;
127                         data = {};
128                 }
129
130                 return jQuery.ajax({
131                         type: "POST",
132                         url: url,
133                         data: data,
134                         success: callback,
135                         dataType: type
136                 });
137         },
138
139         ajaxSetup: function( settings ) {
140                 jQuery.extend( jQuery.ajaxSettings, settings );
141         },
142
143         ajaxSettings: {
144                 url: location.href,
145                 global: true,
146                 type: "GET",
147                 timeout: 0,
148                 contentType: "application/x-www-form-urlencoded",
149                 processData: true,
150                 async: true,
151                 data: null,
152                 username: null,
153                 password: null,
154                 accepts: {
155                         xml: "application/xml, text/xml",
156                         html: "text/html",
157                         script: "text/javascript, application/javascript",
158                         json: "application/json, text/javascript",
159                         text: "text/plain",
160                         _default: "*/*"
161                 }
162         },
163
164         // Last-Modified header cache for next request
165         lastModified: {},
166
167         ajax: function( s ) {
168                 var jsonp, jsre = /=\?(&|$)/g, status, data;
169
170                 // Extend the settings, but re-extend 's' so that it can be
171                 // checked again later (in the test suite, specifically)
172                 s = jQuery.extend(true, s, jQuery.extend(true, {}, jQuery.ajaxSettings, s));
173
174                 // convert data if not already a string
175                 if ( s.data && s.processData && typeof s.data != "string" )
176                         s.data = jQuery.param(s.data);
177
178                 // Handle JSONP Parameter Callbacks
179                 if ( s.dataType == "jsonp" ) {
180                         if ( s.type.toLowerCase() == "get" ) {
181                                 if ( !s.url.match(jsre) )
182                                         s.url += (s.url.match(/\?/) ? "&" : "?") + (s.jsonp || "callback") + "=?";
183                         } else if ( !s.data || !s.data.match(jsre) )
184                                 s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
185                         s.dataType = "json";
186                 }
187
188                 // Build temporary JSONP function
189                 if ( s.dataType == "json" && (s.data && s.data.match(jsre) || s.url.match(jsre)) ) {
190                         jsonp = "jsonp" + jsc++;
191
192                         // Replace the =? sequence both in the query string and the data
193                         if ( s.data )
194                                 s.data = (s.data + "").replace(jsre, "=" + jsonp + "$1");
195                         s.url = s.url.replace(jsre, "=" + jsonp + "$1");
196
197                         // We need to make sure
198                         // that a JSONP style response is executed properly
199                         s.dataType = "script";
200
201                         // Handle JSONP-style loading
202                         window[ jsonp ] = function(tmp){
203                                 data = tmp;
204                                 success();
205                                 complete();
206                                 // Garbage collect
207                                 window[ jsonp ] = undefined;
208                                 try{ delete window[ jsonp ]; } catch(e){}
209                                 if ( head )
210                                         head.removeChild( script );
211                         };
212                 }
213
214                 if ( s.dataType == "script" && s.cache == null )
215                         s.cache = false;
216
217                 if ( s.cache === false && s.type.toLowerCase() == "get" ) {
218                         var ts = now();
219                         // try replacing _= if it is there
220                         var ret = s.url.replace(/(\?|&)_=.*?(&|$)/, "$1_=" + ts + "$2");
221                         // if nothing was replaced, add timestamp to the end
222                         s.url = ret + ((ret == s.url) ? (s.url.match(/\?/) ? "&" : "?") + "_=" + ts : "");
223                 }
224
225                 // If data is available, append data to url for get requests
226                 if ( s.data && s.type.toLowerCase() == "get" ) {
227                         s.url += (s.url.match(/\?/) ? "&" : "?") + s.data;
228
229                         // IE likes to send both get and post data, prevent this
230                         s.data = null;
231                 }
232
233                 // Watch for a new set of requests
234                 if ( s.global && ! jQuery.active++ )
235                         jQuery.event.trigger( "ajaxStart" );
236
237                 // Matches an absolute URL, and saves the domain
238                 var remote = /^(?:\w+:)?\/\/([^\/?#]+)/;
239
240                 // If we're requesting a remote document
241                 // and trying to load JSON or Script with a GET
242                 if ( s.dataType == "script" && s.type.toLowerCase() == "get"
243                                 && remote.test(s.url) && remote.exec(s.url)[1] != location.host ){
244                         var head = document.getElementsByTagName("head")[0];
245                         var script = document.createElement("script");
246                         script.src = s.url;
247                         if (s.scriptCharset)
248                                 script.charset = s.scriptCharset;
249
250                         // Handle Script loading
251                         if ( !jsonp ) {
252                                 var done = false;
253
254                                 // Attach handlers for all browsers
255                                 script.onload = script.onreadystatechange = function(){
256                                         if ( !done && (!this.readyState ||
257                                                         this.readyState == "loaded" || this.readyState == "complete") ) {
258                                                 done = true;
259                                                 success();
260                                                 complete();
261                                                 head.removeChild( script );
262                                         }
263                                 };
264                         }
265
266                         head.appendChild(script);
267
268                         // We handle everything using the script element injection
269                         return undefined;
270                 }
271
272                 var requestDone = false;
273
274                 // Create the request object; Microsoft failed to properly
275                 // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
276                 var xml = window.ActiveXObject ? new ActiveXObject("Microsoft.XMLHTTP") : new XMLHttpRequest();
277
278                 // Open the socket
279                 xml.open(s.type, s.url, s.async, s.username, s.password);
280
281                 // Need an extra try/catch for cross domain requests in Firefox 3
282                 try {
283                         // Set the correct header, if data is being sent
284                         if ( s.data )
285                                 xml.setRequestHeader("Content-Type", s.contentType);
286
287                         // Set the If-Modified-Since header, if ifModified mode.
288                         if ( s.ifModified )
289                                 xml.setRequestHeader("If-Modified-Since",
290                                         jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
291
292                         // Set header so the called script knows that it's an XMLHttpRequest
293                         xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
294
295                         // Set the Accepts header for the server, depending on the dataType
296                         xml.setRequestHeader("Accept", s.dataType && s.accepts[ s.dataType ] ?
297                                 s.accepts[ s.dataType ] + ", */*" :
298                                 s.accepts._default );
299                 } catch(e){}
300
301                 // Allow custom headers/mimetypes
302                 if ( s.beforeSend && s.beforeSend(xml, s) === false ) {
303                         // cleanup active request counter
304                         s.global && jQuery.active--;
305                         // close opended socket
306                         xml.abort();
307                         return false;
308                 }
309
310                 if ( s.global )
311                         jQuery.event.trigger("ajaxSend", [xml, s]);
312
313                 // Wait for a response to come back
314                 var onreadystatechange = function(isTimeout){
315                         // The transfer is complete and the data is available, or the request timed out
316                         if ( !requestDone && xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
317                                 requestDone = true;
318
319                                 // clear poll interval
320                                 if (ival) {
321                                         clearInterval(ival);
322                                         ival = null;
323                                 }
324
325                                 status = isTimeout == "timeout" && "timeout" ||
326                                         !jQuery.httpSuccess( xml ) && "error" ||
327                                         s.ifModified && jQuery.httpNotModified( xml, s.url ) && "notmodified" ||
328                                         "success";
329
330                                 if ( status == "success" ) {
331                                         // Watch for, and catch, XML document parse errors
332                                         try {
333                                                 // process the data (runs the xml through httpData regardless of callback)
334                                                 data = jQuery.httpData( xml, s.dataType );
335                                         } catch(e) {
336                                                 status = "parsererror";
337                                         }
338                                 }
339
340                                 // Make sure that the request was successful or notmodified
341                                 if ( status == "success" ) {
342                                         // Cache Last-Modified header, if ifModified mode.
343                                         var modRes;
344                                         try {
345                                                 modRes = xml.getResponseHeader("Last-Modified");
346                                         } catch(e) {} // swallow exception thrown by FF if header is not available
347
348                                         if ( s.ifModified && modRes )
349                                                 jQuery.lastModified[s.url] = modRes;
350
351                                         // JSONP handles its own success callback
352                                         if ( !jsonp )
353                                                 success();
354                                 } else
355                                         jQuery.handleError(s, xml, status);
356
357                                 // Fire the complete handlers
358                                 complete();
359
360                                 // Stop memory leaks
361                                 if ( s.async )
362                                         xml = null;
363                         }
364                 };
365
366                 if ( s.async ) {
367                         // don't attach the handler to the request, just poll it instead
368                         var ival = setInterval(onreadystatechange, 13);
369
370                         // Timeout checker
371                         if ( s.timeout > 0 )
372                                 setTimeout(function(){
373                                         // Check to see if the request is still happening
374                                         if ( xml ) {
375                                                 // Cancel the request
376                                                 xml.abort();
377
378                                                 if( !requestDone )
379                                                         onreadystatechange( "timeout" );
380                                         }
381                                 }, s.timeout);
382                 }
383
384                 // Send the data
385                 try {
386                         xml.send(s.data);
387                 } catch(e) {
388                         jQuery.handleError(s, xml, null, e);
389                 }
390
391                 // firefox 1.5 doesn't fire statechange for sync requests
392                 if ( !s.async )
393                         onreadystatechange();
394
395                 function success(){
396                         // If a local callback was specified, fire it and pass it the data
397                         if ( s.success )
398                                 s.success( data, status );
399
400                         // Fire the global callback
401                         if ( s.global )
402                                 jQuery.event.trigger( "ajaxSuccess", [xml, s] );
403                 }
404
405                 function complete(){
406                         // Process result
407                         if ( s.complete )
408                                 s.complete(xml, status);
409
410                         // The request was completed
411                         if ( s.global )
412                                 jQuery.event.trigger( "ajaxComplete", [xml, s] );
413
414                         // Handle the global AJAX counter
415                         if ( s.global && ! --jQuery.active )
416                                 jQuery.event.trigger( "ajaxStop" );
417                 }
418
419                 // return XMLHttpRequest to allow aborting the request etc.
420                 return xml;
421         },
422
423         handleError: function( s, xml, status, e ) {
424                 // If a local callback was specified, fire it
425                 if ( s.error ) s.error( xml, status, e );
426
427                 // Fire the global callback
428                 if ( s.global )
429                         jQuery.event.trigger( "ajaxError", [xml, s, e] );
430         },
431
432         // Counter for holding the number of active queries
433         active: 0,
434
435         // Determines if an XMLHttpRequest was successful or not
436         httpSuccess: function( r ) {
437                 try {
438                         // IE error sometimes returns 1223 when it should be 204 so treat it as success, see #1450
439                         return !r.status && location.protocol == "file:" ||
440                                 ( r.status >= 200 && r.status < 300 ) || r.status == 304 || r.status == 1223 ||
441                                 jQuery.browser.safari && r.status == undefined;
442                 } catch(e){}
443                 return false;
444         },
445
446         // Determines if an XMLHttpRequest returns NotModified
447         httpNotModified: function( xml, url ) {
448                 try {
449                         var xmlRes = xml.getResponseHeader("Last-Modified");
450
451                         // Firefox always returns 200. check Last-Modified date
452                         return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
453                                 jQuery.browser.safari && xml.status == undefined;
454                 } catch(e){}
455                 return false;
456         },
457
458         httpData: function( r, type ) {
459                 var ct = r.getResponseHeader("content-type"),
460                         xml = type == "xml" || !type && ct && ct.indexOf("xml") >= 0,
461                         data = xml ? r.responseXML : r.responseText;
462
463                 if ( xml && data.documentElement.tagName == "parsererror" )
464                         throw "parsererror";
465
466                 // If the type is "script", eval it in global context
467                 if ( type == "script" )
468                         jQuery.globalEval( data );
469
470                 // Get the JavaScript object, if JSON is used.
471                 if ( type == "json" )
472                         data = eval("(" + data + ")");
473
474                 return data;
475         },
476
477         // Serialize an array of form elements or a set of
478         // key/values into a query string
479         param: function( a ) {
480                 var s = [];
481
482                 // If an array was passed in, assume that it is an array
483                 // of form elements
484                 if ( a.constructor == Array || a.jquery )
485                         // Serialize the form elements
486                         jQuery.each( a, function(){
487                                 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
488                         });
489
490                 // Otherwise, assume that it's an object of key/value pairs
491                 else
492                         // Serialize the key/values
493                         for ( var j in a )
494                                 // If the value is an array then the key names need to be repeated
495                                 if ( a[j] && a[j].constructor == Array )
496                                         jQuery.each( a[j], function(){
497                                                 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
498                                         });
499                                 else
500                                         s.push( encodeURIComponent(j) + "=" + encodeURIComponent( jQuery.isFunction(a[j]) ? a[j]() : a[j] ) );
501
502                 // Return the resulting serialization
503                 return s.join("&").replace(/%20/g, "+");
504         }
505
506 });