ircguerilla-irc 1.2.0 → 1.3.0

data/lib/irc/client/message_handler.rb

@@ -23,8 +23,10 @@
 #
 # $Id: message_handler.rb 85 2006-08-13 11:42:07Z roman $
 # 
+require 'irc/client/disconnected_state'
 require 'irc/messages/factory'
 require 'log4r'
+require 'timeout'
 
 module IRC
   
@@ -38,6 +40,7 @@ module IRC
       def initialize(context)
         @log = Log4r::Logger.new('IRC::Client::MessageHandler')
         @context = context  
+        @terminate = false
       end
       
       def start
@@ -45,21 +48,38 @@ module IRC
         # Don't start the command handler if already started.
         raise MessageHandlerError.new("Can't start message handler. Already started.") if @thread != nil
         
+        # Terminate the message reading loop if true.
+        @terminate = false
+        
         # Start the message handler thread.
         @thread = Thread.new do
           
-          loop do
-            
-            # Read the raw message from the socket.
-            raw_message = 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)
-            
+          while @terminate == false do
+  
+            begin
+  
+              raw_message = nil
+              
+              # Read the raw message from the socket.              
+              Timeout::timeout(0.5) do
+                raw_message = socket.gets("\r\n")
+              end                
+              
+              # 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)
+              
+            rescue IOError => e        
+              @terminate = true
+              @thread = nil
+              
+            rescue Timeout::Error => e
+              # Ok
+            end              
+
           end
           
         end
@@ -71,11 +91,15 @@ module IRC
       def stop
         
         # Don't stop the command handler if already stopped.
-        raise CommandHandlerError.new("Can't stop message handler. Already stopped.") if @thread == nil
+        raise MessageHandlerError.new("Can't stop message handler. Already stopped.") if @thread == nil
         
-        # Kill the thread.
-        @thread.kill
+        # Terminate the message reading loop.
+        @terminate = true
         
+        # Kill the thread.
+#        Thread.kill(@thread)
+
+        @thread = nil
         @log.debug("[#{@context.network.to_s.upcase}] Message handler successfully stopped.")
         
       end
@@ -83,7 +107,7 @@ module IRC
       private
       
       def socket
-        return @context.socket
+        return @context.input_socket
       end
       
     end

data/lib/irc/client/registered_state.rb

@@ -26,6 +26,7 @@
 require 'irc/client/client_error'
 require 'irc/client/connected_state'
 require 'irc/commands/join_command'
+require 'irc/commands/nick_command'
 require 'irc/commands/part_command'
 require 'log4r'
 
@@ -39,6 +40,11 @@ module IRC
         @log = Log4r::Logger.new('IRC::Client::RegisteredState')  
       end
       
+      # Changes the nick name.
+      def change_nick(context, nick)
+        IRC::Commands::NickCommand.new(nick).execute(context)
+      end              
+      
       # Connects to the server. 
       def connect(context, server)
         raise ClientError.new("Can't connect to server. Already connected to a server.")
@@ -54,6 +60,11 @@ module IRC
         IRC::Commands::PartCommand.new(channels).execute(context)      
       end      
       
+      # Register the connection by sending the password, nick and user commands.
+      def register(context, nick, login, realname)
+        raise ClientError.new("Can't register connection again. Already registered.")                  
+      end
+      
       # ConnectionListener
       
       # This method gets called when a user (possibly us) joins a channel.
@@ -72,6 +83,13 @@ module IRC
       def on_kick(context, channel, kick_user, kicked_user, reason)
       end
       
+      # This method gets called when the chosen nick name is already in use.
+      def on_nick_already_in_use(context, nick_name)
+        return unless context.auto_nick_change
+        raise ClientError("Maximum number of nick name changes reached. Giving up!") if context.nick_generator.names.empty?
+        context.change_nick(context.nick_generator.pop) 
+      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

data/lib/irc/client/unregistered_state.rb

@@ -29,6 +29,8 @@ require 'irc/client/registered_state'
 require 'irc/messages/error_message'
 require 'irc/commands/nick_command'
 require 'irc/messages/notice_message'
+require 'irc/commands/password_command'
+require 'irc/messages/ping_message'
 require 'irc/commands/user_command'
 require 'log4r'
 
@@ -42,6 +44,11 @@ module IRC
         @log = Log4r::Logger.new('IRC::Client::UnregisteredState')  
       end
       
+      # Changes the nick name.
+      def change_nick(context, nick)
+        raise ClientError.new("Can't change nick name. The connection is not yet registered.")
+      end               
+      
       # Joins the given channels.
       def join(context, channels)
         raise ClientError.new("Can't join any channel. The connection is not yet registered.")
