4 # :title: rbot IRC logging facilities
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 class IrcLogModule < CoreBotModule
10 Config.register Config::IntegerValue.new('irclog.max_open_files',
11 :default => 20, :validate => Proc.new { |v| v > 0 },
12 :desc => "Maximum number of irclog files to keep open at any one time.")
13 Config.register Config::ArrayValue.new('irclog.no_log',
14 :default => [], :on_change => Proc.new { |bot, v|
15 bot.plugins.delegate 'event_irclog_list_changed', v, bot.config['irclog.do_log']
17 :desc => "List of channels and nicks for which logging is disabled. IRC patterns can be used too.")
18 Config.register Config::ArrayValue.new('irclog.do_log',
19 :default => [], :on_change => Proc.new { |bot, v|
20 bot.plugins.delegate 'event_irclog_list_changed', bot.config['irclog.no_log'], v
22 :desc => "List of channels and nicks for which logging is enabled. IRC patterns can be used too. This can be used to override wide patters in irclog.no_log")
24 attr :nolog_rx, :dolog_rx
28 @thread = Thread.new { loggers_thread }
30 Dir.mkdir("#{@bot.botclass}/logs") unless File.exist?("#{@bot.botclass}/logs")
31 event_irclog_list_changed(@bot.config['irclog.no_log'], @bot.config['irclog.do_log'])
35 return true if @dolog_rx and where.match @dolog_rx
36 return false if @nolog_rx and where.match @nolog_rx
40 def event_irclog_list_changed(nolist, dolist)
41 @nolog_rx = nolist.empty? ? nil : Regexp.union(*(nolist.map { |r| r.to_irc_regexp }))
42 debug "no log: #{@nolog_rx}"
43 @dolog_rx = dolist.empty? ? nil : Regexp.union(*(dolist.map { |r| r.to_irc_regexp }))
44 debug "do log: #{@dolog_rx}"
45 @logs.inject([]) { |ar, kv|
46 ar << kv.first unless can_log_on(kv.first)
48 }.each { |w| logfile_close(w, 'logging disabled here') }
51 def logfile_close(where_str, reason = 'unknown reason')
52 f = @logs.delete(where_str) or return
53 stamp = Time.now.strftime '%Y/%m/%d %H:%M:%S'
54 f[1].puts "[#{stamp}] @ Log closed by #{@bot.myself.nick} (#{reason})"
58 # log IRC-related message +message+ to a file determined by +where+.
59 # +where+ can be a channel name, or a nick for private message logging
60 def irclog(message, where="server")
61 @queue.push [message, where]
73 irclog "-#{m.source}- #{m.message}", m.target
75 logtarget = who = m.target
79 irclog "* #{m.source} #{m.logmessage}", logtarget
81 irclog "@ #{m.source} asked #{who} about version info", logtarget
83 irclog "@ #{m.source} asked #{who} about source info", logtarget
85 irclog "@ #{m.source} pinged #{who}", logtarget
87 irclog "@ #{m.source} asked #{who} what time it is", logtarget
89 irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
92 irclog "<#{m.source}> #{m.logmessage}", logtarget
96 irclog "@ quit (#{m.message})", ch
102 irclog "joined server #{m.server} as #{m.target}", "server"
108 method = 'log_message'
110 method = 'log_' + m.class.name.downcase.match(/^irc::(\w+)message$/).captures.first
112 if self.respond_to?(method)
113 self.__send__(method, m)
115 warning "unhandled logging for #{m.pretty_inspect} (no such method #{method})"
122 who = m.private? ? "me" : m.target
123 logtarget = m.private? ? m.source : m.target
127 irclog "* #{m.source} #{m.logmessage}", m.target
129 irclog "* #{m.source}(#{m.sourceaddress}) #{m.logmessage}", m.source
132 irclog "@ #{m.source} asked #{who} about version info", logtarget
134 irclog "@ #{m.source} asked #{who} about source info", logtarget
136 irclog "@ #{m.source} pinged #{who}", logtarget
138 irclog "@ #{m.source} asked #{who} what time it is", logtarget
140 irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
144 irclog "<#{m.source}> #{m.logmessage}", m.target
146 irclog "<#{m.source}(#{m.sourceaddress})> #{m.logmessage}", m.source
153 irclog "-#{m.source}(#{m.sourceaddress})- #{m.logmessage}", m.source
155 irclog "-#{m.source}- #{m.logmessage}", m.target
160 m.message.each_line { |line|
161 irclog "MOTD: #{line}", "server"
167 irclog "@ #{m.oldnick} is now known as #{m.newnick}", ch
173 irclog "@ Quit: #{m.source}: #{m.logmessage}", ch
178 irclog "@ Mode #{m.logmessage} by #{m.source}", m.target
183 debug "joined channel #{m.channel}"
184 irclog "@ Joined channel #{m.channel}", m.channel
186 irclog "@ #{m.source} joined channel #{m.channel}", m.channel
192 debug "left channel #{m.channel}"
193 irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
195 irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
201 debug "kicked from channel #{m.channel}"
202 irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
204 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
215 if m.source == @bot.myself
216 irclog "@ I set topic \"#{m.topic}\"", m.channel
218 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
221 topic = m.channel.topic
222 irclog "@ Topic is \"#{m.topic}\"", m.channel
223 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", m.channel
231 def unknown_message(m)
232 irclog m.logmessage, ".unknown"
238 debug 'loggers_thread starting'
239 while ls = @queue.pop
241 message = message.chomp
243 stamp = now.strftime("%Y/%m/%d %H:%M:%S")
244 if where.class <= Server
247 where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
249 return unless can_log_on(where_str)
250 unless @logs.has_key? where_str
251 if @logs.size > @bot.config['irclog.max_open_files']
252 @logs.keys.sort do |a, b|
253 @logs[a][0] <=> @logs[b][0]
254 end.slice(0, @logs.size - @bot.config['irclog.max_open_files']).each do |w|
255 logfile_close w, "idle since #{@logs[w][0]}"
258 f = File.new("#{@bot.botclass}/logs/#{where_str}", "a")
260 f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
261 @logs[where_str] = [now, f]
263 @logs[where_str][1].puts "[#{stamp}] #{message}"
264 @logs[where_str][0] = now
265 #debug "[#{stamp}] <#{where}> #{message}"
267 @logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
268 debug 'loggers_thread terminating'
272 ilm = IrcLogModule.new