lib/rbot/logger.rb

   1 # encoding: UTF-8
   2 #-- vim:sw=2:et
   3 #++
   4 #
   5 # :title: rbot logger
   6
   7 require 'logger'
   8 require 'thread'
   9 require 'singleton'
  10
  11 module Irc
  12 class Bot
  13
  14   class LoggerManager
  15     include Singleton
  16
  17     def initialize
  18       @dateformat = "%Y/%m/%d %H:%M:%S"
  19
  20       @logger = Logger.new(STDERR)
  21       @logger.datetime_format = @dateformat
  22       @logger.level = Logger::Severity::DEBUG
  23       @file_logger = nil
  24
  25       @queue = Queue.new
  26       @thread = start_thread
  27     end
  28
  29     def set_logfile(filename, keep, max_size)
  30       @file_logger = Logger.new(filename, keep, max_size*1024*1024)
  31       @file_logger.datetime_format = @dateformat
  32     end
  33
  34     def set_level(level)
  35       @logger.level = level
  36       if @file_logger
  37         @file_logger.level = level
  38       end
  39     end
  40
  41     def sync_log(severity, message = nil, progname = nil)
  42       @logger.add(severity, message, progname)
  43       if @file_logger
  44         @file_logger.add(severity, message, progname)
  45       end
  46     end
  47
  48     def async_log(severity, message=nil, who_pos=1)
  49       unless @thread
  50         STDERR.puts('logger thread already destroyed, cannot log message!')
  51       end
  52
  53       call_stack = caller
  54       if call_stack.length > who_pos
  55         who = call_stack[who_pos].sub(%r{(?:.+)/([^/]+):(\d+)(:in .*)?}) { "#{$1}:#{$2}#{$3}" }
  56       else
  57         who = "(unknown)"
  58       end
  59       # Output each line. To distinguish between separate messages and multi-line
  60       # messages originating at the same time, we blank #{who} after the first message
  61       # is output.
  62       # Also, we output strings as-is but for other objects we use pretty_inspect
  63       message = message.kind_of?(String) ? message : (message.pretty_inspect rescue '?')
  64       qmsg = Array.new
  65       message.each_line { |l|
  66         qmsg.push [severity, l.chomp, who]
  67         who = ' ' * who.size
  68       }
  69       @queue.push qmsg
  70     end
  71
  72     def log_session_start
  73       if @file_logger
  74         @file_logger << "\n\n=== session started on #{Time.now.strftime(@dateformat)} ===\n\n"
  75       end
  76     end
  77
  78     def log_session_end
  79       if @file_logger
  80         @file_logger << "\n\n=== session ended on #{Time.now.strftime(@dateformat)} ===\n\n"
  81       end
  82     end
  83
  84     def halt_logger
  85       if @thread and @thread.alive?
  86         @queue << nil
  87         @thread.join
  88         @thread = nil
  89       end
  90     end
  91
  92     private
  93
  94     def start_thread
  95       Thread.new do
  96         lines = nil
  97         while lines = @queue.pop
  98           lines.each { |line|
  99             sync_log(*line)
 100           }
 101         end
 102       end
 103     end
 104
 105   end
 106
 107 end
 108 end
 109
 110 def debug(message=nil, who_pos=1)
 111   Irc::Bot::LoggerManager.instance.async_log(Logger::Severity::DEBUG, message, who_pos)
 112 end
 113
 114 def log(message=nil, who_pos=1)
 115   Irc::Bot::LoggerManager.instance.async_log(Logger::Severity::INFO, message, who_pos)
 116 end
 117
 118 def warning(message=nil, who_pos=1)
 119   Irc::Bot::LoggerManager.instance.async_log(Logger::Severity::WARN, message, who_pos)
 120 end
 121
 122 def error(message=nil, who_pos=1)
 123   Irc::Bot::LoggerManager.instance.async_log(Logger::Severity::ERROR, message, who_pos)
 124 end
 125
 126 def fatal(message=nil, who_pos=1)
 127   Irc::Bot::LoggerManager.instance.async_log(Logger::Severity::FATAL, message, who_pos)
 128 end