require 'thread'
+
require 'etc'
require 'fileutils'
+require 'logger'
$debug = false unless $debug
-# print +message+ if debugging is enabled
-def debug(message=nil)
- stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
- print "D: [#{stamp}] #{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
+ # 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|
+ $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'
-require 'rbot/utils'
+# require 'rbot/utils'
+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/channel'
require 'rbot/message'
require 'rbot/language'
require 'rbot/dbhash'
require 'rbot/registry'
-require 'rbot/httputil'
+# 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"
+ # the bot's Auth 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
-
+
+ # synchronize with this mutex while touching permanent data files:
+ # saving, flushing, cleaning up ...
+ attr_reader :save_mutex
+
# bot's Language data
attr_reader :lang
- # 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
# 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
+ 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
- # create a new IrcBot with botclass +botclass+
+ # create a new Bot with botclass +botclass+
def initialize(botclass, params = {})
# BotConfig for the core bot
- 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)
+ # TODO should we split socket stuff into ircsocket, etc?
+ BotConfig.register BotConfigArrayValue.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.")
+ BotConfig.register BotConfigBooleanValue.new('server.ssl',
+ :default => false, :requires_restart => true, :wizard => true,
+ :desc => "Use SSL to connect to this server?")
BotConfig.register BotConfigStringValue.new('server.password',
:default => false, :requires_restart => true,
:desc => "Password for connecting to this server (if required)",
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 BotConfigIntegerValue.new('server.ping_timeout',
+ :default => 30, :validate => Proc.new{|v| v >= 0},
+ :desc => "reconnect if server doesn't respond to PING within this many seconds (set to 0 to disable)")
+
BotConfig.register BotConfigStringValue.new('irc.nick', :default => "rbot",
:desc => "IRC nickname the bot should attempt to use", :wizard => true,
:on_change => Proc.new{|bot, v| bot.sendq "NICK #{v}" })
+ BotConfig.register BotConfigStringValue.new('irc.name',
+ :default => "Ruby bot", :requires_restart => true,
+ :desc => "IRC realname the bot should use")
+ BotConfig.register BotConfigBooleanValue.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)")
BotConfig.register BotConfigStringValue.new('irc.user', :default => "rbot",
:requires_restart => true,
:desc => "local user the bot should appear to be", :wizard => true)
BotConfig.register BotConfigArrayValue.new('irc.join_channels',
:default => [], :wizard => true,
:desc => "What channels the bot should always join at startup. List multiple channels using commas to separate. If a channel requires a password, use a space after the channel name. e.g: '#chan1, #chan2, #secretchan secritpass, #chan3'")
+ BotConfig.register BotConfigArrayValue.new('irc.ignore_users',
+ :default => [],
+ :desc => "Which users to ignore input from. This is mainly to avoid bot-wars triggered by creative people")
+
BotConfig.register BotConfigIntegerValue.new('core.save_every',
:default => 60, :validate => Proc.new{|v| v >= 0},
- # TODO change timer via on_change proc
- :desc => "How often the bot should persist all configuration to disk (in case of a server crash, for example")
- BotConfig.register 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)")
+ :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.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)")
+
+ BotConfig.register BotConfigArrayValue.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")
+
+ BotConfig.register BotConfigEnumValue.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")
+ BotConfig.register BotConfigStringValue.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")
+ BotConfig.register BotConfigIntegerValue.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)")
+ BotConfig.register BotConfigEnumValue.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")
+ BotConfig.register BotConfigStringValue.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)")
+ BotConfig.register BotConfigBooleanValue.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)")
+ BotConfig.register BotConfigStringValue.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")
@argv = params[:argv]
+ unless FileTest.directory? Config::coredir
+ error "core directory '#{Config::coredir}' not found, did you setup.rb?"
+ exit 2
+ end
+
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.getpwuid(Process::Sys.geteuid)[: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")
+ Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
- @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)
-# TODO background self after botconfig has a chance to run wizard
- @timer = Timer::Timer.new(1.0) # only need per-second granularity
+
+ begin
+ @config = BotConfig.configmanager
+ @config.bot_associate(self)
+ rescue => e
+ fatal e.inspect
+ fatal e.backtrace.join("\n")
+ 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?
+ @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.size
+ 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.size
+ 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
+
@registry = BotRegistry.new self
- @timer.add(@config['core.save_every']) { save } if @config['core.save_every']
- @channels = Hash.new
+
+ @timer = Timer::Timer.new(1.0) # only need per-second granularity
+ @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
+
@logs = Hash.new
- @httputil = Utils::HttpUtil.new(self)
- @lang = Language::Language.new(@config['core.language'])
- @keywords = Keywords.new(self)
- @auth = IrcAuth.new(self)
+
+ @plugins = nil
+ @lang = Language::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")
+ log_session_end
+ exit 2
+ end
+ @auth.everyone.set_default_permission("*", true)
+ @auth.botowner.password= @config['auth.password']
Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
- @plugins = Plugins::Plugins.new(self, ["#{botclass}/plugins"])
+ @plugins = Plugins::manager
+ @plugins.bot_associate(self)
+ setup_plugins_path()
- @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'])
- @nick = @config['irc.nick']
+ 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 = IrcSocket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
+ @client = Client.new
+
+ @plugins.scan
+
+ # Channels where we are quiet
+ # Array of channels names where the bot should be quiet
+ # '*' means all channels
+ #
+ @quiet = []
+
+ @client[:welcome] = proc {|data|
+ irclog "joined server #{@client.server} as #{myself}", "server"
+
+ @plugins.delegate("connect")
+
+ @config['irc.join_channels'].each { |c|
+ debug "autojoining channel #{c}"
+ if(c =~ /^(\S+)\s+(\S+)$/i)
+ join $1, $2
+ else
+ join c if(c)
+ end
+ }
+ }
+
+ # TODO the next two @client should go into rfc2812.rb, probably
+ # 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 server.supports[:capab] and !asked_for[:"identify-msg"]
+ sendq "CAPAB IDENTIFY-MSG"
+ asked_for[:"identify-msg"] = true
+ end
+ }
+ @client[:datastr] = proc { |data|
+ if data[:text] == "IDENTIFY-MSG"
+ server.capabilities[:"identify-msg"] = true
+ else
+ debug "Not handling RPL_DATASTR #{data[:servermessage]}"
+ end
+ }
- @client = IrcClient.new
@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])
+ # debug "Message source is #{data[:source].inspect}"
+ # debug "Message target is #{data[:target].inspect}"
+ # debug "Bot is #{myself.inspect}"
+
+ ignored = false
+ @config['irc.ignore_users'].each { |mask|
+ if m.source.matches?(server.new_netmask(mask))
+ ignored = true
+ break
+ end
+ }
+
+ irclogprivmsg(m)
+
+ unless ignored
+ @plugins.delegate "listen", m
+ @plugins.privmsg(m) if m.address?
+ if not m.replied
+ @plugins.delegate "unreplied", m
+ end
+ end
}
@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])
# pass it off to plugins that want to hear everything
@plugins.delegate "listen", message
}
@client[:motd] = proc { |data|
data[:motd].each_line { |line|
- log "MOTD: #{line}", "server"
+ irclog "MOTD: #{line}", "server"
}
}
- @client[:nicktaken] = proc { |data|
- nickchg "#{data[:nick]}_"
+ @client[:nicktaken] = proc { |data|
+ 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|
- puts "WARNING, bad nick (#{data[:nick]})"
+ @client[:badnick] = proc {|data|
+ arning "bad nick (#{data[:nick]})"
}
@client[:ping] = proc {|data|
- # (jump the queue for pongs)
- @socket.puts "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)
+ if source == myself
+ debug "my nick is now #{new}"
end
- @channels.each {|k,v|
- if(v.users.has_key?(sourcenick))
- log "@ #{sourcenick} is now known as #{nick}", k
- v.users[nick] = v.users[sourcenick]
- v.users.delete(sourcenick)
- end
+ data[:is_on].each { |ch|
+ irclog "@ #{old} is now known as #{new}", ch
}
@plugins.delegate("listen", m)
@plugins.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))
- log "@ Quit: #{sourcenick}: #{message}", k
- v.users.delete(sourcenick)
- end
- }
- end
+ m = QuitMessage.new(self, server, source, source, message)
+ data[:was_on].each { |ch|
+ irclog "@ Quit: #{source}: #{message}", ch
+ }
@plugins.delegate("listen", m)
@plugins.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]
- log "@ Mode #{modestring} #{targets} by #{sourcenick}", channel
- }
- @client[:welcome] = proc {|data|
- log "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
- }
+ irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
}
@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])
+ irclogjoin(m)
+
+ @plugins.delegate("listen", m)
+ @plugins.delegate("join", m)
}
@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])
+ irclogpart(m)
+
+ @plugins.delegate("listen", m)
+ @plugins.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])
+ irclogkick(m)
+
+ @plugins.delegate("listen", m)
+ @plugins.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]))
+ if data[:target] == myself
+ join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
end
}
@client[:changetopic] = proc {|data|
- channel = data[:channel]
- sourcenick = data[:sourcenick]
- topic = data[:topic]
- timestamp = data[:unixtime] || Time.now.to_i
- if(sourcenick == @nick)
- log "@ I set topic \"#{topic}\"", channel
- else
- log "@ #{sourcenick} set topic \"#{topic}\"", channel
- end
- m = TopicMessage.new(self, data[:source], data[:channel], timestamp, data[:topic])
+ m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
+ irclogtopic(m)
- ontopic(m)
@plugins.delegate("listen", m)
@plugins.delegate("topic", m)
}
- @client[:topic] = @client[:topicinfo] = proc {|data|
- channel = data[:channel]
- m = TopicMessage.new(self, data[:source], data[:channel], data[:unixtime], data[:topic])
- ontopic(m)
+ @client[:topic] = proc { |data|
+ irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
}
- @client[:names] = proc {|data|
+ @client[:topicinfo] = proc { |data|
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
- end
- @channels[channel].users.clear
- users.each {|u|
- @channels[channel].users[u[0].sub(/^[@&~+]/, '')] = ["mode", u[1]]
- }
+ topic = channel.topic
+ irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", channel
+ m = TopicMessage.new(self, server, data[:source], channel, topic)
+
+ @plugins.delegate("listen", m)
+ @plugins.delegate("topic", m)
+ }
+ @client[:names] = proc { |data|
+ @plugins.delegate "names", data[:channel], data[:users]
}
- @client[:unknown] = proc {|data|
+ @client[:unknown] = proc { |data|
#debug "UNKNOWN: #{data[:serverstring]}"
- log data[:serverstring], ".unknown"
+ irclog data[:serverstring], ".unknown"
}
+
+ 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
+ end
+
+ def setup_plugins_path
+ @plugins.clear_botmodule_dirs
+ @plugins.add_botmodule_dir(Config::coredir + "/utils")
+ @plugins.add_botmodule_dir(Config::coredir)
+ @plugins.add_botmodule_dir("#{botclass}/plugins")
+
+ @config['plugins.path'].each do |_|
+ path = _.sub(/^\(default\)/, Config::datadir + '/plugins')
+ @plugins.add_botmodule_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)
+ return @quiet.include?('*') || @quiet.include?(channel.downcase)
+ end
+
+ def set_quiet(channel)
+ if channel
+ ch = channel.downcase.dup
+ @quiet << ch unless @quiet.include?(ch)
+ else
+ @quiet.clear
+ @quiet << '*'
+ end
+ end
+
+ def reset_quiet(channel)
+ if channel
+ @quiet.delete channel.downcase
+ else
+ @quiet.clear
+ end
+ end
+
+ # things to do when we receive a signal
+ def got_sig(sig)
+ debug "received #{sig}, queueing quit"
+ $interrupted += 1
+ quit unless @quit_mutex.locked?
+ debug "interrupted #{$interrupted} times"
+ if $interrupted >= 3
+ debug "drastic!"
+ log_session_end
+ exit 2
+ end
end
# connect the bot to IRC
def connect
begin
- trap("SIGINT") { quit }
- trap("SIGTERM") { quit }
- trap("SIGHUP") { 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
+ raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + 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"
- start_server_pings
+ 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 #{@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
# begin event handling loop
def mainloop
while true
begin
+ quit if $interrupted > 0
connect
@timer.start
-
+
+ quit_msg = nil
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
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 TimeoutError => e
- puts e
+ rescue Errno::ETIMEDOUT, Errno::ECONNABORTED, TimeoutError, SocketError => e
+ error "network exception: #{e.class}: #{e}"
+ debug e.backtrace.join("\n")
+ quit_msg = e.to_s
+ 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: #{e.inspect}"
- puts e.backtrace.join("\n")
- @socket.shutdown # now we reconnect
+ error "non-net exception: #{e.class}: #{e}"
+ error e.backtrace.join("\n")
+ quit_msg = e.to_s
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"
- @last_ping = nil
- @channels.clear
- @socket.clearq
-
- puts "waiting to reconnect"
+
+ disconnect(quit_msg)
+
+ log "\n\nDisconnected\n\n"
+
+ quit if $interrupted > 0
+
+ log "\n\nWaiting to reconnect\n\n"
sleep @config['server.reconnect_wait']
end
end
-
+
# 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
- begin
- if(left >= message.length)
- sendq("#{type} #{where} :#{message}")
- log_sent(type, where, message)
- return
+ def sendmsg(type, where, original_message, options={})
+ opts = @default_send_options.merge(options)
+
+ # 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
+ ring = mring
+ else
+ case where
+ when User
+ ring = 1
+ else
+ ring = 2
end
- line = message.slice!(0, left)
- lastspace = line.rindex(/\s+/)
- if(lastspace)
- message = line.slice!(lastspace, line.length) + message
- message.gsub!(/^\s+/, "")
+ end
+
+ multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
+ 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
+ raise "Unknown :newlines option #{opts[:newlines]} while sending #{original_message.inspect}"
+ end
+
+ # 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
+ 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
- sendq("#{type} #{where} :#{line}")
+ }.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
+ lines = all_lines
+ end
+
+ lines.each { |line|
+ sendq "#{fixed}#{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)
- message.each_line { |line|
- line.chomp!
- next unless(line.length > 0)
- sendmsg("NOTICE", where, line)
- }
+ 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)
- 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)
- end
- }
+ def say(where, message, options={})
+ return if where.kind_of?(Channel) and quiet_on?(where)
+ sendmsg "PRIVMSG", where, message, options
end
# perform a CTCP action with message +message+ to channel/nick +where+
- def action(where, message)
- sendq("PRIVMSG #{where} :\001ACTION #{message}\001")
- if(where =~ /^#/)
- log "* #{@nick} #{message}", where
- elsif (where =~ /^(\S*)!.*$/)
- log "* #{@nick}[#{where}] #{message}", $1
+ 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
- log "* #{@nick}[#{where}] #{message}", where
+ 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
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")
+ # 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
+ if where.class <= Server
+ where_str = "server"
+ else
+ where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
+ end
+ unless(@logs.has_key?(where_str))
+ @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
+ @logs[where_str].sync = true
end
- @logs[where].puts "[#{stamp}] #{message}"
+ @logs[where_str].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)
- begin
- trap("SIGINT", "DEFAULT")
- trap("SIGTERM", "DEFAULT")
- trap("SIGHUP", "DEFAULT")
- rescue
- debug "failed to trap signals, probably running on windows?"
- end
+ def disconnect(message = nil)
message = @lang.get("quit") if (message.nil? || message.empty?)
- debug "Clearing socket"
- @socket.clearq
- debug "Saving"
- save
- debug "Cleaning up"
- @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
+ server.channels.each { |ch|
+ irclog "@ quit (#{message})", ch
}
- # debug "Closing registries"
- # @registry.close
- debug "Cleaning up the db environment"
- DBTree.cleanup_env
- debug "Sending quit message"
- @socket.puts "QUIT :#{message}"
- debug "Flushing socket"
- @socket.flush
- debug "Shutting down socket"
- @socket.shutdown
- puts "rbot quit (#{message})"
- end
-
+ 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 ..."
+ ## 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
+ disconnect
+ debug "Saving"
+ save
+ debug "Cleaning up"
+ @save_mutex.synchronize do
+ @plugins.cleanup
+ end
+ # debug "Closing registries"
+ # @registry.close
+ debug "Cleaning up the db environment"
+ DBTree.cleanup_env
+ log "rbot quit (#{message})"
+ end
+ end
+
# message:: optional IRC quit message
# quit IRC, shutdown the bot
def quit(message=nil)
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
+ # 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
+ @save_mutex.synchronize do
+ @lang.rescan
+ @plugins.rescan
+ end
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+
def nickchg(name)
- sendq "NICK #{name}"
+ sendq "NICK #{name}"
end
# changing mode
def mode(channel, mode, target)
- sendq "MODE #{channel} #{mode} #{target}"
+ sendq "MODE #{channel} #{mode} #{target}", channel, 2
+ end
+
+ # kicking a user
+ def kick(channel, user, msg)
+ sendq "KICK #{channel} #{user} :#{msg}", channel, 2
end
-
+
# m:: message asking for help
# topic:: optional topic help is requested for
# respond to online help requests
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
else
unless(helpstr = @plugins.help(topic))
helpstr = "no help for topic #{topic}"
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
- @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
- 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"
- }
- @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?)"
- ensure
- raise TimeoutError, "no PONG from server in #{diff} seconds"
- 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
- 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
+ def stop_server_pings
+ # cancel previous PINGs and reset time of last RECV
+ @last_ping = nil
+ @last_rec = nil
end
- # handle incoming IRC PRIVMSG +m+
- def onprivmsg(m)
- # log it first
+ private
+
+ def irclogprivmsg(m)
if(m.action?)
if(m.private?)
- log "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
+ irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
else
- log "* #{m.sourcenick} #{m.message}", m.target
+ irclog "* #{m.source} #{m.message}", m.target
end
else
if(m.public?)
- log "<#{m.sourcenick}> #{m.message}", m.target
+ irclog "<#{m.source}> #{m.message}", m.target
else
- log "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
- end
- end
-
- # 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"
- 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)
+ irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
end
end
end
def log_sent(type, where, message)
case type
when "NOTICE"
- if(where =~ /^#/)
- log "-=#{@nick}=- #{message}", where
- elsif (where =~ /(\S*)!.*/)
- log "[-=#{where}=-] #{message}", $1
+ case where
+ when Channel
+ irclog "-=#{myself}=- #{message}", where
else
- log "[-=#{where}=-] #{message}"
+ irclog "[-=#{where}=-] #{message}", where
end
when "PRIVMSG"
- if(where =~ /^#/)
- log "<#{@nick}> #{message}", where
- elsif (where =~ /^(\S*)!.*$/)
- log "[msg(#{where})] #{message}", $1
+ case where
+ when Channel
+ irclog "<#{myself}> #{message}", where
else
- log "[msg(#{where})] #{message}", where
+ 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?)
+ def irclogjoin(m)
+ 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
- @channels[m.channel].users[m.sourcenick] = Hash.new
- @channels[m.channel].users[m.sourcenick]["mode"] = ""
+ irclog "@ #{m.source} joined channel #{m.channel}", m.channel
end
-
- @plugins.delegate("listen", m)
- @plugins.delegate("join", m)
end
- def onpart(m)
+ def irclogpart(m)
if(m.address?)
debug "left channel #{m.channel}"
- log "@ Left channel #{m.channel} (#{m.message})", m.channel
- @channels.delete(m.channel)
+ irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
else
- log "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
- @channels[m.channel].users.delete(m.sourcenick)
+ irclog "@ #{m.source} left channel #{m.channel} (#{m.message})", m.channel
end
-
- # delegate to plugins
- @plugins.delegate("listen", m)
- @plugins.delegate("part", m)
end
- # respond to being kicked from a channel
- def onkick(m)
+ def irclogkick(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.source} (#{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.source} (#{m.message})", m.channel
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}"
+ def irclogtopic(m)
+ if m.source == myself
+ irclog "@ I set topic \"#{m.topic}\"", m.channel
+ else
+ irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
+ end
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
projects / user / henk / code / ruby / rbot.git / blobdiff