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