/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-2016 Teddy Hogeborn
7
 
# Copyright © 2009-2016 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
43
46
 
44
47
import dbus
45
48
 
46
 
import locale
47
 
 
48
49
if sys.version_info.major == 2:
 
50
    __metaclass__ = type
49
51
    str = unicode
50
 
 
51
 
locale.setlocale(locale.LC_ALL, '')
52
 
 
53
 
import logging
54
 
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)
55
68
 
56
69
# Some useful constants
57
 
domain = 'se.recompile'
58
 
server_interface = domain + '.Mandos'
59
 
client_interface = domain + '.Mandos.Client'
60
 
version = "1.7.6"
 
70
domain = "se.recompile"
 
71
server_interface = domain + ".Mandos"
 
72
client_interface = domain + ".Mandos.Client"
 
73
version = "1.8.17"
61
74
 
62
75
try:
63
76
    dbus.OBJECT_MANAGER_IFACE
64
77
except AttributeError:
65
78
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
66
79
 
 
80
 
67
81
def isoformat_to_datetime(iso):
68
82
    "Parse an ISO 8601 date string to a datetime.datetime()"
69
83
    if not iso:
77
91
                             int(day),
78
92
                             int(hour),
79
93
                             int(minute),
80
 
                             int(second),           # Whole seconds
81
 
                             int(fraction*1000000)) # Microseconds
82
 
 
83
 
class MandosClientPropertyCache(object):
 
94
                             int(second),            # Whole seconds
 
95
                             int(fraction*1000000))  # Microseconds
 
96
 
 
97
 
 
98
class MandosClientPropertyCache:
84
99
    """This wraps a Mandos Client D-Bus proxy object, caches the
85
100
    properties and calls a hook function when any of them are
86
101
    changed.
87
102
    """
88
103
    def __init__(self, proxy_object=None, properties=None, **kwargs):
89
 
        self.proxy = proxy_object # Mandos Client proxy object
 
104
        self.proxy = proxy_object  # Mandos Client proxy object
90
105
        self.properties = dict() if properties is None else properties
91
106
        self.property_changed_match = (
92
107
            self.proxy.connect_to_signal("PropertiesChanged",
93
108
                                         self.properties_changed,
94
109
                                         dbus.PROPERTIES_IFACE,
95
110
                                         byte_arrays=True))
96
 
        
 
111
 
97
112
        if properties is None:
98
 
            self.properties.update(
99
 
                self.proxy.GetAll(client_interface,
100
 
                                  dbus_interface
101
 
                                  = dbus.PROPERTIES_IFACE))
102
 
        
 
113
            self.properties.update(self.proxy.GetAll(
 
114
                client_interface,
 
115
                dbus_interface=dbus.PROPERTIES_IFACE))
 
116
 
103
117
        super(MandosClientPropertyCache, self).__init__(**kwargs)
104
 
    
 
118
 
105
119
    def properties_changed(self, interface, properties, invalidated):
106
120
        """This is called whenever we get a PropertiesChanged signal
107
121
        It updates the changed properties in the "properties" dict.
109
123
        # Update properties dict with new value
110
124
        if interface == client_interface:
111
125
            self.properties.update(properties)
112
 
    
 
126
 
113
127
    def delete(self):
114
128
        self.property_changed_match.remove()
115
129
 
117
131
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
118
132
    """A Mandos Client which is visible on the screen.
119
133
    """
120
 
    
 
134
 
121
135
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, **kwargs):
 
136
                 delete_hook=None, **kwargs):
123
137
        # Called on update
124
138
        self.update_hook = update_hook
125
139
        # Called on delete
126
140
        self.delete_hook = delete_hook
127
141
        # Mandos Server proxy object
128
142
        self.server_proxy_object = server_proxy_object
129
 
        # Logger
130
 
        self.logger = logger
131
 
        
 
143
 
132
144
        self._update_timer_callback_tag = None
133
 
        
 
145
 
134
146
        # The widget shown normally
135
147
        self._text_widget = urwid.Text("")
136
148
        # The widget shown when we have focus
138
150
        super(MandosClientWidget, self).__init__(**kwargs)
139
151
        self.update()
140
152
        self.opened = False
141
 
        
 
153
 
142
154
        self.match_objects = (
143
155
            self.proxy.connect_to_signal("CheckerCompleted",
144
156
                                         self.checker_completed,
160
172
                                         self.rejected,
161
173
                                         client_interface,
162
174
                                         byte_arrays=True))
163
 
        self.logger('Created client {}'
164
 
                    .format(self.properties["Name"]), level=0)
165
 
    
 
175
        log.debug("Created client %s", self.properties["Name"])
 
176
 
166
177
    def using_timer(self, flag):
167
178
        """Call this method with True or False when timer should be
