/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-2013 Teddy Hogeborn
7
 
# Copyright © 2009-2013 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
 
import signal
36
 
 
 
37
import warnings
37
38
import datetime
 
39
import locale
38
40
 
39
41
import urwid.curses_display
40
42
import urwid
41
43
 
42
44
from dbus.mainloop.glib import DBusGMainLoop
43
 
try:
44
 
    import gobject
45
 
except ImportError:
46
 
    from gi.repository import GObject as gobject
 
45
from gi.repository import GLib
47
46
 
48
47
import dbus
49
48
 
50
 
import locale
51
 
 
52
 
if sys.version_info[0] == 2:
 
49
if sys.version_info.major == 2:
 
50
    __metaclass__ = type
53
51
    str = unicode
54
 
 
55
 
locale.setlocale(locale.LC_ALL, '')
56
 
 
57
 
import logging
58
 
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)
59
68
 
60
69
# Some useful constants
61
 
domain = 'se.recompile'
62
 
server_interface = domain + '.Mandos'
63
 
client_interface = domain + '.Mandos.Client'
64
 
version = "1.6.2"
 
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
 
65
80
 
66
81
def isoformat_to_datetime(iso):
67
82
    "Parse an ISO 8601 date string to a datetime.datetime()"
76
91
                             int(day),
77
92
                             int(hour),
78
93
                             int(minute),
79
 
                             int(second),           # Whole seconds
80
 
                             int(fraction*1000000)) # Microseconds
81
 
 
82
 
class MandosClientPropertyCache(object):
 
94
                             int(second),            # Whole seconds
 
95
                             int(fraction*1000000))  # Microseconds
 
96
 
 
97
 
 
98
class MandosClientPropertyCache:
83
99
    """This wraps a Mandos Client D-Bus proxy object, caches the
84
100
    properties and calls a hook function when any of them are
85
101
    changed.
86
102
    """
87
103
    def __init__(self, proxy_object=None, properties=None, **kwargs):
88
 
        self.proxy = proxy_object # Mandos Client proxy object
 
104
        self.proxy = proxy_object  # Mandos Client proxy object
89
105
        self.properties = dict() if properties is None else properties
90
106
        self.property_changed_match = (
91
 
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self._property_changed,
93
 
                                         client_interface,
 
107
            self.proxy.connect_to_signal("PropertiesChanged",
 
108
                                         self.properties_changed,
 
109
                                         dbus.PROPERTIES_IFACE,
94
110
                                         byte_arrays=True))
95
 
        
 
111
 
96
112
        if properties is None:
97
 
            self.properties.update(
98
 
                self.proxy.GetAll(client_interface,
99
 
                                  dbus_interface
100
 
                                  = dbus.PROPERTIES_IFACE))
101
 
        
 
113
            self.properties.update(self.proxy.GetAll(
 
114
                client_interface,
 
115
                dbus_interface=dbus.PROPERTIES_IFACE))
 
116
 
102
117
        super(MandosClientPropertyCache, self).__init__(**kwargs)
103
 
    
104
 
    def _property_changed(self, property, value):
105
 
        """Helper which takes positional arguments"""
106
 
        return self.property_changed(property=property, value=value)
107
 
    
108
 
    def property_changed(self, property=None, value=None):
109
 
        """This is called whenever we get a PropertyChanged signal
110
 
        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.
111
122
        """
112
123
        # Update properties dict with new value
113
 
        self.properties[property] = value
114
 
    
 
124
        if interface == client_interface:
 
125
            self.properties.update(properties)
 
126
 
115
127
    def delete(self):
116
128
        self.property_changed_match.remove()
117
129
 
118
130
 
119
 
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
 
131
class MandosClientWidget(MandosClientPropertyCache, urwid.Widget):
120
132
    """A Mandos Client which is visible on the screen.
121
133
    """
122
 
    
 
134
 
 
135
    _sizing = frozenset(["flow"])
 
136
 
123
137
    def __init__(self, server_proxy_object=None, update_hook=None,
124
 
                 delete_hook=None, logger=None, **kwargs):
 
