Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / source / data / Connection.js
diff --git a/source/data/Connection.js b/source/data/Connection.js
deleted file mode 100644 (file)
index 7fd0678..0000000
+++ /dev/null
@@ -1,511 +0,0 @@
-/*\r
- * Ext JS Library 2.2.1\r
- * Copyright(c) 2006-2009, Ext JS, LLC.\r
- * licensing@extjs.com\r
- * \r
- * http://extjs.com/license\r
- */\r
-\r
-/**\r
- * @class Ext.data.Connection\r
- * @extends Ext.util.Observable\r
- * <p>The class encapsulates a connection to the page's originating domain, allowing requests to be made\r
- * either to a configured URL, or to a URL specified at request time.</p>\r
- * <p>Requests made by this class are asynchronous, and will return immediately. No data from\r
- * the server will be available to the statement immediately following the {@link #request} call.\r
- * To process returned data, use a\r
- * <a href="#request-option-success" ext:member="request-option-success" ext:cls="Ext.data.Connection">success callback</a>\r
- * in the request options object,\r
- * or an {@link #requestcomplete event listener}.</p>\r
- * <p><h3>File Uploads</h3><a href="#request-option-isUpload" ext:member="request-option-isUpload" ext:cls="Ext.data.Connection">File uploads</a> are not performed using normal "Ajax" techniques, that\r
- * is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard\r
- * manner with the DOM <tt>&lt;form></tt> element temporarily modified to have its\r
- * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
- * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
- * but removed after the return data has been gathered.</p>\r
- * <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
- * server is using JSON to send the return object, then the\r
- * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
- * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
- * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode\r
- * "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>\r
- * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
- * is created containing a <tt>responseText</tt> property in order to conform to the\r
- * requirements of event handlers and callbacks.</p>\r
- * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
- * and some server technologies (notably JEE) may require some custom processing in order to\r
- * retrieve parameter names and parameter values from the packet content.</p>\r
- * @constructor\r
- * @param {Object} config a configuration object.\r
- */\r
-Ext.data.Connection = function(config){\r
-    Ext.apply(this, config);\r
-    this.addEvents(\r
-        /**\r
-         * @event beforerequest\r
-         * Fires before a network request is made to retrieve a data object.\r
-         * @param {Connection} conn This Connection object.\r
-         * @param {Object} options The options config object passed to the {@link #request} method.\r
-         */\r
-        "beforerequest",\r
-        /**\r
-         * @event requestcomplete\r
-         * Fires if the request was successfully completed.\r
-         * @param {Connection} conn This Connection object.\r
-         * @param {Object} response The XHR object containing the response data.\r
-         * See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
-         * for details.\r
-         * @param {Object} options The options config object passed to the {@link #request} method.\r
-         */\r
-        "requestcomplete",\r
-        /**\r
-         * @event requestexception\r
-         * Fires if an error HTTP status was returned from the server.\r
-         * See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
-         * for details of HTTP status codes.\r
-         * @param {Connection} conn This Connection object.\r
-         * @param {Object} response The XHR object containing the response data.\r
-         * See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
-         * for details.\r
-         * @param {Object} options The options config object passed to the {@link #request} method.\r
-         */\r
-        "requestexception"\r
-    );\r
-    Ext.data.Connection.superclass.constructor.call(this);\r
-};\r
-\r
-Ext.extend(Ext.data.Connection, Ext.util.Observable, {\r
-    /**\r
-     * @cfg {String} url (Optional) The default URL to be used for requests to the server. (defaults to undefined)\r
-     */\r
-    /**\r
-     * @cfg {Object} extraParams (Optional) An object containing properties which are used as\r
-     * extra parameters to each request made by this object. (defaults to undefined)\r
-     */\r
-    /**\r
-     * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added\r
-     *  to each request made by this object. (defaults to undefined)\r
-     */\r
-    /**\r
-     * @cfg {String} method (Optional) The default HTTP method to be used for requests.\r
-     * (defaults to undefined; if not set, but {@link #request} params are present, POST will be used;\r
-     * otherwise, GET will be used.)\r
-     */\r
-    /**\r
-     * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)\r
-     */\r
-    timeout : 30000,\r
-    /**\r
-     * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false)\r
-     * @type Boolean\r
-     */\r
-    autoAbort:false,\r
-\r
-    /**\r
-     * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true)\r
-     * @type Boolean\r
-     */\r
-    disableCaching: true,\r
-    \r
-    /**\r
-     * @cfg {String} disableCachingParam (Optional) Change the parameter which is sent went disabling caching\r
-     * through a cache buster. Defaults to '_dc'\r
-     * @type String\r
-     */\r
-    disableCachingParam: '_dc',\r
-    \r
-\r
-    /**\r
-     * <p>Sends an HTTP request to a remote server.</p>\r
-     * <p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
-     * return before the response has been received. Process any returned data\r
-     * in a callback function.</p>\r
-     * <p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p>\r
-     * @param {Object} options An object which may contain the following properties:<ul>\r
-     * <li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
-     * which to send the request, or a function to call which returns a URL string. The scope of the\r
-     * function is specified by the <tt>scope</tt> option. Defaults to configured URL.</div></li>\r
-     * <li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
-     * An object containing properties which are used as parameters to the\r
-     * request, a url encoded string or a function to call to get either. The scope of the function\r
-     * is specified by the <tt>scope</tt> option.</div></li>\r
-     * <li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
-     * for the request. Defaults to the configured method, or if no method was configured,\r
-     * "GET" if no parameters are being sent, and "POST" if parameters are being sent.  Note that\r
-     * the method name is case-sensitive and should be all caps.</div></li>\r
-     * <li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
-     * function to be called upon receipt of the HTTP response. The callback is\r
-     * called regardless of success or failure and is passed the following\r
-     * parameters:<ul>\r
-     * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-     * <li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
-     * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data. \r
-     * See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about \r
-     * accessing elements of the response.</div></li>\r
-     * </ul></div></li>\r
-     * <li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
-     * to be called upon success of the request. The callback is passed the following\r
-     * parameters:<ul>\r
-     * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-     * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-     * </ul></div></li>\r
-     * <li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
-     * to be called upon failure of the request. The callback is passed the\r
-     * following parameters:<ul>\r
-     * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-     * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-     * </ul></div></li>\r
-     * <li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
-     * which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
-     * specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
-     * Defaults to the browser window.</div></li>\r
-     * <li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt>&lt;form&gt;</tt>\r
-     * Element or the id of the <tt>&lt;form&gt;</tt> to pull parameters from.</div></li>\r
-     * <li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used \r
-     * with the <tt>form</tt> option.</b>\r
-     * <p>True if the form object is a file upload (will be set automatically if the form was\r
-     * configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
-     * <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
-     * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
-     * DOM <tt>&lt;form></tt> element temporarily modified to have its\r
-     * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
-     * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
-     * but removed after the return data has been gathered.</p>\r
-     * <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
-     * server is using JSON to send the return object, then the\r
-     * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
-     * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
-     * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
-     * is created containing a <tt>responseText</tt> property in order to conform to the\r
-     * requirements of event handlers and callbacks.</p>\r
-     * <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
-     * and some server technologies (notably JEE) may require some custom processing in order to\r
-     * retrieve parameter names and parameter values from the packet content.</p>\r
-     * </div></li>\r
-     * <li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
-     * headers to set for the request.</div></li>\r
-     * <li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
-     * to use for the post. Note: This will be used instead of params for the post\r
-     * data. Any params will be appended to the URL.</div></li>\r
-     * <li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
-     * data to use as the post. Note: This will be used instead of params for the post\r
-     * data. Any params will be appended to the URL.</div></li>\r
-     * <li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
-     * to add a unique cache-buster param to GET requests.</div></li>\r
-     * </ul></p>\r
-     * <p>The options object may also contain any other property which might be needed to perform\r
-     * postprocessing in a callback because it is passed to callback functions.</p>\r
-     * @return {Number} transactionId The id of the server transaction. This may be used\r
-     * to cancel the request.\r
-     */\r
-    request : function(o){\r
-        if(this.fireEvent("beforerequest", this, o) !== false){\r
-            var p = o.params;\r
-\r
-            if(typeof p == "function"){\r
-                p = p.call(o.scope||window, o);\r
-            }\r
-            if(typeof p == "object"){\r
-                p = Ext.urlEncode(p);\r
-            }\r
-            if(this.extraParams){\r
-                var extras = Ext.urlEncode(this.extraParams);\r
-                p = p ? (p + '&' + extras) : extras;\r
-            }\r
-\r
-            var url = o.url || this.url;\r
-            if(typeof url == 'function'){\r
-                url = url.call(o.scope||window, o);\r
-            }\r
-\r
-            if(o.form){\r
-                var form = Ext.getDom(o.form);\r
-                url = url || form.action;\r
-\r
-                var enctype = form.getAttribute("enctype");\r
-                if(o.isUpload || (enctype && enctype.toLowerCase() == 'multipart/form-data')){\r
-                    return this.doFormUpload(o, p, url);\r
-                }\r
-                var f = Ext.lib.Ajax.serializeForm(form);\r
-                p = p ? (p + '&' + f) : f;\r
-            }\r
-\r
-            var hs = o.headers;\r
-            if(this.defaultHeaders){\r
-                hs = Ext.apply(hs || {}, this.defaultHeaders);\r
-                if(!o.headers){\r
-                    o.headers = hs;\r
-                }\r
-            }\r
-\r
-            var cb = {\r
-                success: this.handleResponse,\r
-                failure: this.handleFailure,\r
-                scope: this,\r
-                argument: {options: o},\r
-                timeout : o.timeout || this.timeout\r
-            };\r
-\r
-            var method = o.method||this.method||((p || o.xmlData || o.jsonData) ? "POST" : "GET");\r
-\r
-            if(method == 'GET' && (this.disableCaching && o.disableCaching !== false) || o.disableCaching === true){\r
-                var dcp = o.disableCachingParam || this.disableCachingParam;\r
-                url += (url.indexOf('?') != -1 ? '&' : '?') + dcp + '=' + (new Date().getTime());\r
-            }\r
-\r
-            if(typeof o.autoAbort == 'boolean'){ // options gets top priority\r
-                if(o.autoAbort){\r
-                    this.abort();\r
-                }\r
-            }else if(this.autoAbort !== false){\r
-                this.abort();\r
-            }\r
-            if((method == 'GET' || o.xmlData || o.jsonData) && p){\r
-                url += (url.indexOf('?') != -1 ? '&' : '?') + p;\r
-                p = '';\r
-            }\r
-            this.transId = Ext.lib.Ajax.request(method, url, cb, p, o);\r
-            return this.transId;\r
-        }else{\r
-            Ext.callback(o.callback, o.scope, [o, null, null]);\r
-            return null;\r
-        }\r
-    },\r
-\r
-    /**\r
-     * Determine whether this object has a request outstanding.\r
-     * @param {Number} transactionId (Optional) defaults to the last transaction\r
-     * @return {Boolean} True if there is an outstanding request.\r
-     */\r
-    isLoading : function(transId){\r
-        if(transId){\r
-            return Ext.lib.Ajax.isCallInProgress(transId);\r
-        }else{\r
-            return this.transId ? true : false;\r
-        }\r
-    },\r
-\r
-    /**\r
-     * Aborts any outstanding request.\r
-     * @param {Number} transactionId (Optional) defaults to the last transaction\r
-     */\r
-    abort : function(transId){\r
-        if(transId || this.isLoading()){\r
-            Ext.lib.Ajax.abort(transId || this.transId);\r
-        }\r
-    },\r
-\r
-    // private\r
-    handleResponse : function(response){\r
-        this.transId = false;\r
-        var options = response.argument.options;\r
-        response.argument = options ? options.argument : null;\r
-        this.fireEvent("requestcomplete", this, response, options);\r
-        Ext.callback(options.success, options.scope, [response, options]);\r
-        Ext.callback(options.callback, options.scope, [options, true, response]);\r
-    },\r
-\r
-    // private\r
-    handleFailure : function(response, e){\r
-        this.transId = false;\r
-        var options = response.argument.options;\r
-        response.argument = options ? options.argument : null;\r
-        this.fireEvent("requestexception", this, response, options, e);\r
-        Ext.callback(options.failure, options.scope, [response, options]);\r
-        Ext.callback(options.callback, options.scope, [options, false, response]);\r
-    },\r
-\r
-    // private\r
-    doFormUpload : function(o, ps, url){\r
-        var id = Ext.id();\r
-        var frame = document.createElement('iframe');\r
-        frame.id = id;\r
-        frame.name = id;\r
-        frame.className = 'x-hidden';\r
-        if(Ext.isIE){\r
-            frame.src = Ext.SSL_SECURE_URL;\r
-        }\r
-        document.body.appendChild(frame);\r
-\r
-        if(Ext.isIE){\r
-           document.frames[id].name = id;\r
-        }\r
-\r
-        var form = Ext.getDom(o.form);\r
-        form.target = id;\r
-        form.method = 'POST';\r
-        form.enctype = form.encoding = 'multipart/form-data';\r
-        if(url){\r
-            form.action = url;\r
-        }\r
-\r
-        var hiddens, hd;\r
-        if(ps){ // add dynamic params\r
-            hiddens = [];\r
-            ps = Ext.urlDecode(ps, false);\r
-            for(var k in ps){\r
-                if(ps.hasOwnProperty(k)){\r
-                    hd = document.createElement('input');\r
-                    hd.type = 'hidden';\r
-                    hd.name = k;\r
-                    hd.value = ps[k];\r
-                    form.appendChild(hd);\r
-                    hiddens.push(hd);\r
-                }\r
-            }\r
-        }\r
-\r
-        function cb(){\r
-            var r = {  // bogus response object\r
-                responseText : '',\r
-                responseXML : null\r
-            };\r
-\r
-            r.argument = o ? o.argument : null;\r
-\r
-            try { //\r
-                var doc;\r
-                if(Ext.isIE){\r
-                    doc = frame.contentWindow.document;\r
-                }else {\r
-                    doc = (frame.contentDocument || window.frames[id].document);\r
-                }\r
-                if(doc && doc.body){\r
-                    r.responseText = doc.body.innerHTML;\r
-                }\r
-                if(doc && doc.XMLDocument){\r
-                    r.responseXML = doc.XMLDocument;\r
-                }else {\r
-                    r.responseXML = doc;\r
-                }\r
-            }\r
-            catch(e) {\r
-                // ignore\r
-            }\r
-\r
-            Ext.EventManager.removeListener(frame, 'load', cb, this);\r
-\r
-            this.fireEvent("requestcomplete", this, r, o);\r
-\r
-            Ext.callback(o.success, o.scope, [r, o]);\r
-            Ext.callback(o.callback, o.scope, [o, true, r]);\r
-\r
-            setTimeout(function(){Ext.removeNode(frame);}, 100);\r
-        }\r
-\r
-        Ext.EventManager.on(frame, 'load', cb, this);\r
-        form.submit();\r
-\r
-        if(hiddens){ // remove dynamic params\r
-            for(var i = 0, len = hiddens.length; i < len; i++){\r
-                Ext.removeNode(hiddens[i]);\r
-            }\r
-        }\r
-    }\r
-});\r
-\r
-/**\r
- * @class Ext.Ajax\r
- * @extends Ext.data.Connection\r
- * Global Ajax request class.  Provides a simple way to make Ajax requests with maximum flexibility.  Example usage:\r
- * <pre><code>\r
-// Basic request\r
-Ext.Ajax.request({\r
-   url: 'foo.php',\r
-   success: someFn,\r
-   failure: otherFn,\r
-   headers: {\r
-       'my-header': 'foo'\r
-   },\r
-   params: { foo: 'bar' }\r
-});\r
-\r
-// Simple ajax form submission\r
-Ext.Ajax.request({\r
-    form: 'some-form',\r
-    params: 'foo=bar'\r
-});\r
-\r
-// Default headers to pass in every request\r
-Ext.Ajax.defaultHeaders = {\r
-    'Powered-By': 'Ext'\r
-};\r
-\r
-// Global Ajax events can be handled on every request!\r
-Ext.Ajax.on('beforerequest', this.showSpinner, this);\r
-</code></pre>\r
- * @singleton\r
- */\r
-Ext.Ajax = new Ext.data.Connection({\r
-    /**\r
-     * @cfg {String} url @hide\r
-     */\r
-    /**\r
-     * @cfg {Object} extraParams @hide\r
-     */\r
-    /**\r
-     * @cfg {Object} defaultHeaders @hide\r
-     */\r
-    /**\r
-     * @cfg {String} method (Optional) @hide\r
-     */\r
-    /**\r
-     * @cfg {Number} timeout (Optional) @hide\r
-     */\r
-    /**\r
-     * @cfg {Boolean} autoAbort (Optional) @hide\r
-     */\r
-\r
-    /**\r
-     * @cfg {Boolean} disableCaching (Optional) @hide\r
-     */\r
-\r
-    /**\r
-     * @property  disableCaching\r
-     * True to add a unique cache-buster param to GET requests. (defaults to true)\r
-     * @type Boolean\r
-     */\r
-    /**\r
-     * @property  url\r
-     * The default URL to be used for requests to the server. (defaults to undefined)\r
-     * @type String\r
-     */\r
-    /**\r
-     * @property  extraParams\r
-     * An object containing properties which are used as\r
-     * extra parameters to each request made by this object. (defaults to undefined)\r
-     * @type Object\r
-     */\r
-    /**\r
-     * @property  defaultHeaders\r
-     * An object containing request headers which are added to each request made by this object. (defaults to undefined)\r
-     * @type Object\r
-     */\r
-    /**\r
-     * @property  method\r
-     * The default HTTP method to be used for requests. Note that this is case-sensitive and should be all caps (defaults\r
-     * to undefined; if not set but parms are present will use "POST," otherwise "GET.")\r
-     * @type String\r
-     */\r
-    /**\r
-     * @property  timeout\r
-     * The timeout in milliseconds to be used for requests. (defaults to 30000)\r
-     * @type Number\r
-     */\r
-\r
-    /**\r
-     * @property  autoAbort\r
-     * Whether a new request should abort any pending requests. (defaults to false)\r
-     * @type Boolean\r
-     */\r
-    autoAbort : false,\r
-\r
-    /**\r
-     * Serialize the passed form into a url encoded string\r
-     * @param {String/HTMLElement} form\r
-     * @return {String}\r
-     */\r
-    serializeForm : function(form){\r
-        return Ext.lib.Ajax.serializeForm(form);\r
-    }\r
-});
\ No newline at end of file