Apply JQuery Core Style Guidelines to ajax.js and ajax/*.js,
[jquery.git] / src / ajax / xhr.js
1 (function( jQuery ) {
2
3 var // Next active xhr id
4         xhrId = jQuery.now(),
5
6         // active xhrs
7         xhrs = {},
8
9         // #5280: see below
10         xhrUnloadAbortInstalled,
11
12         // XHR used to determine supports properties
13         testXHR;
14
15 // Create the request object
16 // (This is still attached to ajaxSettings for backward compatibility)
17 jQuery.ajaxSettings.xhr = window.ActiveXObject ?
18         /* Microsoft failed to properly
19          * implement the XMLHttpRequest in IE7 (can't request local files),
20          * so we use the ActiveXObject when it is available
21          * Additionally XMLHttpRequest can be disabled in IE7/IE8 so
22          * we need a fallback.
23          */
24         function() {
25                 if ( window.location.protocol !== "file:" ) {
26                         try {
27                                 return new window.XMLHttpRequest();
28                         } catch( xhrError ) {}
29                 }
30
31                 try {
32                         return new window.ActiveXObject("Microsoft.XMLHTTP");
33                 } catch( activeError ) {}
34         } :
35         // For all other browsers, use the standard XMLHttpRequest object
36         function() {
37                 return new window.XMLHttpRequest();
38         };
39
40 // Test if we can create an xhr object
41 try {
42         testXHR = jQuery.ajaxSettings.xhr();
43 } catch( xhrCreationException ) {}
44
45 //Does this browser support XHR requests?
46 jQuery.support.ajax = !!testXHR;
47
48 // Does this browser support crossDomain XHR requests
49 jQuery.support.cors = testXHR && ( "withCredentials" in testXHR );
50
51 // No need for the temporary xhr anymore
52 testXHR = undefined;
53
54 // Create transport if the browser can provide an xhr
55 if ( jQuery.support.ajax ) {
56
57         jQuery.ajaxTransport(function( s ) {
58                 // Cross domain only allowed if supported through XMLHttpRequest
59                 if ( !s.crossDomain || jQuery.support.cors ) {
60
61                         var callback;
62
63                         return {
64                                 send: function( headers, complete ) {
65
66                                         // #5280: we need to abort on unload or IE will keep connections alive
67                                         if ( !xhrUnloadAbortInstalled ) {
68
69                                                 xhrUnloadAbortInstalled = 1;
70
71                                                 jQuery(window).bind( "unload", function() {
72
73                                                         // Abort all pending requests
74                                                         jQuery.each( xhrs, function( _, xhr ) {
75                                                                 if ( xhr.onreadystatechange ) {
76                                                                         xhr.onreadystatechange( 1 );
77                                                                 }
78                                                         } );
79
80                                                 } );
81                                         }
82
83                                         // Get a new xhr
84                                         var xhr = s.xhr(),
85                                                 handle;
86
87                                         // Open the socket
88                                         // Passing null username, generates a login popup on Opera (#2865)
89                                         if ( s.username ) {
90                                                 xhr.open( s.type, s.url, s.async, s.username, s.password );
91                                         } else {
92                                                 xhr.open( s.type, s.url, s.async );
93                                         }
94
95                                         // Requested-With header
96                                         // Not set for crossDomain requests with no content
97                                         // (see why at http://trac.dojotoolkit.org/ticket/9486)
98                                         // Won't change header if already provided
99                                         if ( !( s.crossDomain && !s.hasContent ) && !headers["x-requested-with"] ) {
100                                                 headers[ "x-requested-with" ] = "XMLHttpRequest";
101                                         }
102
103                                         // Need an extra try/catch for cross domain requests in Firefox 3
104                                         try {
105                                                 jQuery.each( headers, function( key, value ) {
106                                                         xhr.setRequestHeader( key, value );
107                                                 } );
108                                         } catch( _ ) {}
109
110                                         // Do send the request
111                                         try {
112                                                 xhr.send( ( s.hasContent && s.data ) || null );
113                                         } catch( e ) {
114                                                 complete( 0, "error", "" + e );
115                                                 return;
116                                         }
117
118                                         // Listener
119                                         callback = function( _, isAbort ) {
120
121                                                 // Was never called and is aborted or complete
122                                                 if ( callback && ( isAbort || xhr.readyState === 4 ) ) {
123
124                                                         // Only called once
125                                                         callback = 0;
126
127                                                         // Do not keep as active anymore
128                                                         if ( handle ) {
129                                                                 xhr.onreadystatechange = jQuery.noop;
130                                                                 delete xhrs[ handle ];
131                                                         }
132
133                                                         // If it's an abort
134                                                         if ( isAbort ) {
135                                                                 // Abort it manually if needed
136                                                                 if ( xhr.readyState !== 4 ) {
137                                                                         xhr.abort();
138                                                                 }
139                                                         } else {
140                                                                 // Get info
141                                                                 var status = xhr.status,
142                                                                         statusText,
143                                                                         responseHeaders = xhr.getAllResponseHeaders(),
144                                                                         responses = {},
145                                                                         xml = xhr.responseXML;
146
147                                                                 // Construct response list
148                                                                 if ( xml && xml.documentElement /* #4958 */ ) {
149                                                                         responses.xml = xml;
150                                                                 }
151                                                                 responses.text = xhr.responseText;
152
153                                                                 // Firefox throws an exception when accessing
154                                                                 // statusText for faulty cross-domain requests
155                                                                 try {
156                                                                         statusText = xhr.statusText;
157                                                                 } catch( e ) {
158                                                                         // We normalize with Webkit giving an empty statusText
159                                                                         statusText = "";
160                                                                 }
161
162                                                                 // Filter status for non standard behaviours
163                                                                 status =
164                                                                         // Opera returns 0 when it should be 304
165                                                                         // Webkit returns 0 for failing cross-domain no matter the real status
166                                                                         status === 0 ?
167                                                                                 (
168                                                                                         // Webkit, Firefox: filter out faulty cross-domain requests
169                                                                                         !s.crossDomain || statusText ?
170                                                                                         (
171                                                                                                 // Opera: filter out real aborts #6060
172                                                                                                 responseHeaders ?
173                                                                                                 304 :
174                                                                                                 0
175                                                                                         ) :
176                                                                                         // We assume 302 but could be anything cross-domain related
177                                                                                         302
178                                                                                 ) :
179                                                                                 (
180                                                                                         // IE sometimes returns 1223 when it should be 204 (see #1450)
181                                                                                         status == 1223 ?
182                                                                                                 204 :
183                                                                                                 status
184                                                                                 );
185
186                                                                 // Call complete
187                                                                 complete( status, statusText, responses, responseHeaders );
188                                                         }
189                                                 }
190                                         };
191
192                                         // if we're in sync mode or it's in cache
193                                         // and has been retrieved directly (IE6 & IE7)
194                                         // we need to manually fire the callback
195                                         if ( !s.async || xhr.readyState === 4 ) {
196                                                 callback();
197                                         } else {
198                                                 // Add to list of active xhrs
199                                                 handle = xhrId++;
200                                                 xhrs[ handle ] = xhr;
201                                                 xhr.onreadystatechange = callback;
202                                         }
203                                 },
204
205                                 abort: function() {
206                                         if ( callback ) {
207                                                 callback(0,1);
208                                         }
209                                 }
210                         };
211                 }
212         });
213 }
214
215 })( jQuery );