X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fmessage.rb;h=901626ec7e6eaf232858c6a3cdbe2a02692dbb87;hb=1442690c6593c89a136ad7db40aed1fc78932e50;hp=9881503c3f10a074a7f8ff0aff4ae988dadbe69b;hpb=d0e3551896b446a93065a7dac47e81f721b80b7c;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/lib/rbot/message.rb b/lib/rbot/message.rb
index 9881503c..901626ec 100644
--- a/lib/rbot/message.rb
+++ b/lib/rbot/message.rb
@@ -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
@@ -41,6 +42,8 @@ module Irc
   Color = "\003"
   ColorRx = /#{Color}\d?\d?(?:,\d\d?)?/
 
+  FormattingRx = /#{AttributeRx}|#{ColorRx}/
+
   # Standard color codes
   ColorCode = {
     :black      => 1,
@@ -70,7 +73,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 +94,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
@@ -119,11 +122,45 @@ module Irc
     # User/Channel message was sent to
     attr_reader :target
 
-    # contents of the message
+    # contents of the message (stripped of initial/final format codes)
     attr_accessor :message
 
+    # contents of the message (for logging purposes)
+    attr_accessor :logmessage
+
+    # contents of the message (stripped of all formatting)
+    attr_accessor :plainmessage
+
     # has the message been replied to/handled by a plugin?
     attr_accessor :replied
+    alias :replied? :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
+
+    def inspect(fields=nil)
+      ret = self.__to_s__[0..-2]
+      ret << ' bot=' << @bot.__to_s__
+      ret << ' server=' << server.to_s
+      ret << ' time=' << time.to_s
+      ret << ' source=' << source.to_s
+      ret << ' target=' << target.to_s
+      ret << ' message=' << message.inspect
+      ret << ' logmessage=' << logmessage.inspect
+      ret << ' plainmessage=' << plainmessage.inspect
+      ret << fields if fields
+      ret << ' (identified)' if identified?
+      ret << ' (addressed to me)' if identified?
+      ret << ' (replied)' if replied?
+      ret << ' (ignored)' if ignored?
+      ret << ' (in thread)' if in_thread?
+      ret << '>'
+    end
 
     # instantiate a new Message
     # bot::      associated bot class
@@ -139,9 +176,11 @@ module Irc
       @source = source
       @address = false
       @target = target
-      @message = BasicUserMessage.stripcolour message
+      @message = message || ""
       @replied = false
       @server = server
+      @ignored = false
+      @in_thread = false
 
       @identified = false
       if @msg_wants_id && @server.capabilities[:"identify-msg"]
@@ -152,6 +191,9 @@ module Irc
           warning "Message does not have identification"
         end
       end
+      @logmessage = @message.dup
+      @plainmessage = BasicUserMessage.strip_formatting(@message)
+      @message = BasicUserMessage.strip_initial_formatting(@message)
 
       if target && target == @bot.myself
         @address = true
@@ -204,6 +246,24 @@ module Irc
       ret
     end
 
+    def BasicUserMessage.strip_initial_formatting(string)
+      return "" unless string
+      ret = string.gsub(/^#{FormattingRx}|#{FormattingRx}$/,"")
+    end
+
+    def BasicUserMessage.strip_formatting(string)
+      string.gsub(FormattingRx,"")
+    end
+
+  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
@@ -212,6 +272,24 @@ module Irc
   # (address? will return true in this case)
   class UserMessage < BasicUserMessage
 
+    def inspect
+      fields = ' plugin=' << plugin.inspect
+      fields << ' params=' << params.inspect
+      fields << ' channel=' << channel.to_s if channel
+      fields << ' (reply to ' << replyto.to_s << ')'
+      if self.private?
+        fields << ' (private)'
+      else
+        fields << ' (public)'
+      end
+      if self.action?
+        fields << ' (action)'
+      elsif ctcp
+        fields << ' (CTCP ' << ctcp << ')'
+      end
+      super(fields)
+    end
+
     # for plugin messages, the name of the plugin invoked by the message
     attr_reader :plugin
 
@@ -283,11 +361,13 @@ 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
       @params = @message.dup
-      if @params.gsub!(/^\s*(\S+)[\s$]*/, "")
+      # Created messges (such as by fake_message) can contain multiple lines
+      if @params.gsub!(/\A\s*(\S+)[\s$]*/m, "")
         @plugin = $1.downcase
         @params = nil unless @params.length > 0
       end
@@ -329,7 +409,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 +457,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
@@ -402,6 +488,29 @@ module Irc
     # channel user was kicked from
     attr_reader :channel
 
+    def inspect
+      fields = ' channel=' << channel.to_s
+      super(fields)
+    end
+
+    def initialize(bot, server, source, target, channel, message="")
+      super(bot, server, source, target, message)
+      @channel = channel
+    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 inspect
+      fields = ' channel=' << channel.to_s
+      super(fields)
+    end
+
     def initialize(bot, server, source, target, channel, message="")
       super(bot, server, source, target, message)
       @channel = channel
@@ -411,8 +520,10 @@ module Irc
   # 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
@@ -422,11 +533,48 @@ module Irc
     def newnick
       return @message
     end
+
+    def inspect
+      fields = ' old=' << oldnick
+      fields << ' new=' << newnick
+      super(fields)
+    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
+
+    def inspect
+      fields = ' modes=' << modes.inspect
+      super(fields)
+    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
+
+    def inspect
+      fields = ' users=' << users.inspect
+      super(fields)
+    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 +586,20 @@ 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
+
+    def inspect
+      fields = ' topic=' << topic
+      fields << ' (set on ' << timestamp << ')'
+      super(fields)
     end
   end
 
@@ -450,6 +607,12 @@ module Irc
   class JoinMessage < BasicUserMessage
     # channel joined
     attr_reader :channel
+
+    def inspect
+      fields = ' channel=' << channel.to_s
+      super(fields)
+    end
+
     def initialize(bot, server, source, channel, message="")
       super(bot, server, source, channel, message)
       @channel = channel
@@ -462,4 +625,7 @@ module Irc
   # same as a join, but can have a message too
   class PartMessage < JoinMessage
   end
+
+  class UnknownMessage < BasicUserMessage
+  end
 end