]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/plugins.rb
Fix stupid bug introduced with the new debugging messages. switch to kind_of? instead...
[user/henk/code/ruby/rbot.git] / lib / rbot / plugins.rb
index 8d9dcfc9f9736ca5ba25243b4eb1997b9571f5ad..42ff2aaa959382c6992b25b9bba7f8f3670d38a8 100644 (file)
+require 'singleton'
+
 module Irc
+    BotConfig.register BotConfigArrayValue.new('plugins.blacklist',
+      :default => [], :wizard => false, :requires_rescan => true,
+      :desc => "Plugins that should not be loaded")
+module Plugins
   require 'rbot/messagemapper'
 
-  # base class for all rbot plugins
-  # certain methods will be called if they are provided, if you define one of
-  # the following methods, it will be called as appropriate:
-  #
-  # map(template, options)::
-  #    map is the new, cleaner way to respond to specific message formats
-  #    without littering your plugin code with regexps
-  #    examples:
-  #      plugin.map 'karmastats', :action => 'karma_stats'
-  #
-  #      # while in the plugin...
-  #      def karma_stats(m, params)
-  #        m.reply "..."
-  #      end
-  #      
-  #      # the default action is the first component
-  #      plugin.map 'karma'
-  #
-  #      # attributes can be pulled out of the match string
-  #      plugin.map 'karma for :key'
-  #      plugin.map 'karma :key'
-  #
-  #      # while in the plugin...
-  #      def karma(m, params)
-  #        item = params[:key]
-  #        m.reply 'karma for #{item}'
-  #      end
-  #      
-  #      # you can setup defaults, to make parameters optional
-  #      plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
-  #      
-  #      # the default auth check is also against the first component
-  #      # but that can be changed
-  #      plugin.map 'karmastats', :auth => 'karma'
-  #
-  #      # maps can be restricted to public or private message:
-  #      plugin.map 'karmastats', :private false,
-  #      plugin.map 'karmastats', :public false,
-  #    end
-  #
-  #    To activate your maps, you simply register them
-  #    plugin.register_maps
-  #    This also sets the privmsg handler to use the map lookups for
-  #    handling messages. You can still use listen(), kick() etc methods
-  # 
-  # listen(UserMessage)::
-  #                        Called for all messages of any type. To
-  #                        differentiate them, use message.kind_of? It'll be
-  #                        either a PrivMessage, NoticeMessage, KickMessage,
-  #                        QuitMessage, PartMessage, JoinMessage, NickMessage,
-  #                        etc.
-  #                              
-  # privmsg(PrivMessage)::
-  #                        called for a PRIVMSG if the first word matches one
-  #                        the plugin register()d for. Use m.plugin to get
-  #                        that word and m.params for the rest of the message,
-  #                        if applicable.
-  #
-  # kick(KickMessage)::
-  #                        Called when a user (or the bot) is kicked from a
-  #                        channel the bot is in.
-  #
-  # join(JoinMessage)::
-  #                        Called when a user (or the bot) joins a channel
-  #
-  # part(PartMessage)::
-  #                        Called when a user (or the bot) parts a channel
-  #
-  # quit(QuitMessage)::    
-  #                        Called when a user (or the bot) quits IRC
-  #
-  # nick(NickMessage)::
-  #                        Called when a user (or the bot) changes Nick
-  # topic(TopicMessage)::
-  #                        Called when a user (or the bot) changes a channel
-  #                        topic
-  # 
-  # save::                 Called when you are required to save your plugin's
-  #                        state, if you maintain data between sessions
-  #
-  # cleanup::              called before your plugin is "unloaded", prior to a
-  #                        plugin reload or bot quit - close any open
-  #                        files/connections or flush caches here
-  class Plugin
+=begin
+  base class for all rbot plugins
+  certain methods will be called if they are provided, if you define one of
+  the following methods, it will be called as appropriate:
+
+  map(template, options)::
+  map!(template, options)::
+     map is the new, cleaner way to respond to specific message formats
+     without littering your plugin code with regexps. The difference
+     between map and map! is that map! will not register the new command
+     as an alternative name for the plugin.
+
+     Examples:
+
+       plugin.map 'karmastats', :action => 'karma_stats'
+
+       # while in the plugin...
+       def karma_stats(m, params)
+         m.reply "..."
+       end
+
+       # the default action is the first component
+       plugin.map 'karma'
+
+       # attributes can be pulled out of the match string
+       plugin.map 'karma for :key'
+       plugin.map 'karma :key'
+
+       # while in the plugin...
+       def karma(m, params)
+         item = params[:key]
+         m.reply 'karma for #{item}'
+       end
+
+       # you can setup defaults, to make parameters optional
+       plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
+
+       # the default auth check is also against the first component
+       # but that can be changed
+       plugin.map 'karmastats', :auth => 'karma'
+
+       # maps can be restricted to public or private message:
+       plugin.map 'karmastats', :private false,
+       plugin.map 'karmastats', :public false,
+     end
+
+  listen(UserMessage)::
+                         Called for all messages of any type. To
+                         differentiate them, use message.kind_of? It'll be
+                         either a PrivMessage, NoticeMessage, KickMessage,
+                         QuitMessage, PartMessage, JoinMessage, NickMessage,
+                         etc.
+
+  privmsg(PrivMessage)::
+                         called for a PRIVMSG if the first word matches one
+                         the plugin register()d for. Use m.plugin to get
+                         that word and m.params for the rest of the message,
+                         if applicable.
+
+  kick(KickMessage)::
+                         Called when a user (or the bot) is kicked from a
+                         channel the bot is in.
+
+  join(JoinMessage)::
+                         Called when a user (or the bot) joins a channel
+
+  part(PartMessage)::
+                         Called when a user (or the bot) parts a channel
+
+  quit(QuitMessage)::
+                         Called when a user (or the bot) quits IRC
+
+  nick(NickMessage)::
+                         Called when a user (or the bot) changes Nick
+  topic(TopicMessage)::
+                         Called when a user (or the bot) changes a channel
+                         topic
+
+  connect()::            Called when a server is joined successfully, but
+                         before autojoin channels are joined (no params)
+
+  save::                 Called when you are required to save your plugin's
+                         state, if you maintain data between sessions
+
+  cleanup::              called before your plugin is "unloaded", prior to a
+                         plugin reload or bot quit - close any open
+                         files/connections or flush caches here
+=end
+
+  class BotModule
     attr_reader :bot   # the associated bot
