ircguerilla-irc 1.1.0

data/lib/irc/commands/user_command.rb

@@ -0,0 +1,105 @@
+#!/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: user_command.rb 85 2006-08-13 11:42:07Z roman $
+# 
+require 'irc/commands/command'
+require 'irc/commands/invalid_command'
+
+module IRC
+  
+  module Commands
+    
+    # Command: 	USER
+    # 
+    # Parameters: 	<username> <hostname> <servername> <realname>
+    # 
+    # The USER message is used at the beginning of connection to specify the 
+    # username, hostname, servername and realname of s new user. It is also 
+    # used in communication between servers to indicate new user arriving on 
+    # IRC, since only after both USER and NICK have been received from a client 
+    # does a user become registered.
+    # 
+    # Between servers USER must to be prefixed with client's NICKname. Note that 
+    # hostname and servername are normally ignored by the IRC server when the USER 
+    # command comes from a directly connected client (for security reasons), but 
+    # they are used in server to server communication. This means that a NICK must 
+    # always be sent to a remote server when a new user is being introduced to the 
+    # rest of the network before the accompanying USER is sent.
+    # 
+    # It must be noted that realname parameter must be the last parameter, because 
+    # it may contain space characters and must be prefixed with a colon (':') to 
+    # make sure this is recognised as such.
+    # 
+    # Since it is easy for a client to lie about its username by relying solely on 
+    # the USER message, the use of an "Identity Server" is recommended. If the host 
+    # which a user connects from has such a server enabled the username is set to 
+    # that as in the reply from the "Identity Server".
+    # 
+    # Numeric Replies:
+    # 
+    # ERR_NEEDMOREPARAMS 	
+    # ERR_ALREADYREGISTRED
+    # 
+    # Examples:
+    # 
+    # User registering themselves with a username of "guest" and real name "Ronnie Reagan".
+    # 
+    # USER guest tolmoon tolsun :Ronnie Reagan            
+    # 
+    # Message between servers with the nickname for which the USER command belongs to
+    # 
+    # :testnick USER guest tolmoon tolsun :Ronnie Reagan  
+    # 
+    class UserCommand < Command
+      
+      attr_reader :user
+      attr_reader :host
+      attr_reader :server
+      attr_reader :realname
+      
+      def initialize(user, host, server, realname)
+
+        raise InvalidCommand.new("Can't create user command. No user name.") unless user
+        @user = user
+        
+        raise InvalidCommand.new("Can't create user command. No host.") unless host        
+        @host = host
+        
+        raise InvalidCommand.new("Can't create user command. No server.") unless server        
+        @server = server
+        
+        raise InvalidCommand.new("Can't create user command. No real name.") unless realname        
+        @realname = realname
+        
+      end
+      
+      def command 
+        return "USER #{user} #{host} #{server} :#{realname}"
+      end
+      
+    end      
+    
+  end
+  
+end  

data/lib/irc/messages/codes.rb

