X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fircbot.rb;h=6d76cc4962795f76baf9c3f24986c195736ff843;hb=6729561592ffd9630fb8e53509cde9d5e12c9126;hp=fb33b7f5dd21ca67daaa1bc0737e6ef311be264b;hpb=455eaba9fcc043cd0e7f497626555af8a5281a2b;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/ircbot.rb b/lib/rbot/ircbot.rb index fb33b7f5..6d76cc49 100644 --- a/lib/rbot/ircbot.rb +++ b/lib/rbot/ircbot.rb @@ -3,16 +3,39 @@ require 'etc' require 'fileutils' $debug = false unless $debug -# print +message+ if debugging is enabled +$daemonize = false unless $daemonize + +def rawlog(code="", message=nil) + if !code || code.empty? + c = " " + else + c = code.to_s[0,1].upcase + ":" + end + stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S") + message.to_s.each_line { |l| + $stdout.puts "#{c} [#{stamp}] #{l}" + } + $stdout.flush +end + +def log(message=nil) + rawlog("", message) +end + +def log_session_end + log("\n=== #{botclass} session ended ===") if $daemonize +end + def debug(message=nil) - if ($debug && message) - stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S") - message.to_s.each_line { |l| - $stdout.puts "D: [#{stamp}] #{l}" - } - $stdout.flush - end - #yield + rawlog("D", message) if $debug +end + +def warning(message=nil) + rawlog("W", message) +end + +def error(message=nil) + rawlog("E", message) end # The following global is used for the improved signal handling. @@ -98,19 +121,6 @@ class IrcBot BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait', :default => 5, :validate => Proc.new{|v| v >= 0}, :desc => "Seconds to wait before attempting to reconnect, on disconnect") - BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot", - :desc => "IRC nickname the bot should attempt to use", :wizard => true, - :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" }) - BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot", - :requires_restart => true, - :desc => "local user the bot should appear to be", :wizard => true) - BotConfig.register BotConfigArrayValue.new('irc.join_channels', - :default => [], :wizard => true, - :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'") - BotConfig.register BotConfigIntegerValue.new('core.save_every', - :default => 60, :validate => Proc.new{|v| v >= 0}, - # TODO change timer via on_change proc - :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example") BotConfig.register BotConfigFloatValue.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)", @@ -128,10 +138,42 @@ class IrcBot :on_change => Proc.new {|bot, v| bot.start_server_pings}, :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)") + BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot", + :desc => "IRC nickname the bot should attempt to use", :wizard => true, + :on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" }) + BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot", + :requires_restart => true, + :desc => "local user the bot should appear to be", :wizard => true) + BotConfig.register BotConfigArrayValue.new('irc.join_channels', + :default => [], :wizard => true, + :desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'") + BotConfig.register BotConfigArrayValue.new('irc.ignore_users', + :default => [], + :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people") + + BotConfig.register BotConfigIntegerValue.new('core.save_every', + :default => 60, :validate => Proc.new{|v| v >= 0}, + # TODO change timer via on_change proc + :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)") + # BotConfig.register BotConfigBooleanValue.new('core.debug', + # :default => false, :requires_restart => true, + # :on_change => Proc.new { |v| + # debug ((v ? "Enabling" : "Disabling") + " debug output.") + # $debug = v + # debug (($debug ? "Enabled" : "Disabled") + " debug output.") + # }, + # :desc => "Should the bot produce debug output?") + BotConfig.register BotConfigBooleanValue.new('core.run_as_daemon', + :default => false, :requires_restart => true, + :desc => "Should the bot run as a daemon?") + BotConfig.register BotConfigStringValue.new('core.logfile', + :default => false, :requires_restart => true, + :desc => "Name of the logfile to which console messages will be redirected when the bot is run as a daemon") + @argv = params[:argv] unless FileTest.directory? Config::datadir - puts "data directory '#{Config::datadir}' not found, did you setup.rb?" + error "data directory '#{Config::datadir}' not found, did you setup.rb?" exit 2 end @@ -141,9 +183,9 @@ class IrcBot @botclass = botclass.gsub(/\/$/, "") unless FileTest.directory? botclass - puts "no #{botclass} directory found, creating from templates.." + log "no #{botclass} directory found, creating from templates.." if FileTest.exist? botclass - puts "Error: file #{botclass} exists but isn't a directory" + error "file #{botclass} exists but isn't a directory" exit 2 end FileUtils.cp_r Config::datadir+'/templates', botclass @@ -157,7 +199,40 @@ class IrcBot @last_ping = nil @startup_time = Time.new @config = BotConfig.new(self) -# TODO background self after botconfig has a chance to run wizard + # background self after botconfig has a chance to run wizard + @logfile = @config['core.logfile'] + if @logfile.class!=String || @logfile.empty? + @logfile = File.basename(botclass)+".log" + end + if @config['core.run_as_daemon'] + $daemonize = true + end + # See http://blog.humlab.umu.se/samuel/archives/000107.html + # for the backgrounding code + if $daemonize + begin + exit if fork + Process.setsid + exit if fork + rescue NotImplementedError + warning "Could not background, fork not supported" + rescue => e + warning "Could not background. #{e.inspect}" + end + Dir.chdir botclass + # File.umask 0000 # Ensure sensible umask. Adjust as needed. + 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" + end + STDOUT.reopen @logfile, "a" + STDERR.reopen STDOUT + log "\n=== #{botclass} session started ===" + end + @timer = Timer::Timer.new(1.0) # only need per-second granularity @registry = BotRegistry.new self @timer.add(@config['core.save_every']) { save } if @config['core.save_every'] @@ -186,7 +261,7 @@ class IrcBot } @client[:motd] = proc { |data| data[:motd].each_line { |line| - log "MOTD: #{line}", "server" + irclog "MOTD: #{line}", "server" } } @client[:nicktaken] = proc { |data| @@ -194,7 +269,7 @@ class IrcBot @plugins.delegate "nicktaken", data[:nick] } @client[:badnick] = proc {|data| - puts "WARNING, bad nick (#{data[:nick]})" + warning "bad nick (#{data[:nick]})" } @client[:ping] = proc {|data| # (jump the queue for pongs) @@ -213,7 +288,7 @@ class IrcBot end @channels.each {|k,v| if(v.users.has_key?(sourcenick)) - log "@ #{sourcenick} is now known as #{nick}", k + irclog "@ #{sourcenick} is now known as #{nick}", k v.users[nick] = v.users[sourcenick] v.users.delete(sourcenick) end @@ -231,7 +306,7 @@ class IrcBot else @channels.each {|k,v| if(v.users.has_key?(sourcenick)) - log "@ Quit: #{sourcenick}: #{message}", k + irclog "@ Quit: #{sourcenick}: #{message}", k v.users.delete(sourcenick) end } @@ -246,10 +321,10 @@ class IrcBot channel = data[:channel] targets = data[:targets] modestring = data[:modestring] - log "@ Mode #{modestring} #{targets} by #{sourcenick}", channel + irclog "@ Mode #{modestring} #{targets} by #{sourcenick}", channel } @client[:welcome] = proc {|data| - log "joined server #{data[:source]} as #{data[:nick]}", "server" + irclog "joined server #{data[:source]} as #{data[:nick]}", "server" debug "I think my nick is #{@nick}, server thinks #{data[:nick]}" if data[:nick] && data[:nick].length > 0 @nick = data[:nick] @@ -289,9 +364,9 @@ class IrcBot topic = data[:topic] timestamp = data[:unixtime] || Time.now.to_i if(sourcenick == @nick) - log "@ I set topic \"#{topic}\"", channel + irclog "@ I set topic \"#{topic}\"", channel else - log "@ #{sourcenick} set topic \"#{topic}\"", channel + irclog "@ #{sourcenick} set topic \"#{topic}\"", channel end m = TopicMessage.new(self, data[:source], data[:channel], timestamp, data[:topic]) @@ -308,7 +383,7 @@ class IrcBot channel = data[:channel] users = data[:users] unless(@channels[channel]) - puts "bug: got names for channel '#{channel}' I didn't think I was in\n" + warning "got names for channel '#{channel}' I didn't think I was in\n" # exit 2 end @channels[channel].users.clear @@ -319,7 +394,7 @@ class IrcBot } @client[:unknown] = proc {|data| #debug "UNKNOWN: #{data[:serverstring]}" - log data[:serverstring], ".unknown" + irclog data[:serverstring], ".unknown" } end @@ -329,6 +404,7 @@ class IrcBot debug "interrupted #{$interrupted} times" if $interrupted >= 5 debug "drastic!" + log_session_end exit 2 elsif $interrupted >= 3 debug "quitting" @@ -342,11 +418,13 @@ class IrcBot trap("SIGINT") { got_sig("SIGINT") } trap("SIGTERM") { got_sig("SIGTERM") } trap("SIGHUP") { got_sig("SIGHUP") } + rescue ArgumentError => e + debug "failed to trap signals (#{e.inspect}): running on Windows?" rescue => e - debug "failed to trap signals: #{e.inspect}\nProbably running on windows?" + debug "failed to trap signals: #{e.inspect}" end begin - @socket.connect + @socket.connect unless $interrupted > 0 rescue => e raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e end @@ -374,27 +452,38 @@ class IrcBot # exceptions that ARENT SocketError's. How am I supposed to handle # that? rescue SystemExit + log_session_end exit 0 rescue TimeoutError, SocketError => e - puts "#{e.class}: #{e}" + error "network exception: #{e.class}: #{e}" + debug e.inspect debug e.backtrace.join("\n") + rescue BDB::Fatal => e + error "fatal bdb error: #{e.class}: #{e}" + error e.inspect + error e.backtrace.join("\n") + DBTree.stats + restart("Oops, we seem to have registry problems ...") rescue Exception => e - puts "network exception: #{e.inspect}" - puts e.backtrace.join("\n") + error "non-net exception: #{e.class}: #{e}" + error e.inspect + error e.backtrace.join("\n") @socket.shutdown # now we reconnect rescue => e - puts "unexpected exception: connection closed: #{e.inspect}" - puts e.backtrace.join("\n") + error "unexpected exception: #{e.class}: #{e}" + error e.inspect + error e.backtrace.join("\n") + log_session_end exit 2 end - puts "disconnected" + log "disconnected" stop_server_pings @channels.clear @socket.clearq - puts "waiting to reconnect" + log "waiting to reconnect" sleep @config['server.reconnect_wait'] end end @@ -407,8 +496,12 @@ class IrcBot # relevant say() or notice() methods. This one should be used for IRCd # extensions you want to use in modules. def sendmsg(type, where, message) - # limit it 440 chars + CRLF.. so we have to split long lines - left = 440 - type.length - where.length - 3 + # limit it according to the byterate, splitting the message + # taking into consideration the actual message length + # and all the extra stuff + # TODO allow something to do for commands that produce too many messages + # TODO example: math 10**10000 + left = @socket.bytes_per - type.length - where.length - 4 begin if(left >= message.length) sendq("#{type} #{where} :#{message}") @@ -456,11 +549,11 @@ class IrcBot def action(where, message) sendq("PRIVMSG #{where} :\001ACTION #{message}\001") if(where =~ /^#/) - log "* #{@nick} #{message}", where + irclog "* #{@nick} #{message}", where elsif (where =~ /^(\S*)!.*$/) - log "* #{@nick}[#{where}] #{message}", $1 + irclog "* #{@nick}[#{where}] #{message}", $1 else - log "* #{@nick}[#{where}] #{message}", where + irclog "* #{@nick}[#{where}] #{message}", where end end @@ -469,9 +562,9 @@ class IrcBot say where, @lang.get("okay") end - # log message +message+ to a file determined by +where+. +where+ can be a - # channel name, or a nick for private message logging - def log(message, where="server") + # 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") where = where.gsub(/[:!?$*()\/\\<>|"']/, "_") @@ -512,7 +605,7 @@ class IrcBot end debug "Logging quits" @channels.each_value {|v| - log "@ quit (#{message})", v.name + irclog "@ quit (#{message})", v.name } debug "Saving" save @@ -522,7 +615,7 @@ class IrcBot # @registry.close debug "Cleaning up the db environment" DBTree.cleanup_env - puts "rbot quit (#{message})" + log "rbot quit (#{message})" end # message:: optional IRC quit message @@ -531,6 +624,7 @@ class IrcBot begin shutdown(message) ensure + log_session_end exit 0 end end @@ -541,6 +635,7 @@ class IrcBot shutdown(msg) sleep @config['server.reconnect_wait'] # now we re-exec + # Note, this fails on Windows exec($0, *@argv) end @@ -711,24 +806,26 @@ class IrcBot # log it first if(m.action?) if(m.private?) - log "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick + irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick else - log "* #{m.sourcenick} #{m.message}", m.target + irclog "* #{m.sourcenick} #{m.message}", m.target end else if(m.public?) - log "<#{m.sourcenick}> #{m.message}", m.target + irclog "<#{m.sourcenick}> #{m.message}", m.target else - log "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick + irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick end end + @config['irc.ignore_users'].each { |mask| return if Irc.netmaskmatch(mask,m.source) } + # pass it off to plugins that want to hear everything @plugins.delegate "listen", m if(m.private? && m.message =~ /^\001PING\s+(.+)\001/) notice m.sourcenick, "\001PING #$1\001" - log "@ #{m.sourcenick} pinged me" + irclog "@ #{m.sourcenick} pinged me" return end @@ -836,19 +933,19 @@ class IrcBot case type when "NOTICE" if(where =~ /^#/) - log "-=#{@nick}=- #{message}", where + irclog "-=#{@nick}=- #{message}", where elsif (where =~ /(\S*)!.*/) - log "[-=#{where}=-] #{message}", $1 + irclog "[-=#{where}=-] #{message}", $1 else - log "[-=#{where}=-] #{message}" + irclog "[-=#{where}=-] #{message}" end when "PRIVMSG" if(where =~ /^#/) - log "<#{@nick}> #{message}", where + irclog "<#{@nick}> #{message}", where elsif (where =~ /^(\S*)!.*$/) - log "[msg(#{where})] #{message}", $1 + irclog "[msg(#{where})] #{message}", $1 else - log "[msg(#{where})] #{message}", where + irclog "[msg(#{where})] #{message}", where end end end @@ -857,9 +954,9 @@ class IrcBot @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel)) if(m.address?) debug "joined channel #{m.channel}" - log "@ Joined channel #{m.channel}", m.channel + irclog "@ Joined channel #{m.channel}", m.channel else - log "@ #{m.sourcenick} joined channel #{m.channel}", m.channel + irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel @channels[m.channel].users[m.sourcenick] = Hash.new @channels[m.channel].users[m.sourcenick]["mode"] = "" end @@ -871,14 +968,14 @@ class IrcBot def onpart(m) if(m.address?) debug "left channel #{m.channel}" - log "@ Left channel #{m.channel} (#{m.message})", m.channel + irclog "@ Left channel #{m.channel} (#{m.message})", m.channel @channels.delete(m.channel) else - log "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel + irclog "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel if @channels.has_key?(m.channel) @channels[m.channel].users.delete(m.sourcenick) else - puts "bug: got part for channel '#{channel}' I didn't think I was in\n" + warning "got part for channel '#{channel}' I didn't think I was in\n" # exit 2 end end @@ -893,10 +990,10 @@ class IrcBot if(m.address?) debug "kicked from channel #{m.channel}" @channels.delete(m.channel) - log "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel + irclog "@ You have been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel else @channels[m.channel].users.delete(m.sourcenick) - log "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel + irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel end @plugins.delegate("listen", m) @@ -909,7 +1006,7 @@ class IrcBot @channels[m.channel].topic.timestamp = m.timestamp if !m.timestamp.nil? @channels[m.channel].topic.by = m.source if !m.source.nil? - debug "topic of channel #{m.channel} is now #{@channels[m.channel].topic}" + debug "topic of channel #{m.channel} is now #{@channels[m.channel].topic}" end # delegate a privmsg to auth, keyword or plugin handlers