168
179
        activated or deactivated.
169
180
        """
170
181
        if flag and self._update_timer_callback_tag is None:
171
182
            # Will update the shown timer value every second
172
 
            self._update_timer_callback_tag = (GLib.timeout_add
173
 
                                               (1000,
174
 
                                                self.update_timer))
 
183
            self._update_timer_callback_tag = (
 
184
                GLib.timeout_add(1000,
 
185
                                 glib_safely(self.update_timer)))
175
186
        elif not (flag or self._update_timer_callback_tag is None):
176
187
            GLib.source_remove(self._update_timer_callback_tag)
177
188
            self._update_timer_callback_tag = None
178
 
    
 
189
 
179
190
    def checker_completed(self, exitstatus, condition, command):
180
191
        if exitstatus == 0:
181
 
            self.logger('Checker for client {} (command "{}")'
182
 
                        ' succeeded'.format(self.properties["Name"],
183
 
                                            command), level=0)
 
192
            log.debug('Checker for client %s (command "%s")'
 
193
                      " succeeded", self.properties["Name"], command)
184
194
            self.update()
185
195
            return
186
196
        # Checker failed
187
197
        if os.WIFEXITED(condition):
188
 
            self.logger('Checker for client {} (command "{}") failed'
189
 
                        ' with exit code {}'
190
 
                        .format(self.properties["Name"], command,
191
 
                                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))
192
201
        elif os.WIFSIGNALED(condition):
193
 
            self.logger('Checker for client {} (command "{}") was'
194
 
                        ' killed by signal {}'
195
 
                        .format(self.properties["Name"], command,
196
 
                                os.WTERMSIG(condition)))
 
202
            log.info('Checker for client %s (command "%s") was'
 
203
                     " killed by signal %d", self.properties["Name"],
 
204
                     command, os.WTERMSIG(condition))
197
205
        self.update()
198
 
    
 
206
 
199
207
    def checker_started(self, command):
200
208
        """Server signals that a checker started."""
201
 
        self.logger('Client {} started checker "{}"'
202
 
                    .format(self.properties["Name"],
203
 
                            command), level=0)
204
 
    
 
209
        log.debug('Client %s started checker "%s"',
 
210
                  self.properties["Name"], command)
 
211
 
205
212
    def got_secret(self):
206
 
        self.logger('Client {} received its secret'
207
 
                    .format(self.properties["Name"]))
208
 
    
 
213
        log.info("Client %s received its secret",
 
214
                 self.properties["Name"])
 
215
 
209
216
    def need_approval(self, timeout, default):
210
217
        if not default:
211
 
            message = 'Client {} needs approval within {} seconds'
 
218
            message = "Client %s needs approval within %f seconds"
212
219
        else:
213
 
            message = 'Client {} will get its secret in {} seconds'
214
 
        self.logger(message.format(self.properties["Name"],
215
 
                                   timeout/1000))
216
 
    
 
220
            message = "Client %s will get its secret in %f seconds"
 
221
        log.info(message, self.properties["Name"], timeout/1000)
 
222
 
217
223
    def rejected(self, reason):
218
 
        self.logger('Client {} was rejected; reason: {}'
219
 
                    .format(self.properties["Name"], reason))
220
 
    
 
224
        log.info("Client %s was rejected; reason: %s",
 
225
                 self.properties["Name"], reason)
 
226
 
221
227
    def selectable(self):
222
228
        """Make this a "selectable" widget.
223
229
        This overrides the method from urwid.FlowWidget."""
224
230
        return True
225
 
    
 
231
 
226
232
    def rows(self, maxcolrow, focus=False):
227
233
        """How many rows this widget will occupy might depend on
228
234
        whether we have focus or not.
