/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: 2024-11-22 20:28:54 UTC
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(Thanks to an anonymous contributor for reporting this.)

Show diffs side-by-side

added added

removed removed

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