-
Notifications
You must be signed in to change notification settings - Fork 201
/
logger.py
138 lines (99 loc) · 4.17 KB
/
logger.py
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
# Back In Time
# Copyright (C) 2008-2022 Oprea Dan, Bart de Koning, Richard Bailey, Germar Reitze
#
# 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import syslog
import os
import sys
import atexit
import tools
import bcolors
DEBUG = False # Set to "True" when passing "--debug" as cmd arg
SYSLOG_IDENTIFIER = 'backintime'
SYSLOG_MESSAGE_PREFIX = ''
# Labels for the syslog levels
_level_names = {
syslog.LOG_INFO: 'INFO',
syslog.LOG_ERR: 'ERROR',
syslog.LOG_WARNING: 'WARNING',
syslog.LOG_DEBUG: 'DEBUG'
}
def openlog():
syslog.openlog(SYSLOG_IDENTIFIER)
atexit.register(closelog)
def changeProfile(profile_id, profile_name):
global SYSLOG_MESSAGE_PREFIX
SYSLOG_MESSAGE_PREFIX = f'{profile_name}({profile_id}) :: '
def closelog():
syslog.closelog()
def _do_syslog(message: str, level: int) -> str:
for line in tools.wrapLine(message):
syslog.syslog(level, '{}{}: {}'.format(
SYSLOG_MESSAGE_PREFIX, _level_names[level], line))
def error(msg, parent=None, traceDepth=0):
if DEBUG:
msg = '%s %s' % (_debugHeader(parent, traceDepth), msg)
print('%sERROR%s: %s' % (bcolors.FAIL, bcolors.ENDC, msg), file=sys.stderr)
_do_syslog(msg, syslog.LOG_ERR)
def warning(msg, parent=None, traceDepth=0):
if DEBUG:
msg = '%s %s' % (_debugHeader(parent, traceDepth), msg)
print('%sWARNING%s: %s' % (bcolors.WARNING, bcolors.ENDC, msg),
file=sys.stderr)
_do_syslog(msg, syslog.LOG_WARNING)
def info(msg, parent=None, traceDepth=0):
if DEBUG:
msg = '%s %s' % (_debugHeader(parent, traceDepth), msg)
print('%sINFO%s: %s' % (bcolors.OKGREEN, bcolors.ENDC, msg),
file=sys.stderr)
_do_syslog(msg, syslog.LOG_INFO)
def debug(msg, parent=None, traceDepth=0):
if DEBUG:
msg = '%s %s' % (_debugHeader(parent, traceDepth), msg)
# Why does this code differ from eg. "error()"
# (where the following lines are NOT part of the "if")?
print('%sDEBUG%s: %s' % (bcolors.OKBLUE, bcolors.ENDC, msg),
file=sys.stderr)
_do_syslog(msg, syslog.LOG_DEBUG)
def deprecated(parent=None):
"""Dev note (buhtz 2023-07-23): To my knowledge this function is called
only one time in BIT. I assume it could be replace with python's own
deprecation warning system.
"""
frame = sys._getframe(1)
fdir, fname = os.path.split(frame.f_code.co_filename)
fmodule = os.path.basename(fdir)
line = frame.f_lineno
if parent:
fclass = '%s.' %parent.__class__.__name__
else:
fclass = ''
func = frame.f_code.co_name
frameCaller = sys._getframe(2)
fdirCaller, fnameCaller = os.path.split(frameCaller.f_code.co_filename)
fmoduleCaller = os.path.basename(fdirCaller)
lineCaller = frameCaller.f_lineno
msg = '%s/%s:%s %s%s called from ' %(fmodule, fname, line, fclass, func)
msgCaller = '%s/%s:%s' %(fmoduleCaller, fnameCaller, lineCaller)
print('%sDEPRECATED%s: %s%s%s%s' %(bcolors.WARNING, bcolors.ENDC, msg, bcolors.OKBLUE, msgCaller, bcolors.ENDC), file=sys.stderr)
_do_syslog('DEPRECATED: %s%s' % (msg, msgCaller), syslog.LOG_WARNING)
def _debugHeader(parent, traceDepth):
frame = sys._getframe(2 + traceDepth)
fdir, fname = os.path.split(frame.f_code.co_filename)
fmodule = os.path.basename(fdir)
line = frame.f_lineno
fclass = '%s.' % parent.__class__.__name__ if parent else ''
func = frame.f_code.co_name
return '[%s/%s:%s %s%s]' % (fmodule, fname, line, fclass, func)