@@ -0,0 +1,186 @@
+#!/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: codes.rb 85 2006-08-13 11:42:07Z roman $
+# 
+module IRC
+  
+  module Messages
+    
+    module Codes
+      
+      # Reply codes
+      RPL_WELCOME = 001
+      RPL_YOURHOST = 002
+      RPL_CREATED = 003
+      RPL_MYINFO = 004
+      RPL_BOUNCE = 005
+      RPL_ISUPPORT = 005
+      RPL_TRACELINK = 200
+      RPL_TRACECONNECTING = 201
+      RPL_TRACEHANDSHAKE = 202
+      RPL_TRACEUNKNOWN = 203
+      RPL_TRACEOPERATOR = 204
+      RPL_TRACEUSER = 205
+      RPL_TRACESERVER = 206
+      RPL_TRACENEWTYPE = 208
+      RPL_TRACECLASS = 209    
+      RPL_STATSLINKINFO = 211
+      RPL_STATSCOMMANDS = 212
+      RPL_STATSCLINE = 213
+      RPL_STATSNLINE = 214
+      RPL_STATSILINE = 215
+      RPL_STATSKLINE = 216
+      RPL_STATSQLINE = 217
+      RPL_STATSYLINE = 218
+      RPL_ENDOFSTATS = 219
+      RPL_UMODEIS = 221
+      RPL_SERVICEINFO = 231
+      RPL_ENDOFSERVICES = 232
+      RPL_SERVICE = 233
+      RPL_SERVLIST = 234
+      RPL_SERVLISTEND = 235
+      RPL_STATSLLINE = 241
+      RPL_STATSUPTIME = 242
+      RPL_STATSOLINE = 243
+      RPL_STATSHLINE = 244
+      RPL_LUSERCLIENT = 251
+      RPL_LUSEROP = 252
+      RPL_LUSERUNKNOWN = 253
+      RPL_LUSERCHANNELS = 254
+      RPL_LUSERME = 255
+      RPL_ADMINME = 256
+      RPL_ADMINLOC1 = 257
+      RPL_ADMINLOC2 = 258
+      RPL_ADMINEMAIL = 259
+      RPL_TRACELOG = 261
+      RPL_NONE = 300
+      RPL_AWAY = 301
+      RPL_USERHOST = 302
+      RPL_ISON = 303
+      RPL_UNAWAY = 305
+      RPL_NOWAWAY = 306
+      RPL_WHOISUSER = 311
+      RPL_WHOISSERVER = 312
+      RPL_WHOISOPERATOR = 313
+      RPL_WHOWASUSER = 314
+      RPL_ENDOFWHO = 315
+      RPL_WHOISCHANOP = 316
+      RPL_WHOISIDLE = 317
+      RPL_ENDOFWHOIS = 318
+      RPL_WHOISCHANNELS = 319
+      RPL_LISTSTART = 321
+      RPL_LIST = 322
+      RPL_LISTEND = 323
+      RPL_CHANNELMODEIS = 324
+      RPL_NOTOPIC = 331
+      RPL_TOPIC = 332
+      RPL_TOPICINFO = 333
+      RPL_INVITING = 341
+      RPL_SUMMONING = 342
+      RPL_VERSION = 351
+      RPL_WHOREPLY = 352
+      RPL_NAMREPLY = 353
+      RPL_KILLDONE = 361
+      RPL_CLOSING = 362
+      RPL_CLOSEEND = 363
+      RPL_LINKS = 364
+      RPL_ENDOFLINKS = 365
+      RPL_ENDOFNAMES = 366
+      RPL_BANLIST = 367
+      RPL_ENDOFBANLIST = 368
+      RPL_ENDOFWHOWAS = 369
+      RPL_INFO = 371
+      RPL_MOTD = 372
+      RPL_INFOSTART = 373    
+      RPL_ENDOFINFO = 374
+      RPL_MOTDSTART = 375
+      RPL_ENDOFMOTD = 376
+      RPL_YOUREOPER = 381
+      RPL_REHASHING = 382
+      RPL_MYPORTIS = 384
+      RPL_TIME = 391
+      RPL_USERSSTART = 392
+      RPL_USERS = 393
+      RPL_ENDOFUSERS = 394
+      RPL_NOUSERS = 395
+      
+      # Error reply codes
+      ERR_NOSUCHNICK = 401
+      ERR_NOSUCHSERVER = 402
+      ERR_NOSUCHCHANNEL = 403
+      ERR_CANNOTSENDTOCHAN = 404
+      ERR_TOOMANYCHANNELS = 405
+      ERR_WASNOSUCHNICK = 406
+      ERR_TOOMANYTARGETS = 407
+      ERR_NOORIGIN = 409
+      ERR_NORECIPIENT = 411
+      ERR_NOTEXTTOSEND = 412
+      ERR_NOTOPLEVEL = 413
+      ERR_WILDTOPLEVEL = 414
+      ERR_UNKNOWNCOMMAND = 421
+      ERR_NOMOTD = 422
+      ERR_NOADMININFO = 423
+      ERR_FILEERROR = 424
+      ERR_NONICKNAMEGIVEN = 431
+      ERR_ERRONEUSNICKNAME = 432
+      ERR_NICKNAMEINUSE = 433
+      ERR_NICKCOLLISION = 436
+      ERR_TARGETTOOFAST = 439
+      ERR_USERNOTINCHANNEL = 441
+      ERR_NOTONCHANNEL = 442
+      ERR_USERONCHANNEL = 443
+      ERR_NOLOGIN = 444
+      ERR_SUMMONDISABLED = 445
+      ERR_USERSDISABLED = 446
+      ERR_NOTREGISTERED = 451
+      ERR_NEEDMOREPARAMS = 461
+      ERR_ALREADYREGISTRED = 462
+      ERR_NOPERMFORHOST = 463
+      ERR_PASSWDMISMATCH = 464
+      ERR_YOUREBANNEDCREEP = 465
+      ERR_YOUWILLBEBANNED = 466    
+      ERR_KEYSET = 467
+      ERR_INVALIDUSERNAME = 468
+      ERR_LINKCHANNEL = 470
+      ERR_CHANNELISFULL = 471
+      ERR_UNKNOWNMODE = 472
+      ERR_INVITEONLYCHAN = 473
+      ERR_BANNEDFROMCHAN = 474
+      ERR_BADCHANNELKEY = 475
+      ERR_BADCHANMASK = 476    
+      ERR_BADCHANNAME = 479
+      ERR_NOPRIVILEGES = 481
+      ERR_CHANOPRIVSNEEDED = 482
+      ERR_CANTKILLSERVER = 483
+      ERR_SECUREONLYCHAN = 489
+      ERR_NOOPERHOST = 491
+      ERR_NOSERVICEHOST = 492    
+      ERR_UMODEUNKNOWNFLAG = 501
+      ERR_USERSDONTMATCH = 502
+      
+    end
+    
+  end
+  
+end