138
                 delete_hook=None, **kwargs):
125
139
        # Called on update
126
140
        self.update_hook = update_hook
127
141
        # Called on delete
128
142
        self.delete_hook = delete_hook
129
143
        # Mandos Server proxy object
130
144
        self.server_proxy_object = server_proxy_object
131
 
        # Logger
132
 
        self.logger = logger
133
 
        
 
145
 
134
146
        self._update_timer_callback_tag = None
135
 
        
 
147
 
136
148
        # The widget shown normally
137
149
        self._text_widget = urwid.Text("")
138
150
        # The widget shown when we have focus
140
152
        super(MandosClientWidget, self).__init__(**kwargs)
141
153
        self.update()
142
154
        self.opened = False
143
 
        
 
155
 
144
156
        self.match_objects = (
145
157
            self.proxy.connect_to_signal("CheckerCompleted",
146
158
                                         self.checker_completed,
162
174
                                         self.rejected,
163
175
                                         client_interface,
164
176
                                         byte_arrays=True))
165
 
        #self.logger('Created client {0}'
166
 
        #            .format(self.properties["Name"]))
167
 
    
 
177
        log.debug("Created client %s", self.properties["Name"])
 
178
 
168
179
    def using_timer(self, flag):
169
180
        """Call this method with True or False when timer should be
170
181
        activated or deactivated.
171
182
        """
172
183
        if flag and self._update_timer_callback_tag is None:
173
184
            # Will update the shown timer value every second
174
 
            self._update_timer_callback_tag = (gobject.timeout_add
175
 
                                               (1000,
176
 
                                                self.update_timer))
 
185
            self._update_timer_callback_tag = (
 
186
                GLib.timeout_add(1000,
 
187
                                 glib_safely(self.update_timer)))
177
188
        elif not (flag or self._update_timer_callback_tag is None):
178
 
            gobject.source_remove(self._update_timer_callback_tag)
 
189
            GLib.source_remove(self._update_timer_callback_tag)
179
190
            self._update_timer_callback_tag = None
180
 
    
 
191
 
181
192
    def checker_completed(self, exitstatus, condition, command):
182
193
        if exitstatus == 0:
 
194
            log.debug('Checker for client %s (command "%s")'
 
195
                      " succeeded", self.properties["Name"], command)
183
196
            self.update()
184
197
            return
185
198
        # Checker failed
186
199
        if os.WIFEXITED(condition):
187
 
            self.logger('Checker for client {0} (command "{1}")'
188
 
                        ' failed with exit code {2}'
189
 
                        .format(self.properties["Name"], command,
190
 
                                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))
191
203
        elif os.WIFSIGNALED(condition):
192
 
            self.logger('Checker for client {0} (command "{1}") was'
193
 
                        ' killed by signal {2}'
194
 
                        .format(self.properties["Name"], command,
195
 
                                os.WTERMSIG(condition)))
196
 
        elif os.WCOREDUMP(condition):
197
 
            self.logger('Checker for client {0} (command "{1}")'
198
 
                        ' dumped core'
199
 
                        .format(self.properties["Name"], command))
200
 
        else:
201
 
            self.logger('Checker for client {0} completed'
202
 
                        ' mysteriously'
203
 
                        .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))
204
207
        self.update()
205
 
    
 
208
 
206
209
    def checker_started(self, command):
207
 
        """Server signals that a checker started. This could be useful
208
 
           to log in the future. """
209
 
        #self.logger('Client {0} started checker "{1}"'
210
 
        #            .format(self.properties["Name"],
211
 
        #                    str(command)))
212
 
        pass
213
 
    
 
210
        """Server signals that a checker started."""
 
211
        log.debug('Client %s started checker "%s"',
 
212
                  self.properties["Name"], command)
 
213
 
214
214
    def got_secret(self):
