failirc 0.0.1

data/lib/failirc/client/modules/Logger.rb

@@ -0,0 +1,89 @@
+# failirc, a fail IRC library.
+#
+# Copyleft meh. [http://meh.doesntexist.org | meh.ffff@gmail.com]
+#
+# This file is part of failirc.
+#
+# failirc is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# failirc 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with failirc. If not, see <http://www.gnu.org/licenses/>.
+
+require 'failirc/client/module'
+
+module IRC
+
+class Client
+
+module Modules
+
+class Logger < Module
+    @@version = '0.0.1'
+
+    def self.version
+        return @@version
+    end
+
+    def description
+        "Logger-#{Logger.version}"
+    end
+
+    def initialize (server)
+        @events = {
+            :pre  => Event::Callback.new(self.method(:dispatch), -9001),
+            :post => Event::Callback.new(self.method(:dispatch), -9001),
+
+            :custom => {
+                :log  => self.method(:log),
+            },
+        }
+
+        super(server)
+    end
+
+    def rehash
+        if @log && @log != $stdout
+            @log.close
+        end
+
+        file = client.config.elements['config/modules/module[@name="Logger"]/file']
+
+        if file
+            @log = File.open(file.text)
+        else
+            @log = $stdout
+        end
+    end
+
+    def finalize
+        if @log != $stdout
+            @log.close
+        end
+    end
+
+    def dispatch (event, thing, string)
+        if (event.chain == :input && event.special == :pre) || (event.chain == :output && event.special == :post)
+            @log.puts "[#{Time.now}] #{(event.chain == :input) ? '<' : '>'} #{string.inspect}"
+            @log.flush
+        end
+    end
+
+    def log (string)
+        @log.puts "[#{Time.now}] #{string}"
+        @log.flush
+    end
+end
+
+end
+
+end
+
+end

data/lib/failirc/client/server.rb

@@ -0,0 +1,89 @@
+# failirc, a fail IRC library.
+#
+# Copyleft meh. [http://meh.doesntexist.org | meh.ffff@gmail.com]
+#
+# This file is part of failirc.
+#
+# failirc is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# failirc 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with failirc. If not, see <http://www.gnu.org/licenses/>.
+
+require 'failirc/client/channels'
+require 'failirc/client/clients'
+
+module IRC
+
+class Client
+
+class Server
+    attr_reader :client, :socket, :config, :name, :host, :ip, :port, :channels, :clients
+    attr_accessor :nick, :password
+
+    def initialize (client, socket, config, name=nil)
+        @client = client
+        @socket = socket
+        @config = config
+
+        @channels = Channels.new(self)
+        @clients  = Clients.new(self)
+
+        @host = socket.peeraddr[2]
+        @ip   = socket.peeraddr[3]
+        @port = socket.peeraddr[1]
+
+        nick = client.nick
+
+        if !name
+            name = @host
+        else
+            if client.server name
+                raise Error.new "There is already a server named `#{name}`."
+            end
+        end
+
+        while client.server name
+            name << '_'
+        end
+
+        @name = name
+    end
+
+    def name= (value)
+        if client.server value
+            raise Error.new "There is already a server named `#{name}`."
+        end
+
+        client.dispatcher.servers[:byName].delete(name)
+        client.dispatcher.servers[:byName][value] = self
+    end
+
+    def send (symbol, *args)
+        begin
+            self.method(symbol).call(*args)
+        rescue Exception => e
+            self.debug e
+        end
+    end
+
+    def raw (text)
+        @client.dispatcher.dispatch :output, self, text
+        @client.dispatcher.connection.output.push @socket, text
+    end
+
+    def to_s
+        name
+    end
+end
+
+end
+
+end

data/lib/failirc/client/user.rb

@@ -0,0 +1,66 @@
+# failirc, a fail IRC library.
+#
+# Copyleft meh. [http://meh.doesntexist.org | meh.ffff@gmail.com]
+#
+# This file is part of failirc.
+#
+# failirc is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# failirc 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with failirc. If not, see <http://www.gnu.org/licenses/>.
+
+require 'failirc/modes'
+
+module IRC
+
+class Client
+
+class User
+    attr_reader :client, :channel, :modes
+
+    def initialize (client, channel, modes=Modes.new)
+        @client  = client
+        @channel = channel
+        @modes   = modes
+    end
+
+    def mask
+        @client.mask
+    end
+
+    def server
+        @client.server
+    end
+
+    def nick
+        @client.nick
+    end
+
+    def user
+        @client.user
+    end
+
+    def host
+        @client.host
+    end
+
+    def to_s
+        return "#{modes[:level]}#{nick}"
+    end
+
+    def inspect
+        return "#<User: #{client.inspect} #{channel.inspect} #{modes.inspect}>"
+    end
+end
+
+end
+
+end

