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