2 BotConfig.register BotConfigArrayValue.new('plugins.blacklist',
3 :default => [], :wizard => false, :requires_restart => true,
4 :desc => "Plugins that should not be loaded")
6 require 'rbot/messagemapper'
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:
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.
21 # plugin.map 'karmastats', :action => 'karma_stats'
23 # # while in the plugin...
24 # def karma_stats(m, params)
28 # # the default action is the first component
31 # # attributes can be pulled out of the match string
32 # plugin.map 'karma for :key'
33 # plugin.map 'karma :key'
35 # # while in the plugin...
36 # def karma(m, params)
38 # m.reply 'karma for #{item}'
41 # # you can setup defaults, to make parameters optional
42 # plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
44 # # the default auth check is also against the first component
45 # # but that can be changed
46 # plugin.map 'karmastats', :auth => 'karma'
48 # # maps can be restricted to public or private message:
49 # plugin.map 'karmastats', :private false,
50 # plugin.map 'karmastats', :public false,
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,
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,
67 # Called when a user (or the bot) is kicked from a
68 # channel the bot is in.
71 # Called when a user (or the bot) joins a channel
74 # Called when a user (or the bot) parts a channel
77 # Called when a user (or the bot) quits IRC
80 # Called when a user (or the bot) changes Nick
81 # topic(TopicMessage)::
82 # Called when a user (or the bot) changes a channel
85 # connect():: Called when a server is joined successfully, but
86 # before autojoin channels are joined (no params)
88 # save:: Called when you are required to save your plugin's
89 # state, if you maintain data between sessions
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
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
101 @handler = MessageMapper.new(self)
102 @registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
106 # debug "Flushing #{@registry}"
111 # debug "Closing #{@registry}"
118 name = @handler.last.items[0]
120 unless self.respond_to?('privmsg')
130 name = @handler.last.items[0]
131 self.register name, {:hidden => true}
132 unless self.respond_to?('privmsg')
139 # return an identifier for this plugin, defaults to a list of the message
140 # prefixes handled (used for error messages etc)
145 # return a help string for your module. for complex modules, you may wish
146 # to break your help into topics, and return a list of available topics if
147 # +topic+ is nil. +plugin+ is passed containing the matching prefix for
148 # this message - if your plugin handles multiple prefixes, make sure your
149 # return the correct help for the prefix requested
150 def help(plugin, topic)
154 # register the plugin as a handler for messages prefixed +name+
155 # this can be called multiple times for a plugin to handle multiple
157 def register(name,opts={})
158 raise ArgumentError, "Second argument must be a hash!" unless opts.kind_of?(Hash)
159 return if Plugins.plugins.has_key?(name)
160 Plugins.plugins[name] = self
161 @names << name unless opts.fetch(:hidden, false)
164 # default usage method provided as a utility for simple plugins. The
165 # MessageMapper uses 'usage' as its default fallback method.
166 def usage(m, params = {})
167 m.reply "incorrect usage, ask for help using '#{@bot.nick}: help #{m.plugin}'"
172 # class to manage multiple plugins and delegate messages to them for
175 # hash of registered message prefixes and associated plugins
177 # associated IrcBot class
180 # bot:: associated IrcBot class
181 # dirlist:: array of directories to scan (in order) for plugins
183 # create a new plugin handler, scanning for plugins in +dirlist+
184 def initialize(bot, dirlist)
187 @blacklist = Array.new
188 @@bot.config['plugins.blacklist'].each { |p|
189 @blacklist << p+".rb"
194 # access to associated bot
199 # access to list of plugins
204 # load plugins from pre-assigned list of directories
206 processed = @blacklist.dup
208 dirs << Config::datadir + "/plugins"
210 dirs.reverse.each {|dir|
211 if(FileTest.directory?(dir))
214 next if(file =~ /^\./)
215 next if(processed.include?(file))
216 if(file =~ /^(.+\.rb)\.disabled$/)
220 next unless(file =~ /\.rb$/)
221 tmpfilename = "#{dir}/#{file}"
223 # create a new, anonymous module to "house" the plugin
224 # the idea here is to prevent namespace pollution. perhaps there
226 plugin_module = Module.new
229 plugin_string = IO.readlines(tmpfilename).join("")
230 debug "loading plugin #{tmpfilename}"
231 plugin_module.module_eval(plugin_string)
233 rescue Exception => err
234 # rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
235 warning "plugin #{tmpfilename} load failed: " + err.inspect
236 warning err.backtrace.join("\n")
243 # call the save method for each active plugin
245 delegate 'flush_registry'
249 # call the cleanup method for each active plugin
254 # drop all plugins and rescan plugins on disk
255 # calls save and cleanup for each plugin before dropping them
263 # return list of help topics (plugin names)
265 if(@@plugins.length > 0)
266 # return " [plugins: " + @@plugins.keys.sort.join(", ") + "]"
267 return " [#{length} plugins: " + @@plugins.values.uniq.collect{|p| p.name}.sort.join(", ") + "]"
269 return " [no plugins active]"
274 @@plugins.values.uniq.length
277 # return help for +topic+ (call associated plugin's help method)
279 if(topic =~ /^(\S+)\s*(.*)$/)
282 if(@@plugins.has_key?(key))
284 return @@plugins[key].help(key, params)
285 rescue Exception => err
286 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
287 error "plugin #{@@plugins[key].name} help() failed: #{err.class}: #{err}"
288 error err.backtrace.join("\n")
296 # see if each plugin handles +method+, and if so, call it, passing
297 # +message+ as a parameter
298 def delegate(method, *args)
299 @@plugins.values.uniq.each {|p|
300 if(p.respond_to? method)
303 rescue Exception => err
304 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
305 error "plugin #{p.name} #{method}() failed: #{err.class}: #{err}"
306 error err.backtrace.join("\n")
312 # see if we have a plugin that wants to handle this message, if so, pass
313 # it to the plugin and return true, otherwise false
315 return unless(m.plugin)
316 if (@@plugins.has_key?(m.plugin) &&
317 @@plugins[m.plugin].respond_to?("privmsg") &&
318 @@bot.auth.allow?(m.plugin, m.source, m.replyto))
320 @@plugins[m.plugin].privmsg(m)
321 rescue Exception => err
322 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
323 error "plugin #{@@plugins[m.plugin].name} privmsg() failed: #{err.class}: #{err}"
324 error err.backtrace.join("\n")