]> git.decadent.org.uk Git - dak.git/blob - daklib/daklog.py
Deal with args being a tuple
[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, *args, **kwargs):
40         self.__dict__ = self.__shared_state
41
42         if not getattr(self, 'initialised', False):
43             from daklib.config import Config
44             self.initialised = True
45
46             # To be backwards compatibile, dump the first argument if it's a
47             # Config object.  TODO: Fix up all callers and remove this
48             if len(args) > 0 and isinstance(args[0], Config):
49                 args=list(args).pop(0)
50
51             self.__setup(*args, **kwargs)
52
53
54     def __setup(self, program='unknown', debug=False, print_starting=True, include_pid=False):
55         "Initialize a new Logger object"
56         self.program = program
57         self.debug = debug
58         self.include_pid = include_pid
59
60         # Create the log directory if it doesn't exist
61         from daklib.config import Config
62         logdir = Config()["Dir::Log"]
63         if not os.path.exists(logdir):
64             umask = os.umask(00000)
65             os.makedirs(logdir, 02775)
66             os.umask(umask)
67
68         # Open the logfile
69         logfilename = "%s/%s" % (logdir, time.strftime("%Y-%m"))
70         logfile = None
71
72         if debug:
73             logfile = sys.stderr
74         else:
75             umask = os.umask(00002)
76             logfile = utils.open_file(logfilename, 'a')
77             os.umask(umask)
78
79         self.logfile = logfile
80
81         if print_starting:
82             self.log(["program start"])
83
84     def log (self, details):
85         "Log an event"
86         # Prepend timestamp, program name, and user name
87         details.insert(0, utils.getusername())
88         details.insert(0, self.program)
89         timestamp = time.strftime("%Y%m%d%H%M%S")
90         details.insert(0, timestamp)
91         # Force the contents of the list to be string.join-able
92         details = [ str(i) for i in details ]
93         # Write out the log in TSV
94         self.logfile.write("|".join(details)+'\n')
95         # Flush the output to enable tail-ing
96         self.logfile.flush()
97
98     def close (self):
99         "Close a Logger object"
100         self.log(["program end"])
101         self.logfile.flush()
102         self.logfile.close()