plugins/logger.rb

   1 #
   2 # Logging plugin for CyBot.
   3 #
   4
   5 class Logger < PluginBase
   6
   7   # We want these.
   8 #  Channel_Instances = true
   9
  10   # Some per-channel init.
  11   def initialize(*args)
  12     @brief_help = 'Records various channel activities.'
  13     super(*args)
  14     @seen = {}
  15   end
  16
  17   # Load/save database.
  18   def load
  19     begin
  20       @seen = YAML.load_file(file_name('seen.db'))
  21     rescue
  22       @seen = {}
  23     end
  24   end
  25   def save
  26     open_file('seen.db', 'w') do |f|
  27       f.puts '# CyBot logger plugin: Seen database.'
  28       YAML.dump(@seen, f)
  29       f.puts ''
  30     end
  31   end
  32
  33   # Log types.
  34   LogPrivmsg  = 1
  35   LogNotice   = 2
  36   LogJoin     = 3
  37   LogPart     = 4
  38   LogNick     = 5
  39
  40   # Hook for PRIVMSGs to a channel the bot is in.
  41   def hook_privmsg_chan(irc, msg)
  42     l = @seen[cn = irc.channel.name] || (@seen[cn] = {})
  43     l[irc.from.nnick] = [Time.now, LogPrivmsg, msg]
  44   end
  45
  46   def hook_notice_chan(irc, msg)
  47     l = @seen[cn = irc.channel.name] || (@seen[cn] = {})
  48     l[irc.from.nnick] = [Time.now, LogNotice, msg]
  49   end
  50
  51   def hook_join_chan(irc)
  52     l = @seen[cn = irc.channel.name] || (@seen[cn] = {})
  53     l[irc.from.nnick] = [Time.now, LogJoin]
  54   end
  55
  56   def hook_part_chan(irc)
  57     l = @seen[cn = irc.channel.name] || (@seen[cn] = {})
  58     l[irc.from.nnick] = [Time.now, LogPart]
  59   end
  60
  61   def hook_command_serv(irc, handled, cmd, *args)
  62     if cmd == 'NICK'
  63       @seen.each_value do |c|
  64         c[irc.from.nnick] = [Time.now, LogNick, args[0]]
  65       end
  66     end
  67   end
  68
  69   def chan_seen(irc, chan, nick)
  70     if nick
  71       if l = @seen[chan.name] and l = l[IRC::Address.normalize nick]
  72         irc.reply "#{nick} was last seen #{seconds_to_s((Time.now - l[0]).to_i, irc)} ago, " + case l[1]
  73         when LogJoin:     "joining."
  74         when LogPart:     "leaving."
  75         when LogNick:     "changing nick to #{l[2]}"
  76         when LogPrivmsg:  "saying: #{l[2]}"
  77         when LogNoting:   "noting: #{l[2]}"
  78         else              "doing something unknown :-p."
  79         end
  80       else
  81         irc.reply "I haven't seen #{nick}."
  82       end
  83     else
  84       irc.reply 'USAGE: seen [channel] <nick name>'
  85     end
  86   end
  87   help :seen, "Type 'seen <nick>' and I'll tell you when I last heard something from <nick>, and what he or she was saying or doing."
  88
  89 end
  90