ircguerilla-irc 1.2.0 → 1.3.0

data/lib/irc/client/command_handler.rb

@@ -56,7 +56,7 @@ module IRC
       # Sends the command directly to the server bypassing the queue. Sending commands too fast 
       # to the server can result in a disconnect from the server.
       def send_command(command)
-        @context.socket << "#{command.to_s}\r\n"
+        @context.output_socket << "#{command.to_s}\r\n"
         @log.debug("[#{@context.network.to_s.upcase}] >>> #{command.to_s}")
       end
       
@@ -99,7 +99,7 @@ module IRC
         raise CommandHandlerError.new("Can't stop command handler. Already stopped.") if @thread == nil
         
         # Kill the thread & clear the command queue.
-        @thread.kill
+        Thread.kill(@thread)
         @queue.clear
         
         @log.debug("[#{@context.network.to_s.upcase}] Command handler successfully stopped.")

data/lib/irc/client/connected_state.rb

@@ -26,6 +26,9 @@
 require 'irc/client/client_error'
 require 'irc/client/connection_state'
 require 'irc/client/disconnected_state'
+require 'irc/commands/nick_command'
+require 'irc/commands/password_command'
+require 'irc/commands/user_command'
 require 'irc/commands/pong_command'
 require 'irc/commands/quit_command'
 require 'log4r'
@@ -40,6 +43,10 @@ module IRC
         @log = Log4r::Logger.new('IRC::Client::ConnectedState')  
       end
       
+      # Changes the nick name.
+      def change_nick(context, nick)
+      end               
+      
       # Connects to the server. 
       def connect(context, server)
         raise ClientError.new("Can't connect to server. Already connected to a server.")
@@ -61,25 +68,63 @@ module IRC
         # Set network & server to nil.
         context.network = context.server = nil
         
-        # Close socket and set socket to nil.
-        context.socket.close if context.socket != nil
-        context.socket = nil
-        
+        # Close input/output socket and set them to nil.
+        context.input_socket.close if context.input_socket != nil && !context.input_socket.closed?
+        context.input_socket = nil
+
+        context.output_socket.close if context.output_socket != nil && !context.output_socket.closed?
+        context.output_socket = nil
+
         # Change to the disconnected state.
         change_state(context, DisconnectedState.instance)
         
       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. Connection registration is only possible in the unregistered state.")
+      end            
+      
       # ConnectionListener
+
+      def on_error(context, reason)
       
+        @log.debug("#{network_name(context)} Got disconnected from server #{context.server.hostname}. #{reason.capitalize}.")
+        
+        # Stop the command & message handlers.
+        context.stop_command_handler
+        context.stop_message_handler
+                
+        # Set network & server to nil.
+        context.network = context.server = nil
+        
+        # Close input/output socket and set them to nil.
+        context.input_socket.close if context.input_socket != nil && !context.input_socket.closed?
+        context.input_socket = nil
+
+        context.output_socket.close if context.output_socket != nil && !context.output_socket.closed?
+        context.output_socket = nil
+
+        # Change to the disconnected state.
+        change_state(context, DisconnectedState.instance)
+              
+      end
+                  
       # This method gets called when disconnected from a server.
-      def on_disconnect(connection, server, reason = nil)
-        log.debug("#{network_name(connection)} Successfully disconnected from #{server}. #{reason != nil ? reason + '.' : ''}")      
+      def on_disconnect(context, server, reason = nil)
+        log.debug("#{network_name(context)} Successfully disconnected from #{server}. #{reason != nil ? reason + '.' : ''}")      
       end
       
+      # This method gets called when a user changes it's nick name.
+      def on_nick(context, before, after)
+        return if before.nick.strip.downcase != context.nick.strip.downcase
+        context.nick = after.nick
+        @log.debug("#{network_name(context)} Successfully changed nick name from #{before.nick} to #{after.nick}.")              
+      end      
+      
       # This method gets called when a ping message was received from the server.
-      def on_ping(connection, servers)
-        IRC::Commands::PongCommand.new(servers[0], servers[1]).execute(connection)
+      def on_ping(context, servers)
+        IRC::Commands::PongCommand.new(servers[0], servers[1]).execute(context)
       end      
       
       

