/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2009,2010 Teddy Hogeborn
7
 
# Copyright © 2009,2010 Björn Påhlsson
 
6
# Copyright © 2009-2014 Teddy Hogeborn
 
7
# Copyright © 2009-2014 Björn Påhlsson
8
8
# 
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
25
 
from __future__ import division, absolute_import, with_statement
 
26
from __future__ import (division, absolute_import, print_function,
 
27
                        unicode_literals)
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
26
32
 
27
33
import sys
28
34
import os
29
 
import signal
30
35
 
31
36
import datetime
32
37
 
34
39
import urwid
35
40
 
36
41
from dbus.mainloop.glib import DBusGMainLoop
37
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
38
46
 
39
47
import dbus
40
48
 
41
 
import UserList
42
 
 
43
49
import locale
44
50
 
45
 
locale.setlocale(locale.LC_ALL, u'')
 
51
if sys.version_info[0] == 2:
 
52
    str = unicode
 
53
 
 
54
locale.setlocale(locale.LC_ALL, '')
46
55
 
47
56
import logging
48
57
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
49
58
 
50
59
# Some useful constants
51
 
domain = 'se.bsnet.fukt'
 
60
domain = 'se.recompile'
52
61
server_interface = domain + '.Mandos'
53
62
client_interface = domain + '.Mandos.Client'
54
 
version = "1.2"
55
 
 
56
 
# Always run in monochrome mode
57
 
urwid.curses_display.curses.has_colors = lambda : False
58
 
 
59
 
# Urwid doesn't support blinking, but we want it.  Since we have no
60
 
# use for underline on its own, we make underline also always blink.
61
 
urwid.curses_display.curses.A_UNDERLINE |= (
62
 
    urwid.curses_display.curses.A_BLINK)
 
63
version = "1.6.6"
63
64
 
64
65
def isoformat_to_datetime(iso):
65
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
66
67
    if not iso:
67
68
        return None
68
 
    d, t = iso.split(u"T", 1)
69
 
    year, month, day = d.split(u"-", 2)
70
 
    hour, minute, second = t.split(u":", 2)
 
69
    d, t = iso.split("T", 1)
 
70
    year, month, day = d.split("-", 2)
 
71
    hour, minute, second = t.split(":", 2)
71
72
    second, fraction = divmod(float(second), 1)
