$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 restart_logger
+ if $log_thread && $log_thread.alive?
+ $log_queue << nil
+ $log_thread.join
+ $log_thread = nil
+ end
+
+ $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)
require 'rbot/rbotconfig'
require 'rbot/load-gettext'
require 'rbot/config'
-# require 'rbot/utils'
+require 'rbot/config-compat'
require 'rbot/irc'
require 'rbot/rfc2812'
require 'rbot/botuser'
require 'rbot/timer'
require 'rbot/plugins'
-# require 'rbot/channel'
require 'rbot/message'
require 'rbot/language'
require 'rbot/dbhash'
require 'rbot/registry'
-# require 'rbot/httputil'
module Irc
# handles them or passes them to plugins, and contains core functionality.
class Bot
COPYRIGHT_NOTICE = "(c) Tom Gilbert and the rbot development team"
- SOURCE_URL = "http://linuxbrit.co.uk/rbot"
+ SOURCE_URL = "http://ruby-rbot.org"
# the bot's Auth data
attr_reader :auth
myself.nick
end
+ # bot inspection
+ # TODO multiserver
+ def inspect
+ ret = self.to_s[0..-2]
+ ret << ' version=' << $version.inspect
+ ret << ' botclass=' << botclass.inspect
+ ret << ' lang="' << lang.language
+ if defined?(GetText)
+ ret << '/' << locale
+ end
+ ret << '"'
+ ret << ' nick=' << nick.inspect
+ ret << ' server='
+ if server
+ ret << (server.to_s + (socket ?
+ ' [' << socket.server_uri.to_s << ']' : '')).inspect
+ unless server.channels.empty?
+ ret << " channels="
+ ret << server.channels.map { |c|
+ "%s%s" % [c.modes_of(nick).map { |m|
+ server.prefix_for_mode(m)
+ }, c.name]
+ }.inspect
+ end
+ else
+ ret << '(none)'
+ end
+ ret << ' plugins=' << plugins.inspect
+ ret << ">"
+ end
+
+
# create a new Bot with botclass +botclass+
def initialize(botclass, params = {})
# Config for the core bot
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.
+ # * 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)
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")
end
@quit_mutex = Mutex.new
- @logs = Hash.new
-
@plugins = nil
@lang = Language.new(self, @config['core.language'])
begin
- @auth = Auth::authmanager
+ @auth = Auth::manager
@auth.bot_associate(self)
# @auth.load("#{botclass}/botusers.yaml")
rescue Exception => e
@quiet = []
@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|
# 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])
# 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 "WHO #{data[:channel]}", data[:channel], 2
+ @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|
- if data[:target] == myself
- join data[:channel] if @auth.allow?("join", data[:source], data[:source].nick)
- end
+ m = InviteMessage.new(self, server, data[:source], data[:target], data[:channel])
+ @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,
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"
- 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_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
def disconnect(message=nil)
message = @lang.get("quit") if (!message || message.empty?)
if @socket.connected?
- debug "Clearing socket"
- @socket.clearq
- debug "Sending quit message"
- @socket.emergency_puts "QUIT :#{message}"
- debug "Flushing socket"
- @socket.flush
+ begin
+ debug "Clearing socket"
+ @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
+ error "error while disconnecting socket: #{e.pretty_inspect}"
+ end
debug "Shutting down socket"
@socket.shutdown
end
- debug "Logging quits"
- server.channels.each { |ch|
- irclog "@ quit (#{message})", ch
- }
stop_server_pings
@client.reset
end
private
- def irclogprivmsg(m)
- if(m.action?)
- if(m.private?)
- irclog "* [#{m.source}(#{m.sourceaddress})] #{m.message}", m.source
- else
- irclog "* #{m.source} #{m.message}", m.target
- end
- else
- if(m.public?)
- irclog "<#{m.source}> #{m.message}", m.target
- else
- irclog "[#{m.source}(#{m.sourceaddress})] #{m.message}", 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.message})", m.channel
- else
- 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.source} (#{m.message})", m.channel
- else
- irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.message})", 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