X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fmessage.rb;h=3292cb8323a1f9aad8c638c25a69059002a40fda;hb=b64be129f02b7238030ea2f9e160118894b41174;hp=66b6175c21def0de1579de023f207881cc01268d;hpb=0a9b8950fd09f8b815d9f4c491eaadba5f64707e;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/message.rb b/lib/rbot/message.rb index 66b6175c..3292cb83 100644 --- a/lib/rbot/message.rb +++ b/lib/rbot/message.rb @@ -4,10 +4,21 @@ module Irc :desc => "what non nick-matching prefixes should the bot respond to as if addressed (e.g !, so that '!foo' is treated like 'rbot: foo')" ) - Color = "\003" + 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" + ) + Bold = "\002" Underline = "\037" Reverse = "\026" + Color = "\003" + ColorRx = /#{Color}\d\d?(?:,\d\d?)?/ # base user message class, all user messages derive from this # (a user message is defined as having a source hostmask, a target @@ -17,19 +28,16 @@ module Irc # associated bot attr_reader :bot + # associated server + attr_reader :server + # when the message was received attr_reader :time - # hostmask of message source + # User that originated the message attr_reader :source - # nick of message source - attr_reader :sourcenick - - # url part of message source - attr_reader :sourceaddress - - # nick/channel message was sent to + # User/Channel message was sent to attr_reader :target # contents of the message @@ -40,10 +48,11 @@ module Irc # instantiate a new Message # bot:: associated bot class - # source:: hostmask of the message source - # target:: nick/channel message is destined for - # message:: message part - def initialize(bot, source, target, message) + # server:: Server where the message took place + # source:: User that sent the message + # target:: User/Channel is destined for + # message:: actual message + def initialize(bot, server, source, target, message) @msg_wants_id = false unless defined? @msg_wants_id @time = Time.now @@ -53,10 +62,11 @@ module Irc @target = target @message = BasicUserMessage.stripcolour message @replied = false + @server = server @identified = false - if @msg_wants_id && @bot.capabilities["identify-msg".to_sym] - if @message =~ /([-+])(.*)/ + if @msg_wants_id && @server.capabilities[:"identify-msg"] + if @message =~ /^([-+])(.*)/ @identified = ($1=="+") @message = $2 else @@ -64,18 +74,25 @@ module Irc end end - # split source into consituent parts - if source =~ /^((\S+)!(\S+))$/ - @sourcenick = $2 - @sourceaddress = $3 - end - - if target && target.downcase == @bot.nick.downcase + if target && target == @bot.myself @address = true end end + # Access the nick of the source + # + def sourcenick + @source.nick + end + + # Access the user@host of the source + # + def sourceaddress + "#{@source.user}@#{@source.host}" + end + + # Was the message from an identified user? def identified? return @identified end @@ -96,7 +113,7 @@ module Irc # strip mIRC colour escapes from a string def BasicUserMessage.stripcolour(string) return "" unless string - ret = string.gsub(/\cC\d\d?(?:,\d\d?)?/, "") + ret = string.gsub(ColorRx, "") #ret.tr!("\x00-\x1f", "") ret end @@ -133,18 +150,18 @@ module Irc # source:: hostmask of the message source # target:: nick/channel message is destined for # message:: message part - def initialize(bot, source, target, message) - super(bot, source, target, message) + def initialize(bot, server, source, target, message) + super(bot, server, source, target, message) @target = target @private = false @plugin = nil @action = false - if target.downcase == @bot.nick.downcase + if target == @bot.myself @private = true @address = true @channel = nil - @replyto = @sourcenick + @replyto = source else @replyto = @target @channel = @target @@ -198,32 +215,70 @@ module Irc # @bot.say m.replyto, string # So if the message is private, it will reply to the user. If it was # in a channel, it will reply in the channel. - def reply(string) - @bot.say @replyto, string + def plainreply(string, options={}) + @bot.say @replyto, string, options @replied = true end + # Same as reply, but when replying in public it adds the nick of the user + # the bot is replying to + def nickreply(string, options={}) + extra = self.public? ? "#{@source}#{@bot.config['core.nick_postfix']} " : "" + @bot.say @replyto, extra + string, options + @replied = true + end + + # the default reply style is to nickreply unless the reply already contains + # the nick or core.reply_with_nick is set to false + # + def reply(string, options={}) + if @bot.config['core.reply_with_nick'] and not string =~ /\b#{@source}\b/ + return nickreply(string, options) + end + plainreply(string, options) + end + # convenience method to reply to a message with an action. It's the # same as doing: # @bot.action m.replyto, string # So if the message is private, it will reply to the user. If it was # in a channel, it will reply in the channel. - def act(string) - @bot.action @replyto, string + def act(string, options={}) + @bot.action @replyto, string, options @replied = true end # convenience method to reply "okay" in the current language to the # message + def plainokay + self.plainreply @bot.lang.get("okay") + end + + # Like the above, but append the username + def nickokay + str = @bot.lang.get("okay").dup + if self.public? + # remove final punctuation + str.gsub!(/[!,.]$/,"") + str += ", #{@source}" + end + self.plainreply str + end + + # the default okay style is the same as the default reply style + # def okay - @bot.say @replyto, @bot.lang.get("okay") + if @bot.config['core.reply_with_nick'] + return nickokay + end + plainokay end end # class to manage IRC PRIVMSGs class PrivMessage < UserMessage - def initialize(bot, source, target, message) + def initialize(bot, server, source, target, message) @msg_wants_id = true super end @@ -231,7 +286,7 @@ module Irc # class to manage IRC NOTICEs class NoticeMessage < UserMessage - def initialize(bot, source, target, message) + def initialize(bot, server, source, target, message) @msg_wants_id = true super end @@ -244,8 +299,8 @@ module Irc # channel user was kicked from attr_reader :channel - def initialize(bot, source, target, channel, message="") - super(bot, source, target, message) + def initialize(bot, server, source, target, channel, message="") + super(bot, server, source, target, message) @channel = channel end end @@ -253,14 +308,22 @@ module Irc # class to pass IRC Nick changes in. @message contains the old nickame, # @sourcenick contains the new one. class NickMessage < BasicUserMessage - def initialize(bot, source, oldnick, newnick) - super(bot, source, oldnick, newnick) + def initialize(bot, server, source, oldnick, newnick) + super(bot, server, source, oldnick, newnick) + end + + def oldnick + return @target + end + + def newnick + return @message end end class QuitMessage < BasicUserMessage - def initialize(bot, source, target, message="") - super(bot, source, target, message) + def initialize(bot, server, source, target, message="") + super(bot, server, source, target, message) end end @@ -272,10 +335,10 @@ module Irc # topic set on channel attr_reader :channel - def initialize(bot, source, channel, timestamp, topic="") - super(bot, source, channel, topic) + def initialize(bot, server, source, channel, topic=ChannelTopic.new) + super(bot, server, source, channel, topic.text) @topic = topic - @timestamp = timestamp + @timestamp = topic.set_on @channel = channel end end @@ -284,11 +347,11 @@ module Irc class JoinMessage < BasicUserMessage # channel joined attr_reader :channel - def initialize(bot, source, channel, message="") - super(bot, source, channel, message) + def initialize(bot, server, source, channel, message="") + super(bot, server, source, channel, message) @channel = channel # in this case sourcenick is the nick that could be the bot - @address = (sourcenick.downcase == @bot.nick.downcase) + @address = (source == @bot.myself) end end