215
 
        self.logger('Client {0} 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 {0} needs approval within {1} seconds'
 
220
            message = "Client %s needs approval within %f seconds"
221
221
        else:
222
 
            message = 'Client {0} will get its secret in {1} 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 {0} was rejected; reason: {1}'
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:
274
272
            else:
275
273
                timer = datetime.timedelta()
276
274
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {0}. (d)eny?"
 
275
                message = "Approval in {}. (d)eny?"
278
276
            else:
279
 
                message = "Denial in {0}. (a)pprove?"
 
277
                message = "Denial in {}. (a)pprove?"
280
278
            message = message.format(str(timer).rsplit(".", 1)[0])
281
279
            self.using_timer(True)
282
280
        elif self.properties["LastCheckerStatus"] != 0:
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: {0}'
 
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
 
        self._text = "{0}{1}".format(base, message)
300
 
        
 
297
        self._text = "{}{}".format(base, message)
 
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
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
 
        
 
464
 
451
465
        # We keep a reference to the log widget so we can remove it
452
466
        # from the ListWalker without it getting destroyed
453
467
        self.logbox = ConstrainedListBox(self.log)
454
 
        
 
468
 
455
469
        # This keeps track of whether self.uilist currently has
456
470
        # self.logbox in it or not
457
471
        self.log_visible = True
458
472
        self.log_wrap = "any"
459
 
        
 
473
 
 
474
        self.loghandler = UILogHandler(self)
 
475
 
460
476
        self.rebuild()
461
 
        self.log_message_raw(("bold",
462
 
                              "Mandos Monitor version " + version))
463
 
        self.log_message_raw(("bold",
464
 
                              "q: Quit  ?: Help"))
465
 
        
466
 
        self.busname = domain + '.Mandos'
467
 
        self.main_loop = gobject.MainLoop()
468
 
    
469
 
    def client_not_found(self, fingerprint, address):
470
 
        self.log_message("Client with address {0} and fingerprint"
471
 
                         " {1} could not be found"
472
 
                         .format(address, fingerprint))
473
 
    
 
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
 
474
488
    def rebuild(self):
475
489
        """This rebuilds the User Interface.
476
490
        Call this when the widget layout needs to change"""
477
491
        self.uilist = []
478
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
492
        # self.uilist.append(urwid.ListBox(self.clients))
479
493
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
480
494
                                                          clients),
481
 
                                       #header=urwid.Divider(),
 
495
                                       # header=urwid.Divider(),
482
496
                                       header=None,
483
 
                                       footer=
484
 
                                       urwid.Divider(div_char=
485
 
                                                     self.divider)))
 
497
                                       footer=urwid.Divider(
 
498
                                           div_char=self.divider)))
486
499
        if self.log_visible:
487
500
            self.uilist.append(self.logbox)
488
501
        self.topwidget = urwid.Pile(self.uilist)
489
 
    
490
 
    def log_message(self, message):
491
 
        """Log message formatted with timestamp"""
492
 
        timestamp = datetime.datetime.now().isoformat()
493
 
        self.log_message_raw(timestamp + ": " + message)
494
 
    
495
 
    def log_message_raw(self, markup):
496
 
        """Add a log message to the log buffer."""
 
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
 
        #                 + str(self.log_visible))
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: " + self.log_wrap)
522
 
    
523
 
    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):
524
530
        """Find a client by its object path and remove it.
525
 
        
526
 
        This is connected to the ClientRemoved signal from the
 
531
 
 
532
        This is connected to the InterfacesRemoved signal from the
527
533
        Mandos server object."""
 
534
        if client_interface not in interfaces:
 
535
            # Not a Mandos client object; ignore
 
536
            return
528
537
        try:
529
538
            client = self.clients_dict[path]
530
539
        except KeyError:
531
540
            # not found?
532
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
533
 
                             .format(name, path))
 
541
            log.warning("Unknown client %s removed", path)
534
542
            return
535
543
        client.delete()
536
 
    
537
 
    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
538
554
        client_proxy_object = self.bus.get_object(self.busname, path)
