HttpProxy.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:11k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.data.HttpProxy
  3.  * @extends Ext.data.DataProxy
  4.  * <p>An implementation of {@link Ext.data.DataProxy} that processes data requests within the same
  5.  * domain of the originating page.</p>
  6.  * <p><b>Note</b>: this class cannot be used to retrieve data from a domain other
  7.  * than the domain from which the running page was served. For cross-domain requests, use a
  8.  * {@link Ext.data.ScriptTagProxy ScriptTagProxy}.</p>
  9.  * <p>Be aware that to enable the browser to parse an XML document, the server must set
  10.  * the Content-Type header in the HTTP response to "<tt>text/xml</tt>".</p>
  11.  * @constructor
  12.  * @param {Object} conn
  13.  * An {@link Ext.data.Connection} object, or options parameter to {@link Ext.Ajax#request}.
  14.  * <p>Note that if this HttpProxy is being used by a {@link Ext.data.Store Store}, then the
  15.  * Store's call to {@link #load} will override any specified <tt>callback</tt> and <tt>params</tt>
  16.  * options. In this case, use the Store's {@link Ext.data.Store#events events} to modify parameters,
  17.  * or react to loading events. The Store's {@link Ext.data.Store#baseParams baseParams} may also be
  18.  * used to pass parameters known at instantiation time.</p>
  19.  * <p>If an options parameter is passed, the singleton {@link Ext.Ajax} object will be used to make
  20.  * the request.</p>
  21.  */
  22. Ext.data.HttpProxy = function(conn){
  23.     Ext.data.HttpProxy.superclass.constructor.call(this, conn);
  24.     /**
  25.      * The Connection object (Or options parameter to {@link Ext.Ajax#request}) which this HttpProxy
  26.      * uses to make requests to the server. Properties of this object may be changed dynamically to
  27.      * change the way data is requested.
  28.      * @property
  29.      */
  30.     this.conn = conn;
  31.     // nullify the connection url.  The url param has been copied to 'this' above.  The connection
  32.     // url will be set during each execution of doRequest when buildUrl is called.  This makes it easier for users to override the
  33.     // connection url during beforeaction events (ie: beforeload, beforewrite, etc).
  34.     // Url is always re-defined during doRequest.
  35.     this.conn.url = null;
  36.     this.useAjax = !conn || !conn.events;
  37.     // A hash containing active requests, keyed on action [Ext.data.Api.actions.create|read|update|destroy]
  38.     var actions = Ext.data.Api.actions;
  39.     this.activeRequest = {};
  40.     for (var verb in actions) {
  41.         this.activeRequest[actions[verb]] = undefined;
  42.     }
  43. };
  44. Ext.extend(Ext.data.HttpProxy, Ext.data.DataProxy, {
  45.     /**
  46.      * Return the {@link Ext.data.Connection} object being used by this Proxy.
  47.      * @return {Connection} The Connection object. This object may be used to subscribe to events on
  48.      * a finer-grained basis than the DataProxy events.
  49.      */
  50.     getConnection : function() {
  51.         return this.useAjax ? Ext.Ajax : this.conn;
  52.     },
  53.     /**
  54.      * Used for overriding the url used for a single request.  Designed to be called during a beforeaction event.  Calling setUrl
  55.      * will override any urls set via the api configuration parameter.  Set the optional parameter makePermanent to set the url for
  56.      * all subsequent requests.  If not set to makePermanent, the next request will use the same url or api configuration defined
  57.      * in the initial proxy configuration.
  58.      * @param {String} url
  59.      * @param {Boolean} makePermanent (Optional) [false]
  60.      *
  61.      * (e.g.: beforeload, beforesave, etc).
  62.      */
  63.     setUrl : function(url, makePermanent) {
  64.         this.conn.url = url;
  65.         if (makePermanent === true) {
  66.             this.url = url;
  67.             this.api = null;
  68.             Ext.data.Api.prepare(this);
  69.         }
  70.     },
  71.     /**
  72.      * HttpProxy implementation of DataProxy#doRequest
  73.      * @param {String} action The crud action type (create, read, update, destroy)
  74.      * @param {Ext.data.Record/Ext.data.Record[]} rs If action is load, rs will be null
  75.      * @param {Object} params An object containing properties which are to be used as HTTP parameters
  76.      * for the request to the remote server.
  77.      * @param {Ext.data.DataReader} reader The Reader object which converts the data
  78.      * object into a block of Ext.data.Records.
  79.      * @param {Function} callback
  80.      * <div class="sub-desc"><p>A function to be called after the request.
  81.      * The <tt>callback</tt> is passed the following arguments:<ul>
  82.      * <li><tt>r</tt> : Ext.data.Record[] The block of Ext.data.Records.</li>
  83.      * <li><tt>options</tt>: Options object from the action request</li>
  84.      * <li><tt>success</tt>: Boolean success indicator</li></ul></p></div>
  85.      * @param {Object} scope The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.
  86.      * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
  87.      * @protected
  88.      */
  89.     doRequest : function(action, rs, params, reader, cb, scope, arg) {
  90.         var  o = {
  91.             method: (this.api[action]) ? this.api[action]['method'] : undefined,
  92.             request: {
  93.                 callback : cb,
  94.                 scope : scope,
  95.                 arg : arg
  96.             },
  97.             reader: reader,
  98.             callback : this.createCallback(action, rs),
  99.             scope: this
  100.         };
  101.         // If possible, transmit data using jsonData || xmlData on Ext.Ajax.request (An installed DataWriter would have written it there.).
  102.         // Use std HTTP params otherwise.
  103.         if (params.jsonData) {
  104.             o.jsonData = params.jsonData;
  105.         } else if (params.xmlData) {
  106.             o.xmlData = params.xmlData;
  107.         } else {
  108.             o.params = params || {};
  109.         }
  110.         // Set the connection url.  If this.conn.url is not null here,
  111.         // the user must have overridden the url during a beforewrite/beforeload event-handler.
  112.         // this.conn.url is nullified after each request.
  113.         this.conn.url = this.buildUrl(action, rs);
  114.         if(this.useAjax){
  115.             Ext.applyIf(o, this.conn);
  116.             // If a currently running request is found for this action, abort it.
  117.             if (this.activeRequest[action]) {
  118.                 ////
  119.                 // Disabled aborting activeRequest while implementing REST.  activeRequest[action] will have to become an array
  120.                 // TODO ideas anyone?
  121.                 //
  122.                 //Ext.Ajax.abort(this.activeRequest[action]);
  123.             }
  124.             this.activeRequest[action] = Ext.Ajax.request(o);
  125.         }else{
  126.             this.conn.request(o);
  127.         }
  128.         // request is sent, nullify the connection url in preparation for the next request
  129.         this.conn.url = null;
  130.     },
  131.     /**
  132.      * Returns a callback function for a request.  Note a special case is made for the
  133.      * read action vs all the others.
  134.      * @param {String} action [create|update|delete|load]
  135.      * @param {Ext.data.Record[]} rs The Store-recordset being acted upon
  136.      * @private
  137.      */
  138.     createCallback : function(action, rs) {
  139.         return function(o, success, response) {
  140.             this.activeRequest[action] = undefined;
  141.             if (!success) {
  142.                 if (action === Ext.data.Api.actions.read) {
  143.                     // @deprecated: fire loadexception for backwards compat.
  144.                     // TODO remove in 3.1
  145.                     this.fireEvent('loadexception', this, o, response);
  146.                 }
  147.                 this.fireEvent('exception', this, 'response', action, o, response);
  148.                 o.request.callback.call(o.request.scope, null, o.request.arg, false);
  149.                 return;
  150.             }
  151.             if (action === Ext.data.Api.actions.read) {
  152.                 this.onRead(action, o, response);
  153.             } else {
  154.                 this.onWrite(action, o, response, rs);
  155.             }
  156.         }
  157.     },
  158.     /**
  159.      * Callback for read action
  160.      * @param {String} action Action name as per {@link Ext.data.Api.actions#read}.
  161.      * @param {Object} o The request transaction object
  162.      * @param {Object} res The server response
  163.      * @fires loadexception (deprecated)
  164.      * @fires exception
  165.      * @fires load
  166.      * @protected
  167.      */
  168.     onRead : function(action, o, response) {
  169.         var result;
  170.         try {
  171.             result = o.reader.read(response);
  172.         }catch(e){
  173.             // @deprecated: fire old loadexception for backwards-compat.
  174.             // TODO remove in 3.1
  175.             this.fireEvent('loadexception', this, o, response, e);
  176.             this.fireEvent('exception', this, 'response', action, o, response, e);
  177.             o.request.callback.call(o.request.scope, null, o.request.arg, false);
  178.             return;
  179.         }
  180.         if (result.success === false) {
  181.             // @deprecated: fire old loadexception for backwards-compat.
  182.             // TODO remove in 3.1
  183.             this.fireEvent('loadexception', this, o, response);
  184.             // Get DataReader read-back a response-object to pass along to exception event
  185.             var res = o.reader.readResponse(action, response);
  186.             this.fireEvent('exception', this, 'remote', action, o, res, null);
  187.         }
  188.         else {
  189.             this.fireEvent('load', this, o, o.request.arg);
  190.         }
  191.         // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance
  192.         // the calls to request.callback(...) in each will have to be made identical.
  193.         // NOTE reader.readResponse does not currently return Ext.data.Response
  194.         o.request.callback.call(o.request.scope, result, o.request.arg, result.success);
  195.     },
  196.     /**
  197.      * Callback for write actions
  198.      * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
  199.      * @param {Object} trans The request transaction object
  200.      * @param {Object} res The server response
  201.      * @fires exception
  202.      * @fires write
  203.      * @protected
  204.      */
  205.     onWrite : function(action, o, response, rs) {
  206.         var reader = o.reader;
  207.         var res;
  208.         try {
  209.             res = reader.readResponse(action, response);
  210.         } catch (e) {
  211.             this.fireEvent('exception', this, 'response', action, o, response, e);
  212.             o.request.callback.call(o.request.scope, null, o.request.arg, false);
  213.             return;
  214.         }
  215.         if (res.success === false) {
  216.             this.fireEvent('exception', this, 'remote', action, o, res, rs);
  217.         } else {
  218.             this.fireEvent('write', this, action, res.data, res, rs, o.request.arg);
  219.         }
  220.         // TODO refactor onRead, onWrite to be more generalized now that we're dealing with Ext.data.Response instance
  221.         // the calls to request.callback(...) in each will have to be made similar.
  222.         // NOTE reader.readResponse does not currently return Ext.data.Response
  223.         o.request.callback.call(o.request.scope, res.data, res, res.success);
  224.     },
  225.     // inherit docs
  226.     destroy: function(){
  227.         if(!this.useAjax){
  228.             this.conn.abort();
  229.         }else if(this.activeRequest){
  230.             var actions = Ext.data.Api.actions;
  231.             for (var verb in actions) {
  232.                 if(this.activeRequest[actions[verb]]){
  233.                     Ext.Ajax.abort(this.activeRequest[actions[verb]]);
  234.                 }
  235.             }
  236.         }
  237.         Ext.data.HttpProxy.superclass.destroy.call(this);
  238.     }
  239. });