X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fconfig.rb;h=e6145a82ee95637d6a31528bf2a89598c6e0e1b8;hb=6355305f4375b72b457d66304ac001c7bd89144c;hp=ef079429ed0f459d305773d4298c0cf60fcf3530;hpb=a3dc8d973b49d6a4bf1446093c194aed5f69916f;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git

diff --git a/lib/rbot/config.rb b/lib/rbot/config.rb
index ef079429..e6145a82 100644
--- a/lib/rbot/config.rb
+++ b/lib/rbot/config.rb
@@ -1,20 +1,23 @@
 require 'singleton'
 
-module Irc
-
-  require 'yaml'
+require 'yaml'
 
-  unless YAML.respond_to?(:load_file)
-      def YAML.load_file( filepath )
-        File.open( filepath ) do |f|
-          YAML::load( f )
-        end
-      end
+unless YAML.respond_to?(:load_file)
+  def YAML.load_file( filepath )
+    File.open( filepath ) do |f|
+      YAML::load( f )
+    end
   end
+end
+
 
-  class BotConfigValue
+module Irc
+
+class Bot
+module Config
+  class Value
     # allow the definition order to be preserved so that sorting by
-    # definition order is possible. The BotConfigWizard does this to allow
+    # definition order is possible. The Wizard does this to allow
     # the :wizard questions to be in a sensible order.
     @@order = 0
     attr_reader :type
@@ -27,7 +30,7 @@ module Irc
     attr_reader :manager
     attr_reader :auth_path
     def initialize(key, params)
-      @manager = BotConfig::configmanager
+      @manager = Config.manager
       # 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.
@@ -37,7 +40,9 @@ module Irc
       @order = @@order
       @@order += 1
       @key = key.to_sym
-      if params.has_key? :default
+      if @manager.overrides.key?(@key)
+        @default = @manager.overrides[@key]
+      elsif params.has_key? :default
         @default = params[:default]
       else
         @default = false
@@ -60,15 +65,20 @@ module Irc
     end
     def get
       return @manager.config[@key] if @manager.config.has_key?(@key)
-      return @default
+      return default
     end
     alias :value :get
     def set(value, on_change = true)
       @manager.config[@key] = value
+      @manager.changed = true
       @on_change.call(@manager.bot, value) if on_change && @on_change
+      return self
     end
     def unset
       @manager.config.delete(@key)
+      @manager.changed = true
+      @on_change.call(@manager.bot, value) if @on_change
+      return self
     end
 
     # set string will raise ArgumentErrors on failed parse/validate
@@ -90,46 +100,81 @@ module Irc
       get.to_s
     end
 
-    private
-    def validate(value)
-      return true unless @validate
-      if @validate.instance_of?(Proc)
-        return @validate.call(value)
-      elsif @validate.instance_of?(Regexp)
-        raise ArgumentError, "validation via Regexp only supported for strings!" unless value.instance_of? String
-        return @validate.match(value)
+    protected
+    def validate(val, validator  = @validate)
+      case validator
+      when false, nil
+        return true
+      when Proc
+        return validator.call(val)
+      when Regexp
+        raise ArgumentError, "validation via Regexp only supported for strings!" unless String === val
+        return validator.match(val)
       else
-        raise ArgumentError, "validation type #{@validate.class} not supported"
+        raise ArgumentError, "validation type #{validator.class} not supported"
       end
     end
   end
 
-  class BotConfigStringValue < BotConfigValue
+  class StringValue < Value
   end
 
-  class BotConfigBooleanValue < BotConfigValue
+  class BooleanValue < Value
     def parse(string)
       return true if string == "true"
       return false if string == "false"
-      raise ArgumentError, "#{string} does not match either 'true' or 'false'"
+      if string =~ /^-?\d+$/
+        return string.to_i != 0
+      end
+      raise ArgumentError, "#{string} does not match either 'true' or 'false', and it's not an integer either"
+    end
+    def get
+      r = super
+      if r.kind_of?(Integer)
+        return r != 0
+      else
+        return r
+      end
     end
   end
 
-  class BotConfigIntegerValue < BotConfigValue
+  class IntegerValue < Value
     def parse(string)
+      return 1 if string == "true"
+      return 0 if string == "false"
       raise ArgumentError, "not an integer: #{string}" unless string =~ /^-?\d+$/
       string.to_i
     end
+    def get
+      r = super
+      if r.kind_of?(Integer)
+        return r
+      else
+        return r ? 1 : 0
+      end
+    end
   end
 
-  class BotConfigFloatValue < BotConfigValue
+  class FloatValue < Value
     def parse(string)
       raise ArgumentError, "not a float #{string}" unless string =~ /^-?[\d.]+$/
       string.to_f
     end
   end
 
-  class BotConfigArrayValue < BotConfigValue
+  class ArrayValue < Value
+    def initialize(key, params)
+      super
+      @validate_item = params[:validate_item]
+      @validate ||= Proc.new do |v|
+        !v.find { |i| !validate_item(i) }
+      end
+    end
+
+    def validate_item(item)
+      validate(item, @validate_item)
+    end
+
     def parse(string)
       string.split(/,\s+/)
     end
@@ -137,8 +182,13 @@ module Irc
       get.join(", ")
     end
     def add(val)