229
235
        This overrides the method from urwid.FlowWidget"""
230
236
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
231
 
    
 
237
 
232
238
    def current_widget(self, focus=False):
233
239
        if focus or self.opened:
234
240
            return self._focus_widget
235
241
        return self._widget
236
 
    
 
242
 
237
243
    def update(self):
238
244
        "Called when what is visible on the screen should be updated."
239
245
        # How to add standout mode to a style
240
 
        with_standout = { "normal": "standout",
241
 
                          "bold": "bold-standout",
242
 
                          "underline-blink":
243
 
                              "underline-blink-standout",
244
 
                          "bold-underline-blink":
245
 
                              "bold-underline-blink-standout",
246
 
                          }
247
 
        
 
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
 
248
254
        # Rebuild focus and non-focus widgets using current properties
249
 
        
 
255
 
250
256
        # Base part of a client. Name!
251
 
        base = '{name}: '.format(name=self.properties["Name"])
 
257
        base = "{name}: ".format(name=self.properties["Name"])
252
258
        if not self.properties["Enabled"]:
253
259
            message = "DISABLED"
254
260
            self.using_timer(False)
255
261
        elif self.properties["ApprovalPending"]:
256
 
            timeout = datetime.timedelta(milliseconds
257
 
                                         = self.properties
258
 
                                         ["ApprovalDelay"])
 
262
            timeout = datetime.timedelta(
 
263
                milliseconds=self.properties["ApprovalDelay"])
259
264
            last_approval_request = isoformat_to_datetime(
260
265
                self.properties["LastApprovalRequest"])
261
266
            if last_approval_request is not None:
277
282
                timer = datetime.timedelta(0)
278
283
            else:
279
284
                expires = (datetime.datetime.strptime
280
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
285
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
281
286
                timer = max(expires - datetime.datetime.utcnow(),
282
287
                            datetime.timedelta())
283
 
            message = ('A checker has failed! Time until client'
284
 
                       ' gets disabled: {}'
 
288
            message = ("A checker has failed! Time until client"
 
289
                       " gets disabled: {}"
285
290
                       .format(str(timer).rsplit(".", 1)[0]))
286
291
            self.using_timer(True)
287
292
        else:
288
293
            message = "enabled"
289
294
            self.using_timer(False)
290
295
        self._text = "{}{}".format(base, message)
291
 
        
 
296
 
292
297
        if not urwid.supports_unicode():
293
298
            self._text = self._text.encode("ascii", "replace")
294
299
        textlist = [("normal", self._text)]
304
309
        # Run update hook, if any
305
310
        if self.update_hook is not None:
306
311
            self.update_hook()
307
 
    
 
312
 
308
313
    def update_timer(self):
309
314
        """called by GLib. Will indefinitely loop until
310
315
        GLib.source_remove() on tag is called
311
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
322
            GLib.source_remove(self._update_timer_callback_tag)
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
341
            self.proxy.Set(client_interface, "Enabled",
337
 
                           dbus.Boolean(True), ignore_reply = True,
338
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
342
                           dbus.Boolean(True), ignore_reply=True,
 
343
                           dbus_interface=dbus.PROPERTIES_IFACE)
339
344
        elif key == "-":
340
345
            self.proxy.Set(client_interface, "Enabled", False,
341
 
                           ignore_reply = True,
342
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
346
                           ignore_reply=True,
 
347
                           dbus_interface=dbus.PROPERTIES_IFACE)
343
348
        elif key == "a":
344
349
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
 
                               dbus_interface = client_interface,
 
350
                               dbus_interface=client_interface,
346
351
                               ignore_reply=True)
347
352
        elif key == "d":
348
353
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
 
                                  dbus_interface = client_interface,
 
354
                               dbus_interface=client_interface,
350
355
                               ignore_reply=True)
351
356
        elif key == "R" or key == "_" or key == "ctrl k":
352
357
            self.server_proxy_object.RemoveClient(self.proxy
354
359
                                                  ignore_reply=True)
355
360
        elif key == "s":
356
361
            self.proxy.Set(client_interface, "CheckerRunning",
357
 
                           dbus.Boolean(True), ignore_reply = True,
358
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
362
                           dbus.Boolean(True), ignore_reply=True,
 
363
                           dbus_interface=dbus.PROPERTIES_IFACE)
359
364
        elif key == "S":