-    # initialise your plugin. Always call super if you override this method,
+    attr_reader :botmodule_class # the botmodule class (:coremodule or :plugin)
+
+    # initialise your bot module. Always call super if you override this method,
     # as important variables are set up for you
-    def initialize
-      @bot = Plugins.bot
-      @names = Array.new
+    def initialize(kl)
+      @manager = Plugins::pluginmanager
+      @bot = @manager.bot
+
+      @botmodule_class = kl.to_sym
+      @botmodule_triggers = Array.new
+
       @handler = MessageMapper.new(self)
       @registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
+
+      @manager.add_botmodule(self)
+    end
+
+    def flush_registry
+      # debug "Flushing #{@registry}"
+      @registry.flush
+    end
+
+    def cleanup
+      # debug "Closing #{@registry}"
+      @registry.close
+    end
+
+    def handle(m)
+      @handler.handle(m)
     end
 
     def map(*args)
-      @handler.map(*args)
+      @handler.map(self, *args)
+      # register this map
+      name = @handler.last.items[0]
+      self.register name, :auth => nil
+      unless self.respond_to?('privmsg')
+        def self.privmsg(m)
+          handle(m)
+        end
+      end
+    end
+
+    def map!(*args)
+      @handler.map(self, *args)
       # register this map
       name = @handler.last.items[0]
-      self.register name
+      self.register name, :auth => nil, :hidden => true
       unless self.respond_to?('privmsg')
         def self.privmsg(m)
-          @handler.handle(m)
+          handle(m)
         end
       end
     end
 
+    # Sets the default auth for command path _cmd_ to _val_ on channel _chan_:
+    # usually _chan_ is either "*" for everywhere, public and private (in which
+    # case it can be omitted) or "?" for private communications
+    #
+    def default_auth(cmd, val, chan="*")
+      case cmd
+      when "*", ""
+        c = nil
+      else
+        c = cmd
+      end
+      Auth::defaultbotuser.set_default_permission(propose_default_path(c), val)
+    end
+
+    # Gets the default command path which would be given to command _cmd_
+    def propose_default_path(cmd)
+      [name, cmd].compact.join("::")
+    end
+
     # return an identifier for this plugin, defaults to a list of the message
     # prefixes handled (used for error messages etc)
     def name
