ircguerilla-irc 1.1.0

data/lib/irc/messages/notice_message.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: nick_message.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+    # 4.4.2 Notice
+    # 
+    # Command: 	    NOTICE
+    # Parameters: 	<nickname> <text>
+    # 
+    # The NOTICE message is used similarly to PRIVMSG. The difference between NOTICE and PRIVMSG is 
+    # that automatic replies must never be sent in response to a NOTICE message. This rule applies 
+    # to servers too - they must not send any error reply back to the client on receipt of a notice. 
+    # The object of this rule is to avoid loops between a client automatically sending something in 
+    # response to something it received. This is typically used by automatons (clients with either 
+    # an AI or other interactive program controlling their actions) which are always seen to be 
+    # replying lest they end up in a loop with another automaton.
+    # 
+    # See PRIVMSG for more details on replies and examples.
+    # 
+    class NoticeMessage < Message
+    
+      CODE = "NOTICE"
+
+      attr_reader :message
+      
+      # Notify all connection listeners, that a notice message was received.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_notice method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_notice(context, context.lookup_user(nick), message)
+        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*NOTICE\s+:?(\S+)\s+:?(.*)').match(raw_message)
+        raise InvalidMessage.new("Can't parse notice message. Invalid message format.") unless match_data
+
+        # Initialize the nick & message fileds.
+        @nick, @message = match_data[1].strip, match_data[2].strip
+        
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/messages/part_message.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$
+# 
+require 'irc/commands/pong_command'
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+   
+    # 4.2.2 Part message
+    # 
+    # Command: 	    PART
+    # Parameters: 	<channel>{,<channel>}
+    # 
+    # The PART message causes the client sending the message to be removed 
+    # from the list of active users for all given channels listed in the 
+    # parameter string.
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NEEDMOREPARAMS 	
+    # ERR_NOSUCHCHANNEL
+    # ERR_NOTONCHANNEL 	
+    # 
+    # Examples:
+    # 
+    # PART #twilight_zone    ; leave channel "#twilight_zone"
+    # 
+    # PART #oz-ops,&group5   ; leave both channels "&group5" and
+    #                        ; "#oz-ops".
+    # 
+    class PartMessage < Message
+    
+      CODE = "PART"
+
+      attr_reader :channel
+      
+      # Notify all connection listeners, that a user has left 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_part method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_part(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 part 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/ping_message.rb

@@ -0,0 +1,101 @@
+#!/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: ping_message.rb 93 2006-08-13 21:30:53Z roman $
+# 
+require 'irc/commands/pong_command'
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+    # 4.6.2 Ping message
+    # 
+    # Command: 	    PING
+    # Parameters: 	<server1> [<server2>]
+    # 
+    # The PING message is used to test the presence of an active client at the other end of 
+    # the connection. A PING message is sent at regular intervals if no other activity detected 
+    # coming from a connection. If a connection fails to respond to a PING command within a set 
+    # amount of time, that connection is closed.
+    # 
+    # Any client which receives a PING message must respond to <server1> (server which sent the 
+    # PING message out) as quickly as possible with an appropriate PONG message to indicate it 
+    # is still there and alive. Servers should not respond to PING commands but rely on PINGs 
+    # from the other end of the connection to indicate the connection is alive. If the <server2> 
+    # parameter is specified, the PING message gets forwarded there.
+    # 
+    # Numeric Replies:
+    # * ERR_NOORIGIN 	
+    # * ERR_NOSUCHSERVER
+    # 
+    # Examples:
+    # 
+    # PING tolsun.oulu.fi  ; server sending a PING message to
+    #                      another server to indicate it is still
+    #                      alive.
+    # 
+    # PING WiZ             ; PING message being sent to nick WiZ
+    # 
+    class PingMessage < Message
+    
+      CODE = "PING"
+
+      attr_reader :servers
+      
+      # Notify all connection listeners, that a ping message was received.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_ping method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_ping(context, servers)
+        end
+
+      end
+      
+      protected
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        super(raw_message)      
+
+        # Extract the message specific fields.
+        match_data = Regexp.new(':?([^\s:]+)(\s+:?(.+))?').match(message)
+        raise InvalidMessage.new("Can't parse ping message. Invalid message format.") if match_data == nil || code != CODE
+
+        # Extract the servers and strip white spaces.
+        @servers = [match_data[1], match_data[3]].compact.map! { |element| element.strip }
+                
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/messages/pong_message.rb

