/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 13:50:57 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

Show diffs side-by-side

added added

removed removed

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