4 # :title: IRC message datastructures
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')"
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!')"
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"
29 # Define standard IRC attriubtes (not so standard actually,
30 # but the closest thing we have ...)
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
42 ColorRx = /#{Color}\d?\d?(?:,\d\d?)?/
44 # Standard color codes
71 # Convert a String or Symbol into a color number
72 def Irc.find_color(data)
73 "%02d" % if Integer === data
76 f = if String === data
89 # Insert the full color code for a given
90 # foreground/background combination.
91 def Irc.color(fg=nil,bg=nil)
94 str << Irc.find_color(fg)
97 str << "," << Irc.find_color(bg)
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
113 # when the message was received
116 # User that originated the message
119 # User/Channel message was sent to
122 # contents of the message
123 attr_accessor :message
125 # contents of the message (for logging purposes)
126 attr_accessor :logmessage
128 # has the message been replied to/handled by a plugin?
129 attr_accessor :replied
131 # should the message be ignored?
132 attr_accessor :ignored
133 alias :ignored? :ignored
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
149 @message = BasicUserMessage.stripcolour message
155 if @msg_wants_id && @server.capabilities[:"identify-msg"]
156 if @message =~ /^([-+])(.*)/
157 @identified = ($1=="+")
160 warning "Message does not have identification"
163 @logmessage = @message.dup
165 if target && target == @bot.myself
171 # Access the nick of the source
174 @source.nick rescue @source.to_s
177 # Access the user@host of the source
180 "#{@source.user}@#{@source.host}" rescue @source.to_s
183 # Access the botuser corresponding to the source, if any
186 source.botuser rescue @bot.auth.everyone
190 # Was the message from an identified user?
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.
203 # has this message been replied to by a plugin?
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", "")
218 # class for handling welcome messages from the server
219 class WelcomeMessage < BasicUserMessage
222 # class for handling MOTD from the server. Yes, MotdMessage
223 # is somewhat redundant, but it fits with the naming scheme
224 class MotdMessage < BasicUserMessage
227 # class for handling IRC user messages. Includes some utilities for handling
228 # the message, for example in plugins.
229 # The +message+ member will have any bot addressing "^bot: " removed
230 # (address? will return true in this case)
231 class UserMessage < BasicUserMessage
233 # for plugin messages, the name of the plugin invoked by the message
236 # for plugin messages, the rest of the message, with the plugin name
240 # convenience member. Who to reply to (i.e. would be sourcenick for a
241 # privately addressed message, or target (the channel) for a publicly
245 # channel the message was in, nil for privately addressed messages
248 # for PRIVMSGs, false unless the message was a CTCP command,
249 # in which case it evaluates to the CTCP command itself
250 # (TIME, PING, VERSION, etc). The CTCP command parameters
251 # are then stored in the message.
254 # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff
255 # will be stripped from the message)
258 # instantiate a new UserMessage
259 # bot:: associated bot class
260 # source:: hostmask of the message source
261 # target:: nick/channel message is destined for
262 # message:: message part
263 def initialize(bot, server, source, target, message)
264 super(bot, server, source, target, message)
271 if target == @bot.myself
281 # check for option extra addressing prefixes, e.g "|search foo", or
282 # "!version" - first match wins
283 bot.config['core.address_prefix'].each {|mprefix|
284 if @message.gsub!(/^#{Regexp.escape(mprefix)}\s*/, "")
290 # even if they used above prefixes, we allow for silly people who
291 # combine all possible types, e.g. "|rbot: hello", or
292 # "/msg rbot rbot: hello", etc
293 if @message.gsub!(/^\s*#{Regexp.escape(bot.nick)}\s*([:;,>]|\s)\s*/i, "")
297 if(@message =~ /^\001(\S+)(\s(.+))?\001/)
299 # FIXME need to support quoting of NULL and CR/LF, see
300 # http://www.irchelp.org/irchelp/rfc/ctcpspec.html
301 @message = $3 || String.new
302 @action = @ctcp == 'ACTION'
303 debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})"
304 @logmessage = @message.dup
307 # free splitting for plugins
308 @params = @message.dup
309 if @params.gsub!(/^\s*(\S+)[\s$]*/, "")
310 @plugin = $1.downcase
311 @params = nil unless @params.length > 0
315 # returns true for private messages, e.g. "/msg bot hello"
320 # returns true if the message was in a channel
329 # convenience method to reply to a message, useful in plugins. It's the
331 # <tt>@bot.say m.replyto, string</tt>
332 # So if the message is private, it will reply to the user. If it was
333 # in a channel, it will reply in the channel.
334 def plainreply(string, options={})
335 @bot.say @replyto, string, options
339 # Same as reply, but when replying in public it adds the nick of the user
340 # the bot is replying to
341 def nickreply(string, options={})
342 extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : ""
343 @bot.say @replyto, extra + string, options
347 # the default reply style is to nickreply unless the reply already contains
348 # the nick or core.reply_with_nick is set to false
350 def reply(string, options={})
351 if @bot.config['core.reply_with_nick'] and not string =~ /\b#{Regexp.escape(@source.to_s)}\b/
352 return nickreply(string, options)
354 plainreply(string, options)
357 # convenience method to reply to a message with an action. It's the
359 # <tt>@bot.action m.replyto, string</tt>
360 # So if the message is private, it will reply to the user. If it was
361 # in a channel, it will reply in the channel.
362 def act(string, options={})
363 @bot.action @replyto, string, options
367 # send a CTCP response, i.e. a private NOTICE to the sender
368 # with the same CTCP command and the reply as a parameter
369 def ctcp_reply(string, options={})
370 @bot.ctcp_notice @source, @ctcp, string, options
373 # convenience method to reply "okay" in the current language to the
376 self.plainreply @bot.lang.get("okay")
379 # Like the above, but append the username
381 str = @bot.lang.get("okay").dup
383 # remove final punctuation
384 str.gsub!(/[!,.]$/,"")
385 str += ", #{@source}"
390 # the default okay style is the same as the default reply style
393 if @bot.config['core.reply_with_nick']
399 # send a NOTICE to the message source
401 def notify(msg,opts={})
402 @bot.notice(sourcenick, msg, opts)
407 # class to manage IRC PRIVMSGs
408 class PrivMessage < UserMessage
409 def initialize(bot, server, source, target, message)
415 # class to manage IRC NOTICEs
416 class NoticeMessage < UserMessage
417 def initialize(bot, server, source, target, message)
423 # class to manage IRC KICKs
424 # +address?+ can be used as a shortcut to see if the bot was kicked,
425 # basically, +target+ was kicked from +channel+ by +source+ with +message+
426 class KickMessage < BasicUserMessage
427 # channel user was kicked from
430 def initialize(bot, server, source, target, channel, message="")
431 super(bot, server, source, target, message)
436 # class to manage IRC INVITEs
437 # +address?+ can be used as a shortcut to see if the bot was invited,
438 # which should be true except for server bugs
439 class InviteMessage < BasicUserMessage
440 # channel user was invited to
443 def initialize(bot, server, source, target, channel, message="")
444 super(bot, server, source, target, message)
449 # class to pass IRC Nick changes in. @message contains the old nickame,
450 # @sourcenick contains the new one.
451 class NickMessage < BasicUserMessage
452 def initialize(bot, server, source, oldnick, newnick)
453 super(bot, server, source, oldnick, newnick)
465 # class to manage mode changes
466 class ModeChangeMessage < BasicUserMessage
468 def initialize(bot, server, source, target, message="")
469 super(bot, server, source, target, message)
470 @address = (source == @bot.myself)
475 # class to manage NAME replies
476 class NamesMessage < BasicUserMessage
478 def initialize(bot, server, source, target, message="")
479 super(bot, server, source, target, message)
484 class QuitMessage < BasicUserMessage
485 def initialize(bot, server, source, target, message="")
486 super(bot, server, source, target, message)
490 class TopicMessage < BasicUserMessage
493 # topic set at (unixtime)
494 attr_reader :timestamp
495 # topic set on channel
498 def initialize(bot, server, source, channel, topic=ChannelTopic.new)
499 super(bot, server, source, channel, topic.text)
501 @timestamp = topic.set_on
506 # class to manage channel joins
507 class JoinMessage < BasicUserMessage
510 def initialize(bot, server, source, channel, message="")
511 super(bot, server, source, channel, message)
513 # in this case sourcenick is the nick that could be the bot
514 @address = (source == @bot.myself)
518 # class to manage channel parts
519 # same as a join, but can have a message too
520 class PartMessage < JoinMessage
523 class UnknownMessage < BasicUserMessage