/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: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2009-2012 Teddy Hogeborn
7
 
# Copyright © 2009-2012 Björn Påhlsson
 
6
# Copyright © 2009-2014 Teddy Hogeborn
 
7
# Copyright © 2009-2014 Björn Påhlsson
8
8
# 
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
 
 
29
 
from future_builtins import *
 
28
try:
 
29
    from future_builtins import *
 
30
except ImportError:
 
31
    pass
30
32
 
31
33
import sys
32
34
import os
33
 
import signal
34
35
 
35
36
import datetime
36
37
 
38
39
import urwid
39
40
 
40
41
from dbus.mainloop.glib import DBusGMainLoop
41
 
import gobject
 
42
try:
 
43
    import gobject
 
44
except ImportError:
 
45
    from gi.repository import GObject as gobject
42
46
 
43
47
import dbus
44
48
 
45
 
import UserList
46
 
 
47
49
import locale
48
50
 
 
51
if sys.version_info[0] == 2:
 
52
    str = unicode
 
53
 
49
54
locale.setlocale(locale.LC_ALL, '')
50
55
 
51
56
import logging
55
60
domain = 'se.recompile'
56
61
server_interface = domain + '.Mandos'
57
62
client_interface = domain + '.Mandos.Client'
58
 
version = "1.5.5"
59
 
 
60
 
# Always run in monochrome mode
61
 
urwid.curses_display.curses.has_colors = lambda : False
62
 
 
63
 
# Urwid doesn't support blinking, but we want it.  Since we have no
64
 
# use for underline on its own, we make underline also always blink.
65
 
urwid.curses_display.curses.A_UNDERLINE |= (
66
 
    urwid.curses_display.curses.A_BLINK)
 
63
version = "1.6.6"
67
64
 
68
65
def isoformat_to_datetime(iso):
69
66
    "Parse an ISO 8601 date string to a datetime.datetime()"
164
161
                                         self.rejected,
165
162
                                         client_interface,
166
163
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
164
        self.logger('Created client {0}'
 
165
                    .format(self.properties["Name"]), level=0)
169
166
    
170
167
    def using_timer(self, flag):
171
168
        """Call this method with True or False when timer should be
182
179
    
183
180
    def checker_completed(self, exitstatus, condition, command):
184
181
        if exitstatus == 0:
 
182
            self.logger('Checker for client {0} (command "{1}")'
 
183
                        ' succeeded'.format(self.properties["Name"],
 
184
                                            command), level=0)
185
185
            self.update()
186
186
            return
187
187
        # Checker failed
206
206
        self.update()
207
207
    
208
208
    def checker_started(self, command):
209
 
        """Server signals that a checker started. This could be useful
210
 
           to log in the future. """
211
 
        #self.logger('Client {0} started checker "{1}"'
212
 
        #            .format(self.properties["Name"],
213
 
        #                    unicode(command)))
214
 
        pass
 
209
        """Server signals that a checker started."""
 
210
        self.logger('Client {0} started checker "{1}"'
 
211
                    .format(self.properties["Name"],
 
212
                            command), level=0)
215
213
    
216
214
    def got_secret(self):
217
215
        self.logger('Client {0} received its secret'
279
277
                message = "Approval in {0}. (d)eny?"
280
278
            else:
281
279
                message = "Denial in {0}. (a)pprove?"
282
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
280
            message = message.format(str(timer).rsplit(".", 1)[0])
283
281
            self.using_timer(True)
284
282
        elif self.properties["LastCheckerStatus"] != 0:
285
283
            # When checker has failed, show timer until client expires
293
291
                            datetime.timedelta())
294
292
            message = ('A checker has failed! Time until client'
295
293
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
 
294
                       .format(str(timer).rsplit(".", 1)[0]))
297
295
            self.using_timer(True)
298
296
        else:
299
297
            message = "enabled"
382
380
    def property_changed(self, property=None, **kwargs):
383
381
        """Call self.update() if old value is not new value.
384
382
        This overrides the method from MandosClientPropertyCache"""
385
 
        property_name = unicode(property)
 
383
        property_name = str(property)
386
384
        old_value = self.properties.get(property_name)
387
385
        super(MandosClientWidget, self).property_changed(
388
386
            property=property, **kwargs)
406
404
    """This is the entire user interface - the whole screen
407
405
    with boxes, lists of client widgets, etc.
