]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/message.rb
+ strip all colours and formatting when sending to a +c or +C channel
[user/henk/code/ruby/rbot.git] / lib / rbot / message.rb
index acfd5da3fc742cf081d7bdebe5c9f235fba658d8..abe53ce013245ebf217225ca848ff482c03887c9 100644 (file)
@@ -33,6 +33,7 @@ module Irc
   Reverse = "\026"
   Italic = "\011"
   NormalText = "\017"
+  AttributeRx = /#{Bold}|#{Underline}|#{Reverse}|#{Italic}|#{NormalText}/
 
   # Color is prefixed by \003 and followed by optional
   # foreground and background specifications, two-digits-max
@@ -70,7 +71,7 @@ module Irc
 
   # Convert a String or Symbol into a color number
   def Irc.find_color(data)
-    if Integer === data
+    "%02d" % if Integer === data
       data
     else
       f = if String === data
@@ -91,10 +92,10 @@ module Irc
   def Irc.color(fg=nil,bg=nil)
     str = Color.dup
     if fg
-     str << Irc.find_color(fg).to_s
+     str << Irc.find_color(fg)
     end
     if bg
-      str << "," << Irc.find_color(bg).to_s
+      str << "," << Irc.find_color(bg)
     end
     return str
   end
@@ -122,9 +123,20 @@ module Irc
     # contents of the message
     attr_accessor :message
 
+    # contents of the message (for logging purposes)
+    attr_accessor :logmessage
+
     # has the message been replied to/handled by a plugin?
     attr_accessor :replied
 
+    # should the message be ignored?
+    attr_accessor :ignored
+    alias :ignored? :ignored
+
+    # set this to true if the method that delegates the message is run in a thread
+    attr_accessor :in_thread
+    alias :in_thread? :in_thread
+
     # instantiate a new Message
     # bot::      associated bot class
     # server::   Server where the message took place
@@ -142,6 +154,8 @@ module Irc
       @message = BasicUserMessage.stripcolour message
       @replied = false
       @server = server
+      @ignored = false
+      @in_thread = false
 
       @identified = false
       if @msg_wants_id && @server.capabilities[:"identify-msg"]
@@ -152,6 +166,7 @@ module Irc
           warning "Message does not have identification"
         end
       end
+      @logmessage = @message.dup
 
       if target && target == @bot.myself
         @address = true
@@ -174,7 +189,7 @@ module Irc
     # Access the botuser corresponding to the source, if any
     #
     def botuser
-      m.source.botuser rescue @bot.auth.everyone
+      source.botuser rescue @bot.auth.everyone
     end
 
 
@@ -206,6 +221,15 @@ module Irc
 
   end
 
+  # class for handling welcome messages from the server
+  class WelcomeMessage < BasicUserMessage
+  end
+
+  # class for handling MOTD from the server. Yes, MotdMessage
+  # is somewhat redundant, but it fits with the naming scheme
+  class MotdMessage < BasicUserMessage
+  end
+
   # class for handling IRC user messages. Includes some utilities for handling
   # the message, for example in plugins.
   # The +message+ member will have any bot addressing "^bot: " removed
@@ -283,6 +307,7 @@ module Irc
         @message = $3 || String.new
         @action = @ctcp == 'ACTION'
         debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})"
+        @logmessage = @message.dup
       end
 
       # free splitting for plugins
@@ -329,7 +354,7 @@ module Irc
     # the nick or core.reply_with_nick is set to false
     #
     def reply(string, options={})
-      if @bot.config['core.reply_with_nick'] and not string =~ /\b#{@source}\b/
+      if @bot.config['core.reply_with_nick'] and not string =~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/
         return nickreply(string, options)
       end
       plainreply(string, options)
@@ -377,6 +402,12 @@ module Irc
       plainokay
     end
 
+    # send a NOTICE to the message source
+    #
+    def notify(msg,opts={})
+      @bot.notice(sourcenick, msg, opts)
+    end
+
   end
 
   # class to manage IRC PRIVMSGs
@@ -408,11 +439,26 @@ module Irc
     end
   end
 
+  # class to manage IRC INVITEs
+  # +address?+ can be used as a shortcut to see if the bot was invited,
+  # which should be true except for server bugs
+  class InviteMessage < BasicUserMessage
+    # channel user was invited to
+    attr_reader :channel
+
+    def initialize(bot, server, source, target, channel, message="")
+      super(bot, server, source, target, message)
+      @channel = channel
+    end
+  end
+
   # class to pass IRC Nick changes in. @message contains the old nickame,
   # @sourcenick contains the new one.
   class NickMessage < BasicUserMessage
+    attr_accessor :is_on
     def initialize(bot, server, source, oldnick, newnick)
       super(bot, server, source, oldnick, newnick)
+      @is_on = []
     end
 
     def oldnick
@@ -424,9 +470,30 @@ module Irc
     end
   end
 
+  # class to manage mode changes
+  class ModeChangeMessage < BasicUserMessage
+    attr_accessor :modes
+    def initialize(bot, server, source, target, message="")
+      super(bot, server, source, target, message)
+      @address = (source == @bot.myself)
+      @modes = []
+    end
+  end
+
+  # class to manage NAME replies
+  class NamesMessage < BasicUserMessage
+    attr_accessor :users
+    def initialize(bot, server, source, target, message="")
+      super(bot, server, source, target, message)
+      @users = []
+    end
+  end
+
   class QuitMessage < BasicUserMessage
+    attr_accessor :was_on
     def initialize(bot, server, source, target, message="")
       super(bot, server, source, target, message)
+      @was_on = []
     end
   end
 
@@ -438,11 +505,14 @@ module Irc
     # topic set on channel
     attr_reader :channel
 
+    # :info if topic info, :set if topic set
+    attr_accessor :info_or_set
     def initialize(bot, server, source, channel, topic=ChannelTopic.new)
       super(bot, server, source, channel, topic.text)
       @topic = topic
       @timestamp = topic.set_on
       @channel = channel
+      @info_or_set = nil
     end
   end
 
@@ -462,4 +532,7 @@ module Irc
   # same as a join, but can have a message too
   class PartMessage < JoinMessage
   end
+
+  class UnknownMessage < BasicUserMessage
+  end
 end