Merge branch 'winston' of https://github.com/M2Ys4U/KiwiIRC into winston

[KiwiIRC.git] / client / src / models / gateway.js

_kiwi.model.Gateway = function () {\r
\r
    // Set to a reference to this object within initialize()\r
    var that = null;\r
\r
    this.initialize = function () {\r
        that = this;\r
\r
        // For ease of access. The socket.io object\r
        this.socket = this.get('socket');\r
\r
        this.applyEventHandlers();\r
\r
        // Used to check if a disconnection was unplanned\r
        this.disconnect_requested = false;\r
    };\r
\r
\r
    this.applyEventHandlers = function () {\r
        /*\r
        kiwi.gateway.on('message:#channel', my_function);\r
        kiwi.gateway.on('message:somenick', my_function);\r
\r
        kiwi.gateway.on('notice:#channel', my_function);\r
        kiwi.gateway.on('action:somenick', my_function);\r
\r
        kiwi.gateway.on('join:#channel', my_function);\r
        kiwi.gateway.on('part:#channel', my_function);\r
        kiwi.gateway.on('quit', my_function);\r
        */\r
        var that = this;\r
\r
        // Some easier handler events\r
        this.on('onmsg', function (event) {\r
            var source,\r
                connection = _kiwi.app.connections.getByConnectionId(event.server),\r
                is_pm = (event.channel.toLowerCase() == connection.get('nick').toLowerCase());\r
\r
            source = is_pm ? event.nick : event.channel;\r
\r
            that.trigger('message:' + source, event);\r
            that.trigger('message', event);\r
\r
            if (is_pm) {\r
                that.trigger('pm:' + source, event);\r
                that.trigger('pm', event);\r
            }\r
        }, this);\r
\r
\r
        this.on('onnotice', function (event) {\r
            // The notice towards a channel or a query window?\r
            var source = event.target || event.nick;\r
\r
            this.trigger('notice:' + source, event);\r
            this.trigger('notice', event);\r
        }, this);\r
\r
\r
        this.on('onaction', function (event) {\r
            var source,\r
                connection = _kiwi.app.connections.getByConnectionId(event.server),\r
                is_pm = (event.channel.toLowerCase() == connection.get('nick').toLowerCase());\r
\r
            source = is_pm ? event.nick : event.channel;\r
\r
            that.trigger('action:' + source, event);\r
\r
            if (is_pm) {\r
                that.trigger('action:' + source, event);\r
                that.trigger('action', event);\r
            }\r
        }, this);\r
\r
\r
        this.on('ontopic', function (event) {\r
            that.trigger('topic:' + event.channel, event);\r
            that.trigger('topic', event);\r
        });\r
\r
\r
        this.on('onjoin', function (event) {\r
            that.trigger('join:' + event.channel, event);\r
            that.trigger('join', event);\r
        });\r
\r
    };\r
\r
\r
\r
    this.reconnect = function (callback) {\r
        var that = this,\r
            transport_path;\r
\r
        this.disconnect_requested = true;\r
        this.socket.close();\r
\r
        this.socket = null;\r
        this.connect(callback);\r
    };\r
\r
\r
\r
    /**\r
    *   Connects to the server\r
    *   @param  {Function}  callback    A callback function to be invoked once Kiwi's server has connected to the IRC server\r
    */\r
    this.connect = function (callback) {\r
        this.connect_callback = callback;\r
\r
        // Keep note of the server we are connecting to\r
        this.set('kiwi_server', _kiwi.app.kiwi_server);\r
\r
        this.socket = new EngineioTools.ReconnectingSocket(this.get('kiwi_server'), {\r
            path: _kiwi.app.get('base_path') + '/transport',\r
            reconnect_max_attempts: 5,\r
            reconnect_delay: 2000\r
        });\r
\r
        this.rpc = new EngineioTools.Rpc(this.socket);\r
\r
        this.socket.on('connect_failed', function (reason) {\r
            this.socket.disconnect();\r
            this.trigger("connect_fail", {reason: reason});\r
        });\r
\r
        this.socket.on('error', function (e) {\r
            console.log("_kiwi.gateway.socket.on('error')", {reason: e});\r
            that.trigger("connect_fail", {reason: e});\r
        });\r
\r
        this.socket.on('connecting', function (transport_type) {\r
            console.log("_kiwi.gateway.socket.on('connecting')");\r
            that.trigger("connecting");\r
        });\r
\r
        /**\r
         * Once connected to the kiwi server send the IRC connect command along\r
         * with the IRC server details.\r
         * A `connect` event is sent from the kiwi server once connected to the\r
         * IRCD and the nick has been accepted.\r
         */\r
        this.socket.on('open', function () {\r
            // Reset the disconnect_requested flag\r
            that.disconnect_requested = false;\r
\r
            console.log("_kiwi.gateway.socket.on('open')");\r
        });\r
\r
        this.rpc.on('too_many_connections', function () {\r
            that.trigger("connect_fail", {reason: 'too_many_connections'});\r
        });\r
\r
        this.rpc.on('irc', function (response, data) {\r
            that.parse(data.command, data.data);\r
        });\r
\r
        this.rpc.on('kiwi', function (response, data) {\r
            that.parseKiwi(data.command, data.data);\r
        });\r
\r
        this.socket.on('close', function () {\r
            that.trigger("disconnect", {});\r
            console.log("_kiwi.gateway.socket.on('close')");\r
        });\r
\r
        this.socket.on('reconnecting', function (status) {\r
            console.log("_kiwi.gateway.socket.on('reconnecting')");\r
            that.trigger("reconnecting", {delay: status.delay, attempts: status.attempts});\r
        });\r
\r
        this.socket.on('reconnecting_failed', function () {\r
            console.log("_kiwi.gateway.socket.on('reconnect_failed')");\r
        });\r
    };\r
\r
\r
    /**\r
     * Return a new network object with the new connection details\r
     */\r
    this.newConnection = function(connection_info, callback_fn) {\r
        var that = this;\r
\r
        this.makeIrcConnection(connection_info, function(err, server_num) {\r
            var connection;\r
\r
            if (!err) {\r
                if (!_kiwi.app.connections.getByConnectionId(server_num)){\r
                    var inf = {\r
                        connection_id: server_num,\r
                        nick: connection_info.nick,\r
                        address: connection_info.host,\r
                        port: connection_info.port,\r
                        ssl: connection_info.ssl,\r
                        password: connection_info.password\r
                    };\r
                    connection = new _kiwi.model.Network(inf);\r
                    _kiwi.app.connections.add(connection);\r
                }\r
\r
                console.log("_kiwi.gateway.socket.on('connect')", connection);\r
                callback_fn && callback_fn(err, connection);\r
\r
            } else {\r
                console.log("_kiwi.gateway.socket.on('error')", {reason: err});\r
                callback_fn && callback_fn(err);\r
            }\r
        });\r
    };\r
\r
\r
    /**\r
     * Make a new IRC connection and return its connection ID\r
     */\r
    this.makeIrcConnection = function(connection_info, callback_fn) {\r
        var server_info = {\r
            command:    'connect',\r
            nick:       connection_info.nick,\r
            hostname:   connection_info.host,\r
            port:       connection_info.port,\r
            ssl:        connection_info.ssl,\r
            password:   connection_info.password\r
        };\r
\r
        connection_info.options = connection_info.options || {};\r
\r
        // A few optional parameters\r
        if (connection_info.options.encoding)\r
            server_info.encoding = connection_info.options.encoding;\r
\r
        this.rpc.call('kiwi', server_info, function (err, server_num) {\r
            if (!err) {\r
                callback_fn && callback_fn(err, server_num);\r
\r
            } else {\r
                callback_fn && callback_fn(err);\r
            }\r
        });\r
    };\r
\r
\r
    this.isConnected = function () {\r
        // TODO: Check this. Might want to use .readyState\r
        return this.socket;\r
    };\r
\r
\r
\r
    this.parseKiwi = function (command, data) {\r
        this.trigger('kiwi:' + command, data);\r
        this.trigger('kiwi', data);\r
\r
        switch (command) {\r
        case 'connected':\r
            this.connect_callback && this.connect_callback();\r
            delete this.connect_callback;\r
            break;\r
        }\r
    };\r
    /*\r
        Events:\r
            msg\r
            action\r
            server_connect\r
            options\r
            motd\r
            notice\r
            userlist\r
            nick\r
            join\r
            topic\r
            part\r
            kick\r
            quit\r
            whois\r
            syncchannel_redirect\r
            debug\r
    */\r
    /**\r
    *   Parses the response from the server\r
    */\r
    this.parse = function (command, data) {\r
        //console.log('gateway event', command, data);\r
\r
        if (command !== undefined) {\r
            switch (command) {\r
            case 'options':\r
                $.each(data.options, function (name, value) {\r
                    switch (name) {\r
                    case 'CHANTYPES':\r
                        that.set('channel_prefix', value.join(''));\r
                        break;\r
                    case 'NETWORK':\r
                        that.set('name', value);\r
                        break;\r
                    case 'PREFIX':\r
                        that.set('user_prefixes', value);\r
                        break;\r
                    }\r
                });\r
                that.set('cap', data.cap);\r
                break;\r
\r
            /*\r
            case 'sync':\r
                if (_kiwi.gateway.onSync && _kiwi.gateway.syncing) {\r
                    _kiwi.gateway.syncing = false;\r
                    _kiwi.gateway.onSync(item);\r
                }\r
                break;\r
            */\r
\r
            case 'kiwi':\r
                this.emit('_kiwi.' + data.namespace, data.data);\r
                break;\r
            }\r
        }\r
\r
\r
        if (typeof data.server !== 'undefined') {\r
            that.trigger('connection:' + data.server.toString(), {\r
                event_name: command,\r
                event_data: data\r
            });\r
        }\r
\r
        // Trigger the global events (Mainly legacy now)\r
        that.trigger('on' + command, data);\r
    };\r
\r
    /**\r
    *   Sends data to the server\r
    *   @private\r
    *   @param  {Object}    data        The data to send\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.sendData = function (connection_id, data, callback) {\r
        if (typeof connection_id === 'undefined' || connection_id === null)\r
            connection_id = _kiwi.app.connections.active_connection.get('connection_id');\r
\r
        var data_buffer = {\r
            server: connection_id,\r
            data: JSON.stringify(data)\r
        };\r
        this.rpc.call('irc', data_buffer, callback);\r
    };\r
\r
    /**\r
    *   Sends a PRIVMSG message\r
    *   @param  {String}    target      The target of the message (e.g. a channel or nick)\r
    *   @param  {String}    msg         The message to send\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.privmsg = function (connection_id, target, msg, callback) {\r
        var data = {\r
            method: 'privmsg',\r
            args: {\r
                target: target,\r
                msg: msg\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Sends a NOTICE message\r
    *   @param  {String}    target      The target of the message (e.g. a channel or nick)\r
    *   @param  {String}    msg         The message to send\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.notice = function (connection_id, target, msg, callback) {\r
        var data = {\r
            method: 'notice',\r
            args: {\r
                target: target,\r
                msg: msg\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Sends a CTCP message\r
    *   @param  {Boolean}   request     Indicates whether this is a CTCP request (true) or reply (false)\r
    *   @param  {String}    type        The type of CTCP message, e.g. 'VERSION', 'TIME', 'PING' etc.\r
    *   @param  {String}    target      The target of the message, e.g a channel or nick\r
    *   @param  {String}    params      Additional paramaters\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.ctcp = function (connection_id, request, type, target, params, callback) {\r
        var data = {\r
            method: 'ctcp',\r
            args: {\r
                request: request,\r
                type: type,\r
                target: target,\r
                params: params\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   @param  {String}    target      The target of the message (e.g. a channel or nick)\r
    *   @param  {String}    msg         The message to send\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.action = function (connection_id, target, msg, callback) {\r
        this.ctcp(connection_id, true, 'ACTION', target, msg, callback);\r
    };\r
\r
    /**\r
    *   Joins a channel\r
    *   @param  {String}    channel     The channel to join\r
    *   @param  {String}    key         The key to the channel\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.join = function (connection_id, channel, key, callback) {\r
        var data = {\r
            method: 'join',\r
            args: {\r
                channel: channel,\r
                key: key\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Retrieves channel information\r
    */\r
    this.channelInfo = function (connection_id, channel, callback) {\r
        var data = {\r
            method: 'channel_info',\r
            args: {\r
                channel: channel\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Leaves a channel\r
    *   @param  {String}    channel     The channel to part\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.part = function (connection_id, channel, callback) {\r
        var data = {\r
            method: 'part',\r
            args: {\r
                channel: channel\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Queries or modifies a channell topic\r
    *   @param  {String}    channel     The channel to query or modify\r
    *   @param  {String}    new_topic   The new topic to set\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.topic = function (connection_id, channel, new_topic, callback) {\r
        var data = {\r
            method: 'topic',\r
            args: {\r
                channel: channel,\r
                topic: new_topic\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Kicks a user from a channel\r
    *   @param  {String}    channel     The channel to kick the user from\r
    *   @param  {String}    nick        The nick of the user to kick\r
    *   @param  {String}    reason      The reason for kicking the user\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.kick = function (connection_id, channel, nick, reason, callback) {\r
        var data = {\r
            method: 'kick',\r
            args: {\r
                channel: channel,\r
                nick: nick,\r
                reason: reason\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Disconnects us from the server\r
    *   @param  {String}    msg         The quit message to send to the IRC server\r
    *   @param  {Function}   callback    A callback function\r
    */\r
    this.quit = function (connection_id, msg, callback) {\r
        msg = msg || "";\r
        var data = {\r
            method: 'quit',\r
            args: {\r
                message: msg\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Sends a string unmodified to the IRC server\r
    *   @param  {String}    data        The data to send to the IRC server\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.raw = function (connection_id, data, callback) {\r
        data = {\r
            method: 'raw',\r
            args: {\r
                data: data\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Changes our nickname\r
    *   @param  {String}    new_nick    Our new nickname\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.changeNick = function (connection_id, new_nick, callback) {\r
        var data = {\r
            method: 'nick',\r
            args: {\r
                nick: new_nick\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    * Sets a mode for a target\r
    */\r
    this.mode = function (connection_id, target, mode_string, callback) {\r
        data = {\r
            method: 'raw',\r
            args: {\r
                data: 'MODE ' + target + ' ' + mode_string\r
            }\r
        };\r
\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
\r
    /**\r
     *  Sends ENCODING change request to server.\r
     *  @param  {String}     new_encoding  The new proposed encode\r
     *  @param  {Fucntion}   callback      A callback function\r
     */\r
    this.setEncoding = function (connection_id, new_encoding, callback) {\r
        var data = {\r
            method: 'encoding',\r
            args: {\r
                encoding: new_encoding\r
            }\r
        };\r
        this.sendData(connection_id, data, callback);\r
    };\r
\r
    /**\r
    *   Sends data to a fellow Kiwi IRC user\r
    *   @param  {String}    target      The nick of the Kiwi IRC user to send to\r
    *   @param  {String}    data        The data to send\r
    *   @param  {Function}  callback    A callback function\r
    */\r
    this.kiwi = function (target, data, callback) {\r
        data = {\r
            method: 'kiwi',\r
            args: {\r
                target: target,\r
                data: data\r
            }\r
        };\r
\r
        this.sendData(data, callback);\r
    };\r
\r
\r
    return new (Backbone.Model.extend(this))(arguments);\r
};\r