ircguerilla-irc 1.1.0

data/lib/irc/client/client_error.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: client_error.rb 85 2006-08-13 11:42:07Z roman $
+# 
+module IRC
+
+  module Client
+
+    class ClientError < Exception
+    end
+
+  end
+  
+end  

data/lib/irc/client/command_handler.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: command_handler.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    class CommandHandlerError < Exception
+    end
+    
+    class CommandHandler
+      
+      DELAY_IN_MS = 1000 / 1000
+      
+      # The delay in milliseconds between two commands that are sent to the server.      
+      attr_accessor :delay
+      
+      def initialize(context)
+        @log = Log4r::Logger.new('IRC::Client::CommandHandler')      
+        @context = context
+        @queue = Queue.new
+        @delay = DELAY_IN_MS
+      end
+      
+      # Sends the command through a queue to the server. Sending commands
+      # through a queue prevents from flooding the IRC server.
+      def <<(command)
+        send_command_via_queue(command)
+      end
+      
+      # 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"
+        @log.debug("[#{@context.network.to_s.upcase}] >>> #{command.to_s}")
+      end
+      
+      # Sends the command through a queue to the server. Sending commands through a queue prevents 
+      # from flooding the IRC server.
+      def send_command_via_queue(command)
+        @queue << command
+      end
+      
+      def start
+        
+        # Don't start the command handler if already started.
+        raise CommandHandlerError.new("Can't start command handler. Already started.") if @thread != nil
+        
+        # Start the command handler thread.        
+        @thread = Thread.new do
+
+          loop do
+            
+            # Get the next command from the command queue.
+            command = @queue.pop
+            
+            # Send the command to the server.
+            send_command(command)
+            
+            # Wait some milliseconds to prevent server flodding.
+            sleep(delay)
+            
+          end  
+                  
+        end
+        
+        @log.debug("[#{@context.network.to_s.upcase}] Command handler successfully started.")
+        
+      end
+      
+      def stop
+        
+        # Don't stop the command handler if already stopped.
+        raise CommandHandlerError.new("Can't stop command handler. Already stopped.") if @thread == nil
+        
+        # Kill the thread & clear the command queue.
+        @thread.kill
+        @queue.clear
+        
+        @log.debug("[#{@context.network.to_s.upcase}] Command handler successfully stopped.")
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/client/connected_state.rb

@@ -0,0 +1,95 @@
+#!/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: connected_state.rb 88 2006-08-13 12:42:58Z roman $
+# 
+require 'irc/client/client_error'
+require 'irc/client/connection_state'
+require 'irc/client/disconnected_state'
+require 'irc/commands/pong_command'
+require 'irc/commands/quit_command'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    class ConnectedState < ConnectionState
+      
+      def initialize
+        @log = Log4r::Logger.new('IRC::Client::ConnectedState')  
+      end
+      
+      # Connects to the server. 
+      def connect(context, server)
+        raise ClientError.new("Can't connect to server. Already connected to a server.")
+      end    
+      
+      # Disconnects from the currently connected server. 
+      def disconnect(context, message = nil)
+      
+        @log.debug("#{network_name(context)} Disconnecting from server #{context.server.hostname}.")
+      
+        # Send the quit command. If no quit message is given, the nick name will be
+        # send as the default quit message.
+        send_command(context, IRC::Commands::QuitCommand.new(message || context.nick))
+        
+        # Stop the command & message handlers.
+        context.stop_command_handler
+        context.stop_message_handler
+        
+        # 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
+        
+        # Change to the disconnected state.
+        change_state(context, DisconnectedState.instance)
+        
+      end 
+      
+      # Sends the command to the server bypassing the command queue.      
+      def send_command(context, command)
+        context.command_handler.send_command(command)
+      end
+      
+      # Sends the command to the server using the command queue.      
+      def send_command_via_queue(context, command)
+        context.command_handler.send_command_via_queue(command)  
+      end        
+      
+      # ConnectionListener
+      
+      # 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 + '.' : ''}")      
+      end
+      
+      
+    end
+    
+  end
+  
+end

data/lib/irc/client/connection.rb

@@ -0,0 +1,119 @@
+#!/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: connection.rb 85 2006-08-13 11:42:07Z roman $
+# 
+
+require 'irc/client/context'
+
+module IRC
+  
+  module Client
+    
+    class Connection
+      
+      MAX_CONNECTION_TIMEOUT_IN_SEC = 5
+      
+      def initialize(nick = nil, login = nil, realname = nil)
+        @context = IRC::Client::Connection::Context.new(nick, login, realname)
+      end
+      
+      # Adds a new connection listener. The connection listener gets notified when a 
+      # message was received from the IRC server.
+      def add_connection_listener(connection_listener)
+        @context.add_connection_listener(connection_listener)
+      end
+      
+      # Sends the command to the server using the command queue.
+      def <<(command)
+        @context<<(command)
+      end    
+      
+      # Connects to the server. 
+      def connect(server)
+        @network = server.network
+        state.connect(self, server)
+      end
+      
+      # Returns true if a connection to an IRC server has been established.
+      def connected?
+        @context.connected?
+      end
+      
+      # Disconnects from the currently connected server. 
+      def disconnect(message = nil)
+        @context.disconnect(message)
+      end
+      
+      # Joins the given channels.
+      def join(channels)
+        @context.join(channels)
+      end
+      
+      # Returns true, if the given channel is currently joined.
+      def joined?(channel)
+        @context.joined?(channel)
+      end
+      
+      # Returns an Array of all currently joined channels.        
+      def joined_channels
+        @context.joined_channels
+      end
+      
+      # The network to which the context is connected, or nil if no connection has been established.        
+      def network
+        @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?
+      end
+      
+      # Leaves the given channels.
+      def part(channels)
+        @context.part(channels)
+      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.
+      def remove_connection_listener(connection_listener)
+        @context.remove_connection_listener(connection_listener)
+      end
+      
+      # Sends the command to the server bypassing the command queue.      
+      def send_command(command)
+        @context.send_command(command)
+      end
+      
+      # Sends the command to the server using the command queue.      
+      def send_command_via_queue(command)
+        @context.send_command_via_queue(command)
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/client/connection_listener.rb

@@ -0,0 +1,97 @@
+#!/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: connection_listener.rb 90 2006-08-13 14:45:04Z roman $
+# 
+require 'irc/commands/pong_command'
+require 'irc/models/server'
+require 'log4r'
+
+module IRC
+  
+  module Client
+    
+    module ConnectionListener
+      
+      # This method gets called when successfully connected to an IRC server.
+      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)
+      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)
+      end
+      
+      # This method gets called when a notice message was received.
+      def on_notice(connection, user, message)
+      end
+      
+      # This method gets called when a user (possibly us) joins a channel.
+      def on_join(connection, channel, user)
+      end
+      
+      # This message gets called when a channel join attempt failed.
+      def on_join_failure(connection, channel, code, reason)
+      end
+      
+      # This method gets called when a user gets kicked from a channel.
+      def on_kick(connection, channel, kick_user, kicked_user, reason)
+      end
+      
+      # This method gets called when a user (possibly us) leaves a channel.
+      def on_part(connection, channel, user)
+      end
+      
+      # This method gets called when a channel part attempt failed.
+      def on_part_failure(connection, channel)
+      end
+      
+      # This method gets called when a ping message was received from the server.
+      def on_ping(connection, servers)
+      end
+      
+      # This method gets called when a pong message was received from the server.
+      def on_pong(connection, daemons)
+      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.
+      def on_server_response(connection, message)
+      end
+      
+    end
+    
+  end
+  
+end