/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-03 19:06:02 UTC
  • Revision ID: teddy@recompile.se-20120503190602-uqghef5rbpqdvybx
* mandos-monitor: Use new string format method.

Show diffs side-by-side

added added

removed removed

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