aboutsummaryrefslogtreecommitdiff
path: root/src/EventManager.py
blob: e322004e687ea80e5ee1da7c6d0b3e6eb3679f5a (about) (plain) (blame)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
import itertools, time, traceback
from src import Utils

PRIORITY_URGENT = 0
PRIORITY_HIGH = 1
PRIORITY_MEDIUM = 2
PRIORITY_LOW = 3
PRIORITY_MONITOR = 4

DEFAULT_PRIORITY = PRIORITY_MEDIUM
DEFAULT_EVENT_DELIMITER = "."
DEFAULT_MULTI_DELIMITER = "|"

class Event(object):
    def __init__(self, name, **kwargs):
        self.name = name
        self.kwargs = kwargs
        self.eaten = False
    def __getitem__(self, key):
        return self.kwargs[key]
    def get(self, key, default=None):
        return self.kwargs.get(key, default)
    def __contains__(self, key):
        return key in self.kwargs
    def eat(self):
        self.eaten = True

class EventCallback(object):
    def __init__(self, function, priority, kwargs):
        self.function = function
        self.priority = priority
        self.kwargs = kwargs
        self.docstring = Utils.parse_docstring(function.__doc__)

    def call(self, event):
        return self.function(event)

    def get_kwarg(self, name, default=None):
        item = self.kwargs.get(name, default)
        return item or self.docstring.items.get(name, default)

class MultipleEventHook(object):
    def __init__(self):
        self._event_hooks = set([])
    def _add(self, event_hook):
        self._event_hooks.add(event_hook)

    def hook(self, function, **kwargs):
        for event_hook in self._event_hooks:
            event_hook.hook(function, **kwargs)

    def call_limited(self, maximum, **kwargs):
        returns = []
        for event_hook in self._event_hooks:
            returns.append(event_hook.call_limited(maximum, **kwargs))
        return returns
    def call(self, **kwargs):
        returns = []
        for event_hook in self._event_hooks:
            returns.append(event_hook.call(**kwargs))
        return returns

class EventHookContext(object):
    def __init__(self, parent, context):
        self._parent = parent
        self.context = context
    def hook(self, function, priority=DEFAULT_PRIORITY, replay=False,
            **kwargs):
        return self._parent._context_hook(self.context, function, priority,
            replay, kwargs)
    def unhook(self, callback):
        self._parent.unhook(callback)

    def on(self, subevent, *extra_subevents,
            delimiter=DEFAULT_EVENT_DELIMITER):
        return self._parent._context_on(self.context, subevent,
            extra_subevents, delimiter)

    def call_for_result(self, default=None, **kwargs):
        return self._parent.call_for_result(default, **kwargs)
    def assure_call(self, **kwargs):
        self._parent.assure_call(**kwargs)
    def call(self, **kwargs):
        return self._parent.call(**kwargs)
    def call_limited(self, maximum, **kwargs):
        return self._parent.call_limited(maximum, **kwargs)

    def call_unsafe_for_result(self, default=None, **kwargs):
        return self._parent.call_unsafe_for_result(default, **kwargs)
    def call_unsafe(self, **kwargs):
        return self._parent.call_unsafe(**kwargs)
    def call_unsafe_limited(self, maximum, **kwargs):
        return self._parent.call_unsafe_limited(maximum, **kwargs)

    def get_hooks(self):
        return self._parent.get_hooks()
    def get_children(self):
        return self._parent.get_children()

