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