/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: 2024-11-22 20:28:54 UTC
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(Thanks to an anonymous contributor for reporting this.)

Show diffs side-by-side

added added

removed removed

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