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