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