/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: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

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