Parent

Class/Module Index [+]

Quicksearch

Irc::Bot::Registry::Accessor

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 Registry#[] 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.


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 Registry#[] 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.

Attributes

recovery[RW]

Public Class Methods

new(bot, name) click to toggle source

plugins don't call this - a Registry::Accessor is created for them and is accessible via @registry.

# File lib/rbot/registry/tc.rb, line 305
def initialize(bot, name)
  @bot = bot
  @name = name.downcase
  @filename = @bot.path '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 << ".tdb"
  @registry = nil
  @default = nil
  @recovery = nil
  # debug "initializing registry accessor with name #{@name}"
end

Public Instance Methods

[](key) click to toggle source

lookup a key in the registry

# File lib/rbot/registry/tc.rb, line 377
def [](key)
  if File.exist?(@filename) and registry.has_key?(key.to_s)
    return restore(registry[key.to_s])
  else
    return default
  end
end
[]=(key,value) click to toggle source

set a key in the registry

# File lib/rbot/registry/tc.rb, line 386
def []=(key,value)
  registry[key.to_s] = store(value)
end
clear() click to toggle source

empties the registry (restricted to your namespace)

# File lib/rbot/registry/tc.rb, line 487
def clear
  return true unless File.exist?(@filename)
  registry.vanish
end
Also aliased as: truncate, truncate
close() click to toggle source
# File lib/rbot/registry/tc.rb, line 334
def close
  # debug "closing registry #{registry}"
  return if !@registry
  registry.close
end
default() click to toggle source
# File lib/rbot/registry/tc.rb, line 396
def default
  @default && (@default.dup rescue @default)
end
delete(key) click to toggle source

delete a key from the registry

# File lib/rbot/registry/tc.rb, line 455
def delete(key)
  return default unless File.exist?(@filename)
  return registry.delete(key.to_s)
end
each(set=nil, bulk=0, &block) click to toggle source

just like Hash#each

# File lib/rbot/registry/tc.rb, line 401
def each(set=nil, bulk=0, &block)
  return nil unless File.exist?(@filename)
  registry.fwmkeys(set).each {|key|
    block.call(key, restore(registry[key]))
  }
end
each_key(set=nil, bulk=0, &block) click to toggle source

just like Hash#each_key

# File lib/rbot/registry/tc.rb, line 409
def each_key(set=nil, bulk=0, &block)
  return nil unless File.exist?(@filename)
  registry.fwmkeys(set).each do |key|
    block.call(key)
  end
end
each_value(set=nil, bulk=0, &block) click to toggle source

just like Hash#each_value

# File lib/rbot/registry/tc.rb, line 417
def each_value(set=nil, bulk=0, &block)
  return nil unless File.exist?(@filename)
  registry.fwmkeys(set).each do |key|
    block.call(restore(registry[key]))
  end
end
flush() click to toggle source
# File lib/rbot/registry/tc.rb, line 328
def flush
  # debug "fushing registry #{registry}"
  return if !@registry
  registry.sync
end
getlist(key) click to toggle source
# File lib/rbot/registry/tc.rb, line 523
def getlist(key)
  return [] unless File.exist?(@filename)
  (registry.getlist(key.to_s) || []).map {|v| restore(v)}
end
has_both?(key, value) click to toggle source

just like Hash#has_both?

# File lib/rbot/registry/tc.rb, line 435
def has_both?(key, value)
  return false unless File.exist?(@filename)
  registry.has_key?(key.to_s) and registry.has_value?(store(value))
end
has_key?(key) click to toggle source

just like Hash#has_key?

# File lib/rbot/registry/tc.rb, line 425
def has_key?(key)
  return false unless File.exist?(@filename)
  return registry.has_key?(key.to_s)
end
Also aliased as: include?, member?, key?, include?, member?, key?
has_value?(value) click to toggle source

just like Hash#has_value?

# File lib/rbot/registry/tc.rb, line 441
def has_value?(value)
  return false unless File.exist?(@filename)
  return registry.has_value?(store(value))
end
include?(key) click to toggle source
Alias for: has_key?
index(value) click to toggle source

just like Hash#index?

# File lib/rbot/registry/tc.rb, line 447
def index(value)
  self.each do |k,v|
    return k if v == value
  end
  return nil
end
key?(key) click to toggle source
Alias for: has_key?
keys() click to toggle source

returns a list of your keys

# File lib/rbot/registry/tc.rb, line 461
def keys
  return [] unless File.exist?(@filename)
  return registry.keys
end
length() click to toggle source

returns the number of keys in your registry namespace

# File lib/rbot/registry/tc.rb, line 508
def length
  return 0 unless File.exist?(@filename)
  registry.length
end
Also aliased as: size, size
member?(key) click to toggle source
Alias for: has_key?
putdup(key, value) click to toggle source

That is btree!

# File lib/rbot/registry/tc.rb, line 515
def putdup(key, value)
  registry.putdup(key.to_s, store(value))
end
putlist(key, values) click to toggle source
# File lib/rbot/registry/tc.rb, line 519
def putlist(key, values)
  registry.putlist(key.to_s, value.map {|v| store(v)})
end
registry() click to toggle source
# File lib/rbot/registry/tc.rb, line 324
def registry
    @registry ||= DBTree.new @bot, "registry/#{@name}"
end
restore(val) click to toggle source

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
# File lib/rbot/registry/tc.rb, line 358
def 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
set_default(default) click to toggle source

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.

# File lib/rbot/registry/tc.rb, line 392
def set_default (default)
  @default = default
end
size() click to toggle source
Alias for: length
store(val) click to toggle source

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
# File lib/rbot/registry/tc.rb, line 347
def store(val)
  Marshal.dump(val)
end
sub_registry(prefix) click to toggle source
# File lib/rbot/registry/tc.rb, line 503
def sub_registry(prefix)
  return Accessor.new(@bot, @name + "/" + prefix.to_s)
end
to_a() click to toggle source

Return an array of all associations [key, value] in your namespace

# File lib/rbot/registry/tc.rb, line 467
def to_a
  return [] unless File.exist?(@filename)
  ret = Array.new
  registry.each {|key, value|
    ret << [key, restore(value)]
  }
  return ret
end
to_hash() click to toggle source

Return an hash of all associations {key => value} in your namespace

# File lib/rbot/registry/tc.rb, line 477
def to_hash
  return {} unless File.exist?(@filename)
  ret = Hash.new
  registry.each {|key, value|
    ret[key] = restore(value)
  }
  return ret
end
truncate() click to toggle source
Alias for: clear
values() click to toggle source

returns an array of the values in your namespace of the registry

# File lib/rbot/registry/tc.rb, line 494
def values
  return [] unless File.exist?(@filename)
  ret = Array.new
  self.each {|k,v|
    ret << restore(v)
  }
  return ret
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.