1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
#-- vim:sw=2:et
#++
#
# :title: rbot IRC logging facilities
#
# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
class IrcLogModule < CoreBotModule
Config.register Config::IntegerValue.new('irclog.max_open_files',
:default => 20, :validate => Proc.new { |v| v > 0 },
:desc => "Maximum number of irclog files to keep open at any one time.")
Config.register Config::ArrayValue.new('irclog.no_log',
:default => [], :on_change => Proc.new { |bot, v|
bot.plugins.delegate 'event_irclog_list_changed', v, bot.config['irclog.do_log']
},
:desc => "List of channels and nicks for which logging is disabled. IRC patterns can be used too.")
Config.register Config::ArrayValue.new('irclog.do_log',
:default => [], :on_change => Proc.new { |bot, v|
bot.plugins.delegate 'event_irclog_list_changed', bot.config['irclog.no_log'], v
},
: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")
attr :nolog_rx, :dolog_rx
def initialize
super
@logs = Hash.new
Dir.mkdir("#{@bot.botclass}/logs") unless File.exist?("#{@bot.botclass}/logs")
event_irclog_list_changed(@bot.config['irclog.no_log'], @bot.config['irclog.do_log'])
end
def can_log_on(where)
return true if @dolog_rx and where.match @dolog_rx
return false if @nolog_rx and where.match @nolog_rx
return true
end
def event_irclog_list_changed(nolist, dolist)
@nolog_rx = nolist.empty? ? nil : Regexp.union(*(nolist.map { |r| r.to_irc_regexp }))
debug "no log: #{@nolog_rx}"
@dolog_rx = dolist.empty? ? nil : Regexp.union(*(dolist.map { |r| r.to_irc_regexp }))
debug "do log: #{@dolog_rx}"
@logs.inject([]) { |ar, kv|
ar << kv.first unless can_log_on(kv.first)
ar
}.each { |w| logfile_close(w, 'logging disabled here') }
end
def logfile_close(where_str, reason = 'unknown reason')
f = @logs.delete(where_str) or return
stamp = Time.now.strftime '%Y/%m/%d %H:%M:%S'
f[1].puts "[#{stamp}] @ Log closed by #{@bot.myself.nick} (#{reason})"
f[1].close
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
now = Time.now
stamp = now.strftime("%Y/%m/%d %H:%M:%S")
if where.class <= Server
where_str = "server"
else
where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
end
return unless can_log_on(where_str)
unless @logs.has_key? where_str
if @logs.size > @bot.config['irclog.max_open_files']
@logs.keys.sort do |a, b|
@logs[a][0] <=> @logs[b][0]
end.slice(0, @logs.size - @bot.config['irclog.max_open_files']).each do |w|
logfile_close w, "idle since #{@logs[w][0]}"
end
end
f = File.new("#{@bot.botclass}/logs/#{where_str}", "a")
f.sync = true
f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
@logs[where_str] = [now, f]
end
@logs[where_str][1].puts "[#{stamp}] #{message}"
@logs[where_str][0] = now
#debug "[#{stamp}] <#{where}> #{message}"
end
def cleanup
@logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
end
def sent(m)
case m
when NoticeMessage
irclog "-#{m.source}- #{m.message}", m.target
when PrivMessage
irclog "<#{m.source}> #{m.message}", m.target
when QuitMessage
m.was_on.each { |ch|
irclog "@ quit (#{m.message})", ch
}
end
end
def welcome(m)
irclog "joined server #{m.server} as #{m.target}", "server"
end
def listen(m)
case m
when PrivMessage
method = 'log_message'
else
method = 'log_' + m.class.name.downcase.match(/^irc::(\w+)message$/).captures.first
end
if self.respond_to?(method)
self.__send__(method, m)
else
warning "unhandled logging for #{m.pretty_inspect} (no such method #{method})"
unknown_message(m)
end
end
def log_message(m)
if m.ctcp
who = m.private? ? "me" : m.target
logtarget = m.private? ? m.source : m.target
case m.ctcp.intern
when :ACTION
if m.public?
irclog "* #{m.source} #{m.logmessage}", m.target
else
irclog "* #{m.source}(#{m.sourceaddress}) #{m.logmessage}", m.source
end
when :VERSION
irclog "@ #{m.source} asked #{who} about version info", logtarget
when :SOURCE
irclog "@ #{m.source} asked #{who} about source info", logtarget
when :PING
irclog "@ #{m.source} pinged #{who}", logtarget
when :TIME
irclog "@ #{m.source} asked #{who} what time it is", logtarget
else
irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
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
def log_notice(m)
if m.private?
irclog "-#{m.source}(#{m.sourceaddress})- #{m.logmessage}", m.source
else
irclog "-#{m.source}- #{m.logmessage}", m.target
end
end
def motd(m)
m.message.each_line { |line|
irclog "MOTD: #{line}", "server"
}
end
def log_nick(m)
m.is_on.each { |ch|
irclog "@ #{m.oldnick} is now known as #{m.newnick}", ch
}
end
def log_quit(m)
m.was_on.each { |ch|
irclog "@ Quit: #{m.source}: #{m.logmessage}", ch
}
end
def modechange(m)
irclog "@ Mode #{m.logmessage} by #{m.source}", m.target
end
def log_join(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 log_part(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 log_kick(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 log_invite(m)
# # TODO
# end
def log_topic(m)
case m.info_or_set
when :set
if m.source == @bot.myself
irclog "@ I set topic \"#{m.topic}\"", m.channel
else
irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
end
when :info
topic = m.channel.topic
irclog "@ Topic is \"#{m.topic}\"", m.channel
irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", m.channel
end
end
# def names(m)
# # TODO
# end
def unknown_message(m)
irclog m.logmessage, ".unknown"
end
end
ilm = IrcLogModule.new
ilm.priority = -1
|
