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