rbot 0.9.9 → 0.9.10

data/lib/rbot/channel.rb

@@ -4,23 +4,23 @@ module Irc
   class IRCChannel
     # name of channel
     attr_reader :name
-    
+
     # current channel topic
     attr_reader :topic
-    
+
     # hash containing users currently in the channel
     attr_accessor :users
-    
+
     # if true, bot won't talk in this channel
     attr_accessor :quiet
-    
+
     # name:: channel name
     # create a new IRCChannel
     def initialize(name)
       @name = name
       @users = Hash.new
       @quiet = false
-	  @topic = Topic.new
+      @topic = Topic.new
     end
 
     # eg @bot.channels[chan].topic = topic

data/lib/rbot/config.rb

@@ -3,6 +3,14 @@ module Irc
   require 'yaml'
   require 'rbot/messagemapper'
 
+  unless YAML.respond_to?(:load_file)
+      def YAML.load_file( filepath )
+        File.open( filepath ) do |f|
+          YAML::load( f )
+        end
+      end
+  end
+
   class BotConfigValue
     # allow the definition order to be preserved so that sorting by
     # definition order is possible. The BotConfigWizard does this to allow
@@ -15,12 +23,15 @@ module Irc
     attr_reader :requires_restart
     attr_reader :order
     def initialize(key, params)
-      unless key =~ /^.+\..+$/
+      # Keys must be in the form 'module.name'.
+      # They will be internally passed around as symbols,
+      # but we accept them both in string and symbol form.
+      unless key.to_s =~ /^.+\..+$/
         raise ArgumentError,"key must be of the form 'module.name'"
       end
       @order = @@order
       @@order += 1
-      @key = key
+      @key = key.intern
       if params.has_key? :default
         @default = params[:default]
       else
@@ -114,6 +125,15 @@ module Irc
     def to_s
       get.join(", ")
     end
+    def add(val)
+      curval = self.get
+      set(curval + [val]) unless curval.include?(val)
+    end
+    def rm(val)
+      curval = self.get
+      raise ArgumentError, "value #{val} not present" unless curval.include?(val)
+      set(curval - [val])
+    end
   end
   class BotConfigEnumValue < BotConfigValue
     def initialize(key, params)
@@ -128,8 +148,8 @@ module Irc
       end
     end
     def parse(string)
-      unless @values.include?(string)
-        raise ArgumentError, "invalid value #{string}, allowed values are: " + @values.join(", ")
+      unless values.include?(string)
+        raise ArgumentError, "invalid value #{string}, allowed values are: " + values.join(", ")
       end
       string
     end
@@ -167,8 +187,17 @@ module Irc
     # supported via []
     def [](key)
       return @@items[key].value if @@items.has_key?(key)
+      return @@items[key.intern].value if @@items.has_key?(key.intern)
       # try to still support unregistered lookups
-      return @@config[key] if @@config.has_key?(key)
+      # but warn about them
+      if @@config.has_key?(key)
+        warning "Unregistered lookup #{key.inspect}"
+        return @@config[key]
+      end
+      if @@config.has_key?(key.intern)
+        warning "Unregistered lookup #{key.intern.inspect}"
+        return @@config[key.intern]
+      end
       return false
     end
 
@@ -185,7 +214,7 @@ module Irc
       modules = []
       if params[:module]
         @@items.each_key do |key|
-          mod, name = key.split('.')
+          mod, name = key.to_s.split('.')
           next unless mod == params[:module]
           modules.push key unless modules.include?(name)
         end
@@ -196,7 +225,7 @@ module Irc
         end
       else
         @@items.each_key do |key|
-          name = key.split('.').first
+          name = key.to_s.split('.').first
           modules.push name unless modules.include?(name)
         end
         m.reply "modules: " + modules.join(", ")
@@ -204,7 +233,7 @@ module Irc
     end
 
     def handle_get(m, params)
-      key = params[:key]
+      key = params[:key].to_s.intern
       unless @@items.has_key?(key)
         m.reply "no such config key #{key}"
         return
