rbot 0.9.14 → 0.9.15

data/lib/rbot/ircbot.rb

@@ -23,7 +23,7 @@ $log_thread = nil
 
 require 'pp'
 
-unless Kernel.instance_methods.include?("pretty_inspect")
+unless Kernel.respond_to? :pretty_inspect
   def pretty_inspect
     PP.pp(self, '')
   end
@@ -41,6 +41,9 @@ class Exception
   end
 end
 
+class ServerError < RuntimeError
+end
+
 def rawlog(level, message=nil, who_pos=1)
   call_stack = caller
   if call_stack.length > who_pos
@@ -132,6 +135,12 @@ $interrupted = 0
 
 # these first
 require 'rbot/rbotconfig'
+begin
+  require 'rubygems'
+rescue LoadError
+  log "rubygems unavailable"
+end
+
 require 'rbot/load-gettext'
 require 'rbot/config'
 require 'rbot/config-compat'
@@ -144,8 +153,6 @@ require 'rbot/timer'
 require 'rbot/plugins'
 require 'rbot/message'
 require 'rbot/language'
-require 'rbot/dbhash'
-require 'rbot/registry'
 
 module Irc
 
@@ -202,11 +209,16 @@ class Bot
     @client.user
   end
 
-  # bot User in the client/server connection
+  # bot nick in the client/server connection
   def nick
     myself.nick
   end
 
+  # bot channels in the client/server connection
+  def channels
+    myself.channels
+  end
+
   # nick wanted by the bot. This defaults to the irc.nick config value,
   # but may be overridden by a manual !nick command
   def wanted_nick
@@ -303,6 +315,9 @@ class Bot
     Config.register Config::ArrayValue.new('irc.ignore_users',
       :default => [],
       :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
+    Config.register Config::ArrayValue.new('irc.ignore_channels',
+      :default => [],
+      :desc => "Which channels to ignore input in. This is mainly to turn the bot into a logbot that doesn't interact with users in any way (in the specified channels)")
 
     Config.register Config::IntegerValue.new('core.save_every',
       :default => 60, :validate => Proc.new{|v| v >= 0},
@@ -395,6 +410,19 @@ class Bot
         bot.set_default_send_options :truncate_text => v.dup
       },
       :desc => "When truncating overlong messages (see send.overlong) or when sending too many lines per message (see send.max_lines) replace the end of the last line with this text")
+    Config.register Config::IntegerValue.new('send.penalty_pct',
+      :default => 100,
+      :validate => Proc.new { |v| v >= 0 },
+      :on_change => Proc.new { |bot, v|
+        bot.socket.penalty_pct = v
+      },
+      :desc => "Percentage of IRC penalty to consider when sending messages to prevent being disconnected for excess flood. Set to 0 to disable penalty control.")
+    Config.register Config::StringValue.new('core.db',
+      :default => "bdb",
+      :wizard => true, :default => "bdb",
+      :validate => Proc.new { |v| ["bdb", "tc"].include? v },
+      :requires_restart => true,
+      :desc => "DB adaptor to use for storing settings and plugin data. Options are: bdb (Berkeley DB, stable adaptor, but troublesome to install and unmaintained), tc (Tokyo Cabinet, new adaptor, fast and furious, but may be not available and contain bugs)")
 
     @argv = params[:argv]
     @run_dir = params[:run_dir] || Dir.pwd
@@ -424,36 +452,25 @@ class Bot
           botclass.gsub!("\\","/")
         end
       end
-      botclass += "/.rbot"
+      botclass = File.join(botclass, ".rbot")
     end
     botclass = File.expand_path(botclass)
     @botclass = botclass.gsub(/\/$/, "")
 
-    if FileTest.directory? botclass
-      # compare the templates dir with the current botclass, and fill it in with
-      # any missing file.
-      # Sadly, FileUtils.cp_r doesn't have an :update option, so we have to do it
-      # manually
-      template = File.join Config::datadir, 'templates'
-      # note that we use the */** pattern because we don't want to match
-      # keywords.rbot, which gets deleted on load and would therefore be missing always
-      missing = Dir.chdir(template) { Dir.glob('*/**') } - Dir.chdir(botclass) { Dir.glob('*/**') }
-      missing.map do |f|
-        dest = File.join(botclass, f)
-        FileUtils.mkdir_p File.dirname dest
-        FileUtils.cp File.join(template, f), dest
-      end
-    else
-      log "no #{botclass} directory found, creating from templates.."
-      if FileTest.exist? botclass
-        error "file #{botclass} exists but isn't a directory"
-        exit 2
-      end
-      FileUtils.cp_r Config::datadir+'/templates', botclass
-    end
+    repopulate_botclass_directory
 
