]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - lib/rbot/ircbot.rb
utils: support hex HTML entities
[user/henk/code/ruby/rbot.git] / lib / rbot / ircbot.rb
index 7a021fb58f94bfa012840fcc57b20c648dfe77df..92f5fe55c88c400601abeb76367f2c8c189cec95 100644 (file)
@@ -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
@@ -135,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'
@@ -147,8 +153,6 @@ require 'rbot/timer'
 require 'rbot/plugins'
 require 'rbot/message'
 require 'rbot/language'
-require 'rbot/dbhash'
-require 'rbot/registry'
 
 module Irc
 
@@ -182,14 +186,14 @@ class Bot
   attr_reader :socket
 
   # bot's object registry, plugins get an interface to this for persistant
-  # storage (hash interface tied to a bdb file, plugins use Accessors to store
+  # storage (hash interface tied to a db file, plugins use Accessors to store
   # and restore objects in their own namespaces.)
   attr_reader :registry
 
   # bot's plugins. This is an instance of class Plugins
   attr_reader :plugins
 
-  # bot's httputil help object, for fetching resources via http. Sets up
+  # bot's httputil helper object, for fetching resources via http. Sets up
   # proxies etc as defined by the bot configuration/environment
   attr_accessor :httputil
 
@@ -205,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
@@ -408,6 +417,12 @@ class Bot
         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
@@ -477,6 +492,15 @@ class Bot
       $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?
       logfname =  File.basename(botclass).gsub(/^\.+/,'')
@@ -708,6 +732,11 @@ class Bot
       m = WhoisMessage.new(self, server, source, target, data[:whois])
       @plugins.delegate "whois", m
     }
+    @client[:list] = proc {|data|
+      source = data[:source]
+      m = ListMessage.new(self, server, source, source, data[:list])
+      @plugins.delegate "irclist", m
+    }
     @client[:join] = proc {|data|
       m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
       sendq("MODE #{data[:channel]}", nil, 0) if m.address?
@@ -746,6 +775,15 @@ 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]
     }
@@ -778,7 +816,7 @@ class Bot
       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.mkdir_p(File.dirname(dest))
         FileUtils.cp File.join(template_dir, f), dest
       end
     else
@@ -834,7 +872,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)
@@ -895,12 +933,18 @@ 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
+    rescue Exception => e
+      uri = @socket.server_uri || '<unknown>'
+      error "failed to connect to IRC server at #{uri}"
+      error e
+      raise
     end
     quit if $interrupted > 0
 
@@ -915,7 +959,7 @@ class Bot
   end
 
   # disconnect the bot from IRC, if connected, and then connect (again)
-  def reconnect(message=nil, too_fast=false)
+  def reconnect(message=nil, too_fast=0)
     # 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
@@ -926,27 +970,45 @@ class Bot
       disconnect(message)
     end
 
-    if will_wait
-      log "\n\nDisconnected\n\n"
+    begin
+      if will_wait
+        log "\n\nDisconnected\n\n"
 
-      quit if $interrupted > 0
+        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
+        log "\n\nWaiting to reconnect\n\n"
+        sleep @config['server.reconnect_wait']
+        if too_fast > 0
+          tf = too_fast*@config['server.reconnect_wait']
+          tfu = Utils.secs_to_string(tf)
+          log "Will sleep for an extra #{tf}s (#{tfu})"
+          sleep tf
+        end
+      end
 
-    connect
+      connect
+    rescue DBFatal => e
+      fatal "fatal db error: #{e.pretty_inspect}"
+      DBTree.stats
+      log_session_end
+      exit 2
+    rescue Exception => e
+      error e
+      will_wait = true
+      retry
+    end
   end
 
   # begin event handling loop
   def mainloop
     while true
-      too_fast = false
+      too_fast = 0
+      quit_msg = nil
+      valid_recv = false # did we receive anything (valid) from the server yet?
       begin
-        quit_msg = nil
         reconnect(quit_msg, too_fast)
         quit if $interrupted > 0
+        valid_recv = false
         while @socket.connected?
           quit if $interrupted > 0
 
@@ -958,6 +1020,8 @@ class Bot
             break unless reply = @socket.gets
             @last_rec = Time.now
             @client.process reply
+            valid_recv = true
+            too_fast = 0
           else
             ping_server
           end
@@ -972,13 +1036,42 @@ class Bot
       rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
         error "network exception: #{e.pretty_inspect}"
         quit_msg = e.to_s
+        too_fast += 10 if valid_recv
+      rescue ServerMessageParseError => e
+        # if the bot tried reconnecting too often, we can get forcefully
+        # disconnected by the server, while still receiving an empty message
+        # wait at least 10 minutes in this case
+        if e.message.empty?
+          oldtf = too_fast
+          too_fast = [too_fast, 300].max
+          too_fast*= 2
+          log "Empty message from server, extra delay multiplier #{oldtf} -> #{too_fast}"
+        end
+        quit_msg = "Unparseable Server Message: #{e.message.inspect}"
+        retry
       rescue ServerError => e
-        # received an ERROR from the server
         quit_msg = "server ERROR: " + e.message
-        too_fast = e.message.index("reconnect too fast")
+        debug quit_msg
+        idx = e.message.index("connect too fast")
+        debug "'connect too fast' @ #{idx}"
+        if idx
+          oldtf = too_fast
+          too_fast += (idx+1)*2
+          log "Reconnecting too fast, extra delay multiplier #{oldtf} -> #{too_fast}"
+        end
+        idx = e.message.index(/a(uto)kill/i)
+        debug "'autokill' @ #{idx}"
+        if idx
+          # we got auto-killed. since we don't have an easy way to tell
+          # if it's permanent or temporary, we just set a rather high
+          # reconnection timeout
+          oldtf = too_fast
+          too_fast += (idx+1)*5
+          log "Killed by server, extra delay multiplier #{oldtf} -> #{too_fast}"
+        end
         retry
-      rescue BDB::Fatal => e
-        fatal "fatal bdb error: #{e.pretty_inspect}"
+      rescue DBFatal => e
+        fatal "fatal db error: #{e.pretty_inspect}"
         DBTree.stats
         # Why restart? DB problems are serious stuff ...
         # restart("Oops, we seem to have registry problems ...")
@@ -1241,7 +1334,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