[feature] HookableService
[leap_pycommon.git] / src / leap / common / service_hooks.py
1 # -*- coding: utf-8 -*-
2 # service_hooks.py
3 # Copyright (C) 2016 LEAP
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 """
18 Hooks for service composition.
19 """
20 from collections import defaultdict
21
22 from twisted.application.service import IService, Service
23 from twisted.python import log
24
25 from zope.interface import implementer
26
27
28 @implementer(IService)
29 class HookableService(Service):
30
31     """
32     This service allows for other services in a Twisted Service tree to be
33     notified whenever a certain kind of hook is triggered.
34
35     During the service composition, one is expected to register
36     a hook name with the name of the service that wants to react to the
37     triggering of the hook. All the services, both hooked and listeners, should
38     be registered against the same parent service.
39
40     Upon the hook being triggered, the method "hook_<name>" will be called with
41     the passed data in the listener service.
42     """
43
44     def register_hook(self, name, listener):
45         if not hasattr(self, 'event_listeners'):
46             self.event_listeners = defaultdict(list)
47         log.msg("Registering hook %s->%s" % (name, listener))
48         self.event_listeners[name].append(listener)
49
50     def trigger_hook(self, name, **data):
51
52         def react_to_hook(listener, name, **kw):
53             try:
54                 getattr(listener, 'hook_' + name)(**kw)
55             except AttributeError:
56                 raise RuntimeError(
57                     "Tried to notify a hook, but the listener service class %s"
58                     "has not defined the proper method" % listener.__class__)
59
60         if not hasattr(self, 'event_listeners'):
61             self.event_listeners = defaultdict(list)
62         listeners = self._get_listener_services(name)
63
64         for listener in listeners:
65             react_to_hook(listener, name, **data)
66
67     def _get_sibling_service(self, name):
68         return self.parent.getServiceNamed(name)
69
70     def _get_listener_services(self, hook):
71         if hook in self.event_listeners:
72             service_names = self.event_listeners[hook]
73             services = [
74                 self._get_sibling_service(name) for name in service_names]
75             return services