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