Source code for daklib.daklog

"""
Logging functions

@contact: Debian FTP Master <ftpmaster@debian.org>
@copyright: 2001, 2002, 2006  James Troup <james@nocrew.org>
@license: GNU General Public License version 2 or later
"""

# 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 2 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, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

################################################################################

import fcntl
import os
import sys
import time
import traceback
from typing import Any

from . import utils

################################################################################




class Logger:
    "Logger object"

    __shared_state: dict[str, Any] = {}

    def __init__(
        self, program="unknown", debug=False, print_starting=True, include_pid=False
    ):
        self.__dict__ = self.__shared_state

        self.program = program
        self.debug = debug
        self.include_pid = include_pid

        if not getattr(self, "logfile", None):
            self._open_log(debug)

        if print_starting:
            self.log(["program start"])



    def _open_log(self, debug: bool) -> None:
        # Create the log directory if it doesn't exist
        from daklib.config import Config

        logdir = Config()["Dir::Log"]
        if not os.path.exists(logdir):
            umask = os.umask(00000)
            os.makedirs(logdir, 0o2775)
            os.umask(umask)

        # Open the logfile
        logfilename = "%s/%s" % (logdir, time.strftime("%Y-%m"))
        logfile = None

        if debug:
            logfile = sys.stderr
        else:
            umask = os.umask(0o0002)
            logfile = open(logfilename, "a")
            os.umask(umask)

        self.logfile = logfile




    def log(self, details: list[object]) -> None:
        "Log an event"
        # Prepend timestamp, program name, and user name
        details_str = [time.strftime("%Y%m%d%H%M%S"), self.program, utils.getusername()]
        # Force the contents of the list to be string.join-able
        details_str.extend(str(i) for i in details)
        fcntl.lockf(self.logfile, fcntl.LOCK_EX)
        # Write out the log in TSV
        self.logfile.write("|".join(details_str) + "\n")
        # Flush the output to enable tail-ing
        self.logfile.flush()
        fcntl.lockf(self.logfile, fcntl.LOCK_UN)




    def log_traceback(self, info, ex) -> None:
        "Log an exception with a traceback"
        self.log([info, repr(ex)])
        for line in traceback.format_exc().split("\n")[:-1]:
            self.log(["traceback", line])




    def close(self) -> None:
        "Close a Logger object"
        self.log(["program end"])
        self.logfile.close()