/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: 2011-03-08 19:09:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110308190903-j499ebtb9bpk31ar
* INSTALL: Updated.

Show diffs side-by-side

added added

removed removed

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