-    Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
-    Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
+    registry_dir = File.join(@botclass, 'registry')
+    Dir.mkdir(registry_dir) unless File.exist?(registry_dir)
+    unless FileTest.directory? registry_dir
+      error "registry storage location #{registry_dir} is not a directory"
+      exit 2
+    end
+    save_dir = File.join(@botclass, 'safe_save')
+    Dir.mkdir(save_dir) unless File.exist?(save_dir)
+    unless FileTest.directory? save_dir
+      error "safe save location #{save_dir} is not a directory"
+      exit 2
+    end
 
     # Time at which the last PING was sent
     @last_ping = nil
@@ -474,10 +491,20 @@ class Bot
     if @config['core.run_as_daemon']
       $daemonize = true
     end
+    case @config["core.db"]
+      when "bdb"
+        require 'rbot/registry/bdb'
+      when "tc"
+         require 'rbot/registry/tc'
+      else
+        raise _("Unknown DB adaptor: %s") % @config["core.db"]
+    end
 
     @logfile = @config['log.file']
     if @logfile.class!=String || @logfile.empty?
-      @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
+      logfname =  File.basename(botclass).gsub(/^\.+/,'')
+      logfname << ".log"
+      @logfile = File.join(botclass, logfname)
       debug "Using `#{@logfile}' as debug log"
     end
 
@@ -536,7 +563,7 @@ class Bot
       end
     end
 
-    File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
+    File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf|
       pf << "#{$$}\n"
     end
 
@@ -566,7 +593,6 @@ class Bot
     @auth.everyone.set_default_permission("*", true)
     @auth.botowner.password= @config['auth.password']
 
-    Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
     @plugins = Plugins::manager
     @plugins.bot_associate(self)
     setup_plugins_path()
@@ -581,7 +607,7 @@ class Bot
         debug "server.list is now #{@config['server.list'].inspect}"
     end
 
-    @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], :ssl => @config['server.ssl'])
+    @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], :ssl => @config['server.ssl'], :penalty_pct =>@config['send.penalty_pct'])
     @client = Client.new
 
     @plugins.scan
@@ -629,11 +655,18 @@ class Bot
       # debug "Message target is #{data[:target].inspect}"
       # debug "Bot is #{myself.inspect}"
 
+      @config['irc.ignore_channels'].each { |channel|
+        if m.target.downcase == channel.downcase
+          m.ignored = true
+          break
+        end
+      }
       @config['irc.ignore_users'].each { |mask|
         if m.source.matches?(server.new_netmask(mask))
           m.ignored = true
+          break
         end
-      }
+      } unless m.ignored
 
       @plugins.irc_delegate('privmsg', m)
     }
@@ -736,6 +769,18 @@ class Bot
       m.users = data[:users]
       @plugins.delegate "names", m
     }
