X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fconfig.rb;h=de7b29b78719a90d038ed1f9db44dc4c06d1e566;hb=6fc9e6c2e1895018b89f45494384015b6b365a81;hp=027b99023443c1b870a9e432343400e7590d5a07;hpb=830258cd76adb3a40d1c2a854f140b3e1faf1615;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/config.rb b/lib/rbot/config.rb index 027b9902..de7b29b7 100644 --- a/lib/rbot/config.rb +++ b/lib/rbot/config.rb @@ -1,7 +1,8 @@ +require 'singleton' + module Irc require 'yaml' - require 'rbot/messagemapper' unless YAML.respond_to?(:load_file) def YAML.load_file( filepath ) @@ -21,14 +22,21 @@ module Irc attr_reader :key attr_reader :wizard attr_reader :requires_restart + attr_reader :requires_rescan attr_reader :order + attr_reader :manager + attr_reader :auth_path def initialize(key, params) - unless key =~ /^.+\..+$/ + @manager = BotConfig::configmanager + # 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.to_sym if params.has_key? :default @default = params[:default] else @@ -40,6 +48,8 @@ module Irc @validate = params[:validate] @wizard = params[:wizard] @requires_restart = params[:requires_restart] + @requires_rescan = params[:requires_rescan] + @auth_path = "config::key::#{key.sub('.','::')}" end def default if @default.instance_of?(Proc) @@ -49,16 +59,19 @@ module Irc end end def get - return BotConfig.config[@key] if BotConfig.config.has_key?(@key) + return @manager.config[@key] if @manager.config.has_key?(@key) return @default end alias :value :get def set(value, on_change = true) - BotConfig.config[@key] = value - @on_change.call(BotConfig.bot, value) if on_change && @on_change + @manager.config[@key] = value + @manager.changed = true + @on_change.call(@manager.bot, value) if on_change && @on_change end def unset - BotConfig.config.delete(@key) + @manager.config.delete(@key) + @manager.changed = true + @on_change.call(@manager.bot, value) if @on_change end # set string will raise ArgumentErrors on failed parse/validate @@ -70,7 +83,7 @@ module Irc raise ArgumentError, "invalid value: #{string}" end end - + # override this. the default will work for strings only def parse(string) string @@ -96,6 +109,7 @@ module Irc class BotConfigStringValue < BotConfigValue end + class BotConfigBooleanValue < BotConfigValue def parse(string) return true if string == "true" @@ -103,18 +117,21 @@ module Irc raise ArgumentError, "#{string} does not match either 'true' or 'false'" end end + class BotConfigIntegerValue < BotConfigValue def parse(string) raise ArgumentError, "not an integer: #{string}" unless string =~ /^-?\d+$/ string.to_i end end + class BotConfigFloatValue < BotConfigValue def parse(string) raise ArgumentError, "not a float #{string}" unless string =~ /^-?[\d.]+$/ string.to_f end end + class BotConfigArrayValue < BotConfigValue def parse(string) string.split(/,\s+/) @@ -122,7 +139,17 @@ 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) super @@ -130,7 +157,7 @@ module Irc end def values if @values.instance_of?(Proc) - return @values.call(BotConfig.bot) + return @values.call(@manager.bot) else return @values end @@ -142,31 +169,59 @@ module Irc string end def desc - "#{@desc} [valid values are: " + values.join(", ") + "]" + _("%{desc} [valid values are: %{values}]") % {:desc => @desc, :values => values.join(', ')} end end # container for bot configuration - class BotConfig - # Array of registered BotConfigValues for defaults, types and help - @@items = Hash.new - def BotConfig.items - @@items + class BotConfigManagerClass + + include Singleton + + attr_reader :bot + attr_reader :items + attr_reader :config + attr_accessor :changed + + def initialize + bot_associate(nil,true) end - # Hash containing key => value pairs for lookup and serialisation - @@config = Hash.new(false) - def BotConfig.config - @@config + + def reset_config + @items = Hash.new + @config = Hash.new(false) end - def BotConfig.bot - @@bot + + # Associate with bot _bot_ + def bot_associate(bot, reset=false) + reset_config if reset + @bot = bot + return unless @bot + + @changed = false + if(File.exist?("#{@bot.botclass}/conf.yaml")) + begin + newconfig = YAML::load_file("#{@bot.botclass}/conf.yaml") + newconfig.each { |key, val| + @config[key.to_sym] = 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 + @changed = true + save end - - def BotConfig.register(item) + + def register(item) unless item.kind_of?(BotConfigValue) raise ArgumentError,"item must be a BotConfigValue" end - @@items[item.key] = item + @items[item.key] = item end # currently we store values in a hash but this could be changed in the @@ -174,208 +229,103 @@ module Irc # components that register their config keys and setup defaults are # supported via [] def [](key) - return @@items[key].value if @@items.has_key?(key) + # return @items[key].value if @items.has_key?(key) + return @items[key.to_sym].value if @items.has_key?(key.to_sym) # 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.to_sym) + warning _("Unregistered lookup #{key.to_sym.inspect}") + return @config[key.to_sym] + end return false end # TODO should I implement this via BotConfigValue or leave it direct? # def []=(key, value) # end - + # pass everything else through to the hash def method_missing(method, *args, &block) - return @@config.send(method, *args, &block) - end - - def handle_list(m, params) - modules = [] - if params[:module] - @@items.each_key do |key| - mod, name = key.split('.') - next unless mod == params[:module] - modules.push key unless modules.include?(name) - end - if modules.empty? - m.reply "no such module #{params[:module]}" - else - m.reply modules.join(", ") - end - else - @@items.each_key do |key| - name = key.split('.').first - modules.push name unless modules.include?(name) - end - m.reply "modules: " + modules.join(", ") - end - end - - def handle_get(m, params) - key = params[:key] - unless @@items.has_key?(key) - m.reply "no such config key #{key}" - return - end - value = @@items[key].to_s - m.reply "#{key}: #{value}" - end - - def handle_desc(m, params) - key = params[:key] - unless @@items.has_key?(key) - m.reply "no such config key #{key}" - end - puts @@items[key].inspect - m.reply "#{key}: #{@@items[key].desc}" - end - - def handle_unset(m, params) - key = params[:key] - unless @@items.has_key?(key) - m.reply "no such config key #{key}" - end - @@items[key].unset - handle_get(m, params) + return @config.send(method, *args, &block) end - def handle_set(m, params) - key = params[:key] - value = params[:value].to_s - unless @@items.has_key?(key) - m.reply "no such config key #{key}" + # write current configuration to #{botclass}/conf.yaml + def save + if not @changed + debug "Not writing conf.yaml (unchanged)" return end begin - @@items[key].set_string(value) - rescue ArgumentError => e - m.reply "failed to set #{key}: #{e.message}" - return - end - if @@items[key].requires_restart - m.reply "this config change will take effect on the next restart" - else - m.okay - end - 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" - when "list" - m.reply "config list => list configuration modules, config list => list configuration keys for module " - when "get" - m.reply "config get => get configuration value for key " - when "unset" - m.reply "reset key to the default" - when "set" - m.reply "config set => set configuration value for key to " - when "desc" - m.reply "config desc => describe what key configures" - else - m.reply "no help for config #{topic}" - end - end - def usage(m,params) - m.reply "incorrect usage, try '#{@@bot.nick}: help config'" - end - - # bot:: parent bot class - # create a new config hash from #{botclass}/conf.rbot - def initialize(bot) - @@bot = bot - - # respond to config messages, to provide runtime configuration - # management - # messages will be: - # get - # set - # unset - # desc - # and for arrays: - # add TODO - # remove TODO - @handler = MessageMapper.new(self) - @handler.map 'config list :module', :action => 'handle_list', - :defaults => {:module => false} - @handler.map 'config get :key', :action => 'handle_get' - @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 unset :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")) - begin - newconfig = YAML::load_file("#{@@bot.botclass}/conf.yaml") - @@config.update newconfig - return - rescue - $stderr.puts "failed to read conf.yaml: #{$!}" + 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") + @changed = false + rescue => e + error "failed to write configuration file conf.yaml! #{$!}" + error "#{e.class}: #{e}" + error e.backtrace.join("\n") end - # if we got here, we need to run the first-run wizard - BotConfigWizard.new(@@bot).run - # save newly created config - save end + end - # write current configuration to #{botclass}/conf.rbot - def save - begin - File.open("#{@@bot.botclass}/conf.yaml.new", "w") do |file| - file.puts @@config.to_yaml - end - File.rename("#{@@bot.botclass}/conf.yaml.new", - "#{@@bot.botclass}/conf.yaml") - rescue - $stderr.puts "failed to write configuration file conf.yaml! #{$!}" - end + module BotConfig + # Returns the only BotConfigManagerClass + # + def BotConfig.configmanager + return BotConfigManagerClass.instance end - def privmsg(m) - @handler.handle(m) + # Register a config value + def BotConfig.register(item) + BotConfig.configmanager.register(item) end end class BotConfigWizard def initialize(bot) @bot = bot - @questions = BotConfig.items.values.find_all {|i| i.wizard } + @manager = BotConfig::configmanager + @questions = @manager.items.values.find_all {|i| i.wizard } end - + def run() - puts "First time rbot configuration wizard" + puts _("First time rbot configuration wizard") puts "====================================" - puts "This is the first time you have run rbot with a config directory of:" - puts @bot.botclass - puts "This wizard will ask you a few questions to get you started." - puts "The rest of rbot's configuration can be manipulated via IRC once" - puts "rbot is connected and you are auth'd." + puts _("This is the first time you have run rbot with a config directory of: #{@bot.botclass}") + puts _("This wizard will ask you a few questions to get you started.") + puts _("The rest of rbot's configuration can be manipulated via IRC once rbot is connected and you are auth'd.") puts "-----------------------------------" return unless @questions @questions.sort{|a,b| a.order <=> b.order }.each do |q| - puts q.desc + 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? q.set_string response, false end - puts "configured #{q.key} => #{q.to_s}" + puts _("configured #{q.key} => #{q.to_s}") puts "-----------------------------------" rescue ArgumentError => e - puts "failed to set #{q.key}: #{e.message}" + puts _("failed to set #{q.key}: #{e.message}") retry end end end end + end