data/lib/failirc/client/users.rb

@@ -0,0 +1,100 @@
+# failirc, a fail IRC library.
+#
+# Copyleft meh. [http://meh.doesntexist.org | meh.ffff@gmail.com]
+#
+# This file is part of failirc.
+#
+# failirc is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# failirc 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with failirc. If not, see <http://www.gnu.org/licenses/>.
+
+require 'failirc/utils'
+
+require 'failirc/client/user'
+
+module IRC
+
+class Client
+
+class Users < ThreadSafeHash
+    attr_reader :channel
+
+    def initialize (channel, *args)
+        @channel = channel
+
+        super(*args)
+    end
+
+    def client
+        @channel.client
+    end
+
+    def server
+        @channel.server
+    end
+
+    alias __get []
+
+    def [] (user)
+        if user.is_a?(Client) || user.is_a?(User)
+            user = user.nick
+        end
+
+        __get(user)
+    end
+
+    alias __set []=
+
+    def []= (user, value)
+        if user.is_a?(Client) || user.is_a?(User)
+            user = user.nick
+        end
+
+        __set(user, value)
+    end
+
+    alias __delete delete
+    
+    def delete (key)
+        if key.is_a?(User) || key.is_a?(Client)
+            key = key.nick
+        end
+
+        key = key.downcase
+
+        user = self[key]
+
+        if user
+            __delete(key)
+
+            if channel.empty?
+                server.channels.delete(channel)
+            end
+        end
+
+        return user
+    end
+
+    def add (user)
+        if user.is_a?(Client)
+            self[user.nick] = User.new(user, @channel)
+        elsif user.is_a?(User)
+            self[user.nick] = user
+        else
+            raise 'You can only add Client or User.'
+        end
+    end
+end
+
+end
+
+end

data/lib/failirc/errors.rb