@@ -214,7 +243,7 @@ module Irc
     end
 
     def handle_desc(m, params)
-      key = params[:key]
+      key = params[:key].to_s.intern
       unless @@items.has_key?(key)
         m.reply "no such config key #{key}"
       end
@@ -223,17 +252,18 @@ module Irc
     end
 
     def handle_unset(m, params)
-      key = params[:key]
+      key = params[:key].to_s.intern
       unless @@items.has_key?(key)
         m.reply "no such config key #{key}"
       end
       @@items[key].unset
       handle_get(m, params)
+      m.reply "this config change will take effect on the next restart" if @@items[key].requires_restart
     end
 
     def handle_set(m, params)
-      key = params[:key]
-      value = params[:value].to_s
+      key = params[:key].to_s.intern
+      value = params[:value].join(" ")
       unless @@items.has_key?(key)
         m.reply "no such config key #{key}"
         return
@@ -251,11 +281,53 @@ module Irc
       end
     end
 
+    def handle_add(m, params)
+      key = params[:key].to_s.intern
+      value = params[:value]
+      unless @@items.has_key?(key)
+        m.reply "no such config key #{key}"
+        return
+      end
+      unless @@items[key].class <= BotConfigArrayValue
+        m.reply "config key #{key} is not an array"
+        return
+      end
+      begin
+        @@items[key].add(value)
+      rescue ArgumentError => e
+        m.reply "failed to add #{value} to #{key}: #{e.message}"
+        return
+      end
+      handle_get(m,{:key => key})
+      m.reply "this config change will take effect on the next restart" if @@items[key].requires_restart
+    end
+
+    def handle_rm(m, params)
+      key = params[:key].to_s.intern
+      value = params[:value]
+      unless @@items.has_key?(key)
+        m.reply "no such config key #{key}"
+        return
+      end
+      unless @@items[key].class <= BotConfigArrayValue
+        m.reply "config key #{key} is not an array"
+        return
+      end
+      begin
+        @@items[key].rm(value)
+      rescue ArgumentError => e
+        m.reply "failed to remove #{value} from #{key}: #{e.message}"
+        return
+      end
+      handle_get(m,{:key => key})
+      m.reply "this config change will take effect on the next restart" if @@items[key].requires_restart
+    end
+
     def handle_help(m, params)
       topic = params[:topic]
       case topic
       when false
-        m.reply "config module - bot configuration. usage: list, desc, get, set, unset"
+        m.reply "config module - bot configuration. usage: list, desc, get, set, unset, add, rm"
       when "list"
         m.reply "config list => list configuration modules, config list <module> => list configuration keys for module <module>"
       when "get"
@@ -266,6 +338,10 @@ module Irc
         m.reply "config set <key> <value> => set configuration value for key <key> to <value>"
       when "desc"
         m.reply "config desc <key> => describe what key <key> configures"
+      when "add"
+        m.reply "config add <value> to <key> => add value <value> to key <key> if <key> is an array"
+      when "rm"
+        m.reply "config rm <value> from <key> => remove value <value> from key <key> if <key> is an array"
       else
         m.reply "no help for config #{topic}"
       end
@@ -296,27 +372,52 @@ module Irc
       @handler.map 'config desc :key', :action => 'handle_desc'
       @handler.map 'config describe :key', :action => 'handle_desc'
       @handler.map 'config set :key *value', :action => 'handle_set'
+      @handler.map 'config add :value to :key', :action => 'handle_add'
+      @handler.map 'config rm :value from :key', :action => 'handle_rm'
+      @handler.map 'config del :value from :key', :action => 'handle_rm'
+      @handler.map 'config delete :value from :key', :action => 'handle_rm'
       @handler.map 'config unset :key', :action => 'handle_unset'
+      @handler.map 'config reset :key', :action => 'handle_unset'
       @handler.map 'config help :topic', :action => 'handle_help',
                    :defaults => {:topic => false}
       @handler.map 'help config :topic', :action => 'handle_help',
                    :defaults => {:topic => false}
       
       if(File.exist?("#{@@bot.botclass}/conf.yaml"))