@@ -0,0 +1,89 @@
+#!/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: pong_message.rb 93 2006-08-13 21:30:53Z roman $
+# 
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+    # 4.6.3 Pong message
+    # 
+    # Command: 	PONG
+    # Parameters: 	<daemon> [<daemon2>]
+    # 
+    # PONG message is a reply to ping message. If parameter <daemon2> is given this message must 
+    # be forwarded to given daemon. The <daemon> parameter is the name of the daemon who has responded 
+    # to PING message and generated this message.
+    # 
+    # Numeric Replies:
+    # * ERR_NOORIGIN 
+    # *	ERR_NOSUCHSERVER
+    # 
+    # Examples:
+    # 
+    # PONG csd.bu.edu tolsun.oulu.fi  ; PONG message from csd.bu.edu to
+    # 
+    class PongMessage < Message
+    
+      CODE = "PONG"
+
+      attr_reader :daemons
+      
+      # Notify all message listeners, that a pong message was received.
+      def handle(context)
+
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_pong method.
+        notify(context) do |connection_listener| 
+          message_listener.on_pong(context, daemons)
+        end
+
+      end
+      
+      protected
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        super(raw_message)      
+
+        # Extract the message specific fields.
+        match_data = Regexp.new(':?([^\s:]+)(\s+:?(.+))?').match(message)
+        raise InvalidMessage.new("Can't parse ping message. Invalid message format.") if match_data == nil || code != CODE
+
+        # Extract the servers and strip white spaces.
+        @daemons = [match_data[1], match_data[3]].compact.map! { |element| element.strip }
+                
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/messages/private_message.rb

@@ -0,0 +1,121 @@
+#!/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/messages/message'
+require 'irc/messages/invalid_message'
+require 'irc/models/channel'
+
+module IRC
+  
+  module Messages
+    
+    # 4.4.1 Private messages
+    # 
+    # Command: 	    PRIVMSG
+    # Parameters: 	<receiver>{,<receiver>} <text to be sent>
+    # 
+    # PRIVMSG is used to send private messages between users. <receiver> is the nickname 
+    # of the receiver of the message. <receiver> can also be a list of names or channels 
+    # separated with commas.
+    # 
+    # The <receiver> parameter may also me a host mask (#mask) or server mask ($mask). In 
+    # both cases the server will only send the PRIVMSG to those who have a server or host 
+    # matching the mask. The mask must have at least 1 (one) "." in it and no wildcards 
+    # following the last ".". This requirement exists to prevent people sending messages 
+    # to "#*" or "$*", which would broadcast to all users; from experience, this is abused 
+    # more than used responsibly and properly. Wildcards are the '*' and '?' characters. 
+    # This extension to the PRIVMSG command is only available to Operators.
+    # 
+    # Numeric Replies:
+    # * ERR_NORECIPIENT 	
+    # * ERR_NOTEXTTOSEND
+    # * ERR_CANNOTSENDTOCHAN 	
+    # * ERR_NOTOPLEVEL
+    # * ERR_WILDTOPLEVEL 	
+    # * ERR_TOOMANYTARGETS
+    # * ERR_NOSUCHNICK 	
+    # * RPL_AWAY 	
+    # 
+    # Examples:
+    # 
+    # :Angel PRIVMSG Wiz :Hello are you receiving this message ?
+    #                        ; Message from Angel to Wiz.
+    # 
+    # PRIVMSG Angel :yes I'm receiving it !receiving it !'u>(768u+1n) .br
+    #                        ; Message to Angel.
+    # 
+    # PRIVMSG jto@tolsun.oulu.fi :Hello !
+    #                        ; Message to a client on server
+    #                        tolsun.oulu.fi with username of "jto".
+    # 
+    # PRIVMSG $*.fi :Server tolsun.oulu.fi rebooting.
+    #                        ; Message to everyone on a server which
+    #                        has a name matching *.fi.
+    # 
+    # PRIVMSG #*.edu :NSFNet is undergoing work, expect interruptions
+    #                        ; Message to all users who come from a
+    #                        host which has a name matching *.edu.
+    class PrivateMessage < Message
+    
+      CODE = "PRIVMSG"
+
+      attr_reader :target      
+      attr_reader :sender
+      attr_reader :text
+      
+      # Notify all connection listeners, that a private message was received.
+      def handle(context)
+        
+        # Notify all connection listeners by calling their on_server_response method.
+        super(context)
+        
+        # Notify all connection listeners by calling their on_private_message method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_private_message(context, IRC::Models::Channel.is_valid?(target) ? context.lookup_channel(target) : context.lookup_user(target), text)
+        end
+
+      end
+      
+      protected      
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        super(raw_message)      
+
+        # Extract the message specific fields.
+        match_data = Regexp.new('(\S+)\s+:?(.+)').match(message)
+        raise InvalidMessage.new("Can't parse private message. Invalid message format.") if match_data == nil || code != CODE
+
+        # Extract the sender, target and the text.
+        @sender, @target, @text = nick, match_data[1], match_data[2]
+        
+      end
+      
+    end      
+    
+  end
+  
+end