/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-01-15 20:55:50 UTC
  • Revision ID: teddy@recompile.se-20120115205550-i9dfhet4qjcroxru
Use the new Client.LastCheckerStatus property.
* mandos-monitor (MandosClientWidget.last_checker_failed): Removed.
  (MandosClientWidget.property_changed): Check for LastCheckerStatus
                                         and enable timer if failure
                                         is indicated.
  (MandosClientWidget.update): Use LastCheckerStatus property instead
                               of last_checker_failed.

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