72
73
    return datetime.datetime(int(year),
73
74
                             int(month),
82
83
    properties and calls a hook function when any of them are
83
84
    changed.
84
85
    """
85
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
86
    def __init__(self, proxy_object=None, properties=None, **kwargs):
86
87
        self.proxy = proxy_object # Mandos Client proxy object
87
 
        
88
 
        self.properties = dict()
89
 
        self.proxy.connect_to_signal(u"PropertyChanged",
90
 
                                     self.property_changed,
91
 
                                     client_interface,
92
 
                                     byte_arrays=True)
93
 
        
94
 
        self.properties.update(
95
 
            self.proxy.GetAll(client_interface,
96
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
97
 
 
98
 
        #XXX This break good super behaviour!
99
 
#        super(MandosClientPropertyCache, self).__init__(
100
 
#            *args, **kwargs)
 
88
        self.properties = dict() if properties is None else properties
 
89
        self.property_changed_match = (
 
90
            self.proxy.connect_to_signal("PropertyChanged",
 
91
                                         self._property_changed,
 
92
                                         client_interface,
 
93
                                         byte_arrays=True))
 
94
        
 
95
        if properties is None:
 
96
            self.properties.update(
 
97
                self.proxy.GetAll(client_interface,
 
98
                                  dbus_interface
 
99
                                  = dbus.PROPERTIES_IFACE))
 
100
        
 
101
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
102
    
 
103
    def _property_changed(self, property, value):
 
104
        """Helper which takes positional arguments"""
 
105
        return self.property_changed(property=property, value=value)
101
106
    
102
107
    def property_changed(self, property=None, value=None):
103
108
        """This is called whenever we get a PropertyChanged signal
105
110
        """
106
111
        # Update properties dict with new value
107
112
        self.properties[property] = value
 
113
    
 
114
    def delete(self):
 
115
        self.property_changed_match.remove()
108
116
 
109
117
 
110
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
112
120
    """
113
121
    
114
122
    def __init__(self, server_proxy_object=None, update_hook=None,
115
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
123
                 delete_hook=None, logger=None, **kwargs):
116
124
        # Called on update
117
125
        self.update_hook = update_hook
118
126
        # Called on delete
123
131
        self.logger = logger
124
132
        
125
133
        self._update_timer_callback_tag = None
126
 
        self._update_timer_callback_lock = 0
127
 
        self.last_checker_failed = False
128
134
        
129
135
        # The widget shown normally
130
 
        self._text_widget = urwid.Text(u"")
 
136
        self._text_widget = urwid.Text("")
131
137
        # The widget shown when we have focus
132
 
        self._focus_text_widget = urwid.Text(u"")
133
 
        super(MandosClientWidget, self).__init__(
134
 
            update_hook=update_hook, delete_hook=delete_hook,
135
 
            *args, **kwargs)
 
138
        self._focus_text_widget = urwid.Text("")
 
139
        super(MandosClientWidget, self).__init__(**kwargs)
136
140
        self.update()
137
141
        self.opened = False
138
142
        
139
 
        last_checked_ok = isoformat_to_datetime(self.properties
140
 
                                                [u"LastCheckedOK"])
141
 
        if last_checked_ok is None:
142
 
            self.last_checker_failed = True
143
 
        else:
144
 
            self.last_checker_failed = ((datetime.datetime.utcnow()
145
 
                                         - last_checked_ok)
146
 
                                        > datetime.timedelta
147
 
                                        (milliseconds=
148
 
                                         self.properties
149
 
                                         [u"Interval"]))
150
 
        
151
 
        if self.last_checker_failed:
152
 
            self.using_timer(True)
153
 
        
154
 
        if self.need_approval:
155
 
            self.using_timer(True)
156
 
        
157
 
        self.proxy.connect_to_signal(u"CheckerCompleted",
158
 
                                     self.checker_completed,
159
 
                                     client_interface,
160
 
                                     byte_arrays=True)
161
 
        self.proxy.connect_to_signal(u"CheckerStarted",
162
 
                                     self.checker_started,
163
 
                                     client_interface,
164
 
                                     byte_arrays=True)
165
 
        self.proxy.connect_to_signal(u"GotSecret",
166
 
                                     self.got_secret,
167
 
                                     client_interface,
168
 
                                     byte_arrays=True)
169
 
        self.proxy.connect_to_signal(u"NeedApproval",
170
 
                                     self.need_approval,
171
 
                                     client_interface,
172
 
                                     byte_arrays=True)
173
 
        self.proxy.connect_to_signal(u"Rejected",
174
 
                                     self.rejected,
175
 
                                     client_interface,
176
 
                                     byte_arrays=True)
 
143
        self.match_objects = (
 
144
            self.proxy.connect_to_signal("CheckerCompleted",
 
145
                                         self.checker_completed,
 
146
                                         client_interface,
 
147
                                         byte_arrays=True),
 
148
            self.proxy.connect_to_signal("CheckerStarted",
 
149
                                         self.checker_started,
 
150
                                         client_interface,
 
151
                                         byte_arrays=True),
 
152
            self.proxy.connect_to_signal("GotSecret",
 
153
                                         self.got_secret,
 
154
                                         client_interface,
 
155
                                         byte_arrays=True),
 
156
            self.proxy.connect_to_signal("NeedApproval",
 
157
                                         self.need_approval,
 
158
                                         client_interface,
 
159
                                         byte_arrays=True),
 
160
            self.proxy.connect_to_signal("Rejected",
 
161
                                         self.rejected,
 
162
                                         client_interface,
 
163
                                         byte_arrays=True))
 
164
        self.logger('Created client {0}'
 
165
                    .format(self.properties["Name"]), level=0)
177
166
    
178
 
    def property_changed(self, property=None, value=None):
179
 
        super(self, MandosClientWidget).property_changed(property,
180
 
                                                         value)
181
 
        if property == u"ApprovalPending":
182
 
            using_timer(bool(value))
183
 
        
184
167
    def using_timer(self, flag):
185
168
        """Call this method with True or False when timer should be
186
169
        activated or deactivated.
187
170
        """
188
 
        old = self._update_timer_callback_lock
189
 
        if flag:
190
 
            self._update_timer_callback_lock += 1
191
 
        else:
192
 
            self._update_timer_callback_lock -= 1
193
 
        if old == 0 and self._update_timer_callback_lock:
 
171
        if flag and self._update_timer_callback_tag is None:
 
172
            # Will update the shown timer value every second
194
173
            self._update_timer_callback_tag = (gobject.timeout_add
195
174
                                               (1000,
196
175
                                                self.update_timer))
197
 
        elif old and self._update_timer_callback_lock == 0:
 
176
        elif not (flag or self._update_timer_callback_tag is None):
198
177
            gobject.source_remove(self._update_timer_callback_tag)
199
178
            self._update_timer_callback_tag = None
200
179
    
201
180
    def checker_completed(self, exitstatus, condition, command):
202
181
        if exitstatus == 0:
203
 
            if self.last_checker_failed:
204
 
                self.last_checker_failed = False
205
 
                self.using_timer(False)
206
 
            #self.logger(u'Checker for client %s (command "%s")'
207
 
            #            u' was successful'
208
 
            #            % (self.properties[u"Name"], command))
 
182
            self.logger('Checker for client {0} (command "{1}")'
 
183
                        ' succeeded'.format(self.properties["Name"],
 
184
                                            command), level=0)
209
185
            self.update()
210
186
            return
211
187
        # Checker failed
212
 
        if not self.last_checker_failed:
213
 
            self.last_checker_failed = True
214
 
            self.using_timer(True)
215
188
        if os.WIFEXITED(condition):
216
 
            self.logger(u'Checker for client %s (command "%s")'
217
 
                        u' failed with exit code %s'
218
 
                        % (self.properties[u"Name"], command,
219
 
                           os.WEXITSTATUS(condition)))
 
189
            self.logger('Checker for client {0} (command "{1}")'
 
190
                        ' failed with exit code {2}'
 
191
                        .format(self.properties["Name"], command,
 
192
                                os.WEXITSTATUS(condition)))
220
193
        elif os.WIFSIGNALED(condition):
221
 
            self.logger(u'Checker for client %s (command "%s")'
222
 
                        u' was killed by signal %s'
223
 
                        % (self.properties[u"Name"], command,
224
 
                           os.WTERMSIG(condition)))
 
194
            self.logger('Checker for client {0} (command "{1}") was'
 
195
                        ' killed by signal {2}'
 
196
                        .format(self.properties["Name"], command,
 
197
                                os.WTERMSIG(condition)))
225
198
        elif os.WCOREDUMP(condition):
226
 
            self.logger(u'Checker for client %s (command "%s")'
227
 
                        u' dumped core'
228
 
                        % (self.properties[u"Name"], command))
 
199
            self.logger('Checker for client {0} (command "{1}")'
 
200
                        ' dumped core'
 
201
                        .format(self.properties["Name"], command))
229
202
        else:
230
 
            self.logger(u'Checker for client %s completed'
231
 
                        u' mysteriously')
 
203
            self.logger('Checker for client {0} completed'
 
204
                        ' mysteriously'
 
205
                        .format(self.properties["Name"]))
232
206
        self.update()
233
207
    
234
208
    def checker_started(self, command):
235
 
        #self.logger(u'Client %s started checker "%s"'
236
 
        #            % (self.properties[u"Name"], unicode(command)))
237
 
        pass
 
209
        """Server signals that a checker started."""
 
210
        self.logger('Client {0} started checker "{1}"'
 
211
                    .format(self.properties["Name"],
 
212
                            command), level=0)
238
213
    
239
214
    def got_secret(self):
240
 
        self.last_checker_failed = False
241
 
        self.logger(u'Client %s received its secret'
242
 
                    % self.properties[u"Name"])
 
215
        self.logger('Client {0} received its secret'
 
216
                    .format(self.properties["Name"]))
243
217
    
244
218
    def need_approval(self, timeout, default):
245
219
        if not default:
246
 
            message = u'Client %s needs approval within %s seconds'
 
220
            message = 'Client {0} needs approval within {1} seconds'
247
221
        else:
248
 
            message = u'Client %s will get its secret in %s seconds'
249
 
        self.logger(message
250
 
                    % (self.properties[u"Name"], timeout/1000))
251
 
        self.using_timer(True)
 
222
            message = 'Client {0} will get its secret in {1} seconds'
 
223
        self.logger(message.format(self.properties["Name"],
 
224
                                   timeout/1000))
252
225
    
253
226
    def rejected(self, reason):
254
 
        self.logger(u'Client %s was rejected; reason: %s'
255
 
                    % (self.properties[u"Name"], reason))
 
227
        self.logger('Client {0} was rejected; reason: {1}'
 
228
                    .format(self.properties["Name"], reason))
256
229
    
257
230
    def selectable(self):
258
231
        """Make this a "selectable" widget.
259
232
        This overrides the method from urwid.FlowWidget."""
260
233
        return True
261
234
    
262
 
    def rows(self, (maxcol,), focus=False):
 
235
    def rows(self, maxcolrow, focus=False):
263
236
        """How many rows this widget will occupy might depend on
264
237
        whether we have focus or not.
265
238
        This overrides the method from urwid.FlowWidget"""
266
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
239
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
267
240
    
268
241
    def current_widget(self, focus=False):
269
242
        if focus or self.opened:
273
246
    def update(self):
274
247
        "Called when what is visible on the screen should be updated."
275
248
        # How to add standout mode to a style
276
 
        with_standout = { u"normal": u"standout",
277
 
                          u"bold": u"bold-standout",
278
 
                          u"underline-blink":
279
 
                              u"underline-blink-standout",
280
 
                          u"bold-underline-blink":
281
 
                              u"bold-underline-blink-standout",
 
249
        with_standout = { "normal": "standout",
 
250
                          "bold": "bold-standout",
 
251
                          "underline-blink":
 
252
                              "underline-blink-standout",
 
253
                          "bold-underline-blink":
 
254
                              "bold-underline-blink-standout",
282
255
                          }
283
 
 
 
256
        
284
257
        # Rebuild focus and non-focus widgets using current properties
285
 
 
 
258
        
286
259
        # Base part of a client. Name!
287
 
        base = (u'%(name)s: '
288
 
                      % {u"name": self.properties[u"Name"]})
289
 
        if not self.properties[u"Enabled"]:
290
 
            message = u"DISABLED"
291
 
        elif self.properties[u"ApprovalPending"]:
 
260
        base = '{name}: '.format(name=self.properties["Name"])
 
261
        if not self.properties["Enabled"]:
 
262
            message = "DISABLED"
 
263
            self.using_timer(False)
 
264
        elif self.properties["ApprovalPending"]:
292
265
            timeout = datetime.timedelta(milliseconds
293
266
                                         = self.properties
294
 
                                         [u"ApprovalDelay"])
 
267
                                         ["ApprovalDelay"])
295
268
            last_approval_request = isoformat_to_datetime(
296
 
                self.properties[u"LastApprovalRequest"])
 
269
                self.properties["LastApprovalRequest"])
