lib/rbot/core/irclog.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: rbot IRC logging facilities
   5 #
   6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   7
   8 class IrcLogModule < CoreBotModule
   9
  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']
  16     },
  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
  21     },
  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")
  23
  24   attr :nolog_rx, :dolog_rx
  25   def initialize
  26     super
  27     @logs = Hash.new
  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'])
  30   end
  31
  32   def can_log_on(where)
  33     return true if @dolog_rx and where.match @dolog_rx
  34     return false if @nolog_rx and where.match @nolog_rx
  35     return true
  36   end
  37
  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)
  45       ar
  46     }.each { |w| logfile_close(w, 'logging disabled here') }
  47   end
  48
  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})"
  53     f[1].close
  54   end
  55
  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
  60     now = Time.now
  61     stamp = now.strftime("%Y/%m/%d %H:%M:%S")
  62     if where.class <= Server
  63       where_str = "server"
  64     else
  65       where_str = where.downcase.gsub(/[:!?$*()\/\\<>|"']/, "_")
  66     end
  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]}"
  74         end
  75       end
  76       f = File.new("#{@bot.botclass}/logs/#{where_str}", "a")
  77       f.sync = true
  78       f.puts "[#{stamp}] @ Log started by #{@bot.myself.nick}"
  79       @logs[where_str] = [now, f]
  80     end
  81     @logs[where_str][1].puts "[#{stamp}] #{message}"
  82     @logs[where_str][0] = now
  83     #debug "[#{stamp}] <#{where}> #{message}"
  84   end
  85
  86   def cleanup
  87     @logs.keys.each { |w| logfile_close(w, 'rescan or shutdown') }
  88   end
  89
  90   def sent(m)
  91     case m
  92     when NoticeMessage
  93       irclog "-#{m.source}- #{m.message}", m.target
  94     when PrivMessage
  95       irclog "<#{m.source}> #{m.message}", m.target
  96     when QuitMessage
  97       m.was_on.each { |ch|
  98         irclog "@ quit (#{m.message})", ch
  99       }
 100     end
 101   end
 102
 103   def welcome(m)
 104     irclog "joined server #{m.server} as #{m.target}", "server"
 105   end
 106
 107   def listen(m)
 108     case m
 109     when PrivMessage
 110       method = 'log_message'
 111     else
 112       method = 'log_' + m.class.name.downcase.match(/^irc::(\w+)message$/).captures.first
 113     end
 114     if self.respond_to?(method)
 115       self.__send__(method, m)
 116     else
 117       warning "unhandled logging for #{m.pretty_inspect} (no such method #{method})"
 118       unknown_message(m)
 119     end
 120   end
 121
 122   def log_message(m)
 123     if m.ctcp
 124       who = m.private? ? "me" : m.target
 125       logtarget = m.private? ? m.source : m.target
 126       case m.ctcp.intern
 127       when :ACTION
 128         if m.public?
 129           irclog "* #{m.source} #{m.logmessage}", m.target
 130         else
 131           irclog "* #{m.source}(#{m.sourceaddress}) #{m.logmessage}", m.source
 132         end
 133       when :VERSION
 134         irclog "@ #{m.source} asked #{who} about version info", logtarget
 135       when :SOURCE
 136         irclog "@ #{m.source} asked #{who} about source info", logtarget
 137       when :PING
 138         irclog "@ #{m.source} pinged #{who}", logtarget
 139       when :TIME
 140         irclog "@ #{m.source} asked #{who} what time it is", logtarget
 141       else
 142         irclog "@ #{m.source} asked #{who} about #{[m.ctcp, m.message].join(' ')}", logtarget
 143       end
 144     else
 145       if m.public?
 146         irclog "<#{m.source}> #{m.logmessage}", m.target
 147       else
 148         irclog "<#{m.source}(#{m.sourceaddress})> #{m.logmessage}", m.source
 149       end
 150     end
 151   end
 152
 153   def log_notice(m)
 154     if m.private?
 155       irclog "-#{m.source}(#{m.sourceaddress})- #{m.logmessage}", m.source
 156     else
 157       irclog "-#{m.source}- #{m.logmessage}", m.target
 158     end
 159   end
 160
 161   def motd(m)
 162     m.message.each_line { |line|
 163       irclog "MOTD: #{line}", "server"
 164     }
 165   end
 166
 167   def log_nick(m)
 168     m.is_on.each { |ch|
 169       irclog "@ #{m.oldnick} is now known as #{m.newnick}", ch
 170     }
 171   end
 172
 173   def log_quit(m)
 174     m.was_on.each { |ch|
 175       irclog "@ Quit: #{m.source}: #{m.logmessage}", ch
 176     }
 177   end
 178
 179   def modechange(m)
 180     irclog "@ Mode #{m.logmessage} by #{m.source}", m.target
 181   end
 182
 183   def log_join(m)
 184     if m.address?
 185       debug "joined channel #{m.channel}"
 186       irclog "@ Joined channel #{m.channel}", m.channel
 187     else
 188       irclog "@ #{m.source} joined channel #{m.channel}", m.channel
 189     end
 190   end
 191
 192   def log_part(m)
 193     if(m.address?)
 194       debug "left channel #{m.channel}"
 195       irclog "@ Left channel #{m.channel} (#{m.logmessage})", m.channel
 196     else
 197       irclog "@ #{m.source} left channel #{m.channel} (#{m.logmessage})", m.channel
 198     end
 199   end
 200
 201   def log_kick(m)
 202     if(m.address?)
 203       debug "kicked from channel #{m.channel}"
 204       irclog "@ You have been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
 205     else
 206       irclog "@ #{m.target} has been kicked from #{m.channel} by #{m.source} (#{m.logmessage})", m.channel
 207     end
 208   end
 209
 210   # def log_invite(m)
 211   #   # TODO
 212   # end
 213
 214   def log_topic(m)
 215     case m.info_or_set
 216     when :set
 217       if m.source == @bot.myself
 218         irclog "@ I set topic \"#{m.topic}\"", m.channel
 219       else
 220         irclog "@ #{m.source} set topic \"#{m.topic}\"", m.channel
 221       end
 222     when :info
 223       topic = m.channel.topic
 224       irclog "@ Topic is \"#{m.topic}\"", m.channel
 225       irclog "@ Topic set by #{topic.set_by} on #{topic.set_on}", m.channel
 226     end
 227   end
 228
 229   # def names(m)
 230   #   # TODO
 231   # end
 232
 233   def unknown_message(m)
 234     irclog m.logmessage, ".unknown"
 235   end
 236 end
 237
 238 ilm = IrcLogModule.new
 239 ilm.priority = -1
 240