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 # should the message handler be excuted in new thread?
136 # if set to true or false, this overrides :thread option in map. if it's nil,
137 # the map option takes effect
138 attr_accessor :thread
139 alias :thread? :thread
141 # instantiate a new Message
142 # bot:: associated bot class
143 # server:: Server where the message took place
144 # source:: User that sent the message
145 # target:: User/Channel is destined for
146 # message:: actual message
147 def initialize(bot, server, source, target, message)
148 @msg_wants_id = false unless defined? @msg_wants_id
155 @message = BasicUserMessage.stripcolour message
162 if @msg_wants_id && @server.capabilities[:"identify-msg"]
163 if @message =~ /^([-+])(.*)/
164 @identified = ($1=="+")
167 warning "Message does not have identification"
170 @logmessage = @message.dup
172 if target && target == @bot.myself
178 # Access the nick of the source
181 @source.nick rescue @source.to_s
184 # Access the user@host of the source
187 "#{@source.user}@#{@source.host}" rescue @source.to_s
190 # Access the botuser corresponding to the source, if any
193 source.botuser rescue @bot.auth.everyone
197 # Was the message from an identified user?
202 # returns true if the message was addressed to the bot.
203 # This includes any private message to the bot, or any public message
204 # which looks like it's addressed to the bot, e.g. "bot: foo", "bot, foo",
205 # a kick message when bot was kicked etc.
210 # has this message been replied to by a plugin?
215 # strip mIRC colour escapes from a string
216 def BasicUserMessage.stripcolour(string)
217 return "" unless string
218 ret = string.gsub(ColorRx, "")
219 #ret.tr!("\x00-\x1f", "")
225 # class for handling welcome messages from the server
226 class WelcomeMessage < BasicUserMessage
229 # class for handling MOTD from the server. Yes, MotdMessage
230 # is somewhat redundant, but it fits with the naming scheme
231 class MotdMessage < BasicUserMessage
234 # class for handling IRC user messages. Includes some utilities for handling
235 # the message, for example in plugins.
236 # The +message+ member will have any bot addressing "^bot: " removed
237 # (address? will return true in this case)
238 class UserMessage < BasicUserMessage
240 # for plugin messages, the name of the plugin invoked by the message
243 # for plugin messages, the rest of the message, with the plugin name
247 # convenience member. Who to reply to (i.e. would be sourcenick for a
248 # privately addressed message, or target (the channel) for a publicly
252 # channel the message was in, nil for privately addressed messages
255 # for PRIVMSGs, false unless the message was a CTCP command,
256 # in which case it evaluates to the CTCP command itself
257 # (TIME, PING, VERSION, etc). The CTCP command parameters
258 # are then stored in the message.
261 # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff
262 # will be stripped from the message)
265 # instantiate a new UserMessage
266 # bot:: associated bot class
267 # source:: hostmask of the message source
268 # target:: nick/channel message is destined for
269 # message:: message part
270 def initialize(bot, server, source, target, message)
271 super(bot, server, source, target, message)
278 if target == @bot.myself
288 # check for option extra addressing prefixes, e.g "|search foo", or
289 # "!version" - first match wins
290 bot.config['core.address_prefix'].each {|mprefix|
291 if @message.gsub!(/^#{Regexp.escape(mprefix)}\s*/, "")
297 # even if they used above prefixes, we allow for silly people who
298 # combine all possible types, e.g. "|rbot: hello", or
299 # "/msg rbot rbot: hello", etc
300 if @message.gsub!(/^\s*#{Regexp.escape(bot.nick)}\s*([:;,>]|\s)\s*/i, "")
304 if(@message =~ /^\001(\S+)(\s(.+))?\001/)
306 # FIXME need to support quoting of NULL and CR/LF, see
307 # http://www.irchelp.org/irchelp/rfc/ctcpspec.html
308 @message = $3 || String.new
309 @action = @ctcp == 'ACTION'
310 debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})"
311 @logmessage = @message.dup
314 # free splitting for plugins
315 @params = @message.dup
316 if @params.gsub!(/^\s*(\S+)[\s$]*/, "")
317 @plugin = $1.downcase
318 @params = nil unless @params.length > 0
322 # returns true for private messages, e.g. "/msg bot hello"
327 # returns true if the message was in a channel
336 # convenience method to reply to a message, useful in plugins. It's the
338 # <tt>@bot.say m.replyto, string</tt>
339 # So if the message is private, it will reply to the user. If it was
340 # in a channel, it will reply in the channel.
341 def plainreply(string, options={})
342 @bot.say @replyto, string, options
346 # Same as reply, but when replying in public it adds the nick of the user
347 # the bot is replying to
348 def nickreply(string, options={})
349 extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : ""
350 @bot.say @replyto, extra + string, options
354 # the default reply style is to nickreply unless the reply already contains
355 # the nick or core.reply_with_nick is set to false
357 def reply(string, options={})
358 if @bot.config['core.reply_with_nick'] and not string =~ /(?:^|\W)#{Regexp.escape(@source.to_s)}(?:$|\W)/
359 return nickreply(string, options)
361 plainreply(string, options)
364 # convenience method to reply to a message with an action. It's the
366 # <tt>@bot.action m.replyto, string</tt>
367 # So if the message is private, it will reply to the user. If it was
368 # in a channel, it will reply in the channel.
369 def act(string, options={})
370 @bot.action @replyto, string, options
374 # send a CTCP response, i.e. a private NOTICE to the sender
375 # with the same CTCP command and the reply as a parameter
376 def ctcp_reply(string, options={})
377 @bot.ctcp_notice @source, @ctcp, string, options
380 # convenience method to reply "okay" in the current language to the
383 self.plainreply @bot.lang.get("okay")
386 # Like the above, but append the username
388 str = @bot.lang.get("okay").dup
390 # remove final punctuation
391 str.gsub!(/[!,.]$/,"")
392 str += ", #{@source}"
397 # the default okay style is the same as the default reply style
400 if @bot.config['core.reply_with_nick']
406 # send a NOTICE to the message source
408 def notify(msg,opts={})
409 @bot.notice(sourcenick, msg, opts)
414 # class to manage IRC PRIVMSGs
415 class PrivMessage < UserMessage
416 def initialize(bot, server, source, target, message)
422 # class to manage IRC NOTICEs
423 class NoticeMessage < UserMessage
424 def initialize(bot, server, source, target, message)
430 # class to manage IRC KICKs
431 # +address?+ can be used as a shortcut to see if the bot was kicked,
432 # basically, +target+ was kicked from +channel+ by +source+ with +message+
433 class KickMessage < BasicUserMessage
434 # channel user was kicked from
437 def initialize(bot, server, source, target, channel, message="")
438 super(bot, server, source, target, message)
443 # class to manage IRC INVITEs
444 # +address?+ can be used as a shortcut to see if the bot was invited,
445 # which should be true except for server bugs
446 class InviteMessage < BasicUserMessage
447 # channel user was invited to
450 def initialize(bot, server, source, target, channel, message="")
451 super(bot, server, source, target, message)
456 # class to pass IRC Nick changes in. @message contains the old nickame,
457 # @sourcenick contains the new one.
458 class NickMessage < BasicUserMessage
460 def initialize(bot, server, source, oldnick, newnick)
461 super(bot, server, source, oldnick, newnick)
474 # class to manage mode changes
475 class ModeChangeMessage < BasicUserMessage
477 def initialize(bot, server, source, target, message="")
478 super(bot, server, source, target, message)
479 @address = (source == @bot.myself)
484 # class to manage NAME replies
485 class NamesMessage < BasicUserMessage
487 def initialize(bot, server, source, target, message="")
488 super(bot, server, source, target, message)
493 class QuitMessage < BasicUserMessage
494 attr_accessor :was_on
495 def initialize(bot, server, source, target, message="")
496 super(bot, server, source, target, message)
501 class TopicMessage < BasicUserMessage
504 # topic set at (unixtime)
505 attr_reader :timestamp
506 # topic set on channel
509 # :info if topic info, :set if topic set
510 attr_accessor :info_or_set
511 def initialize(bot, server, source, channel, topic=ChannelTopic.new)
512 super(bot, server, source, channel, topic.text)
514 @timestamp = topic.set_on
520 # class to manage channel joins
521 class JoinMessage < BasicUserMessage
524 def initialize(bot, server, source, channel, message="")
525 super(bot, server, source, channel, message)
527 # in this case sourcenick is the nick that could be the bot
528 @address = (source == @bot.myself)
532 # class to manage channel parts
533 # same as a join, but can have a message too
534 class PartMessage < JoinMessage
537 class UnknownMessage < BasicUserMessage