/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:30:34 UTC
  • Revision ID: teddy@recompile.se-20241122203034-92q7483wxv29tqev
mandos-monitor: avoid deprecation warnings from urwid

The urwid.FlowWidget class is deprecated.  Replace it with inheriting
from urwid.Widget, and setting the appropriate class attribute.

* mandos-monitor: Replace any mentions of urwid.FlowWidget with
  urwid.Widget.
  (MandosClientWidget): Inherit from "urwid.Widget" instead of
  "urwid.FlowWidget".  Also, move MandosClientPropertyCache to first
  in inheritance list so that its __init__ method can absorb the
  "proxy_object" and "properties" keyword arguments.
  (MandosClientWidget._sizing): New class attribute; set to
  "frozenset(["flow"])".

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