297
270
            if last_approval_request is not None:
298
 
                timer = timeout - (datetime.datetime.utcnow()
299
 
                                   - last_approval_request)
 
271
                timer = max(timeout - (datetime.datetime.utcnow()
 
272
                                       - last_approval_request),
 
273
                            datetime.timedelta())
300
274
            else:
301
275
                timer = datetime.timedelta()
302
 
            if self.properties[u"ApprovedByDefault"]:
303
 
                message = u"Approval in %s. (d)eny?"
304
 
            else:
305
 
                message = u"Denial in %s. (a)pprove?"
306
 
            message = message % unicode(timer).rsplit(".", 1)[0]
307
 
        elif self.last_checker_failed:
308
 
            timeout = datetime.timedelta(milliseconds
309
 
                                         = self.properties
310
 
                                         [u"Timeout"])
311
 
            last_ok = isoformat_to_datetime(
312
 
                max((self.properties[u"LastCheckedOK"]
313
 
                     or self.properties[u"Created"]),
314
 
                    self.properties[u"LastEnabled"]))
315
 
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
316
 
            message = (u'A checker has failed! Time until client'
317
 
                       u' gets disabled: %s'
318
 
                           % unicode(timer).rsplit(".", 1)[0])
 
276
            if self.properties["ApprovedByDefault"]:
 
