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