jQuery.fn.extend({ /** * Load HTML from a remote file and inject it into the DOM, only if it's * been modified by the server. * * @example $("#feeds").loadIfModified("feeds.html") * @before
* @result
45 feeds found.
* * @name loadIfModified * @type jQuery * @param String url The URL of the HTML file to load. * @param Hash params A set of key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ loadIfModified: function( url, params, callback ) { this.load( url, params, callback, 1 ); }, /** * Load HTML from a remote file and inject it into the DOM. * * @example $("#feeds").load("feeds.html") * @before
* @result
45 feeds found.
* * @example $("#feeds").load("feeds.html", * {test: true}, * function() { alert("load is done"); } * ); * @desc Same as above, but with an additional parameter * and a callback that is executed when the data was loaded. * * @name load * @type jQuery * @param String url The URL of the HTML file to load. * @param Object params A set of key/value pairs that will be sent as data to the server. * @param Function callback A function to be executed whenever the data is loaded (parameters: responseText, status and reponse itself). * @cat AJAX */ load: function( url, params, callback, ifModified ) { if ( url.constructor == Function ) return this.bind("load", url); callback = callback || function(){}; // Default to a GET request var type = "GET"; // If the second parameter was provided if ( params ) { // If it's a function if ( params.constructor == Function ) { // We assume that it's the callback callback = params; params = null; // Otherwise, build a param string } else { params = jQuery.param( params ); type = "POST"; } } var self = this; // Request the remote document jQuery.ajax({ url: url, type: type, data: params, ifModified: ifModified, complete: function(res, status){ if ( status == "success" || !ifModified && status == "notmodified" ) { // Inject the HTML into all the matched elements self.html(res.responseText) // Execute all the scripts inside of the newly-injected HTML .evalScripts() // Execute callback .each( callback, [res.responseText, status, res] ); } else callback.apply( self, [res.responseText, status, res] ); } }); return this; }, /** * Serializes a set of input elements into a string of data. * This will serialize all given elements. If you need * serialization similar to the form submit of a browser, * you should use the form plugin. This is also true for * selects with multiple attribute set, only a single option * is serialized. * * @example $("input[@type=text]").serialize(); * @before * * @after name=John&location=Boston * @desc Serialize a selection of input elements to a string * * @name serialize * @type String * @cat AJAX */ serialize: function() { return jQuery.param( this ); }, /** * Evaluate all script tags inside this jQuery. If they have a src attribute, * the script is loaded, otherwise it's content is evaluated. * * @name evalScripts * @type jQuery * @private * @cat AJAX */ evalScripts: function() { return this.find('script').each(function(){ if ( this.src ) // for some weird reason, it doesn't work if the callback is ommited jQuery.getScript( this.src ); else { jQuery.globalEval( this.text || this.textContent || this.innerHTML || "" ); } }).end(); } }); // If IE is used, create a wrapper for the XMLHttpRequest object if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) XMLHttpRequest = function(){ return new ActiveXObject("Microsoft.XMLHTTP"); }; // Attach a bunch of functions for handling common AJAX events /** * Attach a function to be executed whenever an AJAX request begins. * * @example $("#loading").ajaxStart(function(){ * $(this).show(); * }); * @desc Show a loading message whenever an AJAX request starts. * * @name ajaxStart * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ /** * Attach a function to be executed whenever all AJAX requests have ended. * * @example $("#loading").ajaxStop(function(){ * $(this).hide(); * }); * @desc Hide a loading message after all the AJAX requests have stopped. * * @name ajaxStop * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ /** * Attach a function to be executed whenever an AJAX request completes. * * The XMLHttpRequest and settings used for that request are passed * as arguments to the callback. * * @example $("#msg").ajaxComplete(function(request, settings){ * $(this).append("
  • Request Complete.
  • "); * }); * @desc Show a message when an AJAX request completes. * * @name ajaxComplete * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ /** * Attach a function to be executed whenever an AJAX request completes * successfully. * * The XMLHttpRequest and settings used for that request are passed * as arguments to the callback. * * @example $("#msg").ajaxSuccess(function(request, settings){ * $(this).append("
  • Successful Request!
  • "); * }); * @desc Show a message when an AJAX request completes successfully. * * @name ajaxSuccess * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ /** * Attach a function to be executed whenever an AJAX request fails. * * The XMLHttpRequest and settings used for that request are passed * as arguments to the callback. * * @example $("#msg").ajaxError(function(request, settings){ * $(this).append("
  • Error requesting page " + settings.url + "
  • "); * }); * @desc Show a message when an AJAX request fails. * * @name ajaxError * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ /** * Attach a function to be executed before an AJAX request is send. * * The XMLHttpRequest and settings used for that request are passed * as arguments to the callback. * * @example $("#msg").ajaxSend(function(request, settings){ * $(this).append("
  • Starting request at " + settings.url + "
  • "); * }); * @desc Show a message before an AJAX request is send. * * @name ajaxSend * @type jQuery * @param Function callback The function to execute. * @cat AJAX */ new function(){ var e = "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","); for ( var i = 0; i < e.length; i++ ) new function(){ var o = e[i]; jQuery.fn[o] = function(f){ return this.bind(o, f); }; }; }; jQuery.extend({ /** * Load a remote page using an HTTP GET request. All of the arguments to * the method (except URL) are optional. * * @example $.get("test.cgi") * * @example $.get("test.cgi", { name: "John", time: "2pm" } ) * * @example $.get("test.cgi", function(data){ * alert("Data Loaded: " + data); * }) * * @example $.get("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } * ) * * @name $.get * @type undefined * @param String url The URL of the page to load. * @param Hash params A set of key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ get: function( url, data, callback, type, ifModified ) { // shift arguments if data argument was ommited if ( data && data.constructor == Function ) { callback = data; data = null; } // Delegate jQuery.ajax({ url: url, data: data, success: callback, dataType: type, ifModified: ifModified }); }, /** * Load a remote page using an HTTP GET request, only if it hasn't * been modified since it was last retrieved. All of the arguments to * the method (except URL) are optional. * * @example $.getIfModified("test.html") * * @example $.getIfModified("test.html", { name: "John", time: "2pm" } ) * * @example $.getIfModified("test.cgi", function(data){ * alert("Data Loaded: " + data); * }) * * @example $.getifModified("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } * ) * * @name $.getIfModified * @type undefined * @param String url The URL of the page to load. * @param Hash params A set of key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ getIfModified: function( url, data, callback, type ) { jQuery.get(url, data, callback, type, 1); }, /** * Loads, and executes, a remote JavaScript file using an HTTP GET request. * All of the arguments to the method (except URL) are optional. * * Warning: Safari <= 2.0.x is unable to evalulate scripts in a global * context sychronously. If you load functions via getScript, make sure * to call them after a delay. * * @example $.getScript("test.js") * * @example $.getScript("test.js", function(){ * alert("Script loaded and executed."); * }) * * @name $.getScript * @type undefined * @param String url The URL of the page to load. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ getScript: function( url, callback ) { if(callback) jQuery.get(url, null, callback, "script"); else { jQuery.get(url, null, null, "script"); } }, /** * Load a remote JSON object using an HTTP GET request. * All of the arguments to the method (except URL) are optional. * * @example $.getJSON("test.js", function(json){ * alert("JSON Data: " + json.users[3].name); * }) * * @example $.getJSON("test.js", * { name: "John", time: "2pm" }, * function(json){ * alert("JSON Data: " + json.users[3].name); * } * ) * * @name $.getJSON * @type undefined * @param String url The URL of the page to load. * @param Hash params A set of key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ getJSON: function( url, data, callback ) { jQuery.get(url, data, callback, "json"); }, /** * Load a remote page using an HTTP POST request. All of the arguments to * the method (except URL) are optional. * * @example $.post("test.cgi") * * @example $.post("test.cgi", { name: "John", time: "2pm" } ) * * @example $.post("test.cgi", function(data){ * alert("Data Loaded: " + data); * }) * * @example $.post("test.cgi", * { name: "John", time: "2pm" }, * function(data){ * alert("Data Loaded: " + data); * } * ) * * @name $.post * @type undefined * @param String url The URL of the page to load. * @param Hash params A set of key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. * @cat AJAX */ post: function( url, data, callback, type ) { // Delegate jQuery.ajax({ type: "POST", url: url, data: data, success: callback, dataType: type }); }, // timeout (ms) timeout: 0, /** * Set the timeout of all AJAX requests to a specific amount of time. * This will make all future AJAX requests timeout after a specified amount * of time (the default is no timeout). * * @example $.ajaxTimeout( 5000 ); * @desc Make all AJAX requests timeout after 5 seconds. * * @name $.ajaxTimeout * @type undefined * @param Number time How long before an AJAX request times out. * @cat AJAX */ ajaxTimeout: function(timeout) { jQuery.timeout = timeout; }, // Last-Modified header cache for next request lastModified: {}, /** * Load a remote page using an HTTP request. This function is the primary * means of making AJAX requests using jQuery. * * $.ajax() returns the XMLHttpRequest that it creates. In most cases you won't * need that object to manipulate directly, but it is available if you need to * abort the request manually. * * Please note: Make sure the server sends the right mimetype (eg. xml as * "text/xml"). Sending the wrong mimetype will get you into serious * trouble that jQuery can't solve. * * Supported datatypes (see dataType option) are: * * "xml": Returns a XML document that can be processed via jQuery. * * "html": Returns HTML as plain text, included script tags are evaluated. * * "script": Evaluates the response as Javascript and returns it as plain text. * * "json": Evaluates the response as JSON and returns a Javascript Object * * $.ajax() takes one property, an object of key/value pairs, that are * used to initalize the request. These are all the key/values that can * be passed in to 'prop': * * (String) url - The URL of the page to request. * * (String) type - The type of request to make (e.g. "POST" or "GET"), default is "GET". * * (String) dataType - The type of data that you're expecting back from * the server. No default: If the server sends xml, the responseXML, otherwise * the responseText is is passed to the success callback. * * (Boolean) ifModified - Allow the request to be successful only if the * response has changed since the last request, default is false, ignoring * the Last-Modified header * * (Number) timeout - Local timeout to override global timeout, eg. to give a * single request a longer timeout while all others timeout after 1 seconds, * see $.ajaxTimeout() * * (Boolean) global - Wheather to trigger global AJAX event handlers for * this request, default is true. Set to false to prevent that global handlers * like ajaxStart or ajaxStop are triggered. * * (Function) error - A function to be called if the request fails. The * function gets passed two arguments: The XMLHttpRequest object and a * string describing the type of error that occurred. * * (Function) success - A function to be called if the request succeeds. The * function gets passed one argument: The data returned from the server, * formatted according to the 'dataType' parameter. * * (Function) complete - A function to be called when the request finishes. The * function gets passed two arguments: The XMLHttpRequest object and a * string describing the type the success of the request. * * (Object|String) data - Data to be sent to the server. Converted to a query * string, if not already a string. Is appended to the url for GET-requests. * Override processData option to prevent processing. * * (String) contentType - When sending data to the server, use this content-type, * default is "application/x-www-form-urlencoded", which is fine for most cases. * * (Boolean) processData - By default, data passed in to the data option as an object * other as string will be processed and transformed into a query string, fitting to * the default content-type "application/x-www-form-urlencoded". If you want to send * DOMDocuments, set this option to false. * * (Boolean) async - By default, all requests are send asynchronous (set to true). * If you need synchronous requests, set this option to false. * * (Function) beforeSend - A pre-callback to set custom headers etc., the * XMLHttpRequest is passed as the only argument. * * @example $.ajax({ * type: "GET", * url: "test.js", * dataType: "script" * }) * @desc Load and execute a JavaScript file. * * @example $.ajax({ * type: "POST", * url: "some.php", * data: "name=John&location=Boston", * success: function(msg){ * alert( "Data Saved: " + msg ); * } * }); * @desc Save some data to the server and notify the user once its complete. * * @name $.ajax * @type XMLHttpRequest * @param Hash prop A set of properties to initialize the request with. * @cat AJAX */ ajax: function( s ) { // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout s = jQuery.extend({ global: true, ifModified: false, type: "GET", timeout: jQuery.timeout, complete: null, success: null, error: null, dataType: null, url: null, data: null, contentType: "application/x-www-form-urlencoded", processData: true, async: true, beforeSend: null }, s); // if data available if ( s.data ) { // convert data if not already a string if (s.processData && typeof s.data != 'string') s.data = jQuery.param(s.data); // append data to url for get requests if( s.type.toLowerCase() == "get" ) // "?" + data or "&" + data (in case there are already params) s.url += ((s.url.indexOf("?") > -1) ? "&" : "?") + s.data; } // Watch for a new set of requests if ( s.global && ! jQuery.active++ ) jQuery.event.trigger( "ajaxStart" ); var requestDone = false; // Create the request object var xml = new XMLHttpRequest(); // Open the socket xml.open(s.type, s.url, s.async); // Set the correct header, if data is being sent if ( s.data ) xml.setRequestHeader("Content-Type", s.contentType); // Set the If-Modified-Since header, if ifModified mode. if ( s.ifModified ) xml.setRequestHeader("If-Modified-Since", jQuery.lastModified[s.url] || "Thu, 01 Jan 1970 00:00:00 GMT" ); // Set header so the called script knows that it's an XMLHttpRequest xml.setRequestHeader("X-Requested-With", "XMLHttpRequest"); // Make sure the browser sends the right content length if ( xml.overrideMimeType ) xml.setRequestHeader("Connection", "close"); // Allow custom headers/mimetypes if( s.beforeSend ) s.beforeSend(xml); if (s.global) jQuery.event.trigger("ajaxSend", [xml, s]); // Wait for a response to come back var onreadystatechange = function(isTimeout){ // The transfer is complete and the data is available, or the request timed out if ( xml && (xml.readyState == 4 || isTimeout == "timeout") ) { requestDone = true; var status = jQuery.httpSuccess( xml ) && isTimeout != "timeout" ? s.ifModified && jQuery.httpNotModified( xml, s.url ) ? "notmodified" : "success" : "error"; // Make sure that the request was successful or notmodified if ( status != "error" ) { // Cache Last-Modified header, if ifModified mode. var modRes; try { modRes = xml.getResponseHeader("Last-Modified"); } catch(e) {} // swallow exception thrown by FF if header is not available if ( s.ifModified && modRes ) jQuery.lastModified[s.url] = modRes; // process the data (runs the xml through httpData regardless of callback) var data = jQuery.httpData( xml, s.dataType ); // If a local callback was specified, fire it and pass it the data if ( s.success ) s.success( data, status ); // Fire the global callback if( s.global ) jQuery.event.trigger( "ajaxSuccess", [xml, s] ); // Otherwise, the request was not successful } else { // If a local callback was specified, fire it if ( s.error ) s.error( xml, status ); // Fire the global callback if( s.global ) jQuery.event.trigger( "ajaxError", [xml, s] ); } // The request was completed if( s.global ) jQuery.event.trigger( "ajaxComplete", [xml, s] ); // Handle the global AJAX counter if ( s.global && ! --jQuery.active ) jQuery.event.trigger( "ajaxStop" ); // Process result if ( s.complete ) s.complete(xml, status); // Stop memory leaks xml.onreadystatechange = function(){}; xml = null; } }; xml.onreadystatechange = onreadystatechange; // Timeout checker if(s.timeout > 0) setTimeout(function(){ // Check to see if the request is still happening if (xml) { // Cancel the request xml.abort(); if ( !requestDone ) onreadystatechange( "timeout" ); // Clear from memory xml = null; } }, s.timeout); // Send the data xml.send(s.data); // return XMLHttpRequest to allow aborting the request etc. return xml; }, // Counter for holding the number of active queries active: 0, // Determines if an XMLHttpRequest was successful or not httpSuccess: function(r) { try { return !r.status && location.protocol == "file:" || ( r.status >= 200 && r.status < 300 ) || r.status == 304 || jQuery.browser.safari && r.status == undefined; } catch(e){} return false; }, // Determines if an XMLHttpRequest returns NotModified httpNotModified: function(xml, url) { try { var xmlRes = xml.getResponseHeader("Last-Modified"); // Firefox always returns 200. check Last-Modified date return xml.status == 304 || xmlRes == jQuery.lastModified[url] || jQuery.browser.safari && xml.status == undefined; } catch(e){} return false; }, /* Get the data out of an XMLHttpRequest. * Return parsed XML if content-type header is "xml" and type is "xml" or omitted, * otherwise return plain text. * (String) data - The type of data that you're expecting back, * (e.g. "xml", "html", "script") */ httpData: function(r,type) { var ct = r.getResponseHeader("content-type"); var data = !type && ct && ct.indexOf("xml") >= 0; data = type == "xml" || data ? r.responseXML : r.responseText; // If the type is "script", eval it in global context if ( type == "script" ) { jQuery.globalEval( data ); } // Get the JavaScript object, if JSON is used. if ( type == "json" ) eval( "data = " + data ); // evaluate scripts within html if ( type == "html" ) jQuery("
    ").html(data).evalScripts(); return data; }, // Serialize an array of form elements or a set of // key/values into a query string param: function(a) { var s = []; // If an array was passed in, assume that it is an array // of form elements if ( a.constructor == Array || a.jquery ) { // Serialize the form elements for ( var i = 0; i < a.length; i++ ) s.push( a[i].name + "=" + encodeURIComponent( a[i].value ) ); // Otherwise, assume that it's an object of key/value pairs } else { // Serialize the key/values for ( var j in a ) { // If the value is an array then the key names need to be repeated if( a[j].constructor == Array ) { for (var k = 0; k < a[j].length; k++) { s.push( j + "=" + encodeURIComponent( a[j][k] ) ); } } else { s.push( j + "=" + encodeURIComponent( a[j] ) ); } } } // Return the resulting serialization return s.join("&"); }, // evalulates a script in global context // not reliable for safari globalEval: function(data) { if (window.execScript) window.execScript( data ); else if(jQuery.browser.safari) // safari doesn't provide a synchronous global eval window.setTimeout( data, 0 ); else eval.call( window, data ); } });