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