spox-mod_spox 0.3.1

data/lib/mod_spox/handlers/Welcome.rb

@@ -0,0 +1,30 @@
+require 'mod_spox/handlers/Handler'
+require 'mod_spox/messages/incoming/Welcome'
+module ModSpox
+    module Handlers
+        class Welcome < Handler
+            def initialize(handlers)
+                handlers[RFC[:RPL_WELCOME][:value]] = self
+            end
+            # >> :holmes.freenode.net 001 spax :Welcome to the freenode IRC Network spax 
+            def process(string)
+                parse = string.dup
+                begin
+                    parse.slice!(0)
+                    server = parse.slice!(0..parse.index(' ')-1)
+                    2.times{parse.slice!(0..parse.index(' '))}
+                    nick = parse.slice!(0..parse.index(' ')-1)
+                    parse.slice!(0..parse.index(':'))
+                    nick = Models::Nick.find_or_create(:nick => nick)
+                    nick.botnick = true
+                    nick.visible = true
+                    nick.save
+                    return Messages::Incoming::Welcome.new(string, server, parse, nick, nil, nil)
+                rescue Object => boom
+                    Logger.warn("Failed to parse welcome message: #{string}")
+                    raise Exceptions::GeneralException.new(boom)
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/handlers/Who.rb

@@ -0,0 +1,83 @@
+require 'mod_spox/handlers/Handler'
+require 'mod_spox/messages/incoming/Who'
+module ModSpox
+    module Handlers
+        class Who < Handler
+            def initialize(handlers)
+                handlers[RFC[:RPL_WHOREPLY][:value]] = self
+                handlers[RFC[:RPL_ENDOFWHO][:value]] = self
+                @cache = Hash.new
+                @raw_cache = Hash.new
+            end
+            # :host 352 spox #mod_spox ~pizza_ 12.229.112.195 punch.va.us.dal.net pizza_ H@ :5 pizza_
+            def process(string)
+                string = string.dup
+                orig = string.dup
+                begin
+                    until(string.slice(0..RFC[:RPL_WHOREPLY][:value].size-1) == RFC[:RPL_WHOREPLY][:value] || string.slice(0..RFC[:RPL_ENDOFWHO][:value].size-1) == RFC[:RPL_ENDOFWHO][:value])
+                        string.slice!(0..string.index(' '))
+                    end
+                    if(string.slice(0..RFC[:RPL_WHOREPLY][:value].size-1) == RFC[:RPL_WHOREPLY][:value])
+                        2.times{string.slice!(0..string.index(' '))}
+                        location = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0)
+                        username = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0)
+                        host = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0)
+                        server = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0)
+                        nick = find_model(string.slice!(0..string.index(' ')-1))
+                        string.slice!(0)
+                        info = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0..string.index(':'))
+                        hops = string.slice!(0..string.index(' ')-1)
+                        string.slice!(0)
+                        realname = string
+                        location = nil if location == '*'
+                        nick.username = username
+                        nick.address = location
+                        nick.real_name = realname
+                        nick.connected_to = server
+                        nick.away = !info.index('G').nil?
+                        nick.add_channel(find_model(location)) unless location.nil?
+                        nick.save_changes
+                        key = location.nil? ? nick.nick : location
+                        @cache[key] = Array.new unless @cache[key]
+                        @cache[key] << nick
+                        @raw_cache[key] = Array.new unless @raw_cache[key]
+                        @raw_cache[key] << orig
+                        unless(location.nil?)
+                            channel = find_model(location)
+                            channel.add_nick(nick)
+                            if(info.include?('+'))
+                                m = Models::NickMode.find_or_create(:channel_id => channel.pk, :nick_id => nick.pk)
+                                m.set_mode('v')
+                            elsif(info.include?('@'))
+                                m = Models::NickMode.find_or_create(:channel_id => channel.pk, :nick_id => nick.pk)
+                                m.set_mode('o')
+                            else
+                                m = Models::NickMode.find_or_create(:channel_id => channel.pk, :nick_id => nick.pk)
+                                m.clear_modes
+                            end
+                        end
+                        return nil
+                    else
+                        2.times{string.slice!(0..string.index(' '))}
+                        location = string.slice!(0..string.index(' ')-1)
+                        loc = find_model(location)
+                        @raw_cache[location] << orig
+                        message = Messages::Incoming::Who.new(@raw_cache[location].join("\n"), loc, @cache[location])
+                        @raw_cache.delete(location)
+                        @cache.delete(location)
+                        return message
+                    end
+                rescue Object => boom
+                    Logger.error("Failed to match WHO type message: #{orig}")
+                    raise Exceptions::GeneralException.new(boom)
+                end
+            end
+            
+        end
+    end
+end