539
 
        self.add_client(MandosClientWidget(server_proxy_object
540
 
                                           =self.mandos_serv,
541
 
                                           proxy_object
542
 
                                           =client_proxy_object,
543
 
                                           update_hook
544
 
                                           =self.refresh,
545
 
                                           delete_hook
546
 
                                           =self.remove_client,
547
 
                                           logger
548
 
                                           =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])),
549
561
                        path=path)
550
 
    
 
562
 
551
563
    def add_client(self, client, path=None):
552
564
        self.clients.append(client)
553
565
        if path is None:
555
567
        self.clients_dict[path] = client
556
568
        self.clients.sort(key=lambda c: c.properties["Name"])
557
569
        self.refresh()
558
 
    
 
570
 
559
571
    def remove_client(self, client, path=None):
560
572
        self.clients.remove(client)
561
573
        if path is None:
562
574
            path = client.proxy.object_path
563
575
        del self.clients_dict[path]
564
576
        self.refresh()
565
 
    
 
577
 
566
578
    def refresh(self):
567
579
        """Redraw the screen"""
568
580
        canvas = self.topwidget.render(self.size, focus=True)
569
581
        self.screen.draw_screen(self.size, canvas)
570
 
    
 
582
 
571
583
    def run(self):
572
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")
573
590
        self.bus = dbus.SystemBus()
574
591
        mandos_dbus_objc = self.bus.get_object(
575
592
            self.busname, "/", follow_name_owner_changes=True)
576
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
577
 
                                          dbus_interface
578
 
                                          = server_interface)
 
593
        self.mandos_serv = dbus.Interface(
 
594
            mandos_dbus_objc, dbus_interface=server_interface)
579
595
        try:
580
596
            mandos_clients = (self.mandos_serv
581
597
                              .GetAllClientsWithProperties())
582
598
            if not mandos_clients:
583
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
599
                log.warning("Note: Server has no clients.")
584
600
        except dbus.exceptions.DBusException:
585
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
601
            log.warning("Note: No Mandos server running.")
586
602
            mandos_clients = dbus.Dictionary()
587
 
        
 
603
 
