/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

* mandos-monitor: Speedup: Use properties from D-Bus
                  GetAllClientsWithProperties() call.  Also use
                  super() properly - only use keyword arguments and
                  strip them off as "kwargs" is passed on.
  (MandosClientPropertyCache.__init__): Take new "properties"
                                        argument; use it to skip
                                        calling D-Bus GetAll() method.
                                        Call super().  Bind self._
  (MandosClientPropertyCache._property_changed): New helper function.
  (MandosClientPropertyCache.property_changed): Changed to take
                                                keyword arguments.
  (MandosClientPropertyCache.delete): Bug fix: Don't call
                                      super().__init__().
  (MandosClientWidget.__init__): Don't take *args.  Strip used keyword
                                 arguments before calling super().
  (MandosClientWidget.property_changed): Removed dead code.
  (MandosClientWidget.delete): Don't take *args.
  (MandosClientWidget.property_changed): Don't take "value" argument,
                                         since it is not used.
  (ConstrainedListBox.keypress): Take *args, **kwargs and pass them on
                                 to super().

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
17
17
#     GNU General Public License for more details.
18
18
# 
19
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/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
from future_builtins import *
 
30
 
28
31
import sys
29
32
import os
30
33
import signal
83
86
    properties and calls a hook function when any of them are
84
87
    changed.
85
88
    """
86
 
    def __init__(self, proxy_object=None, *args, **kwargs):
 
89
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
91
        self.properties = dict() if properties is None else properties
90
92
        self.property_changed_match = (
91
93
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
94
                                         self._property_changed,
93
95
                                         client_interface,
94
96
                                         byte_arrays=True))
95
97
        
96
 
        self.properties.update(
97
 
            self.proxy.GetAll(client_interface,
98
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
99
 
 
100
 
        #XXX This breaks good super behaviour
101
 
#        super(MandosClientPropertyCache, self).__init__(
102
 
#            *args, **kwargs)
 
98
        if properties is None:
 
99
            self.properties.update(
 
100
                self.proxy.GetAll(client_interface,
 
101
                                  dbus_interface
 
102
                                  = dbus.PROPERTIES_IFACE))
 
103
        
 
104
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
105
    
 
106
    def _property_changed(self, property, value):
 
107
        """Helper which takes positional arguments"""
 
108
        return self.property_changed(property=property, value=value)
103
109
    
104
110
    def property_changed(self, property=None, value=None):
105
111
        """This is called whenever we get a PropertyChanged signal
108
114
        # Update properties dict with new value
109
115
        self.properties[property] = value
110
116
    
111
 
    def delete(self, *args, **kwargs):
 
117
    def delete(self):
112
118
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
119
 
116
120
 
117
121
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
123
    """
120
124
    
121
125
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
126
                 delete_hook=None, logger=None, **kwargs):
123
127
        # Called on update
124
128
        self.update_hook = update_hook
125
129
        # Called on delete
136
140
        self._text_widget = urwid.Text("")
137
141
        # The widget shown when we have focus
138
142
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(
140
 
            update_hook=update_hook, delete_hook=delete_hook,
141
 
            *args, **kwargs)
 
143
        super(MandosClientWidget, self).__init__(**kwargs)
142
144
        self.update()
143
145
        self.opened = False
144
146
        
172
174
                                         self.rejected,
173
175
                                         client_interface,
174
176
                                         byte_arrays=True))
175
 
        #self.logger('Created client %s' % (self.properties["Name"]))
 
177
        #self.logger('Created client {0}'
 
178
        #            .format(self.properties["Name"]))
176
179
    
177
180
    def property_changed(self, property=None, value=None):
178
181
        super(self, MandosClientWidget).property_changed(property,
181
184
            using_timer(bool(value))
182
185
        if property == "LastCheckerStatus":
183
186
            using_timer(value != 0)
184
 
            #self.logger('Checker for client %s (command "%s")'
185
 
            #            ' was successful'
186
 
            #            % (self.properties["Name"], command))
 
187
            #self.logger('Checker for client {0} (command "{1}") was '
 
188
            #            ' successful'.format(self.properties["Name"],
 
189
            #                                 command))
187
190
    
188
191
    def using_timer(self, flag):
189
192
        """Call this method with True or False when timer should be