data/lib/irc/client/connection.rb

@@ -51,8 +51,7 @@ module IRC
       
       # Connects to the server. 
       def connect(server)
-        @network = server.network
-        state.connect(self, server)
+        @context.connect(server)
       end
       
       # Returns true if a connection to an IRC server has been established.
@@ -60,6 +59,11 @@ module IRC
         @context.connected?
       end
       
+      # Returns all registered connection listeners.
+      def connection_listeners
+        return @context.connection_listeners
+      end
+      
       # Disconnects from the currently connected server. 
       def disconnect(message = nil)
         @context.disconnect(message)
@@ -85,16 +89,41 @@ module IRC
         @context.network
       end
       
-      # Returns true if a connection to an IRC server has been established and the connection
-      # has been successfully registered.
-      def registered?
-        @context.registered?
+      # Returns the nick name that is used when connected to an IRC server.
+      def nick
+        @context.nick
+      end
+      
+      # Returns the nick name that is used when connected to an IRC server.
+      def nick=(new_nick)
+        @context.change_nick(new_nick)
+      end
+
+      # Returns the supported options of the currently connected server.
+      def options
+        return @context.options
       end
       
       # Leaves the given channels.
       def part(channels)
         @context.part(channels)
       end       
+
+      # Returns the real name that is used when connected to an IRC server.
+      def realname
+        @context.realname
+      end
+      
+      # Register the connection by sending the password, nick and user commands.
+      def register(nick = nil, login = nil, realname = nil)
+        @context.register(nick, login, realname)
+      end        
+
+      # Returns true if a connection to an IRC server has been established and the connection
+      # has been successfully registered.
+      def registered?
+        @context.registered?
+      end
       
       # Removes a previously added connection listener. The connection listener will not
       # get notified any longer when a message was received from the IRC server.
@@ -112,6 +141,12 @@ module IRC
         @context.send_command_via_queue(command)
       end
       
+      # Returns the server, to which the connection object is connected to.      
+      def server
+        return @context.server
+      end
+      
+      
     end
     
   end

data/lib/irc/client/connection_listener.rb

@@ -35,17 +35,12 @@ module IRC
       def on_connect(connection, server)
       end
       
-      # This method gets called when disconnected from a server.
-      def on_disconnect(connection, server, reason = nil)
-      end
-      
-      # This method gets called when a private message was received from a channel or an user.
-      def on_private_message(connection, target, message)
+      # This method gets called an error message was received from the IRC server.
+      def on_error(connection, reason)
       end
       
-      # This method gets called when a user sends a public message 
-      # to a channel. If the message was a private message the channel is nil.
-      def on_need_more_parameters(connection, nick)
+      # This method gets called when disconnected from a server.
+      def on_disconnect(connection, server, reason = nil)
       end
       
       # This method gets called when a notice message was received.
@@ -61,9 +56,17 @@ module IRC
       end
       
       # This method gets called when a user gets kicked from a channel.
-      def on_kick(connection, channel, kick_user, kicked_user, reason)
+      def on_kick(connection, channel, kicker_user, kicked_user, reason)
+      end
+      
+      # This method gets called when a user changes it's nick name.
+      def on_nick(connection, before, after)
       end
       
+      # This method gets called when the chosen nick name is already in use.
+      def on_nick_already_in_use(connection, nick_name)
+      end      
+      
       # This method gets called when a user (possibly us) leaves a channel.
       def on_part(connection, channel, user)
       end
@@ -80,14 +83,26 @@ module IRC
       def on_pong(connection, daemons)
       end
       
+      # This method gets called when a private message was received from a channel or an user.
+      def on_private_message(connection, target, message)
+      end
+      
+      # This method gets called when the connection was successfully registered.
+      def on_registration(connection)
+      end
+      
       # This method gets called when an error happend during the connection registration.
       def on_registration_failure(connection, message)
       end
       
-      # This method gets called when a message from the server is received.
+      # This method gets called when a message from the server was received.
       def on_server_response(connection, message)
       end
       
