X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=b039e05d02d6dff13a0eb49e1b1678798d565c5b;hb=3ff83c5a5938ab63b2f5635345d90c375d1172a9;hp=8b4dbaeb127e2b20b2ea89f365f8b0b263a570b8;hpb=c9074f4cab24c624ec1bb43d6b98880416205282;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 8b4dbaeb..b039e05d 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -1,3 +1,4 @@ +# encoding: UTF-8 #-- vim:sw=2:et #++ # @@ -6,24 +7,12 @@ require 'thread' require 'etc' +require 'date' require 'fileutils' -require 'logger' - -$debug = false unless $debug -$daemonize = false unless $daemonize - -$dateformat = "%Y/%m/%d %H:%M:%S" -$logger = Logger.new($stderr) -$logger.datetime_format = $dateformat -$logger.level = $cl_loglevel if defined? $cl_loglevel -$logger.level = 0 if $debug - -$log_queue = Queue.new -$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 @@ -44,125 +33,32 @@ end class ServerError < RuntimeError end -def rawlog(level, message=nil, who_pos=1) - call_stack = caller - if call_stack.length > who_pos - who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" } - else - who = "(unknown)" - end - # Output each line. To distinguish between separate messages and multi-line - # messages originating at the same time, we blank #{who} after the first message - # is output. - # Also, we output strings as-is but for other objects we use pretty_inspect - case message - when String - str = message - else - str = message.pretty_inspect - end - qmsg = Array.new - str.each_line { |l| - qmsg.push [level, l.chomp, who] - who = ' ' * who.size - } - $log_queue.push qmsg -end - -def halt_logger - if $log_thread && $log_thread.alive? - $log_queue << nil - $log_thread.join - $log_thread = nil - end -end - -END { halt_logger } - -def restart_logger(newlogger = false) - halt_logger - - $logger = newlogger if newlogger - - $log_thread = Thread.new do - ls = nil - while ls = $log_queue.pop - ls.each { |l| $logger.add(*l) } - end - end -end - -restart_logger - -def log_session_start - $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n" - restart_logger -end - -def log_session_end - $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n" - $log_queue << nil -end - -def debug(message=nil, who_pos=1) - rawlog(Logger::Severity::DEBUG, message, who_pos) -end - -def log(message=nil, who_pos=1) - rawlog(Logger::Severity::INFO, message, who_pos) -end - -def warning(message=nil, who_pos=1) - rawlog(Logger::Severity::WARN, message, who_pos) -end - -def error(message=nil, who_pos=1) - rawlog(Logger::Severity::ERROR, message, who_pos) -end - -def fatal(message=nil, who_pos=1) - rawlog(Logger::Severity::FATAL, message, who_pos) -end - -debug "debug test" -log "log test" -warning "warning test" -error "error test" -fatal "fatal test" - # The following global is used for the improved signal handling. $interrupted = 0 # these first +require 'rbot/logger' require 'rbot/rbotconfig' -begin - require 'rubygems' -rescue LoadError - log "rubygems unavailable" -end - require 'rbot/load-gettext' require 'rbot/config' -require 'rbot/config-compat' - require 'rbot/irc' require 'rbot/rfc2812' require 'rbot/ircsocket' require 'rbot/botuser' require 'rbot/timer' +require 'rbot/registry' require 'rbot/plugins' require 'rbot/message' require 'rbot/language' -require 'rbot/dbhash' -require 'rbot/registry' +require 'rbot/httputil' module Irc # Main bot class, which manages the various components, receives messages, # handles them or passes them to plugins, and contains core functionality. class Bot - COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team" - SOURCE_URL = "http://ruby-rbot.org" + COPYRIGHT_NOTICE = "(c) Giuseppe Bilotta and the rbot development team" + SOURCE_URL = "https://ruby-rbot.org" # the bot's Auth data attr_reader :auth @@ -187,18 +83,22 @@ class Bot # TODO multiserver 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 - # 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 + # mechanize agent factory + attr_accessor :agent + + # loads and opens new registry databases, used by the plugins + attr_accessor :registry_factory + + # web service + attr_accessor :webservice + # server we are connected to # TODO multiserver def server @@ -280,6 +180,18 @@ class Bot Config.register Config::BooleanValue.new('server.ssl', :default => false, :requires_restart => true, :wizard => true, :desc => "Use SSL to connect to this server?") + Config.register Config::BooleanValue.new('server.ssl_verify', + :default => false, :requires_restart => true, + :desc => "Verify the SSL connection?", + :wizard => true) + Config.register Config::StringValue.new('server.ssl_ca_file', + :default => default_ssl_ca_file, :requires_restart => true, + :desc => "The CA file used to verify the SSL connection.", + :wizard => true) + Config.register Config::StringValue.new('server.ssl_ca_path', + :default => default_ssl_ca_path, :requires_restart => true, + :desc => "Alternativly a directory that includes CA PEM files used to verify the SSL connection.", + :wizard => true) Config.register Config::StringValue.new('server.password', :default => false, :requires_restart => true, :desc => "Password for connecting to this server (if required)", @@ -351,7 +263,7 @@ class Bot :default => 1, :requires_restart => false, :validate => Proc.new { |v| (0..5).include?(v) }, :on_change => Proc.new { |bot, v| - $logger.level = v + LoggerManager.instance.set_level(v) }, :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages") Config.register Config::IntegerValue.new('log.keep', @@ -419,6 +331,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 => default_db, :store_default => true, + :wizard => true, + :validate => Proc.new { |v| Registry::formats.include? v }, + :requires_restart => true, + :desc => "DB adaptor to use for storing the plugin data/registries. Options: " + Registry::formats.join(', ')) @argv = params[:argv] @run_dir = params[:run_dir] || Dir.pwd @@ -455,12 +373,6 @@ class Bot repopulate_botclass_directory - 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 @@ -480,7 +392,6 @@ class Bot @config.bot_associate(self) rescue Exception => e fatal e - log_session_end exit 2 end @@ -488,8 +399,11 @@ class Bot $daemonize = true end + @registry_factory = Registry.new @config['core.db'] + @registry_factory.migrate_registry_folder(path) + @logfile = @config['log.file'] - if @logfile.class!=String || @logfile.empty? + if @logfile.class != String || @logfile.empty? logfname = File.basename(botclass).gsub(/^\.+/,'') logfname << ".log" @logfile = File.join(botclass, logfname) @@ -514,17 +428,9 @@ class Bot # File.umask 0000 # Ensure sensible umask. Adjust as needed. end - logger = Logger.new(@logfile, - @config['log.keep'], - @config['log.max_size']*1024*1024) - logger.datetime_format= $dateformat - logger.level = @config['log.level'] - logger.level = $cl_loglevel if defined? $cl_loglevel - logger.level = 0 if $debug - - restart_logger(logger) - - log_session_start + # setup logger based on bot configuration + LoggerManager.instance.set_level(@config['log.level']) + LoggerManager.instance.set_logfile(@logfile, @config['log.keep'], @config['log.max_size']) if $daemonize log "Redirecting standard input/output/error" @@ -555,8 +461,6 @@ class Bot pf << "#{$$}\n" end - @registry = Registry.new self - @timer = Timer.new @save_mutex = Mutex.new if @config['core.save_every'] > 0 @@ -568,6 +472,7 @@ class Bot @plugins = nil @lang = Language.new(self, @config['core.language']) + @httputil = Utils::HttpUtil.new(self) begin @auth = Auth::manager @@ -575,7 +480,6 @@ class Bot # @auth.load("#{botclass}/botusers.yaml") rescue Exception => e fatal e - log_session_end exit 2 end @auth.everyone.set_default_permission("*", true) @@ -595,7 +499,12 @@ 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'], :penalty_pct =>@config['send.penalty_pct']) + @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], + :ssl => @config['server.ssl'], + :ssl_verify => @config['server.ssl_verify'], + :ssl_ca_file => @config['server.ssl_ca_file'], + :ssl_ca_path => @config['server.ssl_ca_path'], + :penalty_pct => @config['send.penalty_pct']) @client = Client.new @plugins.scan @@ -675,7 +584,7 @@ class Bot # to inform us that our nick has been changed. if data[:target] == '*' debug "setting my connection nick to #{new}" - nick = new + @client.user.nick = new end @plugins.delegate "nicktaken", data[:nick] } @@ -719,6 +628,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? @@ -757,6 +671,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] } @@ -774,7 +697,33 @@ class Bot :purge_split => @config['send.purge_split'], :truncate_text => @config['send.truncate_text'].dup - trap_sigs + trap_signals + end + + # Determine (if possible) a valid path to a CA certificate bundle. + def default_ssl_ca_file + [ '/etc/ssl/certs/ca-certificates.crt', # Ubuntu/Debian + '/etc/ssl/certs/ca-bundle.crt', # Amazon Linux + '/etc/ssl/ca-bundle.pem', # OpenSUSE + '/etc/pki/tls/certs/ca-bundle.crt' # Fedora/RHEL + ].find do |file| + File.readable? file + end + end + + def default_ssl_ca_path + file = default_ssl_ca_file + File.dirname file if file + end + + # Determine if tokyocabinet is installed, if it is use it as a default. + def default_db + begin + require 'tokyocabinet' + return 'tc' + rescue LoadError + return 'dbm' + end end def repopulate_botclass_directory @@ -845,7 +794,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) @@ -877,7 +826,15 @@ class Bot end # things to do when we receive a signal - def got_sig(sig, func=:quit) + def handle_signal(sig) + func = case sig + when 'SIGHUP' + :restart + when 'SIGUSR1' + :reconnect + else + :quit + end debug "received #{sig}, queueing #{func}" # this is not an interruption if we just need to reconnect $interrupted += 1 unless func == :reconnect @@ -885,18 +842,16 @@ class Bot debug "interrupted #{$interrupted} times" if $interrupted >= 3 debug "drastic!" - log_session_end exit 2 end end # trap signals - def trap_sigs + def trap_signals begin - trap("SIGINT") { got_sig("SIGINT") } - trap("SIGTERM") { got_sig("SIGTERM") } - trap("SIGHUP") { got_sig("SIGHUP", :restart) } - trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) } + %w(SIGINT SIGTERM SIGHUP SIGUSR1).each do |sig| + trap(sig) { Thread.new { handle_signal sig } } + end rescue ArgumentError => e debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?" rescue Exception => e @@ -913,8 +868,11 @@ class Bot 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 || '' + error "failed to connect to IRC server at #{uri}" + error e + raise end quit if $interrupted > 0 @@ -929,7 +887,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 @@ -940,27 +898,42 @@ 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 SystemExit + exit 0 + 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 @@ -972,6 +945,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 @@ -981,29 +956,49 @@ class Bot # exceptions that ARENT SocketError's. How am I supposed to handle # that? rescue SystemExit - log_session_end exit 0 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}" - DBTree.stats - # Why restart? DB problems are serious stuff ... - # restart("Oops, we seem to have registry problems ...") - log_session_end - exit 2 rescue Exception => e error "non-net exception: #{e.pretty_inspect}" quit_msg = e.to_s rescue => e fatal "unexpected exception: #{e.pretty_inspect}" - log_session_end exit 2 end end @@ -1033,6 +1028,12 @@ class Bot where = ds[:dest] filtered = ds[:text] + if defined? WebServiceUser and where.instance_of? WebServiceUser + debug 'sendmsg to web service!' + where.response << filtered + return + end + # For starters, set up appropriate queue channels and rings mchan = opts[:queue_channel] mring = opts[:queue_ring] @@ -1231,14 +1232,17 @@ class Bot save debug "\tcleaning up ..." @save_mutex.synchronize do - @plugins.cleanup + begin + @plugins.cleanup + rescue + debug "\tignoring cleanup error: #{$!}" + end end + @httputil.cleanup # debug "\tstopping timers ..." # @timer.stop # debug "Closing registries" # @registry.close - debug "\t\tcleaning up the db environment ..." - DBTree.cleanup_env log "rbot quit (#{message})" end end @@ -1264,11 +1268,9 @@ class Bot # now we re-exec # Note, this fails on Windows debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}" - log_session_end Dir.chdir(@run_dir) exec($0, *@argv) rescue Errno::ENOENT - log_session_end exec("ruby", *(@argv.unshift $0)) rescue Exception => e $interrupted += 1 @@ -1276,21 +1278,26 @@ class Bot end end - # call the save method for all of the botmodules - def save + # call the save method for all or the specified botmodule + # + # :botmodule :: + # optional botmodule to save + def save(botmodule=nil) @save_mutex.synchronize do - @plugins.save - DBTree.cleanup_logs + @plugins.save(botmodule) end end - # call the rescan method for all of the botmodules - def rescan + # call the rescan method for all or just the specified botmodule + # + # :botmodule :: + # instance of the botmodule to rescan + def rescan(botmodule=nil) debug "\tstopping timer..." @timer.stop @save_mutex.synchronize do - @lang.rescan - @plugins.rescan + # @lang.rescan + @plugins.rescan(botmodule) end @timer.start end