src/ajax/ajax.js

   1 jQuery.fn.extend({
   2
   3         /**
   4          * Load HTML from a remote file and inject it into the DOM, only if it's
   5          * been modified by the server.
   6          *
   7          * @example $("#feeds").loadIfModified("feeds.html");
   8          * @before <div id="feeds"></div>
   9          * @result <div id="feeds"><b>45</b> feeds found.</div>
  10          *
  11          * @name loadIfModified
  12          * @type jQuery
  13          * @param String url The URL of the HTML file to load.
  14          * @param Map params (optional) Key/value pairs that will be sent to the server.
  15          * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
  16          * @cat Ajax
  17          */
  18         loadIfModified: function( url, params, callback ) {
  19                 this.load( url, params, callback, 1 );
  20         },
  21
  22         /**
  23          * Load HTML from a remote file and inject it into the DOM.
  24          *
  25          * Note: Avoid to use this to load scripts, instead use $.getScript.
  26          * IE strips script tags when there aren't any other characters in front of it.
  27          *
  28          * @example $("#feeds").load("feeds.html");
  29          * @before <div id="feeds"></div>
  30          * @result <div id="feeds"><b>45</b> feeds found.</div>
  31          *
  32          * @example $("#feeds").load("feeds.html",
  33          *   {limit: 25},
  34          *   function() { alert("The last 25 entries in the feed have been loaded"); }
  35          * );
  36          * @desc Same as above, but with an additional parameter
  37          * and a callback that is executed when the data was loaded.
  38          *
  39          * @name load
  40          * @type jQuery
  41          * @param String url The URL of the HTML file to load.
  42          * @param Object params (optional) A set of key/value pairs that will be sent as data to the server.
  43          * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself).
  44          * @cat Ajax
  45          */
  46         load: function( url, params, callback, ifModified ) {
  47                 if ( jQuery.isFunction( url ) )
  48                         return this.bind("load", url);
  49
  50                 callback = callback || function(){};
  51
  52                 // Default to a GET request
  53                 var type = "GET";
  54
  55                 // If the second parameter was provided
  56                 if ( params )
  57                         // If it's a function
  58                         if ( jQuery.isFunction( params ) ) {
  59                                 // We assume that it's the callback
  60                                 callback = params;
  61                                 params = null;
  62
  63                         // Otherwise, build a param string
  64                         } else {
  65                                 params = jQuery.param( params );
  66                                 type = "POST";
  67                         }
  68
  69                 var self = this;
  70
  71                 // Request the remote document
  72                 jQuery.ajax({
  73                         url: url,
  74                         type: type,
  75                         data: params,
  76                         ifModified: ifModified,
  77                         complete: function(res, status){
  78                                 if ( status == "success" || !ifModified && status == "notmodified" )
  79                                         // Inject the HTML into all the matched elements
  80                                         self.attr("innerHTML", res.responseText)
  81                                           // Execute all the scripts inside of the newly-injected HTML
  82                                           .evalScripts()
  83                                           // Execute callback
  84                                           .each( callback, [res.responseText, status, res] );
  85                                 else
  86                                         callback.apply( self, [res.responseText, status, res] );
  87                         }
  88                 });
  89                 return this;
  90         },
  91
  92         /**
  93          * Serializes a set of input elements into a string of data.
  94          * This will serialize all given elements.
  95          *
  96          * A serialization similar to the form submit of a browser is
  97          * provided by the form plugin. It also takes multiple-selects
  98          * into account, while this method recognizes only a single option.
  99          *
 100          * @example $("input[@type=text]").serialize();
 101          * @before <input type='text' name='name' value='John'/>
 102          * <input type='text' name='location' value='Boston'/>
 103          * @after name=John&location=Boston
 104          * @desc Serialize a selection of input elements to a string
 105          *
 106          * @name serialize
 107          * @type String
 108          * @cat Ajax
 109          */
 110         serialize: function() {
 111                 return jQuery.param( this );
 112         },
 113
 114         /**
 115          * Evaluate all script tags inside this jQuery. If they have a src attribute,
 116          * the script is loaded, otherwise it's content is evaluated.
 117          *
 118          * @name evalScripts
 119          * @type jQuery
 120          * @private
 121          * @cat Ajax
 122          */
 123         evalScripts: function() {
 124                 return this.find("script").each(function(){
 125                         if ( this.src )
 126                                 jQuery.getScript( this.src );
 127                         else
 128                                 jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" );
 129                 }).end();
 130         }
 131
 132 });
 133
 134 // If IE is used, create a wrapper for the XMLHttpRequest object
 135 if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" )
 136         XMLHttpRequest = function(){
 137                 return new ActiveXObject("Microsoft.XMLHTTP");
 138         };
 139
 140 // Attach a bunch of functions for handling common AJAX events
 141
 142 /**
 143  * Attach a function to be executed whenever an AJAX request begins
 144  * and there is none already active.
 145  *
 146  * @example $("#loading").ajaxStart(function(){
 147  *   $(this).show();
 148  * });
 149  * @desc Show a loading message whenever an AJAX request starts
 150  * (and none is already active).
 151  *
 152  * @name ajaxStart
 153  * @type jQuery
 154  * @param Function callback The function to execute.
 155  * @cat Ajax
 156  */
 157
 158 /**
 159  * Attach a function to be executed whenever all AJAX requests have ended.
 160  *
 161  * @example $("#loading").ajaxStop(function(){
 162  *   $(this).hide();
 163  * });
 164  * @desc Hide a loading message after all the AJAX requests have stopped.
 165  *
 166  * @name ajaxStop
 167  * @type jQuery
 168  * @param Function callback The function to execute.
 169  * @cat Ajax
 170  */
 171
 172 /**
 173  * Attach a function to be executed whenever an AJAX request completes.
 174  *
 175  * The XMLHttpRequest and settings used for that request are passed
 176  * as arguments to the callback.
 177  *
 178  * @example $("#msg").ajaxComplete(function(request, settings){
 179  *   $(this).append("<li>Request Complete.</li>");
 180  * });
 181  * @desc Show a message when an AJAX request completes.
 182  *
 183  * @name ajaxComplete
 184  * @type jQuery
 185  * @param Function callback The function to execute.
 186  * @cat Ajax
 187  */
 188
 189 /**
 190  * Attach a function to be executed whenever an AJAX request completes
 191  * successfully.
 192  *
 193  * The XMLHttpRequest and settings used for that request are passed
 194  * as arguments to the callback.
 195  *
 196  * @example $("#msg").ajaxSuccess(function(request, settings){
 197  *   $(this).append("<li>Successful Request!</li>");
 198  * });
 199  * @desc Show a message when an AJAX request completes successfully.
 200  *
 201  * @name ajaxSuccess
 202  * @type jQuery
 203  * @param Function callback The function to execute.
 204  * @cat Ajax
 205  */
 206
 207 /**
 208  * Attach a function to be executed whenever an AJAX request fails.
 209  *
 210  * The XMLHttpRequest and settings used for that request are passed
 211  * as arguments to the callback. A third argument, an exception object,
 212  * is passed if an exception occured while processing the request.
 213  *
 214  * @example $("#msg").ajaxError(function(request, settings){
 215  *   $(this).append("<li>Error requesting page " + settings.url + "</li>");
 216  * });
 217  * @desc Show a message when an AJAX request fails.
 218  *
 219  * @name ajaxError
 220  * @type jQuery
 221  * @param Function callback The function to execute.
 222  * @cat Ajax
 223  */
 224
 225 /**
 226  * Attach a function to be executed before an AJAX request is sent.
 227  *
 228  * The XMLHttpRequest and settings used for that request are passed
 229  * as arguments to the callback.
 230  *
 231  * @example $("#msg").ajaxSend(function(request, settings){
 232  *   $(this).append("<li>Starting request at " + settings.url + "</li>");
 233  * });
 234  * @desc Show a message before an AJAX request is sent.
 235  *
 236  * @name ajaxSend
 237  * @type jQuery
 238  * @param Function callback The function to execute.
 239  * @cat Ajax
 240  */
 241 jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){
 242         jQuery.fn[o] = function(f){
 243                 return this.bind(o, f);
 244         };
 245 });
 246
 247 jQuery.extend({
 248
 249         /**
 250          * Load a remote page using an HTTP GET request.
 251          *
 252          * @example $.get("test.cgi");
 253          *
 254          * @example $.get("test.cgi", { name: "John", time: "2pm" } );
 255          *
 256          * @example $.get("test.cgi", function(data){
 257          *   alert("Data Loaded: " + data);
 258          * });
 259          *
 260          * @example $.get("test.cgi",
 261          *   { name: "John", time: "2pm" },
 262          *   function(data){
 263          *     alert("Data Loaded: " + data);
 264          *   }
 265          * );
 266          *
 267          * @name $.get
 268          * @type XMLHttpRequest
 269          * @param String url The URL of the page to load.
 270          * @param Map params (optional) Key/value pairs that will be sent to the server.
 271          * @param Function callback (optional) A function to be executed whenever the data is loaded.
 272          * @cat Ajax
 273          */
 274         get: function( url, data, callback, type, ifModified ) {
 275                 // shift arguments if data argument was ommited
 276                 if ( jQuery.isFunction( data ) ) {
 277                         callback = data;
 278                         data = null;
 279                 }
 280
 281                 return jQuery.ajax({
 282                         url: url,
 283                         data: data,
 284                         success: callback,
 285                         dataType: type,
 286                         ifModified: ifModified
 287                 });
 288         },
 289
 290         /**
 291          * Load a remote page using an HTTP GET request, only if it hasn't
 292          * been modified since it was last retrieved.
 293          *
 294          * @example $.getIfModified("test.html");
 295          *
 296          * @example $.getIfModified("test.html", { name: "John", time: "2pm" } );
 297          *
 298          * @example $.getIfModified("test.cgi", function(data){
 299          *   alert("Data Loaded: " + data);
 300          * });
 301          *
 302          * @example $.getifModified("test.cgi",
 303          *   { name: "John", time: "2pm" },
 304          *   function(data){
 305          *     alert("Data Loaded: " + data);
 306          *   }
 307          * );
 308          *
 309          * @name $.getIfModified
 310          * @type XMLHttpRequest
 311          * @param String url The URL of the page to load.
 312          * @param Map params (optional) Key/value pairs that will be sent to the server.
 313          * @param Function callback (optional) A function to be executed whenever the data is loaded.
 314          * @cat Ajax
 315          */
 316         getIfModified: function( url, data, callback, type ) {
 317                 return jQuery.get(url, data, callback, type, 1);
 318         },
 319
 320         /**
 321          * Loads, and executes, a remote JavaScript file using an HTTP GET request.
 322          *
 323          * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global
 324          * context synchronously. If you load functions via getScript, make sure
 325          * to call them after a delay.
 326          *
 327          * @example $.getScript("test.js");
 328          *
 329          * @example $.getScript("test.js", function(){
 330          *   alert("Script loaded and executed.");
 331          * });
 332          *
 333          * @name $.getScript
 334          * @type XMLHttpRequest
 335          * @param String url The URL of the page to load.
 336          * @param Function callback (optional) A function to be executed whenever the data is loaded.
 337          * @cat Ajax
 338          */
 339         getScript: function( url, callback ) {
 340                 return jQuery.get(url, null, callback, "script");
 341         },
 342
 343         /**
 344          * Load JSON data using an HTTP GET request.
 345          *
 346          * @example $.getJSON("test.js", function(json){
 347          *   alert("JSON Data: " + json.users[3].name);
 348          * });
 349          *
 350          * @example $.getJSON("test.js",
 351          *   { name: "John", time: "2pm" },
 352          *   function(json){
 353          *     alert("JSON Data: " + json.users[3].name);
 354          *   }
 355          * );
 356          *
 357          * @name $.getJSON
 358          * @type XMLHttpRequest
 359          * @param String url The URL of the page to load.
 360          * @param Map params (optional) Key/value pairs that will be sent to the server.
 361          * @param Function callback A function to be executed whenever the data is loaded.
 362          * @cat Ajax
 363          */
 364         getJSON: function( url, data, callback ) {
 365                 return jQuery.get(url, data, callback, "json");
 366         },
 367
 368         /**
 369          * Load a remote page using an HTTP POST request.
 370          *
 371          * @example $.post("test.cgi");
 372          *
 373          * @example $.post("test.cgi", { name: "John", time: "2pm" } );
 374          *
 375          * @example $.post("test.cgi", function(data){
 376          *   alert("Data Loaded: " + data);
 377          * });
 378          *
 379          * @example $.post("test.cgi",
 380          *   { name: "John", time: "2pm" },
 381          *   function(data){
 382          *     alert("Data Loaded: " + data);
 383          *   }
 384          * );
 385          *
 386          * @name $.post
 387          * @type XMLHttpRequest
 388          * @param String url The URL of the page to load.
 389          * @param Map params (optional) Key/value pairs that will be sent to the server.
 390          * @param Function callback (optional) A function to be executed whenever the data is loaded.
 391          * @cat Ajax
 392          */
 393         post: function( url, data, callback, type ) {
 394                 return jQuery.ajax({
 395                         type: "POST",
 396                         url: url,
 397                         data: data,
 398                         success: callback,
 399                         dataType: type
 400                 });
 401         },
 402
 403         // timeout (ms)
 404         //timeout: 0,
 405
 406         /**
 407          * Set the timeout of all AJAX requests to a specific amount of time.
 408          * This will make all future AJAX requests timeout after a specified amount
 409          * of time.
 410          *
 411          * Set to null or 0 to disable timeouts (default).
 412          *
 413          * You can manually abort requests with the XMLHttpRequest's (returned by
 414          * all ajax functions) abort() method.
 415          *
 416          * Deprecated. Use $.ajaxSetup instead.
 417          *
 418          * @example $.ajaxTimeout( 5000 );
 419          * @desc Make all AJAX requests timeout after 5 seconds.
 420          *
 421          * @name $.ajaxTimeout
 422          * @type undefined
 423          * @param Number time How long before an AJAX request times out.
 424          * @cat Ajax
 425          */
 426         ajaxTimeout: function( timeout ) {
 427                 jQuery.ajaxSettings.timeout = timeout;
 428         },
 429
 430         /**
 431          * Setup global settings for AJAX requests.
 432          *
 433          * See $.ajax for a description of all available options.
 434          *
 435          * @example $.ajaxSetup( {
 436          *   url: "/xmlhttp/",
 437          *   global: false,
 438          *   type: "POST"
 439          * } );
 440          * $.ajax({ data: myData });
 441          * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
 442          * disables global handlers and uses POST instead of GET. The following
 443          * AJAX requests then sends some data without having to set anything else.
 444          *
 445          * @name $.ajaxSetup
 446          * @type undefined
 447          * @param Map settings Key/value pairs to use for all AJAX requests
 448          * @cat Ajax
 449          */
 450         ajaxSetup: function( settings ) {
 451                 jQuery.extend( jQuery.ajaxSettings, settings );
 452         },
 453
 454         ajaxSettings: {
 455                 global: true,
 456                 type: "GET",
 457                 timeout: 0,
 458                 contentType: "application/x-www-form-urlencoded",
 459                 processData: true,
 460                 async: true,
 461                 data: null
 462         },
 463
 464         // Last-Modified header cache for next request
 465         lastModified: {},
 466
 467         /**
 468          * Load a remote page using an HTTP request.
 469          *
 470          * This is jQuery's low-level AJAX implementation. See $.get, $.post etc. for
 471          * higher-level abstractions.
 472          *
 473          * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't
 474          * need that object to manipulate directly, but it is available if you need to
 475          * abort the request manually.
 476          *
 477          * Note: Make sure the server sends the right mimetype (eg. xml as
 478          * "text/xml"). Sending the wrong mimetype will get you into serious
 479          * trouble that jQuery can't solve.
 480          *
 481          * Supported datatypes are (see dataType option):
 482          *
 483          * "xml": Returns a XML document that can be processed via jQuery.
 484          *
 485          * "html": Returns HTML as plain text, included script tags are evaluated.
 486          *
 487          * "script": Evaluates the response as Javascript and returns it as plain text.
 488          *
 489          * "json": Evaluates the response as JSON and returns a Javascript Object
 490          *
 491          * $.ajax() takes one argument, an object of key/value pairs, that are
 492          * used to initalize and handle the request. These are all the key/values that can
 493          * be used:
 494          *
 495          * (String) url - The URL to request.
 496          *
 497          * (String) type - The type of request to make ("POST" or "GET"), default is "GET".
 498          *
 499          * (String) dataType - The type of data that you're expecting back from
 500          * the server. No default: If the server sends xml, the responseXML, otherwise
 501          * the responseText is passed to the success callback.
 502          *
 503          * (Boolean) ifModified - Allow the request to be successful only if the
 504          * response has changed since the last request. This is done by checking the
 505          * Last-Modified header. Default value is false, ignoring the header.
 506          *
 507          * (Number) timeout - Local timeout to override global timeout, eg. to give a
 508          * single request a longer timeout while all others timeout after 1 second.
 509          * See $.ajaxTimeout() for global timeouts.
 510          *
 511          * (Boolean) global - Whether to trigger global AJAX event handlers for
 512          * this request, default is true. Set to false to prevent that global handlers
 513          * like ajaxStart or ajaxStop are triggered.
 514          *
 515          * (Function) error - A function to be called if the request fails. The
 516          * function gets passed tree arguments: The XMLHttpRequest object, a
 517          * string describing the type of error that occurred and an optional
 518          * exception object, if one occured.
 519          *
 520          * (Function) success - A function to be called if the request succeeds. The
 521          * function gets passed one argument: The data returned from the server,
 522          * formatted according to the 'dataType' parameter.
 523          *
 524          * (Function) complete - A function to be called when the request finishes. The
 525          * function gets passed two arguments: The XMLHttpRequest object and a
 526          * string describing the type of success of the request.
 527          *
 528          * (Object|String) data - Data to be sent to the server. Converted to a query
 529          * string, if not already a string. Is appended to the url for GET-requests.
 530          * See processData option to prevent this automatic processing.
 531          *
 532          * (String) contentType - When sending data to the server, use this content-type.
 533          * Default is "application/x-www-form-urlencoded", which is fine for most cases.
 534          *
 535          * (Boolean) processData - By default, data passed in to the data option as an object
 536          * other as string will be processed and transformed into a query string, fitting to
 537          * the default content-type "application/x-www-form-urlencoded". If you want to send
 538          * DOMDocuments, set this option to false.
 539          *
 540          * (Boolean) async - By default, all requests are sent asynchronous (set to true).
 541          * If you need synchronous requests, set this option to false.
 542          *
 543          * (Function) beforeSend - A pre-callback to set custom headers etc., the
 544          * XMLHttpRequest is passed as the only argument.
 545          *
 546          * @example $.ajax({
 547          *   type: "GET",
 548          *   url: "test.js",
 549          *   dataType: "script"
 550          * })
 551          * @desc Load and execute a JavaScript file.
 552          *
 553          * @example $.ajax({
 554          *   type: "POST",
 555          *   url: "some.php",
 556          *   data: "name=John&location=Boston",
 557          *   success: function(msg){
 558          *     alert( "Data Saved: " + msg );
 559          *   }
 560          * });
 561          * @desc Save some data to the server and notify the user once its complete.
 562          *
 563          * @example var html = $.ajax({
 564          *  url: "some.php",
 565          *  async: false
 566          * }).responseText;
 567          * @desc Loads data synchronously. Blocks the browser while the requests is active.
 568          * It is better to block user interaction with others means when synchronization is
 569          * necessary, instead to block the complete browser.
 570          *
 571          * @example var xmlDocument = [create xml document];
 572          * $.ajax({
 573          *   url: "page.php",
 574          *   processData: false,
 575          *   data: xmlDocument,
 576          *   success: handleResponse
 577          * });
 578          * @desc Sends an xml document as data to the server. By setting the processData
 579          * option to false, the automatic conversion of data to strings is prevented.
 580          *
 581          * @name $.ajax
 582          * @type XMLHttpRequest
 583          * @param Map properties Key/value pairs to initialize the request with.
 584          * @cat Ajax
 585          * @see ajaxSetup(Map)
 586          */
 587         ajax: function( s ) {
 588                 // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
 589                 s = jQuery.extend({}, jQuery.ajaxSettings, s);
 590
 591                 // if data available
 592                 if ( s.data ) {
 593                         // convert data if not already a string
 594                         if (s.processData && typeof s.data != "string")
 595                         s.data = jQuery.param(s.data);
 596                         // append data to url for get requests
 597                         if( s.type.toLowerCase() == "get" )
 598                                 // "?" + data or "&" + data (in case there are already params)
 599                                 s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data;
 600                 }
 601
 602                 // Watch for a new set of requests
 603                 if ( s.global && ! jQuery.active++ )
 604                         jQuery.event.trigger( "ajaxStart" );
 605
 606                 var requestDone = false;
 607
 608                 // Create the request object
 609                 var xml = new XMLHttpRequest();
 610
 611                 // Open the socket
 612                 xml.open(s.type, s.url, s.async);
 613
 614                 // Set the correct header, if data is being sent
 615                 if ( s.data )
 616                         xml.setRequestHeader("Content-Type", s.contentType);
 617
 618                 // Set the If-Modified-Since header, if ifModified mode.
 619                 if ( s.ifModified )
 620                         xml.setRequestHeader("If-Modified-Since",
 621                                 jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" );
 622
 623                 // Set header so the called script knows that it's an XMLHttpRequest
 624                 xml.setRequestHeader("X-Requested-With", "XMLHttpRequest");
 625
 626                 // Make sure the browser sends the right content length
 627                 if ( xml.overrideMimeType )
 628                         xml.setRequestHeader("Connection", "close");
 629
 630                 // Allow custom headers/mimetypes
 631                 if( s.beforeSend )
 632                         s.beforeSend(xml);
 633
 634                 if ( s.global )
 635                     jQuery.event.trigger("ajaxSend", [xml, s]);
 636
 637                 // Wait for a response to come back
 638                 var onreadystatechange = function(isTimeout){
 639                         // The transfer is complete and the data is available, or the request timed out
 640                         if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) {
 641                                 requestDone = true;
 642                                 var status;
 643                                 try {
 644                                         status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ?
 645                                                 s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error";
 646                                         // Make sure that the request was successful or notmodified
 647                                         if ( status != "error" ) {
 648                                                 // Cache Last-Modified header, if ifModified mode.
 649                                                 var modRes;
 650                                                 try {
 651                                                         modRes = xml.getResponseHeader("Last-Modified");
 652                                                 } catch(e) {} // swallow exception thrown by FF if header is not available
 653
 654                                                 if ( s.ifModified && modRes )
 655                                                         jQuery.lastModified[s.url] = modRes;
 656
 657                                                 // process the data (runs the xml through httpData regardless of callback)
 658                                                 var data = jQuery.httpData( xml, s.dataType );
 659
 660                                                 // If a local callback was specified, fire it and pass it the data
 661                                                 if ( s.success )
 662                                                         s.success( data, status );
 663
 664                                                 // Fire the global callback
 665                                                 if( s.global )
 666                                                         jQuery.event.trigger( "ajaxSuccess", [xml, s] );
 667                                         } else
 668                                                 jQuery.handleError(s, xml, status);
 669                                 } catch(e) {
 670                                         status = "error";
 671                                         jQuery.handleError(s, xml, status, e);
 672                                 }
 673
 674                                 // The request was completed
 675                                 if( s.global )
 676                                         jQuery.event.trigger( "ajaxComplete", [xml, s] );
 677
 678                                 // Handle the global AJAX counter
 679                                 if ( s.global && ! --jQuery.active )
 680                                         jQuery.event.trigger( "ajaxStop" );
 681
 682                                 // Process result
 683                                 if ( s.complete )
 684                                         s.complete(xml, status);
 685
 686                                 // Stop memory leaks
 687                                 xml.onreadystatechange = function(){};
 688                                 xml = null;
 689                         }
 690                 };
 691                 xml.onreadystatechange = onreadystatechange;
 692
 693                 // Timeout checker
 694                 if ( s.timeout > 0 )
 695                         setTimeout(function(){
 696                                 // Check to see if the request is still happening
 697                                 if ( xml ) {
 698                                         // Cancel the request
 699                                         xml.abort();
 700
 701                                         if( !requestDone )
 702                                                 onreadystatechange( "timeout" );
 703                                 }
 704                         }, s.timeout);
 705
 706                 // save non-leaking reference
 707                 var xml2 = xml;
 708
 709                 // Send the data
 710                 try {
 711                         xml2.send(s.data);
 712                 } catch(e) {
 713                         jQuery.handleError(s, xml, null, e);
 714                 }
 715
 716                 // firefox 1.5 doesn't fire statechange for sync requests
 717                 if ( !s.async )
 718                         onreadystatechange();
 719
 720                 // return XMLHttpRequest to allow aborting the request etc.
 721                 return xml2;
 722         },
 723
 724         handleError: function( s, xml, status, e ) {
 725                 // If a local callback was specified, fire it
 726                 if ( s.error ) s.error( xml, status, e );
 727
 728                 // Fire the global callback
 729                 if ( s.global )
 730                         jQuery.event.trigger( "ajaxError", [xml, s, e] );
 731         },
 732
 733         // Counter for holding the number of active queries
 734         active: 0,
 735
 736         // Determines if an XMLHttpRequest was successful or not
 737         httpSuccess: function( r ) {
 738                 try {
 739                         return !r.status && location.protocol == "file:" ||
 740                                 ( r.status >= 200 && r.status < 300 ) || r.status == 304 ||
 741                                 jQuery.browser.safari && r.status == undefined;
 742                 } catch(e){}
 743                 return false;
 744         },
 745
 746         // Determines if an XMLHttpRequest returns NotModified
 747         httpNotModified: function( xml, url ) {
 748                 try {
 749                         var xmlRes = xml.getResponseHeader("Last-Modified");
 750
 751                         // Firefox always returns 200. check Last-Modified date
 752                         return xml.status == 304 || xmlRes == jQuery.lastModified[url] ||
 753                                 jQuery.browser.safari && xml.status == undefined;
 754                 } catch(e){}
 755                 return false;
 756         },
 757
 758         /* Get the data out of an XMLHttpRequest.
 759          * Return parsed XML if content-type header is "xml" and type is "xml" or omitted,
 760          * otherwise return plain text.
 761          * (String) data - The type of data that you're expecting back,
 762          * (e.g. "xml", "html", "script")
 763          */
 764         httpData: function( r, type ) {
 765                 var ct = r.getResponseHeader("content-type");
 766                 var data = !type && ct && ct.indexOf("xml") >= 0;
 767                 data = type == "xml" || data ? r.responseXML : r.responseText;
 768
 769                 // If the type is "script", eval it in global context
 770                 if ( type == "script" )
 771                         jQuery.globalEval( data );
 772
 773                 // Get the JavaScript object, if JSON is used.
 774                 if ( type == "json" )
 775                         eval( "data = " + data );
 776
 777                 // evaluate scripts within html
 778                 if ( type == "html" )
 779                         jQuery("<div>").html(data).evalScripts();
 780
 781                 return data;
 782         },
 783
 784         // Serialize an array of form elements or a set of
 785         // key/values into a query string
 786         param: function( a ) {
 787                 var s = [];
 788
 789                 // If an array was passed in, assume that it is an array
 790                 // of form elements
 791                 if ( a.constructor == Array || a.jquery )
 792                         // Serialize the form elements
 793                         jQuery.each( a, function(){
 794                                 s.push( encodeURIComponent(this.name) + "=" + encodeURIComponent( this.value ) );
 795                         });
 796
 797                 // Otherwise, assume that it's an object of key/value pairs
 798                 else
 799                         // Serialize the key/values
 800                         for ( var j in a )
 801                                 // If the value is an array then the key names need to be repeated
 802                                 if ( a[j].constructor == Array )
 803                                         jQuery.each( a[j], function(){
 804                                                 s.push( encodeURIComponent(j) + "=" + encodeURIComponent( this ) );
 805                                         });
 806                                 else
 807                                         s.push( encodeURIComponent(j) + "=" + encodeURIComponent( a[j] ) );
 808
 809                 // Return the resulting serialization
 810                 return s.join("&");
 811         },
 812
 813         // evalulates a script in global context
 814         // not reliable for safari
 815         globalEval: function( data ) {
 816                 if ( window.execScript )
 817                         window.execScript( data );
 818                 else if ( jQuery.browser.safari )
 819                         // safari doesn't provide a synchronous global eval
 820                         window.setTimeout( data, 0 );
 821                 else
 822                         eval.call( window, data );
 823         }
 824
 825 });