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
/************************************************************************
* UnrealIRCd - Unreal Internet Relay Chat Daemon - src/api-rpc.c
* (c) 2022- Bram Matthys and The UnrealIRCd Team
* License: GPLv2 or later
*/
/** @file
* @brief RPC API
*/
#include "unrealircd.h"
/** This is the RPC API used for web requests.
* For an overview of available RPC's (not the API)
* see https://www.unrealircd.org/docs/RPC
* @defgroup RPCAPI RPC API
* @{
*/
/** List of RPC handlers */
MODVAR RPCHandler *rpchandlers = NULL;
/* Forward declarations */
static void unload_rpc_handler_commit(RPCHandler *m);
/** Adds a new RPC handler.
* @param module The module which owns this RPC handler.
* @param mreq The details of the request such as the method name, callback, etc.
* @return Returns the handle to the RPC handler if successful, otherwise NULL.
* The module's error code contains specific information about the
* error.
*/
RPCHandler *RPCHandlerAdd(Module *module, RPCHandlerInfo *mreq)
{
RPCHandler *m;
ModuleObject *mobj;
/* Some consistency checks to avoid a headache for module devs later on: */
if (!mreq->method || !mreq->call)
{
unreal_log(ULOG_ERROR, "module", "RPCHANDLERADD_API_ERROR", NULL,
"RPCHandlerAdd() from module $module_name: "
"Missing required fields.",
log_data_string("module_name", module->header->name));
abort();
}
m = RPCHandlerFind(mreq->method);
if (m)
{
if (m->unloaded)
{
m->unloaded = 0;
} else {
if (module)
module->errorcode = MODERR_EXISTS;
return NULL;
}
} else {
/* New RPC handler */
m = safe_alloc(sizeof(RPCHandler));
safe_strdup(m->method, mreq->method);
AddListItem(m, rpchandlers);
}
/* Add or update the following fields: */
m->owner = module;
m->flags = mreq->flags;
m->loglevel = mreq->loglevel;
if (!valid_loglevel(m->loglevel))
m->loglevel = ULOG_INFO;
m->call = mreq->call;
/* Add module object */
mobj = safe_alloc(sizeof(ModuleObject));
mobj->type = MOBJ_RPC;
mobj->object.rpc = m;
AddListItem(mobj, module->objects);
module->errorcode = MODERR_NOERROR;
return m;
}
/** Returns the RPC handler for the given method name.
* @param method The method to search for.
* @return Returns the handle to the RPC handler,
* or NULL if not found.
*/
RPCHandler *RPCHandlerFind(const char *method)
{
RPCHandler *m;
for (m = rpchandlers; m; m = m->next)
{
if (!strcasecmp(method, m->method))
return m;
}
return NULL;
}
/** Remove the specified RPC handler - modules should not call this.
* This is done automatically for modules on unload, so is only called internally.
* @param m The PRC handler to remove.
*/
void RPCHandlerDel(RPCHandler *m)
{
if (m->owner)
{
ModuleObject *mobj;
for (mobj = m->owner->objects; mobj; mobj = mobj->next) {
if (mobj->type == MOBJ_RPC && mobj->object.rpc == m)
{
DelListItem(mobj, m->owner->objects);
safe_free(mobj);
break;
}
}
m->owner = NULL;
}
if (loop.rehashing)
m->unloaded = 1;
else
unload_rpc_handler_commit(m);
}
/** @} */
static void unload_rpc_handler_commit(RPCHandler *m)
{
/* This is an unusual operation, I think we should log it. */
unreal_log(ULOG_INFO, "module", "UNLOAD_RPC_HANDLER", NULL,
"Unloading RPC handler for '$method'",
log_data_string("method", m->method));
/* Destroy the object */
DelListItem(m, rpchandlers);
safe_free(m->method);
safe_free(m);
}
void unload_all_unused_rpc_handlers(void)
{
RPCHandler *m, *m_next;
for (m = rpchandlers; m; m = m_next)
{
m_next = m->next;
if (m->unloaded)
unload_rpc_handler_commit(m);
}
}
|