277
                message = "Approval in {0}. (d)eny?"
 
278
            else:
 
279
                message = "Denial in {0}. (a)pprove?"
 
280
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
            self.using_timer(True)
 
282
        elif self.properties["LastCheckerStatus"] != 0:
 
283
            # When checker has failed, show timer until client expires
 
284
            expires = self.properties["Expires"]
 
285
            if expires == "":
 
286
                timer = datetime.timedelta(0)
 
287
            else:
 
288
                expires = (datetime.datetime.strptime
 
289
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
290
                timer = max(expires - datetime.datetime.utcnow(),
 
291
                            datetime.timedelta())
 
292
            message = ('A checker has failed! Time until client'
 
293
                       ' gets disabled: {0}'
 
294
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
            self.using_timer(True)
319
296
        else:
320
 
            message = u"enabled"
321
 
        self._text = "%s%s" % (base, message)
322
 
            
 
297
            message = "enabled"
 
298
            self.using_timer(False)
 
299
        self._text = "{0}{1}".format(base, message)
 
300
        
323
301
        if not urwid.supports_unicode():
324
302
            self._text = self._text.encode("ascii", "replace")
325
 
        textlist = [(u"normal", self._text)]
 
303
        textlist = [("normal", self._text)]
326
304
        self._text_widget.set_text(textlist)
327
305
        self._focus_text_widget.set_text([(with_standout[text[0]],
328
306
                                           text[1])
337
315
            self.update_hook()
338
316
    
339
317
    def update_timer(self):
340
 
        "called by gobject"
 
318
        """called by gobject. Will indefinitely loop until
 
319
        gobject.source_remove() on tag is called"""
341
320
        self.update()
342
321
        return True             # Keep calling this
343
322
    
344
 
    def delete(self):
 
323
    def delete(self, **kwargs):
345
324
        if self._update_timer_callback_tag is not None:
346
325
            gobject.source_remove(self._update_timer_callback_tag)
347
326
            self._update_timer_callback_tag = None
 
327
        for match in self.match_objects:
 
328
            match.remove()
 
329
        self.match_objects = ()
348
330
        if self.delete_hook is not None:
349
331
            self.delete_hook(self)
 
332
        return super(MandosClientWidget, self).delete(**kwargs)
350
333
    
351
 
    def render(self, (maxcol,), focus=False):
 
334
    def render(self, maxcolrow, focus=False):
352
335
        """Render differently if we have focus.
353
336
        This overrides the method from urwid.FlowWidget"""
354
 
        return self.current_widget(focus).render((maxcol,),
 
337
        return self.current_widget(focus).render(maxcolrow,
355
338
                                                 focus=focus)
356
339
    
357
 
    def keypress(self, (maxcol,), key):
 
340
    def keypress(self, maxcolrow, key):
358
341
        """Handle keys.
359
342
        This overrides the method from urwid.FlowWidget"""
360
 
        if key == u"+":
361
 
            self.proxy.Enable(dbus_interface = client_interface)
362
 
        elif key == u"-":
363
 
            self.proxy.Disable(dbus_interface = client_interface)
364
 
        elif key == u"a":
 
343
        if key == "+":
 
344
            self.proxy.Enable(dbus_interface = client_interface,
 
345
                              ignore_reply=True)
 
346
        elif key == "-":
 
347
            self.proxy.Disable(dbus_interface = client_interface,
 
348
                               ignore_reply=True)
 
349
        elif key == "a":
365
350
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
366
 
                               dbus_interface = client_interface)
367
 
        elif key == u"d":
 
351
                               dbus_interface = client_interface,
 
352
                               ignore_reply=True)
 
353
        elif key == "d":
368
354
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
369
 
                                  dbus_interface = client_interface)
370
 
        elif key == u"R" or key == u"_" or key == u"ctrl k":
 
355
                                  dbus_interface = client_interface,
 
356
                               ignore_reply=True)
 
357
        elif key == "R" or key == "_" or key == "ctrl k":
371
358
            self.server_proxy_object.RemoveClient(self.proxy
372
 
                                                  .object_path)
373
 
        elif key == u"s":
374
 
            self.proxy.StartChecker(dbus_interface = client_interface)
375
 
        elif key == u"S":
376
 
            self.proxy.StopChecker(dbus_interface = client_interface)
377
 
        elif key == u"C":
378
 
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
359
                                                  .object_path,
 
360
                                                  ignore_reply=True)
 
