/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-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
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
 
    
176
 
    def checker_completed(self, exitstatus, signal, command):
 
189
 
 
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
 
        if exitstatus >= 0:
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
187
 
                        .format(self.properties["Name"], command,
188
 
                                exitstatus))
189
 
        elif signal != 0:
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
192
 
                        .format(self.properties["Name"], command,
193
 
                                signal))
194
 
        else:
195
 
            self.logger('Checker for client {} completed'
196
 
                        ' mysteriously'
197
 
                        .format(self.properties["Name"]))
 
197
        if os.WIFEXITED(condition):
 
198
            log.info('Checker for client %s (command "%s") failed'
 
199
                     " with exit code %d", self.properties["Name"],
 
200
                     command, os.WEXITSTATUS(condition))
 
201
        elif os.WIFSIGNALED(condition):
 
202
            log.info('Checker for client %s (command "%s") was'
 
203
                     " killed by signal %d", self.properties["Name"],
 
204
                     command, os.WTERMSIG(condition))
198
205
        self.update()
199
 
    
 
206
 
200
207
    def checker_started(self, command):
201
208
        """Server signals that a checker started."""
202
 
        self.logger('Client {} started checker "{}"'
203
 
                    .format(self.properties["Name"],
204
 
                            command), level=0)
205
 
    
 
209
        log.debug('Client %s started checker "%s"',
 
210
                  self.properties["Name"], command)
 
211
 
206
212
    def got_secret(self):
207
 
        self.logger('Client {} received its secret'
208
 
                    .format(self.properties["Name"]))
209
 
    
 
213
        log.info("Client %s received its secret",
 
214
                 self.properties["Name"])
 
215
 
210
216
    def need_approval(self, timeout, default):
211
217
        if not default:
212
 
            message = 'Client {} needs approval within {} seconds'
 
218
            message = "Client %s needs approval within %f seconds"
213
219
        else:
214
 
            message = 'Client {} will get its secret in {} seconds'
215
 
        self.logger(message.format(self.properties["Name"],
216
 
                                   timeout/1000))
217
 
    
 
220
            message = "Client %s will get its secret in %f seconds"
 
221
        log.info(message, self.properties["Name"], timeout/1000)
 
222
 
218
223
    def rejected(self, reason):
219
 
        self.logger('Client {} was rejected; reason: {}'
220
 
                    .format(self.properties["Name"], reason))
221
 
    
 
224
        log.info("Client %s was rejected; reason: %s",
 
225
                 self.properties["Name"], reason)
 
226
 
222
227
    def selectable(self):
223
228
        """Make this a "selectable" widget.
224
229
        This overrides the method from urwid.FlowWidget."""
225
230
        return True
226
 
    
 
231
 
227
232
    def rows(self, maxcolrow, focus=False):
228
233
        """How many rows this widget will occupy might depend on
229
234
        whether we have focus or not.
230
235
        This overrides the method from urwid.FlowWidget"""
231
236
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
232
 
    
 
237
 
233
238
    def current_widget(self, focus=False):
234
239
        if focus or self.opened:
235
240
            return self._focus_widget
236
241
        return self._widget
237
 
    
 
242
 
238
243
    def update(self):
239
244
        "Called when what is visible on the screen should be updated."
240
245
        # How to add standout mode to a style
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
 
        
 
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
 
249
254
        # Rebuild focus and non-focus widgets using current properties
250
 
        
 
255
 
251
256
        # Base part of a client. Name!
252
 
        base = '{name}: '.format(name=self.properties["Name"])
 
257
        base = "{name}: ".format(name=self.properties["Name"])
253
258
        if not self.properties["Enabled"]:
254
259
            message = "DISABLED"
255
260
            self.using_timer(False)
256
261
        elif self.properties["ApprovalPending"]:
257
 
            timeout = datetime.timedelta(milliseconds
258
 
                                         = self.properties
259
 
                                         ["ApprovalDelay"])
 
262
            timeout = datetime.timedelta(
 
263
                milliseconds=self.properties["ApprovalDelay"])
