src/ajax.js

   1 var jsc = now(),
   2         rscript = /<script(.|\s)*?\/script>/gi,
   3         rselectTextarea = /select|textarea/i,
   4         rinput = /color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,
   5         jsre = /=\?(&|$)/,
   6         rquery = /\?/,
   7         rts = /(\?|&)_=.*?(&|$)/,
   8         rurl = /^(\w+:)?\/\/([^\/?#]+)/,
   9         r20 = /%20/g;
  10
  11 jQuery.fn.extend({
  12         // Keep a copy of the old load
  13         _load: jQuery.fn.load,
  14
  15         load: function( url, params, callback ) {
  16                 if ( typeof url !== "string" ) {
  17                         return this._load( url );
  18
  19                 // Don't do a request if no elements are being requested
  20                 } else if ( !this.length ) {
  21                         return this;
  22                 }
  23
  24                 var off = url.indexOf(" ");
  25                 if ( off >= 0 ) {
  26                         var selector = url.slice(off, url.length);
  27                         url = url.slice(0, off);
  28                 }
  29
  30                 // Default to a GET request
  31                 var type = "GET";
  32
  33                 // If the second parameter was provided
  34                 if ( params ) {
  35                         // If it's a function
  36                         if ( jQuery.isFunction( params ) ) {
  37                                 // We assume that it's the callback
  38                                 callback = params;
  39                                 params = null;
  40
  41                         // Otherwise, build a param string
  42                         } else if ( typeof params === "object" ) {
  43                                 params = jQuery.param( params, jQuery.ajaxSettings.traditional );
  44                                 type = "POST";
  45                         }
  46                 }
  47
  48                 // Request the remote document
  49                 jQuery.ajax({
  50                         url: url,
  51                         type: type,
  52                         dataType: "html",
  53                         data: params,
  54                         context:this,
  55                         complete: function( res, status ) {
  56                                 // If successful, inject the HTML into all the matched elements
  57                                 if ( status === "success" || status === "notmodified" ) {
  58                                         // See if a selector was specified
  59                                         this.html( selector ?
  60                                                 // Create a dummy div to hold the results
  61                                                 jQuery("<div />")
  62                                                         // inject the contents of the document in, removing the scripts
  63                                                         // to avoid any 'Permission Denied' errors in IE
  64                                                         .append(res.responseText.replace(rscript, ""))
  65
  66                                                         // Locate the specified elements
  67                                                         .find(selector) :
  68
  69                                                 // If not, just inject the full result
  70                                                 res.responseText );
  71                                 }
  72
  73                                 if ( callback ) {
  74                                         this.each( callback, [res.responseText, status, res] );
  75                                 }
  76                         }
  77                 });
  78
  79                 return this;
  80         },
  81
  82         serialize: function() {
  83                 return jQuery.param(this.serializeArray());
  84         },
  85         serializeArray: function() {
  86                 return this.map(function() {
  87                         return this.elements ? jQuery.makeArray(this.elements) : this;
  88                 })
  89                 .filter(function() {
  90                         return this.name && !this.disabled &&
  91                                 (this.checked || rselectTextarea.test(this.nodeName) ||
  92                                         rinput.test(this.type));
  93                 })
  94                 .map(function( i, elem ) {
  95                         var val = jQuery(this).val();
  96
  97                         return val == null ?
  98                                 null :
  99                                 jQuery.isArray(val) ?
 100                                         jQuery.map( val, function( val, i ) {
 101                                                 return { name: elem.name, value: val };
 102                                         }) :
 103                                         { name: elem.name, value: val };
 104                 }).get();
 105         }
 106 });
 107
 108 // Attach a bunch of functions for handling common AJAX events
 109 jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), function( i, o ) {
 110         jQuery.fn[o] = function( f ) {
 111                 return this.bind(o, f);
 112         };
 113 });
 114
 115 jQuery.extend({
 116
 117         get: function( url, data, callback, type ) {
 118                 // shift arguments if data argument was omited
 119                 if ( jQuery.isFunction( data ) ) {
 120                         type = type || callback;
 121                         callback = data;
 122                         data = null;
 123                 }
 124
 125                 return jQuery.ajax({
 126                         type: "GET",
 127                         url: url,
 128                         data: data,
 129                         success: callback,
 130                         dataType: type
 131                 });
 132         },
 133
 134         getScript: function( url, callback ) {
 135                 return jQuery.get(url, null, callback, "script");
 136         },
 137
 138         getJSON: function( url, data, callback ) {
 139                 return jQuery.get(url, data, callback, "json");
 140         },
 141
 142         post: function( url, data, callback, type ) {
 143                 // shift arguments if data argument was omited
 144                 if ( jQuery.isFunction( data ) ) {
 145                         type = type || callback;
 146                         callback = data;
 147                         data = {};
 148                 }
 149
 150                 return jQuery.ajax({
 151                         type: "POST",
 152                         url: url,
 153                         data: data,
 154                         success: callback,
 155                         dataType: type
 156                 });
 157         },
 158
 159         ajaxSetup: function( settings ) {
 160                 jQuery.extend( jQuery.ajaxSettings, settings );
 161         },
 162
 163         ajaxSettings: {
 164                 url: location.href,
 165                 global: true,
 166                 type: "GET",
 167                 contentType: "application/x-www-form-urlencoded",
 168                 processData: true,
 169                 async: true,
 170                 /*
 171                 timeout: 0,
 172                 data: null,
 173                 username: null,
 174                 password: null,
 175                 traditional: false,
 176                 */
 177                 // Create the request object; Microsoft failed to properly
 178                 // implement the XMLHttpRequest in IE7, so we use the ActiveXObject when it is available
 179                 // This function can be overriden by calling jQuery.ajaxSetup
 180                 xhr: function() {
 181                         return window.ActiveXObject ?
 182                                 new ActiveXObject("Microsoft.XMLHTTP") :
 183                                 new XMLHttpRequest();
 184                 },
 185                 accepts: {
 186                         xml: "application/xml, text/xml",
 187                         html: "text/html",
 188                         script: "text/javascript, application/javascript",
 189                         json: "application/json, text/javascript",
 190                         text: "text/plain",
 191                         _default: "*/*"
 192                 }
 193         },
 194
 195         // Last-Modified header cache for next request
 196         lastModified: {},
 197         etag: {},
 198
 199         ajax: function( origSettings ) {
 200                 var s = jQuery.extend(true, {}, jQuery.ajaxSettings, origSettings);
 201
 202                 var jsonp, status, data,
 203                         callbackContext = s.context || s,
 204                         type = s.type.toUpperCase();
 205
 206                 // convert data if not already a string
 207                 if ( s.data && s.processData && typeof s.data !== "string" ) {
 208                         s.data = jQuery.param( s.data, s.traditional );
 209                 }
 210
 211                 // Handle JSONP Parameter Callbacks
 212                 if ( s.dataType === "jsonp" ) {
 213                         if ( type === "GET" ) {
 214                                 if ( !jsre.test( s.url ) ) {
 215                                         s.url += (rquery.test( s.url ) ? "&" : "?") + (s.jsonp || "callback") + "=?";
 216                                 }
 217                         } else if ( !s.data || !jsre.test(s.data) ) {
 218                                 s.data = (s.data ? s.data + "&" : "") + (s.jsonp || "callback") + "=?";
 219                         }
 220                         s.dataType = "json";
 221                 }
 222
 223                 // Build temporary JSONP function
 224                 if ( s.dataType === "json" && (s.data && jsre.test(s.data) || jsre.test(s.url)) ) {
 225                         jsonp = s.jsonpCallback || ("jsonp" + jsc++);
 226
 227                         // Replace the =? sequence both in the query string and the data
 228                         if ( s.data ) {
 229                                 s.data = (s.data + "").replace(jsre, "=" + jsonp + "$1");
 230                         }
 231
 232                         s.url = s.url.replace(jsre, "=" + jsonp + "$1");
 233
 234                         // We need to make sure
 235                         // that a JSONP style response is executed properly
 236                         s.dataType = "script";
 237
 238                         // Handle JSONP-style loading
 239                         window[ jsonp ] = window[ jsonp ] || function( tmp ) {
 240                                 data = tmp;
 241                                 success();
 242                                 complete();
 243                                 // Garbage collect
 244                                 window[ jsonp ] = undefined;
 245
 246                                 try {
 247                                         delete window[ jsonp ];
 248                                 } catch(e) {}
 249
 250                                 if ( head ) {
 251                                         head.removeChild( script );
 252                                 }
 253                         };
 254                 }
 255
 256                 if ( s.dataType === "script" && s.cache === null ) {
 257                         s.cache = false;
 258                 }
 259
 260                 if ( s.cache === false && type === "GET" ) {
 261                         var ts = now();
 262
 263                         // try replacing _= if it is there
 264                         var ret = s.url.replace(rts, "$1_=" + ts + "$2");
 265
 266                         // if nothing was replaced, add timestamp to the end
 267                         s.url = ret + ((ret === s.url) ? (rquery.test(s.url) ? "&" : "?") + "_=" + ts : "");
 268                 }
 269
 270                 // If data is available, append data to url for get requests
 271                 if ( s.data && type === "GET" ) {
 272                         s.url += (rquery.test(s.url) ? "&" : "?") + s.data;
 273                 }
 274
 275                 // Watch for a new set of requests
 276                 if ( s.global && ! jQuery.active++ ) {
 277                         jQuery.event.trigger( "ajaxStart" );
 278                 }
 279
 280                 // Matches an absolute URL, and saves the domain
 281                 var parts = rurl.exec( s.url ),
 282                         remote = parts && (parts[1] && parts[1] !== location.protocol || parts[2] !== location.host);
 283
 284                 // If we're requesting a remote document
 285                 // and trying to load JSON or Script with a GET
 286                 if ( s.dataType === "script" && type === "GET" && remote ) {
 287                         var head = document.getElementsByTagName("head")[0] || document.documentElement;
 288                         var script = document.createElement("script");
 289                         script.src = s.url;
 290                         if ( s.scriptCharset ) {
 291                                 script.charset = s.scriptCharset;
 292                         }
 293
 294                         // Handle Script loading
 295                         if ( !jsonp ) {
 296                                 var done = false;
 297
 298                                 // Attach handlers for all browsers
 299                                 script.onload = script.onreadystatechange = function() {
 300                                         if ( !done && (!this.readyState ||
 301                                                         this.readyState === "loaded" || this.readyState === "complete") ) {
 302                                                 done = true;
 303                                                 success();
 304                                                 complete();
 305
 306                                                 // Handle memory leak in IE
 307                                                 script.onload = script.onreadystatechange = null;
 308                                                 if ( head && script.parentNode ) {
 309                                                         head.removeChild( script );
 310                                                 }
 311                                         }
 312                                 };
 313                         }
 314
 315                         // Use insertBefore instead of appendChild  to circumvent an IE6 bug.
 316                         // This arises when a base node is used (#2709 and #4378).
 317                         head.insertBefore( script, head.firstChild );
 318
 319                         // We handle everything using the script element injection
 320                         return undefined;
 321                 }
 322
 323                 var requestDone = false;
 324
 325                 // Create the request object
 326                 var xhr = s.xhr();
 327
 328                 // Open the socket
 329                 // Passing null username, generates a login popup on Opera (#2865)
 330                 if ( s.username ) {
 331                         xhr.open(type, s.url, s.async, s.username, s.password);
 332                 } else {
 333                         xhr.open(type, s.url, s.async);
 334                 }
 335
 336                 // Need an extra try/catch for cross domain requests in Firefox 3
 337                 try {
 338                         // Set the correct header, if data is being sent
 339                         if ( s.data || origSettings && origSettings.contentType ) {
 340                                 xhr.setRequestHeader("Content-Type", s.contentType);
 341                         }
 342
 343                         // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
 344                         if ( s.ifModified ) {
 345                                 if ( jQuery.lastModified[s.url] ) {
 346                                         xhr.setRequestHeader("If-Modified-Since", jQuery.lastModified[s.url]);
 347                                 }
 348
 349                                 if ( jQuery.etag[s.url] ) {
 350                                         xhr.setRequestHeader("If-None-Match", jQuery.etag[s.url]);
 351                                 }
 352                         }
 353
 354                         // Set header so the called script knows that it's an XMLHttpRequest
 355                         // Only send the header if it's not a remote XHR
 356                         if ( !remote ) {
 357                                 xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
 358                         }
 359
 360                         // Set the Accepts header for the server, depending on the dataType
 361                         xhr.setRequestHeader("Accept", s.dataType && s.accepts[ s.dataType ] ?
 362                                 s.accepts[ s.dataType ] + ", */*" :
 363                                 s.accepts._default );
 364                 } catch(e) {}
 365
 366                 // Allow custom headers/mimetypes and early abort
 367                 if ( s.beforeSend && s.beforeSend.call(callbackContext, xhr, s) === false ) {
 368                         // Handle the global AJAX counter
 369                         if ( s.global && ! --jQuery.active ) {
 370                                 jQuery.event.trigger( "ajaxStop" );
 371                         }
 372
 373                         // close opended socket
 374                         xhr.abort();
 375                         return false;
 376                 }
 377
 378                 if ( s.global ) {
 379                         trigger("ajaxSend", [xhr, s]);
 380                 }
 381
 382                 // Wait for a response to come back
 383                 var onreadystatechange = function( isTimeout ) {
 384                         // The request was aborted, clear the interval and decrement jQuery.active
 385                         if ( !xhr || xhr.readyState === 0 ) {
 386                                 if ( ival ) {
 387                                         // clear poll interval
 388                                         clearInterval( ival );
 389                                         ival = null;
 390
 391                                         // Handle the global AJAX counter
 392                                         if ( s.global && ! --jQuery.active ) {
 393                                                 jQuery.event.trigger( "ajaxStop" );
 394                                         }
 395                                 }
 396
 397                         // The transfer is complete and the data is available, or the request timed out
 398                         } else if ( !requestDone && xhr && (xhr.readyState === 4 || isTimeout === "timeout") ) {
 399                                 requestDone = true;
 400
 401                                 // clear poll interval
 402                                 if (ival) {
 403                                         clearInterval(ival);
 404                                         ival = null;
 405                                 }
 406
 407                                 status = isTimeout === "timeout" ?
 408                                         "timeout" :
 409                                         !jQuery.httpSuccess( xhr ) ?
 410                                                 "error" :
 411                                                 s.ifModified && jQuery.httpNotModified( xhr, s.url ) ?
 412                                                         "notmodified" :
 413                                                         "success";
 414
 415                                 if ( status === "success" ) {
 416                                         // Watch for, and catch, XML document parse errors
 417                                         try {
 418                                                 // process the data (runs the xml through httpData regardless of callback)
 419                                                 data = jQuery.httpData( xhr, s.dataType, s );
 420                                         } catch(e) {
 421                                                 status = "parsererror";
 422                                         }
 423                                 }
 424
 425                                 // Make sure that the request was successful or notmodified
 426                                 if ( status === "success" || status === "notmodified" ) {
 427                                         // JSONP handles its own success callback
 428                                         if ( !jsonp ) {
 429                                                 success();
 430                                         }
 431                                 } else {
 432                                         jQuery.handleError(s, xhr, status);
 433                                 }
 434
 435                                 // Fire the complete handlers
 436                                 complete();
 437
 438                                 if ( isTimeout === "timeout" ) {
 439                                         xhr.abort();
 440                                 }
 441
 442                                 // Stop memory leaks
 443                                 if ( s.async ) {
 444                                         xhr = null;
 445                                 }
 446                         }
 447                 };
 448
 449                 if ( s.async ) {
 450                         // don't attach the handler to the request, just poll it instead
 451                         var ival = setInterval(onreadystatechange, 13);
 452
 453                         // Timeout checker
 454                         if ( s.timeout > 0 ) {
 455                                 setTimeout(function() {
 456                                         // Check to see if the request is still happening
 457                                         if ( xhr && !requestDone ) {
 458                                                 onreadystatechange( "timeout" );
 459                                         }
 460                                 }, s.timeout);
 461                         }
 462                 }
 463
 464                 // Send the data
 465                 try {
 466                         xhr.send( type === "POST" || type === "PUT" ? s.data : null );
 467                 } catch(e) {
 468                         jQuery.handleError(s, xhr, null, e);
 469                         // Fire the complete handlers
 470                         complete();
 471                 }
 472
 473                 // firefox 1.5 doesn't fire statechange for sync requests
 474                 if ( !s.async ) {
 475                         onreadystatechange();
 476                 }
 477
 478                 function success() {
 479                         // If a local callback was specified, fire it and pass it the data
 480                         if ( s.success ) {
 481                                 s.success.call( callbackContext, data, status, xhr );
 482                         }
 483
 484                         // Fire the global callback
 485                         if ( s.global ) {
 486                                 trigger( "ajaxSuccess", [xhr, s] );
 487                         }
 488                 }
 489
 490                 function complete() {
 491                         // Process result
 492                         if ( s.complete ) {
 493                                 s.complete.call( callbackContext, xhr, status);
 494                         }
 495
 496                         // The request was completed
 497                         if ( s.global ) {
 498                                 trigger( "ajaxComplete", [xhr, s] );
 499                         }
 500
 501                         // Handle the global AJAX counter
 502                         if ( s.global && ! --jQuery.active ) {
 503                                 jQuery.event.trigger( "ajaxStop" );
 504                         }
 505                 }
 506
 507                 function trigger(type, args) {
 508                         (s.context ? jQuery(s.context) : jQuery.event).trigger(type, args);
 509                 }
 510
 511                 // return XMLHttpRequest to allow aborting the request etc.
 512                 return xhr;
 513         },
 514
 515         handleError: function( s, xhr, status, e ) {
 516                 // If a local callback was specified, fire it
 517                 if ( s.error ) {
 518                         s.error.call( s.context || window, xhr, status, e );
 519                 }
 520
 521                 // Fire the global callback
 522                 if ( s.global ) {
 523                         (s.context ? jQuery(s.context) : jQuery.event).trigger( "ajaxError", [xhr, s, e] );
 524                 }
 525         },
 526
 527         // Counter for holding the number of active queries
 528         active: 0,
 529
 530         // Determines if an XMLHttpRequest was successful or not
 531         httpSuccess: function( xhr ) {
 532                 try {
 533                         // IE error sometimes returns 1223 when it should be 204 so treat it as success, see #1450
 534                         return !xhr.status && location.protocol === "file:" ||
 535                                 // Opera returns 0 when status is 304
 536                                 ( xhr.status >= 200 && xhr.status < 300 ) ||
 537                                 xhr.status === 304 || xhr.status === 1223 || xhr.status === 0;
 538                 } catch(e) {}
 539
 540                 return false;
 541         },
 542
 543         // Determines if an XMLHttpRequest returns NotModified
 544         httpNotModified: function( xhr, url ) {
 545                 var lastModified = xhr.getResponseHeader("Last-Modified"),
 546                         etag = xhr.getResponseHeader("Etag");
 547
 548                 if ( lastModified ) {
 549                         jQuery.lastModified[url] = lastModified;
 550                 }
 551
 552                 if ( etag ) {
 553                         jQuery.etag[url] = etag;
 554                 }
 555
 556                 // Opera returns 0 when status is 304
 557                 return xhr.status === 304 || xhr.status === 0;
 558         },
 559
 560         httpData: function( xhr, type, s ) {
 561                 var ct = xhr.getResponseHeader("content-type"),
 562                         xml = type === "xml" || !type && ct && ct.indexOf("xml") >= 0,
 563                         data = xml ? xhr.responseXML : xhr.responseText;
 564
 565                 if ( xml && data.documentElement.nodeName === "parsererror" ) {
 566                         throw "parsererror";
 567                 }
 568
 569                 // Allow a pre-filtering function to sanitize the response
 570                 // s is checked to keep backwards compatibility
 571                 if ( s && s.dataFilter ) {
 572                         data = s.dataFilter( data, type );
 573                 }
 574
 575                 // The filter can actually parse the response
 576                 if ( typeof data === "string" ) {
 577
 578                         // If the type is "script", eval it in global context
 579                         if ( type === "script" ) {
 580                                 jQuery.globalEval( data );
 581                         }
 582
 583                         // Get the JavaScript object, if JSON is used.
 584                         if ( type === "json" ) {
 585                                 if ( typeof JSON === "object" && JSON.parse ) {
 586                                         data = JSON.parse( data );
 587                                 } else {
 588                                         data = (new Function("return " + data))();
 589                                 }
 590                         }
 591                 }
 592
 593                 return data;
 594         },
 595
 596         // Serialize an array of form elements or a set of
 597         // key/values into a query string
 598         param: function( a, traditional ) {
 599
 600                 var s = [];
 601
 602                 // Set traditional to true for jQuery <= 1.3.2 behavior.
 603                 if ( traditional === undefined ) {
 604                         traditional = jQuery.ajaxSettings.traditional;
 605                 }
 606
 607                 function add( key, value ) {
 608                         // If value is a function, invoke it and return its value
 609                         value = jQuery.isFunction(value) ? value() : value;
 610                         s[ s.length ] = encodeURIComponent(key) + "=" + encodeURIComponent(value);
 611                 }
 612
 613                 // If an array was passed in, assume that it is an array of form elements.
 614                 if ( jQuery.isArray(a) || a.jquery ) {
 615                         // Serialize the form elements
 616                         jQuery.each( a, function() {
 617                                 add( this.name, this.value );
 618                         });
 619
 620                 } else {
 621                         // If traditional, encode the "old" way (the way 1.3.2 or older
 622                         // did it), otherwise encode params recursively.
 623                         jQuery.each( a, function buildParams( prefix, obj ) {
 624
 625                                 if ( jQuery.isArray(obj) ) {
 626                                         // Serialize array item.
 627                                         jQuery.each( obj, function( i, v ) {
 628                                                 if ( traditional ) {
 629                                                         // Treat each array item as a scalar.
 630                                                         add( prefix, v );
 631                                                 } else {
 632                                                         // If array item is non-scalar (array or object), encode its
 633                                                         // numeric index to resolve deserialization ambiguity issues.
 634                                                         // Note that rack (as of 1.0.0) can't currently deserialize
 635                                                         // nested arrays properly, and attempting to do so may cause
 636                                                         // a server error. Possible fixes are to modify rack's
 637                                                         // deserialization algorithm or to provide an option or flag
 638                                                         // to force array serialization to be shallow.
 639                                                         buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v );
 640                                                 }
 641                                         });
 642
 643                                 } else if ( !traditional && typeof obj === "object" ) {
 644                                         // Serialize object item.
 645                                         jQuery.each( obj, function( k, v ) {
 646                                                 buildParams( prefix + "[" + k + "]", v );
 647                                         });
 648
 649                                 } else {
 650                                         // Serialize scalar item.
 651                                         add( prefix, obj );
 652                                 }
 653                         });
 654                 }
 655
 656                 // Return the resulting serialization
 657                 return s.join("&").replace(r20, "+");
 658         }
 659
 660 });