rbot 0.9.14 → 0.9.15

data/lib/rbot/config.rb

@@ -186,7 +186,7 @@ module Config
       unless newval.include? val
         newval << val
         validate_item(val) or raise ArgumentError, "invalid item: #{val}"
-        validate(newval) or raise ArgumentError, "invalid value: #{newval.to_s}"
+        validate(newval) or raise ArgumentError, "invalid value: #{newval.inspect}"
         set(newval)
       end
     end
@@ -262,9 +262,10 @@ module Config
       return unless @bot
 
       @changed = false
-      if(File.exist?("#{@bot.botclass}/conf.yaml"))
+      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
           }
@@ -327,8 +328,10 @@ module Config
         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
@@ -336,8 +339,7 @@ module Config
           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! #{$!}"

data/lib/rbot/core/auth.rb

@@ -160,7 +160,7 @@ class AuthModule < CoreBotModule
   def auth_view_perm(m, params)
     begin
       if params[:user].nil?
-        user = get_botusername_for(m.source)
+        user = get_botuser_for(m.source)
         return m.reply(_("you are owner, you can do anything")) if user.owner?
       else
         user = @bot.auth.get_botuser(params[:user].sub(/^all$/,"everyone"))
@@ -242,23 +242,27 @@ class AuthModule < CoreBotModule
       where = m.parse_channel_list(p[:where].to_s).first # should only be one anyway
     end
 
-    # pseudo-message to find the template. The source is ignored, and the
-    # target is set according to where the template should be checked
-    # (public or private)
-    # This might still fail in the case of 'everywhere' for commands there are
-    # really only private
-    case where
-    when :"?"
-      pseudo_target = @bot.myself
-    when :*
-      pseudo_target = m.channel
+    if p.has_key? :auth_path
+      auth_path = p[:auth_path]
     else
-      pseudo_target = m.server.channel(where)
-    end
+      # pseudo-message to find the template. The source is ignored, and the
+      # target is set according to where the template should be checked
+      # (public or private)
+      # This might still fail in the case of 'everywhere' for commands there are
+      # really only private
+      case where
+      when :"?"
+        pseudo_target = @bot.myself
+      when :*
+        pseudo_target = m.channel
+      else
+        pseudo_target = m.server.channel(where)
+      end
 
-    pseudo = PrivMessage.new(bot, m.server, m.source, pseudo_target, p[:stuff].to_s)
+      pseudo = PrivMessage.new(bot, m.server, m.source, pseudo_target, p[:stuff].to_s)
 
-    auth_path = find_auth(pseudo)
+      auth_path = find_auth(pseudo)
+    end
     debug auth_path
 
     if auth_path
@@ -407,9 +411,21 @@ class AuthModule < CoreBotModule
     when "hello"
       return _("hello: creates a bot user for the person issuing the command")
     when "allow"
-      return _("allow <user> to do <sample command> [<where>]: gives botuser <user> the permissions to execute a command such as the provided sample command (in private or in channel, according to the optional <where>)")
+      return [
+        _("allow <user> to do <sample command> [<where>]: gives botuser <user> the permissions to execute a command such as the provided sample command"),
+        _("(in private or in channel, according to the optional <where>)."),
+        _("<sample command> should be a full command, not just the command keyword --"),
+        _("correct: allow user to do addquote stuff --"),
+        _("wrong: allow user to do addquote.")
+      ].join(" ")
     when "deny"
-      return _("deny <user> from doing <sample command> [<where>]: removes from botuser <user> the permissions to execute a command such as the provided sample command (in private or in channel, according to the optional <where>)")
+      return [
+        _("deny <user> from doing <sample command> [<where>]: removes from botuser <user> the permissions to execute a command such as the provided sample command"),
+        _("(in private or in channel, according to the optional <where>)."),
+        _("<sample command> should be a full command, not just the command keyword --"),
+        _("correct: deny user from doing addquote stuff --"),
+        _("wrong: deny user from doing addquote.")
+      ].join(" ")
     else
       return _("auth commands: auth, login, whoami, who, permission[s], user, meet, hello, allow, deny")
     end
@@ -801,13 +817,13 @@ class AuthModule < CoreBotModule
 
   def auth_export(m, params)
 
-    exportfile = "#{@bot.botclass}/new-auth.users"
+    exportfile = @bot.path "new-auth.users"
 
     what = params[:things]
 
     has_to = what[-2] == "to"
     if has_to
-      exportfile = "#{@bot.botclass}/#{what[-1]}"
+      exportfile = @bot.path what[-1]
       what.slice!(-2,2)
     end
 
@@ -873,13 +889,13 @@ class AuthModule < CoreBotModule
 
   def auth_import(m, params)
 
