add extjs 6.0.1 sources

[extjs.git] / extjs / packages / ux / src / ajax / SimManager.js

/**\r
 * This singleton manages simulated Ajax responses. This allows application logic to be\r
 * written unaware that its Ajax calls are being handled by simulations ("simlets"). This\r
 * is currently done by hooking {@link Ext.data.Connection} methods, so all users of that\r
 * class (and {@link Ext.Ajax} since it is a derived class) qualify for simulation.\r
 *\r
 * The requires hooks are inserted when either the {@link #init} method is called or the\r
 * first {@link Ext.ux.ajax.Simlet} is registered. For example:\r
 *\r
 *      Ext.onReady(function () {\r
 *          initAjaxSim();\r
 *\r
 *          // normal stuff\r
 *      });\r
 *\r
 *      function initAjaxSim () {\r
 *          Ext.ux.ajax.SimManager.init({\r
 *              delay: 300\r
 *          }).register({\r
 *              '/app/data/url': {\r
 *                  type: 'json',  // use JsonSimlet (type is like xtype for components)\r
 *                  data: [\r
 *                      { foo: 42, bar: 'abc' },\r
 *                      ...\r
 *                  ]\r
 *              }\r
 *          });\r
 *      }\r
 *\r
 * As many URL's as desired can be registered and associated with a {@link Ext.ux.ajax.Simlet}. To make\r
 * non-simulated Ajax requests once this singleton is initialized, add a `nosim:true` option\r
 * to the Ajax options:\r
 *\r
 *      Ext.Ajax.request({\r
 *          url: 'page.php',\r
 *          nosim: true, // ignored by normal Ajax request\r
 *          params: {\r
 *              id: 1\r
 *          },\r
 *          success: function(response){\r
 *              var text = response.responseText;\r
 *              // process server response here\r
 *          }\r
 *      });\r
 */\r