260
264
            last_approval_request = isoformat_to_datetime(
261
265
                self.properties["LastApprovalRequest"])
262
266
            if last_approval_request is not None:
278
282
                timer = datetime.timedelta(0)
279
283
            else:
280
284
                expires = (datetime.datetime.strptime
281
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
285
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
282
286
                timer = max(expires - datetime.datetime.utcnow(),
283
287
                            datetime.timedelta())
284
 
            message = ('A checker has failed! Time until client'
285
 
                       ' gets disabled: {}'
 
288
            message = ("A checker has failed! Time until client"
 
289
                       " gets disabled: {}"
286
290
                       .format(str(timer).rsplit(".", 1)[0]))
287
291
            self.using_timer(True)
288
292
        else:
289
293
            message = "enabled"
290
294
            self.using_timer(False)
291
295
        self._text = "{}{}".format(base, message)
292
 
        
 
296
 
293
297
        if not urwid.supports_unicode():
294
298
            self._text = self._text.encode("ascii", "replace")
295
299
        textlist = [("normal", self._text)]
305
309
        # Run update hook, if any
306
310
        if self.update_hook is not None:
307
311
            self.update_hook()
308
 
    
 
312
 
309
313
    def update_timer(self):
310
 
        """called by gobject. Will indefinitely loop until
311
 
        gobject.source_remove() on tag is called"""
 
314
        """called by GLib. Will indefinitely loop until
 
315
        GLib.source_remove() on tag is called
 
316
        """
312
317
        self.update()
313
318
        return True             # Keep calling this
314
 
    
 
319
 
315
320
    def delete(self, **kwargs):
316
321
        if self._update_timer_callback_tag is not None:
317
 
            gobject.source_remove(self._update_timer_callback_tag)
 
322
            GLib.source_remove(self._update_timer_callback_tag)
318
323
            self._update_timer_callback_tag = None
319
324
        for match in self.match_objects:
320
325
            match.remove()
322
327
        if self.delete_hook is not None:
323
328
            self.delete_hook(self)
324
329
        return super(MandosClientWidget, self).delete(**kwargs)
325
 
    
 
330
 
326
331
    def render(self, maxcolrow, focus=False):
327
332
        """Render differently if we have focus.
328
333
        This overrides the method from urwid.FlowWidget"""
329
334
        return self.current_widget(focus).render(maxcolrow,
330
335
                                                 focus=focus)
331
 
    
 
336
 
332
337
    def keypress(self, maxcolrow, key):
333
338
        """Handle keys.
334
339
        This overrides the method from urwid.FlowWidget"""
335
340
        if key == "+":
336
 
            self.proxy.Enable(dbus_interface = client_interface,
337
 
                              ignore_reply=True)
 
341
            self.proxy.Set(client_interface, "Enabled",
 
342
                           dbus.Boolean(True), ignore_reply=True,
 
343
                           dbus_interface=dbus.PROPERTIES_IFACE)
338
344
        elif key == "-":
339
 
            self.proxy.Disable(dbus_interface = client_interface,
340
 
                               ignore_reply=True)
 
345
            self.proxy.Set(client_interface, "Enabled", False,
 
346
                           ignore_reply=True,
 
347
                           dbus_interface=dbus.PROPERTIES_IFACE)
341
348
        elif key == "a":
342
349
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
 
                               dbus_interface = client_interface,
 
350
                               dbus_interface=client_interface,
344
351
                               ignore_reply=True)
345
352
        elif key == "d":
346
353
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
 
                                  dbus_interface = client_interface,
 
354
                               dbus_interface=client_interface,
348
355
                               ignore_reply=True)
349
356
        elif key == "R" or key == "_" or key == "ctrl k":
350
357
            self.server_proxy_object.RemoveClient(self.proxy
351
358
                                                  .object_path,
352
359
                                                  ignore_reply=True)
353
360
        elif key == "s":
354
 
            self.proxy.StartChecker(dbus_interface = client_interface,
355
 
                                    ignore_reply=True)
 
361
            self.proxy.Set(client_interface, "CheckerRunning",
 
362
                           dbus.Boolean(True), ignore_reply=True,
 
363
                           dbus_interface=dbus.PROPERTIES_IFACE)
