/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

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