moparisthebest/SickRage
1
0
Fork 0
mirror of https://github.com/moparisthebest/SickRage synced 2024-12-13 11:32:20 -05:00
Code Issues Releases Wiki Activity

Logging class now uses a custom censored formatter to filter out sensitive information from being logged.

Browse Source
This commit is contained in:
echel0n 2014-12-17 00:36:42 -08:00
parent e9affae8f8
commit 9eefc8034b
1 changed files with 10 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
sickbeard/logger.py
View File

@ -46,28 +46,17 @@ class NullHandler(logging.Handler):
def emit(self, record): def emit(self, record):
pass pass
class CensoredFormatter(logging.Formatter):
class NullFilter(logging.Filter): def format(self, record):
def filter(self, record): msg = super(CensoredFormatter, self).format(record)
pass
class CensorFilter(logging.Filter):
def filter(self, record):
for k, v in censoredItems.items(): for k, v in censoredItems.items():
if v and len(v) > 0 and v in record.msg:
record.msg = record.msg.replace(v, len(v) * '*')
return True
class CensorLoggingAdapter(logging.LoggerAdapter):
def process(self, msg, kwargs):
for k, v in self.extra.items():
if v and len(v) > 0 and v in msg: if v and len(v) > 0 and v in msg:
msg = msg.replace(v, len(v) * '*') msg = msg.replace(v, len(v) * '*')
return msg, kwargs return msg
class Logger(object): class Logger(object):
def __init__(self): def __init__(self):
self.logger = CensorLoggingAdapter(logging.getLogger('sickrage'), censoredItems) self.logger = logging.getLogger('sickrage')
self.loggers = [ self.loggers = [
logging.getLogger('sickrage'), logging.getLogger('sickrage'),
@ -95,9 +84,9 @@ class Logger(object):
# set custom root logger # set custom root logger
for logger in self.loggers: for logger in self.loggers:
if logger is not self.logger.logger: if logger is not self.logger:
logger.root = self.logger.logger logger.root = self.logger
logger.parent = self.logger.logger logger.parent = self.logger
# set minimum logging level allowed for loggers # set minimum logging level allowed for loggers
for logger in self.loggers: for logger in self.loggers:
@ -106,8 +95,7 @@ class Logger(object):
# console log handler # console log handler
if self.consoleLogging: if self.consoleLogging:
console = logging.StreamHandler() console = logging.StreamHandler()
console.setFormatter(logging.Formatter('%(asctime)s %(levelname)s::%(message)s', '%H:%M:%S')) console.setFormatter(CensoredFormatter('%(asctime)s %(levelname)s::%(message)s', '%H:%M:%S'))
console.addFilter(CensorFilter())
console.setLevel(INFO if not self.debugLogging else DEBUG) console.setLevel(INFO if not self.debugLogging else DEBUG)
for logger in self.loggers: for logger in self.loggers:
@ -116,8 +104,7 @@ class Logger(object):
# rotating log file handler # rotating log file handler
if self.fileLogging: if self.fileLogging:
rfh = logging.handlers.RotatingFileHandler(self.logFile, maxBytes=1024 * 1024, backupCount=5, encoding='utf-8') rfh = logging.handlers.RotatingFileHandler(self.logFile, maxBytes=1024 * 1024, backupCount=5, encoding='utf-8')
rfh.setFormatter(logging.Formatter('%(asctime)s %(levelname)-8s %(message)s', '%Y-%m-%d %H:%M:%S')) rfh.setFormatter(CensoredFormatter('%(asctime)s %(levelname)-8s %(message)s', '%Y-%m-%d %H:%M:%S'))
rfh.addFilter(CensorFilter())
rfh.setLevel(DEBUG) rfh.setLevel(DEBUG)
for logger in self.loggers: for logger in self.loggers: