end
end
+class ServerError < RuntimeError
+end
+
def rawlog(level, message=nil, who_pos=1)
call_stack = caller
if call_stack.length > who_pos
# these first
require 'rbot/rbotconfig'
+begin
+ require 'rubygems'
+rescue LoadError
+ log "rubygems unavailable"
+end
+
require 'rbot/load-gettext'
require 'rbot/config'
require 'rbot/config-compat'
@client.user
end
- # bot User in the client/server connection
+ # bot nick in the client/server connection
def nick
myself.nick
end
+ # bot channels in the client/server connection
+ def channels
+ myself.channels
+ 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
+
+
# bot inspection
# TODO multiserver
def inspect
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")
- Config.register Config::FloatValue.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 })
- Config.register Config::IntegerValue.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 })
Config.register Config::IntegerValue.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)")
+ 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")
Config.register Config::StringValue.new('irc.nick', :default => "rbot",
:desc => "IRC nickname the bot should attempt to use", :wizard => true,
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)")
Config.register Config::IntegerValue.new('core.save_every',
:default => 60, :validate => Proc.new{|v| v >= 0},
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
botclass.gsub!("\\","/")
end
end
- botclass += "/.rbot"
+ botclass = File.join(botclass, ".rbot")
end
botclass = File.expand_path(botclass)
@botclass = botclass.gsub(/\/$/, "")
- if FileTest.directory? botclass
- # compare the templates dir with the current botclass, and fill it in with
- # any missing file.
- # Sadly, FileUtils.cp_r doesn't have an :update option, so we have to do it
- # manually
- template = File.join Config::datadir, 'templates'
- # 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.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, 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 Config::datadir+'/templates', botclass
- end
+ repopulate_botclass_directory
- Dir.mkdir("#{botclass}/registry") unless File.exist?("#{botclass}/registry")
- Dir.mkdir("#{botclass}/safe_save") unless File.exist?("#{botclass}/safe_save")
+ 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
# Time at which the last PING was sent
@last_ping = nil
@logfile = @config['log.file']
if @logfile.class!=String || @logfile.empty?
- @logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
+ logfname = File.basename(botclass).gsub(/^\.+/,'')
+ logfname << ".log"
+ @logfile = File.join(botclass, logfname)
debug "Using `#{@logfile}' as debug log"
end
end
end
- File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
+ File.open($opts['pidfile'] || File.join(@botclass, 'rbot.pid'), 'w') do |pf|
pf << "#{$$}\n"
end
@auth.everyone.set_default_permission("*", true)
@auth.botowner.password= @config['auth.password']
- Dir.mkdir("#{botclass}/plugins") unless File.exist?("#{botclass}/plugins")
@plugins = Plugins::manager
@plugins.bot_associate(self)
setup_plugins_path()
debug "server.list is now #{@config['server.list'].inspect}"
end
- @socket = Irc::Socket.new(@config['server.list'], @config['server.bindhost'], @config['server.sendq_delay'], @config['server.sendq_burst'], :ssl => @config['server.ssl'])
+ @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
# '*' 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")
-
- @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
}
@client[:privmsg] = proc { |data|
- m = PrivMessage.new(self, server, data[:source], data[:target], data[: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, server, 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.irc_delegate "notice", message
}
m.modes = data[:modes]
@plugins.delegate "modechange", m
}
+ @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, server, data[:source], data[:channel], data[:message])
sendq("MODE #{data[:channel]}", nil, 0) if m.address?
m.users = data[:users]
@plugins.delegate "names", m
}
+ @client[:error] = proc { |data|
+ raise ServerError, data[:message]
+ }
@client[:unknown] = proc { |data|
#debug "UNKNOWN: #{data[:serverstring]}"
m = UnknownMessage.new(self, server, server, nil, data[:serverstring])
trap_sigs
end
+ 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_botmodule_dir(Config::coredir + "/utils")
- @plugins.add_botmodule_dir(Config::coredir)
- @plugins.add_botmodule_dir("#{botclass}/plugins")
+ @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\)/, Config::datadir + '/plugins')
- @plugins.add_botmodule_dir(path)
+ path = _.sub(/^\(default\)/, plugdir_default)
+ @plugins.add_plugin_dir(path)
end
end
# checks if we should be quiet on a channel
def quiet_on?(channel)
- return @quiet.include?('*') || @quiet.include?(channel.downcase)
+ 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
- @quiet.delete channel.downcase
+ 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}"
- $interrupted += 1
+ # 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 >= 3
trap("SIGINT") { got_sig("SIGINT") }
trap("SIGTERM") { got_sig("SIGTERM") }
trap("SIGHUP") { got_sig("SIGHUP", :restart) }
+ trap("SIGUSR1") { got_sig("SIGUSR1", :reconnect) }
rescue ArgumentError => e
debug "failed to trap signals (#{e.pretty_inspect}): running on Windows?"
rescue Exception => e
begin
quit if $interrupted > 0
@socket.connect
+ @last_rec = Time.now
rescue => e
raise e.class, "failed to connect to IRC server at #{@socket.server_uri}: " + e
end
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
-
quit_msg = nil
+ reconnect(quit_msg, too_fast)
+ quit if $interrupted > 0
while @socket.connected?
quit if $interrupted > 0
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
fatal "fatal bdb error: #{e.pretty_inspect}"
DBTree.stats
log_session_end
exit 2
end
-
- 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 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, original_message, options={})
- opts = @default_send_options.merge(options)
+ 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
+
+ opts = ds[:options]
+ type = ds[:type]
+ where = ds[:dest]
+ filtered = ds[:text]
# For starters, set up appropriate queue channels and rings
mchan = opts[:queue_channel]
end
end
- multi_line = original_message.to_s.gsub(/[\r\n]+/, "\n")
+ multi_line = filtered.gsub(/[\r\n]+/, "\n")
- # if target is a channel with +c or +C modes, strip colours
- if where.kind_of?(Channel) and where.mode.any?('c', 'C')
+ # 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
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
def disconnect(message=nil)
# totally shutdown and respawn the bot
def restart(message=nil)
- message = "restarting, back in #{@config['server.reconnect_wait']}..." if (!message || message.empty?)
+ message = _("restarting, back in %{wait}...") % {
+ :wait => @config['server.reconnect_wait']
+ } if (!message || message.empty?)
shutdown(message)
sleep @config['server.reconnect_wait']
begin
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
m = PrivMessage.new(*args)
when "QUIT"
m = QuitMessage.new(*args)
+ m.was_on = myself.channels
end
@plugins.delegate('sent', m)
end
projects / user / henk / code / ruby / rbot.git / blobdiff