class EventHook(object):
    def __init__(self, log, name=None, parent=None):
        self.log = log
        self.name = name
        self.parent = parent
        self._children = {}
        self._hooks = []
        self._stored_events = []
        self._context_hooks = {}

    def _make_event(self, kwargs):
        return Event(self._get_path(), **kwargs)

    def _get_path(self):
        path = []
        parent = self
        while not parent == None and not parent.name == None:
            path.append(parent.name)
            parent = parent.parent
        return DEFAULT_EVENT_DELIMITER.join(path[::-1])

    def new_context(self, context):
        return EventHookContext(self, context)

    def hook(self, function, priority=DEFAULT_PRIORITY, replay=False,
            **kwargs):
        return self._hook(function, None, priority, replay, kwargs)
    def _context_hook(self, context, function, priority, replay, kwargs):
        return self._hook(function, context, priority, replay, kwargs)
    def _hook(self, function, context, priority, replay, kwargs):
        callback = EventCallback(function, priority, kwargs)

        if context == None:
            self._hooks.append(callback)
        else:
            if not context in self._context_hooks:
                self._context_hooks[context] = []
            self._context_hooks[context].append(callback)

        if replay and not self._stored_events == None:
            for kwargs in self._stored_events:
                self._call(kwargs, True, None)
        self._stored_events = None
        return callback

    def unhook(self, callback):
        if callback in self._hooks:
            self._hooks.remove(callback)

        empty = []
        for context, hooks in self._context_hooks.items():
            if callback in hooks:
                hooks.remove(callback)
                if not hooks:
                    empty.append(context)
        for context in empty:
            del self._context_hooks[context]

    def _make_multiple_hook(self, source, context, events):
        multiple_event_hook = MultipleEventHook()
        for event in events:
            event_hook = source.get_child(event)
            if not context == None:
                event_hook = event_hook.new_context(context)
            multiple_event_hook._add(event_hook)
        return multiple_event_hook

    def on(self, subevent, *extra_subevents,
            delimiter=DEFAULT_EVENT_DELIMITER):
        return self._on(subevent, extra_subevents, None, delimiter)
    def _context_on(self, context, subevent, extra_subevents,
            delimiter=DEFAULT_EVENT_DELIMITER):
        return self._on(subevent, extra_subevents, context, delimiter)
    def _on(self, subevent, extra_subevents, context, delimiter):
        if delimiter in subevent:
            event_chain = subevent.split(delimiter)
            event_obj = self
            for event_name in event_chain:
                if DEFAULT_MULTI_DELIMITER in event_name:
                    return self._make_multiple_hook(event_obj, context,
                        event_name.split(DEFAULT_MULTI_DELIMITER))

                event_obj = event_obj.get_child(event_name)
            if not context == None:
                return event_obj.new_context(context)
            return event_obj

        if extra_subevents:
            return self._make_multiple_hook(self, context,
                (subevent,)+extra_subevents)

        child = self.get_child(subevent)
        if not context == None:
            child = child.new_context(context)
        return child

    def call_for_result(self, default=None, **kwargs):
        return (self.call_limited(1, **kwargs) or [default])[0]
    def assure_call(self, **kwargs):
        if not self._stored_events == None:
            self._stored_events.append(kwargs)
        else:
            self._call(kwargs, True, None)
    def call(self, **kwargs):
        return self._call(kwargs, True, None)
    def call_limited(self, maximum, **kwargs):
        return self._call(kwargs, True, None)

    def call_unsafe_for_result(self, default=None, **kwargs):
        return (self.call_unsafe_limited(1, **kwargs) or [default])[0]
    def call_unsafe(self, **kwargs):
        return self._call(kwargs, False, None)
    def call_unsafe_limited(self, maximum, **kwargs):
        return self._call(kwargs, False, maximum)

    def _call(self, kwargs, safe, maximum):
        event_path = self._get_path()
        self.log.trace("calling event: \"%s\" (params: %s)",
            [event_path, kwargs])
        start = time.monotonic()

        event = self._make_event(kwargs)
        returns = []
        for hook in self.get_hooks()[:maximum]:
            if event.eaten:
                break
            try:
                returns.append(hook.call(event))
            except Exception as e:
                self.log.error("failed to call event \"%s\"",
                    [self._get_path()], exc_info=True)
                if not safe:
                    raise

        total_milliseconds = (time.monotonic() - start) * 1000
        self.log.trace("event \"%s\" called in %fms", [
            event_path, total_milliseconds])

        self.check_purge()

        return returns

    def get_child(self, child_name):
        child_name_lower = child_name.lower()
        if not child_name_lower in self._children:
            self._children[child_name_lower] = EventHook(self.log,
                child_name_lower, self)
        return self._children[child_name_lower]
    def remove_child(self, child_name):
        child_name_lower = child_name.lower()
        if child_name_lower in self._children:
            del self._children[child_name_lower]

    def check_purge(self):
        if self.is_empty() and not self.parent == None:
            self.parent.remove_child(self.name)
            self.parent.check_purge()

    def remove_context(self, context):
        del self._context_hooks[context]
    def has_context(self, context):
        return context in self._context_hooks
    def purge_context(self, context):
        if self.has_context(context):
            self.remove_context(context)

        for child_name in self.get_children()[:]:
            child = self.get_child(child_name)
            child.purge_context(context)

    def get_hooks(self):
        return sorted(self._hooks + sum(self._context_hooks.values(), []),
            key=lambda e: e.priority)
    def get_children(self):
        return list(self._children.keys())
    def is_empty(self):
        return len(self.get_hooks() + self.get_children()) == 0