aboutsummaryrefslogtreecommitdiff
blob: 80a1ca0d8a145bc4b5d6c28af2a910879e46e008 (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
#!/usr/bin/python
# -*- coding: utf-8 -*-

""" Copyright 2005 - 2008 Gunnar Wrobel
              2011 - Brian Dolbec
 Distributed under the terms of the GNU General Public License v2
"""


__version__ = "0.1"


import sys, inspect, types

from   optparse      import OptionGroup

from   overlord.constants  import codes



class Message:
    #FIXME: Think about some simple doctests before you modify this class the
    #       next time.

    def __init__(self,
                 out = sys.stdout,
                 err = sys.stderr,
                 info_level = 4,
                 warn_level = 4,
                 col = True
                 ):

        # Where should the error output go? This can also be a file
        self.error_out = err

        # Where should the normal output go? This can also be a file
        self.std_out = out

        # The higher the level the more information you will get
        self.warn_lev = warn_level

        # The higher the level the more information you will get
        self.info_lev = info_level

        # Should the output be colored?
        self.set_colorize(col)

        self.has_error = False


    def color (self, col, text):
        return codes[col] + text + codes['reset']


    def no_color (self, col, text):
        return text


    def set_colorize(self, state):
        if state:
            self.color_func = self.color
        else:
            self.color_func = self.no_color


    def set_info_level(self, info_level = 4):
        self.info_lev = info_level


    def info_off(self):
        self.set_info_level(0)


    def info_on(self, info_level = 4):
        self.set_info_level(info_level)


    def set_warn_level(self, warn_level = 4):
        self.warn_lev = warn_level


    def warn_off(self):
        self.set_warn_level(0)


    def warn_on(self, warn_level = 4):
        self.set_warn_level(warn_level)




    ## Output Functions

    def notice (self, note):
        print >> self.std_out, note


    def info (self, info, level = 4):

        #print "info =", info

        if type(info) not in types.StringTypes:
            info = str(info)

        if level > self.info_lev:
            return

        for i in info.split('\n'):
            print  >> self.std_out, self.set_colorize('green', '* ') + i


    def status (self, message, status, info = 'ignored'):

        if type(message) not in types.StringTypes:
            message = str(message)

        lines = message.split('\n')

        if not lines:
            return

        for i in lines[0:-1]:
            print  >> self.std_out, self.set_colorize('green', '* ') + i

        i = lines[-1]

        if len(i) > 58:
            i = i[0:57]

        if status == 1:
            result = '[' + self.set_colorize('green', 'ok') + ']'
        elif status == 0:
            result = '[' + self.set_colorize('red', 'failed') + ']'
        else:
            result = '[' + self.set_colorize('yellow', info) + ']'

        print  >> self.std_out, self.set_colorize('green', '* ') + i + ' ' + \
            '.' * (58 - len(i)) + ' ' + result


    def warn (self, warn, level = 4):

        #print "DEBUG.warn()"

        if type(warn) not in types.StringTypes:
            warn = str(warn)

        if level > self.warn_lev:
            return

        for i in warn.split('\n'):
            print  >> self.std_out, self.set_colorize('yellow', '* ') + i


    def error (self, error):

        if type(error) not in types.StringTypes:
            error = str(error)

        for i in error.split('\n'):
            # NOTE: Forced flushing ensures that stdout and stderr
            # stay in nice order.  This is a workaround for calls like
            # "overlord -L |& less".
            sys.stdout.flush()
            print >> self.error_out, self.set_colorize('red', '* ') + i
            self.error_out.flush()
        self.has_error = True


    def die (self, error):

        if type(error) not in types.StringTypes:
            error = str(error)

        for i in error.split('\n'):
            self.error(self.set_colorize('red', 'Fatal error: ') + i)
        self.error(self.set_colorize('red', 'Fatal error(s) - aborting'))
        sys.exit(1)



## gloabal message handler
OUT = Message()