ircguerilla-irc 1.1.0

data/lib/irc/messages/factory.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: factory.rb 93 2006-08-13 21:30:53Z roman $
+# 
+require 'irc/messages/message'
+require 'irc/messages/error_message'
+require 'irc/messages/join_message'
+require 'irc/messages/nick_message'
+require 'irc/messages/notice_message'
+require 'irc/messages/part_message'
+require 'irc/messages/ping_message'
+require 'irc/messages/pong_message'
+
+module IRC
+  
+  module Messages
+    
+    class Factory
+      
+      def self.create(raw_message)
+      
+        # Remove new line from raw message if available.
+        raw_message.chomp!
+
+        # Create a new message object, to get access to the message code.        
+        message = Message.new(raw_message)
+        
+        # Create a new specialized message object, depending on the message code.
+        case message.code     
+        
+        when ErrorAlreadyRegisteredMessage::CODE
+          return ErrorAlreadyRegisteredMessage.new(raw_message)
+        
+        when ErrorBadChannelKeyMessage::CODE
+          return ErrorBadChannelKeyMessage.new(raw_message)   
+          
+        when ErrorBadChannelMaskMessage::CODE
+          return ErrorBadChannelMaskMessage.new(raw_message)          
+          
+        when ErrorBannedFromChannelMessage::CODE
+          return ErrorBannedFromChannelMessage.new(raw_message)
+          
+        when ErrorChannelIsFulMessage::CODE
+          return ErrorChannelIsFulMessage.new(raw_message)
+        
+        when ErrorErroneusNickNameMessage::CODE
+          return ErrorErroneusNickNameMessage.new(raw_message)
+          
+        when ErrorInviteOnlyChannelMessage::CODE
+          return ErrorInviteOnlyChannelMessage.new(raw_message)
+          
+        when ErrorNeedMoreParametersMessage::CODE
+          return ErrorNeedMoreParametersMessage.new(raw_message)                    
+
+        when ErrorNickCollisionMessage::CODE
+          return ErrorNickCollisionMessage.new(raw_message)
+
+        when ErrorNickNameInUseMessage::CODE
+          return ErrorNickNameInUseMessage.new(raw_message)
+
+        when ErrorNoNickNameGivenMessage::CODE
+          return ErrorNoNickNameGivenMessage.new(raw_message)
+          
+        when ErrorNoSuchChannelMessage::CODE
+          return ErrorNoSuchChannelMessage.new(raw_message)
+          
+        when ErrorNotOnChannelMessage::CODE
+          return ErrorNotOnChannelMessage.new(raw_message)          
+          
+        when ErrorTooManyChannelsMessage::CODE
+          return ErrorTooManyChannelsMessage.new(raw_message)             
+
+        when JoinMessage::CODE
+          return JoinMessage.new(raw_message)
+          
+        when NickMessage::CODE
+          return NickMessage.new(raw_message)
+
+        when NoticeMessage::CODE
+          return NoticeMessage.new(raw_message)
+
+        when PartMessage::CODE
+          return PartMessage.new(raw_message)
+          
+        when PingMessage::CODE
+          return PingMessage.new(raw_message)          
+
+        when PongMessage::CODE
+          return PongMessage.new(raw_message)          
+          
+        end
+        
+        return message
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/irc/messages/invalid_message.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_message.rb 85 2006-08-13 11:42:07Z roman $
+# 
+module IRC
+
+  module Messages
+
+    class InvalidMessage < Exception
+    end
+
+  end
+  
+end  

data/lib/irc/messages/join_message.rb

@@ -0,0 +1,130 @@
+#!/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$
+# 
+require 'irc/commands/pong_command'
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+   
+    # 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 JoinMessage < Message
+    
+      CODE = "JOIN"
+
+      attr_reader :channel
+      
+      # Notify all connection listeners, that a user has joined a channel.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_join method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_join(context, context.lookup_channel(channel), context.lookup_user(nick)) 
+        end
+        
+      end
+      
+      protected
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        super(raw_message)      
+        
+        # Extract the message specific fields.
+        match_data = Regexp.new(':?(.+)').match(message)
+        raise InvalidMessage.new("Can't parse join message. Invalid message format.") if match_data == nil || code != CODE
+        
+        # Extract the channel name.
+        @channel = match_data[1]
+                
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/messages/message.rb

