ircbot/rfc2812/message: Add banlist message handling

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

diff --git a/lib/rbot/message.rb b/lib/rbot/message.rb
index f6e38e80a73d8f2359f38508466807b51b30c7b4..c13e59c1673eafdd8f68394968e449d4947bf057 100644 (file)
--- a/lib/rbot/message.rb
+++ b/lib/rbot/message.rb
@@ -22,6 +22,10 @@ module Irc
         :default => ':', :wizard => true,
         :desc => "when replying with nick put this character after the nick of the user the bot is replying to"
       )
+      Config.register BooleanValue.new('core.private_replies',
+        :default => false,
+        :desc => 'Should the bot reply to private instead of the channel?'
+      )
     end
   end
 
@@ -82,7 +86,7 @@ module Irc
             data
           end
       if ColorCode.key?(f)
-        ColorCode[f] 
+        ColorCode[f]
       else
         0
       end
@@ -195,7 +199,9 @@ module Irc
       @plainmessage = BasicUserMessage.strip_formatting(@message)
       @message = BasicUserMessage.strip_initial_formatting(@message)
 
-      @address = true if source == @bot.myself
+      if target && target == @bot.myself
+        @address = true
+      end
 
     end
 
@@ -321,8 +327,9 @@ module Irc
       @ctcp = false
       @action = false
 
-      if @address = (target == @bot.myself)
+      if target == @bot.myself
         @private = true
+        @address = true
         @channel = nil
         @replyto = source
       else
@@ -387,26 +394,47 @@ module Irc
     # So if the message is private, it will reply to the user. If it was
     # in a channel, it will reply in the channel.
     def plainreply(string, options={})
-      @bot.say @replyto, string, options
-      @replied = true
+      reply string, {:nick => false}.merge(options)
     end
 
     # Same as reply, but when replying in public it adds the nick of the user
     # the bot is replying to
     def nickreply(string, options={})
-      extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : ""
-      @bot.say @replyto, extra + string, options
-      @replied = true
+      reply string, {:nick => true}.merge(options)
     end
 
-    # the default reply style is to nickreply unless the reply already contains
-    # the nick or core.reply_with_nick is set to false
+    # 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
     #
+    # :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={})
-      if @bot.config['core.reply_with_nick'] and not string =~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/
-        return nickreply(string, options)
+      opts = {:nick => :auto, :to => :auto}.merge options
+
+      if opts[:nick] == :auto
+        opts[:nick] = @bot.config['core.reply_with_nick']
       end
-      plainreply(string, options)
+
+      if !self.public?
+        opts[:to] = :private
+      elsif opts[:to] == :auto
+        opts[:to] = @bot.config['core.private_replies'] ? :private : :public
+      end
+
+      if (opts[:nick] &&
+          opts[:to] != :private &&
+          string !~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/)
+        string = "#{@source}#{@bot.config['core.nick_postfix']} #{string}"
+      end
+      to = (opts[:to] == :private) ? source : @channel
+      @bot.say to, string, options
+      @replied = true
     end
 
     # convenience method to reply to a message with an action. It's the
@@ -428,7 +456,7 @@ module Irc
     # convenience method to reply "okay" in the current language to the
     # message
     def plainokay
-      self.plainreply @bot.lang.get("okay")
+      self.reply @bot.lang.get("okay"), :nick => false
     end
 
     # Like the above, but append the username
@@ -439,16 +467,13 @@ module Irc
         str.gsub!(/[!,.]$/,"")
         str += ", #{@source}"
       end
-      self.plainreply str
+      self.reply str, :nick => false
     end
 
     # the default okay style is the same as the default reply style
     #
     def okay
-      if @bot.config['core.reply_with_nick']
-        return nickokay
-      end
-      plainokay
+      @bot.config['core.reply_with_nick'] ? nickokay : plainokay
     end
 
     # send a NOTICE to the message source
@@ -517,6 +542,7 @@ module Irc
     attr_accessor :is_on
     def initialize(bot, server, source, oldnick, newnick)
       super(bot, server, source, oldnick, newnick)
+      @address = (source == @bot.myself)
       @is_on = []
     end
 
@@ -540,6 +566,7 @@ module Irc
     attr_accessor :modes
     def initialize(bot, server, source, target, message="")
       super(bot, server, source, target, message)
+      @address = (source == @bot.myself)
       @modes = []
     end
 
@@ -554,6 +581,7 @@ module Irc
     attr_reader :whois
     def initialize(bot, server, source, target, whois)
       super(bot, server, source, target, "")
+      @address = (target == @bot.myself)
       @whois = whois
     end
 
@@ -577,6 +605,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="")
@@ -624,6 +668,7 @@ module Irc
       super(bot, server, source, channel, message)
       @channel = channel
       # in this case sourcenick is the nick that could be the bot
+      @address = (source == @bot.myself)
     end
   end
 
@@ -632,6 +677,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