356
364
        elif key == "S":
357
 
            self.proxy.StopChecker(dbus_interface = client_interface,
358
 
                                   ignore_reply=True)
 
365
            self.proxy.Set(client_interface, "CheckerRunning",
 
366
                           dbus.Boolean(False), ignore_reply=True,
 
367
                           dbus_interface=dbus.PROPERTIES_IFACE)
359
368
        elif key == "C":
360
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
369
            self.proxy.CheckedOK(dbus_interface=client_interface,
361
370
                                 ignore_reply=True)
362
371
        # xxx
363
372
#         elif key == "p" or key == "=":
368
377
#             self.open()
369
378
        else:
370
379
            return key
371
 
    
 
380
 
372
381
    def properties_changed(self, interface, properties, invalidated):
373
382
        """Call self.update() if any properties changed.
374
383
        This overrides the method from MandosClientPropertyCache"""
375
 
        old_values = { key: self.properties.get(key)
376
 
                       for key in properties.keys() }
 
384
        old_values = {key: self.properties.get(key)
 
385
                      for key in properties.keys()}
377
386
        super(MandosClientWidget, self).properties_changed(
378
387
            interface, properties, invalidated)
379
388
        if any(old_values[key] != self.properties.get(key)
381
390
            self.update()
382
391
 
383
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
 
384
403
class ConstrainedListBox(urwid.ListBox):
385
404
    """Like a normal urwid.ListBox, but will consume all "up" or
386
405
    "down" key presses, thus not allowing any containing widgets to
387
406
    use them as an excuse to shift focus away from this widget.
388
407
    """
389
408
    def keypress(self, *args, **kwargs):
390
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
409
        ret = (super(ConstrainedListBox, self)
 
410
               .keypress(*args, **kwargs))
391
411
        if ret in ("up", "down"):
392
412
            return
393
413
        return ret
394
414
 
395
415
 
396
 
class UserInterface(object):
 
416
class UserInterface:
397
417
    """This is the entire user interface - the whole screen
398
418
    with boxes, lists of client widgets, etc.
399
419
    """
400
 
    def __init__(self, max_log_length=1000, log_level=1):
 
420
    def __init__(self, max_log_length=1000):
401
421
        DBusGMainLoop(set_as_default=True)
402
 
        
 
422
 
403
423
        self.screen = urwid.curses_display.Screen()
404
 
        
 
424
 
405
425
        self.screen.register_palette((
406
426
                ("normal",
407
427
                 "default", "default", None),
412
432
                ("standout",
413
433
                 "standout", "default", "standout"),
414
434
                ("bold-underline-blink",
415
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
435
                 "bold,underline,blink", "default",
 
436
                 "bold,underline,blink"),
416
437
                ("bold-standout",
417
438
                 "bold,standout", "default", "bold,standout"),
418
439
                ("underline-blink-standout",
422
443
                 "bold,underline,blink,standout", "default",
423
444
                 "bold,underline,blink,standout"),
424
445
                ))
425
 
        
 
446
 
426
447
        if urwid.supports_unicode():
427
 
            self.divider = "─" # \u2500
428
 
            #self.divider = "━" # \u2501
 
448
            self.divider = "─"  # \u2500
429
449
        else:
430
 
            #self.divider = "-" # \u002d
431
 
            self.divider = "_" # \u005f
432
 
        
 
450
            self.divider = "_"  # \u005f
 
451
 
433
452
        self.screen.start()
434
 
        
 
453
 
435
454
        self.size = self.screen.get_cols_rows()
436
 
        
 
455
 
437
456
        self.clients = urwid.SimpleListWalker([])
438
457
        self.clients_dict = {}
439
 
        
 
458
 
440
459
        # We will add Text widgets to this list
441
 
        self.log = []
 
460
        self.log = urwid.SimpleListWalker([])
442
461
        self.max_log_length = max_log_length
443
 
        
444
 
        self.log_level = log_level
445
 
        
 
462
 
446
463
        # We keep a reference to the log widget so we can remove it
447
464
        # from the ListWalker without it getting destroyed
448
465
        self.logbox = ConstrainedListBox(self.log)
449
 
        
 
466
 
450
467
        # This keeps track of whether self.uilist currently has
451
468
        # self.logbox in it or not
452
469
        self.log_visible = True
453
470
        self.log_wrap = "any"
454
 
        
 
471
 
 
472
        self.loghandler = UILogHandler(self)
 
473
 
455
474
        self.rebuild()
456
 
        self.log_message_raw(("bold",
457
 
                              "Mandos Monitor version " + version))
458
 
        self.log_message_raw(("bold",
459
 
                              "q: Quit  ?: Help"))
460
 
        
461
 
        self.busname = domain + '.Mandos'
462
 
        self.main_loop = gobject.MainLoop()
463
 
    
464
 
    def client_not_found(self, fingerprint, address):
465
 
        self.log_message("Client with address {} and fingerprint {}"
466
 
                         " could not be found"
467
 
                         .format(address, fingerprint))
468
 
    
 
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
 
469
486
    def rebuild(self):
470
487
        """This rebuilds the User Interface.
471
488
        Call this when the widget layout needs to change"""
472
489
        self.uilist = []
473
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
490
        # self.uilist.append(urwid.ListBox(self.clients))
474
491
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
475
492
                                                          clients),
