require 'rbot/dbhash'
module Irc
+class Bot
- # 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
+ # 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 Registry
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)
+ upgrade_data2
end
# check for older versions of rbot with data formats that require updating
# 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]
+ 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,
+ BDB::CREATE | BDB::EXCL,
+ 0600)
old.each {|k,v|
new[k] = v
}
old.close
new.close
- File.delete("#{@bot.botclass}/registry.db")
+ File.rename("#{@bot.botclass}/registry.db", "#{@bot.botclass}/registry.db.old")
end
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)# | BDB::TXN_NOSYNC)
+ dbs = Hash.new
+ 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|
+ prefix,key = k.split("/", 2)
+ 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)
+ end
+ }
+ end
+ unless dbs.has_key?(prefix)
+ 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)
+ end
+ dbs[prefix][key] = v
+ }
+ old.close
+ File.rename("#{@bot.botclass}/plugin_registry.db", "#{@bot.botclass}/plugin_registry.db.old")
+ dbs.each {|k,v|
+ log _("closing db #{k}")
+ v.close
+ }
+ env.close
+ 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
# 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.
+ # 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#[]
+ # 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]
# 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, prefix)
+ def initialize(bot, name)
@bot = bot
- @registry = @bot.registry
- @orig_prefix = prefix
- @prefix = prefix + "/"
+ @name = name.downcase
+ @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
- # debug "initializing registry accessor with prefix #{@prefix}"
+ @recovery = nil
+ # debug "initializing registry accessor with name #{@name}"
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)
+ def registry
+ @registry ||= DBTree.new @bot, "registry/#{@name}"
+ end
+
+ def flush
+ # debug "fushing registry #{registry}"
+ return if !@registry
+ registry.flush
+ registry.sync
+ end
+
+ def close
+ # debug "closing registry #{registry}"
+ return if !@registry
+ registry.close
end
# convert value to string form for storing in the registry
# val
# end
def restore(val)
- Marshal.restore(val)
+ begin
+ Marshal.restore(val)
+ rescue Exception => e
+ error _("failed to restore marshal data for #{val.inspect}, attempting recovery or fallback to default")
+ debug e
+ if defined? @recovery and @recovery
+ begin
+ return @recovery.call(val)
+ rescue Exception => ee
+ error _("marshal recovery failed, trying default")
+ debug ee
+ end
+ end
+ return default
+ end
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)
+ 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[@prefix + 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|
- if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
- block.call(key, restore(value))
- end
+ 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|
- if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
- block.call(key)
- end
+ 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|
- if key =~ /^#{Regexp.escape(@prefix)}/
- block.call(restore(value))
- end
+ 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?(@prefix + 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?(@prefix + 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))
- if ind && ind.gsub!(/^#{Regexp.escape(@prefix)}/, "")
+ return nil unless File.exist?(@filename)
+ ind = registry.index(store(value))
+ if ind
return ind
else
return nil
end
end
-
+
# delete a key from the registry
def delete(key)
- return @registry.delete(@prefix + key)
+ return default unless File.exist?(@filename)
+ return registry.delete(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
+ 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|
- if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
- ret << [key, restore(value)]
- end
+ registry.each {|key, value|
+ ret << [key, restore(value)]
}
return ret
end
-
+
# 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|
- if key.gsub!(/^#{Regexp.escape(@prefix)}/, "")
- ret[key] = restore(value)
- end
+ registry.each {|key, value|
+ ret[key] = restore(value)
}
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
- }
+ 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)
return ret
end
+ def sub_registry(prefix)
+ return Accessor.new(@bot, @name + "/" + prefix.to_s)
+ 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
+end
end
projects / user / henk / code / ruby / rbot.git / blobdiff