361
        elif key == "s":
 
362
            self.proxy.StartChecker(dbus_interface = client_interface,
 
363
                                    ignore_reply=True)
 
364
        elif key == "S":
 
365
            self.proxy.StopChecker(dbus_interface = client_interface,
 
366
                                   ignore_reply=True)
 
367
        elif key == "C":
 
368
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
369
                                 ignore_reply=True)
379
370
        # xxx
380
 
#         elif key == u"p" or key == "=":
 
371
#         elif key == "p" or key == "=":
381
372
#             self.proxy.pause()
382
 
#         elif key == u"u" or key == ":":
 
373
#         elif key == "u" or key == ":":
383
374
#             self.proxy.unpause()
384
 
#         elif key == u"RET":
 
375
#         elif key == "RET":
385
376
#             self.open()
386
377
        else:
387
378
            return key
388
379
    
389
 
    def property_changed(self, property=None, value=None,
390
 
                         *args, **kwargs):
 
380
    def property_changed(self, property=None, **kwargs):
391
381
        """Call self.update() if old value is not new value.
392
382
        This overrides the method from MandosClientPropertyCache"""
393
 
        property_name = unicode(property)
 
383
        property_name = str(property)
394
384
        old_value = self.properties.get(property_name)
395
385
        super(MandosClientWidget, self).property_changed(
396
 
            property=property, value=value, *args, **kwargs)
 
386
            property=property, **kwargs)
397
387
        if self.properties.get(property_name) != old_value:
398
388
            self.update()
399
389
 
403
393
    "down" key presses, thus not allowing any containing widgets to
404
394
    use them as an excuse to shift focus away from this widget.
405
395
    """
406
 
    def keypress(self, (maxcol, maxrow), key):
407
 
        ret = super(ConstrainedListBox, self).keypress((maxcol,
408
 
                                                        maxrow), key)
409
 
        if ret in (u"up", u"down"):
 
396
    def keypress(self, *args, **kwargs):
 
397
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
398
        if ret in ("up", "down"):
410
399
            return
411
400
        return ret
412
401
 
415
404
    """This is the entire user interface - the whole screen
416
405
    with boxes, lists of client widgets, etc.
