require 'thread'
+
require 'etc'
require 'fileutils'
+require 'logger'
$debug = false unless $debug
-# print +message+ if debugging is enabled
-def debug(message=nil)
- print "DEBUG: #{message}\n" if($debug && message)
- #yield
+$daemonize = false unless $daemonize
+
+$dateformat = "%Y/%m/%d %H:%M:%S"
+$logger = Logger.new($stderr)
+$logger.datetime_format = $dateformat
+$logger.level = $cl_loglevel if $cl_loglevel
+$logger.level = 0 if $debug
+
+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
+ message.to_s.each_line { |l|
+ $logger.add(level, l.chomp, who)
+ who.gsub!(/./," ")
+ }
+end
+
+def log_session_start
+ $logger << "\n\n=== #{botclass} session started on #{Time.now.strftime($dateformat)} ===\n\n"
+end
+
+def log_session_end
+ $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
+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/rbotconfig'
require 'rbot/config'
class IrcBot
# the bot's current nickname
attr_reader :nick
-
+
# the bot's IrcAuth data
attr_reader :auth
-
+
# the bot's BotConfig data
attr_reader :config
-
+
# the botclass for this bot (determines configdir among other things)
attr_reader :botclass
-
+
# used to perform actions periodically (saves configuration once per minute
# by default)
attr_reader :timer
-
+
# bot's Language data
attr_reader :lang
- # bot's configured addressing prefixes
- attr_reader :addressing_prefixes
+ # capabilities info for the server
+ attr_reader :capabilities
# channel info for channels the bot is in
attr_reader :channels
# 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
# proxies etc as defined by the bot configuration/environment
attr_reader :httputil
# create a new IrcBot with botclass +botclass+
def initialize(botclass, params = {})
# BotConfig for the core bot
+ # TODO should we split socket stuff into ircsocket, etc?
BotConfig.register BotConfigStringValue.new('server.name',
:default => "localhost", :requires_restart => true,
:desc => "What server should the bot connect to?",
:wizard => true)
BotConfig.register BotConfigIntegerValue.new('server.port',
:default => 6667, :type => :integer, :requires_restart => true,
- :desc => "What port should the bot connect to?",
+ :desc => "What port should the bot connect to?",
:validate => Proc.new {|v| v > 0}, :wizard => true)
BotConfig.register BotConfigStringValue.new('server.password',
:default => false, :requires_restart => true,
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 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)",
+ :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
+ BotConfig.register BotConfigIntegerValue.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 })
+ BotConfig.register BotConfigStringValue.new('server.byterate',
+ :default => "400/2", :validate => Proc.new{|v| v.match(/\d+\/\d/)},
+ :desc => "(flood prevention) max bytes/seconds rate to send the server. Most ircd's have limits of 512 bytes/2 seconds",
+ :on_change => Proc.new {|bot, v| bot.socket.byterate = v })
+ BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
+ :default => 30, :validate => Proc.new{|v| v >= 0},
+ :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 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 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)",
- :on_change => Proc.new {|bot, v| bot.socket.sendq_delay = v })
- BotConfig.register BotConfigIntegerValue.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, with non-burst limits of 512 bytes/2 seconds",
- :on_change => Proc.new {|bot, v| bot.socket.sendq_burst = v })
- BotConfig.register BotConfigIntegerValue.new('server.ping_timeout',
- :default => 10, :validate => Proc.new{|v| v >= 0},
- :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)")
+ :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example)")
+
+ 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('log.file',
+ :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")
+ BotConfig.register BotConfigIntegerValue.new('log.level',
+ :default => 1, :requires_restart => false,
+ :validate => Proc.new { |v| (0..5).include?(v) },
+ :on_change => Proc.new { |bot, v|
+ $logger.level = v
+ },
+ :desc => "The minimum logging level (0=DEBUG,1=INFO,2=WARN,3=ERROR,4=FATAL) for console messages")
+ BotConfig.register BotConfigIntegerValue.new('log.keep',
+ :default => 1, :requires_restart => true,
+ :validate => Proc.new { |v| v >= 0 },
+ :desc => "How many old console messages logfiles to keep")
+ BotConfig.register BotConfigIntegerValue.new('log.max_size',
+ :default => 10, :requires_restart => true,
+ :validate => Proc.new { |v| v > 0 },
+ :desc => "Maximum console messages logfile size (in megabytes)")
@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
-
- #botclass = "#{Etc.getpwnam(Etc.getlogin).dir}/.rbot" unless botclass
- botclass = "#{ENV['HOME']}/.rbot" unless botclass
+
+ unless botclass and not botclass.empty?
+ # We want to find a sensible default.
+ # * On POSIX systems we prefer ~/.rbot for the effective uid of the process
+ # * On Windows (at least the NT versions) we want to put our stuff in the
+ # Application Data folder.
+ # We don't use any particular O/S detection magic, exploiting the fact that
+ # Etc.getpwuid is nil on Windows
+ if Etc.getpwuid(Process::Sys.geteuid)
+ botclass = Etc.getpwuid(Process::Sys.geteuid)[:dir].dup
+ else
+ if ENV.has_key?('APPDATA')
+ botclass = ENV['APPDATA'].dup
+ botclass.gsub!("\\","/")
+ end
+ end
+ botclass += "/.rbot"
+ end
+ botclass = File.expand_path(botclass)
@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
end
-
+
Dir.mkdir("#{botclass}/logs") unless File.exist?("#{botclass}/logs")
+ Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
@ping_timer = nil
@pong_timer = nil
@last_ping = nil
@startup_time = Time.new
@config = BotConfig.new(self)
-# TODO background self after botconfig has a chance to run wizard
+
+ if @config['core.run_as_daemon']
+ $daemonize = true
+ end
+
+ @logfile = @config['log.file']
+ if @logfile.class!=String || @logfile.empty?
+ @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
+ 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
+ def STDOUT.write(str=nil)
+ log str, 2
+ return str.to_s.length
+ end
+ def STDERR.write(str=nil)
+ if str.to_s.match(/:\d+: warning:/)
+ warning str, 2
+ else
+ error str, 2
+ end
+ return str.to_s.length
+ 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 $cl_loglevel
+ $logger.level = 0 if $debug
+
+ log_session_start
+
@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']
@httputil = Utils::HttpUtil.new(self)
@lang = Language::Language.new(@config['core.language'])
@keywords = Keywords.new(self)
- @auth = IrcAuth.new(self)
+ begin
+ @auth = IrcAuth.new(self)
+ rescue => e
+ fatal e.inspect
+ fatal e.backtrace.join("\n")
+ log_session_end
+ exit 2
+ end
Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
@plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"])
@nick = @config['irc.nick']
@client = IrcClient.new
+ @client[:isupport] = proc { |data|
+ if data[:capab]
+ sendq "CAPAB IDENTIFY-MSG"
+ end
+ }
+ @client[:datastr] = proc { |data|
+ debug data.inspect
+ if data[:text] == "IDENTIFY-MSG"
+ @capabilities["identify-msg".to_sym] = true
+ else
+ debug "Not handling RPL_DATASTR #{data[:servermessage]}"
+ end
+ }
@client[:privmsg] = proc { |data|
message = PrivMessage.new(self, data[:source], data[:target], data[:message])
onprivmsg(message)
}
@client[:motd] = proc { |data|
data[:motd].each_line { |line|
- log "MOTD: #{line}", "server"
+ irclog "MOTD: #{line}", "server"
}
}
- @client[:nicktaken] = proc { |data|
+ @client[:nicktaken] = proc { |data|
nickchg "#{data[:nick]}_"
+ @plugins.delegate "nicktaken", data[:nick]
}
- @client[:badnick] = proc {|data|
- puts "WARNING, bad nick (#{data[:nick]})"
+ @client[:badnick] = proc {|data|
+ warning "bad nick (#{data[:nick]})"
}
@client[:ping] = proc {|data|
- # (jump the queue for pongs)
- @socket.puts "PONG #{data[:pingid]}"
+ @socket.queue "PONG #{data[:pingid]}"
}
@client[:pong] = proc {|data|
@last_ping = nil
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
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
}
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]
onpart(m)
}
@client[:kick] = proc {|data|
- m = KickMessage.new(self, data[:source], data[:target],data[:channel],data[:message])
+ m = KickMessage.new(self, data[:source], data[:target],data[:channel],data[:message])
onkick(m)
}
@client[:invite] = proc {|data|
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])
channel = data[:channel]
users = data[:users]
unless(@channels[channel])
- puts "bug: got names for channel '#{channel}' I didn't think I was in\n"
- exit 2
+ warning "got names for channel '#{channel}' I didn't think I was in\n"
+ # exit 2
end
@channels[channel].users.clear
users.each {|u|
@channels[channel].users[u[0].sub(/^[@&~+]/, '')] = ["mode", u[1]]
}
+ @plugins.delegate "names", data[:channel], data[:users]
}
@client[:unknown] = proc {|data|
#debug "UNKNOWN: #{data[:serverstring]}"
- log data[:serverstring], ":unknown"
+ irclog data[:serverstring], ".unknown"
}
end
+ def got_sig(sig)
+ debug "received #{sig}, queueing quit"
+ $interrupted += 1
+ debug "interrupted #{$interrupted} times"
+ if $interrupted >= 5
+ debug "drastic!"
+ log_session_end
+ exit 2
+ elsif $interrupted >= 3
+ debug "quitting"
+ quit
+ end
+ end
+
# connect the bot to IRC
def connect
begin
- trap("SIGTERM") { quit }
- trap("SIGHUP") { quit }
- trap("SIGINT") { quit }
- rescue
- debug "failed to trap signals, probably running on windows?"
+ 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}"
end
begin
+ quit if $interrupted > 0
@socket.connect
- rescue => e
- raise "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
+ rescue => e
+ raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + e
end
- @socket.puts "PASS " + @config['server.password'] if @config['server.password']
- @socket.puts "NICK #{@nick}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
+ @socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
+ @socket.emergency_puts "NICK #{@nick}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert"
+ @capabilities = Hash.new
start_server_pings
end
# begin event handling loop
def mainloop
while true
- connect
- @timer.start
-
begin
- while true
+ quit if $interrupted > 0
+ connect
+ @timer.start
+
+ while @socket.connected?
if @socket.select
break unless reply = @socket.gets
@client.process reply
end
+ quit if $interrupted > 0
end
+
# I despair of this. Some of my users get "connection reset by peer"
# exceptions that ARENT SocketError's. How am I supposed to handle
# that?
- #rescue TimeoutError, SocketError => e
+ rescue SystemExit
+ log_session_end
+ exit 0
+ rescue Errno::ETIMEDOUT, TimeoutError, SocketError => e
+ error "network exception: #{e.class}: #{e}"
+ debug e.backtrace.join("\n")
+ rescue BDB::Fatal => e
+ fatal "fatal bdb error: #{e.class}: #{e}"
+ fatal e.backtrace.join("\n")
+ 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
- puts "network exception: connection closed: #{e}"
- puts e.backtrace.join("\n")
- @socket.shutdown # now we reconnect
+ error "non-net exception: #{e.class}: #{e}"
+ error e.backtrace.join("\n")
rescue => e
- puts "unexpected exception: connection closed: #{e.inspect}"
- puts e.backtrace.join("\n")
+ fatal "unexpected exception: #{e.class}: #{e}"
+ fatal e.backtrace.join("\n")
+ log_session_end
exit 2
end
-
- puts "disconnected"
+
+ stop_server_pings
@channels.clear
- @socket.clearq
-
- puts "waiting to reconnect"
+ if @socket.connected?
+ @socket.clearq
+ @socket.shutdown
+ end
+
+ log "disconnected"
+
+ quit if $interrupted > 0
+
+ log "waiting to reconnect"
sleep @config['server.reconnect_wait']
end
end
-
+
# type:: message type
# where:: message target
# message:: message text
# 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, message)
- # limit it 440 chars + CRLF.. so we have to split long lines
- left = 440 - type.length - where.length - 3
+ def sendmsg(type, where, message, chan=nil, ring=0)
+ # 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}")
+ sendq "#{type} #{where} :#{message}", chan, ring
log_sent(type, where, message)
return
end
message = line.slice!(lastspace, line.length) + message
message.gsub!(/^\s+/, "")
end
- sendq("#{type} #{where} :#{line}")
+ sendq "#{type} #{where} :#{line}", chan, ring
log_sent(type, where, line)
end while(message.length > 0)
end
# queue an arbitraty message for the server
- def sendq(message="")
+ def sendq(message="", chan=nil, ring=0)
# temporary
- @socket.queue(message)
+ @socket.queue(message, chan, ring)
end
# send a notice message to channel/nick +where+
- def notice(where, message)
+ def notice(where, message, mchan=nil, mring=-1)
+ if mchan == ""
+ chan = where
+ else
+ chan = mchan
+ end
+ if mring < 0
+ if where =~ /^#/
+ ring = 2
+ else
+ ring = 1
+ end
+ else
+ ring = mring
+ end
message.each_line { |line|
line.chomp!
next unless(line.length > 0)
- sendmsg("NOTICE", where, line)
+ sendmsg "NOTICE", where, line, chan, ring
}
end
# say something (PRIVMSG) to channel/nick +where+
- def say(where, message)
+ def say(where, message, mchan="", mring=-1)
+ if mchan == ""
+ chan = where
+ else
+ chan = mchan
+ end
+ if mring < 0
+ if where =~ /^#/
+ ring = 2
+ else
+ ring = 1
+ end
+ else
+ ring = mring
+ end
message.to_s.gsub(/[\r\n]+/, "\n").each_line { |line|
line.chomp!
next unless(line.length > 0)
unless((where =~ /^#/) && (@channels.has_key?(where) && @channels[where].quiet))
- sendmsg("PRIVMSG", where, line)
+ sendmsg "PRIVMSG", where, line, chan, ring
end
}
end
# perform a CTCP action with message +message+ to channel/nick +where+
- def action(where, message)
- sendq("PRIVMSG #{where} :\001ACTION #{message}\001")
+ def action(where, message, mchan="", mring=-1)
+ if mchan == ""
+ chan = where
+ else
+ chan = mchan
+ end
+ if mring < 0
+ if where =~ /^#/
+ ring = 2
+ else
+ ring = 1
+ end
+ else
+ ring = mring
+ end
+ sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring
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
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")
- message.chomp!
+ # 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(/[:!?$*()\/\\<>|"']/, "_")
unless(@logs.has_key?(where))
@logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
@logs[where].sync = true
@logs[where].puts "[#{stamp}] #{message}"
#debug "[#{stamp}] <#{where}> #{message}"
end
-
+
# set topic of channel +where+ to +topic+
def topic(where, topic)
- sendq "TOPIC #{where} :#{topic}"
+ sendq "TOPIC #{where} :#{topic}", where, 2
end
# disconnect from the server and cleanup all plugins and modules
def shutdown(message = nil)
- trap("SIGTERM", "DEFAULT")
- trap("SIGHUP", "DEFAULT")
- trap("SIGINT", "DEFAULT")
+ debug "Shutting down ..."
+ ## No we don't restore them ... let everything run through
+ # begin
+ # trap("SIGINT", "DEFAULT")
+ # trap("SIGTERM", "DEFAULT")
+ # trap("SIGHUP", "DEFAULT")
+ # rescue => e
+ # debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
+ # end
message = @lang.get("quit") if (message.nil? || message.empty?)
- @socket.clearq
- save
- @plugins.cleanup
+ if @socket.connected?
+ debug "Clearing socket"
+ @socket.clearq
+ debug "Sending quit message"
+ @socket.emergency_puts "QUIT :#{message}"
+ debug "Flushing socket"
+ @socket.flush
+ debug "Shutting down socket"
+ @socket.shutdown
+ end
+ debug "Logging quits"
@channels.each_value {|v|
- log "@ quit (#{message})", v.name
+ irclog "@ quit (#{message})", v.name
}
- @socket.puts "QUIT :#{message}"
- @socket.flush
- @socket.shutdown
- @registry.close
- puts "rbot quit (#{message})"
+ debug "Saving"
+ save
+ debug "Cleaning up"
+ @plugins.cleanup
+ # debug "Closing registries"
+ # @registry.close
+ debug "Cleaning up the db environment"
+ DBTree.cleanup_env
+ log "rbot quit (#{message})"
end
-
+
# message:: optional IRC quit message
# quit IRC, shutdown the bot
def quit(message=nil)
- shutdown(message)
- exit 0
+ begin
+ shutdown(message)
+ ensure
+ exit 0
+ end
end
# totally shutdown and respawn the bot
shutdown(msg)
sleep @config['server.reconnect_wait']
# now we re-exec
+ # Note, this fails on Windows
exec($0, *@argv)
end
# call the save method for bot's config, keywords, auth and all plugins
def save
- @registry.flush
@config.save
@keywords.save
@auth.save
@plugins.save
+ DBTree.cleanup_logs
end
# call the rescan method for the bot's lang, keywords and all plugins
@plugins.rescan
@keywords.rescan
end
-
+
# channel:: channel to join
# key:: optional channel key if channel is +s
# join a channel
def join(channel, key=nil)
if(key)
- sendq "JOIN #{channel} :#{key}"
+ sendq "JOIN #{channel} :#{key}", channel, 2
else
- sendq "JOIN #{channel}"
+ sendq "JOIN #{channel}", channel, 2
end
end
# part a channel
def part(channel, message="")
- sendq "PART #{channel} :#{message}"
+ sendq "PART #{channel} :#{message}", channel, 2
end
# attempt to change bot's nick to +name+
# changing mode
def mode(channel, mode, target)
- sendq "MODE #{channel} #{mode} #{target}"
+ sendq "MODE #{channel} #{mode} #{target}", channel, 2
end
-
+
# m:: message asking for help
# topic:: optional topic help is requested for
# respond to online help requests
def status
secs_up = Time.new - @startup_time
uptime = Utils.secs_to_string secs_up
- return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
+ # return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@registry.length} items stored in registry, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
+ return "Uptime #{uptime}, #{@plugins.length} plugins active, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
end
# we'll ping the server every 30 seconds or so, and expect a response
# before the next one come around..
def start_server_pings
- # stop existing timers if running
- unless @ping_timer.nil?
- @timer.remove @ping_timer
- @ping_timer = nil
- end
- unless @pong_timer.nil?
- @timer.remove @pong_timer
- @pong_timer = nil
- end
+ stop_server_pings
return unless @config['server.ping_timeout'] > 0
# we want to respond to a hung server within 30 secs or so
@ping_timer = @timer.add(30) {
@last_ping = Time.now
- @socket.puts "PING :rbot"
+ @socket.queue "PING :rbot"
}
@pong_timer = @timer.add(10) {
unless @last_ping.nil?
rescue
debug "couldn't shutdown connection (already shutdown?)"
end
+ @last_ping = nil
+ raise TimeoutError, "no PONG from server in #{diff} seconds"
end
end
}
end
+ def stop_server_pings
+ @last_ping = nil
+ # stop existing timers if running
+ unless @ping_timer.nil?
+ @timer.remove @ping_timer
+ @ping_timer = nil
+ end
+ unless @pong_timer.nil?
+ @timer.remove @pong_timer
+ @pong_timer = nil
+ end
+ end
+
private
# handle help requests for "core" topics
return "say <channel>|<nick> <message> => say <message> to <channel> or in private message to <nick>"
when "action"
return "action <channel>|<nick> <message> => does a /me <message> to <channel> or in private message to <nick>"
- when "topic"
- return "topic <channel> <message> => set topic of <channel> to <message>"
+ # when "topic"
+ # return "topic <channel> <message> => set topic of <channel> to <message>"
when "quiet"
return "quiet [in here|<channel>] => with no arguments, stop speaking in all channels, if \"in here\", stop speaking in this channel, or stop speaking in <channel>"
when "talk"
# 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
if(m.address?)
+ delegate_privmsg(m)
case m.message
when (/^join\s+(\S+)\s+(\S+)$/i)
join $1, $2 if(@auth.allow?("join", m.source, m.replyto))
say $1, $2 if(@auth.allow?("say", m.source, m.replyto))
when (/^action\s+(\S+)\s+(.*)$/i)
action $1, $2 if(@auth.allow?("say", m.source, m.replyto))
- when (/^topic\s+(\S+)\s+(.*)$/i)
- topic $1, $2 if(@auth.allow?("topic", m.source, m.replyto))
+ # when (/^topic\s+(\S+)\s+(.*)$/i)
+ # topic $1, $2 if(@auth.allow?("topic", m.source, m.replyto))
when (/^mode\s+(\S+)\s+(\S+)\s+(.*)$/i)
mode $1, $2, $3 if(@auth.allow?("mode", m.source, m.replyto))
when (/^ping$/i)
say m.replyto, "pong"
when (/^rescan$/i)
if(@auth.allow?("config", m.source, m.replyto))
- m.okay
+ m.reply "saving ..."
+ save
+ m.reply "rescanning ..."
rescan
+ m.reply "done. #{@plugins.status(true)}"
end
when (/^quiet$/i)
if(auth.allow?("talk", m.source, m.replyto))
when (/^(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi(\W|$)|yo(\W|$)).*/i)
say m.replyto, @lang.get("hello_X") % m.sourcenick if(m.public?)
say m.replyto, @lang.get("hello") if(m.private?)
- else
- delegate_privmsg(m)
end
else
# stuff to handle when not addressed
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
@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
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
- @channels[m.channel].users.delete(m.sourcenick)
+ 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
+ warning "got part for channel '#{channel}' I didn't think I was in\n"
+ # exit 2
+ end
end
-
+
# delegate to plugins
@plugins.delegate("listen", m)
@plugins.delegate("part", m)
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)
@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
projects / user / henk / code / ruby / rbot.git / blobdiff