476
 
                                       #header=urwid.Divider(),
 
493
                                       # header=urwid.Divider(),
477
494
                                       header=None,
478
 
                                       footer=
479
 
                                       urwid.Divider(div_char=
480
 
                                                     self.divider)))
 
495
                                       footer=urwid.Divider(
 
496
                                           div_char=self.divider)))
481
497
        if self.log_visible:
482
498
            self.uilist.append(self.logbox)
483
499
        self.topwidget = urwid.Pile(self.uilist)
484
 
    
485
 
    def log_message(self, message, level=1):
486
 
        """Log message formatted with timestamp"""
487
 
        if level < self.log_level:
488
 
            return
489
 
        timestamp = datetime.datetime.now().isoformat()
490
 
        self.log_message_raw("{}: {}".format(timestamp, message),
491
 
                             level=level)
492
 
    
493
 
    def log_message_raw(self, markup, level=1):
494
 
        """Add a log message to the log buffer."""
495
 
        if level < self.log_level:
496
 
            return
 
500
 
 
501
    def add_log_line(self, markup):
497
502
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
 
        if (self.max_log_length
499
 
            and len(self.log) > self.max_log_length):
500
 
            del self.log[0:len(self.log)-self.max_log_length-1]
501
 
        self.logbox.set_focus(len(self.logbox.body.contents),
 
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,
502
507
                              coming_from="above")
503
508
        self.refresh()
504
 
    
 
509
 
505
510
    def toggle_log_display(self):
506
511
        """Toggle visibility of the log buffer."""
507
512
        self.log_visible = not self.log_visible
508
513
        self.rebuild()
509
 
        self.log_message("Log visibility changed to: {}"
510
 
                         .format(self.log_visible), level=0)
511
 
    
 
514
        log.debug("Log visibility changed to: %s", self.log_visible)
 
515
 
512
516
    def change_log_display(self):
513
517
        """Change type of log display.
514
518
        Currently, this toggles wrapping of text lines."""
518
522
            self.log_wrap = "clip"
519
523
        for textwidget in self.log:
520
524
            textwidget.set_wrap_mode(self.log_wrap)
521
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
522
 
                         level=0)
523
 
    
524
 
    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):
525
528
        """Find a client by its object path and remove it.
526
 
        
527
 
        This is connected to the ClientRemoved signal from the
 
529
 
 
530
        This is connected to the InterfacesRemoved signal from the
528
531
        Mandos server object."""
 
532
        if client_interface not in interfaces:
 
533
            # Not a Mandos client object; ignore
 
534
            return
529
535
        try:
530
536
            client = self.clients_dict[path]
531
537
        except KeyError:
532
538
            # not found?
533
 
            self.log_message("Unknown client {!r} ({!r}) removed"
534
 
                             .format(name, path))
 