417
406
    """
418
 
    def __init__(self, max_log_length=1000):
 
407
    def __init__(self, max_log_length=1000, log_level=1):
419
408
        DBusGMainLoop(set_as_default=True)
420
409
        
421
410
        self.screen = urwid.curses_display.Screen()
422
411
        
423
412
        self.screen.register_palette((
424
 
                (u"normal",
425
 
                 u"default", u"default", None),
426
 
                (u"bold",
427
 
                 u"default", u"default", u"bold"),
428
 
                (u"underline-blink",
429
 
                 u"default", u"default", u"underline"),
430
 
                (u"standout",
431
 
                 u"default", u"default", u"standout"),
432
 
                (u"bold-underline-blink",
433
 
                 u"default", u"default", (u"bold", u"underline")),
434
 
                (u"bold-standout",
435
 
                 u"default", u"default", (u"bold", u"standout")),
436
 
                (u"underline-blink-standout",
437
 
                 u"default", u"default", (u"underline", u"standout")),
438
 
                (u"bold-underline-blink-standout",
439
 
                 u"default", u"default", (u"bold", u"underline",
440
 
                                          u"standout")),
 
413
                ("normal",
 
414
                 "default", "default", None),
 
415
                ("bold",
 
416
                 "bold", "default", "bold"),
 
417
                ("underline-blink",
 
418
                 "underline,blink", "default", "underline,blink"),
 
419
                ("standout",
 
420
                 "standout", "default", "standout"),
 
421
                ("bold-underline-blink",
 
422
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
423
                ("bold-standout",
 
424
                 "bold,standout", "default", "bold,standout"),
 
425
                ("underline-blink-standout",
 
426
                 "underline,blink,standout", "default",
 
427
                 "underline,blink,standout"),
 
428
                ("bold-underline-blink-standout",
 
429
                 "bold,underline,blink,standout", "default",
 
430
                 "bold,underline,blink,standout"),
441
431
                ))
442
432
        
443
433
        if urwid.supports_unicode():
444
 
            self.divider = u"─" # \u2500
445
 
            #self.divider = u"━" # \u2501
 
434
            self.divider = "─" # \u2500
 
435
            #self.divider = "━" # \u2501
446
436
        else:
447
 
            #self.divider = u"-" # \u002d
448
 
            self.divider = u"_" # \u005f
 
437
            #self.divider = "-" # \u002d
 
438
            self.divider = "_" # \u005f
449
439
        
450
440
        self.screen.start()
451
441
        
458
448
        self.log = []
459
449
        self.max_log_length = max_log_length
460
450
        
 
451
        self.log_level = log_level
 
452
        
461
453
        # We keep a reference to the log widget so we can remove it
462
454
        # from the ListWalker without it getting destroyed
463
455
        self.logbox = ConstrainedListBox(self.log)
465
457
        # This keeps track of whether self.uilist currently has
466
458
        # self.logbox in it or not
467
459
        self.log_visible = True
468
 
        self.log_wrap = u"any"
 
460
        self.log_wrap = "any"
469
461
        
470
462
        self.rebuild()
471
 
        self.log_message_raw((u"bold",
472
 
                              u"Mandos Monitor version " + version))
473
 
        self.log_message_raw((u"bold",
474
 
                              u"q: Quit  ?: Help"))
 
463
        self.log_message_raw(("bold",
 
464
                              "Mandos Monitor version " + version))
 
465
        self.log_message_raw(("bold",
 
466
                              "q: Quit  ?: Help"))
475
467
        
476
468
        self.busname = domain + '.Mandos'
477
469
        self.main_loop = gobject.MainLoop()
478
 
        self.bus = dbus.SystemBus()
479
 
        mandos_dbus_objc = self.bus.get_object(
480
 
            self.busname, u"/", follow_name_owner_changes=True)
481
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
482
 
                                          dbus_interface
483
 
                                          = server_interface)
484
 
        try:
485
 
            mandos_clients = (self.mandos_serv
486
 
                              .GetAllClientsWithProperties())
487
 
        except dbus.exceptions.DBusException:
488
 
            mandos_clients = dbus.Dictionary()
489
 
        
490
 
        (self.mandos_serv
491
 
         .connect_to_signal(u"ClientRemoved",
492
 
                            self.find_and_remove_client,
493
 
                            dbus_interface=server_interface,
494
 
                            byte_arrays=True))
495
 
        (self.mandos_serv
496
 
         .connect_to_signal(u"ClientAdded",
497
 
                            self.add_new_client,
498
 
                            dbus_interface=server_interface,
499
 
                            byte_arrays=True))
500
 
        (self.mandos_serv
501
 
         .connect_to_signal(u"ClientNotFound",
502
 
                            self.client_not_found,
503
 
                            dbus_interface=server_interface,
504
 
                            byte_arrays=True))
505
 
        for path, client in mandos_clients.iteritems():
506
 
            client_proxy_object = self.bus.get_object(self.busname,
507
 
                                                      path)
508
 
            self.add_client(MandosClientWidget(server_proxy_object
509
 
                                               =self.mandos_serv,
510
 
                                               proxy_object
511
 
                                               =client_proxy_object,
512
 
                                               properties=client,
513
 
                                               update_hook
514
 
                                               =self.refresh,
515
 
                                               delete_hook
516
 
                                               =self.remove_client,
517
 
                                               logger
518
 
                                               =self.log_message),
519
 
                            path=path)
520
470
    
521
471
    def client_not_found(self, fingerprint, address):
522
 
        self.log_message((u"Client with address %s and fingerprint %s"
523
 
                          u" could not be found" % (address,
524
 
                                                    fingerprint)))
 
472
        self.log_message("Client with address {0} and fingerprint"
 
473
                         " {1} could not be found"
 
474
                         .format(address, fingerprint))
525
475
    
526
476
    def rebuild(self):
527
477
        """This rebuilds the User Interface.
537
487
                                                     self.divider)))
538
488
        if self.log_visible:
539
489
            self.uilist.append(self.logbox)
540
 
            pass
541
490
        self.topwidget = urwid.Pile(self.uilist)
542
491
    
543
 
    def log_message(self, message):
 
492
    def log_message(self, message, level=1):
 
493
        """Log message formatted with timestamp"""
 
494
        if level < self.log_level:
 
495
            return
544
496
        timestamp = datetime.datetime.now().isoformat()
545
 
        self.log_message_raw(timestamp + u": " + message)
 
497
        self.log_message_raw("{0}: {1}".format(timestamp, message),
 
498
                             level=level)
546
499
    
547
 
    def log_message_raw(self, markup):
 
500
    def log_message_raw(self, markup, level=1):
548
501
        """Add a log message to the log buffer."""
 
502
        if level < self.log_level:
 
503
            return
549
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
550
505
        if (self.max_log_length
551
506
            and len(self.log) > self.max_log_length):
552
507
            del self.log[0:len(self.log)-self.max_log_length-1]
553
508
        self.logbox.set_focus(len(self.logbox.body.contents),
554
 
                              coming_from=u"above")
 
509
                              coming_from="above")
555
510
        self.refresh()
556
511
    
557
512
    def toggle_log_display(self):
558
513
        """Toggle visibility of the log buffer."""
559
514
        self.log_visible = not self.log_visible
560
515
        self.rebuild()
561
 
        #self.log_message(u"Log visibility changed to: "
562
 
        #                 + unicode(self.log_visible))
 
516
        self.log_message("Log visibility changed to: {0}"
 
517
                         .format(self.log_visible), level=0)