-        newconfig = YAML::load_file("#{@@bot.botclass}/conf.yaml")
-        @@config.update newconfig
-      else
-        # first-run wizard!
-        BotConfigWizard.new(@@bot).run
-        # save newly created config
-        save
+        begin
+          newconfig = YAML::load_file("#{@@bot.botclass}/conf.yaml")
+          newconfig.each { |key, val|
+            @@config[key.intern] = val
+          }
+          return
+        rescue
+          error "failed to read conf.yaml: #{$!}"
+        end
       end
+      # if we got here, we need to run the first-run wizard
+      BotConfigWizard.new(@@bot).run
+      # save newly created config
+      save
     end
 
-    # write current configuration to #{botclass}/conf.rbot
+    # write current configuration to #{botclass}/conf.yaml
     def save
-      File.open("#{@@bot.botclass}/conf.yaml", "w") do |file|
-        file.puts @@config.to_yaml
+      begin
+        debug "Writing new conf.yaml ..."
+        File.open("#{@@bot.botclass}/conf.yaml.new", "w") do |file|
+          savehash = {}
+          @@config.each { |key, val|
+            savehash[key.to_s] = val
+          }
+          file.puts savehash.to_yaml
+        end
+        debug "Officializing conf.yaml ..."
+        File.rename("#{@@bot.botclass}/conf.yaml.new",
+                    "#{@@bot.botclass}/conf.yaml")
+      rescue => e
+        error "failed to write configuration file conf.yaml! #{$!}"
+        error "#{e.class}: #{e}"
+        error e.backtrace.join("\n")
       end
     end
 
@@ -345,7 +446,7 @@ module Irc
       @questions.sort{|a,b| a.order <=> b.order }.each do |q|
         puts q.desc
         begin
-          print q.key + " [#{q.to_s}]: "
+          print q.key.to_s + " [#{q.to_s}]: "
           response = STDIN.gets
           response.chop!
           unless response.empty?

data/lib/rbot/dbhash.rb

@@ -1,8 +1,8 @@
 begin
   require 'bdb'
 rescue Exception => e
-  puts "Got exception: "+e
-  puts "rbot couldn't load the bdb module, perhaps you need to install it? try: http://www.ruby-lang.org/en/raa-list.rhtml?name=bdb"
+  error "Got exception: "+e
+  error "rbot couldn't load the bdb module, perhaps you need to install it? try: http://www.ruby-lang.org/en/raa-list.rhtml?name=bdb"
   exit 2
 end
 
@@ -10,7 +10,10 @@ end
 module BDB
   class CIBtree < Btree
     def bdb_bt_compare(a, b)
-      a.downcase <=> b.downcase
+      if a == nil || b == nil
+        warning "CIBTree: comparing #{a.inspect} (#{self[a].inspect}) with #{b.inspect} (#{self[b].inspect})"
+      end
+      (a||'').downcase <=> (b||'').downcase
     end
   end
 end
@@ -22,7 +25,7 @@ module Irc
   # mydata.db, if it exists, it will load and reference that db.
   # Otherwise it'll create and empty db called mydata.db
   class DBHash
-    
+
     # absfilename:: use +key+ as an actual filename, don't prepend the bot's
     #               config path and don't append ".db"
     def initialize(bot, key, absfilename=false)
@@ -50,29 +53,39 @@ module Irc
     def DBHash.create_db(name)
       debug "DBHash: creating empty db #{name}"
       return BDB::Hash.open(name, nil, 
-                             BDB::CREATE | BDB::EXCL | BDB::TRUNCATE,
-                             0600, "set_pagesize" => 1024,
-                             "set_cachesize" => [(0), (32 * 1024), (0)])
+      BDB::CREATE | BDB::EXCL, 0600)
     end
 
     def DBHash.open_db(name)
       debug "DBHash: opening existing db #{name}"
-      return BDB::Hash.open(name, nil, 
-                             "r+", 0600, "set_pagesize" => 1024,
-                             "set_cachesize" => [(0), (32 * 1024), (0)])
+      return BDB::Hash.open(name, nil, "r+", 0600)
     end