-      @names.join("|")
+      self.class.to_s.downcase.sub(/^#<module:.*?>::/,"").sub(/(plugin|module)?$/,"")
     end
-    
+
+    # just calls name
+    def to_s
+      name
+    end
+
     # return a help string for your module. for complex modules, you may wish
     # to break your help into topics, and return a list of available topics if
     # +topic+ is nil. +plugin+ is passed containing the matching prefix for
-    # this message - if your plugin handles multiple prefixes, make sure your
+    # this message - if your plugin handles multiple prefixes, make sure you
     # return the correct help for the prefix requested
     def help(plugin, topic)
       "no help"
     end
-    
+
     # register the plugin as a handler for messages prefixed +name+
     # this can be called multiple times for a plugin to handle multiple
     # message prefixes
-    def register(name)
-      return if Plugins.plugins.has_key?(name)
-      Plugins.plugins[name] = self
-      @names << name
+    def register(cmd, opts={})
+      raise ArgumentError, "Second argument must be a hash!" unless opts.kind_of?(Hash)
+      return if @manager.knows?(cmd, @botmodule_class)
+      if opts.has_key?(:auth)
+        @manager.register(self, cmd, opts[:auth])
+      else
+        @manager.register(self, cmd, propose_default_path(cmd))
+      end
+      @botmodule_triggers << cmd unless opts.fetch(:hidden, false)
     end
 
     # default usage method provided as a utility for simple plugins. The
     # MessageMapper uses 'usage' as its default fallback method.
-    def usage(m, params)
+    def usage(m, params = {})
       m.reply "incorrect usage, ask for help using '#{@bot.nick}: help #{m.plugin}'"
     end
 
   end
 
-  # class to manage multiple plugins and delegate messages to them for
+  class CoreBotModule < BotModule
+    def initialize
+      super(:coremodule)
+    end
+  end
+
+  class Plugin < BotModule
+    def initialize
+      super(:plugin)
+    end
+  end
+
+  # Singleton to manage multiple plugins and delegate messages to them for
   # handling
-  class Plugins
-    # hash of registered message prefixes and associated plugins
-    @@plugins = Hash.new
-    # associated IrcBot class
-    @@bot = nil
-
-    # bot::     associated IrcBot class
-    # dirlist:: array of directories to scan (in order) for plugins
-    #
-    # create a new plugin handler, scanning for plugins in +dirlist+
-    def initialize(bot, dirlist)
-      @@bot = bot
-      @dirs = dirlist
-      scan
+  class PluginManagerClass
+    include Singleton
+    attr_reader :bot
+    attr_reader :botmodules
+
+    def initialize
+      bot_associate(nil)
+
+      @dirs = []
     end
-    
-    # access to associated bot
-    def Plugins.bot
-      @@bot
+
+    # Reset lists of botmodules
+    def reset_botmodule_lists
+      @botmodules = {
+        :coremodule => [],
+        :plugin => []
+      }
+
+      @commandmappers = {
+        :coremodule => {},
+        :plugin => {}
+      }
+
     end
 
-    # access to list of plugins
-    def Plugins.plugins
-      @@plugins
+    # Associate with bot _bot_
+    def bot_associate(bot)
+      reset_botmodule_lists
+      @bot = bot
+    end
+
+    # Returns +true+ if _name_ is a known botmodule of class kl
+    def knows?(name, kl)
+      return @commandmappers[kl.to_sym].has_key?(name.to_sym)
+    end
+
+    # Registers botmodule _botmodule_ with command _cmd_ and command path _auth_path_
+    def register(botmodule, cmd, auth_path)
+      raise TypeError, "First argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
+      kl = botmodule.botmodule_class
+      @commandmappers[kl.to_sym][cmd.to_sym] = {:botmodule => botmodule, :auth => auth_path}
+      h = @commandmappers[kl.to_sym][cmd.to_sym]
+      # debug "Registered command mapper for #{cmd.to_sym} (#{kl.to_sym}): #{h[:botmodule].name} with command path #{h[:auth]}"
+    end
+
+    def add_botmodule(botmodule)
+      raise TypeError, "Argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
+      kl = botmodule.botmodule_class
+      raise "#{kl.to_s} #{botmodule.name} already registered!" if @botmodules[kl.to_sym].include?(botmodule)
+      @botmodules[kl.to_sym] << botmodule
+    end
+
+    # Returns an array of the loaded plugins
+    def core_modules
+      @botmodules[:coremodule]
+    end
+
+    # Returns an array of the loaded plugins
+    def plugins
+      @botmodules[:plugin]
+    end
+
+    # Returns a hash of the registered message prefixes and associated
+    # plugins
+    def plugin_commands
+      @commandmappers[:plugin]
+    end
+
+    # Returns a hash of the registered message prefixes and associated
+    # core modules
+    def core_commands
+      @commandmappers[:coremodule]
+    end
+
+    # Makes a string of error _err_ by adding text _str_
+    def report_error(str, err)
+      ([str, err.inspect] + err.backtrace).join("\n")
+    end
+
+    # This method is the one that actually loads a module from the
+    # file _fname_
+    #
+    # _desc_ is a simple description of what we are loading (plugin/botmodule/whatever)
+    #
+    # It returns the Symbol :loaded on success, and an Exception
+    # on failure
+    #
+    def load_botmodule_file(fname, desc=nil)
+      # create a new, anonymous module to "house" the plugin
+      # the idea here is to prevent namespace pollution. perhaps there
+      # is another way?
+      plugin_module = Module.new
+
+      desc = desc.to_s + " " if desc
+
+      begin
+        plugin_string = IO.readlines(fname).join("")
+        debug "loading #{desc}#{fname}"
+        plugin_module.module_eval(plugin_string, fname)
+        return :loaded
+      rescue Exception => err
+        # rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
+        warning report_error("#{desc}#{fname} load failed", err)
+        bt = err.backtrace.select { |line|
+          line.match(/^(\(eval\)|#{fname}):\d+/)
+        }
+        bt.map! { |el|
+          el.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
+            "#{fname}#{$1}#{$3}"
+          }
+        }
+        msg = err.to_str.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
+          "#{fname}#{$1}#{$3}"
+        }
+        newerr = err.class.new(msg)
+        newerr.set_backtrace(bt)
+        return newerr
+      end
+    end
+    private :load_botmodule_file
+
+    # add one or more directories to the list of directories to
+    # load botmodules from
+    #
+    # TODO find a way to specify necessary plugins which _must_ be loaded
+    #
+    def add_botmodule_dir(*dirlist)
+      @dirs += dirlist
+      debug "Botmodule loading path: #{@dirs.join(', ')}"
     end
 
     # load plugins from pre-assigned list of directories
     def scan
-      dirs = Array.new
-      dirs << Config::DATADIR + "/plugins"
-      dirs += @dirs
+      @failed = Array.new
+      @ignored = Array.new
+      processed = Hash.new
+
+      @bot.config['plugins.blacklist'].each { |p|
+        pn = p + ".rb"
+        processed[pn.intern] = :blacklisted
+      }
+
+      dirs = @dirs
       dirs.each {|dir|
         if(FileTest.directory?(dir))
           d = Dir.new(dir)
-          d.each {|file|
+          d.sort.each {|file|
+
             next if(file =~ /^\./)
+
+            if processed.has_key?(file.intern)
+              @ignored << {:name => file, :dir => dir, :reason => processed[file.intern]}
+              next
+            end
+
+            if(file =~ /^(.+\.rb)\.disabled$/)
+              # GB: Do we want to do this? This means that a disabled plugin in a directory
+              #     will disable in all subsequent directories. This was probably meant
+              #     to be used before plugins.blacklist was implemented, so I think
+              #     we don't need this anymore
+              processed[$1.intern] = :disabled
+              @ignored << {:name => $1, :dir => dir, :reason => processed[$1.intern]}
+              next
+            end
+
             next unless(file =~ /\.rb$/)
-            @tmpfilename = "#{dir}/#{file}"
 
-            # create a new, anonymous module to "house" the plugin
-            plugin_module = Module.new
-            
-            begin
-              plugin_string = IO.readlines(@tmpfilename).join("")
-              debug "loading module: #{@tmpfilename}"
-              plugin_module.module_eval(plugin_string)
-            rescue StandardError, NameError, LoadError, SyntaxError => err
-              puts "warning: plugin #{@tmpfilename} load failed: " + err
-              puts err.backtrace.join("\n")
+            did_it = load_botmodule_file("#{dir}/#{file}", "plugin")
+            case did_it
+            when Symbol
+              processed[file.intern] = did_it
+            when Exception
+              @failed <<  { :name => file, :dir => dir, :reason => did_it }
             end
+
           }
         end
       }
+      debug "finished loading plugins: #{status(true)}"
     end
 
     # call the save method for each active plugin
     def save
-      @@plugins.values.uniq.each {|p|
-        next unless(p.respond_to?("save"))
-        begin
-          p.save
-        rescue StandardError, NameError, SyntaxError => err
-          puts "plugin #{p.name} save() failed: " + err
-          puts err.backtrace.join("\n")
-        end
-      }
+      delegate 'flush_registry'
+      delegate 'save'
     end
 
     # call the cleanup method for each active plugin
     def cleanup
-      @@plugins.values.uniq.each {|p|
-        next unless(p.respond_to?("cleanup"))
-        begin
-          p.cleanup
-        rescue StandardError, NameError, SyntaxError => err
-          puts "plugin #{p.name} cleanup() failed: " + err
-          puts err.backtrace.join("\n")
-        end
-      }
+      @bot.save_mutex.synchronize do
+        delegate 'cleanup'
+      end
+      reset_botmodule_lists
     end
 
     # drop all plugins and rescan plugins on disk
@@ -227,74 +428,183 @@ module Irc
     def rescan
       save
       cleanup
-      @@plugins = Hash.new
       scan
     end
 
-    # return list of help topics (plugin names)
-    def helptopics
-      if(@@plugins.length > 0)
-        # return " [plugins: " + @@plugins.keys.sort.join(", ") + "]"
-        return " [#{length} plugins: " + @@plugins.values.uniq.collect{|p| p.name}.sort.join(", ") + "]"
+    def status(short=false)
+      list = ""
+      if self.core_length > 0
+        list << "#{self.core_length} core module#{'s' if core_length > 1}"
+        if short
+          list << " loaded"
+        else
+          list << ": " + core_modules.collect{ |p| p.name}.sort.join(", ")
+        end
       else
-        return " [no plugins active]" 
+        list << "no core botmodules loaded"
+      end
+      # Active plugins first
+      if(self.length > 0)
+        list << "; #{self.length} plugin#{'s' if length > 1}"
+        if short
+          list << " loaded"
+        else
+          list << ": " + plugins.collect{ |p| p.name}.sort.join(", ")
+        end
+      else
+        list << "no plugins active"
+      end
+      # Ignored plugins next
+      unless @ignored.empty?
+        list << "; #{Underline}#{@ignored.length} plugin#{'s' if @ignored.length > 1} ignored#{Underline}"
+        list << ": use #{Bold}help ignored plugins#{Bold} to see why" unless short
       end
+      # Failed plugins next
+      unless @failed.empty?
+        list << "; #{Reverse}#{@failed.length} plugin#{'s' if @failed.length > 1} failed to load#{Reverse}"
+        list << ": use #{Bold}help failed plugins#{Bold} to see why" unless short
+      end
+      list
+    end
+
+    # return list of help topics (plugin names)
+    def helptopics
+      return status
     end
 
     def length
-      @@plugins.values.uniq.length
+      plugins.length
+    end
+
+    def core_length
+      core_modules.length
     end
 
     # return help for +topic+ (call associated plugin's help method)
     def help(topic="")
-      if(topic =~ /^(\S+)\s*(.*)$/)
+      case topic
+      when /fail(?:ed)?\s*plugins?.*(trace(?:back)?s?)?/
+        # debug "Failures: #{@failed.inspect}"
+        return "no plugins failed to load" if @failed.empty?
+        return @failed.inject(Array.new) { |list, p|
+          list << "#{Bold}#{p[:name]}#{Bold} in #{p[:dir]} failed"
+          list << "with error #{p[:reason].class}: #{p[:reason]}"
+          list << "at #{p[:reason].backtrace.join(', ')}" if $1 and not p[:reason].backtrace.empty?
+          list
+        }.join("\n")
+      when /ignored?\s*plugins?/
+        return "no plugins were ignored" if @ignored.empty?
+        return @ignored.inject(Array.new) { |list, p|
+          case p[:reason]
+          when :loaded
+            list << "#{p[:name]} in #{p[:dir]} (overruled by previous)"
+          else
+            list << "#{p[:name]} in #{p[:dir]} (#{p[:reason].to_s})"
+          end
+          list
+        }.join(", ")
+      when /^(\S+)\s*(.*)$/
         key = $1
         params = $2
-        if(@@plugins.has_key?(key))
+        (core_modules + plugins).each { |p|
+          # debug "checking #{p.name.inspect} against #{key.inspect}"
           begin
-            return @@plugins[key].help(key, params)
-          rescue StandardError, NameError, SyntaxError => err
-            puts "plugin #{@@plugins[key].name} help() failed: " + err
-            puts err.backtrace.join("\n")
+            return p.help(params)
+          rescue Exception => err
+            #rescue TimeoutError, StandardError, NameError, SyntaxError => err
+            error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
+          end if p.name == key
+        }
+        [core_commands, plugin_commands].each { |pl|
+          # debug "looking for #{key.inspect} in #{pl.keys.sort.inspect}"
+          if pl.has_key?(key)
+            p = pl[key][:botmodule] 
+            begin
+              return p.help(key, params)
+            rescue Exception => err
+              #rescue TimeoutError, StandardError, NameError, SyntaxError => err
+              error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
+            end
           end
-        else
-          return false
-        end
+        }
       end
+      return false
     end
-    
+
     # see if each plugin handles +method+, and if so, call it, passing
     # +message+ as a parameter
-    def delegate(method, message)
-      @@plugins.values.uniq.each {|p|
-        if(p.respond_to? method)
-          begin
-            p.send method, message
-          rescue StandardError, NameError, SyntaxError => err
-            puts "plugin #{p.name} #{method}() failed: " + err
-            puts err.backtrace.join("\n")
+    def delegate(method, *args)
+      # debug "Delegating #{method.inspect}"
+      [core_modules, plugins].each { |pl|
+        pl.each {|p|
+          if(p.respond_to? method)
+            begin
+              # debug "#{p.botmodule_class} #{p.name} responds"
+              p.send method, *args
+            rescue Exception => err
+              raise if err.kind_of?(SystemExit)
+              error report_error("#{p.botmodule_class} #{p.name} #{method}() failed:", err)
+              raise if err.kind_of?(BDB::Fatal)
+            end
           end
-        end
+        }
       }
+      # debug "Finished delegating #{method.inspect}"
     end
 
     # see if we have a plugin that wants to handle this message, if so, pass
     # it to the plugin and return true, otherwise false
     def privmsg(m)
-      return unless(m.plugin)
-      if (@@plugins.has_key?(m.plugin) &&
-          @@plugins[m.plugin].respond_to?("privmsg") &&
-          @@bot.auth.allow?(m.plugin, m.source, m.replyto))
-        begin
-          @@plugins[m.plugin].privmsg(m)
-        rescue StandardError, NameError, SyntaxError => err
-          puts "plugin #{@@plugins[m.plugin].name} privmsg() failed: " + err
-          puts err.backtrace.join("\n")
+      # debug "Delegating privmsg #{m.message.inspect} from #{m.source} to #{m.replyto} with pluginkey #{m.plugin.inspect}"
+      return unless m.plugin
+      [core_commands, plugin_commands].each { |pl|
+        # We do it this way to skip creating spurious keys
+        # FIXME use fetch?
+        k = m.plugin.to_sym
+        if pl.has_key?(k)
+          p = pl[k][:botmodule]
+          a = pl[k][:auth]
+        else
+          p = nil
+          a = nil
         end
-        return true
-      end
+        if p
+          # We check here for things that don't check themselves
+          # (e.g. mapped things)
+          # debug "Checking auth ..."
+          if a.nil? || @bot.auth.allow?(a, m.source, m.replyto)
+            # debug "Checking response ..."
+            if p.respond_to?("privmsg")
+              begin
+                # debug "#{p.botmodule_class} #{p.name} responds"
+                p.privmsg(m)
+              rescue Exception => err
+                raise if err.kind_of?(SystemExit)
+                error report_error("#{p.botmodule_class} #{p.name} privmsg() failed:", err)
+                raise if err.kind_of?(BDB::Fatal)
+              end
+              # debug "Successfully delegated #{m.message}"
+              return true
+            else
+              # debug "#{p.botmodule_class} #{p.name} is registered, but it doesn't respond to privmsg()"
+            end
+          else
+            # debug "#{p.botmodule_class} #{p.name} is registered, but #{m.source} isn't allowed to call #{m.plugin.inspect} on #{m.replyto}"
+          end
+        else
+          # debug "No #{pl.values.first[:botmodule].botmodule_class} registered #{m.plugin.inspect}" unless pl.empty?
+        end
+        # debug "Finished delegating privmsg with key #{m.plugin.inspect}" + ( pl.empty? ? "" : " to #{pl.values.first[:botmodule].botmodule_class}s" )
+      }
       return false
+      # debug "Finished delegating privmsg with key #{m.plugin.inspect}"
     end
   end
 
+  # Returns the only PluginManagerClass instance
+  def Plugins.pluginmanager
+    return PluginManagerClass.instance
+  end
+
+end
 end