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