# -*- coding: utf-8 -*-
#+---------------------------------------------------------------------------+
#| 01001110 01100101 01110100 01111010 01101111 01100010 |
#| |
#| Netzob : Inferring communication protocols |
#+---------------------------------------------------------------------------+
#| Copyright (C) 2011-2017 Georges Bossert and Frédéric Guihéry |
#| This program 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. |
#| |
#| This program 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 this program. If not, see <http://www.gnu.org/licenses/>. |
#+---------------------------------------------------------------------------+
#| @url : http://www.netzob.org |
#| @contact : contact@netzob.org |
#| @sponsors : Amossys, http://www.amossys.fr |
#| Supélec, http://www.rennes.supelec.fr/ren/rd/cidre/ |
#+---------------------------------------------------------------------------+
#+----------------------------------------------
#| Standard library imports
#+----------------------------------------------
import logging.config
import os
import configparser
#+----------------------------------------------
#| Related third party imports
#+----------------------------------------------
#+----------------------------------------------
#| Local application imports
#+----------------------------------------------
[docs]def singleton(cls, *args, **kwargs):
"""This decorator allows to implement some kind of Singleton
design pattern. In our case, we only allow one instanciation."""
instances = {}
def getinstance(*args, **kwargs):
if cls not in instances:
instances[cls] = cls(*args, **kwargs)
elif len(args) == 0:
return instances[cls]
else:
raise Exception("{0} is already initialized".format(cls.__name__))
return getinstance
@singleton
[docs]class LoggingConfiguration(object):
"""Configure the logging layer of Netzob"""
#+----------------------------------------------
#| initializeLogging:
#+----------------------------------------------
def __init__(self, workspace, opts):
# First we extract the normal logging config file
self.loggingFilePath = os.path.join(workspace.getPath(),
workspace.getPathOfLogging())
if (self.loggingFilePath != "" and
os.path.isfile(self.loggingFilePath)):
logging.debug(
"Logging config file: {0}".format(self.loggingFilePath))
logging.config.fileConfig(self.loggingFilePath)
else:
logging.info("No logging config file found, create a default one.")
# Make a global logging object.
logger = logging.getLogger("")
logger.setLevel(logging.INFO)
h = logging.StreamHandler()
f = logging.Formatter(
"[%(threadName)s]%(asctime)s - %(module)s - %(levelname)s - %(message)s"
)
h.setFormatter(f)
logger.addHandler(h)
# Override default configuration with command line option
if opts.debugLevel in [
'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'
]:
logger = logging.getLogger()
logger.setLevel(opts.debugLevel)
self._parseConfigFile()
def _parseConfigFile(self):
self.config = configparser.ConfigParser()
self.config.read([self.loggingFilePath])
def _writeConfigFile(self):
self.config.write(open(self.loggingFilePath, 'w'))
def getLoggingLevel(self):
"""Get the logging level defined in the main configuration
file."""
return logging.getLevelName(logging.getLogger("").level)
def setLoggingLevel(self, level):
"""Modify the logging level defined in the main configuration
file."""
logger = logging.getLogger("")
if level in ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']:
logging.info("Updating logging level from {0} to {1}".format(
logging.getLevelName(logger.level), level))
self.config.set("logger_root", "level", level)
self.config.set("handler_consoleHandler", "level", level)
self._writeConfigFile()
logging.getLogger().setLevel(level)