X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=389494af7911157f6708145a544b2683db6b5d06;hb=8115edef0169d95f0ebb64d77364e346e9452099;hp=057170b8a6930f30e60f350b807337e73cfab296;hpb=dd87231af22d1a94562b1c6b312c8af97d258bfb;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index 057170b8..389494af 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -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 @@ -66,12 +69,20 @@ def rawlog(level, message=nil, who_pos=1) $log_queue.push qmsg end -def restart_logger +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 @@ -199,6 +210,22 @@ class Bot myself.nick 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 @@ -253,17 +280,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, @@ -283,6 +306,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}, @@ -375,6 +401,13 @@ 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.") @argv = params[:argv] @run_dir = params[:run_dir] || Dir.pwd @@ -409,7 +442,21 @@ class Bot botclass = File.expand_path(botclass) @botclass = botclass.gsub(/\/$/, "") - unless FileTest.directory? botclass + 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" @@ -444,6 +491,7 @@ class Bot @logfile = @config['log.file'] if @logfile.class!=String || @logfile.empty? @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log" + debug "Using `#{@logfile}' as debug log" end # See http://blog.humlab.umu.se/samuel/archives/000107.html @@ -462,18 +510,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 @@ -483,15 +549,6 @@ 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| pf << "#{$$}\n" end @@ -537,7 +594,7 @@ 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'], :penalty_pct =>@config['send.penalty_pct']) @client = Client.new @plugins.scan @@ -546,22 +603,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]) @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 @@ -583,21 +637,28 @@ 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 - } + } 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.irc_delegate "notice", message } @@ -651,8 +712,15 @@ class Bot 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[:join] = proc {|data| m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message]) + sendq("MODE #{data[:channel]}", nil, 0) if m.address? @plugins.irc_delegate("join", m) sendq("WHO #{data[:channel]}", data[:channel], 2) if m.address? } @@ -688,6 +756,9 @@ class Bot m.users = data[:users] @plugins.delegate "names", 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]) @@ -701,6 +772,8 @@ class Bot :split_at => Regexp.new(@config['send.split_at']), :purge_split => @config['send.purge_split'], :truncate_text => @config['send.truncate_text'].dup + + trap_sigs end def setup_plugins_path @@ -736,32 +809,39 @@ class Bot # 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 got_sig(sig, func=:quit) + 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!" @@ -770,20 +850,26 @@ class Bot end end - # connect the bot to IRC - def connect + # trap signals + def trap_sigs begin trap("SIGINT") { got_sig("SIGINT") } trap("SIGTERM") { got_sig("SIGTERM") } - trap("SIGHUP") { got_sig("SIGHUP") } + 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 debug "failed to trap signals: #{e.pretty_inspect}" end + end + + # connect the bot to IRC + def connect 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 end @@ -799,14 +885,39 @@ 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 + + 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 + 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 @@ -832,6 +943,11 @@ class Bot rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e error "network exception: #{e.pretty_inspect}" quit_msg = e.to_s + rescue ServerError + # 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 @@ -847,15 +963,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 @@ -889,6 +996,12 @@ class Bot end multi_line = original_message.to_s.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 @@ -1009,8 +1122,14 @@ class Bot end # set topic of channel +where+ to +topic+ - def topic(where, topic) - sendq "TOPIC #{where} :#{topic}", where, 2 + # 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 + sendq "TOPIC #{where} :#{topic}", where, 2 + end end def disconnect(message=nil) @@ -1086,9 +1205,11 @@ 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 @@ -1137,10 +1258,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 @@ -1218,6 +1344,7 @@ class Bot m = PrivMessage.new(*args) when "QUIT" m = QuitMessage.new(*args) + m.was_on = myself.channels end @plugins.delegate('sent', m) end