/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: 2012-05-07 20:46:51 UTC
  • Revision ID: teddy@recompile.se-20120507204651-qx5o5ztwmau54mh4
* mandos-monitor: Speedup: Use properties from D-Bus
                  GetAllClientsWithProperties() call.  Also use
                  super() properly - only use keyword arguments and
                  strip them off as "kwargs" is passed on.
  (MandosClientPropertyCache.__init__): Take new "properties"
                                        argument; use it to skip
                                        calling D-Bus GetAll() method.
                                        Call super().  Bind self._
  (MandosClientPropertyCache._property_changed): New helper function.
  (MandosClientPropertyCache.property_changed): Changed to take
                                                keyword arguments.
  (MandosClientPropertyCache.delete): Bug fix: Don't call
                                      super().__init__().
  (MandosClientWidget.__init__): Don't take *args.  Strip used keyword
                                 arguments before calling super().
  (MandosClientWidget.property_changed): Removed dead code.
  (MandosClientWidget.delete): Don't take *args.
  (MandosClientWidget.property_changed): Don't take "value" argument,
                                         since it is not used.
  (ConstrainedListBox.keypress): Take *args, **kwargs and pass them on
                                 to super().

Show diffs side-by-side

added added

removed removed

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