588
604
        (self.mandos_serv
589
 
         .connect_to_signal("ClientRemoved",
 
605
         .connect_to_signal("InterfacesRemoved",
590
606
                            self.find_and_remove_client,
591
 
                            dbus_interface=server_interface,
 
607
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
592
608
                            byte_arrays=True))
593
609
        (self.mandos_serv
594
 
         .connect_to_signal("ClientAdded",
 
610
         .connect_to_signal("InterfacesAdded",
595
611
                            self.add_new_client,
596
 
                            dbus_interface=server_interface,
 
612
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
597
613
                            byte_arrays=True))
598
614
        (self.mandos_serv
599
615
         .connect_to_signal("ClientNotFound",
603
619
        for path, client in mandos_clients.items():
604
620
            client_proxy_object = self.bus.get_object(self.busname,
605
621
                                                      path)
606
 
            self.add_client(MandosClientWidget(server_proxy_object
607
 
                                               =self.mandos_serv,
608
 
                                               proxy_object
609
 
                                               =client_proxy_object,
610
 
                                               properties=client,
611
 
                                               update_hook
612
 
                                               =self.refresh,
613
 
                                               delete_hook
614
 
                                               =self.remove_client,
615
 
                                               logger
616
 
                                               =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),
617
628
                            path=path)
618
 
        
 
629
 
619
630
        self.refresh()
620
 
        self._input_callback_tag = (gobject.io_add_watch
621
 
                                    (sys.stdin.fileno(),
622
 
                                     gobject.IO_IN,
623
 
                                     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)))
624
636
        self.main_loop.run()
625
637
        # Main loop has finished, we should close everything now
626
 
        gobject.source_remove(self._input_callback_tag)
627
 
        self.screen.stop()
628
 
    
 
638
        GLib.source_remove(self._input_callback_tag)
 
639
        with warnings.catch_warnings():
 
640
            warnings.simplefilter("ignore", BytesWarning)
 
641
            self.screen.stop()
 
642
 
629
643
    def stop(self):
630
644
        self.main_loop.quit()
631
 
    
 
645
        log.removeHandler(self.loghandler)
 
646
        log.propagate = self.orig_log_propagate
 
647
 
632
648
    def process_input(self, source, condition):
633
649
        keys = self.screen.get_input()
634
 
        translations = { "ctrl n": "down",      # Emacs
635
 
                         "ctrl p": "up",        # Emacs
636
 
                         "ctrl v": "page down", # Emacs
637
 
                         "meta v": "page up",   # Emacs
638
 
                         " ": "page down",      # less
639
 
                         "f": "page down",      # less
640
 
                         "b": "page up",        # less
641
 
                         "j": "down",           # vi
642
 
                         "k": "up",             # vi
643
 
                         }
 
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
                        }
644
660
        for key in keys:
645
661
            try:
646
662
                key = translations[key]
647
663
            except KeyError:    # :-)
648
664
                pass
649
 
            
 
665
 
650
666
            if key == "q" or key == "Q":
651
667
                self.stop()
652
668
                break
653
669
            elif key == "window resize":
654
670
                self.size = self.screen.get_cols_rows()
655
671
                self.refresh()
656
 
            elif key == "\f":  # Ctrl-L
 
672
            elif key == "ctrl l":
 
673
                self.screen.clear()
657
674
                self.refresh()
658
675
            elif key == "l" or key == "D":
659
676
                self.toggle_log_display()
665
682
                if not self.log_visible:
666
683
                    self.log_visible = True
667
684
                    self.rebuild()
668
 
                self.log_message_raw(("bold",
669
 
                                      "  ".
670
 
                                      join(("q: Quit",
671
 
                                            "?: Help",
672
 
                                            "l: Log window toggle",
673
 
                                            "TAB: Switch window",
674
 
                                            "w: Wrap (log)"))))
675
 
                self.log_message_raw(("bold",
676
 
                                      "  "
677
 
                                      .join(("Clients:",
678
 
                                             "+: Enable",
679
 
                                             "-: Disable",
680
 
                                             "R: Remove",
681
 
                                             "s: Start new checker",
682
 
                                             "S: Stop checker",
683
 
                                             "C: Checker OK",
684
 
                                             "a: Approve",
685
 
                                             "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
                                   ))))
686
704
                self.refresh()
687
705
            elif key == "tab":
688
706
                if self.topwidget.get_focus() is self.logbox:
690
708
                else:
691
709
                    self.topwidget.set_focus(self.logbox)
692
710
                self.refresh()
693
 
            #elif (key == "end" or key == "meta >" or key == "G"
694
 
            #      or key == ">"):
695
 
            #    pass            # xxx end-of-buffer
696
 
            #elif (key == "home" or key == "meta <" or key == "g"
697
 
            #      or key == "<"):
698
 
            #    pass            # xxx beginning-of-buffer
699
 
            #elif key == "ctrl e" or key == "$":
700
 
            #    pass            # xxx move-end-of-line
701
 
            #elif key == "ctrl a" or key == "^":
702
 
            #    pass            # xxx move-beginning-of-line
703
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
704
 
            #    pass            # xxx left
705
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
706
 
            #    pass            # xxx right
707
 
            #elif key == "a":
708
 
            #    pass            # scroll up log
709
 
            #elif key == "z":
710
 
            #    pass            # scroll down log
 
711
            elif key == "v":
 
712
                if log.level < logging.INFO:
 
713
                    log.setLevel(logging.INFO)
 
714
                    log.info("Verbose mode: Off")
 
715
                else:
 
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
711
736
            elif self.topwidget.selectable():
712
737
                self.topwidget.keypress(self.size, key)
713
738
                self.refresh()
714
739
        return True
715
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
 
716
755
ui = UserInterface()
717
756
try:
718
757
    ui.run()
719
758
except KeyboardInterrupt:
720
 
    ui.screen.stop()
721
 
except Exception as e:
722
 
    ui.log_message(str(e))
723
 
    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()
724
766
    raise