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