ScriptTagProxy.js
上传用户:shuoshiled
上传日期:2018-01-28
资源大小:10124k
文件大小:11k
源码类别:

中间件编程

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.0.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.data.ScriptTagProxy
  3.  * @extends Ext.data.DataProxy
  4.  * An implementation of Ext.data.DataProxy that reads a data object from a URL which may be in a domain
  5.  * other than the originating domain of the running page.<br>
  6.  * <p>
  7.  * <b>Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain
  8.  * of the running page, you must use this class, rather than HttpProxy.</b><br>
  9.  * <p>
  10.  * The content passed back from a server resource requested by a ScriptTagProxy <b>must</b> be executable JavaScript
  11.  * source code because it is used as the source inside a &lt;script> tag.<br>
  12.  * <p>
  13.  * In order for the browser to process the returned data, the server must wrap the data object
  14.  * with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy.
  15.  * Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy
  16.  * depending on whether the callback name was passed:
  17.  * <p>
  18.  * <pre><code>
  19. boolean scriptTag = false;
  20. String cb = request.getParameter("callback");
  21. if (cb != null) {
  22.     scriptTag = true;
  23.     response.setContentType("text/javascript");
  24. } else {
  25.     response.setContentType("application/x-json");
  26. }
  27. Writer out = response.getWriter();
  28. if (scriptTag) {
  29.     out.write(cb + "(");
  30. }
  31. out.print(dataBlock.toJsonString());
  32. if (scriptTag) {
  33.     out.write(");");
  34. }
  35. </code></pre>
  36.  *
  37.  * @constructor
  38.  * @param {Object} config A configuration object.
  39.  */
  40. Ext.data.ScriptTagProxy = function(config){
  41.     Ext.apply(this, config);
  42.     Ext.data.ScriptTagProxy.superclass.constructor.call(this, config);
  43.     this.head = document.getElementsByTagName("head")[0];
  44.     /**
  45.      * @event loadexception
  46.      * <b>Deprecated</b> in favor of 'exception' event.
  47.      * Fires if an exception occurs in the Proxy during data loading.  This event can be fired for one of two reasons:
  48.      * <ul><li><b>The load call timed out.</b>  This means the load callback did not execute within the time limit
  49.      * specified by {@link #timeout}.  In this case, this event will be raised and the
  50.      * fourth parameter (read error) will be null.</li>
  51.      * <li><b>The load succeeded but the reader could not read the response.</b>  This means the server returned
  52.      * data, but the configured Reader threw an error while reading the data.  In this case, this event will be
  53.      * raised and the caught error will be passed along as the fourth parameter of this event.</li></ul>
  54.      * Note that this event is also relayed through {@link Ext.data.Store}, so you can listen for it directly
  55.      * on any Store instance.
  56.      * @param {Object} this
  57.      * @param {Object} options The loading options that were specified (see {@link #load} for details).  If the load
  58.      * call timed out, this parameter will be null.
  59.      * @param {Object} arg The callback's arg object passed to the {@link #load} function
  60.      * @param {Error} e The JavaScript Error object caught if the configured Reader could not read the data.
  61.      * If the remote request returns success: false, this parameter will be null.
  62.      */
  63. };
  64. Ext.data.ScriptTagProxy.TRANS_ID = 1000;
  65. Ext.extend(Ext.data.ScriptTagProxy, Ext.data.DataProxy, {
  66.     /**
  67.      * @cfg {String} url The URL from which to request the data object.
  68.      */
  69.     /**
  70.      * @cfg {Number} timeout (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.
  71.      */
  72.     timeout : 30000,
  73.     /**
  74.      * @cfg {String} callbackParam (Optional) The name of the parameter to pass to the server which tells
  75.      * the server the name of the callback function set up by the load call to process the returned data object.
  76.      * Defaults to "callback".<p>The server-side processing must read this parameter value, and generate
  77.      * javascript output which calls this named function passing the data object as its only parameter.
  78.      */
  79.     callbackParam : "callback",
  80.     /**
  81.      *  @cfg {Boolean} nocache (optional) Defaults to true. Disable caching by adding a unique parameter
  82.      * name to the request.
  83.      */
  84.     nocache : true,
  85.     /**
  86.      * HttpProxy implementation of DataProxy#doRequest
  87.      * @param {String} action
  88.      * @param {Ext.data.Record/Ext.data.Record[]} rs If action is <tt>read</tt>, rs will be null
  89.      * @param {Object} params An object containing properties which are to be used as HTTP parameters
  90.      * for the request to the remote server.
  91.      * @param {Ext.data.DataReader} reader The Reader object which converts the data
  92.      * object into a block of Ext.data.Records.
  93.      * @param {Function} callback The function into which to pass the block of Ext.data.Records.
  94.      * The function must be passed <ul>
  95.      * <li>The Record block object</li>
  96.      * <li>The "arg" argument from the load function</li>
  97.      * <li>A boolean success indicator</li>
  98.      * </ul>
  99.      * @param {Object} scope The scope in which to call the callback
  100.      * @param {Object} arg An optional argument which is passed to the callback as its second parameter.
  101.      */
  102.     doRequest : function(action, rs, params, reader, callback, scope, arg) {
  103.         var p = Ext.urlEncode(Ext.apply(params, this.extraParams));
  104.         var url = this.buildUrl(action, rs);
  105.         if (!url) {
  106.             throw new Ext.data.Api.Error('invalid-url', url);
  107.         }
  108.         url = Ext.urlAppend(url, p);
  109.         if(this.nocache){
  110.             url = Ext.urlAppend(url, '_dc=' + (new Date().getTime()));
  111.         }
  112.         var transId = ++Ext.data.ScriptTagProxy.TRANS_ID;
  113.         var trans = {
  114.             id : transId,
  115.             action: action,
  116.             cb : "stcCallback"+transId,
  117.             scriptId : "stcScript"+transId,
  118.             params : params,
  119.             arg : arg,
  120.             url : url,
  121.             callback : callback,
  122.             scope : scope,
  123.             reader : reader
  124.         };
  125.         window[trans.cb] = this.createCallback(action, rs, trans);
  126.         url += String.format("&{0}={1}", this.callbackParam, trans.cb);
  127.         if(this.autoAbort !== false){
  128.             this.abort();
  129.         }
  130.         trans.timeoutId = this.handleFailure.defer(this.timeout, this, [trans]);
  131.         var script = document.createElement("script");
  132.         script.setAttribute("src", url);
  133.         script.setAttribute("type", "text/javascript");
  134.         script.setAttribute("id", trans.scriptId);
  135.         this.head.appendChild(script);
  136.         this.trans = trans;
  137.     },
  138.     // @private createCallback
  139.     createCallback : function(action, rs, trans) {
  140.         var self = this;
  141.         return function(res) {
  142.             self.trans = false;
  143.             self.destroyTrans(trans, true);
  144.             if (action === Ext.data.Api.actions.read) {
  145.                 self.onRead.call(self, action, trans, res);
  146.             } else {
  147.                 self.onWrite.call(self, action, trans, res, rs);
  148.             }
  149.         };
  150.     },
  151.     /**
  152.      * Callback for read actions
  153.      * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
  154.      * @param {Object} trans The request transaction object
  155.      * @param {Object} res The server response
  156.      * @private
  157.      */
  158.     onRead : function(action, trans, res) {
  159.         var result;
  160.         try {
  161.             result = trans.reader.readRecords(res);
  162.         }catch(e){
  163.             // @deprecated: fire loadexception
  164.             this.fireEvent("loadexception", this, trans, res, e);
  165.             this.fireEvent('exception', this, 'response', action, trans, res, e);
  166.             trans.callback.call(trans.scope||window, null, trans.arg, false);
  167.             return;
  168.         }
  169.         if (result.success === false) {
  170.             // @deprecated: fire old loadexception for backwards-compat.
  171.             this.fireEvent('loadexception', this, trans, res);
  172.             this.fireEvent('exception', this, 'remote', action, trans, res, null);
  173.         } else {
  174.             this.fireEvent("load", this, res, trans.arg);
  175.         }
  176.         trans.callback.call(trans.scope||window, result, trans.arg, result.success);
  177.     },
  178.     /**
  179.      * Callback for write actions
  180.      * @param {String} action [Ext.data.Api.actions.create|read|update|destroy]
  181.      * @param {Object} trans The request transaction object
  182.      * @param {Object} res The server response
  183.      * @private
  184.      */
  185.     onWrite : function(action, trans, res, rs) {
  186.         var reader = trans.reader;
  187.         try {
  188.             // though we already have a response object here in STP, run through readResponse to catch any meta-data exceptions.
  189.             reader.readResponse(action, res);
  190.         } catch (e) {
  191.             this.fireEvent('exception', this, 'response', action, trans, res, e);
  192.             trans.callback.call(trans.scope||window, null, res, false);
  193.             return;
  194.         }
  195.         if(!res[reader.meta.successProperty] === true){
  196.             this.fireEvent('exception', this, 'remote', action, trans, res, rs);
  197.             trans.callback.call(trans.scope||window, null, res, false);
  198.             return;
  199.         }
  200.         this.fireEvent("write", this, action, res[reader.meta.root], res, rs, trans.arg );
  201.         trans.callback.call(trans.scope||window, res[reader.meta.root], res, true);
  202.     },
  203.     // private
  204.     isLoading : function(){
  205.         return this.trans ? true : false;
  206.     },
  207.     /**
  208.      * Abort the current server request.
  209.      */
  210.     abort : function(){
  211.         if(this.isLoading()){
  212.             this.destroyTrans(this.trans);
  213.         }
  214.     },
  215.     // private
  216.     destroyTrans : function(trans, isLoaded){
  217.         this.head.removeChild(document.getElementById(trans.scriptId));
  218.         clearTimeout(trans.timeoutId);
  219.         if(isLoaded){
  220.             window[trans.cb] = undefined;
  221.             try{
  222.                 delete window[trans.cb];
  223.             }catch(e){}
  224.         }else{
  225.             // if hasn't been loaded, wait for load to remove it to prevent script error
  226.             window[trans.cb] = function(){
  227.                 window[trans.cb] = undefined;
  228.                 try{
  229.                     delete window[trans.cb];
  230.                 }catch(e){}
  231.             };
  232.         }
  233.     },
  234.     // private
  235.     handleFailure : function(trans){
  236.         this.trans = false;
  237.         this.destroyTrans(trans, false);
  238.         if (trans.action === Ext.data.Api.actions.read) {
  239.             // @deprecated firing loadexception
  240.             this.fireEvent("loadexception", this, null, trans.arg);
  241.         }
  242.         this.fireEvent('exception', this, 'response', trans.action, {
  243.             response: null,
  244.             options: trans.arg
  245.         });
  246.         trans.callback.call(trans.scope||window, null, trans.arg, false);
  247.     },
  248.     // inherit docs
  249.     destroy: function(){
  250.         this.abort();
  251.         Ext.data.ScriptTagProxy.superclass.destroy.call(this);
  252.     }
  253. });