539
            log.warning("Unknown client %s removed", path)
535
540
            return
536
541
        client.delete()
537
 
    
538
 
    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
539
552
        client_proxy_object = self.bus.get_object(self.busname, path)
540
 
        self.add_client(MandosClientWidget(server_proxy_object
541
 
                                           =self.mandos_serv,
542
 
                                           proxy_object
543
 
                                           =client_proxy_object,
544
 
                                           update_hook
545
 
                                           =self.refresh,
546
 
                                           delete_hook
547
 
                                           =self.remove_client,
548
 
                                           logger
549
 
                                           =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])),
550
559
                        path=path)
551
 
    
 
560
 
552
561
    def add_client(self, client, path=None):
553
562
        self.clients.append(client)
554
563
        if path is None:
556
565
        self.clients_dict[path] = client
557
566
        self.clients.sort(key=lambda c: c.properties["Name"])
558
567
        self.refresh()
559
 
    
 
568
 
560
569
    def remove_client(self, client, path=None):
561
570
        self.clients.remove(client)
562
571
        if path is None:
563
572
            path = client.proxy.object_path
564
573
        del self.clients_dict[path]
565
574
        self.refresh()
566
 
    
 
575
 
567
576
    def refresh(self):
568
577
        """Redraw the screen"""
569
578
        canvas = self.topwidget.render(self.size, focus=True)
570
579
        self.screen.draw_screen(self.size, canvas)
571
 
    
 
580
 
572
581
    def run(self):
573
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")
574
588
        self.bus = dbus.SystemBus()
575
589
        mandos_dbus_objc = self.bus.get_object(
576
590
            self.busname, "/", follow_name_owner_changes=True)
577
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
578
 
                                          dbus_interface
579
 
                                          = server_interface)
 
591
        self.mandos_serv = dbus.Interface(
 
592
            mandos_dbus_objc, dbus_interface=server_interface)
580
593
        try:
581
594
            mandos_clients = (self.mandos_serv
582
595
                              .GetAllClientsWithProperties())
583
596
            if not mandos_clients:
584
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
597
                log.warning("Note: Server has no clients.")
585
598
        except dbus.exceptions.DBusException:
586
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
599
            log.warning("Note: No Mandos server running.")
587
600
            mandos_clients = dbus.Dictionary()
588
 
        
 
601
 