408
406
    """
409
 
    def __init__(self, max_log_length=1000):
 
407
    def __init__(self, max_log_length=1000, log_level=1):
410
408
        DBusGMainLoop(set_as_default=True)
411
409
        
412
410
        self.screen = urwid.curses_display.Screen()
415
413
                ("normal",
416
414
                 "default", "default", None),
417
415
                ("bold",
418
 
                 "default", "default", "bold"),
 
416
                 "bold", "default", "bold"),
419
417
                ("underline-blink",
420
 
                 "default", "default", "underline"),
 
418
                 "underline,blink", "default", "underline,blink"),
421
419
                ("standout",
422
 
                 "default", "default", "standout"),
 
420
                 "standout", "default", "standout"),
423
421
                ("bold-underline-blink",
424
 
                 "default", "default", ("bold", "underline")),
 
422
                 "bold,underline,blink", "default", "bold,underline,blink"),
425
423
                ("bold-standout",
426
 
                 "default", "default", ("bold", "standout")),
 
424
                 "bold,standout", "default", "bold,standout"),
427
425
                ("underline-blink-standout",
428
 
                 "default", "default", ("underline", "standout")),
 
426
                 "underline,blink,standout", "default",
 
427
                 "underline,blink,standout"),
429
428
                ("bold-underline-blink-standout",
430
 
                 "default", "default", ("bold", "underline",
431
 
                                          "standout")),
 
429
                 "bold,underline,blink,standout", "default",
 
430
                 "bold,underline,blink,standout"),
432
431
                ))
433
432
        
434
433
        if urwid.supports_unicode():
449
448
        self.log = []
450
449
        self.max_log_length = max_log_length
451
450
        
 
451
        self.log_level = log_level
 
452
        
452
453
        # We keep a reference to the log widget so we can remove it
453
454
        # from the ListWalker without it getting destroyed
454
455
        self.logbox = ConstrainedListBox(self.log)
488
489
            self.uilist.append(self.logbox)
489
490
        self.topwidget = urwid.Pile(self.uilist)
490
491
    
491
 
    def log_message(self, message):
 
492
    def log_message(self, message, level=1):
 
493
        """Log message formatted with timestamp"""
 
494
        if level < self.log_level:
 
495
            return
492
496
        timestamp = datetime.datetime.now().isoformat()
493
 
        self.log_message_raw(timestamp + ": " + message)
 
497
        self.log_message_raw("{0}: {1}".format(timestamp, message),
 
498
                             level=level)
494
499
    
495
 
    def log_message_raw(self, markup):
 
500
    def log_message_raw(self, markup, level=1):
496
501
        """Add a log message to the log buffer."""
 
502
        if level < self.log_level:
 
503
            return
497
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
505
        if (self.max_log_length
499
506
            and len(self.log) > self.max_log_length):
506
513
        """Toggle visibility of the log buffer."""
507
514
        self.log_visible = not self.log_visible
508
515
        self.rebuild()
509
 
        #self.log_message("Log visibility changed to: "
510
 
        #                 + unicode(self.log_visible))
 
516
        self.log_message("Log visibility changed to: {0}"
 
517
                         .format(self.log_visible), level=0)
511
518
    
512
519
    def change_log_display(self):
513
520
        """Change type of log display.
518
525
            self.log_wrap = "clip"
519
526
        for textwidget in self.log:
520
527
            textwidget.set_wrap_mode(self.log_wrap)
521
 
        #self.log_message("Wrap mode: " + self.log_wrap)
 
528
        self.log_message("Wrap mode: {0}".format(self.log_wrap),
 
529
                         level=0)
522
530
    
523
531
    def find_and_remove_client(self, path, name):
524
532
        """Find a client by its object path and remove it.
553
561
        if path is None:
554
562
            path = client.proxy.object_path
555
563
        self.clients_dict[path] = client
556
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
564
        self.clients.sort(key=lambda c: c.properties["Name"])
557
565
        self.refresh()
558
566
    
559
567
    def remove_client(self, client, path=None):
561
569
        if path is None:
562
570
            path = client.proxy.object_path
563
571
        del self.clients_dict[path]
564
 
        if not self.clients_dict:
565
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
566
 
            # is completely emptied, we need to recreate it.
567
 
            self.clients = urwid.SimpleListWalker([])
568
 
            self.rebuild()
569
572
        self.refresh()
570
573
    
571
574
    def refresh(self):
584
587
        try:
585
588
            mandos_clients = (self.mandos_serv
586
589
                              .GetAllClientsWithProperties())
 
590
            if not mandos_clients:
 
591
                self.log_message_raw(("bold", "Note: Server has no clients."))
587
592
        except dbus.exceptions.DBusException:
 
593
            self.log_message_raw(("bold", "Note: No Mandos server running."))
588
594
            mandos_clients = dbus.Dictionary()
589
595
        
590
596
        (self.mandos_serv
602
608
                            self.client_not_found,
603
609
                            dbus_interface=server_interface,
604
610
                            byte_arrays=True))
605
 
        for path, client in mandos_clients.iteritems():
 
611
        for path, client in mandos_clients.items():
606
612
            client_proxy_object = self.bus.get_object(self.busname,
607
613
                                                      path)
608
614
            self.add_client(MandosClientWidget(server_proxy_object
673
679
                                            "?: Help",
674
680
                                            "l: Log window toggle",
675
681
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log)"))))
 
682
                                            "w: Wrap (log lines)",
 
683
                                            "v: Toggle verbose log",
 
684
                                            ))))
677
685
                self.log_message_raw(("bold",
678
686
                                      "  "
679
687
                                      .join(("Clients:",
692
700
                else:
693
701
                    self.topwidget.set_focus(self.logbox)
694
702
                self.refresh()
 
703
            elif key == "v":
 
704
                if self.log_level == 0:
 
705
                    self.log_level = 1
 
706
                    self.log_message("Verbose mode: Off")
 
707
                else:
 
708
                    self.log_level = 0
 
709
                    self.log_message("Verbose mode: On")
695
710
            #elif (key == "end" or key == "meta >" or key == "G"
696
711
            #      or key == ">"):
697
712
            #    pass            # xxx end-of-buffer
720
735
    ui.run()
721
736
except KeyboardInterrupt:
722
737
    ui.screen.stop()
723
 
except Exception, e:
724
 
    ui.log_message(unicode(e))
 
738
except Exception as e:
 
739
    ui.log_message(str(e))
725
740
    ui.screen.stop()
726
741
    raise