deluge/deluge/ui/web/js/Deluge.Client.js

/*
Script: Deluge.Client.js
    A JSON-RPC proxy built on top of ext-core.

Copyright:
    (C) Damien Churchill 2009 <damoxc@gmail.com>
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3, or (at your option)
    any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, write to:
        The Free Software Foundation, Inc.,
        51 Franklin Street, Fifth Floor
        Boston, MA  02110-1301, USA.

    In addition, as a special exception, the copyright holders give
    permission to link the code of portions of this program with the OpenSSL
    library.
    You must obey the GNU General Public License in all respects for all of
    the code used other than OpenSSL. If you modify file(s) with this
    exception, you may extend this exception to your version of the file(s),
    but you are not obligated to do so. If you do not wish to do so, delete
    this exception statement from your version. If you delete this exception
    statement from all source files in the program, then also delete it here.
*/

Ext.namespace('Ext.ux.util');
(function() {
    Ext.ux.util.RpcClient = Ext.extend(Ext.util.Observable, {

        _components: [],
        
        _methods: [],
        
        _requests: {},
        
        _url: null,
        
        _optionKeys: ['scope', 'success', 'failure'],
        
        constructor: function(config) {
            Ext.ux.util.RpcClient.superclass.constructor.call(this, config);
            this._url = config.url || null;
            this._id = 0;
            
            this.addEvents(
                // raw events
                /**
                 * @event connected
                 * Fires when the client has retrieved the list of methods from the server.
                 * @param {Ext.ux.util.RpcClient} this
                 */
                 'connected',
                 
                 'error'
            );
            this.reloadMethods();
        },
        
        reloadMethods: function() {
            Ext.each(this._components, function(component) {
                delete this[component];
            }, this);
            this._execute('system.listMethods', {
                success: this._setMethods,
                scope: this
            });
        },
    
        _execute: function(method, options) {
            options = options || {};
            options.params = options.params || [];
            options.id = this._id;
            
            var request = Ext.encode({
                method: method,
                params: options.params,
                id: options.id
            });
            this._id++;
            
            return Ext.Ajax.request({
                url: this._url,
                method: 'POST',
                success: this._onSuccess,
                failure: this._onFailure,
                scope: this,
                jsonData: request,
                options: options
            });
        },
        
        _onFailure: function(response, requestOptions) {
            var options = requestOptions.options;
            errorObj = {
                id: options.id,
                result: null,
                error: {
                    msg: 'HTTP: ' + response.status + ' ' + response.statusText,
                    code: 255
                }
            }
            
            this.fireEvent('error', errorObj, response, requestOptions)
            
            if (Ext.type(options.failure) != 'function') return;
            if (options.scope) {
                options.failure.call(options.scope, errorObj, response, requestOptions);
            } else {
                options.failure(errorObj, response, requestOptions);
            }            
        },
        
        _onSuccess: function(response, requestOptions) {
            var responseObj = Ext.decode(response.responseText);
            var options = requestOptions.options;
            if (responseObj.error) {
                this.fireEvent('error', responseObj, response, requestOptions);
                
                if (Ext.type(options.failure) != 'function') return;
                if (options.scope) {
                    options.failure.call(options.scope, responseObj, response, requestOptions);
                } else {
                    options.failure(responseObj, response, requestOptions);
                }
            } else {
                if (Ext.type(options.success) != 'function') return;
                if (options.scope) {
                    options.success.call(options.scope, responseObj.result, responseObj, response, requestOptions);
                } else {
                    options.success(responseObj.result, responseObj, response, requestOptions);
                }
            }
        },
        
        _parseArgs: function(args) {
            var params = [];
            Ext.each(args, function(arg) {
                params.push(arg);
            });
            
            var options = params[params.length - 1];
            if (Ext.type(options) == 'object') {
                var keys = Ext.keys(options), isOption = false;
                
                Ext.each(this._optionKeys, function(key) {
                    if (keys.indexOf(key) > -1) isOption = true;
                });
                
                if (isOption) {
                    params.remove(options)
                } else {
                    options = {}
                }
            } else {
                options = {}
            }
            options.params = params;
            return options;
        },
    
        _setMethods: function(methods) {
            var components = {}, self = this;
            
            Ext.each(methods, function(method) {
                var parts = method.split('.');
                var component = components[parts[0]] || {};
                
                var fn = function() {
                    var options = self._parseArgs(arguments);
                    return self._execute(method, options);
                }
                component[parts[1]] = fn;
                components[parts[0]] = component;
            });
            
            for (var name in components) {
                self[name] = components[name];
            }
            
            this._components = Ext.keys(components);
            this.fireEvent('connected', this);
        }
    });
})();