src/ajax/xhr.js

   1 (function( jQuery ) {
   2
   3 var // #5280: next active xhr id and list of active xhrs' callbacks
   4         xhrId = jQuery.now(),
   5         xhrCallbacks,
   6
   7         // XHR used to determine supports properties
   8         testXHR;
   9
  10 // #5280: Internet Explorer will keep connections alive if we don't abort on unload
  11 function xhrOnUnloadAbort() {
  12         jQuery( window ).unload(function() {
  13                 // Abort all pending requests
  14                 for ( var key in xhrCallbacks ) {
  15                         xhrCallbacks[ key ]( 0, 1 );
  16                 }
  17         });
  18 }
  19
  20 // Functions to create xhrs
  21 function createStandardXHR() {
  22         try {
  23                 return new window.XMLHttpRequest();
  24         } catch( e ) {}
  25 }
  26
  27 function createActiveXHR() {
  28         try {
  29                 return new window.ActiveXObject("Microsoft.XMLHTTP");
  30         } catch( e ) {}
  31 }
  32
  33 // Create the request object
  34 // (This is still attached to ajaxSettings for backward compatibility)
  35 jQuery.ajaxSettings.xhr = window.ActiveXObject ?
  36         /* Microsoft failed to properly
  37          * implement the XMLHttpRequest in IE7 (can't request local files),
  38          * so we use the ActiveXObject when it is available
  39          * Additionally XMLHttpRequest can be disabled in IE7/IE8 so
  40          * we need a fallback.
  41          */
  42         function() {
  43                 return !this.isLocal && createStandardXHR() || createActiveXHR();
  44         } :
  45         // For all other browsers, use the standard XMLHttpRequest object
  46         createStandardXHR;
  47
  48 // Test if we can create an xhr object
  49 testXHR = jQuery.ajaxSettings.xhr();
  50 jQuery.support.ajax = !!testXHR;
  51
  52 // Does this browser support crossDomain XHR requests
  53 jQuery.support.cors = testXHR && ( "withCredentials" in testXHR );
  54
  55 // No need for the temporary xhr anymore
  56 testXHR = undefined;
  57
  58 // Create transport if the browser can provide an xhr
  59 if ( jQuery.support.ajax ) {
  60
  61         jQuery.ajaxTransport(function( s ) {
  62                 // Cross domain only allowed if supported through XMLHttpRequest
  63                 if ( !s.crossDomain || jQuery.support.cors ) {
  64
  65                         var callback;
  66
  67                         return {
  68                                 send: function( headers, complete ) {
  69
  70                                         // Get a new xhr
  71                                         var xhr = s.xhr(),
  72                                                 handle,
  73                                                 i;
  74
  75                                         // Open the socket
  76                                         // Passing null username, generates a login popup on Opera (#2865)
  77                                         if ( s.username ) {
  78                                                 xhr.open( s.type, s.url, s.async, s.username, s.password );
  79                                         } else {
  80                                                 xhr.open( s.type, s.url, s.async );
  81                                         }
  82
  83                                         // Apply custom fields if provided
  84                                         if ( s.xhrFields ) {
  85                                                 for ( i in s.xhrFields ) {
  86                                                         xhr[ i ] = s.xhrFields[ i ];
  87                                                 }
  88                                         }
  89
  90                                         // Override mime type if needed
  91                                         if ( s.mimeType && xhr.overrideMimeType ) {
  92                                                 xhr.overrideMimeType( s.mimeType );
  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                                                 for ( i in headers ) {
 106                                                         xhr.setRequestHeader( i, headers[ i ] );
 107                                                 }
 108                                         } catch( _ ) {}
 109
 110                                         // Do send the request
 111                                         // This may raise an exception which is actually
 112                                         // handled in jQuery.ajax (so no try/catch here)
 113                                         xhr.send( ( s.hasContent && s.data ) || null );
 114
 115                                         // Listener
 116                                         callback = function( _, isAbort ) {
 117
 118                                                 var status,
 119                                                         statusText,
 120                                                         responseHeaders,
 121                                                         responses,
 122                                                         xml;
 123
 124                                                 // Firefox throws exceptions when accessing properties
 125                                                 // of an xhr when a network error occured
 126                                                 // http://helpful.knobs-dials.com/index.php/Component_returned_failure_code:_0x80040111_(NS_ERROR_NOT_AVAILABLE)
 127                                                 try {
 128
 129                                                         // Was never called and is aborted or complete
 130                                                         if ( callback && ( isAbort || xhr.readyState === 4 ) ) {
 131
 132                                                                 // Only called once
 133                                                                 callback = undefined;
 134
 135                                                                 // Do not keep as active anymore
 136                                                                 if ( handle ) {
 137                                                                         xhr.onreadystatechange = jQuery.noop;
 138                                                                         delete xhrCallbacks[ handle ];
 139                                                                 }
 140
 141                                                                 // If it's an abort
 142                                                                 if ( isAbort ) {
 143                                                                         // Abort it manually if needed
 144                                                                         if ( xhr.readyState !== 4 ) {
 145                                                                                 xhr.abort();
 146                                                                         }
 147                                                                 } else {
 148                                                                         status = xhr.status;
 149                                                                         responseHeaders = xhr.getAllResponseHeaders();
 150                                                                         responses = {};
 151                                                                         xml = xhr.responseXML;
 152
 153                                                                         // Construct response list
 154                                                                         if ( xml && xml.documentElement /* #4958 */ ) {
 155                                                                                 responses.xml = xml;
 156                                                                         }
 157                                                                         responses.text = xhr.responseText;
 158
 159                                                                         // Firefox throws an exception when accessing
 160                                                                         // statusText for faulty cross-domain requests
 161                                                                         try {
 162                                                                                 statusText = xhr.statusText;
 163                                                                         } catch( e ) {
 164                                                                                 // We normalize with Webkit giving an empty statusText
 165                                                                                 statusText = "";
 166                                                                         }
 167
 168                                                                         // Filter status for non standard behaviors
 169
 170                                                                         // IE - #1450: sometimes returns 1223 when it should be 204
 171                                                                         if ( status === 1223 ) {
 172                                                                                 status = 204;
 173                                                                         // Various - #8177: a Not Modified response was received
 174                                                                         // yet no conditional request headers was provided
 175                                                                         } else if ( status === 304 &&
 176                                                                                                 !headers[ "if-modified-since" ] &&
 177                                                                                                 !headers[ "if-none-match" ] ) {
 178                                                                                 status = 200;
 179                                                                         // Status 0 encompasses several cases
 180                                                                         } else if ( !status ) {
 181                                                                                 // Cross-domain
 182                                                                                 if ( s.crossDomain ) {
 183                                                                                         if ( !s.statusText ) {
 184                                                                                                 // FF, Webkit (other?): There is no status text for errors
 185                                                                                                 // 302 is the most generic cross-domain status code
 186                                                                                                 // for errors, could be anything really (even a real 0)
 187                                                                                                 status = 302;
 188                                                                                         }
 189                                                                                 // All same-domain: for local files, 0 is a success
 190                                                                                 } else if( s.isLocal ) {
 191                                                                                         status = 200;
 192                                                                                         // Opera: this notifies success for all requests
 193                                                                                         // (verified in 11.01). Patch welcome.
 194                                                                                 }
 195                                                                                 // Opera - #6060: sets status as 0 for 304
 196                                                                                 // Patch welcome.
 197                                                                         }
 198                                                                 }
 199                                                         }
 200                                                 } catch( firefoxAccessException ) {
 201                                                         if ( !isAbort ) {
 202                                                                 complete( -1, firefoxAccessException );
 203                                                         }
 204                                                 }
 205
 206                                                 // Call complete if needed
 207                                                 if ( responses ) {
 208                                                         complete( status, statusText, responses, responseHeaders );
 209                                                 }
 210                                         };
 211
 212                                         // if we're in sync mode or it's in cache
 213                                         // and has been retrieved directly (IE6 & IE7)
 214                                         // we need to manually fire the callback
 215                                         if ( !s.async || xhr.readyState === 4 ) {
 216                                                 callback();
 217                                         } else {
 218                                                 // Create the active xhrs callbacks list if needed
 219                                                 // and attach the unload handler
 220                                                 if ( !xhrCallbacks ) {
 221                                                         xhrCallbacks = {};
 222                                                         xhrOnUnloadAbort();
 223                                                 }
 224                                                 // Add to list of active xhrs callbacks
 225                                                 handle = xhrId++;
 226                                                 xhr.onreadystatechange = xhrCallbacks[ handle ] = callback;
 227                                         }
 228                                 },
 229
 230                                 abort: function() {
 231                                         if ( callback ) {
 232                                                 callback(0,1);
 233                                         }
 234                                 }
 235                         };
 236                 }
 237         });
 238 }
 239
 240 })( jQuery );