/mandos/trunk

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