$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")
else
str = message.pretty_inspect
end
+ qmsg = Array.new
str.each_line { |l|
- $logger.add(level, l.chomp, who)
- who.gsub!(/./," ")
+ qmsg.push [level, l.chomp, who]
+ who = ' ' * who.size
}
+ $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
+
+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
$logger << "\n\n=== #{botclass} session ended on #{Time.now.strftime($dateformat)} ===\n\n"
+ $log_queue << nil
end
def debug(message=nil, who_pos=1)
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
+
+
# bot inspection
# TODO multiserver
def inspect
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,
botclass = File.expand_path(botclass)
@botclass = botclass.gsub(/\/$/, "")
- unless FileTest.directory? botclass
+ 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"
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")
@logfile = @config['log.file']
if @logfile.class!=String || @logfile.empty?
@logfile = "#{botclass}/#{File.basename(botclass).gsub(/^\.+/,'')}.log"
+ debug "Using `#{@logfile}' as debug log"
end
# See http://blog.humlab.umu.se/samuel/archives/000107.html
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)
+
+ def $stdout.write(str=nil)
log str, 2
return str.to_s.size
end
- def STDERR.write(str=nil)
+ def $stdout.write(str=nil)
if str.to_s.match(/:\d+: warning:/)
warning str, 2
else
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 defined? $cl_loglevel
- $logger.level = 0 if $debug
-
- log_session_start
-
File.open($opts['pidfile'] || "#{@botclass}/rbot.pid", 'w') do |pf|
pf << "#{$$}\n"
end
end
@quit_mutex = Mutex.new
- @logs = Hash.new
-
@plugins = nil
@lang = Language.new(self, @config['core.language'])
# Array of channels names where the bot should be quiet
# '*' means all channels
#
- @quiet = []
+ @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|
- irclog "joined server #{@client.server} as #{myself}", "server"
+ m = WelcomeMessage.new(self, server, data[:source], data[:target], data[:message])
+ @plugins.delegate("welcome", m)
@plugins.delegate("connect")
@config['irc.join_channels'].each { |c|
}
@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}"
- ignored = false
@config['irc.ignore_users'].each { |mask|
if m.source.matches?(server.new_netmask(mask))
- ignored = true
- break
+ m.ignored = true
end
}
- irclogprivmsg(m)
-
- unless ignored
- @plugins.delegate "listen", m
- @plugins.delegate("ctcp_listen", m) if m.ctcp
- @plugins.privmsg(m) if m.address?
- if not m.replied
- @plugins.delegate "unreplied", m
- end
- end
+ @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.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|
new = "#{data[:nick]}_"
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
- data[:is_on].each { |ch|
- irclog "@ #{old} is now known as #{new}", ch
- }
- @plugins.delegate("listen", m)
- @plugins.delegate("nick", m)
+ @plugins.irc_delegate("nick", m)
}
@client[:quit] = proc {|data|
source = data[:source]
message = data[:message]
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)
+ m.was_on = data[:was_on]
+ @plugins.irc_delegate("quit", m)
}
@client[:mode] = proc {|data|
- irclog "@ Mode #{data[:modestring]} by #{data[:source]}", data[:channel]
+ m = ModeChangeMessage.new(self, server, data[:source], data[:target], data[:modestring])
+ m.modes = data[:modes]
+ @plugins.delegate "modechange", m
}
@client[:join] = proc {|data|
m = JoinMessage.new(self, server, data[:source], data[:channel], data[:message])
- irclogjoin(m)
-
- @plugins.delegate("listen", m)
- @plugins.delegate("join", m)
+ 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, server, data[:source], data[:channel], data[:message])
- irclogpart(m)
-
- @plugins.delegate("listen", m)
- @plugins.delegate("part", m)
+ @plugins.irc_delegate("part", m)
}
@client[:kick] = proc {|data|
m = KickMessage.new(self, server, data[:source], data[:target], data[:channel],data[:message])
- irclogkick(m)
-
- @plugins.delegate("listen", m)
- @plugins.delegate("kick", m)
+ @plugins.irc_delegate("kick", m)
}
@client[:invite] = proc {|data|
m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
-
- @plugins.delegate("listen", m)
- @plugins.delegate("invite", m)
+ @plugins.irc_delegate("invite", m)
}
@client[:changetopic] = proc {|data|
m = TopicMessage.new(self, server, data[:source], data[:channel], data[:topic])
- irclogtopic(m)
-
- @plugins.delegate("listen", m)
- @plugins.delegate("topic", m)
- }
- @client[:topic] = proc { |data|
- irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
+ m.info_or_set = :set
+ @plugins.irc_delegate("topic", m)
}
+ # @client[:topic] = proc { |data|
+ # irclog "@ Topic is \"#{data[:topic]}\"", data[:channel]
+ # }
@client[:topicinfo] = proc { |data|
channel = data[:channel]
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)
+ m.info_or_set = :info
+ @plugins.irc_delegate("topic", m)
}
@client[:names] = proc { |data|
- @plugins.delegate "names", data[:channel], data[:users]
+ m = NamesMessage.new(self, server, server, data[:channel])
+ m.users = data[:users]
+ @plugins.delegate "names", m
}
@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,
: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 setup_plugins_path
return @quiet.include?('*') || @quiet.include?(channel.downcase)
end
- def set_quiet(channel)
+ def set_quiet(channel = nil)
if channel
ch = channel.downcase.dup
- @quiet << ch unless @quiet.include?(ch)
+ @quiet << ch
else
@quiet.clear
@quiet << '*'
end
end
- def reset_quiet(channel)
+ def reset_quiet(channel = nil)
if channel
@quiet.delete channel.downcase
else
end
# things to do when we receive a signal
- def got_sig(sig)
- debug "received #{sig}, queueing quit"
+ def got_sig(sig, func=:quit)
+ debug "received #{sig}, queueing #{func}"
$interrupted += 1
- quit unless @quit_mutex.locked?
+ self.send(func) unless @quit_mutex.locked?
debug "interrupted #{$interrupted} times"
if $interrupted >= 3
debug "drastic!"
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) }
rescue ArgumentError => e
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
end
multi_line = original_message.to_s.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
lines.each { |line|
sendq "#{fixed}#{line}", chan, ring
- log_sent(type, where, line)
+ delegate_sent(type, where, line)
}
end
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")
- if where.class <= Server
- where_str = "server"
+ # set topic of channel +where+ to +topic+
+ # 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
- 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
+ sendq "TOPIC #{where} :#{topic}", where, 2
end
- @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}", where, 2
end
def disconnect(message=nil)
@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
debug "Shutting down socket"
@socket.shutdown
end
- debug "Logging quits"
- server.channels.each { |ch|
- irclog "@ quit (#{message})", ch
- }
stop_server_pings
@client.reset
end
# 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
end
# changing mode
- def mode(channel, mode, target)
+ def mode(channel, mode, target=nil)
sendq "MODE #{channel} #{mode} #{target}", channel, 2
end
private
- def irclogprivmsg(m)
- if(m.action?)
- if(m.private?)
- irclog "* [#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
- else
- irclog "* #{m.source} #{m.logmessage}", m.target
- end
- else
- if(m.public?)
- irclog "<#{m.source}> #{m.logmessage}", m.target
- else
- irclog "[#{m.source}(#{m.sourceaddress})] #{m.logmessage}", m.source
- 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"
- case where
- when Channel
- irclog "-=#{myself}=- #{message}", where
- else
- irclog "[-=#{where}=-] #{message}", where
- end
+ m = NoticeMessage.new(*args)
when "PRIVMSG"
- case where
- when Channel
- irclog "<#{myself}> #{message}", where
- else
- irclog "[msg(#{where})] #{message}", where
- end
- end
- end
-
- def irclogjoin(m)
- if m.address?
- debug "joined channel #{m.channel}"
- irclog "@ Joined channel #{m.channel}", m.channel
- else
- irclog "@ #{m.source} joined channel #{m.channel}", m.channel
- end
- end
-
- def irclogpart(m)
- if(m.address?)
- debug "left channel #{m.channel}"
- irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
- else
- irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", 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.source} (#{m.logmessage})", m.channel
- else
- irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
- end
- end
-
- 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
+ m = PrivMessage.new(*args)
+ when "QUIT"
+ m = QuitMessage.new(*args)
end
+ @plugins.delegate('sent', m)
end
end