-    importfile = "#{@bot.botclass}/new-auth.users"
+    importfile = @bot.path "new-auth.users"
 
     what = params[:things]
 
     has_from = what[-2] == "from"
     if has_from
-      importfile = "#{@bot.botclass}/#{what[-1]}"
+      importfile = @bot.path what[-1]
       what.slice!(-2,2)
     end
 

data/lib/rbot/core/basics.rb

@@ -30,7 +30,11 @@ class BasicsModule < CoreBotModule
   # identification. Observe that this means the bot may not connect any channels
   # until the 'identified' method gets delegated
   def connect
-    join_channels unless @bot.config['irc.join_after_identify']
+    if @bot.config['irc.join_after_identify']
+      log "waiting for identififcation before JOINing default channels"
+    else
+      join_channels
+    end
   end
 
   def ctcp_listen(m)
@@ -65,6 +69,20 @@ class BasicsModule < CoreBotModule
     end
   end
 
+  def bot_channel_list(m, param)
+    ret = _('I am in: ')
+    # sort the channels by the base name and then map with prefixes for the
+    # mode and display.
+    ret << @bot.channels.compact.sort { |a,b|
+        a.name.downcase <=> b.name.downcase
+    }.map { |c|
+        c.modes_of(@bot.myself).map{ |mo|
+          m.server.prefix_for_mode(mo)
+        }.to_s + c.name
+    }.join(', ')
+    m.reply ret
+  end
+
   def bot_quit(m, param)
     @bot.quit param[:msg].to_s
   end
@@ -73,6 +91,10 @@ class BasicsModule < CoreBotModule
     @bot.restart param[:msg].to_s
   end
 
+  def bot_reconnect(m, param)
+    @bot.reconnect param[:msg].to_s
+  end
+
   def bot_hide(m, param)
     @bot.join 0
   end
@@ -133,6 +155,8 @@ class BasicsModule < CoreBotModule
       _("quit [<message>] => quit IRC with message <message>")
     when "restart"
       _("restart => completely stop and restart the bot (including reconnect)")
+    when "reconnect"
+      _("reconnect => ask the bot to disconnect and then connect again")
     when "join"
       _("join <channel> [<key>] => join channel <channel> with secret key <key> if specified. #{@bot.myself} also responds to invites if you have the required access level")
     when "part"
@@ -172,6 +196,10 @@ basics.map "restart *msg",
   :action => 'bot_restart',
   :defaults => { :msg => nil },
   :auth_path => 'quit'
+basics.map "reconnect *msg",
+  :action => 'bot_reconnect',
+  :defaults => { :msg => nil },
+  :auth_path => 'quit'
 
 basics.map "quiet [in] [:where]",
   :action => 'bot_quiet',
@@ -190,7 +218,7 @@ basics.map "mode :where :what *who",
   :action => 'bot_mode',
   :auth_path => 'talk::do'
 
-basics.map "join :chan :pass", 
+basics.map "join :chan :pass",
   :action => 'bot_join',
   :defaults => {:pass => nil},
   :auth_path => 'move'
@@ -198,6 +226,9 @@ basics.map "part :chan",
   :action => 'bot_part',
   :defaults => {:chan => nil},
   :auth_path => 'move'
+basics.map "channels",
+  :action => 'bot_channel_list',
+  :auth_path => 'move'
 basics.map "hide",
   :action => 'bot_hide',
   :auth_path => 'move'

data/lib/rbot/core/config.rb

@@ -122,7 +122,7 @@ class ConfigModule < CoreBotModule
 
   def handle_add(m, params)
     key = params[:key].to_s.intern
-    value = params[:value]
+    values = params[:value].to_s.split(/,\s+/)
     unless @bot.config.items.has_key?(key)
       m.reply _("no such config key %{key}") % {:key => key}
       return
@@ -132,11 +132,13 @@ class ConfigModule < CoreBotModule
       return
     end
     return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