563
518
    
564
519
    def change_log_display(self):
565
520
        """Change type of log display.
566
521
        Currently, this toggles wrapping of text lines."""
567
 
        if self.log_wrap == u"clip":
568
 
            self.log_wrap = u"any"
 
522
        if self.log_wrap == "clip":
 
523
            self.log_wrap = "any"
569
524
        else:
570
 
            self.log_wrap = u"clip"
 
525
            self.log_wrap = "clip"
571
526
        for textwidget in self.log:
572
527
            textwidget.set_wrap_mode(self.log_wrap)
573
 
        #self.log_message(u"Wrap mode: " + self.log_wrap)
 
528
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
 
529
                         level=0)
574
530
    
575
531
    def find_and_remove_client(self, path, name):
576
 
        """Find an client from its object path and remove it.
 
532
        """Find a client by its object path and remove it.
577
533
        
578
534
        This is connected to the ClientRemoved signal from the
579
535
        Mandos server object."""
581
537
            client = self.clients_dict[path]
582
538
        except KeyError:
583
539
            # not found?
 
540
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
541
                             .format(name, path))
584
542
            return
585
 
        self.remove_client(client, path)
 
543
        client.delete()
586
544
    
587
545
    def add_new_client(self, path):
588
546
        client_proxy_object = self.bus.get_object(self.busname, path)
603
561
        if path is None:
604
562
            path = client.proxy.object_path
605
563
        self.clients_dict[path] = client
606
 
        self.clients.sort(None, lambda c: c.properties[u"Name"])
 
564
        self.clients.sort(key=lambda c: c.properties["Name"])
607
565
        self.refresh()
608
566
    
609
567
    def remove_client(self, client, path=None):
611
569
        if path is None:
612
570
            path = client.proxy.object_path
613
571
        del self.clients_dict[path]
614
 
        if not self.clients_dict:
615
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
616
 
            # is completely emptied, we need to recreate it.
617
 
            self.clients = urwid.SimpleListWalker([])
618
 
            self.rebuild()
619
572
        self.refresh()
620
573
    
621
574
    def refresh(self):
625
578
    
626
579
    def run(self):
627
580
        """Start the main loop and exit when it's done."""
 
581
        self.bus = dbus.SystemBus()
 
582
        mandos_dbus_objc = self.bus.get_object(
 
583
            self.busname, "/", follow_name_owner_changes=True)
 
584
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
585
                                          dbus_interface
 
586
                                          = server_interface)
 
587
        try:
 
588
            mandos_clients = (self.mandos_serv
 
589
                              .GetAllClientsWithProperties())
 
590
            if not mandos_clients:
 
591
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
592
        except dbus.exceptions.DBusException:
 
593
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
594
            mandos_clients = dbus.Dictionary()
 
595
        
 
596
        (self.mandos_serv
 
597
         .connect_to_signal("ClientRemoved",
 
598
                            self.find_and_remove_client,
 
599
                            dbus_interface=server_interface,
 
600
                            byte_arrays=True))
 
601
        (self.mandos_serv
 
602
         .connect_to_signal("ClientAdded",
 
603
                            self.add_new_client,
 
604
                            dbus_interface=server_interface,
 
605
                            byte_arrays=True))
 
606
        (self.mandos_serv
 
607
         .connect_to_signal("ClientNotFound",
 
608
                            self.client_not_found,
 
609
                            dbus_interface=server_interface,
 
610
                            byte_arrays=True))
 
611
        for path, client in mandos_clients.items():
 
612
            client_proxy_object = self.bus.get_object(self.busname,
 
613
                                                      path)
 
614
            self.add_client(MandosClientWidget(server_proxy_object
 
615
                                               =self.mandos_serv,
 
616
                                               proxy_object
 
617
                                               =client_proxy_object,
 
618
                                               properties=client,
 
619
                                               update_hook
 
620
                                               =self.refresh,
 
621
                                               delete_hook
 
622
                                               =self.remove_client,
 
623
                                               logger
 
624
                                               =self.log_message),
 
625
                            path=path)
 
626
        
628
627
        self.refresh()
