Updated client codebase

[KiwiIRC.git] / client / assets / dev / model_gateway.js

kiwi.model.Gateway = function () {\r
\r
    // Set to a reference to this object within initialize()\r
    var that = null;\r
\r
    this.defaults = {\r
        /**\r
        *   The name of the network\r
        *   @type    String\r
        */\r
        name: 'Server',\r
\r
        /**\r
        *   The address (URL) of the network\r
        *   @type    String\r
        */\r
        address: '',\r
\r
        /**\r
        *   The current nickname\r
        *   @type   String\r
        */\r
        nick: '',\r
\r
        /**\r
        *   The channel prefix for this network\r
        *   @type    String\r
        */\r
        channel_prefix: '#',\r
\r
        /**\r
        *   The user prefixes for channel owner/admin/op/voice etc. on this network\r
        *   @type   Array\r
        */\r
        user_prefixes: ['~', '&', '@', '+'],\r
\r
        /**\r
        *   The URL to the Kiwi server\r
        *   @type   String\r
        */\r
        kiwi_server: '//kiwi'\r
    };\r
\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
\r
\r
    /**\r
    *   Connects to the server\r
    *   @param  {String}    host        The hostname or IP address of the IRC server to connect to\r
    *   @param  {Number}    port        The port of the IRC server to connect to\r
    *   @param  {Boolean}   ssl         Whether or not to connect to the IRC server using SSL\r
    *   @param  {String}    password    The password to supply to the IRC server during registration\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 (host, port, ssl, password, callback) {\r
        this.socket = io.connect(this.get('kiwi_server'), {\r
            'try multiple transports': true,\r
            'connect timeout': 3000,\r
            'max reconnection attempts': 7,\r
            'reconnection delay': 2000,\r
            'sync disconnect on unload': false\r
        });\r
        this.socket.on('connect_failed', function (reason) {\r
            // TODO: When does this even actually get fired? I can't find a case! ~Darren\r
            console.debug('Unable to connect Socket.IO', reason);\r
            console.log("kiwi.gateway.socket.on('connect_failed')");\r
            //kiwi.front.tabviews.server.addMsg(null, ' ', 'Unable to connect to Kiwi IRC.\n' + reason, 'error');\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('connect', function () {\r
            this.emit('kiwi', {command: 'connect', nick: that.get('nick'), hostname: host, port: port, ssl: ssl, password:password}, function (err, server_num) {\r
                if (!err) {\r
                    that.server_num = server_num;\r
                    console.log("kiwi.gateway.socket.on('connect')");\r
                } else {\r
                    console.log("kiwi.gateway.socket.on('error')", {reason: err});\r
                }\r
            });\r
        });\r
\r
        this.socket.on('too_many_connections', function () {\r
            that.trigger("connect_fail", {reason: 'too_many_connections'});\r
        });\r
\r
        this.socket.on('irc', function (data, callback) {\r
            that.parse(data.command, data.data);\r
        });\r
\r
        this.socket.on('disconnect', function () {\r
            that.trigger("disconnect", {});\r
            console.log("kiwi.gateway.socket.on('disconnect')");\r
        });\r
\r
        this.socket.on('close', function () {\r
            console.log("kiwi.gateway.socket.on('close')");\r
        });\r
\r
        this.socket.on('reconnecting', function (reconnectionDelay, reconnectionAttempts) {\r
            console.log("kiwi.gateway.socket.on('reconnecting')");\r
            that.trigger("reconnecting", {delay: reconnectionDelay, attempts: reconnectionAttempts});\r
        });\r
\r
        this.socket.on('reconnect_failed', function () {\r
            console.log("kiwi.gateway.socket.on('reconnect_failed')");\r
        });\r
    };\r
\r
\r
\r
    this.isConnected = function () {\r
        return this.socket.socket.connected;\r
    };\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
        if (command !== undefined) {\r
            that.trigger('on' + command, data);\r
\r
            switch (command) {\r
            case 'options':\r
                $.each(data.options, function (name, value) {\r
                    switch (name) {\r
                    case 'CHANTYPES':\r
                        // TODO: Check this. Why is it only getting the first char?\r
                        that.set('channel_prefix', value.join('').charAt(0));\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
                break;\r
\r
            case 'connect':\r
                that.set('nick', data.nick);\r
                break;\r
\r
            case 'nick':\r
                if (data.nick === that.get('nick')) {\r
                    that.set('nick', data.newnick);\r
                }\r
                break;\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
    /**\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 (data, callback) {\r
        this.socket.emit('irc', {server: 0, data: JSON.stringify(data)}, 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 (target, msg, callback) {\r
        var data = {\r
            method: 'privmsg',\r
            args: {\r
                target: target,\r
                msg: msg\r
            }\r
        };\r
\r
        this.sendData(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 (target, msg, callback) {\r
        var data = {\r
            method: 'notice',\r
            args: {\r
                target: target,\r
                msg: msg\r
            }\r
        };\r
\r
        this.sendData(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 (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(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 (target, msg, callback) {\r
        this.ctcp(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 (channel, key, callback) {\r
        var data = {\r
            method: 'join',\r
            args: {\r
                channel: channel,\r
                key: key\r
            }\r
        };\r
\r
        this.sendData(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 (channel, callback) {\r
        var data = {\r
            method: 'part',\r
            args: {\r
                channel: channel\r
            }\r
        };\r
\r
        this.sendData(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 (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(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 (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(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 (msg, callback) {\r
        msg = msg || "";\r
        var data = {\r
            method: 'quit',\r
            args: {\r
                message: msg\r
            }\r
        };\r
\r
        this.sendData(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 (data, callback) {\r
        data = {\r
            method: 'raw',\r
            args: {\r
                data: data\r
            }\r
        };\r
\r
        this.sendData(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 (new_nick, callback) {\r
        var data = {\r
            method: 'nick',\r
            args: {\r
                nick: new_nick\r
            }\r
        };\r
\r
        this.sendData(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
};