rbot 0.9.9

data/lib/rbot/plugins.rb

@@ -0,0 +1,291 @@
+module Irc
+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
+  #
+  # 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
+  class Plugin
+    attr_reader :bot   # the associated bot
+    # initialise your plugin. Always call super if you override this method,
+    # as important variables are set up for you
+    def initialize
+      @bot = Plugins.bot
+      @names = Array.new
+      @handler = MessageMapper.new(self)
+      @registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
+    end
+
+    def map(*args)
+      @handler.map(*args)
+      # register this map
+      name = @handler.last.items[0]
+      self.register name
+      unless self.respond_to?('privmsg')
+        def self.privmsg(m)
+          @handler.handle(m)
+        end
+      end
+    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("|")
+    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
+    # 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
+    end
+
+    # default usage method provided as a utility for simple plugins. The
+    # MessageMapper uses 'usage' as its default fallback method.
+    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
+  # 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
+    end
+    
+    # access to associated bot
+    def Plugins.bot
+      @@bot
+    end
+
+    # access to list of plugins
+    def Plugins.plugins
+      @@plugins
+    end
+
+    # load plugins from pre-assigned list of directories
+    def scan
+      dirs = Array.new
+      dirs << Config::datadir + "/plugins"
+      dirs += @dirs
+      dirs.each {|dir|
+        if(FileTest.directory?(dir))
+          d = Dir.new(dir)
+          d.sort.each {|file|
+            next if(file =~ /^\./)
+            next unless(file =~ /\.rb$/)
+            tmpfilename = "#{dir}/#{file}"
+
+            # 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
+            
+            begin
+              plugin_string = IO.readlines(tmpfilename).join("")
+              debug "loading plugin #{tmpfilename}"
+              plugin_module.module_eval(plugin_string)
+            rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
+              puts "warning: plugin #{tmpfilename} load failed: " + err
+              puts err.backtrace.join("\n")
+            end
+          }
+        end
+      }
+    end
+
+    # call the save method for each active plugin
+    def save
+      delegate 'save'
+    end
+
+    # call the cleanup method for each active plugin
+    def cleanup
+      delegate 'cleanup'
+    end
+
+    # drop all plugins and rescan plugins on disk
+    # calls save and cleanup for each plugin before dropping them
+    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(", ") + "]"
+      else
+        return " [no plugins active]" 
+      end
+    end
+
+    def length
+      @@plugins.values.uniq.length
+    end
+
+    # return help for +topic+ (call associated plugin's help method)
+    def help(topic="")
+      if(topic =~ /^(\S+)\s*(.*)$/)
+        key = $1
+        params = $2
+        if(@@plugins.has_key?(key))
+          begin
+            return @@plugins[key].help(key, params)
+          rescue TimeoutError, StandardError, NameError, SyntaxError => err
+            puts "plugin #{@@plugins[key].name} help() failed: " + err
+            puts err.backtrace.join("\n")
+          end
+        else
+          return false
+        end
+      end
+    end
+    
+    # see if each plugin handles +method+, and if so, call it, passing
+    # +message+ as a parameter
+    def delegate(method, *args)
+      @@plugins.values.uniq.each {|p|
+        if(p.respond_to? method)
+          begin
+            p.send method, *args
+          rescue TimeoutError, StandardError, NameError, SyntaxError => err
+            puts "plugin #{p.name} #{method}() failed: " + err
+            puts err.backtrace.join("\n")
+          end
+        end
+      }
+    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 TimeoutError, StandardError, NameError, SyntaxError => err
+          puts "plugin #{@@plugins[m.plugin].name} privmsg() failed: " + err
+          puts err.backtrace.join("\n")
+        end
+        return true
+      end
+      return false
+    end
+  end
+
+end
+end

data/lib/rbot/post-install.rb

@@ -0,0 +1,8 @@
+# write out our datadir so we can reference it at runtime
+File.open("#{config('rbdir')}/rbot/pkgconfig.rb", "w") {|f|
+  f.puts "module Irc"
+  f.puts "  module PKGConfig"
+  f.puts "    DATADIR = '#{config('datadir')}/rbot'"
+  f.puts "  end"
+  f.puts "end"
+}

data/lib/rbot/rbotconfig.rb

