X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=18b9e1d4ac35ff2e05e5b47d226e6a6e9b26b1f7;hb=53cfadbb9f2b25efe4c22b2fd02f8bc33b5e9d2d;hp=3d20b71df3c4578d77395e02f49306e65661863f;hpb=1f7b45bcfa05821884ba47d4e42608c8f9b5a6b1;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 3d20b71d..18b9e1d4 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -1,3 +1,4 @@ +# encoding: UTF-8 #-- vim:sw=2:et #++ # @@ -18,9 +19,12 @@ $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 @@ -38,6 +42,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 @@ -53,20 +60,52 @@ def rawlog(level, message=nil, who_pos=1) when String str = message else - str = message.pretty_inspect + str = message.pretty_inspect rescue '?' end + qmsg = Array.new str.each_line { |l| - $logger.add(level, l.chomp, who) - who.gsub!(/./," ") + qmsg.push [level, l.chomp, who] + who = ' ' * who.size } + if level == Logger::Severity::ERROR or level == Logger::Severity::FATAL and not $daemonize + $stderr.puts str + end + $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) @@ -100,20 +139,24 @@ $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' 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' module Irc @@ -146,18 +189,21 @@ 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 + + attr_accessor :webservice + # server we are connected to # TODO multiserver def server @@ -170,11 +216,32 @@ 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 + @wanted_nick || config['irc.nick'] + end + + # set the nick wanted by the bot + def wanted_nick=(wn) + if wn.nil? or wn.to_s.downcase == config['irc.nick'].downcase + @wanted_nick = nil + else + @wanted_nick = wn.to_s.dup + end + end + + # bot inspection # TODO multiserver def inspect @@ -218,6 +285,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)", @@ -229,17 +308,13 @@ class Bot Config.register Config::IntegerValue.new('server.reconnect_wait', :default => 5, :validate => Proc.new{|v| v >= 0}, :desc => "Seconds to wait before attempting to reconnect, on disconnect") - Config.register Config::FloatValue.new('server.sendq_delay', - :default => 2.0, :validate => Proc.new{|v| v >= 0}, - :desc => "(flood prevention) the delay between sending messages to the server (in seconds)", - :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v }) - Config.register Config::IntegerValue.new('server.sendq_burst', - :default => 4, :validate => Proc.new{|v| v >= 0}, - :desc => "(flood prevention) max lines to burst to the server before throttling. Most ircd's allow bursts of up 5 lines", - :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v }) Config.register Config::IntegerValue.new('server.ping_timeout', :default => 30, :validate => Proc.new{|v| v >= 0}, :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)") + Config.register Config::ArrayValue.new('server.nocolor_modes', + :default => ['c'], :wizard => false, + :requires_restart => false, + :desc => "List of channel modes that require messages to be without colors") Config.register Config::StringValue.new('irc.nick', :default => "rbot", :desc => "IRC nickname the bot should attempt to use", :wizard => true, @@ -259,6 +334,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}, @@ -351,6 +429,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 => 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 @@ -380,23 +471,19 @@ class Bot botclass.gsub!("\\","/") end end - botclass += "/.rbot" + botclass = File.join(botclass, ".rbot") end botclass = File.expand_path(botclass) @botclass = botclass.gsub(/\/$/, "") - unless FileTest.directory? botclass - 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}/logs") unless File.exist?("#{botclass}/logs") - Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry") - Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save") + 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 @@ -418,9 +505,15 @@ 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? - @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 # See http://blog.humlab.umu.se/samuel/archives/000107.html @@ -439,18 +532,36 @@ class Bot end Dir.chdir botclass # 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 + + if $daemonize log "Redirecting standard input/output/error" - begin - STDIN.reopen "/dev/null" - rescue Errno::ENOENT - # On Windows, there's not such thing as /dev/null - STDIN.reopen "NUL" + [$stdin, $stdout, $stderr].each do |fd| + begin + fd.reopen "/dev/null" + rescue Errno::ENOENT + # On Windows, there's not such thing as /dev/null + fd.reopen "NUL" + end end - def STDOUT.write(str=nil) + + def $stdout.write(str=nil) log str, 2 return str.to_s.size end - def STDERR.write(str=nil) + def $stdout.write(str=nil) if str.to_s.match(/:\d+: warning:/) warning str, 2 else @@ -460,21 +571,10 @@ class Bot end end - # Set the new logfile and loglevel. This must be done after the daemonizing - $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 - - log_session_start - - 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 - @registry = Registry.new self - @timer = Timer.new @save_mutex = Mutex.new if @config['core.save_every'] > 0 @@ -484,8 +584,6 @@ class Bot end @quit_mutex = Mutex.new - @logs = Hash.new - @plugins = nil @lang = Language.new(self, @config['core.language']) @@ -501,7 +599,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() @@ -516,7 +613,12 @@ class Bot debug "server.list is now #{@config['server.list'].inspect}" end - @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl']) + @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 @@ -525,24 +627,19 @@ class Bot # Array of channels names where the bot should be quiet # '*' means all channels # - @quiet = [] + @quiet = Set.new + # but we always speak here + @not_quiet = Set.new + + # the nick we want, if it's different from the irc.nick config value + # (e.g. as set by a !nick command) + @wanted_nick = nil @client[:welcome] = proc {|data| m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message]) - irclog "joined server #{@client.server} as #{myself}", "server" - @plugins.delegate("welcome", m) @plugins.delegate("connect") - - @config['irc.join_channels'].each { |c| - debug "autojoining channel #{c}" - if(c =~ /^(\S+)\s+(\S+)$/i) - join $1, $2 - else - join c if(c) - end - } } # TODO the next two @client should go into rfc2812.rb, probably @@ -564,32 +661,33 @@ class Bot } @client[:privmsg] = proc { |data| - m = PrivMessage.new(self, server, data[:source], data[:target], data[:message]) + m = PrivMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true) # debug "Message source is #{data[:source].inspect}" # 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 - } - - irclogprivmsg(m) + } unless m.ignored - @plugins.irc_delegate('privmsg', m) unless m.ignored? + @plugins.irc_delegate('privmsg', m) } @client[:notice] = proc { |data| - message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message]) + message = NoticeMessage.new(self, server, data[:source], data[:target], data[:message], :handle_id => true) # pass it off to plugins that want to hear everything - @plugins.delegate "listen", message - @plugins.delegate "notice", message + @plugins.irc_delegate "notice", message } @client[:motd] = proc { |data| m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd]) - data[:motd].each_line { |line| - irclog "MOTD: #{line}", "server" - } @plugins.delegate "motd", m } @client[:nicktaken] = proc { |data| @@ -620,73 +718,89 @@ class Bot old = data[:oldnick] new = data[:newnick] m = NickMessage.new(self, server, source, old, new) + m.is_on = data[:is_on] if source == myself debug "my nick is now #{new}" end - data[:is_on].each { |ch| - irclog "@ #{old} is now known as #{new}", ch - } @plugins.irc_delegate("nick", m) } @client[:quit] = proc {|data| source = data[:source] message = data[:message] m = QuitMessage.new(self, server, source, source, message) - data[:was_on].each { |ch| - irclog "@ Quit: #{source}: #{message}", ch - } + m.was_on = data[:was_on] @plugins.irc_delegate("quit", m) } @client[:mode] = proc {|data| - irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel] + m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring]) + m.modes = data[:modes] + @plugins.delegate "modechange", m + } + @client[:whois] = proc {|data| + source = data[:source] + target = server.get_user(data[:whois][:nick]) + 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]) - irclogjoin(m) - + sendq("MODE #{data[:channel]}", nil, 0) if m.address? @plugins.irc_delegate("join", m) sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address? } @client[:part] = proc {|data| m = PartMessage.new(self, server, data[:source], data[:channel], data[:message]) - irclogpart(m) - @plugins.irc_delegate("part", m) } @client[:kick] = proc {|data| m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message]) - irclogkick(m) - @plugins.irc_delegate("kick", m) } @client[:invite] = proc {|data| m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel]) - @plugins.irc_delegate("invite", m) } @client[:changetopic] = proc {|data| m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic]) - irclogtopic(m) - + m.info_or_set = :set @plugins.irc_delegate("topic", m) } - @client[:topic] = proc { |data| - irclog "@ Topic is \"#{data[:topic]}\"", data[:channel] - } + # @client[:topic] = proc { |data| + # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel] + # } @client[:topicinfo] = proc { |data| channel = data[:channel] topic = channel.topic - irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel m = TopicMessage.new(self, server, data[:source], channel, topic) - + m.info_or_set = :info @plugins.irc_delegate("topic", m) } @client[:names] = proc { |data| - @plugins.delegate "names", data[:channel], data[:users] + m = NamesMessage.new(self, server, server, data[:channel]) + 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]}" - irclog data[:serverstring], ".unknown" + m = UnknownMessage.new(self, server, server, nil, data[:serverstring]) + @plugins.delegate "unknown_message", m } set_default_send_options :newlines => @config['send.newlines'].to_sym, @@ -696,17 +810,84 @@ class Bot :split_at => Regexp.new(@config['send.split_at']), :purge_split => @config['send.purge_split'], :truncate_text => @config['send.truncate_text'].dup + + 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 + 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 @@ -727,36 +908,51 @@ 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) - return @quiet.include?('*') || @quiet.include?(channel.downcase) + ch = channel.downcase + return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch) end - def set_quiet(channel) + def set_quiet(channel = nil) if channel ch = channel.downcase.dup - @quiet << ch unless @quiet.include?(ch) + @not_quiet.delete(ch) + @quiet << ch else @quiet.clear + @not_quiet.clear @quiet << '*' end end - def reset_quiet(channel) + def reset_quiet(channel = nil) if channel - @quiet.delete channel.downcase + ch = channel.downcase.dup + @quiet.delete(ch) + @not_quiet << ch else @quiet.clear + @not_quiet.clear end end # things to do when we receive a signal - def got_sig(sig) - debug "received #{sig}, queueing quit" - $interrupted += 1 - quit unless @quit_mutex.locked? + 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 + self.send(func) unless @quit_mutex.locked? debug "interrupted #{$interrupted} times" if $interrupted >= 3 debug "drastic!" @@ -765,22 +961,33 @@ class Bot end end - # connect the bot to IRC - def connect + # trap signals + def trap_signals begin - trap("SIGINT") { got_sig("SIGINT") } - trap("SIGTERM") { got_sig("SIGTERM") } - trap("SIGHUP") { got_sig("SIGHUP") } + %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 debug "failed to trap signals: #{e.pretty_inspect}" end + end + + # 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 - rescue => e - raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e + @last_rec = Time.now + rescue Exception => e + uri = @socket.server_uri || '' + error "failed to connect to IRC server at #{uri}" + error e + raise end quit if $interrupted > 0 @@ -794,14 +1001,55 @@ 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=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 + # 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'] + 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 + rescue SystemExit + log_session_end + exit 0 + rescue Exception => e + error e + will_wait = true + retry + end + end + # begin event handling loop def mainloop while true + too_fast = 0 + quit_msg = nil + valid_recv = false # did we receive anything (valid) from the server yet? begin + reconnect(quit_msg, too_fast) quit if $interrupted > 0 - connect - - quit_msg = nil + valid_recv = false while @socket.connected? quit if $interrupted > 0 @@ -813,6 +1061,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 @@ -827,13 +1077,40 @@ class Bot rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e error "network exception: #{e.pretty_inspect}" quit_msg = e.to_s - 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 + 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 + quit_msg = "server ERROR: " + e.message + 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 Exception => e error "non-net exception: #{e.pretty_inspect}" quit_msg = e.to_s @@ -842,15 +1119,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 @@ -861,8 +1129,28 @@ 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] + + 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] @@ -883,7 +1171,13 @@ 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']) + multi_line.replace BasicUserMessage.strip_formatting(multi_line) + end + messages = Array.new case opts[:newlines] when :join @@ -961,7 +1255,7 @@ class Bot lines.each { |line| sendq "#{fixed}#{line}", chan, ring - log_sent(type, where, line) + delegate_sent(type, where, line) } end @@ -1003,27 +1297,15 @@ class Bot say where, @lang.get("okay") end - # log IRC-related message +message+ to a file determined by +where+. - # +where+ can be a channel name, or a nick for private message logging - def irclog(message, where="server") - message = message.chomp - stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S") - if where.class <= Server - where_str = "server" + # set topic of channel +where+ to +topic+ + # can also be used to retrieve the topic of channel +where+ + # by omitting the last argument + def topic(where, topic=nil) + if topic.nil? + sendq "TOPIC #{where}", where, 2 else - where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_") - end - unless(@logs.has_key?(where_str)) - @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a") - @logs[where_str].sync = true + sendq "TOPIC #{where} :#{topic}", where, 2 end - @logs[where_str].puts "[#{stamp}] #{message}" - #debug "[#{stamp}] <#{where}> #{message}" - end - - # set topic of channel +where+ to +topic+ - def topic(where, topic) - sendq "TOPIC #{where} :#{topic}", where, 2 end def disconnect(message=nil) @@ -1034,6 +1316,8 @@ class Bot @socket.clearq debug "Sending quit message" @socket.emergency_puts "QUIT :#{message}" + debug "Logging quits" + delegate_sent('QUIT', myself, message) debug "Flushing socket" @socket.flush rescue SocketError => e @@ -1042,10 +1326,6 @@ class Bot debug "Shutting down socket" @socket.shutdown end - debug "Logging quits" - server.channels.each { |ch| - irclog "@ quit (#{message})", ch - } stop_server_pings @client.reset end @@ -1070,14 +1350,16 @@ class Bot save debug "\tcleaning up ..." @save_mutex.synchronize do - @plugins.cleanup + begin + @plugins.cleanup + rescue + debug "\tignoring cleanup error: #{$!}" + end end # 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 @@ -1094,16 +1376,20 @@ 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 # 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 @@ -1115,7 +1401,6 @@ class Bot def save @save_mutex.synchronize do @plugins.save - DBTree.cleanup_logs end end @@ -1152,10 +1437,15 @@ class Bot end # changing mode - def mode(channel, mode, target) + def mode(channel, mode, target=nil) sendq "MODE #{channel} #{mode} #{target}", channel, 2 end + # asking whois + def whois(nick, target=nil) + sendq "WHOIS #{target} #{nick}", nil, 0 + end + # kicking a user def kick(channel, user, msg) sendq "KICK #{channel} #{user} :#{msg}", channel, 2 @@ -1223,75 +1513,19 @@ class Bot private - def irclogprivmsg(m) - if(m.action?) - if(m.private?) - irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source - else - irclog "* #{m.source} #{m.logmessage}", m.target - end - else - if(m.public?) - irclog "<#{m.source}> #{m.logmessage}", m.target - else - irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source - end - end - end - - # log a message. Internal use only. - def log_sent(type, where, message) + # delegate sent messages + def delegate_sent(type, where, message) + args = [self, server, myself, server.user_or_channel(where.to_s), message] case type when "NOTICE" - case where - when Channel - irclog "-=#{myself}=- #{message}", where - else - irclog "[-=#{where}=-] #{message}", where - end + m = NoticeMessage.new(*args) when "PRIVMSG" - case where - when Channel - irclog "<#{myself}> #{message}", where - else - irclog "[msg(#{where})] #{message}", where - end - end - end - - def irclogjoin(m) - if m.address? - debug "joined channel #{m.channel}" - irclog "@ Joined channel #{m.channel}", m.channel - else - irclog "@ #{m.source} joined channel #{m.channel}", m.channel - end - end - - def irclogpart(m) - if(m.address?) - debug "left channel #{m.channel}" - irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel - else - irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel - end - end - - def irclogkick(m) - if(m.address?) - debug "kicked from channel #{m.channel}" - irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel - else - irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel - end - end - - def irclogtopic(m) - if m.source == myself - irclog "@ I set topic \"#{m.topic}\"", m.channel - else - irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel + m = PrivMessage.new(*args) + when "QUIT" + m = QuitMessage.new(*args) + m.was_on = myself.channels end + @plugins.delegate('sent', m) end end