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)
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).to_s
97 str << "," << Irc.find_color(bg).to_s
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 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
224 # for plugin messages, the name of the plugin invoked by the message
227 # for plugin messages, the rest of the message, with the plugin name
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
236 # channel the message was in, nil for privately addressed messages
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.
245 # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff
246 # will be stripped from the message)
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)
262 if target == @bot.myself
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*/, "")
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, "")
288 if(@message =~ /^\001(\S+)(\s(.+))?\001/)
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
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
306 # returns true for private messages, e.g. "/msg bot hello"
311 # returns true if the message was in a channel
320 # convenience method to reply to a message, useful in plugins. It's the
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
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
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
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)
345 plainreply(string, options)
348 # convenience method to reply to a message with an action. It's the
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
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
364 # convenience method to reply "okay" in the current language to the
367 self.plainreply @bot.lang.get("okay")
370 # Like the above, but append the username
372 str = @bot.lang.get("okay").dup
374 # remove final punctuation
375 str.gsub!(/[!,.]$/,"")
376 str += ", #{@source}"
381 # the default okay style is the same as the default reply style
384 if @bot.config['core.reply_with_nick']
390 # send a NOTICE to the message source
392 def notify(msg,opts={})
393 @bot.notice(sourcenick, msg, opts)
398 # class to manage IRC PRIVMSGs
399 class PrivMessage < UserMessage
400 def initialize(bot, server, source, target, message)
406 # class to manage IRC NOTICEs
407 class NoticeMessage < UserMessage
408 def initialize(bot, server, source, target, message)
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
421 def initialize(bot, server, source, target, channel, message="")
422 super(bot, server, source, target, message)
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
434 def initialize(bot, server, source, target, channel, message="")
435 super(bot, server, source, target, message)
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)
456 class QuitMessage < BasicUserMessage
457 def initialize(bot, server, source, target, message="")
458 super(bot, server, source, target, message)
462 class TopicMessage < BasicUserMessage
465 # topic set at (unixtime)
466 attr_reader :timestamp
467 # topic set on channel
470 def initialize(bot, server, source, channel, topic=ChannelTopic.new)
471 super(bot, server, source, channel, topic.text)
473 @timestamp = topic.set_on
478 # class to manage channel joins
479 class JoinMessage < BasicUserMessage
482 def initialize(bot, server, source, channel, message="")
483 super(bot, server, source, channel, message)
485 # in this case sourcenick is the nick that could be the bot
486 @address = (source == @bot.myself)
490 # class to manage channel parts
491 # same as a join, but can have a message too
492 class PartMessage < JoinMessage