# # This file is part of SickGear. # # SickGear is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # SickGear is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with SickGear. If not, see . from __future__ import with_statement import codecs import logging import glob import os import re import sys import threading import time import zipfile from logging.handlers import TimedRotatingFileHandler import sickbeard from sickbeard import classes import sickbeard.helpers try: from lib.send2trash import send2trash except ImportError: pass ERROR = logging.ERROR WARNING = logging.WARNING MESSAGE = logging.INFO DEBUG = logging.DEBUG DB = 5 reverseNames = {u'ERROR': ERROR, u'WARNING': WARNING, u'INFO': MESSAGE, u'DEBUG': DEBUG, u'DB': DB} # suppress output with this handler class NullHandler(logging.Handler): def emit(self, record): pass class SBRotatingLogHandler(object): def __init__(self, log_file): self.log_file = log_file self.log_file_path = log_file self.h_file = None self.h_console = None self.console_logging = False self.log_lock = threading.Lock() self.log_types = ['sickbeard', 'tornado.application', 'tornado.general', 'imdbpy', 'subliminal'] self.log_types_null = ['tornado.access'] def __del__(self): pass def close_log(self, handler=None): handlers = [] if not handler: handlers = [self.h_file] if None is not self.h_console: handlers += [self.h_console] elif not isinstance(handler, list): handlers = [handler] for handler in handlers: for logger_name in self.log_types + self.log_types_null: logging.getLogger(logger_name).removeHandler(handler) handler.flush() handler.close() def init_logging(self, console_logging=False): self.console_logging |= console_logging self.log_file_path = os.path.join(sickbeard.LOG_DIR, self.log_file) # get old handler for post switch-over closure old_h_file = old_h_console = None if self.h_file or self.h_console: if self.h_file: old_h_file = self.h_file if self.h_console: old_h_console = self.h_console # add a new logging level DB logging.addLevelName(5, 'DB') if self.console_logging: # get a console handler to output INFO or higher messages to sys.stderr h_console = logging.StreamHandler() h_console.setLevel((logging.INFO, logging.DEBUG)[sickbeard.DEBUG]) h_console.setFormatter(DispatchingFormatter(self._formatters(), logging.Formatter('%(message)s'), )) self.h_console = h_console # add the handler to the root logger for logger_name in self.log_types: logging.getLogger(logger_name).addHandler(h_console) for logger_name in self.log_types_null: logging.getLogger(logger_name).addHandler(NullHandler()) h_file = TimedCompressedRotatingFileHandler(self.log_file_path, logger=self) h_file.setLevel(reverseNames[sickbeard.FILE_LOGGING_PRESET]) h_file.setFormatter(DispatchingFormatter(self._formatters(False), logging.Formatter('%(message)s'), )) self.h_file = h_file for logger_name in self.log_types: logging.getLogger(logger_name).addHandler(h_file) log_level = (logging.WARNING, logging.DEBUG)[sickbeard.DEBUG] for logger_name in [x for x in self.log_types if 'sickbeard' != x]: logging.getLogger(logger_name).setLevel(log_level) logging.getLogger('sickbeard').setLevel(DB) # as now logging in new log folder, close old handlers if old_h_file: self.close_log(old_h_file) if old_h_console: self.close_log(old_h_console) def _formatters(self, log_simple=True): fmt = {} for logger_name in self.log_types: source = (re.sub('(.*\.\w\w\w).*$', r'\1', logger_name).upper() + ' :: ', '')['sickbeard' == logger_name] fmt.setdefault(logger_name, logging.Formatter( '%(asctime)s %(levelname)' + ('-8', '')[log_simple] + 's ' + source + '%(message)s', ('%Y-%m-%d ', '')[log_simple] + '%H:%M:%S')) return fmt def log(self, to_log, log_level=MESSAGE): with self.log_lock: out_line = '%s :: %s' % (threading.currentThread().getName(), to_log) sb_logger = logging.getLogger('sickbeard') setattr(sb_logger, 'db', lambda *args: sb_logger.log(DB, *args)) # sub_logger = logging.getLogger('subliminal') # imdb_logger = logging.getLogger('imdbpy') # tornado_logger = logging.getLogger('tornado') try: if DEBUG == log_level: sb_logger.debug(out_line) elif MESSAGE == log_level: sb_logger.info(out_line) elif WARNING == log_level: sb_logger.warning(out_line) elif ERROR == log_level: sb_logger.error(out_line) # add errors to the UI logger classes.ErrorViewer.add(classes.UIError(out_line)) elif DB == log_level: sb_logger.db(out_line) else: sb_logger.log(log_level, out_line) except ValueError: pass def log_error_and_exit(self, error_msg): log(error_msg, ERROR) if not self.console_logging: sys.exit(error_msg.encode(sickbeard.SYS_ENCODING, 'xmlcharrefreplace')) else: sys.exit(1) class DispatchingFormatter: def __init__(self, formatters, default_formatter): self._formatters = formatters self._default_formatter = default_formatter def __del__(self): pass def format(self, record): formatter = self._formatters.get(record.name, self._default_formatter) return formatter.format(record) class TimedCompressedRotatingFileHandler(TimedRotatingFileHandler): def __init__(self, log_file_path, logger=None, when='midnight', interval=1, backup_count=16, encoding='utf-8', delay=False, utc=False): super(TimedCompressedRotatingFileHandler, self).__init__(log_file_path, when, interval, backup_count, encoding, delay, utc) self.logger_instance = logger def doRollover(self): """ example: logger.TimedCompressedRotatingFileHandler(sickbeard.logger.sb_log_instance.log_file_path, when='M', interval=2, logger=sickbeard.logger.sb_log_instance).doRollover() """ if self.logger_instance: with self.logger_instance.log_lock: self._do_rollover() """ Extended version of TimedRotatingFileHandler that compress logs on rollover. by Angel Freire """ def _do_rollover(self): """ do a rollover; in this case, a date/time stamp is appended to the filename when the rollover happens. However, you want the file to be named for the start of the interval, not the current time. If there is a backup count, then we have to get a list of matching filenames, sort them and remove the one with the oldest suffix. This method is modified from the one in TimedRotatingFileHandler. """ self.stream.close() # get the time that this sequence started at t = self.rolloverAt - self.interval start_time = time.localtime(t) file_name = self.baseFilename.rpartition('.')[0] dfn = '%s_%s.log' % (file_name, time.strftime(self.suffix, start_time)) self.delete_logfile(dfn) self.logger_instance.close_log() self.logger_instance.h_file = self.logger_instance.h_console = None from sickbeard import encodingKludge try: encodingKludge.ek(os.rename, self.baseFilename, dfn) except (StandardError, Exception): pass self.logger_instance.init_logging() if self.encoding: self.stream = codecs.open(self.baseFilename, 'w', self.encoding) else: self.stream = open(self.baseFilename, 'w') zip_name = '%s.zip' % dfn.rpartition('.')[0] self.delete_logfile(zip_name) with zipfile.ZipFile(zip_name, 'w', zipfile.ZIP_DEFLATED) as zip_fh: zip_fh.write(dfn, os.path.basename(dfn)) self.delete_logfile(dfn) if 0 < self.backupCount: # find the oldest log file and delete it all_names = encodingKludge.ek(glob.glob, file_name + '_*') if len(all_names) > self.backupCount: all_names.sort() self.delete_logfile(all_names[0]) self.rolloverAt = self.rolloverAt + self.interval @staticmethod def delete_logfile(filepath): if os.path.exists(filepath): if sickbeard.TRASH_ROTATE_LOGS: send2trash(filepath) else: sickbeard.helpers.remove_file_failed(filepath) sb_log_instance = SBRotatingLogHandler('sickgear.log') def log(to_log, log_level=MESSAGE): sb_log_instance.log(to_log, log_level) def log_error_and_exit(error_msg): sb_log_instance.log_error_and_exit(error_msg) def close(): sb_log_instance.close_log() def log_set_level(): if sb_log_instance.h_file: sb_log_instance.h_file.setLevel(reverseNames[sickbeard.FILE_LOGGING_PRESET]) def current_log_file(): return os.path.join(sickbeard.LOG_DIR, sb_log_instance.log_file)