/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: 2009-11-15 10:12:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091115101209-d0zrfwkp6u0l7v7b
* mandos (MandosServer.handle_ipc): Better log message.
  (main/MandosDBusService.ClientNotFound): Add "address" argument.
                                           All callers changed.
* mandos-monitor (MandosClientWidget.__init__): Add "logger" argument.
  (MandosClientWidget.checker_completed,
  MandosClientWidget.checker_started, MandosClientWidget.got_secret,
  MandosClientWidget.rejected): New methods, connected to signals.
  (MandosClientWidget.update): Improve display.
  (UserInterface.client_not_found): New method, conneced to signal.
  (UserInterface.log_message): New; log with timestamp.
  (UserInterface.log_message_raw): Same as old "log_message".  Bug
                                  fix; always do "refresh()".

Show diffs side-by-side

added added

removed removed

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