]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - lib/rbot/plugins.rb
Add mapsvn diff method for plugins: just like map, but doesn't add synonyms to the...
[user/henk/code/ruby/rbot.git] / lib / rbot / plugins.rb
1 module Irc
2     BotConfig.register BotConfigArrayValue.new('plugins.blacklist',
3       :default => [], :wizard => false, :requires_restart => true,
4       :desc => "Plugins that should not be loaded")
5 module Plugins
6   require 'rbot/messagemapper'
7
8   # base class for all rbot plugins
9   # certain methods will be called if they are provided, if you define one of
10   # the following methods, it will be called as appropriate:
11   #
12   # map(template, options)::
13   # map!(template, options)::
14   #    map is the new, cleaner way to respond to specific message formats
15   #    without littering your plugin code with regexps. The difference
16   #    between map and map! is that map! will not register the new command
17   #    as an alternative name for the plugin.
18   #
19   #    Examples:
20   #
21   #      plugin.map 'karmastats', :action => 'karma_stats'
22   #
23   #      # while in the plugin...
24   #      def karma_stats(m, params)
25   #        m.reply "..."
26   #      end
27   #
28   #      # the default action is the first component
29   #      plugin.map 'karma'
30   #
31   #      # attributes can be pulled out of the match string
32   #      plugin.map 'karma for :key'
33   #      plugin.map 'karma :key'
34   #
35   #      # while in the plugin...
36   #      def karma(m, params)
37   #        item = params[:key]
38   #        m.reply 'karma for #{item}'
39   #      end
40   #
41   #      # you can setup defaults, to make parameters optional
42   #      plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
43   #
44   #      # the default auth check is also against the first component
45   #      # but that can be changed
46   #      plugin.map 'karmastats', :auth => 'karma'
47   #
48   #      # maps can be restricted to public or private message:
49   #      plugin.map 'karmastats', :private false,
50   #      plugin.map 'karmastats', :public false,
51   #    end
52   #
53   # listen(UserMessage)::
54   #                        Called for all messages of any type. To
55   #                        differentiate them, use message.kind_of? It'll be
56   #                        either a PrivMessage, NoticeMessage, KickMessage,
57   #                        QuitMessage, PartMessage, JoinMessage, NickMessage,
58   #                        etc.
59   #
60   # privmsg(PrivMessage)::
61   #                        called for a PRIVMSG if the first word matches one
62   #                        the plugin register()d for. Use m.plugin to get
63   #                        that word and m.params for the rest of the message,
64   #                        if applicable.
65   #
66   # kick(KickMessage)::
67   #                        Called when a user (or the bot) is kicked from a
68   #                        channel the bot is in.
69   #
70   # join(JoinMessage)::
71   #                        Called when a user (or the bot) joins a channel
72   #
73   # part(PartMessage)::
74   #                        Called when a user (or the bot) parts a channel
75   #
76   # quit(QuitMessage)::
77   #                        Called when a user (or the bot) quits IRC
78   #
79   # nick(NickMessage)::
80   #                        Called when a user (or the bot) changes Nick
81   # topic(TopicMessage)::
82   #                        Called when a user (or the bot) changes a channel
83   #                        topic
84   #
85   # connect()::            Called when a server is joined successfully, but
86   #                        before autojoin channels are joined (no params)
87   #
88   # save::                 Called when you are required to save your plugin's
89   #                        state, if you maintain data between sessions
90   #
91   # cleanup::              called before your plugin is "unloaded", prior to a
92   #                        plugin reload or bot quit - close any open
93   #                        files/connections or flush caches here
94   class Plugin
95     attr_reader :bot   # the associated bot
96     # initialise your plugin. Always call super if you override this method,
97     # as important variables are set up for you
98     def initialize
99       @bot = Plugins.bot
100       @names = Array.new
101       @handler = MessageMapper.new(self)
102       @registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
103     end
104
105     def flush_registry
106       # debug "Flushing #{@registry}"
107       @registry.flush
108     end
109
110     def cleanup
111       # debug "Closing #{@registry}"
112       @registry.close
113     end
114
115     def map(*args)
116       @handler.map(*args)
117       # register this map
118       name = @handler.last.items[0]
119       self.register name
120       unless self.respond_to?('privmsg')
121         def self.privmsg(m)
122           @handler.handle(m)
123         end
124       end
125     end
126
127     def map!(*args)
128       @handler.map(*args)
129       # register this map
130       name = @handler.last.items[0]
131       unless self.respond_to?('privmsg')
132         def self.privmsg(m)
133           @handler.handle(m)
134         end
135       end
136     end
137
138     # return an identifier for this plugin, defaults to a list of the message
139     # prefixes handled (used for error messages etc)
140     def name
141       @names.join("|")
142     end
143
144     # return a help string for your module. for complex modules, you may wish
145     # to break your help into topics, and return a list of available topics if
146     # +topic+ is nil. +plugin+ is passed containing the matching prefix for
147     # this message - if your plugin handles multiple prefixes, make sure your
148     # return the correct help for the prefix requested
149     def help(plugin, topic)
150       "no help"
151     end
152
153     # register the plugin as a handler for messages prefixed +name+
154     # this can be called multiple times for a plugin to handle multiple
155     # message prefixes
156     def register(name)
157       return if Plugins.plugins.has_key?(name)
158       Plugins.plugins[name] = self
159       @names << name
160     end
161
162     # default usage method provided as a utility for simple plugins. The
163     # MessageMapper uses 'usage' as its default fallback method.
164     def usage(m, params = {})
165       m.reply "incorrect usage, ask for help using '#{@bot.nick}: help #{m.plugin}'"
166     end
167
168   end
169
170   # class to manage multiple plugins and delegate messages to them for
171   # handling
172   class Plugins
173     # hash of registered message prefixes and associated plugins
174     @@plugins = Hash.new
175     # associated IrcBot class
176     @@bot = nil
177
178     # bot::     associated IrcBot class
179     # dirlist:: array of directories to scan (in order) for plugins
180     #
181     # create a new plugin handler, scanning for plugins in +dirlist+
182     def initialize(bot, dirlist)
183       @@bot = bot
184       @dirs = dirlist
185       @blacklist = Array.new
186       @@bot.config['plugins.blacklist'].each { |p|
187         @blacklist << p+".rb"
188       }
189       scan
190     end
191
192     # access to associated bot
193     def Plugins.bot
194       @@bot
195     end
196
197     # access to list of plugins
198     def Plugins.plugins
199       @@plugins
200     end
201
202     # load plugins from pre-assigned list of directories
203     def scan
204       processed = @blacklist.dup
205       dirs = Array.new
206       dirs << Config::datadir + "/plugins"
207       dirs += @dirs
208       dirs.reverse.each {|dir|
209         if(FileTest.directory?(dir))
210           d = Dir.new(dir)
211           d.sort.each {|file|
212             next if(file =~ /^\./)
213             next if(processed.include?(file))
214             if(file =~ /^(.+\.rb)\.disabled$/)
215               processed << $1
216               next
217             end
218             next unless(file =~ /\.rb$/)
219             tmpfilename = "#{dir}/#{file}"
220
221             # create a new, anonymous module to "house" the plugin
222             # the idea here is to prevent namespace pollution. perhaps there
223             # is another way?
224             plugin_module = Module.new
225
226             begin
227               plugin_string = IO.readlines(tmpfilename).join("")
228               debug "loading plugin #{tmpfilename}"
229               plugin_module.module_eval(plugin_string)
230               processed << file
231             rescue Exception => err
232               # rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
233               warning "plugin #{tmpfilename} load failed: " + err.inspect
234               warning err.backtrace.join("\n")
235             end
236           }
237         end
238       }
239     end
240
241     # call the save method for each active plugin
242     def save
243       delegate 'flush_registry'
244       delegate 'save'
245     end
246
247     # call the cleanup method for each active plugin
248     def cleanup
249       delegate 'cleanup'
250     end
251
252     # drop all plugins and rescan plugins on disk
253     # calls save and cleanup for each plugin before dropping them
254     def rescan
255       save
256       cleanup
257       @@plugins = Hash.new
258       scan
259     end
260
261     # return list of help topics (plugin names)
262     def helptopics
263       if(@@plugins.length > 0)
264         # return " [plugins: " + @@plugins.keys.sort.join(", ") + "]"
265         return " [#{length} plugins: " + @@plugins.values.uniq.collect{|p| p.name}.sort.join(", ") + "]"
266       else
267         return " [no plugins active]" 
268       end
269     end
270
271     def length
272       @@plugins.values.uniq.length
273     end
274
275     # return help for +topic+ (call associated plugin's help method)
276     def help(topic="")
277       if(topic =~ /^(\S+)\s*(.*)$/)
278         key = $1
279         params = $2
280         if(@@plugins.has_key?(key))
281           begin
282             return @@plugins[key].help(key, params)
283           rescue Exception => err
284           #rescue TimeoutError, StandardError, NameError, SyntaxError => err
285             error "plugin #{@@plugins[key].name} help() failed: #{err.class}: #{err}"
286             error err.backtrace.join("\n")
287           end
288         else
289           return false
290         end
291       end
292     end
293
294     # see if each plugin handles +method+, and if so, call it, passing
295     # +message+ as a parameter
296     def delegate(method, *args)
297       @@plugins.values.uniq.each {|p|
298         if(p.respond_to? method)
299           begin
300             p.send method, *args
301           rescue Exception => err
302             #rescue TimeoutError, StandardError, NameError, SyntaxError => err
303             error "plugin #{p.name} #{method}() failed: #{err.class}: #{err}"
304             error err.backtrace.join("\n")
305           end
306         end
307       }
308     end
309
310     # see if we have a plugin that wants to handle this message, if so, pass
311     # it to the plugin and return true, otherwise false
312     def privmsg(m)
313       return unless(m.plugin)
314       if (@@plugins.has_key?(m.plugin) &&
315           @@plugins[m.plugin].respond_to?("privmsg") &&
316           @@bot.auth.allow?(m.plugin, m.source, m.replyto))
317         begin
318           @@plugins[m.plugin].privmsg(m)
319         rescue Exception => err
320           #rescue TimeoutError, StandardError, NameError, SyntaxError => err
321           error "plugin #{@@plugins[m.plugin].name} privmsg() failed: #{err.class}: #{err}"
322           error err.backtrace.join("\n")
323         end
324         return true
325       end
326       return false
327     end
328   end
329
330 end
331 end