/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

* mandos-monitor: Speedup: Use properties from D-Bus
                  GetAllClientsWithProperties() call.  Also use
                  super() properly - only use keyword arguments and
                  strip them off as "kwargs" is passed on.
  (MandosClientPropertyCache.__init__): Take new "properties"
                                        argument; use it to skip
                                        calling D-Bus GetAll() method.
                                        Call super().  Bind self._
  (MandosClientPropertyCache._property_changed): New helper function.
  (MandosClientPropertyCache.property_changed): Changed to take
                                                keyword arguments.
  (MandosClientPropertyCache.delete): Bug fix: Don't call
                                      super().__init__().
  (MandosClientWidget.__init__): Don't take *args.  Strip used keyword
                                 arguments before calling super().
  (MandosClientWidget.property_changed): Removed dead code.
  (MandosClientWidget.delete): Don't take *args.
  (MandosClientWidget.property_changed): Don't take "value" argument,
                                         since it is not used.
  (ConstrainedListBox.keypress): Take *args, **kwargs and pass them on
                                 to super().

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