360
365
            self.proxy.Set(client_interface, "CheckerRunning",
361
 
                           dbus.Boolean(False), ignore_reply = True,
362
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
 
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'
 
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"
466
480
        self.main_loop = GLib.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
 
    
 
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
 
    
 
525
        log.debug("Wrap mode: %s", self.log_wrap)
 
526
 
528
527
    def find_and_remove_client(self, path, interfaces):
529
528
        """Find a client by its object path and remove it.
530
 
        
 
529
 
531
530
        This is connected to the InterfacesRemoved signal from the
532
531
        Mandos server object."""
533
532
        if client_interface not in interfaces:
537
536
            client = self.clients_dict[path]
538
537
        except KeyError:
539
538
            # not found?
540
 
            self.log_message("Unknown client {!r} removed"
541
 
                             .format(path))
 
539
            log.warning("Unknown client %s removed", path)
542
540
            return
543
541
        client.delete()
544
 
    
 
542
 
545
543
    def add_new_client(self, path, ifs_and_props):
546
544
        """Find a client by its object path and remove it.
547
 
        
 
545
 
548
546
        This is connected to the InterfacesAdded signal from the
549
547
        Mandos server object.
550
548
        """
552
550
            # Not a Mandos client object; ignore
553
551
            return
554
552
        client_proxy_object = self.bus.get_object(self.busname, path)
555
 
        self.add_client(MandosClientWidget(server_proxy_object
556
 
                                           =self.mandos_serv,
557
 
                                           proxy_object
558
 
                                           =client_proxy_object,
559
 
                                           update_hook
560
 
                                           =self.refresh,
561
 
                                           delete_hook
562
 
                                           =self.remove_client,
563
 
                                           logger
564
 
                                           =self.log_message,
565
 
                                           properties
566
 
                                           = dict(ifs_and_props[
567
 
                                               client_interface])),
 
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])),
568
559
                        path=path)
569
 
    
 
560
 
570
561
    def add_client(self, client, path=None):
571
562
        self.clients.append(client)
572
563
        if path is None:
574
565
        self.clients_dict[path] = client
575
566
        self.clients.sort(key=lambda c: c.properties["Name"])
576
567
        self.refresh()
577
 
    
 
568
 
578
569
    def remove_client(self, client, path=None):
579
570
        self.clients.remove(client)
580
571
        if path is None:
581
572
            path = client.proxy.object_path
582
573
        del self.clients_dict[path]
583
574
        self.refresh()
584
 
    
 
575
 
585
576
    def refresh(self):
586
577
        """Redraw the screen"""
587
578
        canvas = self.topwidget.render(self.size, focus=True)
588
579
        self.screen.draw_screen(self.size, canvas)
589
 
    
 
580
 
590
581
    def run(self):
591
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")
592
588
        self.bus = dbus.SystemBus()
593
589
        mandos_dbus_objc = self.bus.get_object(
594
590
            self.busname, "/", follow_name_owner_changes=True)
595
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
596
 
                                          dbus_interface
597
 
                                          = server_interface)
 
591
        self.mandos_serv = dbus.Interface(
 
592
            mandos_dbus_objc, dbus_interface=server_interface)
598
593
        try:
599
594
            mandos_clients = (self.mandos_serv
600
595
                              .GetAllClientsWithProperties())
601
596
            if not mandos_clients:
602
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
597
                log.warning("Note: Server has no clients.")
603
598
        except dbus.exceptions.DBusException:
604
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
599
            log.warning("Note: No Mandos server running.")
605
600
            mandos_clients = dbus.Dictionary()
606
 
        
 
601
 
607
602
        (self.mandos_serv
608
603
         .connect_to_signal("InterfacesRemoved",
609
604
                            self.find_and_remove_client,
610
 
                            dbus_interface
611
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
605
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
612
606
                            byte_arrays=True))
613
607
        (self.mandos_serv
614
608
         .connect_to_signal("InterfacesAdded",
615
609
                            self.add_new_client,
616
 
                            dbus_interface
617
 
                            = dbus.OBJECT_MANAGER_IFACE,
 
610
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
618
611
                            byte_arrays=True))