629
628
        self._input_callback_tag = (gobject.io_add_watch
630
629
                                    (sys.stdin.fileno(),
640
639
    
641
640
    def process_input(self, source, condition):
642
641
        keys = self.screen.get_input()
643
 
        translations = { u"ctrl n": u"down",      # Emacs
644
 
                         u"ctrl p": u"up",        # Emacs
645
 
                         u"ctrl v": u"page down", # Emacs
646
 
                         u"meta v": u"page up",   # Emacs
647
 
                         u" ": u"page down",      # less
648
 
                         u"f": u"page down",      # less
649
 
                         u"b": u"page up",        # less
650
 
                         u"j": u"down",           # vi
651
 
                         u"k": u"up",             # vi
 
642
        translations = { "ctrl n": "down",      # Emacs
 
643
                         "ctrl p": "up",        # Emacs
 
644
                         "ctrl v": "page down", # Emacs
 
645
                         "meta v": "page up",   # Emacs
 
646
                         " ": "page down",      # less
 
647
                         "f": "page down",      # less
 
648
                         "b": "page up",        # less
 
649
                         "j": "down",           # vi
 
650
                         "k": "up",             # vi
652
651
                         }
653
652
        for key in keys:
654
653
            try:
656
655
            except KeyError:    # :-)
657
656
                pass
658
657
            
659
 
            if key == u"q" or key == u"Q":
 
658
            if key == "q" or key == "Q":
660
659
                self.stop()
661
660
                break
662
 
            elif key == u"window resize":
 
661
            elif key == "window resize":
663
662
                self.size = self.screen.get_cols_rows()
664
663
                self.refresh()
665
 
            elif key == u"\f":  # Ctrl-L
 
664
            elif key == "\f":  # Ctrl-L
666
665
                self.refresh()
667
 
            elif key == u"l" or key == u"D":
 
666
            elif key == "l" or key == "D":
668
667
                self.toggle_log_display()
669
668
                self.refresh()
670
 
            elif key == u"w" or key == u"i":
 
669
            elif key == "w" or key == "i":
671
670
                self.change_log_display()
672
671
                self.refresh()
673
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
672
            elif key == "?" or key == "f1" or key == "esc":
674
673
                if not self.log_visible:
675
674
                    self.log_visible = True
676
675
                    self.rebuild()
677
 
                self.log_message_raw((u"bold",
678
 
                                      u"  ".
679
 
                                      join((u"q: Quit",
680
 
                                            u"?: Help",
681
 
                                            u"l: Log window toggle",
682
 
                                            u"TAB: Switch window",
683
 
                                            u"w: Wrap (log)"))))
684
 
                self.log_message_raw((u"bold",
685
 
                                      u"  "
686
 
                                      .join((u"Clients:",
687
 
                                             u"+: Enable",
688
 
                                             u"-: Disable",
689
 
                                             u"R: Remove",
690
 
                                             u"s: Start new checker",
691
 
                                             u"S: Stop checker",
692
 
                                             u"C: Checker OK",
693
 
                                             u"a: Approve",
694
 
                                             u"d: Deny"))))
 
676
                self.log_message_raw(("bold",
 
677
                                      "  ".
 
678
                                      join(("q: Quit",
 
679
                                            "?: Help",
 
680
                                            "l: Log window toggle",
 
681
                                            "TAB: Switch window",
 
682
                                            "w: Wrap (log lines)",
 
683
                                            "v: Toggle verbose log",
 
684
                                            ))))
 
685
                self.log_message_raw(("bold",
 
686
                                      "  "
 
687
                                      .join(("Clients:",
 
688
                                             "+: Enable",
 
689
                                             "-: Disable",
 
690
                                             "R: Remove",
 
691
                                             "s: Start new checker",
 
692
                                             "S: Stop checker",
 
693
                                             "C: Checker OK",
 
694
                                             "a: Approve",
 
695
                                             "d: Deny"))))
695
696
                self.refresh()
696
 
            elif key == u"tab":
 
697
            elif key == "tab":
697
698
                if self.topwidget.get_focus() is self.logbox:
698
699
                    self.topwidget.set_focus(0)
699
700
                else:
700
701
                    self.topwidget.set_focus(self.logbox)
701
702
                self.refresh()
702
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
703
 
            #      or key == u">"):
 
703
            elif key == "v":
 
704
                if self.log_level == 0:
 
705
                    self.log_level = 1
 
706
                    self.log_message("Verbose mode: Off")
 
707
                else:
 
708
                    self.log_level = 0
 
709
                    self.log_message("Verbose mode: On")
 
710
            #elif (key == "end" or key == "meta >" or key == "G"
 
711
            #      or key == ">"):
704
712
            #    pass            # xxx end-of-buffer
705
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
706
 
            #      or key == u"<"):
 
713
            #elif (key == "home" or key == "meta <" or key == "g"
 
714
            #      or key == "<"):
707
715
            #    pass            # xxx beginning-of-buffer
708
 
            #elif key == u"ctrl e" or key == u"$":
 
716
            #elif key == "ctrl e" or key == "$":
709
717
            #    pass            # xxx move-end-of-line
710
 
            #elif key == u"ctrl a" or key == u"^":
 
718
            #elif key == "ctrl a" or key == "^":
711
719
            #    pass            # xxx move-beginning-of-line
712
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
720
            #elif key == "ctrl b" or key == "meta (" or key == "h":
713
721
            #    pass            # xxx left
714
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
722
            #elif key == "ctrl f" or key == "meta )" or key == "l":
715
723
            #    pass            # xxx right
716
 
            #elif key == u"a":
 
724
            #elif key == "a":
717
725
            #    pass            # scroll up log
718
 
            #elif key == u"z":
 
726
            #elif key == "z":
719
727
            #    pass            # scroll down log
720
728
            elif self.topwidget.selectable():
721
729
                self.topwidget.keypress(self.size, key)
727
735
    ui.run()
728
736
except KeyboardInterrupt:
729
737
    ui.screen.stop()
730
 
except Exception, e:
731
 
    ui.log_message(unicode(e))
 
738
except Exception as e:
 
739
    ui.log_message(str(e))
732
740
    ui.screen.stop()
733
741
    raise