src/ajax.js

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