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 IRC user messages. Includes some utilities for handling
223 # the message, for example in plugins.
224 # The +message+ member will have any bot addressing "^bot: " removed
225 # (address? will return true in this case)
226 class UserMessage < BasicUserMessage
228 # for plugin messages, the name of the plugin invoked by the message
231 # for plugin messages, the rest of the message, with the plugin name
235 # convenience member. Who to reply to (i.e. would be sourcenick for a
236 # privately addressed message, or target (the channel) for a publicly
240 # channel the message was in, nil for privately addressed messages
243 # for PRIVMSGs, false unless the message was a CTCP command,
244 # in which case it evaluates to the CTCP command itself
245 # (TIME, PING, VERSION, etc). The CTCP command parameters
246 # are then stored in the message.
249 # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff
250 # will be stripped from the message)
253 # instantiate a new UserMessage
254 # bot:: associated bot class
255 # source:: hostmask of the message source
256 # target:: nick/channel message is destined for
257 # message:: message part
258 def initialize(bot, server, source, target, message)
259 super(bot, server, source, target, message)
266 if target == @bot.myself
276 # check for option extra addressing prefixes, e.g "|search foo", or
277 # "!version" - first match wins
278 bot.config['core.address_prefix'].each {|mprefix|
279 if @message.gsub!(/^#{Regexp.escape(mprefix)}\s*/, "")
285 # even if they used above prefixes, we allow for silly people who
286 # combine all possible types, e.g. "|rbot: hello", or
287 # "/msg rbot rbot: hello", etc
288 if @message.gsub!(/^\s*#{Regexp.escape(bot.nick)}\s*([:;,>]|\s)\s*/i, "")
292 if(@message =~ /^\001(\S+)(\s(.+))?\001/)
294 # FIXME need to support quoting of NULL and CR/LF, see
295 # http://www.irchelp.org/irchelp/rfc/ctcpspec.html
296 @message = $3 || String.new
297 @action = @ctcp == 'ACTION'
298 debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})"
299 @logmessage = @message.dup
302 # free splitting for plugins
303 @params = @message.dup
304 if @params.gsub!(/^\s*(\S+)[\s$]*/, "")
305 @plugin = $1.downcase
306 @params = nil unless @params.length > 0
310 # returns true for private messages, e.g. "/msg bot hello"
315 # returns true if the message was in a channel
324 # convenience method to reply to a message, useful in plugins. It's the
326 # <tt>@bot.say m.replyto, string</tt>
327 # So if the message is private, it will reply to the user. If it was
328 # in a channel, it will reply in the channel.
329 def plainreply(string, options={})
330 @bot.say @replyto, string, options
334 # Same as reply, but when replying in public it adds the nick of the user
335 # the bot is replying to
336 def nickreply(string, options={})
337 extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : ""
338 @bot.say @replyto, extra + string, options
342 # the default reply style is to nickreply unless the reply already contains
343 # the nick or core.reply_with_nick is set to false
345 def reply(string, options={})
346 if @bot.config['core.reply_with_nick'] and not string =~ /\b#{Regexp.escape(@source.to_s)}\b/
347 return nickreply(string, options)
349 plainreply(string, options)
352 # convenience method to reply to a message with an action. It's the
354 # <tt>@bot.action m.replyto, string</tt>
355 # So if the message is private, it will reply to the user. If it was
356 # in a channel, it will reply in the channel.
357 def act(string, options={})
358 @bot.action @replyto, string, options
362 # send a CTCP response, i.e. a private NOTICE to the sender
363 # with the same CTCP command and the reply as a parameter
364 def ctcp_reply(string, options={})
365 @bot.ctcp_notice @source, @ctcp, string, options
368 # convenience method to reply "okay" in the current language to the
371 self.plainreply @bot.lang.get("okay")
374 # Like the above, but append the username
376 str = @bot.lang.get("okay").dup
378 # remove final punctuation
379 str.gsub!(/[!,.]$/,"")
380 str += ", #{@source}"
385 # the default okay style is the same as the default reply style
388 if @bot.config['core.reply_with_nick']
394 # send a NOTICE to the message source
396 def notify(msg,opts={})
397 @bot.notice(sourcenick, msg, opts)
402 # class to manage IRC PRIVMSGs
403 class PrivMessage < UserMessage
404 def initialize(bot, server, source, target, message)
410 # class to manage IRC NOTICEs
411 class NoticeMessage < UserMessage
412 def initialize(bot, server, source, target, message)
418 # class to manage IRC KICKs
419 # +address?+ can be used as a shortcut to see if the bot was kicked,
420 # basically, +target+ was kicked from +channel+ by +source+ with +message+
421 class KickMessage < BasicUserMessage
422 # channel user was kicked from
425 def initialize(bot, server, source, target, channel, message="")
426 super(bot, server, source, target, message)
431 # class to manage IRC INVITEs
432 # +address?+ can be used as a shortcut to see if the bot was invited,
433 # which should be true except for server bugs
434 class InviteMessage < BasicUserMessage
435 # channel user was invited to
438 def initialize(bot, server, source, target, channel, message="")
439 super(bot, server, source, target, message)
444 # class to pass IRC Nick changes in. @message contains the old nickame,
445 # @sourcenick contains the new one.
446 class NickMessage < BasicUserMessage
447 def initialize(bot, server, source, oldnick, newnick)
448 super(bot, server, source, oldnick, newnick)
460 class QuitMessage < BasicUserMessage
461 def initialize(bot, server, source, target, message="")
462 super(bot, server, source, target, message)
466 class TopicMessage < BasicUserMessage
469 # topic set at (unixtime)
470 attr_reader :timestamp
471 # topic set on channel
474 def initialize(bot, server, source, channel, topic=ChannelTopic.new)
475 super(bot, server, source, channel, topic.text)
477 @timestamp = topic.set_on
482 # class to manage channel joins
483 class JoinMessage < BasicUserMessage
486 def initialize(bot, server, source, channel, message="")
487 super(bot, server, source, channel, message)
489 # in this case sourcenick is the nick that could be the bot
490 @address = (source == @bot.myself)
494 # class to manage channel parts
495 # same as a join, but can have a message too
496 class PartMessage < JoinMessage