209
212
            return
210
213
        # Checker failed
211
214
        if os.WIFEXITED(condition):
212
 
            self.logger('Checker for client %s (command "%s")'
213
 
                        ' failed with exit code %s'
214
 
                        % (self.properties["Name"], command,
215
 
                           os.WEXITSTATUS(condition)))
 
215
            self.logger('Checker for client {0} (command "{1}")'
 
216
                        ' failed with exit code {2}'
 
217
                        .format(self.properties["Name"], command,
 
218
                                os.WEXITSTATUS(condition)))
216
219
        elif os.WIFSIGNALED(condition):
217
 
            self.logger('Checker for client %s (command "%s")'
218
 
                        ' was killed by signal %s'
219
 
                        % (self.properties["Name"], command,
220
 
                           os.WTERMSIG(condition)))
 
220
            self.logger('Checker for client {0} (command "{1}") was'
 
221
                        ' killed by signal {2}'
 
222
                        .format(self.properties["Name"], command,
 
223
                                os.WTERMSIG(condition)))
221
224
        elif os.WCOREDUMP(condition):
222
 
            self.logger('Checker for client %s (command "%s")'
 
225
            self.logger('Checker for client {0} (command "{1}")'
223
226
                        ' dumped core'
224
 
                        % (self.properties["Name"], command))
 
227
                        .format(self.properties["Name"], command))
225
228
        else:
226
 
            self.logger('Checker for client %s completed'
227
 
                        ' mysteriously')
 
229
            self.logger('Checker for client {0} completed'
 
230
                        ' mysteriously'
 
231
                        .format(self.properties["Name"]))
228
232
        self.update()
229
233
    
230
234
    def checker_started(self, command):
231
235
        """Server signals that a checker started. This could be useful
232
236
           to log in the future. """
233
 
        #self.logger('Client %s started checker "%s"'
234
 
        #            % (self.properties["Name"], unicode(command)))
 
237
        #self.logger('Client {0} started checker "{1}"'
 
238
        #            .format(self.properties["Name"],
 
239
        #                    unicode(command)))
235
240
        pass
236
241
    
237
242
    def got_secret(self):
238
 
        self.logger('Client %s received its secret'
239
 
                    % self.properties["Name"])
 
243
        self.logger('Client {0} received its secret'
 
244
                    .format(self.properties["Name"]))
240
245
    
241
246
    def need_approval(self, timeout, default):
242
247
        if not default:
243
 
            message = 'Client %s needs approval within %s seconds'
 
248
            message = 'Client {0} needs approval within {1} seconds'
244
249
        else:
245
 
            message = 'Client %s will get its secret in %s seconds'
246
 
        self.logger(message
247
 
                    % (self.properties["Name"], timeout/1000))
 
250
            message = 'Client {0} will get its secret in {1} seconds'
 
251
        self.logger(message.format(self.properties["Name"],
 
252
                                   timeout/1000))
248
253
        self.using_timer(True)
249
254
    
250
255
    def rejected(self, reason):
251
 
        self.logger('Client %s was rejected; reason: %s'
252
 
                    % (self.properties["Name"], reason))
 
256
        self.logger('Client {0} was rejected; reason: {1}'
 
257
                    .format(self.properties["Name"], reason))
253
258
    
254
259
    def selectable(self):
