summaryrefslogtreecommitdiff
path: root/pysnmp/debug.py
blob: e0e536078e41275151daf76ba6fa093a872ca284 (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
#
# This file is part of pysnmp software.
#
# Copyright (c) 2005-2019, Ilya Etingof <etingof@gmail.com>
# License: http://snmplabs.com/pysnmp/license.html
#
import logging

from pyasn1.compat.octets import octs2ints

from pysnmp import __version__
from pysnmp import error

FLAG_NONE = 0x0000
FLAG_IO = 0x0001
FLAG_DSP = 0x0002
FLAG_MP = 0x0004
FLAG_SM = 0x0008
FLAG_BLD = 0x0010
FLAG_MIB = 0x0020
FLAG_INS = 0x0040
FLAG_ACL = 0x0080
FLAG_PRX = 0x0100
FLAG_APP = 0x0200
FLAG_ALL = 0xffff

FLAG_MAP = {
    'io': FLAG_IO,
    'dsp': FLAG_DSP,
    'msgproc': FLAG_MP,
    'secmod': FLAG_SM,
    'mibbuild': FLAG_BLD,
    'mibview': FLAG_MIB,
    'mibinstrum': FLAG_INS,
    'acl': FLAG_ACL,
    'proxy': FLAG_PRX,
    'app': FLAG_APP,
    'all': FLAG_ALL
}


class Printer(object):
    def __init__(self, logger=None, handler=None, formatter=None):
        if logger is None:
            logger = logging.getLogger('pysnmp')

        logger.setLevel(logging.DEBUG)

        if handler is None:
            handler = logging.StreamHandler()

        if formatter is None:
            formatter = logging.Formatter('%(asctime)s %(name)s: %(message)s')

        handler.setFormatter(formatter)
        handler.setLevel(logging.DEBUG)

        logger.addHandler(handler)

        self.__logger = logger

    def __call__(self, msg):
        self.__logger.debug(msg)

    def __str__(self):
        return '<python built-in logging>'


if hasattr(logging, 'NullHandler'):
    NullHandler = logging.NullHandler

else:
    # Python 2.6
    class NullHandler(logging.Handler):
        def emit(self, record):
            pass


class Debug(object):
    DEFAULT_PRINTER = None

    def __init__(self, *flags, **options):
        self._flags = FLAG_NONE

        if options.get('printer') is not None:
            self._printer = options.get('printer')

        elif self.DEFAULT_PRINTER is not None:
            self._printer = self.DEFAULT_PRINTER

        else:
            if 'loggerName' in options:
                # route our logs to parent logger
                self._printer = Printer(
                    logger=logging.getLogger(options['loggerName']),
                    handler=NullHandler())

            else:
                self._printer = Printer()

        self('running pysnmp version %s' % __version__)

        for flag in flags:
            negate = flag and flag[0] in ('!', '~')
            if negate:
                flag = flag[1:]

            try:
                if negate:
                    self._flags &= ~FLAG_MAP[flag]

                else:
                    self._flags |= FLAG_MAP[flag]

            except KeyError:
                raise error.PySnmpError('bad debug flag %s' % flag)

            self('debug category "%s" '
                 '%s' % (flag, negate and 'disabled' or 'enabled'))

    def __str__(self):
        return 'logger %s, flags %x' % (self._printer, self._flags)

    def __call__(self, msg):
        self._printer(msg)

    def __and__(self, flag):
        return self._flags & flag

    def __rand__(self, flag):
        return flag & self._flags


# This will yield false from bitwise and with a flag, and save
# on unnecessary calls
logger = 0


def setLogger(l):
    global logger
    logger = l


def hexdump(octets):
    return ' '.join(
        '%s%.2X' % (n % 16 == 0 and ('\n%.5d: ' % n) or '', x)
        for n, x in zip(range(len(octets)), octs2ints(octets)))