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