+    @client[:banlist] = proc { |data|
+      m = BanlistMessage.new(self, server, server, data[:channel])
+      m.bans = data[:bans]
+      @plugins.delegate "banlist", m
+    }
+    @client[:nosuchtarget] = proc { |data|
+      m = NoSuchTargetMessage.new(self, server, server, data[:target], data[:message])
+      @plugins.delegate "nosuchtarget", m
+    }
+    @client[:error] = proc { |data|
+      raise ServerError, data[:message]
+    }
     @client[:unknown] = proc { |data|
       #debug "UNKNOWN: #{data[:serverstring]}"
       m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
@@ -753,15 +798,54 @@ class Bot
     trap_sigs
   end
 
+  def repopulate_botclass_directory
+    template_dir = File.join Config::datadir, 'templates'
+    if FileTest.directory? @botclass
+      # compare the templates dir with the current botclass dir, filling up the
+      # latter with any missing file. Sadly, FileUtils.cp_r doesn't have an
+      # :update option, so we have to do it manually.
+      # Note that we use the */** pattern because we don't want to match
+      # keywords.rbot, which gets deleted on load and would therefore be missing
+      # always
+      missing = Dir.chdir(template_dir) { Dir.glob('*/**') } - Dir.chdir(@botclass) { Dir.glob('*/**') }
+      missing.map do |f|
+        dest = File.join(@botclass, f)
+        FileUtils.mkdir_p(File.dirname(dest))
+        FileUtils.cp File.join(template_dir, f), dest
+      end
+    else
+      log "no #{@botclass} directory found, creating from templates..."
+      if FileTest.exist? @botclass
+        error "file #{@botclass} exists but isn't a directory"
+        exit 2
+      end
+      FileUtils.cp_r template_dir, @botclass
+    end
+  end
+
+  # Return a path under the current botclass by joining the mentioned
+  # components. The components are automatically converted to String
+  def path(*components)
+    File.join(@botclass, *(components.map {|c| c.to_s}))
+  end
+
   def setup_plugins_path
+    plugdir_default = File.join(Config::datadir, 'plugins')
+    plugdir_local = File.join(@botclass, 'plugins')
+    Dir.mkdir(plugdir_local) unless File.exist?(plugdir_local)
+
     @plugins.clear_botmodule_dirs
-    @plugins.add_botmodule_dir(Config::coredir + "/utils")
-    @plugins.add_botmodule_dir(Config::coredir)
-    @plugins.add_botmodule_dir("#{botclass}/plugins")
+    @plugins.add_core_module_dir(File.join(Config::coredir, 'utils'))
+    @plugins.add_core_module_dir(Config::coredir)
+    if FileTest.directory? plugdir_local
+      @plugins.add_plugin_dir(plugdir_local)
+    else
+      warning "local plugin location #{plugdir_local} is not a directory"
+    end
 
     @config['plugins.path'].each do |_|
-        path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
-        @plugins.add_botmodule_dir(path)
+        path = _.sub(/^\(default\)/, plugdir_default)
+        @plugins.add_plugin_dir(path)
     end
   end
 
@@ -782,7 +866,7 @@ class Bot
       }
     end
     @default_send_options.update opts unless opts.empty?
-    end
+  end
 
   # checks if we should be quiet on a channel
   def quiet_on?(channel)
@@ -816,7 +900,8 @@ class Bot
   # things to do when we receive a signal
   def got_sig(sig, func=:quit)
     debug "received #{sig}, queueing #{func}"
-    $interrupted += 1
+    # this is not an interruption if we just need to reconnect
+    $interrupted += 1 unless func == :reconnect
     self.send(func) unless @quit_mutex.locked?
     debug "interrupted #{$interrupted} times"
     if $interrupted >= 3
@@ -832,6 +917,7 @@ class Bot
       trap("SIGINT") { got_sig("SIGINT") }
       trap("SIGTERM") { got_sig("SIGTERM") }
       trap("SIGHUP") { got_sig("SIGHUP", :restart) }
+      trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) }
     rescue ArgumentError => e
       debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
     rescue Exception => e
@@ -841,11 +927,15 @@ class Bot
 
   # connect the bot to IRC
   def connect
+    # make sure we don't have any spurious ping checks running
+    # (and initialize the vars if this is the first time we connect)
+    stop_server_pings
     begin
       quit if $interrupted > 0
       @socket.connect
+      @last_rec = Time.now
     rescue => e
-      raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
+      raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: #{e}"
     end
     quit if $interrupted > 0
 
@@ -859,14 +949,44 @@ class Bot
     myself.user = @config['irc.user']
   end
 
+  # disconnect the bot from IRC, if connected, and then connect (again)
+  def reconnect(message=nil, too_fast=false)
+    # we will wait only if @last_rec was not nil, i.e. if we were connected or
+    # got disconnected by a network error
+    # if someone wants to manually call disconnect() _and_ reconnect(), they
+    # will have to take care of the waiting themselves
+    will_wait = !!@last_rec
+
+    if @socket.connected?
+      disconnect(message)
+    end
+
+    begin
+      if will_wait
+        log "\n\nDisconnected\n\n"
+
+        quit if $interrupted > 0
+
+        log "\n\nWaiting to reconnect\n\n"
+        sleep @config['server.reconnect_wait']
+        sleep 10*@config['server.reconnect_wait'] if too_fast
+      end
+
+      connect
+    rescue Exception => e
+      will_wait = true
+      retry
+    end
+  end
+
   # begin event handling loop
   def mainloop
     while true
+      too_fast = false
       begin
-        quit if $interrupted > 0
-        connect
-
         quit_msg = nil
