/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: 2019-11-03 18:44:41 UTC
  • Revision ID: teddy@recompile.se-20191103184441-1vhjuf06hjqgfohh
mandos-monitor: Use Python's standard loggging module

* mandos-monitor: Use Python's standard loggging module, also for
                  warnings.  Suppress BytesWarning from urwid when
                  exiting.
  (log): New global logger object.  This replaces UserInterface
        log_message().
  (MandosClientWidget.__init__): Remove "logger" argument.
  (MandosClientWidget.using_timer): Wrap self.update_timer using new
                                    glib_safely() function.
  (glib_safely): New function to log any exceptions instead of letting
                 exceptions propagate up to GLib.
  (UserInterface.__init__): Remove "log_level" argument.  Set new
                            "loghandler" attribute, instance of new
                            "UILogHandler".
  (UserInterface.log_message): Removed.
  (UserInterface.log_message_raw): Renamed to "add_log_line"; all
                                   callers changed.  Also fix
                                   off-by-one error in max_log_length
                                   logic.
  (UserInterface.run): Add self.loghandler to logger "log". Wrap
                       self.process_input using new glib_safely()
                       function.
  (UserInterface.stop): Remove self.loghandler from logger "log".
  (UserInterface.process_input): Make verbosity toggle affect log
                                 level of logger "log".
  (UILogHandler): New.

Show diffs side-by-side

added added

removed removed

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