data/lib/mod_spox/handlers/Whois.rb

@@ -0,0 +1,117 @@
+require 'mod_spox/handlers/Handler'
+require 'mod_spox/messages/incoming/Whois'
+module ModSpox
+    module Handlers
+        class Whois < Handler
+            def initialize(handlers)
+                handlers[RFC[:RPL_WHOISUSER][:value]] = self
+                handlers[RFC[:RPL_WHOISSERVER][:value]] = self
+                handlers[RFC[:RPL_WHOISOPERATOR][:value]] = self
+                handlers[RFC[:RPL_WHOISIDLE][:value]] = self
+                handlers[RFC[:RPL_WHOISCHANNELS][:value]] = self
+                handlers[RFC[:RPL_WHOISIDENTIFIED][:value]] = self
+                handlers[RFC[:RPL_ENDOFWHOIS][:value]] = self
+                @cache = Hash.new
+                @raw = Hash.new
+            end
+            
+            def process(string)
+                orig = string.dup
+                string = string.dup
+                begin
+                    until(string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISUSER][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISSERVER][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISOPERATOR][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISIDLE][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISCHANNELS][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_WHOISIDENTIFIED][:value] ||
+                            string.slice(0..string.index(' ')-1) ==RFC[:RPL_ENDOFWHOIS][:value])
+                        string.slice!(0..string.index(' '))
+                    end
+                    case string.slice!(0..string.index(' ')-1)
+                        whenRFC[:RPL_WHOISUSER][:value]
+                            string.slice!(0)
+                            string.slice!(0..string.index(' '))
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            string.slice!(0)
+                            nick.username = string.slice!(0..string.index(' ')-1)
+                            string.slice!(0)
+                            nick.address = string.slice!(0..string.index(' ')-1)
+                            string.slice!(0..string.index(':'))
+                            nick.real_name = string
+                            nick.save_changes
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick)
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_WHOISCHANNELS][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            string.slice!(0..string.index(':'))
+                            string.split.each do |c|
+                                channel = find_model(['@','+'].include?(c.slice(0)) ? c.slice(1..c.size) : c)
+                                channel.add_nick(nick)
+                                @cache[nick.nick].channels_push(channel)
+                                if(c[0].chr == '@')
+                                    m = Models::NickMode.find_or_create(:nick_id => nick.pk, :channel_id => channel.pk)
+                                    m.set_mode('o')
+                                elsif(c[0].chr == '+')
+                                    m = Models::NickMode.find_or_create(:nick_id => nick.pk, :channel_id => channel.pk)
+                                    m.set_mode('v')
+                                else
+                                    m = Models::NickMode.find_or_create(:nick_id => nick.pk, :channel_id => channel.pk)
+                                    m.clear_modes
+                                end
+                            end
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_WHOISSERVER][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            string.slice!(0)
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            nick.connected_to = string.slice!(0..string.index(' ')-1)
+                            nick.save_changes
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_WHOISIDENTIFIED][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            nick.auth.services_identified = true
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_WHOISIDLE][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            string.slice!(0)
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            nick.seconds_idle = string.slice!(0..string.index(' ')-1).to_i
+                            string.slice!(0)
+                            nick.connected_at = Time.at(string.slice!(0..string.index(' ')-1).to_i)
+                            nick.save_changes
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_WHOISOPERATOR][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            string.slice!(0)
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            @cache[nick.nick].raw_push(orig)
+                        whenRFC[:RPL_ENDOFWHOIS][:value]
+                            2.times{string.slice!(0..string.index(' '))}
+                            nick = find_model(string.slice!(0..string.index(' ')-1))
+                            @cache[nick.nick] = Messages::Incoming::Whois.new(nick) unless @cache[nick.nick]
+                            @cache[nick.nick].raw_push(orig)
+                            message = @cache[nick.nick]
+                            message.lock
+                            @cache.delete(nick.nick)
+                            return message
+                        else
+                            Logger.error("Failed to parse WHOIS type reply. Unknown part found: #{orig}")
+                    end
+                    return nil
+                rescue Object => boom
+                    Logger.error("Failed to parse WHOIS type reply: #{orig}")
+                    raise Exceptions::GeneralException.new(boom)
+                end
+            end
+
+        end
+    end
+end

data/lib/mod_spox/handlers/YourHost.rb

@@ -0,0 +1,20 @@
+require 'mod_spox/handlers/Handler'
+require 'mod_spox/messages/incoming/YourHost'
+module ModSpox
+    module Handlers
+        class YourHost < Handler
+            def initialize(handlers)
+                handlers[RFC[:RPL_YOURHOST][:value]] = self
+            end
+            
+            def process(string)
+                if(string =~ /:Your host is (\S+), running version (.+)$/)
+                    return Messages::Incoming::YourHost.new(string, $1, $2)
+                else
+                    Logger.warn('Failed to match Your Host message')
+                    return nil
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/Messages.rb

@@ -0,0 +1,6 @@
+# Lazy loader for messages
+['incoming', 'outgoing', 'internal'].each do |dir|
+    Dir.new(File.dirname(__FILE__) + '/' + dir).each do |file|
+        require File.dirname(__FILE__) + '/' + dir + '/' + file if file =~ /\.rb$/
+    end
+end

data/lib/mod_spox/messages/incoming/BadNick.rb

@@ -0,0 +1,16 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class BadNick < Message
+                # nick that failed (string)
+                attr_reader :bad_nick
+                def initialize(raw, nick)
+                    super(raw)
+                    @bad_nick = nick
+                end
+            end
+        end
+    end
+end
+                

data/lib/mod_spox/messages/incoming/Bounce.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Bounce < Message
+                # server to connect to
+                attr_reader :server
+                # port to connect to
+                attr_reader :port
+                def initialize(raw, server, port)
+                    super(raw)
+                    @server = server
+                    @port = port
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Created.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Created < Message
+                # date server was created
+                attr_reader :date
+                def initialize(raw, date)
+                    super(raw)
+                    @date = date
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Invite.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Invite < Message
+                # source nick of invite
+                attr_reader :source
+                # target nick of invite
+                attr_reader :target
+                # channel invited to
+                attr_reader :channel
+                def initialize(raw, source, target, channel)
+                    super(raw)
+                    @source = source
+                    @target = target
+                    @channel = channel
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Join.rb

@@ -0,0 +1,19 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Join < Message
+                # channel that nick joined
+                attr_reader :channel
+                # nick that joined channel
+                attr_reader :nick
+                
+                def initialize(raw, channel, nick)
+                    super(raw)
+                    @channel = channel
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Kick.rb

@@ -0,0 +1,26 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Kick < Message
+                # channel user was kicked from
+                attr_reader :channel
+                # nick that performed the kick
+                attr_reader :kicker
+                # nick that was kicked
+                attr_reader :kickee
+                # reason for kick
+                attr_reader :reason
+                
+                def initialize(raw, channel, kicker, kickee, reason)
+                    super(raw)
+                    @channel = channel
+                    @kicker = kicker
+                    @kickee = kickee
+                    @reason = reason
+                end
+        
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/LuserChannels.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class LuserChannels < Message
+                # number of channels
+                attr_reader :channels
+                def initialize(raw, num)
+                    super(raw)
+                    @channels = num
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/LuserClient.rb

@@ -0,0 +1,24 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class LuserClient < Message
+                # number of visible users
+                attr_reader :users
+                # number of invisible users
+                attr_reader :invisible
+                # number of servers
+                attr_reader :servers
+                # number of services
+                attr_reader :services
+                def initialize(raw, user, invis, servers, services)
+                    super(raw)
+                    @users = user
+                    @invisible = invis
+                    @servers = servers
+                    @services = services
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/LuserMe.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class LuserMe < Message
+                # number of clients on server
+                attr_reader :clients
+                # number of servers
+                attr_reader :servers
+                def initialize(raw, clients, servers)
+                    super(raw)
+                    @clients = clients
+                    @servers = servers
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/LuserOp.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class LuserOp < Message
+                # number of operators visible
+                attr_reader :ops
+                def initialize(raw, num)
+                    super(raw)
+                    @ops = num
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/LuserUnknown.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class LuserUnknown < Message
+                # number of unknown users
+                attr_reader :unknown
+                def initialize(raw, num)
+                    super(raw)
+                    @unknown = num
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Message.rb

@@ -0,0 +1,22 @@
+module ModSpox
+    module Messages
+        module Incoming
+        
+            class Message
+                
+                # raw string from server
+                attr_reader :raw_content
+                
+                # time of message creation
+                attr_reader :time
+                
+                def initialize(content)
+                    @raw_content = content
+                    @time = Time.now
+                end
+        
+            end
+        
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Mode.rb

@@ -0,0 +1,42 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Mode < Message
+                
+                # mode string (will be two or more characters matching: /^[+\-][A-Za-z]+$/)
+                attr_reader :mode
+                
+                # mode channel (nil if target is nick (basically modes for the bot))
+                attr_reader :channel
+                
+                # nick mode is applied to (nil if mode change is for channel only)
+                # if multiple modes are applied to multiple nicks, this will be
+                # an array holding the nicks in order the mode string was applied
+                attr_reader :target
+                
+                # nick that applied the mode change
+                attr_reader :source
+                
+                def initialize(raw, mode, source, target, channel)
+                    super(raw)
+                    @mode = mode
+                    @channel = channel
+                    @source = source
+                    @target = target
+                end
+                
+                # If mode is for a nick
+                def for_nick?
+                    return @channel.nil?
+                end
+                
+                # If mode is for a channel
+                def for_channel?
+                    return @target.nil?
+                end
+                
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Motd.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Motd < Message
+                # Message of the day
+                attr_reader :motd
+                # Server message is from
+                attr_reader :server
+                def initialize(raw, motd, server)
+                    super(raw)
+                    @motd = motd
+                    @server = server
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/MyInfo.rb

@@ -0,0 +1,24 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class MyInfo < Message
+                # name of server connected to
+                attr_reader :servername
+                # version of server connected to
+                attr_reader :version
+                # user modes supported by server
+                attr_reader :user_modes
+                # channel modes supported by server
+                attr_reader :channel_modes
+                def initialize(raw, server, version, umodes, cmodes)
+                    super(raw)
+                    @servername = server
+                    @version = version
+                    @user_modes = umodes
+                    @channel_modes = cmodes
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Names.rb

@@ -0,0 +1,24 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Names < Message
+                # channel names are from
+                attr_reader :channel
+                # nicks in the channel
+                attr_reader :nicks
+                # ops in the channel
+                attr_reader :ops
+                # voiced nicks in channel
+                attr_reader :voiced
+                def initialize(raw, channel, nicks, ops, voiced)
+                    super(raw)
+                    @channel = channel
+                    @nicks = nicks
+                    @ops = ops
+                    @voiced = voiced
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Nick.rb

@@ -0,0 +1,26 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Nick < Message
+            
+                # previous nick
+                attr_reader :original_nick
+                # new nick
+                attr_reader :new_nick
+                
+                ## make sure old_nick is the source here
+                ## in the processor breaking the raw message
+                
+                # old_nick:: this should be the source
+                # new_nick:: this should be the target
+                def initialize(raw, old_nick, new_nick)
+                    super(raw)
+                    @original_nick = old_nick
+                    @new_nick = new_nick
+                end
+            
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/NickInUse.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class NickInUse < Message
+                # nick that is in use (string)
+                attr_reader :nick
+                def initialize(raw, nick)
+                    super(raw)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Notice.rb

@@ -0,0 +1,9 @@
+require 'mod_spox/messages/incoming/Privmsg'
+module ModSpox
+    module Messages
+        module Incoming
+            class Notice < Privmsg
+            end
+        end
+    end
+end