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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2018-2020 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2015, 2018 Attila Molnar <attilamolnar@hush.com>
*
* This file is part of InspIRCd. InspIRCd 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, version 2.
*
* 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/>.
*/
#pragma once
namespace Events
{
class ModuleEventListener;
class ModuleEventProvider;
}
/** Provider of one or more cross-module events.
* Modules who wish to provide events for other modules create instances of this class and use
* one of the macros below to fire the event, passing the instance of the event provider class
* to the macro.
* Event providers are identified using a unique identifier string.
*/
class Events::ModuleEventProvider : public ServiceProvider, private dynamic_reference_base::CaptureHook
{
public:
struct Comp
{
bool operator()(ModuleEventListener* lhs, ModuleEventListener* rhs) const;
};
struct ElementComp
{
bool operator()(ModuleEventListener* lhs, ModuleEventListener* rhs) const;
};
typedef insp::flat_multiset<ModuleEventListener*, Comp, ElementComp> SubscriberList;
/** Constructor
* @param mod Module providing the event(s)
* @param eventid Identifier of the event or event group provided, must be unique
*/
ModuleEventProvider(Module* mod, const std::string& eventid)
: ServiceProvider(mod, eventid, SERVICE_DATA)
, prov(mod, eventid)
{
prov.SetCaptureHook(this);
}
/** Retrieves the module which created this listener. */
const Module* GetModule() const { return prov.creator; }
/** Get list of objects subscribed to this event
* @return List of subscribed objects
*/
const SubscriberList& GetSubscribers() const { return prov->subscribers; }
/** Subscribes a listener to this event.
* @param subscriber The listener to subscribe.
*/
void Subscribe(ModuleEventListener* subscriber)
{
subscribers.insert(subscriber);
OnSubscribe(subscriber);
}
/** Unsubscribes a listener from this event.
* @param subscriber The listener to unsubscribe.
*/
void Unsubscribe(ModuleEventListener* subscriber)
{
subscribers.erase(subscriber);
OnUnsubscribe(subscriber);
}
private:
void OnCapture() CXX11_OVERRIDE
{
// If someone else holds the list from now on, clear mine. See below for more info.
if (*prov != this)
subscribers.clear();
}
/** Called when a listener subscribes to this event.
* @param subscriber The listener which subscribed.
*/
virtual void OnSubscribe(ModuleEventListener* subscriber) { }
/** Called when a listener unsubscribes from this event.
* @param subscriber The listener which unsubscribed.
*/
virtual void OnUnsubscribe(ModuleEventListener* subscriber) { }
/** Reference to the active provider for this event. In case multiple event providers
* exist for the same event, only one of them contains the list of subscribers.
* To handle the case when we are not the ones with the list, we get it from the provider
* where the dynref points to.
*/
dynamic_reference_nocheck<ModuleEventProvider> prov;
/** List of objects subscribed to the event(s) provided by us, or empty if multiple providers
* exist with the same name and we are not the ones holding the list.
*/
SubscriberList subscribers;
};
/** Base class for abstract classes describing cross-module events.
* Subscribers should NOT inherit directly from this class.
*/
class Events::ModuleEventListener : private dynamic_reference_base::CaptureHook
{
/** Reference to the provider, can be NULL if none of the provider modules are loaded
*/
dynamic_reference_nocheck<ModuleEventProvider> prov;
const unsigned int eventpriority;
/** Called by the dynref when the event provider becomes available
*/
void OnCapture() CXX11_OVERRIDE
{
prov->Subscribe(this);
}
public:
static const unsigned int DefaultPriority = 100;
/** Constructor
* @param mod Module subscribing
* @param eventid Identifier of the event to subscribe to
* @param eventprio The priority to give this event listener
*/
ModuleEventListener(Module* mod, const std::string& eventid, unsigned int eventprio = DefaultPriority)
: prov(mod, eventid)
, eventpriority(eventprio)
{
prov.SetCaptureHook(this);
// If the dynamic_reference resolved at construction our capture handler wasn't called
if (prov)
ModuleEventListener::OnCapture();
}
~ModuleEventListener()
{
if (prov)
prov->Unsubscribe(this);
}
/** Retrieves the module which created this listener. */
const Module* GetModule() const { return prov.creator; }
/** Retrieves the priority of this event. */
unsigned int GetPriority() const { return eventpriority; }
};
inline bool Events::ModuleEventProvider::Comp::operator()(Events::ModuleEventListener* lhs, Events::ModuleEventListener* rhs) const
{
return (lhs->GetPriority() < rhs->GetPriority());
}
inline bool Events::ModuleEventProvider::ElementComp::operator()(Events::ModuleEventListener* lhs, Events::ModuleEventListener* rhs) const
{
if (lhs->GetPriority() < rhs->GetPriority())
return true;
if (lhs->GetPriority() > rhs->GetPriority())
return false;
return std::less<ModuleEventListener*>()(lhs, rhs);
}
/**
* Run the given hook provided by a module
*
* FOREACH_MOD_CUSTOM(accountevprov, AccountEventListener, OnAccountChange, MOD_RESULT, (user, newaccount))
*/
#define FOREACH_MOD_CUSTOM(prov, listenerclass, func, params) do { \
if (!(prov).GetModule() || !(prov).GetModule()->dying) \
{ \
const ::Events::ModuleEventProvider::SubscriberList& _handlers = (prov).GetSubscribers(); \
for (::Events::ModuleEventProvider::SubscriberList::const_iterator _i = _handlers.begin(); _i != _handlers.end(); ++_i) \
{ \
listenerclass* _t = static_cast<listenerclass*>(*_i); \
const Module* _m = _t->GetModule(); \
if (_m && !_m->dying) \
_t->func params ; \
} \
} \
} while (0);
/**
* Run the given hook provided by a module until some module returns MOD_RES_ALLOW or MOD_RES_DENY.
* If no module does that, result is set to MOD_RES_PASSTHRU.
*
* Example: ModResult MOD_RESULT;
* FIRST_MOD_RESULT_CUSTOM(httpevprov, HTTPRequestEventListener, OnHTTPRequest, MOD_RESULT, (request));
*/
#define FIRST_MOD_RESULT_CUSTOM(prov, listenerclass, func, result, params) do { \
result = MOD_RES_PASSTHRU; \
if (!(prov).GetModule() || !(prov).GetModule()->dying) \
{ \
const ::Events::ModuleEventProvider::SubscriberList& _handlers = (prov).GetSubscribers(); \
for (::Events::ModuleEventProvider::SubscriberList::const_iterator _i = _handlers.begin(); _i != _handlers.end(); ++_i) \
{ \
listenerclass* _t = static_cast<listenerclass*>(*_i); \
const Module* _m = _t->GetModule(); \
if (!_m || _m->dying) \
continue; \
result = _t->func params ; \
if (result != MOD_RES_PASSTHRU) \
break; \
} \
} \
} while (0);
|
