ircguerilla-irc 1.1.0

data/lib/irc/client/message_handler.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: message_handler.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/messages/factory'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    class MessageHandlerError < Exception
+    end
+    
+    class MessageHandler
+      
+      def initialize(context)
+        @log = Log4r::Logger.new('IRC::Client::MessageHandler')
+        @context = context  
+      end
+      
+      def start
+        
+        # Don't start the command handler if already started.
+        raise MessageHandlerError.new("Can't start message handler. Already started.") if @thread != nil
+        
+        # Start the message handler thread.
+        @thread = Thread.new do
+          
+          loop do
+            
+            # Read the raw message from the socket.
+            raw_message = @context.socket.gets("\r\n")
+            
+            # Log the raw message.
+            @log.debug("[#{@context.network.to_s.upcase}] <<< #{raw_message.chomp}")
+             
+            # Create the message object & ask the message object to handle it.
+            message = message = IRC::Messages::Factory.create(raw_message)   
+            message.handle(@context)
+            
+          end
+          
+        end
+        
+        @log.debug("[#{@context.network.to_s.upcase}] Message handler successfully started.")
+        
+      end
+      
+      def stop
+        
+        # Don't stop the command handler if already stopped.
+        raise CommandHandlerError.new("Can't stop message handler. Already stopped.") if @thread == nil
+        
+        # Kill the thread.
+        @thread.kill
+        
+        @log.debug("[#{@context.network.to_s.upcase}] Message handler successfully stopped.")
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/client/registered_state.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: registered_state.rb 94 2006-08-13 21:40:40Z roman $
+# 
+require 'irc/client/client_error'
+require 'irc/client/connected_state'
+require 'irc/commands/join_command'
+require 'irc/commands/part_command'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    class RegisteredState < ConnectedState
+      
+      def initialize
+        @log = Log4r::Logger.new('IRC::Client::RegisteredState')  
+      end
+      
+      # Connects to the server. 
+      def connect(context, server)
+        raise ClientError.new("Can't connect to server. Already connected to a server.")
+      end      
+      
+      # Joins the given channels.
+      def join(context, channels)
+        IRC::Commands::JoinCommand.new(channels).send(context)
+      end
+      
+      # Leaves the given channels.
+      def part(context, channels)
+        IRC::Commands::PartCommand.new(channels).send(context)      
+      end      
+      
+      # ConnectionListener
+      
+      # This method gets called when a user (possibly us) joins a channel.
+      def on_join(context, channel, user)
+        return unless context.nick.strip.downcase == user.nick.strip.downcase
+        context.join_succeeded(channel) 
+        @log.debug("#{network_name(context)} Successfully joined channel #{channel}.")
+      end
+      
+      # This message gets called when a channel join attempt failed.
+      def on_join_failure(context, channel, code, reason)
+        @log.debug("#{network_name(context)} Failed to join channel #{channel}. #{reason.capitalize}.")
+      end
+      
+      # This method gets called when a user gets kicked from a channel.
+      def on_kick(context, channel, kick_user, kicked_user, reason)
+      end
+      
+      # This method gets called when a user (possibly us) leaves a channel.
+      def on_part(context, channel, user)
+        return unless context.nick.strip.downcase == user.nick.strip.downcase
+        context.part_succeeded(channel) 
+        @log.debug("#{network_name(context)} Successfully left channel #{channel}.")        
+      end
+      
+      # This method gets called when a channel part attempt failed.
+      def on_part_failure(connection, channel)
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/client/unregistered_state.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: unregistered_state.rb 90 2006-08-13 14:45:04Z roman $
+# 
+require 'irc/client/client_error'
+require 'irc/client/connected_state'
+require 'irc/client/registered_state'
+require 'irc/messages/error_message'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    class UnregisteredState < ConnectedState
+      
+      def initialize
+        @log = Log4r::Logger.new('IRC::Client::UnregisteredState')  
+      end
+      
+      # Joins the given channels.
+      def join(context, channels)
+        raise ClientError.new("Can't join any channel. The connection is not yet registered.")
+      end
+      
+      # Leaves the given channels.
+      def part(context, channels)
+        raise ClientError.new("Can't leave any channel. The connection is not yet registered.")
+      end
+      
+      # Sends a private message to the target (a nick or a channel).
+      def private_message(context, target, message)
+        raise ClientError.new("Can't send  a private message. The connection is not yet registered.")
+      end
+    
+      # ConnectionListener  
+      
+      # This method gets called when a message from the server is received.
+      def on_server_response(context, message)
+          
+        # The given nick name is not valid.  
+        if message.instance_of?(IRC::Messages::ErrorErroneusNickNameMessage)
+          registration_failure(context, message)               
+                  
+        # We didn't send a valid command. There are some parameters missing.       
+        elsif message.instance_of?(IRC::Messages::ErrorNeedMoreParametersMessage)            
+          registration_failure(context, message)     
+          
+        # Nick name collision.  
+        elsif message.instance_of?(IRC::Messages::ErrorNickCollisionMessage)
+          registration_failure(context, message)                        
+          
+        # The chosen nick name is already in use.  
+        elsif message.instance_of?(IRC::Messages::ErrorNickNameInUseMessage)
+          registration_failure(context, message)            
+          
+        # We didn't send a valid nick command. The nick name was missing.
+        elsif message.instance_of?(IRC::Messages::ErrorNoNickNameGivenMessage)
+          registration_failure(context, message)       
+        
+        # Ignore notice messages.
+        elsif message.instance_of?(IRC::Messages::NoticeMessage)  
+          return
+
+        # We are already registered. Did we miss something?      
+        elsif message.instance_of?(IRC::Messages::ErrorAlreadyRegisteredMessage)  
+          change_state(context, RegisteredState.instance)
+                  
+        # Everything ok. Change to the registered state.  
+        else
+          change_state(context, RegisteredState.instance)
+          
+        end
+      
+      end     
+      
+      protected
+
+      # Notify all connection listeners that an error occured during the connection registration.      
+      def registration_failure(context, message)       
+      
+        context.connection_listeners.each do |connection_listener|
+          connection_listener.on_registration_failure(context, message)
+        end
+      
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/commands/command.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    class Command
+    
+      def initialize(raw_command = "")
+        @raw_command = raw_command
+      end
+    
+      # Returns the command as a string.
+      def command
+        return @raw_command
+      end
+      
+      # Sends the command to the io object.
+      def send(io)
+        io << self
+      end
+      
+      # Returns the command as a string.
+      def to_s
+        return command
+      end
+  
+    end
+    
+  end
+  
+end  