+      # This method gets called when a welcome message was received.
+      def on_welcome(connection, user, text)
+      end
+
     end
     
   end

data/lib/irc/client/connection_state.rb

@@ -35,6 +35,10 @@ module IRC
       include ConnectionListener      
       include ::Singleton
       
+      # Changes the nick name.
+      def change_nick(context, nick)
+      end               
+      
       # Connects to the server. 
       def connect(context, server)
       end      
@@ -54,6 +58,10 @@ module IRC
       # Sends a private message to the target (a nick or a channel).
       def private_message(context, target, message)
       end
+      
+      # Register the connection by sending the password, nick and user commands.
+      def register(context, nick, login, realname)
+      end
 
       # Sends the command to the server bypassing the command queue.      
       def send_command(context, command)
@@ -68,8 +76,13 @@ module IRC
       # ConnectionListener
       
       # This method gets called when a ping message was received from the server.
-      def on_ping(connection, servers)
-        IRC::Commands::PongCommand.new(servers[0], servers[1]).send(connection)
+      def on_ping(context, servers)
+        IRC::Commands::PongCommand.new(servers[0], servers[1]).execute(context)
+      end
+      
+      # This method gets called when a welcome message was received.
+      def on_welcome(context, user, text)
+        context.nick = user.nick
       end
       
       protected

data/lib/irc/client/context.rb

@@ -29,6 +29,7 @@ require 'irc/client/context'
 require 'irc/client/connection_listener'
 require 'irc/client/disconnected_state'
 require 'irc/client/message_handler'
+require 'irc/util/nick_generator'
 require 'log4r'
 
 module IRC
@@ -46,30 +47,40 @@ module IRC
         
         # The connection listeners that get notified when a message was received by the IRC server.
         attr_reader :connection_listeners
-
-        # The login name that is used when connected to an IRC server.
-        attr_reader :login
-
-        # The nick name that is used when connected to an IRC server.
-        attr_reader :nick
-
-        # The real name that is used when connected to an IRC server.
-        attr_reader :realname
+        
+        # The nick name generator that used, when automatic nick name change is enabled.
+        attr_reader :nick_generator
         
         # The context's current state. The initial state is disconnected.
         attr_reader :state
 
         # ACCESSOR       
 
+        # When set to true the connection object changes the nick name automatically when 
+        # the chosen name is already in use.
+        attr_accessor :auto_nick_change
+
+        # The login name that is used when connected to an IRC server.
+        attr_accessor :login
+
         # The network to which the context is connected., or nil if no connection has been established.        
         attr_accessor :network
 
+        # The nick name that is used when connected to an IRC server.
+        attr_accessor :nick
+
+        # The real name that is used when connected to an IRC server.
+        attr_accessor :realname
+
+        # The options that are supported by the server.
+        attr_accessor :options
+
         # The IRC server the context is connected to, or nil if no connection has been established. 
         attr_accessor :server        
 
         # The TCPSocket the context uses to talk to the IRC server.
-        attr_accessor :socket
-        
+        attr_writer :input_socket
+        attr_writer :output_socket        
         
         def initialize(nick = nil, login = nil, realname = nil)
           
@@ -82,6 +93,10 @@ module IRC
           @login = login || ENV['USER'] || ENV['USERNAME'] || nick
           @realname = realname || ENV['USER'] || ENV['USERNAME'] || nick
           
+          # Enable automatic nick change. Use the nick name generator.
+          @auto_nick_change = true
+          @nick_generator = IRC::Util::NickGenerator.new(@nick)
+          
           # A hash to keep track of currently joined channels.
           @joined_channels = Hash.new
           
@@ -97,6 +112,9 @@ module IRC
           # Change into the disconnected state.
           change_state(DisconnectedState.instance)
           
+          # The options from the isupport messages.
+          @options = Hash.new
+          
         end
         
         # Adds a new connection listener. The connection listener gets notified when a 
@@ -110,6 +128,11 @@ module IRC
           send_command_via_queue(command)
         end
         