589
602
        (self.mandos_serv
590
 
         .connect_to_signal("ClientRemoved",
 
603
         .connect_to_signal("InterfacesRemoved",
591
604
                            self.find_and_remove_client,
592
 
                            dbus_interface=server_interface,
 
605
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
593
606
                            byte_arrays=True))
594
607
        (self.mandos_serv
595
 
         .connect_to_signal("ClientAdded",
 
608
         .connect_to_signal("InterfacesAdded",
596
609
                            self.add_new_client,
597
 
                            dbus_interface=server_interface,
 
610
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
598
611
                            byte_arrays=True))
599
612
        (self.mandos_serv
600
613
         .connect_to_signal("ClientNotFound",
604
617
        for path, client in mandos_clients.items():
605
618
            client_proxy_object = self.bus.get_object(self.busname,
606
619
                                                      path)
607
 
            self.add_client(MandosClientWidget(server_proxy_object
608
 
                                               =self.mandos_serv,
609
 
                                               proxy_object
610
 
                                               =client_proxy_object,
611
 
                                               properties=client,
612
 
                                               update_hook
613
 
                                               =self.refresh,
614
 
                                               delete_hook
615
 
                                               =self.remove_client,
616
 
                                               logger
617
 
                                               =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),
618
626
                            path=path)
619
 
        
 
627
 
620
628
        self.refresh()
621
 
        self._input_callback_tag = (gobject.io_add_watch
622
 
                                    (sys.stdin.fileno(),
623
 
                                     gobject.IO_IN,
624
 
                                     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)))
625
634
        self.main_loop.run()
626
635
        # Main loop has finished, we should close everything now
627
 
        gobject.source_remove(self._input_callback_tag)
628
 
        self.screen.stop()
629
 
    
 
636
        GLib.source_remove(self._input_callback_tag)
 
637
        with warnings.catch_warnings():
 
638
            warnings.simplefilter("ignore", BytesWarning)
 
639
            self.screen.stop()
 
640
 
630
641
    def stop(self):
631
642
        self.main_loop.quit()
632
 
    
 
643
        log.removeHandler(self.loghandler)
 
644
        log.propagate = self.orig_log_propagate
 
645
 
633
646
    def process_input(self, source, condition):
634
647
        keys = self.screen.get_input()
635
 
        translations = { "ctrl n": "down",      # Emacs
636
 
                         "ctrl p": "up",        # Emacs
637
 
                         "ctrl v": "page down", # Emacs
638
 
                         "meta v": "page up",   # Emacs
639
 
                         " ": "page down",      # less
640
 
                         "f": "page down",      # less
641
 
                         "b": "page up",        # less
642
 
                         "j": "down",           # vi
643
 
                         "k": "up",             # vi
644
 
                         }
 
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
                        }
645
658
        for key in keys:
646
659
            try:
647
660
                key = translations[key]
648
661
            except KeyError:    # :-)
649
662
                pass
650
 
            
 
663
 
651
664
            if key == "q" or key == "Q":
652
665
                self.stop()
653
666
                break
667
680
                if not self.log_visible:
668
681
                    self.log_visible = True
669
682
                    self.rebuild()
670
 
                self.log_message_raw(("bold",
671
 
                                      "  ".
672
 
                                      join(("q: Quit",
673
 
                                            "?: Help",
674
 
                                            "l: Log window toggle",
675
 
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log lines)",
677
 
                                            "v: Toggle verbose log",
678
 
                                            ))))
679
 
                self.log_message_raw(("bold",
680
 
                                      "  "
681
 
                                      .join(("Clients:",
682
 
                                             "+: Enable",
683
 
                                             "-: Disable",
684
 
                                             "R: Remove",
685
 
                                             "s: Start new checker",
686
 
                                             "S: Stop checker",
687
 
                                             "C: Checker OK",
688
 
                                             "a: Approve",
689
 
                                             "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
                                   ))))
690
702
                self.refresh()
691
703
            elif key == "tab":
692
704
                if self.topwidget.get_focus() is self.logbox:
695
707
                    self.topwidget.set_focus(self.logbox)
696
708
                self.refresh()
697
709
            elif key == "v":
698
 
                if self.log_level == 0:
699
 
                    self.log_level = 1
700
 
                    self.log_message("Verbose mode: Off")
 
710
                if log.level < logging.INFO:
 
711
                    log.setLevel(logging.INFO)
 
712
                    log.info("Verbose mode: Off")
701
713
                else:
702
 
                    self.log_level = 0
703
 
                    self.log_message("Verbose mode: On")
704
 
            #elif (key == "end" or key == "meta >" or key == "G"
705
 
            #      or key == ">"):
706
 
            #    pass            # xxx end-of-buffer
707
 
            #elif (key == "home" or key == "meta <" or key == "g"
708
 
            #      or key == "<"):
709
 
            #    pass            # xxx beginning-of-buffer
710
 
            #elif key == "ctrl e" or key == "$":
711
 
            #    pass            # xxx move-end-of-line
712
 
            #elif key == "ctrl a" or key == "^":
713
 
            #    pass            # xxx move-beginning-of-line
714
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
715
 
            #    pass            # xxx left
716
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
717
 
            #    pass            # xxx right
718
 
            #elif key == "a":
719
 
            #    pass            # scroll up log
720
 
            #elif key == "z":
721
 
            #    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
722
734
            elif self.topwidget.selectable():
723
735
                self.topwidget.keypress(self.size, key)
724
736
                self.refresh()
725
737
        return True
726
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
 
727
753
ui = UserInterface()
728
754
try:
729
755
    ui.run()
730
756
except KeyboardInterrupt:
731
 
    ui.screen.stop()
732
 
except Exception as e:
733
 
    ui.log_message(str(e))
734
 
    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()
735
764
    raise