Ext.define('Ext.ux.ajax.SimManager', {\r
    singleton: true,\r
\r
    requires: [\r
        'Ext.data.Connection',\r
        'Ext.ux.ajax.SimXhr',\r
        'Ext.ux.ajax.Simlet',\r
        'Ext.ux.ajax.JsonSimlet'\r
    ],\r
\r
    /**\r
     * @cfg {Ext.ux.ajax.Simlet} defaultSimlet\r
     * The {@link Ext.ux.ajax.Simlet} instance to use for non-matching URL's. By default, this will\r
     * return 404. Set this to null to use real Ajax calls for non-matching URL's.\r
     */\r
\r
    /**\r
     * @cfg {String} defaultType\r
     * The default `type` to apply to generic {@link Ext.ux.ajax.Simlet} configuration objects. The\r
     * default is 'basic'.\r
     */\r
    defaultType: 'basic',\r
\r
    /**\r
     * @cfg {Number} delay\r
     * The number of milliseconds to delay before delivering a response to an async request.\r
     */\r
    delay: 150,\r
\r
    /**\r
     * @property {Boolean} ready\r
     * True once this singleton has initialized and applied its Ajax hooks.\r
     * @private\r
     */\r
    ready: false,\r
\r
    constructor: function () {\r
        this.simlets = [];\r
    },\r
\r
    getSimlet: function (url) {\r
        // Strip down to base URL (no query parameters or hash):\r
        var me = this,\r
            index = url.indexOf('?'),\r
            simlets = me.simlets,\r
            len = simlets.length,\r
            i, simlet, simUrl, match;\r
\r
        if (index < 0) {\r
            index = url.indexOf('#');\r
        }\r
        if (index > 0) {\r
            url = url.substring(0, index);\r
        }\r
        \r
        for (i = 0; i < len; ++i) {\r
            simlet = simlets[i];\r
            simUrl = simlet.url;\r
            if (simUrl instanceof RegExp) {\r
                match = simUrl.test(url);\r
            } else {\r
                match = simUrl === url;\r
            }\r
            if (match) {\r
                return simlet;\r
            }\r
        }\r
\r
        return me.defaultSimlet;\r
    },\r
\r
    getXhr: function (method, url, options, async) {\r
        var simlet = this.getSimlet(url);\r
\r
        if (simlet) {\r
            return simlet.openRequest(method, url, options, async);\r
        }\r
\r
        return null;\r
    },\r
\r
    /**\r
     * Initializes this singleton and applies configuration options.\r
     * @param {Object} config An optional object with configuration properties to apply.\r
     * @return {Ext.ux.ajax.SimManager} this\r
     */\r
    init: function (config) {\r
        var me = this;\r
\r
        Ext.apply(me, config);\r
\r
        if (!me.ready) {\r
            me.ready = true;\r
\r
            if (!('defaultSimlet' in me)) {\r
                me.defaultSimlet = new Ext.ux.ajax.Simlet({\r
                    status: 404,\r
                    statusText: 'Not Found'\r
                });\r
            }\r
\r
            me._openRequest = Ext.data.Connection.prototype.openRequest;\r
\r
            Ext.data.request.Ajax.override({\r
                openRequest: function (options, requestOptions, async) {\r
                    var xhr = !options.nosim &&\r
                              me.getXhr(requestOptions.method, requestOptions.url, options, async);\r
                    if (!xhr) {\r
                        xhr = this.callParent(arguments);\r
                    }\r
                    return xhr;\r
                }\r
            });\r
\r
            if (Ext.data.JsonP) {\r
                Ext.data.JsonP.self.override({\r
                    createScript: function (url, params, options) {\r
                        var fullUrl = Ext.urlAppend(url, Ext.Object.toQueryString(params)),\r
                            script = !options.nosim &&\r
                                     me.getXhr('GET', fullUrl, options, true);\r
\r
                        if (!script) {\r
                            script = this.callParent(arguments);\r
                        }\r
\r
                        return script;\r
                    },\r
\r
                    loadScript: function (request) {\r
                        var script = request.script;\r
                        if (script.simlet) {\r
                            script.jsonpCallback = request.params[request.callbackKey];\r
                            script.send(null);\r
\r
                            // Ext.data.JsonP will attempt dom removal of a script tag, so emulate its presence\r
                            request.script = document.createElement('script');\r
                        } else {\r
                            this.callParent(arguments);\r
                        }\r
                    }\r
                });\r
            }\r
        }\r
\r
        return me;\r
    },\r
\r
    openRequest: function (method, url, async) {\r
        var opt = {\r
            method: method,\r
            url: url\r
        };\r
        return this._openRequest.call(Ext.data.Connection.prototype, {}, opt, async);\r
    },\r
\r
    /**\r
     * Registeres one or more {@link Ext.ux.ajax.Simlet} instances.\r
     * @param {Array/Object} simlet Either a {@link Ext.ux.ajax.Simlet} instance or config, an Array\r
     * of such elements or an Object keyed by URL with values that are {@link Ext.ux.ajax.Simlet}\r
     * instances or configs.\r
     */\r
    register: function (simlet) {\r
        var me = this;\r
\r
        me.init();\r
\r
        function reg (one) {\r
            var simlet = one;\r
            if (!simlet.isSimlet) {\r
                simlet = Ext.create('simlet.' + (simlet.type || simlet.stype || me.defaultType), one);\r
            }\r
            me.simlets.push(simlet);\r
            simlet.manager = me;\r
        }\r
\r
        if (Ext.isArray(simlet)) {\r
            Ext.each(simlet, reg);\r
        } else if (simlet.isSimlet || simlet.url) {\r
            reg(simlet);\r
        } else {\r
            Ext.Object.each(simlet, function (url, s) {\r
                s.url = url;\r
                reg(s);\r
            });\r
        }\r
\r
        return me;\r
    }\r
});\r