# 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('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)/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|
end
def STDOUT.write(str=nil)
log str, 2
- return str.to_s.length
+ return str.to_s.size
end
def STDERR.write(str=nil)
if str.to_s.match(/:\d+: warning:/)
else
error str, 2
end
- return str.to_s.length
+ return str.to_s.size
end
end
Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
@plugins = Plugins::pluginmanager
@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()
+
+ @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 = 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
- myself.nick = @config['irc.nick']
-
# Channels where we are quiet
# Array of channels names where the bot should be quiet
# '*' means all channels
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|
}
}
@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
+ # yo 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]})"
+ arning "bad nick (#{data[:nick]})"
}
@client[:ping] = proc {|data|
sendq "PONG #{data[:pingid]}"
@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
raise e.class, "failed to connect to IRC server at #{@config['server.name']} #{@config['server.port']}: " + 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"
+ @socket.emergency_puts "NICK #{@config['irc.nick']}\nUSER #{@config['irc.user']} 4 #{@config['server.name']} :#{realname}"
quit if $interrupted > 0
+ myself.nick = @config['irc.nick']
+ myself.user = @config['irc.user']
end
# begin event handling loop
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
lines = Array.new
message.each_line { |line|
line.chomp!
- next unless(line.length > 0)
+ next unless(line.size > 0)
lines << line
}
else
# The maximum raw message length we can send is therefore 512 - 2 - 2
# minus the length of our hostmask.
- max_len = 508 - myself.fullform.length
+ max_len = 508 - myself.fullform.size
# On servers that support IDENTIFY-MSG, we have to subtract 1, because messages
# will have a + or - prepended
fixed = "#{type} #{where} :"
# And this is what's left
- left = max_len - fixed.length
+ left = max_len - fixed.size
case opts[:overlong]
when :split
split_at = opts[:split_at]
when :truncate
truncate = opts[:truncate_text]
- truncate = @default_send_options[:truncate_text] if truncate.length > left
- truncate = "" if truncate.length > left
+ truncate = @default_send_options[:truncate_text] if truncate.size > left
+ truncate = "" if truncate.size > left
else
raise "Unknown :overlong option #{opts[:overlong]} while sending #{original_message.inspect}"
end
begin
if max_lines > 0 and cmd_lines == max_lines - 1
truncate = opts[:truncate_text]
- truncate = @default_send_options[:truncate_text] if truncate.length > left
- truncate = "" if truncate.length > left
+ truncate = @default_send_options[:truncate_text] if truncate.size > left
+ truncate = "" if truncate.size > left
maxed = true
end
- if(left >= msg.length) and not maxed
+ if(left >= msg.size) and not maxed
sendq "#{fixed}#{msg}", chan, ring
log_sent(type, where, msg)
cmd_lines += 1
break
end
if truncate
- line.replace msg.slice(0, left-truncate.length)
+ line.replace msg.slice(0, left-truncate.size)
# line.sub!(/\s+\S*$/, truncate)
line << truncate
- raise "PROGRAMMER ERROR! #{line.inspect} of length #{line.length} > #{left}" if line.length > left
+ raise "PROGRAMMER ERROR! #{line.inspect} of size #{line.size} > #{left}" if line.size > left
sendq "#{fixed}#{line}", chan, ring
log_sent(type, where, line)
return
line.replace msg.slice!(0, left)
lastspace = line.rindex(opts[:split_at])
if(lastspace)
- msg.replace line.slice!(lastspace, line.length) + msg
+ msg.replace line.slice!(lastspace, line.size) + msg
msg.gsub!(/^#{opts[:split_at]}/, "") if opts[:purge_split]
end
sendq "#{fixed}#{line}", chan, ring
log_sent(type, where, line)
cmd_lines += 1
- end while(msg.length > 0)
+ end while(msg.size > 0)
}
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"