data/rbot/plugins/linkbot.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: linkbot management for rbot
   5 #
   6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   7 # Copyright:: (C) 2006 Giuseppe Bilotta
   8 # License:: GPL v2
   9 #
  10 # Based on an idea by hagabaka (Yaohan Chen <yaohan.chen@gmail.com>)
  11 #
  12 # This plugin is used to grab messages from eggdrops (or other bots) that link
  13 # channels from different networks. For the time being, a PRIVMSG echoed by an
  14 # eggdrop is assumed to be in the form:
  15 #    <eggdrop> (nick@network) text of the message
  16 # and it's fed back to the message delegators.
  17 #
  18 # This plugin also shows how to create 'fake' messages from a plugin, letting
  19 # the bot parse them.
  20 #
  21 # TODO a possible enhancement to the Irc framework could be to create 'fake'
  22 # servers to make this even easier.
  23
  24 class LinkBot < Plugin
  25   Config.register Config::ArrayValue.new('linkbot.nicks',
  26     :default => [],
  27     :desc => "Nick(s) of the bots that act as channel links across networks")
  28
  29   Config.register Config::ArrayValue.new('linkbot.message_patterns',
  30     :default => ['^<(\S+?)@(\S+?)>\s+(.*)$', '^\((\S+?)@(\S+?)\)\s+(.*)$'],
  31     :desc => "List of regexp which match linkbot messages; each regexp needs to have three captures, which in order are the nickname of the original speaker, network, and original message",
  32     :on_change => proc {|bot, v| bot.plugins['linkbot'].update_patterns})
  33   # TODO use template strings instead of regexp for user friendliness
  34
  35   # Initialize the plugin
  36   def initialize
  37     super
  38     update_patterns
  39   end
  40
  41   def update_patterns
  42     @message_patterns = @bot.config['linkbot.message_patterns'].map {|p|
  43       Regexp.new(p)
  44     }
  45   end
  46
  47   # Main method
  48   def listen(m)
  49     linkbots = @bot.config['linkbot.nicks']
  50     return if linkbots.empty?
  51     return unless linkbots.include?(m.sourcenick)
  52     return unless m.kind_of?(PrivMessage)
  53     # Now we know that _m_ is a PRIVMSG from a linkbot. Let's split it
  54     # in nick, network, message
  55     if @message_patterns.any? {|p| m.message =~ p}
  56       # if the regexp doesn't contain all parts, the default values get used
  57       new_nick = $1 || 'unknown_nick'
  58       network = $2 || 'unknown_network'
  59       message = $3 || 'unknown_message'
  60       # strip any formatting codes in the new_nick. some people configure their linkbots
  61       # to embed these codes in nicknames (such as to\B\Bm), to avoid triggering the
  62       # person's highlight
  63       new_nick.gsub!(/[#{Bold}#{Underline}#{Reverse}#{Italic}#{NormalText}]/, '')
  64       debug "#{m.sourcenick} reports that #{new_nick} said #{message.inspect} on #{network}"
  65       # One way to pass the new message back to the bot is to create a PrivMessage
  66       # and delegate it to the plugins
  67       new_m = PrivMessage.new(@bot, m.server, m.server.user(new_nick), m.target, message)
  68       @bot.plugins.delegate "listen", new_m
  69       @bot.plugins.privmsg(new_m) if new_m.address?
  70
  71       ## Another way is to create a data Hash with source, target and message keys
  72       ## and then letting the bot client :privmsg handler handle it
  73       ## Note that this will also create irclog entries for the fake PRIVMSG
  74       ## TODO we could probably add a :no_irc_log entry to the data passed to the
  75       ## @bot.client handlers, or something like that
  76       # data = {
  77       #   :source => m.server.user(new_nick)
  78       #   :target => m.target
  79       #   :message => message
  80       # }
  81       # @bot.client[:privmsg].call(data)
  82     end
  83   end
  84 end
  85
  86 plugin = LinkBot.new
  87