4 # :title: rbot IRC logging facilities
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
7 # Copyright:: (C) 2008 Giuseppe Bilotta
10 class IrcLogModule < CoreBotModule
12 MAX_OPEN_FILES = 20 # XXX: maybe add a config value
17 Dir.mkdir("#{@bot.botclass}/logs") unless File.exist?("#{@bot.botclass}/logs")
20 def logfile_close(where_str, reason = 'unknown reason')
21 f = @logs.delete(where_str) or return
22 stamp = Time.now.strftime '%Y/%m/%d %H:%M:%S'
23 f[1].puts "[#{stamp}] @ Log closed by #{@bot.myself.nick} (#{reason})"
27 # log IRC-related message +message+ to a file determined by +where+.
28 # +where+ can be a channel name, or a nick for private message logging
29 def irclog(message, where="server")
30 message = message.chomp
32 stamp = now.strftime("%Y/%m/%d %H:%M:%S")
33 if where.class <= Server
36 where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
38 unless @logs.has_key? where_str
39 if @logs.size > MAX_OPEN_FILES
40 @logs.keys.sort do |a, b|
41 @logs[a][0] <=> @logs[b][0]
42 end.slice(0, @logs.size - MAX_OPEN_FILES).each do |w|
43 logfile_close w, "idle since #{@logs[w][0]}"
46 f = File.new("#{@bot.botclass}/logs/#{where_str}", "a")
48 f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
49 @logs[where_str] = [now, f]
51 @logs[where_str][1].puts "[#{stamp}] #{message}"
52 @logs[where_str][0] = now
53 #debug "[#{stamp}] <#{where}> #{message}"
57 @logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
63 irclog "-#{m.source}- #{m.message}", m.target
65 irclog "<#{m.source}> #{m.message}", m.target
68 irclog "@ quit (#{m.message})", ch
74 irclog "joined server #{m.server} as #{m.target}", "server"
80 method = 'log_message'
82 method = 'log_' + m.class.name.downcase.match(/^irc::(\w+)message$/).captures.first
84 if self.respond_to?(method)
85 self.__send__(method, m)
87 warning "unhandled logging for #{m.pretty_inspect} (no such method #{method})"
94 who = m.private? ? "me" : m.target
95 logtarget = m.private? ? m.source : m.target
99 irclog "* #{m.source} #{m.logmessage}", m.target
101 irclog "* #{m.source}(#{m.sourceaddress}) #{m.logmessage}", m.source
104 irclog "@ #{m.source} asked #{who} about version info", logtarget
106 irclog "@ #{m.source} asked #{who} about source info", logtarget
108 irclog "@ #{m.source} pinged #{who}", logtarget
110 irclog "@ #{m.source} asked #{who} what time it is", logtarget
112 irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
116 irclog "<#{m.source}> #{m.logmessage}", m.target
118 irclog "<#{m.source}(#{m.sourceaddress})> #{m.logmessage}", m.source
125 irclog "-#{m.source}(#{m.sourceaddress})- #{m.logmessage}", m.source
127 irclog "-#{m.source}- #{m.logmessage}", m.target
132 m.message.each_line { |line|
133 irclog "MOTD: #{line}", "server"
139 irclog "@ #{m.oldnick} is now known as #{m.newnick}", ch
145 irclog "@ Quit: #{m.source}: #{m.logmessage}", ch
150 irclog "@ Mode #{m.logmessage} by #{m.source}", m.target
155 debug "joined channel #{m.channel}"
156 irclog "@ Joined channel #{m.channel}", m.channel
158 irclog "@ #{m.source} joined channel #{m.channel}", m.channel
164 debug "left channel #{m.channel}"
165 irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
167 irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
173 debug "kicked from channel #{m.channel}"
174 irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
176 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
187 if m.source == @bot.myself
188 irclog "@ I set topic \"#{m.topic}\"", m.channel
190 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
193 topic = m.channel.topic
194 irclog "@ Topic is \"#{m.topic}\"", m.channel
195 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", m.channel
203 def unknown_message(m)
204 irclog m.logmessage, ".unknown"
208 ilm = IrcLogModule.new