-    begin
-      @bot.config.items[key].add(value)
-    rescue ArgumentError => e
-      m.reply _("failed to add %{value} to %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
-      return
+    values.each do |value|
+      begin
+        @bot.config.items[key].add(value)
+      rescue ArgumentError => e
+        m.reply _("failed to add %{value} to %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
+        next
+      end
     end
     handle_get(m,{:key => key})
     m.reply _("this config change will take effect on the next restart") if @bot.config.items[key].requires_restart
@@ -145,7 +147,7 @@ class ConfigModule < CoreBotModule
 
   def handle_rm(m, params)
     key = params[:key].to_s.intern
-    value = params[:value]
+    values = params[:value].to_s.split(/,\s+/)
     unless @bot.config.items.has_key?(key)
       m.reply _("no such config key %{key}") % {:key => key}
       return
@@ -155,11 +157,13 @@ class ConfigModule < CoreBotModule
       return
     end
     return if !@bot.auth.allow?(@bot.config.items[key].auth_path, m.source, m.replyto)
-    begin
-      @bot.config.items[key].rm(value)
-    rescue ArgumentError => e
-      m.reply _("failed to remove %{value} from %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
-      return
+    values.each do |value|
+      begin
+        @bot.config.items[key].rm(value)
+      rescue ArgumentError => e
+        m.reply _("failed to remove %{value} from %{key}: %{error}") % {:value => value, :key => key, :error => e.message}
+        next
+      end
     end
     handle_get(m,{:key => key})
     m.reply _("this config change will take effect on the next restart") if @bot.config.items[key].requires_restart
@@ -228,7 +232,7 @@ class ConfigModule < CoreBotModule
       when "desc"
       _("config desc <key> => describe what key <key> configures")
       when "add"
-      _("config add <value> to <key> => add value <value> to key <key> if <key> is an array")
+      _("config add <values> to <key> => add values <values> to key <key> if <key> is an array")
       when "rm"
       _("config rm <value> from <key> => remove value <value> from key <key> if <key> is an array")
       else
@@ -296,16 +300,19 @@ conf.map "version",
 conf.map 'config set :key *value',
   :action => 'handle_set',
   :auth_path => 'edit'
-conf.map 'config add :value to :key',
+conf.map 'config add *value to :key',
   :action => 'handle_add',
   :auth_path => 'edit'
-conf.map 'config rm :value from :key',
+conf.map 'config rm *value from :key',
+  :action => 'handle_rm',
+  :auth_path => 'edit'
+conf.map 'config remove *value from :key',
   :action => 'handle_rm',
   :auth_path => 'edit'
-conf.map 'config del :value from :key',
+conf.map 'config del *value from :key',
   :action => 'handle_rm',
   :auth_path => 'edit'
-conf.map 'config delete :value from :key',
+conf.map 'config delete *value from :key',
   :action => 'handle_rm',
   :auth_path => 'edit'
 conf.map 'config unset :key',

data/lib/rbot/core/filters_ui.rb

@@ -27,7 +27,7 @@ class FiltersModule < CoreBotModule
         msg = _("no known filters")
       end
     else
-      msg = _("known filters: ") << ar.join(", ") 
+      msg = _("known filters: ") << ar.join(", ")
     end
     m.reply msg
   end
@@ -37,7 +37,7 @@ class FiltersModule < CoreBotModule
     if ar.empty?
       msg = _("no known filter groups")
     else
-      msg = _("known filter groups: ") << ar.join(", ") 
+      msg = _("known filter groups: ") << ar.join(", ")
     end
     m.reply msg
   end

data/lib/rbot/core/irclog.rb

@@ -23,6 +23,9 @@ class IrcLogModule < CoreBotModule
   Config.register Config::StringValue.new('irclog.filename_format',
     :default => '%%{where}', :requires_rescan => true,
     :desc => "filename pattern for the IRC log. You can put typical strftime keys such as %Y for year and %m for month, plus the special %%{where} key for location (channel name or user nick)")
+  Config.register Config::StringValue.new('irclog.timestamp_format',
+    :default => '[%Y/%m/%d %H:%M:%S]', :requires_rescan => true,
+    :desc => "timestamp pattern for the IRC log, using typical strftime keys")
 
   attr :nolog_rx, :dolog_rx
   def initialize
@@ -30,7 +33,9 @@ class IrcLogModule < CoreBotModule
     @queue = Queue.new
     @thread = Thread.new { loggers_thread }
     @logs = Hash.new
-    Dir.mkdir("#{@bot.botclass}/logs") unless File.exist?("#{@bot.botclass}/logs")
+    logdir = @bot.path 'logs'
+    Dir.mkdir(logdir) unless File.exist?(logdir)
+    # TODO what shall we do if the logdir couldn't be created? (e.g. it existed as a file)
     event_irclog_list_changed(@bot.config['irclog.no_log'], @bot.config['irclog.do_log'])
     @fn_format = @bot.config['irclog.filename_format']
   end
@@ -41,6 +46,10 @@ class IrcLogModule < CoreBotModule
     return true
   end
 
+  def timestamp(time)
+    return time.strftime(@bot.config['irclog.timestamp_format'])
+  end
+
   def event_irclog_list_changed(nolist, dolist)
     @nolog_rx = nolist.empty? ? nil : Regexp.union(*(nolist.map { |r| r.to_irc_regexp }))
     debug "no log: #{@nolog_rx}"
@@ -54,8 +63,8 @@ class IrcLogModule < CoreBotModule
 
   def logfile_close(where_str, reason = 'unknown reason')
     f = @logs.delete(where_str) or return
-    stamp = Time.now.strftime '%Y/%m/%d %H:%M:%S'
-    f[1].puts "[#{stamp}] @ Log closed by #{@bot.myself.nick} (#{reason})"
+    stamp = timestamp(Time.now)
+    f[1].puts "#{stamp} @ Log closed by #{@bot.myself.nick} (#{reason})"
     f[1].close
   end
 
@@ -144,7 +153,7 @@ class IrcLogModule < CoreBotModule
         irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
       end
     else
-      if m.public? 
+      if m.public?
         irclog "<#{m.source}> #{m.logmessage}", m.target
       else
         irclog "<#{m.source}(#{m.sourceaddress})> #{m.logmessage}", m.source
@@ -237,7 +246,7 @@ class IrcLogModule < CoreBotModule
   end
 
   def logfilepath(where_str, now)
-    File.join(@bot.botclass, 'logs', now.strftime(@fn_format) % { :where => where_str })
+    @bot.path('logs', now.strftime(@fn_format) % { :where => where_str })
   end
 
   protected
@@ -248,13 +257,13 @@ class IrcLogModule < CoreBotModule
       message, where = ls
       message = message.chomp
       now = Time.now
-      stamp = now.strftime("%Y/%m/%d %H:%M:%S")
+      stamp = timestamp(now)
       if where.class <= Server
         where_str = "server"
       else
         where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
       end
-      return unless can_log_on(where_str)
+      next unless can_log_on(where_str)
 
       # close the previous logfile if we're rotating
       if @logs.has_key? where_str
@@ -280,7 +289,7 @@ class IrcLogModule < CoreBotModule
           # If it's a file, we rename to filename.old.filedate
           up = dir.dup
           until File.exist? up
-            up.replace File.dirname up
+            up.replace(File.dirname(up))
           end
           unless File.directory? up
             backup = up.dup
@@ -300,16 +309,16 @@ class IrcLogModule < CoreBotModule
           # it should be fine to create the file now
           f = File.new(fp, "a")
           f.sync = true
-          f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
+          f.puts "#{stamp} @ Log started by #{@bot.myself.nick}"
         rescue Exception => e
           error e
           next
         end
         @logs[where_str] = [now, f]
       end
-      @logs[where_str][1].puts "[#{stamp}] #{message}"
+      @logs[where_str][1].puts "#{stamp} #{message}"
       @logs[where_str][0] = now
-      #debug "[#{stamp}] <#{where}> #{message}"
+      #debug "#{stamp} <#{where}> #{message}"
     end
     @logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
     debug 'loggers_thread terminating'

data/lib/rbot/core/remote.rb

@@ -136,7 +136,7 @@ class Bot
       raise "Botmodule #{botmodule.name} tried to unmap #{tmpl.inspect} that was handled by #{tmpl.botmodule}" unless tmpl.botmodule == botmodule.name
       debug "Unmapping #{tmpl.inspect}"
       @templates[handle] = nil
-      @templates.clear unless @templates.nitems > 0
+      @templates.clear unless @templates.compact.size > 0
     end
 
     # We redefine the handle() method from MessageMapper, taking into account
@@ -147,7 +147,7 @@ class Bot
     #
     # Presently, the hash returned on success has only one key, :return, whose
     # value is the actual return value of the successfull dispatch.
-    # 
+    #
     # TODO this same kind of mechanism could actually be used in MessageMapper
     # itself to be able to handle the case of multiple plugins having the same
     # 'first word' ...
@@ -160,19 +160,19 @@ class Bot
         # Skip this element if it was unmapped
         next unless tmpl
         botmodule = @parent.plugins[tmpl.botmodule]
-        options, failure = tmpl.recognize(m)
-        if options.nil?
-          failures << [tmpl, failure]
+        options = tmpl.recognize(m)
+        if options.kind_of? Failure
+          failures << options
         else
           action = tmpl.options[:action]
           unless botmodule.respond_to?(action)
-            failures << [tmpl, "#{botmodule} does not respond to action #{action}"]
+            failures << NoActionFailure.new(tmpl, m)
             next
           end
           auth = tmpl.options[:full_auth_path]
           debug "checking auth for #{auth}"
           # We check for private permission
-          if m.bot.auth.allow?(auth, m.source, '?')
+          if m.bot.auth.permit?(m.source, auth, '?')
             debug "template match found and auth'd: #{action.inspect} #{options.inspect}"
             return :return => botmodule.send(action, m, options)
           end
@@ -182,8 +182,8 @@ class Bot
           return false
         end
       end
-      failures.each {|f, r|
-        debug "#{f.inspect} => #{r}"
+      failures.each {|r|
+        debug "#{r.template.inspect} => #{r}"
       }
       debug "no handler found"
       return false