@@ -0,0 +1,110 @@
+#!/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.rb 93 2006-08-13 21:30:53Z roman $
+# 
+require 'pp'
+require 'irc/messages/codes'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+    class Message
+    
+      include Codes
+    
+      MESSAGE_FORMAT = Regexp.new('(:([^!\s]+)(!([^@\s]+))?(@(\S+))?\s+)?(\w+|\d\d\d)\s+(.*)')      
+
+      attr_reader :code
+      attr_reader :host
+      attr_reader :message      
+      attr_reader :nick
+      attr_reader :raw_message      
+      attr_reader :server
+      attr_reader :login      
+      
+      def initialize(raw_message)
+        parse(raw_message)
+      end
+      
+      # Notify all connection listeners that a message was received from the IRC server, 
+      # by calling their on_server_response method.
+      def handle(context)
+
+        # Notify all connection listeners by calling their on_server_response method.
+        notify(context) do |connection_listener|
+          connection_listener.on_server_response(context, self)
+        end
+        
+      end
+      
+      # Returns true if the given string matches the IRC message format, else false.
+      def self.is_valid?(raw_message)
+        return Regexp.new(MESSAGE_FORMAT).match(raw_message) != nil
+      end
+      
+      protected
+
+      # Notify all connection listeners, by calling the surrounding block with a channel listener as parameter.
+      def notify(context)
+      
+        context.connection_listeners.each do |connection_listener|
+          yield connection_listener
+        end
+      
+      end
+      
+      def parse(raw_message)        
+      
+        # Throw an exception if the given message doesn't match the IRC message format.      
+        raise InvalidMessage.new("Can't create message. Invalid IRC message format.") unless Message.is_valid?(raw_message)
+        
+        # Save the raw message for later use.
+        @raw_message = raw_message
+        
+        # Parse the raw message & initialize the IRC message fields.
+        match_data = MESSAGE_FORMAT.match(raw_message)
+        
+        # Extract nick & server. 
+        @nick = match_data[2]        
+        @server = match_data[4] != nil || match_data[6] != nil ? nil : match_data[2]                
+        
+        # Extract the login & host name.
+        @login = match_data[4]
+        @host = match_data[6]        
+
+        # Extract the IRC message code. If the code is a number, convert it to an integer.
+        @code = (match_data[7] =~ /\d+/ ? match_data[7].to_i : match_data[7])
+      
+        # Extract the rest of the message. The message is everything after the IRC message code.
+        @message = match_data[8]
+      
+      end
+    
+    end
+    
+  end
+  
+end

data/lib/irc/messages/nick_message.rb

@@ -0,0 +1,93 @@
+#!/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
+    
+    # 4.1.2 Nick message
+    # 
+    # Command: 	NICK
+    # Parameters: 	<nickname> [ <hopcount> ]
+    # 
+    # NICK message is used to give user a nickname or change the previous one. The 
+    # <hopcount> parameter is only used by servers to indicate how far away a nick 
+    # is from its home server. A local connection has a hopcount of 0. If supplied 
+    # by a client, it must be ignored.
+    # 
+    # If a NICK message arrives at a server which already knows about an identical 
+    # nickname for another client, a nickname collision occurs. As a result of a 
+    # nickname collision, all instances of the nickname are removed from the server's 
+    # database, and a KILL command is issued to remove the nickname from all other 
+    # server's database. If the NICK message causing the collision was a nickname 
+    # change, then the original (old) nick must be removed as well.
+    # 
+    # If the server recieves an identical NICK from a client which is directly 
+    # connected, it may issue an ERR_NICKCOLLISION to the local client, drop the NICK 
+    # command, and not generate any kills.
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NONICKNAMEGIVEN 	
+    # ERR_ERRONEUSNICKNAME
+    # ERR_NICKNAMEINUSE 	
+    # ERR_NICKCOLLISION
+    # 
+    # Example:
+    # 
+    # NICK Wiz                 ; Introducing new nick "Wiz".
+    # 
+    # :WiZ NICK Kilroy         ; WiZ changed his nickname to Kilroy.
+    #     
+    class NickMessage < Message
+    
+      CODE = "NICK"
+
+      attr_reader :after            
+      attr_reader :before
+      
+      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+NICK\s+(\S+)\s*').match(raw_message)
+        raise InvalidMessage.new("Can't parse nick message. Invalid message format.") unless match_data
+
+        # Initialize the variables holding the nick names before & after the nick change.        
+        @after = match_data[2]
+        @before = match_data[1]        
+        
+      end
+      
+    end      
+    
+  end
+  
+end