data/lib/irc/commands/invalid_command.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: invalid_command.rb 85 2006-08-13 11:42:07Z roman $
+#  
+module IRC
+
+  module Commands
+
+    class InvalidCommand < Exception
+    end
+
+  end
+  
+end  

data/lib/irc/commands/join_command.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+# 
+# Copyright (c) 2006 Roman Scherer | IRC Guerilla | Rapid Packet Movement
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# $Id: join_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # 4.2.1 Join message
+    # 
+    # Command: 	    JOIN
+    # Parameters: 	<channel>{,<channel>} [<key>{,<key>}]
+    # 
+    # The JOIN command is used by client to start listening a specific channel. 
+    # Whether or not a client is allowed to join a channel is checked only by 
+    # the server the client is connected to; all other servers automatically add 
+    # the user to the channel when it is received from other servers. The conditions 
+    # which affect this are as follows:
+    # 
+    #    1. the user must be invited if the channel is invite-only;
+    #    2. the user's nick/username/hostname must not match any active bans;
+    #    3. the correct key (password) must be given if it is set.
+    # 
+    # These are discussed in more detail under the MODE command (see section 4.2.3 
+    # for more details).
+    # 
+    # Once a user has joined a channel, they receive notice about all commands their 
+    # server receives which affect the channel. This includes MODE, KICK, PART, QUIT 
+    # and of course PRIVMSG/NOTICE. The JOIN command needs to be broadcast to all 
+    # servers so that each server knows where to find the users who are on the channel. 
+    # This allows optimal delivery of PRIVMSG/NOTICE messages to the channel.
+    #
+    # If a JOIN is successful, the user is then sent the channel's topic (using 
+    # RPL_TOPIC) and the list of users who are on the channel (using RPL_NAMREPLY), 
+    # which must include the user joining.
+    # 
+    # Numeric Replies:
+    # 
+    # * ERR_NEEDMOREPARAMS 	
+    # * ERR_BANNEDFROMCHAN
+    # * ERR_INVITEONLYCHAN 	
+    # * ERR_BADCHANNELKEY
+    # * ERR_CHANNELISFULL 	
+    # * ERR_BADCHANMASK
+    # * ERR_NOSUCHCHANNEL 	
+    # * ERR_TOOMANYCHANNELS
+    # * RPL_TOPIC 	
+    # 
+    # Examples:
+    # 
+    # JOIN #foobar                ; join channel #foobar.
+    # 
+    # JOIN &foo fubar             ; join channel &foo using key "fubar".
+    # 
+    # JOIN #foo,&bar fubar        ; join channel #foo using key "fubar"
+    #                             ; and &bar using no key.
+    # 
+    # JOIN #foo,#bar fubar,foobar ; join channel #foo using key "fubar".
+    #                             ; and channel #bar using key "foobar".
+    # 
+    # JOIN #foo,#bar              ; join channels #foo and #bar.
+    # 
+    # :WiZ JOIN #Twilight_zone    ; JOIN message from WiZ
+    #    
+    class JoinCommand < Command
+      
+      attr_reader :channels
+      attr_reader :passwords
+      
+      def initialize(channels, passwords = [])
+
+        raise InvalidCommand.new("Can't create join command. No channels.") unless channels
+        
+        if channels.instance_of?(Array)
+          @channels = channels
+        else
+          @channels = Array.new
+          @channels << channels
+        end
+        
+        if passwords.instance_of?(Array)
+          @passwords = passwords
+        else
+          @passwords = Array.new
+          @passwords << passwords
+        end
+        
+      end
+      
+      def command 
+        return "JOIN #{channels.join(',')} #{passwords.join(',')}".strip
+      end
+      
+    end      
+    
+  end
+  
+end