An unparseable message from the server is a ServerError

[user/henk/code/ruby/rbot.git] / lib / rbot / message.rb

diff --git a/lib/rbot/message.rb b/lib/rbot/message.rb
index 4da511ed8dc944fdec5a1fdec04840c4cf9b6601..ed533e9b0ccfc8b57deec4965bd7adfcb5b18eb5 100644 (file)
--- a/lib/rbot/message.rb
+++ b/lib/rbot/message.rb
@@ -30,7 +30,7 @@ module Irc
   end
 
 
-  # Define standard IRC attriubtes (not so standard actually,
+  # Define standard IRC attributes (not so standard actually,
   # but the closest thing we have ...)
   Bold = "\002"
   Underline = "\037"
@@ -72,7 +72,7 @@ module Irc
     :dark_gray  => 14,
     :lightgray  => 15,
     :light_gray => 15,
-    :white      => 16
+    :white      => 0
   }
 
   # Convert a String or Symbol into a color number
@@ -86,7 +86,7 @@ module Irc
             data
           end
       if ColorCode.key?(f)
-        ColorCode[f] 
+        ColorCode[f]
       else
         0
       end
@@ -159,7 +159,11 @@ module Irc
       ret << ' plainmessage=' << plainmessage.inspect
       ret << fields if fields
       ret << ' (identified)' if identified?
-      ret << ' (addressed to me)' if address?
+      if address?
+        ret << ' (addressed to me'
+        ret << ', with prefix' if prefixed?
+        ret << ')'
+      end
       ret << ' (replied)' if replied?
       ret << ' (ignored)' if ignored?
       ret << ' (in thread)' if in_thread?
@@ -179,6 +183,7 @@ module Irc
       @bot = bot
       @source = source
       @address = false
+      @prefixed = false
       @target = target
       @message = message || ""
       @replied = false
@@ -237,6 +242,12 @@ module Irc
       return @address
     end
 
+    # returns true if the messaged was addressed to the bot via the address
+    # prefix. This can be used to tell appart "!do this" from "botname, do this"
+    def prefixed?
+      return @prefixed
+    end
+
     # strip mIRC colour escapes from a string
     def BasicUserMessage.stripcolour(string)
       return "" unless string
@@ -342,6 +353,7 @@ module Irc
       bot.config['core.address_prefix'].each {|mprefix|
         if @message.gsub!(/^#{Regexp.escape(mprefix)}\s*/, "")
           @address = true
+          @prefixed = true
           break
         end
       }
@@ -403,19 +415,27 @@ module Irc
       reply string, {:nick => true}.merge(options)
     end
 
+    # Same as nickreply, but always prepend the target's nick.
+    def nickreply!(string, options={})
+      reply string, {:nick => true, :forcenick => true}.merge(options)
+    end
+
     # The general way to reply to a command. The following options are available:
     # :nick [false, true, :auto]
     #   state if the nick of the user calling the command should be prepended
     #   :auto uses core.reply_with_nick
     #
+    # :forcenick [false, true]
+    #   if :nick is true, always prepend the target's nick, even if the nick
+    #   already appears in the reply. Defaults to false.
+    #
     # :to [:private, :public, :auto]
     #   where should the bot reply?
     #   :private always reply to the nick
     #   :public reply to the channel (if available)
     #   :auto uses core.private_replies
-
     def reply(string, options={})
-      opts = {:nick => :auto, :to => :auto}.merge options
+      opts = {:nick => :auto, :forcenick => false, :to => :auto}.merge options
 
       if opts[:nick] == :auto
         opts[:nick] = @bot.config['core.reply_with_nick']
@@ -429,7 +449,8 @@ module Irc
 
       if (opts[:nick] &&
           opts[:to] != :private &&
-          string !~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/)
+          (string !~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/ ||
+            opts[:forcenick]))
         string = "#{@source}#{@bot.config['core.nick_postfix']} #{string}"
       end
       to = (opts[:to] == :private) ? source : @channel
@@ -591,6 +612,21 @@ module Irc
     end
   end
 
+  # class to manage LIST replies
+  class ListMessage < BasicUserMessage
+    attr_accessor :list
+    def initialize(bot, server, source, target, list=Hash.new)
+      super(bot, server, source, target, "")
+      @list = []
+    end
+
+    def inspect
+      fields = ' list=' << list.inspect
+      super(fields)
+    end
+  end
+
+
   # class to manage NAME replies
   class NamesMessage < BasicUserMessage
     attr_accessor :users
@@ -605,6 +641,22 @@ module Irc
     end
   end
 
+  # class to manager Ban list replies
+  class BanlistMessage < BasicUserMessage
+    # the bans
+    attr_accessor :bans
+
+    def initialize(bot, server, source, target, message="")
+      super(bot, server, source, target, message)
+      @bans = []
+    end
+
+    def inspect
+      fields = ' bans=' << bans.inspect
+      super(fields)
+    end
+  end
+
   class QuitMessage < BasicUserMessage
     attr_accessor :was_on
     def initialize(bot, server, source, target, message="")
@@ -661,6 +713,18 @@ module Irc
   class PartMessage < JoinMessage
   end
 
+  # class to handle ERR_NOSUCHNICK and ERR_NOSUCHCHANNEL
+  class NoSuchTargetMessage < BasicUserMessage
+    # the channel or nick that was not found
+    attr_reader :target
+
+    def initialize(bot, server, source, target, message='')
+      super(bot, server, source, target, message)
+
+      @target = target
+    end
+  end
+
   class UnknownMessage < BasicUserMessage
   end
 end