-    
+
   end
 
-  
+
   # DBTree is a BTree equivalent of DBHash, with case insensitive lookups.
   class DBTree
-    
+    @@env=nil
+    # TODO: make this customizable
+    # Note that it must be at least four times lg_bsize
+    @@lg_max = 8*1024*1024
     # absfilename:: use +key+ as an actual filename, don't prepend the bot's
     #               config path and don't append ".db"
     def initialize(bot, key, absfilename=false)
       @bot = bot
       @key = key
+      if @@env.nil?
+        begin
+          @@env = BDB::Env.open("#{@bot.botclass}", BDB::INIT_TRANSACTION | BDB::CREATE | BDB::RECOVER, "set_lg_max" => @@lg_max)
+          debug "DBTree: environment opened with max log size #{@@env.conf['lg_max']}"
+        rescue => e
+          debug "DBTree: failed to open environment: #{e}. Retrying ..."
+          @@env = BDB::Env.open("#{@bot.botclass}", BDB::INIT_TRANSACTION | BDB::CREATE |  BDB::RECOVER)
+        end
+        #@@env = BDB::Env.open("#{@bot.botclass}", BDB::CREATE | BDB::INIT_MPOOL | BDB::RECOVER)
+      end
+
       if absfilename && File.exist?(key)
         # db already exists, use it
         @db = DBTree.open_db(key)
@@ -94,19 +107,72 @@ module Irc
 
     def DBTree.create_db(name)
       debug "DBTree: creating empty db #{name}"
-      return BDB::CIBtree.open(name, nil, 
-                             BDB::CREATE | BDB::EXCL | BDB::TRUNCATE,
-                             0600, "set_pagesize" => 1024,
-                             "set_cachesize" => [(0), (32 * 1024), (0)])
+      return @@env.open_db(BDB::CIBtree, name, nil, BDB::CREATE | BDB::EXCL, 0600)
     end
 
     def DBTree.open_db(name)
       debug "DBTree: opening existing db #{name}"
-      return BDB::CIBtree.open(name, nil, 
-                             "r+", 0600, "set_pagesize" => 1024,
-                             "set_cachesize" => [0, 32 * 1024, 0])
+      return @@env.open_db(BDB::CIBtree, name, nil, "r+", 0600)
+    end
+
+    def DBTree.cleanup_logs()
+      begin
+        debug "DBTree: checkpointing ..."
+        @@env.checkpoint
+      rescue => e
+        debug "Failed: #{e}"
+      end
+      begin
+        debug "DBTree: flushing log ..."
+        @@env.log_flush
+        logs = @@env.log_archive(BDB::ARCH_ABS)
+        debug "DBTree: deleting archivable logs: #{logs.join(', ')}."
+        logs.each { |log|
+          File.delete(log)
+        }
+      rescue => e
+        debug "Failed: #{e}"
+      end
+    end
+
+    def DBTree.stats()
+      begin
+        debug "General stats:"
+        debug @@env.stat
+        debug "Lock stats:"
+        debug @@env.lock_stat
+        debug "Log stats:"
+        debug @@env.log_stat
+        debug "Txn stats:"
+        debug @@env.txn_stat
+      rescue
+        debug "Couldn't dump stats"
+      end
     end
-    
+
+    def DBTree.cleanup_env()
+      begin
+        debug "DBTree: checking transactions ..."
+        has_active_txn = @@env.txn_stat["st_nactive"] > 0
+        if has_active_txn
+          warning "DBTree: not all transactions completed!"
+        end
+        DBTree.cleanup_logs
+        debug "DBTree: closing environment #{@@env}"
+        path = @@env.home
+        @@env.close
+        @@env = nil
+        if has_active_txn
+          debug "DBTree: keeping file because of incomplete transactions"
+        else
+          debug "DBTree: cleaning up environment in #{path}"
+          BDB::Env.remove("#{path}")
+        end
+      rescue => e
+        error "failed to clean up environment: #{e.inspect}"
+      end
+    end
+
   end
 
 end