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