summaryrefslogtreecommitdiffstats
path: root/pykolab/logger.py
blob: 1a826d96d7df1c31e25ee7d98b3b51a2e15f337b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# -*- coding: utf-8 -*-
# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
#
# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
#
# 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/>.
#
from __future__ import print_function

import grp
import logging
import logging.handlers
import os
import pwd
import sys


class StderrToLogger:
    """
    Fake file-like stream object that redirects writes to a logger instance.
    """
    def __init__(self, logger, log_level=logging.DEBUG):
        self.logger = logger
        self.log_level = log_level
        self.linebuf = ''
        self.skip_next = False

    def write(self, buf):
        # ugly patch to make smtplib and smtpd debug logging records appear on one line in log file
        # smtplib uses "print>>stderr, var, var" statements for debug logging. These
        # statements are splited into separate lines on separating whitespace.

        for line in buf.rstrip().splitlines():
            if self.skip_next:
                self.skip_next = False
                continue

            if buf != '\n':
                linestarts = line.split(':')[0]
                if linestarts in ['send', 'reply', 'Data', 'recips', 'Peer', 'sender']:
                    self.linebuf = line
                elif linestarts.startswith('===>'):
                    # Do not log lines starting with ====>
                    self.linebuf = ''
                    self.skip_next = True
                    continue
                else:
                    self.logger.log(self.log_level, '%s %s', self.linebuf, line.rstrip()[:150])
                    self.linebuf = ''

    def flush(self):
        pass


class LoggerAdapter(logging.LoggerAdapter):
    """
        Custom LoggingAdapter to log Wallace mail message Queue ID
    """

    def process(self, msg, kwargs):
        return '%s %s' % (self.extra['qid'], msg), kwargs


class Logger(logging.Logger):
    """
        The PyKolab version of a logger.

        This class wraps the Python native logging library, adding to the
        loglevel capabilities, a debuglevel capability.
    """
    debuglevel = 0
    fork = False
    loglevel = logging.CRITICAL
    process_username = 'kolab'
    process_groupname = 'kolab-n'

    if hasattr(sys, 'argv'):
        for arg in sys.argv:
            if debuglevel == -1:
                try:
                    debuglevel = (int)(arg)
                except ValueError:
                    continue

                loglevel = logging.DEBUG
                break

            if arg == '-d':
                debuglevel = -1
                continue

            if arg == '-l':
                loglevel = -1
                continue

            if arg == '--fork':
                fork = True

            if loglevel == -1:
                if hasattr(logging, arg.upper()):
                    loglevel = getattr(logging, arg.upper())
                else:
                    loglevel = logging.DEBUG

            if arg in ['-u', '--user']:
                process_username = -1
                continue

            if arg.startswith('--user='):
                process_username = arg.split('=')[1]

            if process_username == -1:
                process_username = arg

            if arg in ['-g', '--group']:
                process_groupname = -1
                continue

            if arg.startswith('--group='):
                process_groupname = arg.split('=')[1]

            if process_groupname == -1:
                process_groupname = arg

    # pylint: disable=too-many-branches
    # pylint: disable=too-many-locals
    # pylint: disable=too-many-statements
    def __init__(self, *args, **kw):
        if 'name' in kw:
            name = kw['name']
        elif len(args) == 1:
            name = args[0]
        else:
            name = 'pykolab'

        logging.Logger.__init__(self, name)

        plaintextformatter = logging.Formatter(
            "%(asctime)s %(name)s %(levelname)s [%(process)d] %(message)s"
        )

        if not self.fork:
            self.console_stdout = logging.StreamHandler(sys.stdout)
            self.console_stdout.setFormatter(plaintextformatter)

            self.addHandler(self.console_stdout)

        if 'logfile' in kw:
            self.logfile = kw['logfile']
        else:
            self.logfile = '/var/log/kolab/pykolab.log'

        group_gid = 0
        user_uid = 0

        # Make sure (read: attempt to change) the permissions
        try:
            try:
                (ruid, _, _) = os.getresuid()
                (rgid, _, _) = os.getresgid()
            except AttributeError:
                ruid = os.getuid()
                rgid = os.getgid()

            if ruid == 0:
                # Means we can setreuid() / setregid() / setgroups()
                if rgid == 0:
                    # Get group entry details
                    try:
                        (
                            _,
                            _,
                            group_gid,
                            _
                        ) = grp.getgrnam(self.process_groupname)

                    except KeyError:
                        group_gid = False

                if ruid == 0:
                    # Means we haven't switched yet.
                    try:
                        (
                            _,
                            _,
                            user_uid,
                            _,
                            _,
                            _,
                            _
                        ) = pwd.getpwnam(self.process_username)

                    except KeyError:
                        user_uid = False

                if os.path.isfile(self.logfile):
                    try:
                        if user_uid > 0 or group_gid > 0:
                            os.chown(
                                self.logfile,
                                user_uid,
                                group_gid
                            )

                            os.chmod(self.logfile, 660)

                    except Exception as errmsg:
                        self.error(
                            _("Could not change permissions on %s: %r") % (self.logfile, errmsg)
                        )

                        if self.debuglevel > 8:
                            import traceback
                            traceback.print_exc()

        except Exception as errmsg:
            if os.path.isfile(self.logfile):
                self.error(_("Could not change permissions on %s: %r") % (self.logfile, errmsg))
                if self.debuglevel > 8:
                    import traceback
                    traceback.print_exc()

        # Make sure the log file exists
        try:
            fhandle = open(self.logfile, 'a')
            try:
                os.utime(self.logfile, None)
            finally:
                fhandle.close()

            try:
                filelog_handler = logging.FileHandler(filename=self.logfile)
                filelog_handler.setFormatter(plaintextformatter)
            except IOError as errmsg:
                print(_("Cannot log to file %s: %s") % (self.logfile, errmsg), file=sys.stderr)

            if len(self.handlers) <= 1:
                try:
                    self.addHandler(filelog_handler)
                except Exception:
                    pass

        except IOError:
            pass

    def remove_stdout_handler(self):
        if not self.fork:
            self.console_stdout.close()
            self.removeHandler(self.console_stdout)

    # pylint: disable=arguments-differ
    # pylint: disable=keyword-arg-before-vararg
    def debug(self, msg, level=1, *args, **kw):
        self.setLevel(self.loglevel)
        # Work around other applications not using various levels of debugging
        if not self.name.startswith('pykolab') and self.debuglevel != 9:
            return

        if level <= self.debuglevel:
            self.log(logging.DEBUG, msg)


logging.setLoggerClass(Logger)