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