4 # :title: rbot plugin management
10 Config.register Config::ArrayValue.new('plugins.blacklist',
11 :default => [], :wizard => false, :requires_rescan => true,
12 :desc => "Plugins that should not be loaded")
14 require 'rbot/messagemapper'
17 BotModule is the base class for the modules that enhance the rbot
18 functionality. Rather than subclassing BotModule, however, one should
19 subclass either CoreBotModule (reserved for system modules) or Plugin
22 A BotModule interacts with Irc events by defining one or more of the following
23 methods, which get called as appropriate when the corresponding Irc event
26 map(template, options)::
27 map!(template, options)::
28 map is the new, cleaner way to respond to specific message formats without
29 littering your plugin code with regexps, and should be used instead of
30 #register() and #privmsg() (see below) when possible.
32 The difference between map and map! is that map! will not register the new
33 command as an alternative name for the plugin.
37 plugin.map 'karmastats', :action => 'karma_stats'
39 # while in the plugin...
40 def karma_stats(m, params)
44 # the default action is the first component
47 # attributes can be pulled out of the match string
48 plugin.map 'karma for :key'
49 plugin.map 'karma :key'
51 # while in the plugin...
54 m.reply 'karma for #{item}'
57 # you can setup defaults, to make parameters optional
58 plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
60 # the default auth check is also against the first component
61 # but that can be changed
62 plugin.map 'karmastats', :auth => 'karma'
64 # maps can be restricted to public or private message:
65 plugin.map 'karmastats', :private => false
66 plugin.map 'karmastats', :public => false
68 See MessageMapper#map for more information on the template format and the
72 Called for all messages of any type. To
73 differentiate them, use message.kind_of? It'll be
74 either a PrivMessage, NoticeMessage, KickMessage,
75 QuitMessage, PartMessage, JoinMessage, NickMessage,
78 ctcp_listen(UserMessage)::
79 Called for all messages that contain a CTCP command.
80 Use message.ctcp to get the CTCP command, and
81 message.message to get the parameter string. To reply,
82 use message.ctcp_reply, which sends a private NOTICE
85 message(PrivMessage)::
86 Called for all PRIVMSG. Hook on this method if you
87 need to handle PRIVMSGs regardless of whether they are
88 addressed to the bot or not, and regardless of
90 privmsg(PrivMessage)::
91 Called for a PRIVMSG if the first word matches one
92 the plugin #register()ed for. Use m.plugin to get
93 that word and m.params for the rest of the message,
96 unreplied(PrivMessage)::
97 Called for a PRIVMSG which has not been replied to.
100 Called when a user (or the bot) is kicked from a
101 channel the bot is in.
103 invite(InviteMessage)::
104 Called when the bot is invited to a channel.
107 Called when a user (or the bot) joins a channel
110 Called when a user (or the bot) parts a channel
113 Called when a user (or the bot) quits IRC
116 Called when a user (or the bot) changes Nick
117 topic(TopicMessage)::
118 Called when a user (or the bot) changes a channel
121 connect:: Called when a server is joined successfully, but
122 before autojoin channels are joined (no params)
124 set_language(String)::
125 Called when the user sets a new language
126 whose name is the given String
128 save:: Called when you are required to save your plugin's
129 state, if you maintain data between sessions
131 cleanup:: called before your plugin is "unloaded", prior to a
132 plugin reload or bot quit - close any open
133 files/connections or flush caches here
140 # the plugin registry
141 attr_reader :registry
143 # the message map handler
146 # Initialise your bot module. Always call super if you override this method,
147 # as important variables are set up for you:
152 # the botmodule's registry, which can be used to store permanent data
153 # (see Registry::Accessor for additional documentation)
155 # Other instance variables which are defined and should not be overwritten
156 # byt the user, but aren't usually accessed directly, are:
159 # the plugins manager instance
160 # @botmodule_triggers::
161 # an Array of words this plugin #register()ed itself for
163 # the MessageMapper that handles this plugin's maps
166 @manager = Plugins::manager
169 @botmodule_triggers = Array.new
171 @handler = MessageMapper.new(self)
172 @registry = Registry::Accessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
174 @manager.add_botmodule(self)
175 if self.respond_to?('set_language')
176 self.set_language(@bot.lang.language)
180 # Returns the symbol :BotModule
185 # Method called to flush the registry, thus ensuring that the botmodule's permanent
186 # data is committed to disk
189 # debug "Flushing #{@registry}"
193 # Method called to cleanup before the plugin is unloaded. If you overload
194 # this method to handle additional cleanup tasks, remember to call super()
195 # so that the default cleanup actions are taken care of as well.
198 # debug "Closing #{@registry}"
202 # Handle an Irc::PrivMessage for which this BotModule has a map. The method
203 # is called automatically and there is usually no need to call it
210 # Signal to other BotModules that an even happened.
212 def call_event(ev, *args)
213 @bot.plugins.delegate('event_' + ev.to_s.gsub(/[^\w\?!]+/, '_'), *args)
216 # call-seq: map(template, options)
218 # This is the preferred way to register the BotModule so that it
219 # responds to appropriately-formed messages on Irc.
225 # call-seq: map!(template, options)
227 # This is the same as map but doesn't register the new command
228 # as an alternative name for the plugin.
234 # Auxiliary method called by #map and #map!
235 def do_map(silent, *args)
236 @handler.map(self, *args)
240 self.register name, :auth => nil, :hidden => silent
241 @manager.register_map(self, map)
242 unless self.respond_to?('privmsg')
243 def self.privmsg(m) #:nodoc:
249 # Sets the default auth for command path _cmd_ to _val_ on channel _chan_:
250 # usually _chan_ is either "*" for everywhere, public and private (in which
251 # case it can be omitted) or "?" for private communications
253 def default_auth(cmd, val, chan="*")
260 Auth::defaultbotuser.set_default_permission(propose_default_path(c), val)
263 # Gets the default command path which would be given to command _cmd_
264 def propose_default_path(cmd)
265 [name, cmd].compact.join("::")
268 # Return an identifier for this plugin, defaults to a list of the message
269 # prefixes handled (used for error messages etc)
271 self.class.to_s.downcase.sub(/^#<module:.*?>::/,"").sub(/(plugin|module)?$/,"")
284 # Return a help string for your module. For complex modules, you may wish
285 # to break your help into topics, and return a list of available topics if
286 # +topic+ is nil. +plugin+ is passed containing the matching prefix for
287 # this message - if your plugin handles multiple prefixes, make sure you
288 # return the correct help for the prefix requested
289 def help(plugin, topic)
293 # Register the plugin as a handler for messages prefixed _cmd_.
295 # This can be called multiple times for a plugin to handle multiple message
298 # This command is now superceded by the #map() command, which should be used
299 # instead whenever possible.
301 def register(cmd, opts={})
302 raise ArgumentError, "Second argument must be a hash!" unless opts.kind_of?(Hash)
303 who = @manager.who_handles?(cmd)
305 raise "Command #{cmd} is already handled by #{who.botmodule_class} #{who}" if who != self
308 if opts.has_key?(:auth)
309 @manager.register(self, cmd, opts[:auth])
311 @manager.register(self, cmd, propose_default_path(cmd))
313 @botmodule_triggers << cmd unless opts.fetch(:hidden, false)
316 # Default usage method provided as a utility for simple plugins. The
317 # MessageMapper uses 'usage' as its default fallback method.
319 def usage(m, params = {})
320 m.reply(_("incorrect usage, ask for help using '%{command}'") % {:command => "#{@bot.nick}: help #{m.plugin}"})
325 # A CoreBotModule is a BotModule that provides core functionality.
327 # This class should not be used by user plugins, as it's reserved for system
328 # plugins such as the ones that handle authentication, configuration and basic
331 class CoreBotModule < BotModule
337 # A Plugin is a BotModule that provides additional functionality.
339 # A user-defined plugin should subclass this, and then define any of the
340 # methods described in the documentation for BotModule to handle interaction
343 class Plugin < BotModule
349 # Singleton to manage multiple plugins and delegate messages to them for
351 class PluginManagerClass
354 attr_reader :botmodules
357 # This is the list of patterns commonly delegated to plugins.
358 # A fast delegation lookup is enabled for them.
359 DEFAULT_DELEGATE_PATTERNS = %r{^(?:
361 listen|ctcp_listen|privmsg|unreplied|
363 save|cleanup|flush_registry|
369 :CoreBotModule => [],
373 @names_hash = Hash.new
374 @commandmappers = Hash.new
376 @delegate_list = Hash.new { |h, k|
389 ret = self.to_s[0..-2]
390 ret << ' corebotmodules='
391 ret << @botmodules[:CoreBotModule].map { |m|
395 ret << @botmodules[:Plugin].map { |m|
401 # Reset lists of botmodules
402 def reset_botmodule_lists
403 @botmodules[:CoreBotModule].clear
404 @botmodules[:Plugin].clear
406 @commandmappers.clear
408 @failures_shown = false
411 # Associate with bot _bot_
412 def bot_associate(bot)
413 reset_botmodule_lists
417 # Returns the botmodule with the given _name_
419 @names_hash[name.to_sym]
422 # Returns +true+ if _cmd_ has already been registered as a command
423 def who_handles?(cmd)
424 return nil unless @commandmappers.has_key?(cmd.to_sym)
425 return @commandmappers[cmd.to_sym][:botmodule]
428 # Registers botmodule _botmodule_ with command _cmd_ and command path _auth_path_
429 def register(botmodule, cmd, auth_path)
430 raise TypeError, "First argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
431 @commandmappers[cmd.to_sym] = {:botmodule => botmodule, :auth => auth_path}
434 # Registers botmodule _botmodule_ with map _map_. This adds the map to the #maps hash
435 # which has three keys:
437 # botmodule:: the associated botmodule
438 # auth:: an array of auth keys checked by the map; the first is the full_auth_path of the map
439 # map:: the actual MessageTemplate object
442 def register_map(botmodule, map)
443 raise TypeError, "First argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
444 @maps[map.template] = { :botmodule => botmodule, :auth => [map.options[:full_auth_path]], :map => map }
447 def add_botmodule(botmodule)
448 raise TypeError, "Argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
449 kl = botmodule.botmodule_class
450 if @names_hash.has_key?(botmodule.to_sym)
451 case self[botmodule].botmodule_class
453 raise "#{kl} #{botmodule} already registered!"
455 raise "#{self[botmodule].botmodule_class} #{botmodule} already registered, cannot re-register as #{kl}"
458 @botmodules[kl] << botmodule
459 @names_hash[botmodule.to_sym] = botmodule
462 # Returns an array of the loaded plugins
464 @botmodules[:CoreBotModule]
467 # Returns an array of the loaded plugins
472 # Returns a hash of the registered message prefixes and associated
478 # Makes a string of error _err_ by adding text _str_
479 def report_error(str, err)
480 ([str, err.inspect] + err.backtrace).join("\n")
483 # This method is the one that actually loads a module from the
486 # _desc_ is a simple description of what we are loading (plugin/botmodule/whatever)
488 # It returns the Symbol :loaded on success, and an Exception
491 def load_botmodule_file(fname, desc=nil)
492 # create a new, anonymous module to "house" the plugin
493 # the idea here is to prevent namespace pollution. perhaps there
495 plugin_module = Module.new
497 desc = desc.to_s + " " if desc
500 plugin_string = IO.readlines(fname).join("")
501 debug "loading #{desc}#{fname}"
502 plugin_module.module_eval(plugin_string, fname)
504 rescue Exception => err
505 # rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
506 error report_error("#{desc}#{fname} load failed", err)
507 bt = err.backtrace.select { |line|
508 line.match(/^(\(eval\)|#{fname}):\d+/)
511 el.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
515 msg = err.to_str.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
518 newerr = err.class.new(msg)
519 newerr.set_backtrace(bt)
523 private :load_botmodule_file
525 # add one or more directories to the list of directories to
526 # load botmodules from
528 # TODO find a way to specify necessary plugins which _must_ be loaded
530 def add_botmodule_dir(*dirlist)
532 debug "Botmodule loading path: #{@dirs.join(', ')}"
535 def clear_botmodule_dirs
537 debug "Botmodule loading path cleared"
540 # load plugins from pre-assigned list of directories
548 @bot.config['plugins.blacklist'].each { |p|
550 processed[pn.intern] = :blacklisted
555 if(FileTest.directory?(dir))
559 next if(file =~ /^\./)
561 if processed.has_key?(file.intern)
562 @ignored << {:name => file, :dir => dir, :reason => processed[file.intern]}
566 if(file =~ /^(.+\.rb)\.disabled$/)
567 # GB: Do we want to do this? This means that a disabled plugin in a directory
568 # will disable in all subsequent directories. This was probably meant
569 # to be used before plugins.blacklist was implemented, so I think
570 # we don't need this anymore
571 processed[$1.intern] = :disabled
572 @ignored << {:name => $1, :dir => dir, :reason => processed[$1.intern]}
576 next unless(file =~ /\.rb$/)
578 did_it = load_botmodule_file("#{dir}/#{file}", "plugin")
581 processed[file.intern] = did_it
583 @failed << { :name => file, :dir => dir, :reason => did_it }
589 debug "finished loading plugins: #{status(true)}"
590 (core_modules + plugins).each { |p|
591 p.methods.grep(DEFAULT_DELEGATE_PATTERNS).each { |m|
592 @delegate_list[m.intern] << p
597 # call the save method for each active plugin
599 delegate 'flush_registry'
603 # call the cleanup method for each active plugin
606 reset_botmodule_lists
609 # drop all plugins and rescan plugins on disk
610 # calls save and cleanup for each plugin before dropping them
617 def status(short=false)
619 if self.core_length > 0
621 output << n_("%{count} core module loaded", "%{count} core modules loaded",
622 self.core_length) % {:count => self.core_length}
624 output << n_("%{count} core module: %{list}",
625 "%{count} core modules: %{list}", self.core_length) %
626 { :count => self.core_length,
627 :list => core_modules.collect{ |p| p.name}.sort.join(", ") }
630 output << _("no core botmodules loaded")
632 # Active plugins first
635 output << n_("%{count} plugin loaded", "%{count} plugins loaded",
636 self.length) % {:count => self.length}
638 output << n_("%{count} plugin: %{list}",
639 "%{count} plugins: %{list}", self.length) %
640 { :count => self.length,
641 :list => plugins.collect{ |p| p.name}.sort.join(", ") }
644 output << "no plugins active"
646 # Ignored plugins next
647 unless @ignored.empty? or @failures_shown
649 output << n_("%{highlight}%{count} plugin ignored%{highlight}",
650 "%{highlight}%{count} plugins ignored%{highlight}",
652 { :count => @ignored.length, :highlight => Underline }
654 output << n_("%{highlight}%{count} plugin ignored%{highlight}: use %{bold}%{command}%{bold} to see why",
655 "%{highlight}%{count} plugins ignored%{highlight}: use %{bold}%{command}%{bold} to see why",
657 { :count => @ignored.length, :highlight => Underline,
658 :bold => Bold, :command => "help ignored plugins"}
661 # Failed plugins next
662 unless @failed.empty? or @failures_shown
664 output << n_("%{highlight}%{count} plugin failed to load%{highlight}",
665 "%{highlight}%{count} plugins failed to load%{highlight}",
667 { :count => @failed.length, :highlight => Reverse }
669 output << n_("%{highlight}%{count} plugin failed to load%{highlight}: use %{bold}%{command}%{bold} to see why",
670 "%{highlight}%{count} plugins failed to load%{highlight}: use %{bold}%{command}%{bold} to see why",
672 { :count => @failed.length, :highlight => Reverse,
673 :bold => Bold, :command => "help failed plugins"}
679 # return list of help topics (plugin names)
682 @failures_shown = true
694 # return help for +topic+ (call associated plugin's help method)
697 when /fail(?:ed)?\s*plugins?.*(trace(?:back)?s?)?/
698 # debug "Failures: #{@failed.inspect}"
699 return _("no plugins failed to load") if @failed.empty?
700 return @failed.collect { |p|
701 _('%{highlight}%{plugin}%{highlight} in %{dir} failed with error %{exception}: %{reason}') % {
702 :highlight => Bold, :plugin => p[:name], :dir => p[:dir],
703 :exception => p[:reason].class, :reason => p[:reason],
704 } + if $1 && !p[:reason].backtrace.empty?
705 _('at %{backtrace}') % {:backtrace => p[:reason].backtrace.join(', ')}
710 when /ignored?\s*plugins?/
711 return _('no plugins were ignored') if @ignored.empty?
715 reason = p[:loaded] ? _('overruled by previous') : _(p[:reason].to_s)
716 ((tmp[p[:dir]] ||= Hash.new)[reason] ||= Array.new).push(p[:name])
719 return tmp.map do |dir, reasons|
720 # FIXME get rid of these string concatenations to make gettext easier
721 s = reasons.map { |r, list|
722 list.map { |_| _.sub(/\.rb$/, '') }.join(', ') + " (#{r})"
726 when /^(\S+)\s*(.*)$/
730 # Let's see if we can match a plugin by the given name
731 (core_modules + plugins).each { |p|
732 next unless p.name == key
734 return p.help(key, params)
735 rescue Exception => err
736 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
737 error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
741 # Nope, let's see if it's a command, and ask for help at the corresponding botmodule
743 if commands.has_key?(k)
744 p = commands[k][:botmodule]
746 return p.help(key, params)
747 rescue Exception => err
748 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
749 error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
756 # see if each plugin handles +method+, and if so, call it, passing
757 # +message+ as a parameter
758 def delegate(method, *args)
759 # debug "Delegating #{method.inspect}"
761 if method.match(DEFAULT_DELEGATE_PATTERNS)
762 debug "fast-delegating #{method}"
764 debug "no-one to delegate to" unless @delegate_list.has_key?(m)
765 return [] unless @delegate_list.has_key?(m)
766 @delegate_list[m].each { |p|
768 ret.push p.send(method, *args)
769 rescue Exception => err
770 raise if err.kind_of?(SystemExit)
771 error report_error("#{p.botmodule_class} #{p.name} #{method}() failed:", err)
772 raise if err.kind_of?(BDB::Fatal)
776 debug "slow-delegating #{method}"
777 (core_modules + plugins).each { |p|
778 if(p.respond_to? method)
780 # debug "#{p.botmodule_class} #{p.name} responds"
781 ret.push p.send(method, *args)
782 rescue Exception => err
783 raise if err.kind_of?(SystemExit)
784 error report_error("#{p.botmodule_class} #{p.name} #{method}() failed:", err)
785 raise if err.kind_of?(BDB::Fatal)
791 # debug "Finished delegating #{method.inspect}"
794 # see if we have a plugin that wants to handle this message, if so, pass
795 # it to the plugin and return true, otherwise false
797 # debug "Delegating privmsg #{m.message.inspect} from #{m.source} to #{m.replyto} with pluginkey #{m.plugin.inspect}"
798 return unless m.plugin
800 if commands.has_key?(k)
801 p = commands[k][:botmodule]
802 a = commands[k][:auth]
803 # We check here for things that don't check themselves
804 # (e.g. mapped things)
805 # debug "Checking auth ..."
806 if a.nil? || @bot.auth.allow?(a, m.source, m.replyto)
807 # debug "Checking response ..."
808 if p.respond_to?("privmsg")
810 # debug "#{p.botmodule_class} #{p.name} responds"
812 rescue Exception => err
813 raise if err.kind_of?(SystemExit)
814 error report_error("#{p.botmodule_class} #{p.name} privmsg() failed:", err)
815 raise if err.kind_of?(BDB::Fatal)
817 # debug "Successfully delegated #{m.message}"
820 # debug "#{p.botmodule_class} #{p.name} is registered, but it doesn't respond to privmsg()"
823 # debug "#{p.botmodule_class} #{p.name} is registered, but #{m.source} isn't allowed to call #{m.plugin.inspect} on #{m.replyto}"
826 # debug "Finished delegating privmsg with key #{m.plugin.inspect}" + ( pl.empty? ? "" : " to #{pl.values.first[:botmodule].botmodule_class}s" )
828 # debug "Finished delegating privmsg with key #{m.plugin.inspect}"
831 # delegate IRC messages, by delegating 'listen' first, and the actual method
832 # afterwards. Delegating 'privmsg' also delegates ctcp_listen and message
834 def irc_delegate(method, m)
835 delegate('listen', m)
836 if method.to_sym == :privmsg
837 delegate('ctcp_listen', m) if m.ctcp
838 delegate('message', m)
839 privmsg(m) if m.address?
840 delegate('unreplied', m) unless m.replied
847 # Returns the only PluginManagerClass instance
849 return PluginManagerClass.instance