data/lib/irc/messages/error_join_message.rb

@@ -0,0 +1,72 @@
+#!/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/error_join_message'
+require 'irc/messages/invalid_message'
+require 'irc/messages/message'
+
+module IRC
+  
+  module Messages
+    
+    class ErrorJoinMessage < Message
+    
+      attr_reader :channel
+      attr_reader :reason
+          
+      # Notify all connection listeners, that the channel join failed.
+      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_failure method.
+        notify(context) do |connection_listener| 
+          connection_listener.on_join_failure(context, context.lookup_channel(channel), code, reason)
+        end
+
+      end
+      
+      protected
+      
+      def parse(raw_message)
+
+        # Initialize the base message fields.
+        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
+        
+        # Extract nick & channel name and the error reason.
+        @nick, @channel, @reason = match_data[1], match_data[2], match_data[3]
+                
+      end    
+    
+      
+    end      
+  
+  end
+  
+end  

data/lib/irc/messages/error_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: error_message.rb 94 2006-08-13 21:40:40Z roman $
+# 
+require 'irc/messages/error_join_message'
+require 'irc/messages/message'
+require 'irc/messages/invalid_message'
+
+module IRC
+  
+  module Messages
+    
+    class ErrorMessage < Message
+    end      
+    
+    class JoinFailureMessage < ErrorMessage
+    end
+    
+    class PartFailureMessage < ErrorMessage
+    end
+    
+    class ErrorAlreadyRegisteredMessage < ErrorMessage
+      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
+      CODE = ERR_ERRONEUSNICKNAME
+    end      
+
+    class ErrorInviteOnlyChannelMessage < ErrorJoinMessage
+      CODE = ERR_INVITEONLYCHAN
+    end      
+    
+    class ErrorNeedMoreParametersMessage < ErrorMessage
+      CODE = ERR_NEEDMOREPARAMS
+    end          
+
+    class ErrorNickCollisionMessage < ErrorMessage
+      CODE = ERR_NICKCOLLISION
+    end      
+
+    class ErrorNickNameInUseMessage < ErrorMessage
+      CODE = ERR_ERRONEUSNICKNAME
+    end      
+    
+    class ErrorNoNickNameGivenMessage < ErrorMessage
+      CODE = ERR_NONICKNAMEGIVEN
+    end      
+    
+    class ErrorNoSuchChannelMessage < ErrorJoinMessage
+      CODE = ERR_NOSUCHCHANNEL
+    end      
+    
+    class ErrorNotOnChannelMessage < ErrorMessage
+      CODE = ERR_NOTONCHANNEL
+    end 
+
+    class ErrorTooManyChannelsMessage < ErrorJoinMessage
+      CODE = ERR_TOOMANYCHANNELS
+    end      
+    
+  end
+  
+end