619
612
        (self.mandos_serv
620
613
         .connect_to_signal("ClientNotFound",
624
617
        for path, client in mandos_clients.items():
625
618
            client_proxy_object = self.bus.get_object(self.busname,
626
619
                                                      path)
627
 
            self.add_client(MandosClientWidget(server_proxy_object
628
 
                                               =self.mandos_serv,
629
 
                                               proxy_object
630
 
                                               =client_proxy_object,
631
 
                                               properties=client,
632
 
                                               update_hook
633
 
                                               =self.refresh,
634
 
                                               delete_hook
635
 
                                               =self.remove_client,
636
 
                                               logger
637
 
                                               =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),
638
626
                            path=path)
639
 
        
 
627
 
640
628
        self.refresh()
641
 
        self._input_callback_tag = (GLib.io_add_watch
642
 
                                    (sys.stdin.fileno(),
643
 
                                     GLib.IO_IN,
644
 
                                     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)))
645
634
        self.main_loop.run()
646
635
        # Main loop has finished, we should close everything now
647
636
        GLib.source_remove(self._input_callback_tag)
648
 
        self.screen.stop()
649
 
    
 
637
        with warnings.catch_warnings():
 
638
            warnings.simplefilter("ignore", BytesWarning)
 
639
            self.screen.stop()
 
640
 
650
641
    def stop(self):
651
642
        self.main_loop.quit()
652
 
    
 
643
        log.removeHandler(self.loghandler)
 
644
        log.propagate = self.orig_log_propagate
 
645
 
653
646
    def process_input(self, source, condition):
654
647
        keys = self.screen.get_input()
655
 
        translations = { "ctrl n": "down",      # Emacs
656
 
                         "ctrl p": "up",        # Emacs
657
 
                         "ctrl v": "page down", # Emacs
658
 
                         "meta v": "page up",   # Emacs
659
 
                         " ": "page down",      # less
660
 
                         "f": "page down",      # less
661
 
                         "b": "page up",        # less
662
 
                         "j": "down",           # vi
663
 
                         "k": "up",             # vi
664
 
                         }
 
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
                        }
665
658
        for key in keys:
666
659
            try:
667
660
                key = translations[key]
668
661
            except KeyError:    # :-)
669
662
                pass
670
 
            
 
663
 
671
664
            if key == "q" or key == "Q":
672
665
                self.stop()
673
666
                break
687
680
                if not self.log_visible:
688
681
                    self.log_visible = True
689
682
                    self.rebuild()
690
 
                self.log_message_raw(("bold",
691
 
                                      "  ".
692
 
                                      join(("q: Quit",
693
 
                                            "?: Help",
694
 
                                            "l: Log window toggle",
695
 
                                            "TAB: Switch window",
696
 
                                            "w: Wrap (log lines)",
697
 
                                            "v: Toggle verbose log",
698
 
                                            ))))
699
 
                self.log_message_raw(("bold",
700
 
                                      "  "
701
 
                                      .join(("Clients:",
702
 
                                             "+: Enable",
703
 
                                             "-: Disable",
704
 
                                             "R: Remove",
705
 
                                             "s: Start new checker",
706
 
                                             "S: Stop checker",
707
 
                                             "C: Checker OK",
708
 
                                             "a: Approve",
709
 
                                             "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
                                   ))))
710
702
                self.refresh()
711
703
            elif key == "tab":
712
704
                if self.topwidget.get_focus() is self.logbox:
715
707
                    self.topwidget.set_focus(self.logbox)
716
708
                self.refresh()
717
709
            elif key == "v":
718
 
                if self.log_level == 0:
719
 
                    self.log_level = 1
720
 
                    self.log_message("Verbose mode: Off")
 
710
                if log.level < logging.INFO:
 
711
                    log.setLevel(logging.INFO)
 
712
                    log.info("Verbose mode: Off")
721
713
                else:
722
 
                    self.log_level = 0
723
 
                    self.log_message("Verbose mode: On")
724
 
            #elif (key == "end" or key == "meta >" or key == "G"
725
 
            #      or key == ">"):
726
 
            #    pass            # xxx end-of-buffer
727
 
            #elif (key == "home" or key == "meta <" or key == "g"
728
 
            #      or key == "<"):
729
 
            #    pass            # xxx beginning-of-buffer
730
 
            #elif key == "ctrl e" or key == "$":
731
 
            #    pass            # xxx move-end-of-line
732
 
            #elif key == "ctrl a" or key == "^":
733
 
            #    pass            # xxx move-beginning-of-line
734
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
735
 
            #    pass            # xxx left
736
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
737
 
            #    pass            # xxx right
738
 
            #elif key == "a":
739
 
            #    pass            # scroll up log
740
 
            #elif key == "z":
741
 
            #    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
742
734
            elif self.topwidget.selectable():
743
735
                self.topwidget.keypress(self.size, key)
744
736
                self.refresh()
745
737
        return True
746
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
 
747
753
ui = UserInterface()
748
754
try:
749
755
    ui.run()
750
756
except KeyboardInterrupt:
751
 
    ui.screen.stop()
752
 
except Exception as e:
753
 
    ui.log_message(str(e))
754
 
    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()
755
764
    raise