linkbot plugin: make message pattern configurable
[rbot] / 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   BotConfig.register BotConfigArrayValue.new('linkbot.nicks',
26     :default => [],
27     :desc => "Nick(s) of the bots that act as channel links across networks")
28
29   BotConfig.register BotConfigArrayValue.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   # TODO use template strings instead of regexp for user friendliness
33   
34   # Initialize the plugin
35   def initialize
36     super
37     
38     @message_patterns = @bot.config['linkbot.message_patterns'].map {|p|
39       Regexp.new(p)
40     }
41   end
42
43   # Main method
44   def listen(m)
45     linkbots = @bot.config['linkbot.nicks']
46     return if linkbots.empty?
47     return unless linkbots.include?(m.sourcenick)
48     return unless m.kind_of?(PrivMessage)
49     # Now we know that _m_ is a PRIVMSG from a linkbot. Let's split it
50     # in nick, network, message
51     if @message_patterns.any? {|p| m.message.match p}
52       # if the regexp doesn't contain all parts, the default values get used
53       new_nick = $1 || 'unknown_nick'
54       network = $2 || 'unknown_network'
55       message = $3 || 'unknown_message'
56
57       debug "#{m.sourcenick} reports that #{new_nick} said #{message.inspect} on #{network}"
58       # One way to pass the new message back to the bot is to create a PrivMessage
59       # and delegate it to the plugins
60       new_m = PrivMessage.new(@bot, m.server, m.server.user(new_nick), m.target, message)
61       @bot.plugins.delegate "listen", new_m
62       @bot.plugins.privmsg(new_m) if new_m.address?
63
64       ## Another way is to create a data Hash with source, target and message keys
65       ## and then letting the bot client :privmsg handler handle it
66       ## Note that this will also create irclog entries for the fake PRIVMSG
67       ## TODO we could probably add a :no_irc_log entry to the data passed to the
68       ## @bot.client handlers, or something like that
69       # data = {
70       #   :source => m.server.user(new_nick)
71       #   :target => m.target
72       #   :message => message
73       # }
74       # @bot.client[:privmsg].call(data)
75     end
76   end
77 end
78
79 plugin = LinkBot.new
80