X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fregistry.rb;h=b85a622426de23442a71b5039e144c4051ce3f3b;hb=2d2e6d1fb24e5d687eab7e77bf251ad777ca736d;hp=bc52a3730dd17378eb6ce4ea36e0f96d7db65ab0;hpb=597bfec2266fc9c6c29f84a0d811fe264932500b;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/registry.rb b/lib/rbot/registry.rb index bc52a373..b85a6224 100644 --- a/lib/rbot/registry.rb +++ b/lib/rbot/registry.rb @@ -1,10 +1,11 @@ require 'rbot/dbhash' module Irc +class Bot - # this class is now used purely for upgrading from prior versions of rbot + # This class is now used purely for upgrading from prior versions of rbot # the new registry is split into multiple DBHash objects, one per plugin - class BotRegistry + class Registry def initialize(bot) @bot = bot upgrade_data @@ -16,7 +17,7 @@ module Irc # work with is @bot.botclass. def upgrade_data if File.exist?("#{@bot.botclass}/registry.db") - log "upgrading old-style (rbot 0.9.5 or earlier) plugin registry to new format" + log _("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) new = BDB::CIBtree.open("#{@bot.botclass}/plugin_registry.db", nil, @@ -27,16 +28,16 @@ module Irc } old.close new.close - File.delete("#{@bot.botclass}/registry.db") + File.rename("#{@bot.botclass}/registry.db", "#{@bot.botclass}/registry.db.old") end end def upgrade_data2 if File.exist?("#{@bot.botclass}/plugin_registry.db") Dir.mkdir("#{@bot.botclass}/registry") unless File.exist?("#{@bot.botclass}/registry") - env = BDB::Env.open("#{@bot.botclass}", BDB::INIT_TRANSACTION | BDB::CREATE | BDB::RECOVER) + env = BDB::Env.open("#{@bot.botclass}", BDB::INIT_TRANSACTION | BDB::CREATE | BDB::RECOVER)# | BDB::TXN_NOSYNC) dbs = Hash.new - log "upgrading previous (rbot 0.9.9 or earlier) plugin registry to new split format" + log _("upgrading previous (rbot 0.9.9 or earlier) plugin registry to new split format") old = BDB::CIBtree.open("#{@bot.botclass}/plugin_registry.db", nil, "r+", 0600, "env" => env) old.each {|k,v| @@ -44,17 +45,18 @@ module Irc prefix.downcase! # subregistries were split with a +, now they are in separate folders if prefix.gsub!(/\+/, "/") + # Ok, this code needs to be put in the db opening routines dirs = File.dirname("#{@bot.botclass}/registry/#{prefix}.db").split("/") dirs.length.times { |i| dir = dirs[0,i+1].join("/")+"/" unless File.exist?(dir) - log "creating subregistry directory #{dir}" - Dir.mkdir(dir) + log _("creating subregistry directory #{dir}") + Dir.mkdir(dir) end } end unless dbs.has_key?(prefix) - log "creating db #{@bot.botclass}/registry/#{prefix}.db" + log _("creating db #{@bot.botclass}/registry/#{prefix}.db") dbs[prefix] = BDB::CIBtree.open("#{@bot.botclass}/registry/#{prefix}.db", nil, BDB::CREATE | BDB::EXCL, 0600, "env" => env) @@ -64,13 +66,12 @@ module Irc old.close File.rename("#{@bot.botclass}/plugin_registry.db", "#{@bot.botclass}/plugin_registry.db.old") dbs.each {|k,v| - log "closing db #{k}" + log _("closing db #{k}") v.close } env.close end end - end # This class provides persistent storage for plugins via a hash interface. @@ -93,7 +94,7 @@ module Irc # 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#[] + # will NOT modify the object in the registry - remember that Registry#[] # returns a Marshal.restore'd object, the object you just modified in place # will disappear. You would need to: # blah = @registry[:blah] @@ -116,24 +117,46 @@ module Irc # 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 + class Accessor + + attr_accessor :recovery + + # plugins don't call this - a Registry::Accessor is created for them and # is accessible via @registry. def initialize(bot, name) @bot = bot @name = name.downcase - @registry = DBTree.new bot, "registry/#{@name}" + @filename = "#{@bot.botclass}/registry/#{@name}" + dirs = File.dirname(@filename).split("/") + dirs.length.times { |i| + dir = dirs[0,i+1].join("/")+"/" + unless File.exist?(dir) + debug "creating subregistry directory #{dir}" + Dir.mkdir(dir) + end + } + @filename << ".db" + @registry = nil @default = nil + @recovery = nil # debug "initializing registry accessor with name #{@name}" end + def registry + @registry ||= DBTree.new @bot, "registry/#{@name}" + end + def flush - @registry.flush - @registry.sync + # debug "fushing registry #{registry}" + return if !@registry + registry.flush + registry.sync end def close - @registry.close + # debug "closing registry #{registry}" + return if !@registry + registry.close end # convert value to string form for storing in the registry @@ -158,84 +181,93 @@ module Irc begin Marshal.restore(val) rescue Exception => e - warning "failed to restore marshal data for #{val.inspect}, falling back to default" - debug e.inspect - debug e.backtrace.join("\n") - if @default != nil + error _("failed to restore marshal data for #{val.inspect}, attempting recovery or fallback to default") + debug e + if defined? @recovery and @recovery begin - return Marshal.restore(@default) - rescue - return nil + return @recovery.call(val) + rescue Exception => ee + error _("marshal recovery failed, trying default") + debug ee end - else - return nil end + return default end end # lookup a key in the registry def [](key) - if @registry.has_key?(key) - return restore(@registry[key]) - elsif @default != nil - return restore(@default) + if File.exist?(@filename) && registry.has_key?(key) + return restore(registry[key]) else - return nil + return default end end # set a key in the registry def []=(key,value) - @registry[key] = store(value) + registry[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) + @default = default + end + + def default + @default && (@default.dup rescue @default) end # just like Hash#each def each(&block) - @registry.each {|key,value| + return nil unless File.exist?(@filename) + registry.each {|key,value| block.call(key, restore(value)) } end # just like Hash#each_key def each_key(&block) - @registry.each {|key, value| + return nil unless File.exist?(@filename) + registry.each {|key, value| block.call(key) } end # just like Hash#each_value def each_value(&block) - @registry.each {|key, value| + return nil unless File.exist?(@filename) + registry.each {|key, value| block.call(restore(value)) } end # just like Hash#has_key? def has_key?(key) - return @registry.has_key?(key) + return false unless File.exist?(@filename) + return registry.has_key?(key) end alias include? has_key? alias member? has_key? + alias key? has_key? # just like Hash#has_both? def has_both?(key, value) - return @registry.has_both?(key, store(value)) + return false unless File.exist?(@filename) + return registry.has_both?(key, store(value)) end # just like Hash#has_value? def has_value?(value) - return @registry.has_value?(store(value)) + return false unless File.exist?(@filename) + return registry.has_value?(store(value)) end # just like Hash#index? def index(value) - ind = @registry.index(store(value)) + return nil unless File.exist?(@filename) + ind = registry.index(store(value)) if ind return ind else @@ -245,18 +277,21 @@ module Irc # delete a key from the registry def delete(key) - return @registry.delete(key) + return default unless File.exist?(@filename) + return registry.delete(key) end # returns a list of your keys def keys - return @registry.keys + return [] unless File.exist?(@filename) + return registry.keys end # Return an array of all associations [key, value] in your namespace def to_a + return [] unless File.exist?(@filename) ret = Array.new - @registry.each {|key, value| + registry.each {|key, value| ret << [key, restore(value)] } return ret @@ -264,8 +299,9 @@ module Irc # Return an hash of all associations {key => value} in your namespace def to_hash + return {} unless File.exist?(@filename) ret = Hash.new - @registry.each {|key, value| + registry.each {|key, value| ret[key] = restore(value) } return ret @@ -273,12 +309,14 @@ module Irc # empties the registry (restricted to your namespace) def clear - @registry.clear + return true unless File.exist?(@filename) + registry.clear end alias truncate clear # returns an array of the values in your namespace of the registry def values + return [] unless File.exist?(@filename) ret = Array.new self.each {|k,v| ret << restore(v) @@ -287,7 +325,7 @@ module Irc end def sub_registry(prefix) - return BotRegistryAccessor.new(@bot, @name + "/" + prefix) + return Accessor.new(@bot, @name + "/" + prefix.to_s) end # returns the number of keys in your registry namespace @@ -298,4 +336,6 @@ module Irc end + end +end end