]> git.decadent.org.uk Git - dak.git/blob - daklib/daklog.py
rewrite daklib.utils.gpg_get_key_addresses
[dak.git] / daklib / daklog.py
1 #!/usr/bin/env python
2
3 """
4 Logging functions
5
6 @contact: Debian FTP Master <ftpmaster@debian.org>
7 @copyright: 2001, 2002, 2006  James Troup <james@nocrew.org>
8 @license: GNU General Public License version 2 or later
9 """
10
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2 of the License, or
14 # (at your option) any later version.
15
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 # GNU General Public License for more details.
20
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24
25 ################################################################################
26
27 import os
28 import pwd
29 import time
30 import sys
31 import utils
32
33 ################################################################################
34
35 class Logger(object):
36     "Logger object"
37     __shared_state = {}
38
39     def __init__(self, program='unknown', debug=False, print_starting=True, include_pid=False):
40         self.__dict__ = self.__shared_state
41
42         self.program = program
43         self.debug = debug
44         self.include_pid = include_pid
45
46         if not getattr(self, 'logfile', None):
47             self._open_log(debug)
48
49         if print_starting:
50             self.log(["program start"])
51
52     def _open_log(self, debug):
53         # Create the log directory if it doesn't exist
54         from daklib.config import Config
55         logdir = Config()["Dir::Log"]
56         if not os.path.exists(logdir):
57             umask = os.umask(00000)
58             os.makedirs(logdir, 0o2775)
59             os.umask(umask)
60
61         # Open the logfile
62         logfilename = "%s/%s" % (logdir, time.strftime("%Y-%m"))
63         logfile = None
64
65         if debug:
66             logfile = sys.stderr
67         else:
68             umask = os.umask(0o0002)
69             logfile = utils.open_file(logfilename, 'a')
70             os.umask(umask)
71
72         self.logfile = logfile
73
74     def log (self, details):
75         "Log an event"
76         # Prepend timestamp, program name, and user name
77         details.insert(0, utils.getusername())
78         details.insert(0, self.program)
79         timestamp = time.strftime("%Y%m%d%H%M%S")
80         details.insert(0, timestamp)
81         # Force the contents of the list to be string.join-able
82         details = [ str(i) for i in details ]
83         # Write out the log in TSV
84         self.logfile.write("|".join(details)+'\n')
85         # Flush the output to enable tail-ing
86         self.logfile.flush()
87
88     def close (self):
89         "Close a Logger object"
90         self.log(["program end"])
91         self.logfile.flush()
92         self.logfile.close()