-      curval = self.get
-      set(curval + [val]) unless curval.include?(val)
+      newval = self.get.dup
+      unless newval.include? val
+        newval << val
+        validate_item(val) or raise ArgumentError, "invalid item: #{val}"
+        validate(newval) or raise ArgumentError, "invalid value: #{newval.inspect}"
+        set(newval)
+      end
     end
     def rm(val)
       curval = self.get
@@ -147,7 +197,7 @@ module Irc
     end
   end
 
-  class BotConfigEnumValue < BotConfigValue
+  class EnumValue < Value
     def initialize(key, params)
       super
       @values = params[:values]
@@ -166,18 +216,20 @@ 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 BotConfigManagerClass
+  class ManagerClass
 
     include Singleton
 
     attr_reader :bot
     attr_reader :items
     attr_reader :config
+    attr_reader :overrides
+    attr_accessor :changed
 
     def initialize
       bot_associate(nil,true)
@@ -186,6 +238,21 @@ module Irc
     def reset_config
       @items = Hash.new
       @config = Hash.new(false)
+
+      # We allow default values for config keys to be overridden by
+      # the config file /etc/rbot.conf
+      # The main purpose for this is to allow distro or system-wide
+      # settings such as external program paths (figlet, toilet, ispell)
+      # to be set once for all the bots.
+      @overrides = Hash.new
+      etcfile = "/etc/rbot.conf"
+      if File.exist?(etcfile)
+        log "Loading defaults from #{etcfile}"
+        etcconf = YAML::load_file(etcfile)
+        etcconf.each { |k, v|
+          @overrides[k.to_sym] = v
+        }
+      end
     end
 
     # Associate with bot _bot_
@@ -194,9 +261,11 @@ module Irc
       @bot = bot
       return unless @bot
 
-      if(File.exist?("#{@bot.botclass}/conf.yaml"))
+      @changed = false
+      conf = @bot.path 'conf.yaml'
+      if File.exist? conf
         begin
-          newconfig = YAML::load_file("#{@bot.botclass}/conf.yaml")
+          newconfig = YAML::load_file conf
           newconfig.each { |key, val|
             @config[key.to_sym] = val
           }
@@ -206,14 +275,15 @@ module Irc
         end
       end
       # if we got here, we need to run the first-run wizard
-      BotConfigWizard.new(@bot).run
+      Wizard.new(@bot).run
       # save newly created config
+      @changed = true
       save
     end
 
     def register(item)
-      unless item.kind_of?(BotConfigValue)
-        raise ArgumentError,"item must be a BotConfigValue"
+      unless item.kind_of?(Value)
+        raise ArgumentError,"item must be an Irc::Bot::Config::Value"
       end
       @items[item.key] = item
     end
@@ -232,15 +302,19 @@ module Irc
       #        return @config[key]
       #      end
       if @config.has_key?(key.to_sym)
-        warning "Unregistered lookup #{key.to_sym.inspect}"
+        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
+    def []=(key, value)
+      return @items[key.to_sym].set(value) if @items.has_key?(key.to_sym)
+      if @config.has_key?(key.to_sym)
+        warning _("Unregistered lookup #{key.to_sym.inspect}")
+        return @config[key.to_sym] = value
+      end
+    end
 
     # pass everything else through to the hash
     def method_missing(method, *args, &block)
@@ -249,9 +323,15 @@ module Irc
 
     # write current configuration to #{botclass}/conf.yaml
     def save
+      if not @changed
+        debug "Not writing conf.yaml (unchanged)"
+        return
+      end
       begin
+	conf = @bot.path 'conf.yaml'
+	fnew = conf + '.new'
         debug "Writing new conf.yaml ..."
-        File.open("#{@bot.botclass}/conf.yaml.new", "w") do |file|
+        File.open(fnew, "w") do |file|
           savehash = {}
           @config.each { |key, val|
             savehash[key.to_s] = val
@@ -259,8 +339,8 @@ module Irc
           file.puts savehash.to_yaml
         end
         debug "Officializing conf.yaml ..."
-        File.rename("#{@bot.botclass}/conf.yaml.new",
-                    "#{@bot.botclass}/conf.yaml")
+        File.rename(fnew, conf)
+        @changed = false
       rescue => e
         error "failed to write configuration file conf.yaml! #{$!}"
         error "#{e.class}: #{e}"
@@ -269,39 +349,36 @@ module Irc
     end
   end
 
-  module BotConfig
-    # Returns the only BotConfigManagerClass
-    #
-    def BotConfig.configmanager
-      return BotConfigManagerClass.instance
-    end
+  # Returns the only Irc::Bot::Config::ManagerClass
+  #
+  def Config.manager
+    return ManagerClass.instance
+  end
 
-    # Register a config value
-    def BotConfig.register(item)
-      BotConfig.configmanager.register(item)
-    end
+  # Register a config value
+  def Config.register(item)
+    Config.manager.register(item)
   end
 
-  class BotConfigWizard
+  class Wizard
     def initialize(bot)
       @bot = bot
-      @manager = BotConfig::configmanager
+      @manager = Config.manager
       @questions = @manager.items.values.find_all {|i| i.wizard }
     end
 
     def run()
-      puts "First time rbot configuration wizard"
+      $stdout.sync = true
+      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.to_s + " [#{q.to_s}]: "
           response = STDIN.gets
@@ -309,10 +386,10 @@ module Irc
           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
@@ -320,3 +397,5 @@ module Irc
   end
 
 end
+end
+end