+#-- vim:sw=2:et
+#++
+#
+# :title: rbot core
+
require 'thread'
+
require 'etc'
require 'fileutils'
+require 'logger'
$debug = false unless $debug
$daemonize = false unless $daemonize
-# TODO we should use the actual Logger class
-def rawlog(code="", message=nil)
- if !code || code.empty?
- c = " "
- else
- c = code.to_s[0,1].upcase + ":"
+$dateformat = "%Y/%m/%d %H:%M:%S"
+$logger = Logger.new($stderr)
+$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")
+ 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
+
+class ServerError < RuntimeError
+end
+
+def rawlog(level, message=nil, who_pos=1)
call_stack = caller
- case call_stack.length
- when 0
- $stderr.puts "ERROR IN THE LOGGING SYSTEM, THIS CAN'T HAPPEN"
- who = "WTF1?? "
- when 1
- $stderr.puts "ERROR IN THE LOGGING SYSTEM, THIS CAN'T HAPPEN"
- who = "WTF2?? "
+ if call_stack.length > who_pos
+ who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
+ else
+ who = "(unknown)"
+ end
+ # 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.
+ # Also, we output strings as-is but for other objects we use pretty_inspect
+ case message
+ when String
+ str = message
else
- who = call_stack[1].match(%r{(?:.+)/([^/]+):(\d+)(?::(in .*))?})[1,3].join(":")
+ str = message.pretty_inspect
end
- stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
- message.to_s.each_line { |l|
- $stdout.puts "#{c} [#{stamp}] #{who} -- #{l}"
+ qmsg = Array.new
+ str.each_line { |l|
+ qmsg.push [level, l.chomp, who]
+ who = ' ' * who.size
}
- $stdout.flush
+ $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
-def log(message=nil)
- rawlog("", message)
+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
- rawlog("", "\n=== #{botclass} session ended ===") if $daemonize
+ $logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
+ $log_queue << nil
+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 debug(message=nil)
- rawlog("D", message) if $debug
+def warning(message=nil, who_pos=1)
+ rawlog(Logger::Severity::WARN, message, who_pos)
end
-def warning(message=nil)
- rawlog("W", message)
+def error(message=nil, who_pos=1)
+ rawlog(Logger::Severity::ERROR, message, who_pos)
end
-def error(message=nil)
- rawlog("E", message)
+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/load-gettext'
require 'rbot/config'
-require 'rbot/utils'
+require 'rbot/config-compat'
+require 'rbot/irc'
require 'rbot/rfc2812'
-require 'rbot/keywords'
require 'rbot/ircsocket'
-require 'rbot/auth'
+require 'rbot/botuser'
require 'rbot/timer'
require 'rbot/plugins'
-require 'rbot/channel'
require 'rbot/message'
require 'rbot/language'
require 'rbot/dbhash'
require 'rbot/registry'
-require 'rbot/httputil'
module Irc
# Main bot class, which manages the various components, receives messages,
# handles them or passes them to plugins, and contains core functionality.
-class IrcBot
- # the bot's current nickname
- attr_reader :nick
-
- # the bot's IrcAuth data
+class Bot
+ COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
+ SOURCE_URL = "http://ruby-rbot.org"
+ # the bot's Auth data
attr_reader :auth
- # the bot's BotConfig data
+ # the bot's Config data
attr_reader :config
# the botclass for this bot (determines configdir among other things)
# by default)
attr_reader :timer
+ # synchronize with this mutex while touching permanent data files:
+ # saving, flushing, cleaning up ...
+ attr_reader :save_mutex
+
# bot's Language data
attr_reader :lang
- # capabilities info for the server
- attr_reader :capabilities
-
- # channel info for channels the bot is in
- attr_reader :channels
-
# bot's irc socket
+ # TODO multiserver
attr_reader :socket
# bot's object registry, plugins get an interface to this for persistant
# bot's httputil help object, for fetching resources via http. Sets up
# proxies etc as defined by the bot configuration/environment
- attr_reader :httputil
+ attr_accessor :httputil
+
+ # server we are connected to
+ # TODO multiserver
+ def server
+ @client.server
+ end
+
+ # bot User in the client/server connection
+ # TODO multiserver
+ def myself
+ @client.user
+ end
+
+ # bot User in the client/server connection
+ def nick
+ 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
- # create a new IrcBot with botclass +botclass+
+
+ # bot inspection
+ # TODO multiserver
+ def inspect
+ ret = self.to_s[0..-2]
+ ret << ' version=' << $version.inspect
+ ret << ' botclass=' << botclass.inspect
+ ret << ' lang="' << lang.language
+ if defined?(GetText)
+ ret << '/' << locale
+ end
+ ret << '"'
+ ret << ' nick=' << nick.inspect
+ ret << ' server='
+ if server
+ ret << (server.to_s + (socket ?
+ ' [' << socket.server_uri.to_s << ']' : '')).inspect
+ unless server.channels.empty?
+ ret << " channels="
+ ret << server.channels.map { |c|
+ "%s%s" % [c.modes_of(nick).map { |m|
+ server.prefix_for_mode(m)
+ }, c.name]
+ }.inspect
+ end
+ else
+ ret << '(none)'
+ end
+ ret << ' plugins=' << plugins.inspect
+ ret << ">"
+ end
+
+
+ # create a new Bot with botclass +botclass+
def initialize(botclass, params = {})
- # BotConfig for the core bot
+ # Config 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?",
- :validate => Proc.new {|v| v > 0}, :wizard => true)
- BotConfig.register BotConfigStringValue.new('server.password',
+ Config.register Config::ArrayValue.new('server.list',
+ :default => ['irc://localhost'], :wizard => true,
+ :requires_restart => true,
+ :desc => "List of irc servers rbot should try to connect to. Use comma to separate values. Servers are in format 'server.doma.in:port'. If port is not specified, default value (6667) is used.")
+ 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::StringValue.new('server.password',
:default => false, :requires_restart => true,
:desc => "Password for connecting to this server (if required)",
:wizard => true)
- BotConfig.register BotConfigStringValue.new('server.bindhost',
+ Config.register Config::StringValue.new('server.bindhost',
:default => false, :requires_restart => true,
:desc => "Specific local host or IP for the bot to bind to (if required)",
:wizard => true)
- BotConfig.register BotConfigIntegerValue.new('server.reconnect_wait',
+ 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")
- 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',
+ Config.register Config::IntegerValue.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)")
+ 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")
- BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
+ Config.register Config::StringValue.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",
+ Config.register Config::StringValue.new('irc.name',
+ :default => "Ruby bot", :requires_restart => true,
+ :desc => "IRC realname the bot should use")
+ Config.register Config::BooleanValue.new('irc.name_copyright',
+ :default => true, :requires_restart => true,
+ :desc => "Append copyright notice to bot realname? (please don't disable unless it's really necessary)")
+ Config.register Config::StringValue.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',
+ Config.register Config::ArrayValue.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 => [],
+ 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)")
- BotConfig.register BotConfigIntegerValue.new('core.save_every',
+ Config.register Config::IntegerValue.new('core.save_every',
:default => 60, :validate => Proc.new{|v| v >= 0},
- # TODO change timer via on_change proc
+ :on_change => Proc.new { |bot, v|
+ if @save_timer
+ if v > 0
+ @timer.reschedule(@save_timer, v)
+ @timer.unblock(@save_timer)
+ else
+ @timer.block(@save_timer)
+ end
+ else
+ if v > 0
+ @save_timer = @timer.add(v) { bot.save }
+ end
+ # Nothing to do when v == 0
+ end
+ },
: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',
+
+ Config.register Config::BooleanValue.new('core.run_as_daemon',
:default => false, :requires_restart => true,
:desc => "Should the bot run as a daemon?")
- BotConfig.register BotConfigStringValue.new('core.logfile',
+
+ Config.register Config::StringValue.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")
+ Config.register Config::IntegerValue.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")
+ Config.register Config::IntegerValue.new('log.keep',
+ :default => 1, :requires_restart => true,
+ :validate => Proc.new { |v| v >= 0 },
+ :desc => "How many old console messages logfiles to keep")
+ Config.register Config::IntegerValue.new('log.max_size',
+ :default => 10, :requires_restart => true,
+ :validate => Proc.new { |v| v > 0 },
+ :desc => "Maximum console messages logfile size (in megabytes)")
+
+ Config.register Config::ArrayValue.new('plugins.path',
+ :wizard => true, :default => ['(default)', '(default)/games', '(default)/contrib'],
+ :requires_restart => false,
+ :on_change => Proc.new { |bot, v| bot.setup_plugins_path },
+ :desc => "Where the bot should look for plugins. List multiple directories using commas to separate. Use '(default)' for default prepackaged plugins collection, '(default)/contrib' for prepackaged unsupported plugins collection")
+
+ Config.register Config::EnumValue.new('send.newlines',
+ :values => ['split', 'join'], :default => 'split',
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :newlines => v.to_sym
+ },
+ :desc => "When set to split, messages with embedded newlines will be sent as separate lines. When set to join, newlines will be replaced by the value of join_with")
+ Config.register Config::StringValue.new('send.join_with',
+ :default => ' ',
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :join_with => v.dup
+ },
+ :desc => "String used to replace newlines when send.newlines is set to join")
+ Config.register Config::IntegerValue.new('send.max_lines',
+ :default => 5,
+ :validate => Proc.new { |v| v >= 0 },
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :max_lines => v
+ },
+ :desc => "Maximum number of IRC lines to send for each message (set to 0 for no limit)")
+ Config.register Config::EnumValue.new('send.overlong',
+ :values => ['split', 'truncate'], :default => 'split',
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :overlong => v.to_sym
+ },
+ :desc => "When set to split, messages which are too long to fit in a single IRC line are split into multiple lines. When set to truncate, long messages are truncated to fit the IRC line length")
+ Config.register Config::StringValue.new('send.split_at',
+ :default => '\s+',
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :split_at => Regexp.new(v)
+ },
+ :desc => "A regular expression that should match the split points for overlong messages (see send.overlong)")
+ Config.register Config::BooleanValue.new('send.purge_split',
+ :default => true,
+ :on_change => Proc.new { |bot, v|
+ bot.set_default_send_options :purge_split => v
+ },
+ :desc => "Set to true if the splitting boundary (set in send.split_at) should be removed when splitting overlong messages (see send.overlong)")
+ Config.register Config::StringValue.new('send.truncate_text',
+ :default => "#{Reverse}...#{Reverse}",
+ :on_change => Proc.new { |bot, v|
+ 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
+
+ unless FileTest.directory? Config::coredir
+ error "core directory '#{Config::coredir}' not found, did you setup.rb?"
+ exit 2
+ end
unless FileTest.directory? Config::datadir
error "data directory '#{Config::datadir}' not found, did you setup.rb?"
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.
+ # * 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.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")
+ registry_dir = File.join(@botclass, 'registry')
+ Dir.mkdir(registry_dir) unless File.exist?(registry_dir)
+ unless FileTest.directory? registry_dir
+ error "registry storage location #{registry_dir} is not a directory"
+ exit 2
+ end
+ 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
- @ping_timer = nil
- @pong_timer = nil
+ # Time at which the last PING was sent
@last_ping = nil
+ # Time at which the last line was RECV'd from the server
+ @last_rec = nil
+
@startup_time = Time.new
- @config = BotConfig.new(self)
- # 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"
+
+ begin
+ @config = Config.manager
+ @config.bot_associate(self)
+ rescue Exception => e
+ fatal e
+ log_session_end
+ exit 2
end
+
if @config['core.run_as_daemon']
$daemonize = true
end
+
+ @logfile = @config['log.file']
+ if @logfile.class!=String || @logfile.empty?
+ 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
- # 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.
+ 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)
+ log str, 2
+ return str.to_s.size
+ end
+ def $stdout.write(str=nil)
+ if str.to_s.match(/:\d+: warning:/)
+ warning str, 2
+ else
+ error str, 2
+ end
+ return str.to_s.size
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']
- @channels = Hash.new
- @logs = Hash.new
- @httputil = Utils::HttpUtil.new(self)
- @lang = Language::Language.new(@config['core.language'])
- @keywords = Keywords.new(self)
- @auth = IrcAuth.new(self)
+ File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf|
+ pf << "#{$$}\n"
+ end
- Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
- @plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"])
+ @registry = Registry.new self
- @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
- @nick = @config['irc.nick']
+ @timer = Timer.new
+ @save_mutex = Mutex.new
+ if @config['core.save_every'] > 0
+ @save_timer = @timer.add(@config['core.save_every']) { save }
+ else
+ @save_timer = nil
+ end
+ @quit_mutex = Mutex.new
+
+ @plugins = nil
+ @lang = Language.new(self, @config['core.language'])
- @client = IrcClient.new
+ begin
+ @auth = Auth::manager
+ @auth.bot_associate(self)
+ # @auth.load("#{botclass}/botusers.yaml")
+ rescue Exception => e
+ fatal e
+ log_session_end
+ exit 2
+ end
+ @auth.everyone.set_default_permission("*", true)
+ @auth.botowner.password= @config['auth.password']
+
+ @plugins = Plugins::manager
+ @plugins.bot_associate(self)
+ setup_plugins_path()
+
+ if @config['server.name']
+ debug "upgrading configuration (server.name => server.list)"
+ srv_uri = 'irc://' + @config['server.name']
+ srv_uri += ":#{@config['server.port']}" if @config['server.port']
+ @config.items['server.list'.to_sym].set_string(srv_uri)
+ @config.delete('server.name'.to_sym)
+ @config.delete('server.port'.to_sym)
+ debug "server.list is now #{@config['server.list'].inspect}"
+ end
+
+ @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
+
+ # Channels where we are quiet
+ # Array of channels names where the bot should be quiet
+ # '*' means all channels
+ #
+ @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")
+ }
+
+ # TODO the next two @client should go into rfc2812.rb, probably
+ # Since capabs are two-steps processes, server.supports[:capab]
+ # should be a three-state: nil, [], [....]
+ asked_for = { :"identify-msg" => false }
@client[:isupport] = proc { |data|
- if data[:capab]
+ if server.supports[:capab] and !asked_for[:"identify-msg"]
sendq "CAPAB IDENTIFY-MSG"
+ asked_for[:"identify-msg"] = true
end
}
@client[:datastr] = proc { |data|
- debug data.inspect
if data[:text] == "IDENTIFY-MSG"
- @capabilities["identify-msg".to_sym] = true
+ server.capabilities[:"identify-msg"] = 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)
+ 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, 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.irc_delegate "notice", message
}
@client[:motd] = proc { |data|
- data[:motd].each_line { |line|
- irclog "MOTD: #{line}", "server"
- }
+ m = MotdMessage.new(self, server, data[:source], data[:target], data[:motd])
+ @plugins.delegate "motd", m
}
@client[:nicktaken] = proc { |data|
- nickchg "#{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
+ # to inform us that our nick has been changed.
+ if data[:target] == '*'
+ debug "setting my connection nick to #{new}"
+ nick = new
+ end
@plugins.delegate "nicktaken", data[:nick]
}
@client[:badnick] = proc {|data|
warning "bad nick (#{data[:nick]})"
}
@client[:ping] = proc {|data|
- @socket.queue "PONG #{data[:pingid]}"
+ sendq "PONG #{data[:pingid]}"
}
@client[:pong] = proc {|data|
@last_ping = nil
}
@client[:nick] = proc {|data|
- sourcenick = data[:sourcenick]
- nick = data[:nick]
- m = NickMessage.new(self, data[:source], data[:sourcenick], data[:nick])
- if(sourcenick == @nick)
- debug "my nick is now #{nick}"
- @nick = nick
+ # debug "Message source is #{data[:source].inspect}"
+ # debug "Bot is #{myself.inspect}"
+ source = data[:source]
+ 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
- @channels.each {|k,v|
- if(v.users.has_key?(sourcenick))
- irclog "@ #{sourcenick} is now known as #{nick}", k
- v.users[nick] = v.users[sourcenick]
- v.users.delete(sourcenick)
- end
- }
- @plugins.delegate("listen", m)
- @plugins.delegate("nick", m)
+ @plugins.irc_delegate("nick", m)
}
@client[:quit] = proc {|data|
source = data[:source]
- sourcenick = data[:sourcenick]
- sourceurl = data[:sourceaddress]
message = data[:message]
- m = QuitMessage.new(self, data[:source], data[:sourcenick], data[:message])
- if(data[:sourcenick] =~ /#{Regexp.escape(@nick)}/i)
- else
- @channels.each {|k,v|
- if(v.users.has_key?(sourcenick))
- irclog "@ Quit: #{sourcenick}: #{message}", k
- v.users.delete(sourcenick)
- end
- }
- end
- @plugins.delegate("listen", m)
- @plugins.delegate("quit", m)
+ m = QuitMessage.new(self, server, source, source, message)
+ m.was_on = data[:was_on]
+ @plugins.irc_delegate("quit", m)
}
@client[:mode] = proc {|data|
- source = data[:source]
- sourcenick = data[:sourcenick]
- sourceurl = data[:sourceaddress]
- channel = data[:channel]
- targets = data[:targets]
- modestring = data[:modestring]
- irclog "@ Mode #{modestring} #{targets} by #{sourcenick}", channel
+ m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
+ m.modes = data[:modes]
+ @plugins.delegate "modechange", m
}
- @client[:welcome] = proc {|data|
- 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]
- end
-
- @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
- }
+ @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, data[:source], data[:channel], data[:message])
- onjoin(m)
+ 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?
}
@client[:part] = proc {|data|
- m = PartMessage.new(self, data[:source], data[:channel], data[:message])
- onpart(m)
+ m = PartMessage.new(self, server, data[:source], data[:channel], data[:message])
+ @plugins.irc_delegate("part", m)
}
@client[:kick] = proc {|data|
- m = KickMessage.new(self, data[:source], data[:target],data[:channel],data[:message])
- onkick(m)
+ m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
+ @plugins.irc_delegate("kick", m)
}
@client[:invite] = proc {|data|
- if(data[:target] =~ /^#{Regexp.escape(@nick)}$/i)
- join data[:channel] if (@auth.allow?("join", data[:source], data[:sourcenick]))
- end
+ m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
+ @plugins.irc_delegate("invite", m)
}
@client[:changetopic] = proc {|data|
- channel = data[:channel]
- sourcenick = data[:sourcenick]
- topic = data[:topic]
- timestamp = data[:unixtime] || Time.now.to_i
- if(sourcenick == @nick)
- irclog "@ I set topic \"#{topic}\"", channel
- else
- irclog "@ #{sourcenick} set topic \"#{topic}\"", channel
- end
- m = TopicMessage.new(self, data[:source], data[:channel], timestamp, data[:topic])
-
- ontopic(m)
- @plugins.delegate("listen", m)
- @plugins.delegate("topic", m)
+ m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
+ m.info_or_set = :set
+ @plugins.irc_delegate("topic", m)
}
- @client[:topic] = @client[:topicinfo] = proc {|data|
+ # @client[:topic] = proc { |data|
+ # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
+ # }
+ @client[:topicinfo] = proc { |data|
channel = data[:channel]
- m = TopicMessage.new(self, data[:source], data[:channel], data[:unixtime], data[:topic])
- ontopic(m)
+ topic = channel.topic
+ m = TopicMessage.new(self, server, data[:source], channel, topic)
+ m.info_or_set = :info
+ @plugins.irc_delegate("topic", m)
}
- @client[:names] = proc {|data|
- channel = data[:channel]
- users = data[:users]
- unless(@channels[channel])
- 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[:names] = proc { |data|
+ m = NamesMessage.new(self, server, server, data[:channel])
+ m.users = data[:users]
+ @plugins.delegate "names", m
}
- @client[:unknown] = proc {|data|
+ @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,
+ :join_with => @config['send.join_with'].dup,
+ :max_lines => @config['send.max_lines'],
+ :overlong => @config['send.overlong'].to_sym,
+ :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 got_sig(sig)
- debug "received #{sig}, queueing quit"
- $interrupted += 1
+ 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_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\)/, plugdir_default)
+ @plugins.add_plugin_dir(path)
+ end
+ end
+
+ def set_default_send_options(opts={})
+ # Default send options for NOTICE and PRIVMSG
+ unless defined? @default_send_options
+ @default_send_options = {
+ :queue_channel => nil, # use default queue channel
+ :queue_ring => nil, # use default queue ring
+ :newlines => :split, # or :join
+ :join_with => ' ', # by default, use a single space
+ :max_lines => 0, # maximum number of lines to send with a single command
+ :overlong => :split, # or :truncate
+ # TODO an array of splitpoints would be preferrable for this option:
+ :split_at => /\s+/, # by default, split overlong lines at whitespace
+ :purge_split => true, # should the split string be removed?
+ :truncate_text => "#{Reverse}...#{Reverse}" # text to be appened when truncating
+ }
+ end
+ @default_send_options.update opts unless opts.empty?
+ end
+
+ # checks if we should be quiet on a channel
+ def quiet_on?(channel)
+ ch = channel.downcase
+ return (@quiet.include?('*') && !@not_quiet.include?(ch)) || @quiet.include?(ch)
+ end
+
+ def set_quiet(channel = nil)
+ if channel
+ ch = channel.downcase.dup
+ @not_quiet.delete(ch)
+ @quiet << ch
+ else
+ @quiet.clear
+ @not_quiet.clear
+ @quiet << '*'
+ end
+ end
+
+ def reset_quiet(channel = nil)
+ if channel
+ 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, 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 >= 5
+ if $interrupted >= 3
debug "drastic!"
log_session_end
exit 2
- elsif $interrupted >= 3
- debug "quitting"
- quit
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.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
+ 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 #{@config['server.name']} #{@config['server.port']}: " + e
+ raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
end
+ quit if $interrupted > 0
+
+ realname = @config['irc.name'].clone || 'Ruby bot'
+ realname << ' ' + COPYRIGHT_NOTICE if @config['irc.name_copyright']
+
@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
+ @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@socket.server_uri.host} :#{realname}"
+ quit if $interrupted > 0
+ myself.nick = @config['irc.nick']
+ 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
- @timer.start
-
+ quit_msg = nil
+ reconnect(quit_msg, too_fast)
+ quit if $interrupted > 0
while @socket.connected?
- if @socket.select
+ quit if $interrupted > 0
+
+ # Wait for messages and process them as they arrive. If nothing is
+ # received, we call the ping_server() method that will PING the
+ # server if appropriate, or raise a TimeoutError if no PONG has been
+ # received in the user-chosen timeout since the last PING sent.
+ if @socket.select(1)
break unless reply = @socket.gets
+ @last_rec = Time.now
@client.process reply
+ else
+ ping_server
end
- quit if $interrupted > 0
end
# I despair of this. Some of my users get "connection reset by peer"
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 Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
+ error "network exception: #{e.pretty_inspect}"
+ quit_msg = e.to_s
+ rescue ServerError => e
+ # 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
- error "fatal bdb error: #{e.class}: #{e}"
- error e.backtrace.join("\n")
+ fatal "fatal bdb error: #{e.pretty_inspect}"
DBTree.stats
- restart("Oops, we seem to have registry problems ...")
+ # 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
- error "unexpected exception: #{e.class}: #{e}"
- error e.backtrace.join("\n")
+ fatal "unexpected exception: #{e.pretty_inspect}"
log_session_end
exit 2
end
-
- stop_server_pings
- @channels.clear
- 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 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, 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}", chan, ring
- log_sent(type, where, message)
- return
- end
- line = message.slice!(0, left)
- lastspace = line.rindex(/\s+/)
- if(lastspace)
- message = line.slice!(lastspace, line.length) + message
- message.gsub!(/^\s+/, "")
- end
- sendq "#{type} #{where} :#{line}", chan, ring
- log_sent(type, where, line)
- end while(message.length > 0)
- end
+ 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
- # queue an arbitraty message for the server
- def sendq(message="", chan=nil, ring=0)
- # temporary
- @socket.queue(message, chan, ring)
- end
+ opts = ds[:options]
+ type = ds[:type]
+ where = ds[:dest]
+ filtered = ds[:text]
- # send a notice message to channel/nick +where+
- def notice(where, message, mchan=nil, mring=-1)
- if mchan == ""
- chan = where
- else
+ # For starters, set up appropriate queue channels and rings
+ mchan = opts[:queue_channel]
+ mring = opts[:queue_ring]
+ if mchan
chan = mchan
+ else
+ chan = where
end
- if mring < 0
- if where =~ /^#/
- ring = 2
- else
+ if mring
+ ring = mring
+ else
+ case where
+ when User
ring = 1
+ else
+ ring = 2
end
- else
- ring = mring
end
- message.each_line { |line|
- line.chomp!
- next unless(line.length > 0)
- sendmsg "NOTICE", where, line, chan, ring
- }
- end
- # say something (PRIVMSG) to channel/nick +where+
- def say(where, message, mchan="", mring=-1)
- if mchan == ""
- chan = where
+ 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
+ messages << [multi_line.gsub("\n", opts[:join_with])]
+ when :split
+ multi_line.each_line { |line|
+ line.chomp!
+ next unless(line.size > 0)
+ messages << line
+ }
else
- chan = mchan
+ raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
end
- if mring < 0
- if where =~ /^#/
- ring = 2
+
+ # The IRC protocol requires that each raw message must be not longer
+ # than 512 characters. From this length with have to subtract the EOL
+ # terminators (CR+LF) and the length of ":botnick!botuser@bothost "
+ # that will be prepended by the server to all of our messages.
+
+ # The maximum raw message length we can send is therefore 512 - 2 - 2
+ # minus the length of our hostmask.
+
+ max_len = 508 - myself.fullform.size
+
+ # On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
+ # will have a + or - prepended
+ if server.capabilities[:"identify-msg"]
+ max_len -= 1
+ end
+
+ # When splitting the message, we'll be prefixing the following string:
+ # (e.g. "PRIVMSG #rbot :")
+ fixed = "#{type} #{where} :"
+
+ # And this is what's left
+ left = max_len - fixed.size
+
+ truncate = opts[:truncate_text]
+ truncate = @default_send_options[:truncate_text] if truncate.size > left
+ truncate = "" if truncate.size > left
+
+ all_lines = messages.map { |line|
+ if line.size < left
+ line
else
- ring = 1
+ case opts[:overlong]
+ when :split
+ msg = line.dup
+ sub_lines = Array.new
+ begin
+ sub_lines << msg.slice!(0, left)
+ break if msg.empty?
+ lastspace = sub_lines.last.rindex(opts[:split_at])
+ if lastspace
+ msg.replace sub_lines.last.slice!(lastspace, sub_lines.last.size) + msg
+ msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
+ end
+ end until msg.empty?
+ sub_lines
+ when :truncate
+ line.slice(0, left - truncate.size) << truncate
+ else
+ raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
+ end
end
+ }.flatten
+
+ if opts[:max_lines] > 0 and all_lines.length > opts[:max_lines]
+ lines = all_lines[0...opts[:max_lines]]
+ new_last = lines.last.slice(0, left - truncate.size) << truncate
+ lines.last.replace(new_last)
else
- ring = mring
+ lines = all_lines
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, chan, ring
- end
+
+ lines.each { |line|
+ sendq "#{fixed}#{line}", chan, ring
+ delegate_sent(type, where, line)
}
end
+ # queue an arbitraty message for the server
+ def sendq(message="", chan=nil, ring=0)
+ # temporary
+ @socket.queue(message, chan, ring)
+ end
+
+ # send a notice message to channel/nick +where+
+ def notice(where, message, options={})
+ return if where.kind_of?(Channel) and quiet_on?(where)
+ sendmsg "NOTICE", where, message, options
+ end
+
+ # say something (PRIVMSG) to channel/nick +where+
+ def say(where, message, options={})
+ return if where.kind_of?(Channel) and quiet_on?(where)
+ 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, 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 =~ /^#/)
- irclog "* #{@nick} #{message}", where
- elsif (where =~ /^(\S*)!.*$/)
- irclog "* #{@nick}[#{where}] #{message}", $1
- else
- irclog "* #{@nick}[#{where}] #{message}", where
- end
+ def action(where, message, options={})
+ ctcp_say(where, 'ACTION', message, options)
end
# quick way to say "okay" (or equivalent) to +where+
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")
- where = where.gsub(/[:!?$*()\/\\<>|"']/, "_")
- unless(@logs.has_key?(where))
- @logs[where] = File.new("#{@botclass}/logs/#{where}", "a")
- @logs[where].sync = true
- end
- @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}", 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
- # disconnect from the server and cleanup all plugins and modules
- def shutdown(message = nil)
- 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?)
+ def disconnect(message=nil)
+ message = @lang.get("quit") if (!message || message.empty?)
if @socket.connected?
- debug "Clearing socket"
- @socket.clearq
- debug "Sending quit message"
- @socket.emergency_puts "QUIT :#{message}"
- debug "Flushing socket"
- @socket.flush
+ begin
+ debug "Clearing socket"
+ @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
+ error "error while disconnecting socket: #{e.pretty_inspect}"
+ end
debug "Shutting down socket"
@socket.shutdown
end
- debug "Logging quits"
- @channels.each_value {|v|
- irclog "@ quit (#{message})", v.name
- }
- 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})"
+ stop_server_pings
+ @client.reset
+ end
+
+ # disconnect from the server and cleanup all plugins and modules
+ def shutdown(message=nil)
+ @quit_mutex.synchronize do
+ debug "Shutting down: #{message}"
+ ## 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
+ debug "\tdisconnecting..."
+ disconnect(message)
+ debug "\tstopping timer..."
+ @timer.stop
+ debug "\tsaving ..."
+ save
+ debug "\tcleaning up ..."
+ @save_mutex.synchronize do
+ @plugins.cleanup
+ 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
# message:: optional IRC quit message
begin
shutdown(message)
ensure
- log_session_end
exit 0
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}"
+ 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
+ raise e
+ end
end
- # call the save method for bot's config, keywords, auth and all plugins
+ # call the save method for all of the botmodules
def save
- @config.save
- @keywords.save
- @auth.save
- @plugins.save
- DBTree.cleanup_logs
+ @save_mutex.synchronize do
+ @plugins.save
+ DBTree.cleanup_logs
+ end
end
- # call the rescan method for the bot's lang, keywords and all plugins
+ # call the rescan method for all of the botmodules
def rescan
- @lang.rescan
- @plugins.rescan
- @keywords.rescan
+ debug "\tstopping timer..."
+ @timer.stop
+ @save_mutex.synchronize do
+ @lang.rescan
+ @plugins.rescan
+ end
+ @timer.start
end
# channel:: channel to join
# attempt to change bot's nick to +name+
def nickchg(name)
- sendq "NICK #{name}"
+ sendq "NICK #{name}"
end
# changing mode
- def mode(channel, mode, target)
- sendq "MODE #{channel} #{mode} #{target}", channel, 2
+ 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
end
# m:: message asking for help
topic = nil if topic == ""
case topic
when nil
- helpstr = "help topics: core, auth, keywords"
+ helpstr = _("help topics: ")
helpstr += @plugins.helptopics
- helpstr += " (help <topic> for more info)"
- when /^core$/i
- helpstr = corehelp
- when /^core\s+(.+)$/i
- helpstr = corehelp $1
- when /^auth$/i
- helpstr = @auth.help
- when /^auth\s+(.+)$/i
- helpstr = @auth.help $1
- when /^keywords$/i
- helpstr = @keywords.help
- when /^keywords\s+(.+)$/i
- helpstr = @keywords.help $1
+ 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'll ping the server every 30 seconds or so, and expect a response
- # before the next one come around..
- def start_server_pings
- 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.queue "PING :rbot"
- }
- @pong_timer = @timer.add(10) {
- unless @last_ping.nil?
- diff = Time.now - @last_ping
- unless diff < @config['server.ping_timeout']
- debug "no PONG from server for #{diff} seconds, reconnecting"
- begin
- @socket.shutdown
- rescue
- debug "couldn't shutdown connection (already shutdown?)"
- end
- @last_ping = nil
+ # We want to respond to a hung server in a timely manner. If nothing was received
+ # in the user-selected timeout and we haven't PINGed the server yet, we PING
+ # the server. If the PONG is not received within the user-defined timeout, we
+ # assume we're in ping timeout and act accordingly.
+ def ping_server
+ act_timeout = @config['server.ping_timeout']
+ return if act_timeout <= 0
+ now = Time.now
+ if @last_rec && now > @last_rec + act_timeout
+ if @last_ping.nil?
+ # No previous PING pending, send a new one
+ sendq "PING :rbot"
+ @last_ping = Time.now
+ else
+ diff = now - @last_ping
+ if diff > act_timeout
+ debug "no PONG from server in #{diff} seconds, reconnecting"
+ # the actual reconnect is handled in the main loop:
raise TimeoutError, "no PONG from server in #{diff} seconds"
end
end
- }
+ end
end
def stop_server_pings
+ # cancel previous PINGs and reset time of last RECV
@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
+ @last_rec = nil
end
private
- # handle help requests for "core" topics
- def corehelp(topic="")
- case topic
- when "quit"
- return "quit [<message>] => quit IRC with message <message>"
- when "restart"
- return "restart => completely stop and restart the bot (including reconnect)"
- when "join"
- return "join <channel> [<key>] => join channel <channel> with secret key <key> if specified. #{@nick} also responds to invites if you have the required access level"
- when "part"
- return "part <channel> => part channel <channel>"
- when "hide"
- return "hide => part all channels"
- when "save"
- return "save => save current dynamic data and configuration"
- when "rescan"
- return "rescan => reload modules and static facts"
- when "nick"
- return "nick <nick> => attempt to change nick to <nick>"
- when "say"
- 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 "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"
- return "talk [in here|<channel>] => with no arguments, resume speaking in all channels, if \"in here\", resume speaking in this channel, or resume speaking in <channel>"
- when "version"
- return "version => describes software version"
- when "botsnack"
- return "botsnack => reward #{@nick} for being good"
- when "hello"
- return "hello|hi|hey|yo [#{@nick}] => greet the bot"
- else
- return "Core help topics: quit, restart, config, join, part, hide, save, rescan, nick, say, action, topic, quiet, talk, version, botsnack, hello"
- end
- end
-
- # handle incoming IRC PRIVMSG +m+
- def onprivmsg(m)
- # log it first
- if(m.action?)
- if(m.private?)
- irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
- else
- irclog "* #{m.sourcenick} #{m.message}", m.target
- end
- else
- if(m.public?)
- irclog "<#{m.sourcenick}> #{m.message}", m.target
- else
- 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"
- 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))
- when (/^join\s+(\S+)$/i)
- join $1 if(@auth.allow?("join", m.source, m.replyto))
- when (/^part$/i)
- part m.target if(m.public? && @auth.allow?("join", m.source, m.replyto))
- when (/^part\s+(\S+)$/i)
- part $1 if(@auth.allow?("join", m.source, m.replyto))
- when (/^quit(?:\s+(.*))?$/i)
- quit $1 if(@auth.allow?("quit", m.source, m.replyto))
- when (/^restart(?:\s+(.*))?$/i)
- restart $1 if(@auth.allow?("quit", m.source, m.replyto))
- when (/^hide$/i)
- join 0 if(@auth.allow?("join", m.source, m.replyto))
- when (/^save$/i)
- if(@auth.allow?("config", m.source, m.replyto))
- save
- m.okay
- end
- when (/^nick\s+(\S+)$/i)
- nickchg($1) if(@auth.allow?("nick", m.source, m.replyto))
- when (/^say\s+(\S+)\s+(.*)$/i)
- 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 (/^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.reply "Saving ..."
- save
- m.reply "Rescanning ..."
- rescan
- m.okay
- end
- when (/^quiet$/i)
- if(auth.allow?("talk", m.source, m.replyto))
- m.okay
- @channels.each_value {|c| c.quiet = true }
- end
- when (/^quiet in (\S+)$/i)
- where = $1
- if(auth.allow?("talk", m.source, m.replyto))
- m.okay
- where.gsub!(/^here$/, m.target) if m.public?
- @channels[where].quiet = true if(@channels.has_key?(where))
- end
- when (/^talk$/i)
- if(auth.allow?("talk", m.source, m.replyto))
- @channels.each_value {|c| c.quiet = false }
- m.okay
- end
- when (/^talk in (\S+)$/i)
- where = $1
- if(auth.allow?("talk", m.source, m.replyto))
- where.gsub!(/^here$/, m.target) if m.public?
- @channels[where].quiet = false if(@channels.has_key?(where))
- m.okay
- end
- when (/^status\??$/i)
- m.reply status if auth.allow?("status", m.source, m.replyto)
- when (/^registry stats$/i)
- if auth.allow?("config", m.source, m.replyto)
- m.reply @registry.stat.inspect
- end
- when (/^(help\s+)?config(\s+|$)/)
- @config.privmsg(m)
- when (/^(version)|(introduce yourself)$/i)
- say m.replyto, "I'm a v. #{$version} rubybot, (c) Tom Gilbert - http://linuxbrit.co.uk/rbot/"
- when (/^help(?:\s+(.*))?$/i)
- say m.replyto, help($1)
- #TODO move these to a "chatback" plugin
- when (/^(botsnack|ciggie)$/i)
- say m.replyto, @lang.get("thanks_X") % m.sourcenick if(m.public?)
- say m.replyto, @lang.get("thanks") if(m.private?)
- 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?)
- end
- else
- # stuff to handle when not addressed
- case m.message
- when (/^\s*(hello|howdy|hola|salut|bonjour|sup|niihau|hey|hi|yo(\W|$))[\s,-.]+#{Regexp.escape(@nick)}$/i)
- say m.replyto, @lang.get("hello_X") % m.sourcenick
- when (/^#{Regexp.escape(@nick)}!*$/)
- say m.replyto, @lang.get("hello_X") % m.sourcenick
- else
- @keywords.privmsg(m)
- 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"
- if(where =~ /^#/)
- irclog "-=#{@nick}=- #{message}", where
- elsif (where =~ /(\S*)!.*/)
- irclog "[-=#{where}=-] #{message}", $1
- else
- irclog "[-=#{where}=-] #{message}"
- end
+ m = NoticeMessage.new(*args)
when "PRIVMSG"
- if(where =~ /^#/)
- irclog "<#{@nick}> #{message}", where
- elsif (where =~ /^(\S*)!.*$/)
- irclog "[msg(#{where})] #{message}", $1
- else
- irclog "[msg(#{where})] #{message}", where
- end
- end
- end
-
- def onjoin(m)
- @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
- if(m.address?)
- debug "joined channel #{m.channel}"
- irclog "@ Joined channel #{m.channel}", m.channel
- else
- 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
-
- @plugins.delegate("listen", m)
- @plugins.delegate("join", m)
- end
-
- def onpart(m)
- if(m.address?)
- debug "left channel #{m.channel}"
- irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
- @channels.delete(m.channel)
- else
- 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)
- end
-
- # respond to being kicked from a channel
- def onkick(m)
- if(m.address?)
- debug "kicked from channel #{m.channel}"
- @channels.delete(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)
- irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.sourcenick} (#{m.message})", m.channel
+ m = PrivMessage.new(*args)
+ when "QUIT"
+ m = QuitMessage.new(*args)
+ m.was_on = myself.channels
end
-
- @plugins.delegate("listen", m)
- @plugins.delegate("kick", m)
- end
-
- def ontopic(m)
- @channels[m.channel] = IRCChannel.new(m.channel) unless(@channels.has_key?(m.channel))
- @channels[m.channel].topic = m.topic if !m.topic.nil?
- @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}"
+ @plugins.delegate('sent', m)
end
- # delegate a privmsg to auth, keyword or plugin handlers
- def delegate_privmsg(message)
- [@auth, @plugins, @keywords].each {|m|
- break if m.privmsg(message)
- }
- end
end
end