/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-11-03 18:44:41 UTC
  • Revision ID: teddy@recompile.se-20191103184441-1vhjuf06hjqgfohh
mandos-monitor: Use Python's standard loggging module

* mandos-monitor: Use Python's standard loggging module, also for
                  warnings.  Suppress BytesWarning from urwid when
                  exiting.
  (log): New global logger object.  This replaces UserInterface
        log_message().
  (MandosClientWidget.__init__): Remove "logger" argument.
  (MandosClientWidget.using_timer): Wrap self.update_timer using new
                                    glib_safely() function.
  (glib_safely): New function to log any exceptions instead of letting
                 exceptions propagate up to GLib.
  (UserInterface.__init__): Remove "log_level" argument.  Set new
                            "loghandler" attribute, instance of new
                            "UILogHandler".
  (UserInterface.log_message): Removed.
  (UserInterface.log_message_raw): Renamed to "add_log_line"; all
                                   callers changed.  Also fix
                                   off-by-one error in max_log_length
                                   logic.
  (UserInterface.run): Add self.loghandler to logger "log". Wrap
                       self.process_input using new glib_safely()
                       function.
  (UserInterface.stop): Remove self.loghandler from logger "log".
  (UserInterface.process_input): Make verbosity toggle affect log
                                 level of logger "log".
  (UILogHandler): New.

Show diffs side-by-side

added added

removed removed

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