+#-- vim:sw=2:et
+#++
+#
+# :title: rbot core
+
require 'thread'
require 'etc'
$dateformat = "%Y/%m/%d %H:%M:%S"
$logger = Logger.new($stderr)
$logger.datetime_format = $dateformat
-$logger.level = $cl_loglevel if $cl_loglevel
+$logger.level = $cl_loglevel if defined? $cl_loglevel
$logger.level = 0 if $debug
+require 'pp'
+
+unless Kernel.instance_methods.include?("pretty_inspect")
+ def pretty_inspect
+ PP.pp(self, '')
+ end
+ public :pretty_inspect
+end
+
+class Exception
+ def pretty_print(q)
+ q.group(1, "#<%s: %s" % [self.class, self.message], ">") {
+ if self.backtrace and not self.backtrace.empty?
+ q.text "\n"
+ q.seplist(self.backtrace, lambda { q.text "\n" } ) { |l| q.text l }
+ end
+ }
+ end
+end
+
def rawlog(level, message=nil, who_pos=1)
call_stack = caller
if call_stack.length > who_pos
# Output each line. To distinguish between separate messages and multi-line
# messages originating at the same time, we blank #{who} after the first message
# is output.
- message.to_s.each_line { |l|
+ # Also, we output strings as-is but for other objects we use pretty_inspect
+ case message
+ when String
+ str = message
+ else
+ str = message.pretty_inspect
+ end
+ str.each_line { |l|
$logger.add(level, l.chomp, who)
who.gsub!(/./," ")
}
# these first
require 'rbot/rbotconfig'
+require 'rbot/load-gettext'
require 'rbot/config'
# require 'rbot/utils'
# handles them or passes them to plugins, and contains core functionality.
class Bot
COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
+ SOURCE_URL = "http://linuxbrit.co.uk/rbot"
# the bot's Auth data
attr_reader :auth
: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 => [],
+ :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',
},
:desc => "String used to replace newlines when send.newlines is set to join")
BotConfig.register BotConfigIntegerValue.new('send.max_lines',
- :default => 0,
+ :default => 5,
:validate => Proc.new { |v| v >= 0 },
:on_change => Proc.new { |bot, v|
bot.set_default_send_options :max_lines => v
: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")
@argv = params[:argv]
+ @run_dir = params[:run_dir] || Dir.pwd
unless FileTest.directory? Config::coredir
error "core directory '#{Config::coredir}' not found, did you setup.rb?"
begin
@config = BotConfig.configmanager
@config.bot_associate(self)
- rescue => e
- fatal e.inspect
- fatal e.backtrace.join("\n")
+ rescue Exception => e
+ fatal e
log_session_end
exit 2
end
end
# See http://blog.humlab.umu.se/samuel/archives/000107.html
- # for the backgrounding code
+ # for the backgrounding code
if $daemonize
begin
exit if fork
exit if fork
rescue NotImplementedError
warning "Could not background, fork not supported"
- rescue => e
- warning "Could not background. #{e.inspect}"
+ rescue SystemExit
+ exit 0
+ rescue Exception => e
+ warning "Could not background. #{e.pretty_inspect}"
end
Dir.chdir botclass
# File.umask 0000 # Ensure sensible umask. Adjust as needed.
$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 = $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
+
@registry = BotRegistry.new self
- @timer = Timer::Timer.new(1.0) # only need per-second granularity
+ @timer = Timer.new
@save_mutex = Mutex.new
if @config['core.save_every'] > 0
@save_timer = @timer.add(@config['core.save_every']) { save }
@logs = Hash.new
@plugins = nil
- @lang = Language::Language.new(self, @config['core.language'])
+ @lang = Language.new(self, @config['core.language'])
begin
@auth = Auth::authmanager
@auth.bot_associate(self)
# @auth.load("#{botclass}/botusers.yaml")
- rescue => e
- fatal e.inspect
- fatal e.backtrace.join("\n")
+ rescue Exception => e
+ fatal e
log_session_end
exit 2
end
unless ignored
@plugins.delegate "listen", m
+ @plugins.delegate("ctcp_listen", m) if m.ctcp
@plugins.privmsg(m) if m.address?
- if not m.replied
+ if not m.replied
@plugins.delegate "unreplied", m
end
end
}
}
@client[:nicktaken] = proc { |data|
- new = "#{data[:nick]}_"
+ new = "#{data[:nick]}_"
nickchg new
# If we're setting our nick at connection because our choice was taken,
# we have to fix our nick manually, because there will be no NICK message
@plugins.delegate "nicktaken", data[:nick]
}
@client[:badnick] = proc {|data|
- arning "bad nick (#{data[:nick]})"
+ warning "bad nick (#{data[:nick]})"
}
@client[:ping] = proc {|data|
sendq "PONG #{data[:pingid]}"
@plugins.delegate("listen", m)
@plugins.delegate("join", m)
+ sendq "WHO #{data[:channel]}", data[:channel], 2
}
@client[:part] = proc {|data|
m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
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}"
+ debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
+ rescue Exception => e
+ debug "failed to trap signals: #{e.pretty_inspect}"
end
begin
quit if $interrupted > 0
quit if $interrupted > 0
realname = @config['irc.name'].clone || 'Ruby bot'
- realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
+ realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
@socket.emergency_puts "PASS " + @config['server.password'] if @config['server.password']
@socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
begin
quit if $interrupted > 0
connect
- @timer.start
quit_msg = nil
while @socket.connected?
log_session_end
exit 0
rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
- error "network exception: #{e.class}: #{e}"
- debug e.backtrace.join("\n")
+ error "network exception: #{e.pretty_inspect}"
quit_msg = e.to_s
rescue BDB::Fatal => e
- fatal "fatal bdb error: #{e.class}: #{e}"
- fatal e.backtrace.join("\n")
+ fatal "fatal bdb error: #{e.pretty_inspect}"
DBTree.stats
# Why restart? DB problems are serious stuff ...
# restart("Oops, we seem to have registry problems ...")
log_session_end
exit 2
rescue Exception => e
- error "non-net exception: #{e.class}: #{e}"
- error e.backtrace.join("\n")
+ error "non-net exception: #{e.pretty_inspect}"
quit_msg = e.to_s
rescue => e
- fatal "unexpected exception: #{e.class}: #{e}"
- fatal e.backtrace.join("\n")
+ fatal "unexpected exception: #{e.pretty_inspect}"
log_session_end
exit 2
end
else
lines = all_lines
end
- debug lines.inspect
lines.each { |line|
sendq "#{fixed}#{line}", chan, ring
sendmsg "PRIVMSG", where, message, options
end
+ def ctcp_notice(where, command, message, options={})
+ return if where.kind_of?(Channel) and quiet_on?(where)
+ sendmsg "NOTICE", where, "\001#{command} #{message}\001", options
+ end
+
+ def ctcp_say(where, command, message, options={})
+ return if where.kind_of?(Channel) and quiet_on?(where)
+ sendmsg "PRIVMSG", where, "\001#{command} #{message}\001", options
+ end
+
# perform a CTCP action with message +message+ to channel/nick +where+
def action(where, message, options={})
- return if where.kind_of?(Channel) and quiet_on?(where)
- mchan = options.fetch(:queue_channel, nil)
- mring = options.fetch(:queue_ring, nil)
- if mchan
- chan = mchan
- else
- chan = where
- end
- if mring
- ring = mring
- else
- case where
- when User
- ring = 1
- else
- ring = 2
- end
- end
- # FIXME doesn't check message length. Can we make this exploit sendmsg?
- sendq "PRIVMSG #{where} :\001ACTION #{message}\001", chan, ring
- case where
- when Channel
- irclog "* #{myself} #{message}", where
- else
- irclog "* #{myself}[#{where}] #{message}", where
- end
+ ctcp_say(where, 'ACTION', message, options)
end
# quick way to say "okay" (or equivalent) to +where+
sendq "TOPIC #{where} :#{topic}", where, 2
end
- def disconnect(message = nil)
- message = @lang.get("quit") if (message.nil? || message.empty?)
+ def disconnect(message=nil)
+ message = @lang.get("quit") if (!message || message.empty?)
if @socket.connected?
debug "Clearing socket"
@socket.clearq
end
# disconnect from the server and cleanup all plugins and modules
- def shutdown(message = nil)
+ def shutdown(message=nil)
@quit_mutex.synchronize do
- debug "Shutting down ..."
+ debug "Shutting down: #{message}"
## No we don't restore them ... let everything run through
# begin
# trap("SIGINT", "DEFAULT")
# rescue => e
# debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
# end
- disconnect
- debug "Saving"
+ debug "\tdisconnecting..."
+ disconnect(message)
+ debug "\tstopping timer..."
+ @timer.stop
+ debug "\tsaving ..."
save
- debug "Cleaning up"
+ debug "\tcleaning up ..."
@save_mutex.synchronize do
@plugins.cleanup
end
+ # debug "\tstopping timers ..."
+ # @timer.stop
# debug "Closing registries"
# @registry.close
- debug "Cleaning up the db environment"
+ debug "\t\tcleaning up the db environment ..."
DBTree.cleanup_env
log "rbot quit (#{message})"
end
end
# totally shutdown and respawn the bot
- def restart(message = false)
- msg = message ? message : "restarting, back in #{@config['server.reconnect_wait']}..."
- shutdown(msg)
+ def restart(message=nil)
+ message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
+ shutdown(message)
sleep @config['server.reconnect_wait']
- # now we re-exec
- # Note, this fails on Windows
- exec($0, *@argv)
+ begin
+ # now we re-exec
+ # Note, this fails on Windows
+ debug "going to exec #{$0} #{@argv.inspect} from #{@run_dir}"
+ Dir.chdir(@run_dir)
+ exec($0, *@argv)
+ rescue Errno::ENOENT
+ exec("ruby", *(@argv.unshift $0))
+ rescue Exception => e
+ $interrupted += 1
+ raise e
+ end
end
# call the save method for all of the botmodules
# call the rescan method for all of the botmodules
def rescan
+ debug "\tstopping timer..."
+ @timer.stop
@save_mutex.synchronize do
@lang.rescan
@plugins.rescan
end
+ @timer.start
end
# channel:: channel to join
topic = nil if topic == ""
case topic
when nil
- helpstr = "help topics: "
+ helpstr = _("help topics: ")
helpstr += @plugins.helptopics
- helpstr += " (help <topic> for more info)"
+ helpstr += _(" (help <topic> for more info)")
else
unless(helpstr = @plugins.help(topic))
- helpstr = "no help for topic #{topic}"
+ helpstr = _("no help for topic %{topic}") % { :topic => topic }
end
end
return helpstr
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, #{@socket.lines_sent} lines sent, #{@socket.lines_received} received."
+ return (_("Uptime %{up}, %{plug} plugins active, %{sent} lines sent, %{recv} received.") %
+ {
+ :up => uptime, :plug => @plugins.length,
+ :sent => @socket.lines_sent, :recv => @socket.lines_received
+ })
end
# We want to respond to a hung server in a timely manner. If nothing was received
projects / user / henk / code / ruby / rbot.git / blobdiff