@@ -0,0 +1,339 @@
+# failirc, a fail IRC library.
+#
+# Copyleft meh. [http://meh.doesntexist.org | meh.ffff@gmail.com]
+#
+# This file is part of failirc.
+#
+# failirc is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# failirc 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with failirc. If not, see <http://www.gnu.org/licenses/>.
+
+module IRC
+
+# Used to indicate the nickname parameter supplied to a command is currently unused.
+ERR_NOSUCHNICK = {
+    :code => 401,
+    :text => '"#{value} :No such nick/channel"'
+}
+
+# Used to indicate the server name given currently doesn't exist.
+ERR_NOSUCHSERVER = {
+    :code => 402,
+    :text => '"#{value} :No such server"'
+}
+
+# Used to indicate the given channel name is invalid.
+ERR_NOSUCHCHANNEL = {
+    :code => 403,
+    :text => '"#{value} :No such channel"'
+}
+
+# Sent to a user who is either (a) not on a channel which is mode +n or (b) not a chanop (or mode +v) on a channel which has mode +m set and is trying to send a PRIVMSG message to that channel.
+ERR_CANNOTSENDTOCHAN = {
+    :code => 404,
+    :text => '"#{value[:channel]} :Cannot send to channel"'
+}
+
+ERR_YOUNEEDVOICE = {
+    :code => 404,
+    :text => '"#{value} :You need voice (+v) (#{value})"'
+}
+
+ERR_NOEXTERNALMESSAGES = {
+    :code => 404,
+    :text => '"#{value} :No external channel messages (#{value})"'
+}
+
+ERR_YOUAREBANNED = {
+    :code => 404,
+    :text => '"#{value} :You are banned (#{value})"'
+}
+
+ERR_NOCTCPS = {
+    :code => 404,
+    :text => '"#{value} :CTCPs are not permtted in this channel (#{value})"'
+}
+
+ERR_NOCOLORS = {
+    :code => 404,
+    :text => '"#{value} :Color is not permitted in this channel (#{value})"'
+}
+
+# Sent to a user when they have joined the maximum number of allowed channels and they try to join another channel.
+ERR_TOOMANYCHANNELS = {
+    :code => 405,
+    :text => '"#{value.name} :You have joined too many channels"'
+}
+
+# Sent to a user when they have joined the maximum number of allowed channels and they try to join another channel.
+ERR_WASNOSUCHNICK = {
+    :code => 406,
+    :text => '"#{value} :There was no such nickname"'
+}
+
+# Returned to a client which is attempting to send PRIVMSG/NOTICE using the user@host destination format and for a user@host which has several occurrences.
+ERR_TOOMANYTARGETS = {
+    :code => 407,
+    :text => '"#{value} :Duplicate recipients. No message delivered"'
+}
+
+# PING or PONG message missing the originator parameter which is required since these commands must work without valid prefixes.
+ERR_NOORIGIN = {
+    :code => 409,
+    :text => '":No origin specified"'
+}
+
+ERR_NORECIPIENT = {
+    :code => 411,
+    :text => '":No recipient given (#{value})"'
+}
+
+ERR_NOTEXTTOSEND = {
+    :code => 412,
+    :text => '":No text to send"'
+}
+
+ERR_NOTOPLEVEL = {
+    :code => 413,
+    :text => '"#{mask} :No toplevel domain specified"'
+}
+
+# 412 - 414 are returned by PRIVMSG to indicate that the message wasn't delivered for some reason. ERR_NOTOPLEVEL and ERR_WILDTOPLEVEL are errors that are returned when an invalid use of "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
+ERR_WILDTOPLEVEL = {
+    :code => 414,
+    :text => '"#{mask} :Wildcard in toplevel domain"'
+}
+
+# Returned to a registered client to indicate that the command sent is unknown by the server.
+ERR_UNKNOWNCOMMAND = {
+    :code => 421,
+    :text => '"#{value} :Unknown command"'
+}
+
+# Server's MOTD file could not be opened by the server.
+ERR_NOMOTD = {
+    :code => 422,
+    :text => '":MOTD File is missing"'
+}
+
+# Returned by a server in response to an ADMIN message when there is an error in finding the appropriate information.
+ERR_NOADMININFO = {
+    :code => 423,
+    :text => '"#{server.name} :No administrative info available"'
+}
+
+# Generic error message used to report a failed file operation during the processing of a message.
+ERR_FILEERROR = {
+    :code => 424,
+    :text => '":File error doing #{fileOperation} on #{file}"'
+}
+
+# Returned when a nickname parameter expected for a command and isn't found.
+ERR_NONICKNAMEGIVEN = {
+    :code => 431,
+    :text => '":No nickname given"'
+}
+
+# Returned after receiving a NICK message which contains characters which do not fall in the defined set. See section x.x.x for details on valid nicknames.
+ERR_ERRONEUSNICKNAME = {
+    :code => 432,
+    :text => '"#{value} :Erroneus nickname"'
+}
+
+# Returned when a NICK message is processed that results in an attempt to change to a currently existing nickname.
+ERR_NICKNAMEINUSE = {
+    :code => 433,
+    :text => '"#{value} :Nickname is already in use"'
+}
+
+# Returned by a server to a client when it detects a nickname collision (registered of a NICK that already exists by another server).
+ERR_NICKCOLLISION = {
+    :code => 436,
+    :text => '"#{value} :Nickname collision KILL"'
+}
+
+# Returned by the server to indicate that the target user of the command is not on the given channel.
+ERR_USERNOTINCHANNEL = {
+    :code => 441,
+    :text => '"#{value[:nick]} #{value[:channel]} :They aren\'t on that channel"'
+}
+
+# Returned by the server whenever a client tries to perform a channel effecting command for which the client isn't a member.
+ERR_NOTONCHANNEL = {
+    :code => 442,
+    :text => '"#{value} :You\'re not on that channel"'
+}
+
+# Returned when a client tries to invite a user to a channel they are already on.
+ERR_USERONCHANNEL = {
+    :code => 443,
+    :text => '"#{value[:nick]} #{value[:channel]} :is already on channel"'
+}
+
+# Returned by the summon after a SUMMON command for a user was unable to be performed since they were not logged in.
+ERR_NOLOGIN = {
+    :code => 444,
+    :text => '"#{user} :User not logged in"'
+}
+
+# Returned as a response to the SUMMON command. Must be returned by any server which does not implement it.
+ERR_SUMMONDISABLED = {
+    :code => 445,
+    :text => '":SUMMON has been disabled"'
+}
+
+# Returned as a response to the USERS command. Must be returned by any server which does not implement it.
+ERR_USERSDISABLED = {
+    :code => 446,
+    :text => '":USERS has been disabled"'
+}
+
+# Returned by the server to indicate that the client must be registered before the server will allow it to be parsed in detail.
+ERR_NOTREGISTERED = {
+    :code => 451,
+    :text => '":You have not registered"'
+}
+
+# Returned by the server by numerous commands to indicate to the client that it didn't supply enough parameters.
+ERR_NEEDMOREPARAMS = {
+    :code => 461,
+    :text => '"#{value} :Not enough parameters"'
+}
+
+# Returned by the server to any link which tries to change part of the registered details (such as password or user details from second USER message).
+ERR_ALREADYREGISTRED = {
+    :code => 462,
+    :text => '":You may not reregister"'
+}
+
+# Returned to a client which attempts to register with a server which does not been setup to allow connections from the host the attempted connection is tried.
+ERR_NOPERMFORHOST = {
+    :code => 463,
+    :text => '":Your host isn\'t among the privileged"'
+}
+
+# Returned to indicate a failed attempt at registering a connection for which a password was required and was either not given or incorrect.
+ERR_PASSWDMISMATCH = {
+    :code => 464,
+    :text => '":Password incorrect"'
+}
+
+# Returned after an attempt to connect and register yourself with a server which has been setup to explicitly deny connections to you.
+ERR_YOUREBANNEDCREEP = {
+    :code => 465,
+    :text => '":You are banned from this server"'
+}
+
+ERR_KEYSET = {
+    :code => 467,
+    :text => '"#{value} :Channel key already set"'
+}
+
+ERR_CHANNELISFULL = {
+    :code => 471,
+    :text => '"#{value} :Cannot join channel (+l)"'
+}
+
+ERR_UNKNOWNMODE = {
+    :code => 472,
+    :text => '"#{value} :is unknown mode char to me"'
+}
+
+ERR_INVITEONLYCHAN = {
+    :code => 473,
+    :text => '"#{value} :Cannot join channel (+i)"'
+}
+
+ERR_BANNEDFROMCHAN = {
+    :code => 474,
+    :text => '"#{value} :Cannot join channel (+b)"'
+}
+
+ERR_BADCHANNELKEY = {
+    :code => 475,
+    :text => '"#{value} :Cannot join channel (+k)"'
+}
+
+ERR_NOKNOCK = {
+    :code => 480,
+    :text => '":Cannot knock on #{value[:channel]} (#{value[:reason]})"'
+}
+
+
+# Any command requiring operator privileges to operate must return this error to indicate the attempt was unsuccessful.
+ERR_NOPRIVILEGES = {
+    :code => 481,
+    :text => '":Permission Denied- You\'re not an IRC operator"'
+}
+
+# Any command requiring 'chanop' privileges (such as MODE messages) must return this error if the client making the attempt is not a chanop on the specified channel.
+ERR_CHANOPRIVSNEEDED = {
+    :code => 482,
+    :text => '"#{value} :You\'re not channel operator"'
+}
+
+# Any attempts to use the KILL command on a server are to be refused and this error returned directly to the client.
+ERR_CANTKILLSERVER = {
+    :code => 483,
+    :text => '":You cant kill a server!"'
+}
+
+# If a client sends an OPER message and the server has not been configured to allow connections from the client's host as an operator, this error must be returned.
+ERR_NOOPERHOST = {
+    :code => 491,
+    :text => '":No O-lines for your host"'
+}
+
+# Returned by the server to indicate that a MODE message was sent with a nickname parameter and that the a mode flag sent was not recognized.
+ERR_UMODEUNKNOWNFLAG = {
+    :code => 501,
+    :text => '":Unknown MODE flag"'
+}
+
+# Error sent to any user trying to view or change the user mode for a user other than themselves.
+ERR_USERSDONTMATCH = {
+    :code => 502,
+    :text => '":Cant change mode for other users"'
+}
+
+# custom
+ERR_BADCHANMASK = {
+    :code => 476,
+    :text => '"#{value} :Bad channel name"'
+}
+
+ERR_ALLMUSTUSESSL = {
+    :code => 974,
+    :text => '"z :all members must be connected via SSL"'
+}
+
+ERR_SSLREQUIRED = {
+    :code => 489,
+    :text => '"#{value} :Cannot join channel (SSL is required)"'
+}
+
+ERR_NONICKCHANGE = {
+    :code => 447,
+    :text => '"Can not change nickname while on #{value} (+N)"'
+}
+
+ERR_NOKICKS = {
+    :code => 972,
+    :text => '"KICK :channel is +Q"'
+}
+
+ERR_NOINVITE = {
+    :code => 518,
+    :text => '"Cannot invite (+V) at channel #{value}"'
+}
+
+end