+        # Changes the context's state to the next state,
+        def change_nick(new_nick)
+          state.change_nick(self, new_nick)
+        end        
+        
         # Changes the context's state to the next state,
         def change_state(next_state)
 
@@ -144,6 +167,16 @@ module IRC
         def disconnect(message = nil)
           state.disconnect(self, message)        
         end
+
+        # Returns the socket, that is used to receive messages from the server.   
+        def input_socket
+          return @input_socket
+        end
+        
+        # Returns the socket, that is used to send commands to the server.   
+        def output_socket
+          return @output_socket
+        end
         
          # Joins the given channels.
         def join(channels)
@@ -195,6 +228,11 @@ module IRC
           state.part(self, channels)
         end    
         
+        # Register the connection by sending the password, nick and user commands.
+        def register(nick = nil, login = nil, realname = nil)
+          state.register(self, nick || self.nick, login || self.login, realname || self.realname)
+        end        
+        
         # Returns true if a connection to an IRC server has been established and the connection
         # has been successfully registered.
         def registered?

data/lib/irc/client/disconnected_state.rb

@@ -27,9 +27,6 @@ require 'irc/client/client_error'
 require 'irc/client/connection'
 require 'irc/client/connection_state'
 require 'irc/client/unregistered_state'
-require 'irc/commands/nick_command'
-require 'irc/commands/password_command'
-require 'irc/commands/user_command'
 require 'irc/models/server'
 require 'log4r'
 require 'socket'
@@ -46,34 +43,39 @@ module IRC
         @log = Log4r::Logger.new('IRC::Client::DisconnectedState')  
       end
       
+      # Changes the nick name.
+      def change_nick(context, nick)
+        raise ClientError.new("Can't change nick name. Not connected to a server.")
+      end               
+      
       # Connects to the server. 
       def connect(context, server)
         
         @log.debug("#{network_name(context)} Trying to connect to server #{server.hostname} on port #{server.port}.")
         
         # Establish the connection to the server.        
-        context.socket = establish_connection(server)
+        establish_connection(context, server)
         
         # Set the server to which we are connected.    
         context.server = server
         
+        # Clear the supported options, that get initialized by the isupport messages.
+        context.options = Hash.new
+        
         # Initialize and start the command & message handlers.
         context.start_command_handler
-        context.start_message_handler        
+        context.start_message_handler      
         
         # Change to the unregistered state.
         change_state(context, UnregisteredState.instance)                  
         
-        # Send the connection registration commands.
-        if server.password
-          context.send_command_via_queue(IRC::Commands::PasswordCommand.new(server.password))
-        end          
-        
-        context.send_command_via_queue(IRC::Commands::NickCommand.new(context.nick))
-        context.send_command_via_queue(IRC::Commands::UserCommand.new(context.nick, Socket.gethostname, server.hostname, context.realname))
+        # Notify all connection listeners that we are successfully connected now.
+        context.connection_listeners.each do |connection_listener|
+          connection_listener.on_connect(context, server)
+        end  
         
-#      rescue Exception => e
-#        raise ClientError.new("Can't connect to server #{server.hostname} on port #{server.port}. #{e.message.capitalize}.")
+      rescue Exception => e
+        raise ClientError.new("Can't connect to server #{server.hostname} on port #{server.port}. #{e.message.capitalize}.")
         
       end      
       
@@ -97,6 +99,11 @@ module IRC
         raise ClientError.new("Can't send a private message. Not connected to a server.")            
       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. Not connected to a server.")                  
+      end
+      
       # Sends the command to the server bypassing the command queue.      
       def send_command(context, command)
         raise ClientError.new("Can't send command. Not connected to a server.")
@@ -116,11 +123,16 @@ module IRC
       
       private
       
-      def establish_connection(server)
+      def establish_connection(context, server)
       
         # Try to connect to the server before the timeout exceeds.
         Timeout::timeout(Connection::MAX_CONNECTION_TIMEOUT_IN_SEC) do
-          return TCPSocket.open(server.hostname, server.port)
+          
+          socket = TCPSocket.open(server.hostname, server.port)
+          
+          context.input_socket = socket
+          context.output_socket = socket          
+          
         end 
       
       end