# 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 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
# bot User in the client/server connection
# TODO multiserver
def myself
- @client.client
+ @client.user
end
# bot User in the client/server connection
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
# 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 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('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)
: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 plugin. 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|
@auth.botowner.password= @config['auth.password']
Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
- @plugins = Plugins::pluginmanager
+ @plugins = Plugins::manager
@plugins.bot_associate(self)
- @plugins.add_botmodule_dir(Config::coredir + "/utils")
- @plugins.add_botmodule_dir(Config::coredir)
- @plugins.add_botmodule_dir("#{botclass}/plugins")
- @plugins.add_botmodule_dir(Config::datadir + "/plugins")
+ 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 = 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
Utils.set_safe_save_dir("#{botclass}/safe_save")
@httputil = Utils::HttpUtil.new(self)
-
- @socket = IrcSocket.new(@config['server.name'], @config['server.port'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
- @client = IrcClient.new
-
# Channels where we are quiet
# Array of channels names where the bot should be quiet
# '*' means all channels
@last_ping = nil
}
@client[:nick] = proc {|data|
+ # debug "Message source is #{data[:source].inspect}"
+ # debug "Bot is #{myself.inspect}"
source = data[:source]
old = data[:oldnick]
new = data[:newnick]
: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
quit if $interrupted > 0
@socket.connect
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 #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :Ruby bot. (c) Tom Gilbert and the rbot development team"
+ @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']
connect
@timer.start
+ quit_msg = nil
while @socket.connected?
quit if $interrupted > 0
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")
rescue Exception => e
error "non-net exception: #{e.class}: #{e}"
error e.backtrace.join("\n")
+ quit_msg = e.to_s
rescue => e
fatal "unexpected exception: #{e.class}: #{e}"
fatal e.backtrace.join("\n")
exit 2
end
- stop_server_pings
- server.clear
- if @socket.connected?
- @socket.clearq
- @socket.shutdown
- end
+ disconnect(quit_msg)
- log "disconnected"
+ log "\n\nDisconnected\n\n"
quit if $interrupted > 0
- log "waiting to reconnect"
+ log "\n\nWaiting to reconnect\n\n"
sleep @config['server.reconnect_wait']
end
end
def irclog(message, where="server")
message = message.chomp
stamp = Time.now.strftime("%Y/%m/%d %H:%M:%S")
- where = where.downcase.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
- @logs[where].puts "[#{stamp}] #{message}"
+ unless(@logs.has_key?(where_str))
+ @logs[where_str] = File.new("#{@botclass}/logs/#{where_str}", "a")
+ @logs[where_str].sync = true
+ end
+ @logs[where_str].puts "[#{stamp}] #{message}"
#debug "[#{stamp}] <#{where}> #{message}"
end
sendq "TOPIC #{where} :#{topic}", where, 2
end
+ def disconnect(message = nil)
+ message = @lang.get("quit") if (message.nil? || message.empty?)
+ 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"
+ server.channels.each { |ch|
+ irclog "@ quit (#{message})", ch
+ }
+ stop_server_pings
+ @client.reset
+ end
+
# disconnect from the server and cleanup all plugins and modules
def shutdown(message = nil)
@quit_mutex.synchronize do
# rescue => e
# debug "failed to restore signals: #{e.inspect}\nProbably running on windows?"
# end
- message = @lang.get("quit") if (message.nil? || message.empty?)
- 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"
- server.channels.each { |ch|
- irclog "@ quit (#{message})", ch
- }
+ disconnect
debug "Saving"
save
debug "Cleaning up"
def irclogprivmsg(m)
if(m.action?)
if(m.private?)
- irclog "* [#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
+ irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
else
- irclog "* #{m.sourcenick} #{m.message}", m.target
+ irclog "* #{m.source} #{m.message}", m.target
end
else
if(m.public?)
- irclog "<#{m.sourcenick}> #{m.message}", m.target
+ irclog "<#{m.source}> #{m.message}", m.target
else
- irclog "[#{m.sourcenick}(#{m.sourceaddress})] #{m.message}", m.sourcenick
+ irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
end
end
end
debug "joined channel #{m.channel}"
irclog "@ Joined channel #{m.channel}", m.channel
else
- irclog "@ #{m.sourcenick} joined channel #{m.channel}", m.channel
+ irclog "@ #{m.source} joined channel #{m.channel}", m.channel
end
end
debug "left channel #{m.channel}"
irclog "@ Left channel #{m.channel} (#{m.message})", m.channel
else
- irclog "@ #{m.sourcenick} left channel #{m.channel} (#{m.message})", m.channel
+ irclog "@ #{m.source} left channel #{m.channel} (#{m.message})", m.channel
end
end
def irclogkick(m)
if(m.address?)
debug "kicked from channel #{m.channel}"
- irclog "@ 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
- irclog "@ #{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
end
projects / user / henk / code / ruby / rbot.git / blobdiff