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