/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: 2019-03-18 22:29:25 UTC
  • Revision ID: teddy@recompile.se-20190318222925-jvhek84dgcfgj6g3
mandos-ctl: Refactor tests

* mandos-ctl: Where the clients names "foo" and "barbar" do not refer
              to the actual mock clients in the TestCommand class,
              change all occurrences of these names to "client1" and
              "client2" (or just "client" when only one is used) .
              Also change all test doubles to use correct terminology;
              some things called mocks are actually stubs or spies,
              and rename all true mocks to have "mock" in their names.
              Also eliminate duplicate values in tests; derive values
              from previously defined values whenever possible.

Show diffs side-by-side

added added

removed removed

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