X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fmessage.rb;h=df3812e00e24d4f3e724f3b6b12cf3e888d75b16;hb=edb270838305ee330480bc0fb4060b11af4ff128;hp=4110e634b92a0a966350b2a13a3f59ebe9614fe3;hpb=fff8d44385c9cbac4c2e037ea950db0f747f9f46;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/message.rb b/lib/rbot/message.rb index 4110e634..df3812e0 100644 --- a/lib/rbot/message.rb +++ b/lib/rbot/message.rb @@ -1,25 +1,103 @@ +#-- vim:sw=2:et +#++ +# +# :title: IRC message datastructures + module Irc - BotConfig.register BotConfigArrayValue.new('core.address_prefix', - :default => [], :wizard => true, - :desc => "what non nick-matching prefixes should the bot respond to as if addressed (e.g !, so that '!foo' is treated like 'rbot: foo')" - ) - BotConfig.register BotConfigBooleanValue.new('core.reply_with_nick', - :default => false, :wizard => true, - :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!')" - ) - BotConfig.register BotConfigStringValue.new('core.nick_postfix', - :default => ':', :wizard => true, - :desc => "when replying with nick put this character after the nick of the user the bot is replying to" - ) + class Bot + module Config + Config.register ArrayValue.new('core.address_prefix', + :default => [], :wizard => true, + :desc => "what non nick-matching prefixes should the bot respond to as if addressed (e.g !, so that '!foo' is treated like 'rbot: foo')" + ) + + Config.register BooleanValue.new('core.reply_with_nick', + :default => false, :wizard => true, + :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!')" + ) + Config.register StringValue.new('core.nick_postfix', + :default => ':', :wizard => true, + :desc => "when replying with nick put this character after the nick of the user the bot is replying to" + ) + end + end + + + # Define standard IRC attriubtes (not so standard actually, + # but the closest thing we have ...) Bold = "\002" Underline = "\037" Reverse = "\026" Italic = "\011" + NormalText = "\017" + + # Color is prefixed by \003 and followed by optional + # foreground and background specifications, two-digits-max + # numbers separated by a comma. One of the two parts + # must be present. Color = "\003" - ColorRx = /#{Color}\d\d?(?:,\d\d?)?/ + ColorRx = /#{Color}\d?\d?(?:,\d\d?)?/ + + # Standard color codes + ColorCode = { + :black => 1, + :blue => 2, + :navyblue => 2, + :navy_blue => 2, + :green => 3, + :red => 4, + :brown => 5, + :purple => 6, + :olive => 7, + :yellow => 8, + :limegreen => 9, + :lime_green => 9, + :teal => 10, + :aqualight => 11, + :aqua_light => 11, + :royal_blue => 12, + :hotpink => 13, + :hot_pink => 13, + :darkgray => 14, + :dark_gray => 14, + :lightgray => 15, + :light_gray => 15, + :white => 16 + } + + # Convert a String or Symbol into a color number + def Irc.find_color(data) + if Integer === data + data + else + f = if String === data + data.intern + else + data + end + if ColorCode.key?(f) + ColorCode[f] + else + 0 + end + end + end + + # Insert the full color code for a given + # foreground/background combination. + def Irc.color(fg=nil,bg=nil) + str = Color.dup + if fg + str << Irc.find_color(fg).to_s + end + if bg + str << "," << Irc.find_color(bg).to_s + end + return str + end # base user message class, all user messages derive from this # (a user message is defined as having a source hostmask, a target @@ -44,6 +122,9 @@ module Irc # contents of the message attr_accessor :message + # contents of the message (for logging purposes) + attr_accessor :logmessage + # has the message been replied to/handled by a plugin? attr_accessor :replied @@ -74,6 +155,7 @@ module Irc warning "Message does not have identification" end end + @logmessage = @message.dup if target && target == @bot.myself @address = true @@ -84,15 +166,22 @@ module Irc # Access the nick of the source # def sourcenick - @source.nick + @source.nick rescue @source.to_s end # Access the user@host of the source # def sourceaddress - "#{@source.user}@#{@source.host}" + "#{@source.user}@#{@source.host}" rescue @source.to_s end + # Access the botuser corresponding to the source, if any + # + def botuser + source.botuser rescue @bot.auth.everyone + end + + # Was the message from an identified user? def identified? return @identified @@ -142,6 +231,12 @@ module Irc # channel the message was in, nil for privately addressed messages attr_reader :channel + # for PRIVMSGs, false unless the message was a CTCP command, + # in which case it evaluates to the CTCP command itself + # (TIME, PING, VERSION, etc). The CTCP command parameters + # are then stored in the message. + attr_reader :ctcp + # for PRIVMSGs, true if the message was a CTCP ACTION (CTCP stuff # will be stripped from the message) attr_reader :action @@ -156,6 +251,7 @@ module Irc @target = target @private = false @plugin = nil + @ctcp = false @action = false if target == @bot.myself @@ -184,9 +280,14 @@ module Irc @address = true end - if(@message =~ /^\001ACTION\s(.+)\001/) - @message = $1 - @action = true + if(@message =~ /^\001(\S+)(\s(.+))?\001/) + @ctcp = $1 + # FIXME need to support quoting of NULL and CR/LF, see + # http://www.irchelp.org/irchelp/rfc/ctcpspec.html + @message = $3 || String.new + @action = @ctcp == 'ACTION' + debug "Received CTCP command #{@ctcp} with options #{@message} (action? #{@action})" + @logmessage = @message.dup end # free splitting for plugins @@ -249,6 +350,12 @@ module Irc @replied = true end + # send a CTCP response, i.e. a private NOTICE to the sender + # with the same CTCP command and the reply as a parameter + def ctcp_reply(string, options={}) + @bot.ctcp_notice @source, @ctcp, string, options + end + # convenience method to reply "okay" in the current language to the # message def plainokay @@ -275,6 +382,12 @@ module Irc plainokay end + # send a NOTICE to the message source + # + def notify(msg,opts={}) + @bot.notice(sourcenick, msg, opts) + end + end # class to manage IRC PRIVMSGs