lib/rbot/message.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: IRC message datastructures
   5
   6 module Irc
   7
   8
   9   class Bot
  10     module Config
  11       Config.register ArrayValue.new('core.address_prefix',
  12         :default => [], :wizard => true,
  13         :desc => "what non nick-matching prefixes should the bot respond to as if addressed (e.g !, so that '!foo' is treated like 'rbot: foo')"
  14       )
  15
  16       Config.register BooleanValue.new('core.reply_with_nick',
  17         :default => false, :wizard => true,
  18         :desc => "if true, the bot will prepend the nick to what he has to say when replying (e.g. 'markey: you can't do that!')"
  19       )
  20
  21       Config.register StringValue.new('core.nick_postfix',
  22         :default => ':', :wizard => true,
  23         :desc => "when replying with nick put this character after the nick of the user the bot is replying to"
  24       )
  25     end
  26   end
  27
  28
  29   # Define standard IRC attriubtes (not so standard actually,
  30   # but the closest thing we have ...)
  31   Bold = "\002"
  32   Underline = "\037"
  33   Reverse = "\026"
  34   Italic = "\011"
  35   NormalText = "\017"
  36
  37   # Color is prefixed by \003 and followed by optional
  38   # foreground and background specifications, two-digits-max
  39   # numbers separated by a comma. One of the two parts
  40   # must be present.
  41   Color = "\003"
  42   ColorRx = /#{Color}\d?\d?(?:,\d\d?)?/
  43
  44   # Standard color codes
  45   ColorCode = {
  46     :black      => 1,
  47     :blue       => 2,
  48     :navyblue   => 2,
  49     :navy_blue  => 2,
  50     :green      => 3,
  51     :red        => 4,
  52     :brown      => 5,
  53     :purple     => 6,
  54     :olive      => 7,
  55     :yellow     => 8,
  56     :limegreen  => 9,
  57     :lime_green => 9,
  58     :teal       => 10,
  59     :aqualight  => 11,
  60     :aqua_light => 11,
  61     :royal_blue => 12,
  62     :hotpink    => 13,
  63     :hot_pink   => 13,
  64     :darkgray   => 14,
  65     :dark_gray  => 14,
  66     :lightgray  => 15,
  67     :light_gray => 15,
  68     :white      => 16
  69   }
  70
  71   # Convert a String or Symbol into a color number
  72   def Irc.find_color(data)
  73     "%02d" % if Integer === data
  74       data
  75     else
  76       f = if String === data
  77             data.intern
  78           else
  79             data
  80           end
  81       if ColorCode.key?(f)
  82         ColorCode[f]
  83       else
  84         0
  85       end
  86     end
  87   end
  88
  89   # Insert the full color code for a given
  90   # foreground/background combination.
  91   def Irc.color(fg=nil,bg=nil)
  92     str = Color.dup
  93     if fg
  94      str << Irc.find_color(fg)
  95     end
  96     if bg
  97       str << "," << Irc.find_color(bg)
  98     end
  99     return str
 100   end
 101
 102   # base user message class, all user messages derive from this
 103   # (a user message is defined as having a source hostmask, a target
 104   # nick/channel and a message part)
 105   class BasicUserMessage
 106
 107     # associated bot
 108     attr_reader :bot
 109
 110     # associated server
 111     attr_reader :server
 112
 113     # when the message was received
 114     attr_reader :time
 115
 116     # User that originated the message
 117     attr_reader :source
 118
 119     # User/Channel message was sent to
 120     attr_reader :target
 121
 122     # contents of the message
 123     attr_accessor :message
 124
 125     # contents of the message (for logging purposes)
 126     attr_accessor :logmessage
 127
 128     # has the message been replied to/handled by a plugin?
 129     attr_accessor :replied
 130
 131     # should the message be ignored?
 132     attr_accessor :ignored
 133     alias :ignored? :ignored
 134
 135     # instantiate a new Message
 136     # bot::      associated bot class
 137     # server::   Server where the message took place
 138     # source::   User that sent the message
 139     # target::   User/Channel is destined for
 140     # message::  actual message
 141     def initialize(bot, server, source, target, message)
 142       @msg_wants_id = false unless defined? @msg_wants_id
 143
 144       @time = Time.now
 145       @bot = bot
 146       @source = source
 147       @address = false
 148       @target = target
 149       @message = BasicUserMessage.stripcolour message
 150       @replied = false
 151       @server = server
 152       @ignored = false
 153
 154       @identified = false
 155       if @msg_wants_id && @server.capabilities[:"identify-msg"]
 156         if @message =~ /^([-+])(.*)/
 157           @identified = ($1=="+")
 158           @message = $2
 159         else
 160           warning "Message does not have identification"
 161         end
 162       end
 163       @logmessage = @message.dup
 164
 165       if target && target == @bot.myself
 166         @address = true
 167       end
 168
 169     end
 170
 171     # Access the nick of the source
 172     #
 173     def sourcenick
 174       @source.nick rescue @source.to_s
 175     end
 176
 177     # Access the user@host of the source
 178     #
 179     def sourceaddress
 180       "#{@source.user}@#{@source.host}" rescue @source.to_s
 181     end
 182
 183     # Access the botuser corresponding to the source, if any
 184     #
 185     def botuser
 186       source.botuser rescue @bot.auth.everyone
 187     end
 188
 189
 190     # Was the message from an identified user?
 191     def identified?
 192       return @identified
 193     end
 194
 195     # returns true if the message was addressed to the bot.
 196     # This includes any private message to the bot, or any public message
 197     # which looks like it's addressed to the bot, e.g. "bot: foo", "bot, foo",
 198     # a kick message when bot was kicked etc.
 199     def address?
 200       return @address
 201     end
 202
 203     # has this message been replied to by a plugin?
 204     def replied?
 205       return @replied
 206     end
 207
 208     # strip mIRC colour escapes from a string
 209     def BasicUserMessage.stripcolour(string)
 210       return "" unless string
 211       ret = string.gsub(ColorRx, "")
 212       #ret.tr!("\x00-\x1f", "")
 213       ret
 214     end
 215
 216   end
 217
 218   # class for handling IRC user messages. Includes some utilities for handling
 219   # the message, for example in plugins.
 220   # The +message+ member will have any bot addressing "^bot: " removed
 221   # (address? will return true in this case)
 222   class UserMessage < BasicUserMessage
 223
 224     # for plugin messages, the name of the plugin invoked by the message
 225     attr_reader :plugin
 226
 227     # for plugin messages, the rest of the message, with the plugin name
 228     # removed
 229     attr_reader :params
 230
 231     # convenience member. Who to reply to (i.e. would be sourcenick for a
 232     # privately addressed message, or target (the channel) for a publicly
 233     # addressed message
 234     attr_reader :replyto
 235
 236     # channel the message was in, nil for privately addressed messages
 237     attr_reader :channel
 238
 239     # for PRIVMSGs, false unless the message was a CTCP command,
 240     # in which case it evaluates to the CTCP command itself
 241     # (TIME, PING, VERSION, etc). The CTCP command parameters
 242     # are then stored in the message.
 243     attr_reader :ctcp
 244
 245     # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff
 246     # will be stripped from the message)
 247     attr_reader :action
 248
 249     # instantiate a new UserMessage
 250     # bot::      associated bot class
 251     # source::   hostmask of the message source
 252     # target::   nick/channel message is destined for
 253     # message::  message part
 254     def initialize(bot, server, source, target, message)
 255       super(bot, server, source, target, message)
 256       @target = target
 257       @private = false
 258       @plugin = nil
 259       @ctcp = false
 260       @action = false
 261
 262       if target == @bot.myself
 263         @private = true
 264         @address = true
 265         @channel = nil
 266         @replyto = source
 267       else
 268         @replyto = @target
 269         @channel = @target
 270       end
 271
 272       # check for option extra addressing prefixes, e.g "|search foo", or
 273       # "!version" - first match wins
 274       bot.config['core.address_prefix'].each {|mprefix|
 275         if @message.gsub!(/^#{Regexp.escape(mprefix)}\s*/, "")
 276           @address = true
 277           break
 278         end
 279       }
 280
 281       # even if they used above prefixes, we allow for silly people who
 282       # combine all possible types, e.g. "|rbot: hello", or
 283       # "/msg rbot rbot: hello", etc
 284       if @message.gsub!(/^\s*#{Regexp.escape(bot.nick)}\s*([:;,>]|\s)\s*/i, "")
 285         @address = true
 286       end
 287
 288       if(@message =~ /^\001(\S+)(\s(.+))?\001/)
 289         @ctcp = $1
 290         # FIXME need to support quoting of NULL and CR/LF, see
 291         # http://www.irchelp.org/irchelp/rfc/ctcpspec.html
 292         @message = $3 || String.new
 293         @action = @ctcp == 'ACTION'
 294         debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})"
 295         @logmessage = @message.dup
 296       end
 297
 298       # free splitting for plugins
 299       @params = @message.dup
 300       if @params.gsub!(/^\s*(\S+)[\s$]*/, "")
 301         @plugin = $1.downcase
 302         @params = nil unless @params.length > 0
 303       end
 304     end
 305
 306     # returns true for private messages, e.g. "/msg bot hello"
 307     def private?
 308       return @private
 309     end
 310
 311     # returns true if the message was in a channel
 312     def public?
 313       return !@private
 314     end
 315
 316     def action?
 317       return @action
 318     end
 319
 320     # convenience method to reply to a message, useful in plugins. It's the
 321     # same as doing:
 322     # <tt>@bot.say m.replyto, string</tt>
 323     # So if the message is private, it will reply to the user. If it was
 324     # in a channel, it will reply in the channel.
 325     def plainreply(string, options={})
 326       @bot.say @replyto, string, options
 327       @replied = true
 328     end
 329
 330     # Same as reply, but when replying in public it adds the nick of the user
 331     # the bot is replying to
 332     def nickreply(string, options={})
 333       extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : ""
 334       @bot.say @replyto, extra + string, options
 335       @replied = true
 336     end
 337
 338     # the default reply style is to nickreply unless the reply already contains
 339     # the nick or core.reply_with_nick is set to false
 340     #
 341     def reply(string, options={})
 342       if @bot.config['core.reply_with_nick'] and not string =~ /\b#{Regexp.escape(@source.to_s)}\b/
 343         return nickreply(string, options)
 344       end
 345       plainreply(string, options)
 346     end
 347
 348     # convenience method to reply to a message with an action. It's the
 349     # same as doing:
 350     # <tt>@bot.action m.replyto, string</tt>
 351     # So if the message is private, it will reply to the user. If it was
 352     # in a channel, it will reply in the channel.
 353     def act(string, options={})
 354       @bot.action @replyto, string, options
 355       @replied = true
 356     end
 357
 358     # send a CTCP response, i.e. a private NOTICE to the sender
 359     # with the same CTCP command and the reply as a parameter
 360     def ctcp_reply(string, options={})
 361       @bot.ctcp_notice @source, @ctcp, string, options
 362     end
 363
 364     # convenience method to reply "okay" in the current language to the
 365     # message
 366     def plainokay
 367       self.plainreply @bot.lang.get("okay")
 368     end
 369
 370     # Like the above, but append the username
 371     def nickokay
 372       str = @bot.lang.get("okay").dup
 373       if self.public?
 374         # remove final punctuation
 375         str.gsub!(/[!,.]$/,"")
 376         str += ", #{@source}"
 377       end
 378       self.plainreply str
 379     end
 380
 381     # the default okay style is the same as the default reply style
 382     #
 383     def okay
 384       if @bot.config['core.reply_with_nick']
 385         return nickokay
 386       end
 387       plainokay
 388     end
 389
 390     # send a NOTICE to the message source
 391     #
 392     def notify(msg,opts={})
 393       @bot.notice(sourcenick, msg, opts)
 394     end
 395
 396   end
 397
 398   # class to manage IRC PRIVMSGs
 399   class PrivMessage < UserMessage
 400     def initialize(bot, server, source, target, message)
 401       @msg_wants_id = true
 402       super
 403     end
 404   end
 405
 406   # class to manage IRC NOTICEs
 407   class NoticeMessage < UserMessage
 408     def initialize(bot, server, source, target, message)
 409       @msg_wants_id = true
 410       super
 411     end
 412   end
 413
 414   # class to manage IRC KICKs
 415   # +address?+ can be used as a shortcut to see if the bot was kicked,
 416   # basically, +target+ was kicked from +channel+ by +source+ with +message+
 417   class KickMessage < BasicUserMessage
 418     # channel user was kicked from
 419     attr_reader :channel
 420
 421     def initialize(bot, server, source, target, channel, message="")
 422       super(bot, server, source, target, message)
 423       @channel = channel
 424     end
 425   end
 426
 427   # class to manage IRC INVITEs
 428   # +address?+ can be used as a shortcut to see if the bot was invited,
 429   # which should be true except for server bugs
 430   class InviteMessage < BasicUserMessage
 431     # channel user was invited to
 432     attr_reader :channel
 433
 434     def initialize(bot, server, source, target, channel, message="")
 435       super(bot, server, source, target, message)
 436       @channel = channel
 437     end
 438   end
 439
 440   # class to pass IRC Nick changes in. @message contains the old nickame,
 441   # @sourcenick contains the new one.
 442   class NickMessage < BasicUserMessage
 443     def initialize(bot, server, source, oldnick, newnick)
 444       super(bot, server, source, oldnick, newnick)
 445     end
 446
 447     def oldnick
 448       return @target
 449     end
 450
 451     def newnick
 452       return @message
 453     end
 454   end
 455
 456   class QuitMessage < BasicUserMessage
 457     def initialize(bot, server, source, target, message="")
 458       super(bot, server, source, target, message)
 459     end
 460   end
 461
 462   class TopicMessage < BasicUserMessage
 463     # channel topic
 464     attr_reader :topic
 465     # topic set at (unixtime)
 466     attr_reader :timestamp
 467     # topic set on channel
 468     attr_reader :channel
 469
 470     def initialize(bot, server, source, channel, topic=ChannelTopic.new)
 471       super(bot, server, source, channel, topic.text)
 472       @topic = topic
 473       @timestamp = topic.set_on
 474       @channel = channel
 475     end
 476   end
 477
 478   # class to manage channel joins
 479   class JoinMessage < BasicUserMessage
 480     # channel joined
 481     attr_reader :channel
 482     def initialize(bot, server, source, channel, message="")
 483       super(bot, server, source, channel, message)
 484       @channel = channel
 485       # in this case sourcenick is the nick that could be the bot
 486       @address = (source == @bot.myself)
 487     end
 488   end
 489
 490   # class to manage channel parts
 491   # same as a join, but can have a message too
 492   class PartMessage < JoinMessage
 493   end
 494 end