# 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)
- new = BDB::CIBtree.open("#{@bot.botclass}/plugin_registry.db", nil,
+ 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)
+ 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
-
+
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
- puts "upgrading previous (rbot 0.9.9 or earlier) plugin registry to new split format"
- old = BDB::CIBtree.open("#{@bot.botclass}/plugin_registry.db", nil,
+ 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)
- puts "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)
-
end
dbs[prefix][key] = v
}
old.close
File.rename("#{@bot.botclass}/plugin_registry.db", "#{@bot.botclass}/plugin_registry.db.old")
dbs.each {|k,v|
- puts "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.
# 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
# (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
+
+ attr_accessor :recovery
+
# plugins don't call this - a BotRegistryAccessor is created for them and
# is accessible via @registry.
def initialize(bot, name)
@bot = bot
@name = name.downcase
- @registry = DBTree.new bot, "registry/#{@name}"
+ dirs = File.dirname("#{@bot.botclass}/registry/#{@name}").split("/")
+ dirs.length.times { |i|
+ dir = dirs[0,i+1].join("/")+"/"
+ unless File.exist?(dir)
+ debug "creating subregistry directory #{dir}"
+ Dir.mkdir(dir)
+ end
+ }
+ @registry = nil
@default = nil
+ @recover = 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
def restore(val)
begin
Marshal.restore(val)
- rescue Exception
- $stderr.puts "failed to restore marshal data, falling back to default"
- if @default != nil
+ rescue Exception => e
+ error _("failed to restore marshal data for #{val.inspect}, attempting recovery or fallback to default")
+ debug e
+ if @recovery
+ begin
+ return @recovery.call(val)
+ rescue Exception => ee
+ error _("marshal recovery failed, trying default")
+ debug ee
+ end
+ end
+ unless @default.nil?
begin
return Marshal.restore(@default)
rescue
# lookup a key in the registry
def [](key)
- if @registry.has_key?(key)
- return restore(@registry[key])
+ if registry.has_key?(key)
+ return restore(registry[key])
elsif @default != nil
return restore(@default)
else
# 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
# just like Hash#each
def each(&block)
- @registry.each {|key,value|
+ registry.each {|key,value|
block.call(key, restore(value))
}
end
-
+
# just like Hash#each_key
def each_key(&block)
- @registry.each {|key, value|
+ registry.each {|key, value|
block.call(key)
}
end
-
+
# just like Hash#each_value
def each_value(&block)
- @registry.each {|key, value|
+ registry.each {|key, value|
block.call(restore(value))
}
end
# just like Hash#has_key?
def has_key?(key)
- return @registry.has_key?(key)
+ return registry.has_key?(key)
end
alias include? has_key?
alias member? has_key?
# just like Hash#has_both?
def has_both?(key, value)
- return @registry.has_both?(key, store(value))
+ return registry.has_both?(key, store(value))
end
-
+
# just like Hash#has_value?
def has_value?(value)
- return @registry.has_value?(store(value))
+ return registry.has_value?(store(value))
end
# just like Hash#index?
def index(value)
- ind = @registry.index(store(value))
+ 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(key)
+ return registry.delete(key)
end
# returns a list of your keys
def keys
- return @registry.keys
+ return registry.keys
end
# Return an array of all associations [key, value] in your namespace
def to_a
ret = Array.new
- @registry.each {|key, value|
+ 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
ret = Hash.new
- @registry.each {|key, value|
+ registry.each {|key, value|
ret[key] = restore(value)
}
return ret
# empties the registry (restricted to your namespace)
def clear
- @registry.clear
+ registry.clear
end
alias truncate clear
end
def sub_registry(prefix)
- return BotRegistryAccessor.new(@bot, @name + "/" + prefix)
+ return BotRegistryAccessor.new(@bot, @name + "/" + prefix.to_s)
end
# returns the number of keys in your registry namespace