@@ -0,0 +1,36 @@
+module Irc
+  module Config
+    @@datadir = nil
+    # setup pkg-based configuration - i.e. where were we installed to, where
+    # are our data files, etc.
+    begin
+      debug "trying to load rubygems"
+      require 'rubygems'
+      debug "loaded rubygems, looking for rbot-#$version"
+      gemname, gem = Gem.source_index.find{|name, spec| spec.name == 'rbot' && spec.version.version == $version}
+      debug "got gem #{gem}"
+      if gem && path = gem.full_gem_path
+        debug "installed via rubygems to #{path}"
+        @@datadir = "#{path}/data/rbot"
+      else
+        debug "not installed via rubygems"
+      end
+    rescue LoadError
+      debug "no rubygems installed"
+    end
+
+    if @@datadir.nil?
+      begin
+        require 'rbot/pkgconfig'
+        @@datadir = PKGConfig::DATADIR
+      rescue LoadError
+        puts "fatal - no way to determine data dir"
+        exit 2
+      end
+    end
+    
+    def Config.datadir
+      @@datadir
+    end
+  end
+end

data/lib/rbot/registry.rb

@@ -0,0 +1,271 @@
+require 'rbot/dbhash'
+
+module Irc
+
+  # this is the backend of the RegistryAccessor class, which ties it to a
+  # DBHash object called plugin_registry(.db). All methods are delegated to
+  # the DBHash.
+  class BotRegistry
+    def initialize(bot)
+      @bot = bot
+      upgrade_data
+      @db = DBTree.new @bot, "plugin_registry"
+    end
+
+    # delegation hack
+    def method_missing(method, *args, &block)
+      @db.send(method, *args, &block)
+    end
+
+    # check for older versions of rbot with data formats that require updating
+    # NB this function is called _early_ in init(), pretty much all you have to
+    # work with is @bot.botclass.
+    def upgrade_data
+      if File.exist?("#{@bot.botclass}/registry.db")
+        puts "upgrading old-style (rbot 0.9.5 or earlier) plugin registry to new format"
+        old = BDB::Hash.open "#{@bot.botclass}/registry.db", nil, 
+                             "r+", 0600, "set_pagesize" => 1024,
+                             "set_cachesize" => [0, 32 * 1024, 0]
+        new = BDB::CIBtree.open "#{@bot.botclass}/plugin_registry.db", nil, 
+                                BDB::CREATE | BDB::EXCL | BDB::TRUNCATE,
+                                0600, "set_pagesize" => 1024,
+                                "set_cachesize" => [0, 32 * 1024, 0]
+        old.each {|k,v|
+          new[k] = v
+        }
+        old.close
+        new.close
+        File.delete("#{@bot.botclass}/registry.db")
+      end
+    end
+  end
+
+  # This class provides persistent storage for plugins via a hash interface.
+  # The default mode is an object store, so you can store ruby objects and
+  # reference them with hash keys. This is because the default store/restore
+  # methods of the plugins' RegistryAccessor are calls to Marshal.dump and
+  # Marshal.restore,
+  # for example:
+  #   blah = Hash.new
+  #   blah[:foo] = "fum"
+  #   @registry[:blah] = blah
+  # then, even after the bot is shut down and disconnected, on the next run you
+  # can access the blah object as it was, with:
+  #   blah = @registry[:blah]
+  # The registry can of course be used to store simple strings, fixnums, etc as
+  # well, and should be useful to store or cache plugin data or dynamic plugin
+  # configuration. 
+  #
+  # WARNING:
+  # in object store mode, don't make the mistake of treating it like a live
+  # object, e.g. (using the example above)
+  #   @registry[:blah][:foo] = "flump"
+  # will NOT modify the object in the registry - remember that BotRegistry#[]
+  # returns a Marshal.restore'd object, the object you just modified in place
+  # will disappear. You would need to:
+  #   blah = @registry[:blah]
+  #   blah[:foo] = "flump"
+  #   @registry[:blah] = blah
+
+  # If you don't need to store objects, and strictly want a persistant hash of
+  # strings, you can override the store/restore methods to suit your needs, for
+  # example (in your plugin):
+  #   def initialize
+  #     class << @registry
+  #       def store(val)
+  #         val
+  #       end
+  #       def restore(val)
+  #         val
+  #       end
+  #     end
+  #   end
+  # Your plugins section of the registry is private, it has its own namespace
+  # (derived from the plugin's class name, so change it and lose your data).
+  # Calls to registry.each etc, will only iterate over your namespace.
+  class BotRegistryAccessor
+    # plugins don't call this - a BotRegistryAccessor is created for them and
+    # is accessible via @registry.
+    def initialize(bot, prefix)
+      @bot = bot
+      @registry = @bot.registry
+      @orig_prefix = prefix
+      @prefix = prefix + "/"
+      @default = nil
+      # debug "initializing registry accessor with prefix #{@prefix}"
+    end
+
+    # use this to chop up your namespace into bits, so you can keep and
+    # reference separate object stores under the same registry
+    def sub_registry(prefix)
+      return BotRegistryAccessor.new(@bot, @orig_prefix + "+" + prefix)
+    end
+
+    # convert value to string form for storing in the registry
+    # defaults to Marshal.dump(val) but you can override this in your module's
+    # registry object to use any method you like.
+    # For example, if you always just handle strings use:
+    #   def store(val)
+    #     val
+    #   end
+    def store(val)
+      Marshal.dump(val)
+    end
+
+    # restores object from string form, restore(store(val)) must return val.
+    # If you override store, you should override restore to reverse the
+    # action.
+    # For example, if you always just handle strings use:
+    #   def restore(val)
+    #     val
+    #   end
+    def restore(val)
+      Marshal.restore(val)
+    end
+
+    # lookup a key in the registry
+    def [](key)
+      if @registry.has_key?(@prefix + key)
+        return restore(@registry[@prefix + key])
+      elsif @default != nil
+        return restore(@default)
+      else
+        return nil
+      end
+    end
+
+    # set a key in the registry
+    def []=(key,value)
+      @registry[@prefix + key] = store(value)
+    end
+
+    # set the default value for registry lookups, if the key sought is not
+    # found, the default will be returned. The default default (har) is nil.
+    def set_default (default)
+      @default = store(default)
+    end
+
+    # just like Hash#each
+    def each(&block)
+      @registry.each {|key,value|
+        if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+          block.call(key, restore(value))
+        end
+      }
+    end
+    
+    # just like Hash#each_key
+    def each_key(&block)
+      @registry.each {|key, value|
+        if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+          block.call(key)
+        end
+      }
+    end
+    
+    # just like Hash#each_value
+    def each_value(&block)
+      @registry.each {|key, value|
+        if key =~ /^#{Regexp.escape(@prefix)}/
+          block.call(restore(value))
+        end
+      }
+    end
+
+    # just like Hash#has_key?
+    def has_key?(key)
+      return @registry.has_key?(@prefix + key)
+    end
+    alias include? has_key?
+    alias member? has_key?
+
+    # just like Hash#has_both?
+    def has_both?(key, value)
+      return @registry.has_both?(@prefix + key, store(value))
+    end
+    
+    # just like Hash#has_value?
+    def has_value?(value)
+      return @registry.has_value?(store(value))
+    end
+
+    # just like Hash#index?
+    def index(value)
+      ind = @registry.index(store(value))
+      if ind && ind.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+        return ind
+      else
+        return nil
+      end
+    end
+    
+    # delete a key from the registry
+    def delete(key)
+      return @registry.delete(@prefix + key)
+    end
+
+    # returns a list of your keys
+    def keys
+      return @registry.keys.collect {|key|
+        if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")  
+          key
+        else
+          nil
+        end
+      }.compact
+    end
+
+    # Return an array of all associations [key, value] in your namespace
+    def to_a
+      ret = Array.new
+      @registry.each {|key, value|
+        if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+          ret << [key, restore(value)]
+        end
+      }
+      return ret
+    end
+    
+    # Return an hash of all associations {key => value} in your namespace
+    def to_hash
+      ret = Hash.new
+      @registry.each {|key, value|
+        if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+          ret[key] = restore(value)
+        end
+      }
+      return ret
+    end
+
+    # empties the registry (restricted to your namespace)
+    def clear
+      @registry.each_key {|key|
+        if key =~ /^#{Regexp.escape(@prefix)}/
+          @registry.delete(key)
+        end
+      }
+    end
+    alias truncate clear
+
+    # returns an array of the values in your namespace of the registry
+    def values
+      ret = Array.new
+      self.each {|k,v|
+        ret << restore(v)
+      }
+      return ret
+    end
+
+    # returns the number of keys in your registry namespace
+    def length
+      self.keys.length
+    end
+    alias size length
+
+    def flush
+      @registry.flush
+    end
+    
+  end
+
+end