@@ -56,7 +63,21 @@ module IRC
       def private_message(context, target, message)
         raise ClientError.new("Can't send  a private message. The connection is not yet registered.")
       end
-    
+      
+      # Register the connection by sending the password, nick and user commands.
+      def register(context, nick, login, realname)
+
+        if context.server.password
+          IRC::Commands::PasswordCommand.new(context.server.password).execute(context)
+        end          
+        
+        IRC::Commands::NickCommand.new(nick).execute(context)
+        IRC::Commands::UserCommand.new(nick, Socket.gethostname, context.server.hostname, realname).execute(context)
+        
+        context.nick, context.login, context.realname = nick, login, realname
+
+      end            
+     
       # ConnectionListener  
       
       # This method gets called when a message from the server is received.
@@ -67,36 +88,45 @@ module IRC
           # Ignore notice messages.
           when IRC::Messages::NoticeMessage::CODE
             return
+            
+          # Ignore ping messages.
+          when IRC::Messages::PingMessage::CODE
+            return
                   
           # The given nick name is not valid.  
           when IRC::Messages::ErrorErroneusNickNameMessage::CODE
-            registration_failure(context, message)               
+            registration_failure(context, message)   
+            return            
                     
           # We didn't send a valid command. There are some parameters missing.       
           when IRC::Messages::ErrorNeedMoreParametersMessage::CODE
             registration_failure(context, message)     
-            
+            return
+                        
           # Nick name collision.  
           when IRC::Messages::ErrorNickCollisionMessage::CODE
             registration_failure(context, message)                        
-            
+            return
+                        
           # The chosen nick name is already in use.  
           when IRC::Messages::ErrorNickNameInUseMessage::CODE
             registration_failure(context, message)            
-            
+            return
+                        
           # We didn't send a valid nick command. The nick name was missing.
           when IRC::Messages::ErrorNoNickNameGivenMessage::CODE
             registration_failure(context, message)       
-  
-          # We are already registered. Did we miss something?      
-          when IRC::Messages::ErrorAlreadyRegisteredMessage::CODE
-            change_state(context, RegisteredState.instance)
-                    
-          # Everything ok. Change to the registered state.  
-          else
-            change_state(context, RegisteredState.instance)
+            return
+        
+        end          
+        
+          # Everything ok. Change to the registered state.            
+          change_state(context, RegisteredState.instance)
             
-          end
+          # Notify all connection listeners that we are successfully connected now.
+          context.connection_listeners.each do |connection_listener|
+            connection_listener.on_registration(context)
+          end  
       
       end     
       
@@ -109,8 +139,13 @@ module IRC
           connection_listener.on_registration_failure(context, message)
         end
         
-        IRC::Commands::NickCommand.new("au_lasa").execute(context)
-        IRC::Commands::UserCommand.new("au_lasa", Socket.gethostname, server.hostname, context.realname).execute(context)
+        return unless context.auto_nick_change
+        
+        raise ClientError("Maximum number of nick name changes reached. Giving up!") if context.nick_generator.names.empty?
+        nick = context.nick_generator.pop
+        
+        IRC::Commands::NickCommand.new(nick).execute(context)
+        IRC::Commands::UserCommand.new(nick, Socket.gethostname, context.server.hostname, context.realname).execute(context)
       
       end
       

data/lib/irc/commands/nick_command.rb

@@ -25,6 +25,7 @@
 # 
 require 'irc/commands/command'
 require 'irc/commands/invalid_command'
+require 'irc/messages/notice_message'
 
 module IRC
   
@@ -80,6 +81,19 @@ module IRC
         return "NICK #{nick} #{hopcount ? hopcount.to_s : ''}"
       end
       
+      # This method gets called when a message from the server is received. 
+      def on_server_response(connection, message)
+
+        # Ignore notice messages      
+        return if message.code == IRC::Messages::NoticeMessage::CODE
+        
+        if !connection.registered? || (connection.registered? && message.code == IRC::Messages::NickMessage::CODE)
+          connection.remove_connection_listener(self)
+          @response = message
+        end
+        
+      end      
+      
     end      
   
   end

data/lib/irc/messages/error_join_message.rb

@@ -57,7 +57,7 @@ module IRC
         super(raw_message)      
         
         match_data = Regexp.new('(\S+)\s+(\S+)\s+:?(.+)').match(message)
-        raise InvalidMessage.new("Can't parse join error message. Invalid message format.") unless match_data
+        raise InvalidMessage.new("Can't parse 'nick already in use' message. Invalid message format.") unless match_data
         
         # Extract nick & channel name and the error reason.
         @nick, @channel, @reason = match_data[1], match_data[2], match_data[3]