255
260
        """Make this a "selectable" widget.
281
286
        # Rebuild focus and non-focus widgets using current properties
282
287
 
283
288
        # Base part of a client. Name!
284
 
        base = ('%(name)s: '
285
 
                      % {"name": self.properties["Name"]})
 
289
        base = '{name}: '.format(name=self.properties["Name"])
286
290
        if not self.properties["Enabled"]:
287
291
            message = "DISABLED"
288
292
        elif self.properties["ApprovalPending"]:
297
301
            else:
298
302
                timer = datetime.timedelta()
299
303
            if self.properties["ApprovedByDefault"]:
300
 
                message = "Approval in %s. (d)eny?"
 
304
                message = "Approval in {0}. (d)eny?"
301
305
            else:
302
 
                message = "Denial in %s. (a)pprove?"
303
 
            message = message % unicode(timer).rsplit(".", 1)[0]
 
306
                message = "Denial in {0}. (a)pprove?"
 
307
            message = message.format(unicode(timer).rsplit(".", 1)[0])
304
308
        elif self.properties["LastCheckerStatus"] != 0:
305
 
            # When checker has failed, print a timer until client expires
 
309
            # When checker has failed, show timer until client expires
306
310
            expires = self.properties["Expires"]
307
311
            if expires == "":
308
312
                timer = datetime.timedelta(0)
309
313
            else:
310
 
                expires = datetime.datetime.strptime(expires,
311
 
                                                     '%Y-%m-%dT%H:%M:%S.%f')
 
314
                expires = (datetime.datetime.strptime
 
315
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
312
316
                timer = expires - datetime.datetime.utcnow()
313
317
            message = ('A checker has failed! Time until client'
314
 
                       ' gets disabled: %s'
315
 
                           % unicode(timer).rsplit(".", 1)[0])
 
318
                       ' gets disabled: {0}'
 
319
                       .format(unicode(timer).rsplit(".", 1)[0]))
316
320
        else:
317
321
            message = "enabled"
318
 
        self._text = "%s%s" % (base, message)
 
322
        self._text = "{0}{1}".format(base, message)
319
323
            
320
324
        if not urwid.supports_unicode():
321
325
            self._text = self._text.encode("ascii", "replace")
339
343
        self.update()
340
344
        return True             # Keep calling this
341
345
    
342
 
    def delete(self, *args, **kwargs):
 
346
    def delete(self, **kwargs):
343
347
        if self._update_timer_callback_tag is not None:
344
348
            gobject.source_remove(self._update_timer_callback_tag)
345
349
            self._update_timer_callback_tag = None
348
352
        self.match_objects = ()
349
353
        if self.delete_hook is not None:
350
354
            self.delete_hook(self)
351
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
355
        return super(MandosClientWidget, self).delete(**kwargs)
352
356
    
353
357
    def render(self, maxcolrow, focus=False):
354
358
        """Render differently if we have focus.
396
400
        else:
397
401
            return key
398
402
    
399
 
    def property_changed(self, property=None, value=None,
400
 
                         *args, **kwargs):
 
403
    def property_changed(self, property=None, **kwargs):
401
404
        """Call self.update() if old value is not new value.
402
405
        This overrides the method from MandosClientPropertyCache"""
403
406
        property_name = unicode(property)
404
407
        old_value = self.properties.get(property_name)
405
408
        super(MandosClientWidget, self).property_changed(
406
 
            property=property, value=value, *args, **kwargs)
 
409
            property=property, **kwargs)
407
410
        if self.properties.get(property_name) != old_value:
408
411
            self.update()
409
412
 
413
416
    "down" key presses, thus not allowing any containing widgets to
414
417
    use them as an excuse to shift focus away from this widget.
415
418
    """
416
 
    def keypress(self, maxcolrow, key):
417
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
419
    def keypress(self, *args, **kwargs):
 
420
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
418
421
        if ret in ("up", "down"):
419
422
            return
420
423
        return ret
486
489
        self.main_loop = gobject.MainLoop()
487
490
    
488
491
    def client_not_found(self, fingerprint, address):
489
 
        self.log_message(("Client with address %s and fingerprint %s"
490
 
                          " could not be found" % (address,
491
 
                                                    fingerprint)))
 
492
        self.log_message("Client with address {0} and fingerprint"
 
493
                         " {1} could not be found"
 
494
                         .format(address, fingerprint))
492
495
    
493
496
    def rebuild(self):
494
497
        """This rebuilds the User Interface.
547
550
            client = self.clients_dict[path]
548
551
        except KeyError:
549
552
            # not found?
550
 
            self.log_message("Unknown client %r (%r) removed", name,
551
 
                             path)
 
553
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
554
                             .format(name, path))
552
555
            return
553
556
        client.delete()
554
557
    
635
638
                                               logger
636
639
                                               =self.log_message),
637
640
                            path=path)
638
 
 
 
641
        
639
642
        self.refresh()
640
643
        self._input_callback_tag = (gobject.io_add_watch
641
644
                                    (sys.stdin.fileno(),