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