data/lib/irc/messages/error_message.rb

@@ -32,59 +32,88 @@ module IRC
   module Messages
     
     class ErrorMessage < Message
+      
+      CODE = "ERROR"
+      
+      attr_reader :reason
+      
+      # Notify all connection listeners, that a user changed it's nick name.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_nick method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_error(context, reason)
+        end
+        
+      end
+      
+      protected      
+      
+      def parse(raw_message)
+        
+        # Initialize the base message fields.
+        super(raw_message)      
+        
+        # Match the message against the message format.
+        match_data = Regexp.new('\s*ERROR\s+:?(.+)').match(raw_message)
+        raise InvalidMessage.new("Can't parse error message. Invalid message format.") unless match_data
+        
+        @reason = match_data[1]
+
+      end      
+      
     end      
     
-    class JoinFailureMessage < ErrorMessage
-    end
+#    class JoinFailureMessage < Message
+#    end
+#    
+#    class PartFailureMessage < Message
+#    end
     
-    class PartFailureMessage < ErrorMessage
-    end
-    
-    class ErrorAlreadyRegisteredMessage < ErrorMessage
+    class ErrorAlreadyRegisteredMessage < Message
       CODE = ERR_ALREADYREGISTRED
     end
     
     class ErrorBadChannelKeyMessage < ErrorJoinMessage
       CODE = ERR_BADCHANNELKEY
     end          
-
+    
     class ErrorBadChannelMaskMessage < ErrorJoinMessage
       CODE = ERR_BADCHANMASK
     end          
-
+    
     class ErrorBannedFromChannelMessage < ErrorJoinMessage
       CODE = ERR_BANNEDFROMCHAN
     end          
-
+    
     class ErrorChannelIsFulMessage < ErrorJoinMessage
       CODE = ERR_CHANNELISFULL
     end          
-
-    class ErrorErroneusNickNameMessage < ErrorMessage
+    
+    class ErrorErroneusNickNameMessage < Message
       CODE = ERR_ERRONEUSNICKNAME
     end      
-
+    
     class ErrorInviteOnlyChannelMessage < ErrorJoinMessage
       CODE = ERR_INVITEONLYCHAN
     end      
     
-    class ErrorNeedMoreParametersMessage < ErrorMessage
+    class ErrorNeedMoreParametersMessage < Message
       CODE = ERR_NEEDMOREPARAMS
     end          
-
-    class ErrorNickCollisionMessage < ErrorMessage
+    
+    class ErrorNickCollisionMessage < Message
       CODE = ERR_NICKCOLLISION
     end      
-
-    class ErrorNickNameInUseMessage < ErrorMessage
-      CODE = ERR_NICKNAMEINUSE
-    end      
     
-    class ErrorNoNickNameGivenMessage < ErrorMessage
+    class ErrorNoNickNameGivenMessage < Message
       CODE = ERR_NONICKNAMEGIVEN
     end      
     
-    class ErrorNoOriginMessage < ErrorMessage
+    class ErrorNoOriginMessage < Message
       CODE = ERR_NOORIGIN
     end
     
@@ -92,14 +121,14 @@ module IRC
       CODE = ERR_NOSUCHCHANNEL
     end      
     
-    class ErrorNoSuchServerMessage < ErrorMessage
+    class ErrorNoSuchServerMessage < Message
       CODE = ERR_NOSUCHSERVER
     end      
     
-    class ErrorNotOnChannelMessage < ErrorMessage
+    class ErrorNotOnChannelMessage < Message
       CODE = ERR_NOTONCHANNEL
     end 
-
+    
     class ErrorTooManyChannelsMessage < ErrorJoinMessage
       CODE = ERR_TOOMANYCHANNELS
     end      

data/lib/irc/messages/error_nick_name_in_use_message.rb

@@ -0,0 +1,70 @@
+#!/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: nick_message.rb 89 2006-08-13 14:03:35Z roman $
+# 
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+
+    class ErrorNickNameInUseMessage < Message
+    
+      CODE = ERR_NICKNAMEINUSE
+      
+      attr_reader :nick_name_in_use
+      
+      # Notify all connection listeners, that a user changed it's nick name.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_nick method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_nick_already_in_use(context, nick_name_in_use)
+        end
+
+      end
+      
+      protected      
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        super(raw_message)      
+
+        # Match the message against the message format.
+        match_data = Regexp.new('\\*\s+(\S+)\s+:?(\S+)\s*').match(raw_message)
+        raise InvalidMessage.new("Can't parse nick message. Invalid message format.") unless match_data
+
+        @nick_name_in_use = match_data[1]
+      end
+      
+    end      
+    
+  end
+  
+end