log.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
# @COPYRIGHT_begin
#
# Copyright [2010-2014] Institute of Nuclear Physics PAN, Krakow, Poland
#
# Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
# @COPYRIGHT_end

##
# @package src.clm.utils.log
# @author Gaetano
# @date May 8, 2013
# 
import logging
import os
from django.conf import settings


# # Set of active loggers - ones currently writing to logs.
active_loggers = set([])


##
# 
#     Returns logger.
# 
#     - If no logger_id is provided, then logger is anonymus. His logs go to the file
#     intended for storing anonimous logs.
# 
#     - Otherwise user is added to active loggers. Function creates unique file
#     handler for his logs.
# 
#     This way actions may be analyzed per user.
#     
def get_logger(logger_id):
    if logger_id:
        log_name = 'user_%d' % logger_id
    else:
        log_name = 'no_user'
        logger_id = 0
    if logger_id in active_loggers:
        return logging.getLogger(log_name)

    active_loggers.add(logger_id)
    logger = logging.getLogger(log_name)
    hdlr = logging.handlers.TimedRotatingFileHandler(os.path.join(settings.LOG_DIR, '%s.log' % log_name), when='D', interval=1)
    formatter = logging.Formatter(settings.LOG_FORMAT)
    hdlr.setFormatter(formatter)
    logger.addHandler(hdlr)
    logger.setLevel(settings.LOG_LEVEL)
    return logger


##
# 
#     @parameter{logger_id,int} optional, id of the logger. If no id is provided,
#     logs are anonymus.
#     @parameter{text,string} content of the log.
# 
#     Prints debug log with @prm{contetnt} to log file of the user @prm{id}.
#     
def debug(logger_id, text):
    get_logger(logger_id).debug(text)


##
# 
#     @parameter{logger_id,int} optional, id of the logger. If no id is provided,
#     logs are anonymus.
#     @parameter{text,string} content of the log.
# 
#     Prints info log with @prm{text} contetnt to log file of the user @prm{logger_id}.
#     
def info(logger_id, text):
    get_logger(logger_id).info(text)


##
# 
#     @parameter{logger_id,int} optional, id of the logger. If no logger_id is provided,
#     logs are anonymus.
#     @parameter{text,string} content of the log.
# 
#     Prints warning log with @prm{text} contetnt to log file of the user @prm{logger_id}.
#     
def warning(logger_id, text):
    get_logger(logger_id).warning(text)


##
# 
#     @parameter{logger_id,int} optional, id of the logger. If no id is provided,
#     logs are anonymus.
#     @parameter{text,string} content of the log.
# 
#     Prints exception log with @prm{text} contetnt to log file of the user @prm{logger_id}.
#     
def exception(logger_id, text):
    get_logger(logger_id).exception(text)


##
# 
#     @parameter{logger_id,int} optional, id of the logger. If no id is provided,
#     logs are anonymus.
#     @parameter{text,string} content of the log.
# 
#     Prints error log with @prm{text} contetnt to log file of the user @prm{logger_id}.
#     
def error(logger_id, text):
    get_logger(logger_id).error(text)