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 Dir.mkdir("#{@bot.botclass}/logs") unless File.exist?("#{@bot.botclass}/logs")
29 event_irclog_list_changed(@bot.config['irclog.no_log'], @bot.config['irclog.do_log'])
33 return true if @dolog_rx and where.match @dolog_rx
34 return false if @nolog_rx and where.match @nolog_rx
38 def event_irclog_list_changed(nolist, dolist)
39 @nolog_rx = nolist.empty? ? nil : Regexp.union(*(nolist.map { |r| r.to_irc_regexp }))
40 debug "no log: #{@nolog_rx}"
41 @dolog_rx = dolist.empty? ? nil : Regexp.union(*(dolist.map { |r| r.to_irc_regexp }))
42 debug "do log: #{@dolog_rx}"
43 @logs.inject([]) { |ar, kv|
44 ar << kv.first unless can_log_on(kv.first)
46 }.each { |w| logfile_close(w, 'logging disabled here') }
49 def logfile_close(where_str, reason = 'unknown reason')
50 f = @logs.delete(where_str) or return
51 stamp = Time.now.strftime '%Y/%m/%d %H:%M:%S'
52 f[1].puts "[#{stamp}] @ Log closed by #{@bot.myself.nick} (#{reason})"
56 # log IRC-related message +message+ to a file determined by +where+.
57 # +where+ can be a channel name, or a nick for private message logging
58 def irclog(message, where="server")
59 message = message.chomp
61 stamp = now.strftime("%Y/%m/%d %H:%M:%S")
62 if where.class <= Server
65 where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
67 return unless can_log_on(where_str)
68 unless @logs.has_key? where_str
69 if @logs.size > @bot.config['irclog.max_open_files']
70 @logs.keys.sort do |a, b|
71 @logs[a][0] <=> @logs[b][0]
72 end.slice(0, @logs.size - @bot.config['irclog.max_open_files']).each do |w|
73 logfile_close w, "idle since #{@logs[w][0]}"
76 f = File.new("#{@bot.botclass}/logs/#{where_str}", "a")
78 f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
79 @logs[where_str] = [now, f]
81 @logs[where_str][1].puts "[#{stamp}] #{message}"
82 @logs[where_str][0] = now
83 #debug "[#{stamp}] <#{where}> #{message}"
87 @logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
93 irclog "-#{m.source}- #{m.message}", m.target
95 logtarget = who = m.target
99 irclog "* #{m.source} #{m.logmessage}", logtarget
101 irclog "@ #{m.source} asked #{who} about version info", logtarget
103 irclog "@ #{m.source} asked #{who} about source info", logtarget
105 irclog "@ #{m.source} pinged #{who}", logtarget
107 irclog "@ #{m.source} asked #{who} what time it is", logtarget
109 irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
112 irclog "<#{m.source}> #{m.logmessage}", logtarget
116 irclog "@ quit (#{m.message})", ch
122 irclog "joined server #{m.server} as #{m.target}", "server"
128 method = 'log_message'
130 method = 'log_' + m.class.name.downcase.match(/^irc::(\w+)message$/).captures.first
132 if self.respond_to?(method)
133 self.__send__(method, m)
135 warning "unhandled logging for #{m.pretty_inspect} (no such method #{method})"
142 who = m.private? ? "me" : m.target
143 logtarget = m.private? ? m.source : m.target
147 irclog "* #{m.source} #{m.logmessage}", m.target
149 irclog "* #{m.source}(#{m.sourceaddress}) #{m.logmessage}", m.source
152 irclog "@ #{m.source} asked #{who} about version info", logtarget
154 irclog "@ #{m.source} asked #{who} about source info", logtarget
156 irclog "@ #{m.source} pinged #{who}", logtarget
158 irclog "@ #{m.source} asked #{who} what time it is", logtarget
160 irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
164 irclog "<#{m.source}> #{m.logmessage}", m.target
166 irclog "<#{m.source}(#{m.sourceaddress})> #{m.logmessage}", m.source
173 irclog "-#{m.source}(#{m.sourceaddress})- #{m.logmessage}", m.source
175 irclog "-#{m.source}- #{m.logmessage}", m.target
180 m.message.each_line { |line|
181 irclog "MOTD: #{line}", "server"
187 irclog "@ #{m.oldnick} is now known as #{m.newnick}", ch
193 irclog "@ Quit: #{m.source}: #{m.logmessage}", ch
198 irclog "@ Mode #{m.logmessage} by #{m.source}", m.target
203 debug "joined channel #{m.channel}"
204 irclog "@ Joined channel #{m.channel}", m.channel
206 irclog "@ #{m.source} joined channel #{m.channel}", m.channel
212 debug "left channel #{m.channel}"
213 irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
215 irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
221 debug "kicked from channel #{m.channel}"
222 irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
224 irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
235 if m.source == @bot.myself
236 irclog "@ I set topic \"#{m.topic}\"", m.channel
238 irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
241 topic = m.channel.topic
242 irclog "@ Topic is \"#{m.topic}\"", m.channel
243 irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", m.channel
251 def unknown_message(m)
252 irclog m.logmessage, ".unknown"
256 ilm = IrcLogModule.new