+        reconnect(quit_msg, too_fast)
+        quit if $interrupted > 0
         while @socket.connected?
           quit if $interrupted > 0
 
@@ -892,6 +1012,11 @@ class Bot
       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
         error "network exception: #{e.pretty_inspect}"
         quit_msg = e.to_s
+      rescue ServerError => e
+        # received an ERROR from the server
+        quit_msg = "server ERROR: " + e.message
+        too_fast = e.message.index("reconnect too fast")
+        retry
       rescue BDB::Fatal => e
         fatal "fatal bdb error: #{e.pretty_inspect}"
         DBTree.stats
@@ -907,15 +1032,6 @@ class Bot
         log_session_end
         exit 2
       end
-
-      disconnect(quit_msg)
-
-      log "\n\nDisconnected\n\n"
-
-      quit if $interrupted > 0
-
-      log "\n\nWaiting to reconnect\n\n"
-      sleep @config['server.reconnect_wait']
     end
   end
 
@@ -926,8 +1042,22 @@ class Bot
   # Type can be PRIVMSG, NOTICE, etc, but those you should really use the
   # relevant say() or notice() methods. This one should be used for IRCd
   # extensions you want to use in modules.
-  def sendmsg(type, where, original_message, options={})
-    opts = @default_send_options.merge(options)
+  def sendmsg(original_type, original_where, original_message, options={})
+
+    # filter message with sendmsg filters
+    ds = DataStream.new original_message.to_s.dup,
+      :type => original_type, :dest => original_where,
+      :options => @default_send_options.merge(options)
+    filters = filter_names(:sendmsg)
+    filters.each do |fname|
+      debug "filtering #{ds[:text]} with sendmsg filter #{fname}"
+      ds.merge! filter(self.global_filter_name(fname, :sendmsg), ds)
+    end
+
+    opts = ds[:options]
+    type = ds[:type]
+    where = ds[:dest]
+    filtered = ds[:text]
 
     # For starters, set up appropriate queue channels and rings
     mchan = opts[:queue_channel]
@@ -948,7 +1078,7 @@ class Bot
       end
     end
 
-    multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
+    multi_line = filtered.gsub(/[\r\n]+/, "\n")
 
     # if target is a channel with nocolor modes, strip colours
     if where.kind_of?(Channel) and where.mode.any?(*config['server.nocolor_modes'])
@@ -1151,7 +1281,9 @@ class Bot
 
   # totally shutdown and respawn the bot
   def restart(message=nil)
-    message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
+    message = _("restarting, back in %{wait}...") % {
+      :wait => @config['server.reconnect_wait']
+    } if (!message || message.empty?)
     shutdown(message)
     sleep @config['server.reconnect_wait']
     begin

data/lib/rbot/ircsocket.rb

@@ -48,8 +48,14 @@ class ::String
       dests = pars.split($;,2).first
       penalty += dests.split(',').size
     when :WHO
-      # I'm too lazy to implement this one correctly
-      penalty += 5
+      args = pars.split
+      if args.length > 0
+        penalty += args.inject(0){ |sum,x| sum += ((x.length > 4) ? 3 : 5) }
+      else
+        penalty += 10
+      end
+    when :PART
+      penalty += 4
     when :AWAY, :JOIN, :VERSION, :TIME, :TRACE, :WHOIS, :DNS
       penalty += 2
     when :INVITE, :NICK
@@ -246,6 +252,9 @@ module Irc
     # normalized uri of the current server
     attr_reader :server_uri
 
+    # penalty multiplier (percent)
+    attr_accessor :penalty_pct
+
     # default trivial filter class
     class IdentityFilter
         def in(x)
@@ -275,11 +284,8 @@ module Irc
       @spooler = false
       @lines_sent = 0
       @lines_received = 0
-      if opts.kind_of?(Hash) and opts.key?(:ssl)
-        @ssl = opts[:ssl]
-      else
-        @ssl = false
-      end
+      @ssl = opts[:ssl]
+      @penalty_pct = opts[:penalty_pct] || 100
     end
 
     def connected?
@@ -437,7 +443,7 @@ module Irc
           @sock.syswrite actual
           @last_send = now
           @flood_send = now if @flood_send < now
-          @flood_send += message.irc_send_penalty if penalty
+          @flood_send += message.irc_send_penalty*@penalty_pct/100.0 if penalty
           @lines_sent += 1
         end
       rescue Exception => e