]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * charybdis: An advanced ircd. | |
3 | * m_list_safelist.c: Version of /list that uses the safelist code. | |
4 | * | |
5 | * Copyright (c) 2006 William Pitcock <nenolod@nenolod.net> | |
6 | * | |
7 | * Redistribution and use in source and binary forms, with or without | |
8 | * modification, are permitted provided that the following conditions are | |
9 | * met: | |
10 | * | |
11 | * 1. Redistributions of source code must retain the above copyright notice, | |
12 | * this list of conditions and the following disclaimer. | |
13 | * | |
14 | * 2. Redistributions in binary form must reproduce the above copyright | |
15 | * notice, this list of conditions and the following disclaimer in the | |
16 | * documentation and/or other materials provided with the distribution. | |
17 | * | |
18 | * 3. The name of the author may not be used to endorse or promote products | |
19 | * derived from this software without specific prior written permission. | |
20 | * | |
21 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
22 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | |
23 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
24 | * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, | |
25 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
26 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
27 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
28 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
29 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
30 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
31 | * POSSIBILITY OF SUCH DAMAGE. | |
32 | * | |
33 | * $Id: m_list.c 3372 2007-04-03 10:18:07Z nenolod $ | |
34 | */ | |
35 | ||
36 | #include "stdinc.h" | |
37 | #include "channel.h" | |
38 | #include "client.h" | |
39 | #include "hash.h" | |
40 | #include "match.h" | |
41 | #include "ircd.h" | |
42 | #include "numeric.h" | |
43 | #include "s_conf.h" | |
44 | #include "s_newconf.h" | |
45 | #include "s_serv.h" | |
46 | #include "supported.h" | |
47 | #include "send.h" | |
48 | #include "msg.h" | |
49 | #include "parse.h" | |
50 | #include "modules.h" | |
51 | #include "inline/stringops.h" | |
52 | #include "s_assert.h" | |
53 | #include "logger.h" | |
54 | ||
55 | static rb_dlink_list safelisting_clients = { NULL, NULL, 0 }; | |
56 | ||
57 | static int _modinit(void); | |
58 | static void _moddeinit(void); | |
59 | ||
60 | static int m_list(struct Client *, struct Client *, int, const char **); | |
61 | static int mo_list(struct Client *, struct Client *, int, const char **); | |
62 | ||
63 | static void list_one_channel(struct Client *source_p, struct Channel *chptr, int visible); | |
64 | ||
65 | static void safelist_check_cliexit(hook_data_client_exit * hdata); | |
66 | static void safelist_client_instantiate(struct Client *, struct ListClient *); | |
67 | static void safelist_client_release(struct Client *); | |
68 | static void safelist_one_channel(struct Client *source_p, struct Channel *chptr); | |
69 | static void safelist_iterate_client(struct Client *source_p); | |
70 | static void safelist_iterate_clients(void *unused); | |
71 | static void safelist_channel_named(struct Client *source_p, const char *name, int operspy); | |
72 | ||
73 | struct Message list_msgtab = { | |
74 | "LIST", 0, 0, 0, MFLG_SLOW, | |
75 | {mg_unreg, {m_list, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_list, 0}} | |
76 | }; | |
77 | ||
78 | mapi_clist_av1 list_clist[] = { &list_msgtab, NULL }; | |
79 | ||
80 | mapi_hfn_list_av1 list_hfnlist[] = { | |
81 | {"client_exit", (hookfn) safelist_check_cliexit}, | |
82 | {NULL, NULL} | |
83 | }; | |
84 | ||
85 | DECLARE_MODULE_AV1(list, _modinit, _moddeinit, list_clist, NULL, list_hfnlist, "$Revision: 3372 $"); | |
86 | ||
87 | static struct ev_entry *iterate_clients_ev = NULL; | |
88 | ||
89 | static int _modinit(void) | |
90 | { | |
91 | iterate_clients_ev = rb_event_add("safelist_iterate_clients", safelist_iterate_clients, NULL, 3); | |
92 | ||
93 | /* ELIST=[tokens]: | |
94 | * | |
95 | * M = mask search | |
96 | * N = !mask search | |
97 | * U = user count search (< >) | |
98 | * C = creation time search (C> C<) | |
99 | * T = topic search (T> T<) | |
100 | */ | |
101 | add_isupport("SAFELIST", isupport_string, ""); | |
102 | add_isupport("ELIST", isupport_string, "CTU"); | |
103 | ||
104 | return 0; | |
105 | } | |
106 | ||
107 | static void _moddeinit(void) | |
108 | { | |
109 | rb_event_delete(iterate_clients_ev); | |
110 | ||
111 | delete_isupport("SAFELIST"); | |
112 | delete_isupport("ELIST"); | |
113 | } | |
114 | ||
115 | static void safelist_check_cliexit(hook_data_client_exit * hdata) | |
116 | { | |
117 | /* Cancel the safelist request if we are disconnecting | |
118 | * from the server. That way it doesn't core. :P --nenolod | |
119 | */ | |
120 | if (MyClient(hdata->target) && hdata->target->localClient->safelist_data != NULL) | |
121 | { | |
122 | safelist_client_release(hdata->target); | |
123 | } | |
124 | } | |
125 | ||
126 | /* m_list() | |
127 | * parv[1] = channel | |
128 | * | |
129 | * XXX - With SAFELIST, do we really need to continue pacing? | |
130 | * In theory, the server cannot be lagged by this. --nenolod | |
131 | */ | |
132 | static int m_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) | |
133 | { | |
134 | static time_t last_used = 0L; | |
135 | ||
136 | if (source_p->localClient->safelist_data != NULL) | |
137 | { | |
138 | sendto_one_notice(source_p, ":/LIST aborted"); | |
139 | safelist_client_release(source_p); | |
140 | return 0; | |
141 | } | |
142 | ||
143 | if (parc < 2 || !IsChannelName(parv[1])) | |
144 | { | |
145 | /* pace this due to the sheer traffic involved */ | |
146 | if (((last_used + ConfigFileEntry.pace_wait) > rb_current_time())) | |
147 | { | |
148 | sendto_one(source_p, form_str(RPL_LOAD2HI), me.name, source_p->name, "LIST"); | |
149 | sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name); | |
150 | return 0; | |
151 | } | |
152 | else | |
153 | last_used = rb_current_time(); | |
154 | } | |
155 | ||
156 | return mo_list(client_p, source_p, parc, parv); | |
157 | } | |
158 | ||
159 | /* mo_list() | |
160 | * parv[1] = channel | |
161 | */ | |
162 | static int mo_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[]) | |
163 | { | |
164 | struct ListClient *params; | |
165 | char *p; | |
166 | char *args = NULL; | |
167 | int i; | |
168 | int operspy = 0; | |
169 | ||
170 | if (source_p->localClient->safelist_data != NULL) | |
171 | { | |
172 | sendto_one_notice(source_p, ":/LIST aborted"); | |
173 | safelist_client_release(source_p); | |
174 | return 0; | |
175 | } | |
176 | ||
177 | if (parc > 1) | |
178 | { | |
179 | args = LOCAL_COPY(parv[1]); | |
180 | } | |
181 | ||
182 | if (args && *args == '!' && IsOperSpy(source_p)) | |
183 | { | |
184 | args++; | |
185 | report_operspy(source_p, "LIST", args); | |
186 | operspy = 1; | |
187 | } | |
188 | ||
189 | /* Single channel. */ | |
190 | if (args && IsChannelName(args)) | |
191 | { | |
192 | safelist_channel_named(source_p, args, operspy); | |
193 | return 0; | |
194 | } | |
195 | ||
196 | /* Multiple channels, possibly with parameters. */ | |
197 | params = rb_malloc(sizeof(struct ListClient)); | |
198 | ||
199 | /* XXX rather arbitrary -- jilles */ | |
200 | params->users_min = 3; | |
201 | params->users_max = INT_MAX; | |
202 | params->operspy = operspy; | |
203 | params->created_min = params->topic_min = | |
204 | params->created_max = params->topic_max = 0; | |
205 | ||
206 | if (args && !EmptyString(args)) | |
207 | { | |
208 | /* Cancel out default minimum. */ | |
209 | params->users_min = 0; | |
210 | ||
211 | for (i = 0; i < 7; i++) | |
212 | { | |
213 | if ((p = strchr(args, ',')) != NULL) | |
214 | *p++ = '\0'; | |
215 | ||
216 | if (*args == '<') | |
217 | { | |
218 | args++; | |
219 | if (IsDigit(*args)) | |
220 | { | |
221 | params->users_max = atoi(args); | |
222 | if (params->users_max == 0) | |
223 | params->users_max = INT_MAX; | |
224 | else | |
225 | params->users_max--; | |
226 | } | |
227 | } | |
228 | else if (*args == '>') | |
229 | { | |
230 | args++; | |
231 | if (IsDigit(*args)) | |
232 | params->users_min = atoi(args) + 1; | |
233 | else | |
234 | params->users_min = 0; | |
235 | } | |
236 | else if (*args == 'C' || *args == 'c') | |
237 | { | |
238 | args++; | |
239 | if (*args == '>') | |
240 | { | |
241 | /* Creation time earlier than last x minutes. */ | |
242 | args++; | |
243 | if (IsDigit(*args)) | |
244 | { | |
245 | params->created_max = rb_current_time() - (60 * atoi(args)); | |
246 | } | |
247 | } | |
248 | else if (*args == '<') | |
249 | { | |
250 | /* Creation time within last x minutes. */ | |
251 | args++; | |
252 | if (IsDigit(*args)) | |
253 | { | |
254 | params->created_min = rb_current_time() - (60 * atoi(args)); | |
255 | } | |
256 | } | |
257 | } | |
258 | else if (*args == 'T' || *args == 't') | |
259 | { | |
260 | args++; | |
261 | if (*args == '>') | |
262 | { | |
263 | /* Topic change time earlier than last x minutes. */ | |
264 | args++; | |
265 | if (IsDigit(*args)) | |
266 | { | |
267 | params->topic_max = rb_current_time() - (60 * atoi(args)); | |
268 | } | |
269 | } | |
270 | else if (*args == '<') | |
271 | { | |
272 | /* Topic change time within last x minutes. */ | |
273 | args++; | |
274 | if (IsDigit(*args)) | |
275 | { | |
276 | params->topic_min = rb_current_time() - (60 * atoi(args)); | |
277 | } | |
278 | } | |
279 | } | |
280 | ||
281 | if (EmptyString(p)) | |
282 | break; | |
283 | else | |
284 | args = p; | |
285 | } | |
286 | } | |
287 | ||
288 | safelist_client_instantiate(source_p, params); | |
289 | ||
290 | return 0; | |
291 | } | |
292 | ||
293 | /* | |
294 | * list_one_channel() | |
295 | * | |
296 | * inputs - client pointer, channel pointer, whether normally visible | |
297 | * outputs - none | |
298 | * side effects - a channel is listed | |
299 | */ | |
300 | static void list_one_channel(struct Client *source_p, struct Channel *chptr, | |
301 | int visible) | |
302 | { | |
303 | char topic[TOPICLEN + 1]; | |
304 | ||
305 | if (chptr->topic != NULL) | |
306 | rb_strlcpy(topic, chptr->topic, sizeof topic); | |
307 | else | |
308 | topic[0] = '\0'; | |
309 | strip_colour(topic); | |
310 | sendto_one(source_p, form_str(RPL_LIST), me.name, source_p->name, | |
311 | visible ? "" : "!", | |
312 | chptr->chname, rb_dlink_list_length(&chptr->members), | |
313 | topic); | |
314 | } | |
315 | ||
316 | /* | |
317 | * safelist_sendq_exceeded() | |
318 | * | |
319 | * inputs - pointer to client that needs checking | |
320 | * outputs - 1 if a client has exceeded the reserved | |
321 | * sendq limit, 0 if not | |
322 | * side effects - none | |
323 | * | |
324 | * When safelisting, we only use half of the SendQ at any | |
325 | * given time. | |
326 | */ | |
327 | static int safelist_sendq_exceeded(struct Client *client_p) | |
328 | { | |
329 | if (rb_linebuf_len(&client_p->localClient->buf_sendq) > (get_sendq(client_p) / 2)) | |
330 | return YES; | |
331 | else | |
332 | return NO; | |
333 | } | |
334 | ||
335 | /* | |
336 | * safelist_client_instantiate() | |
337 | * | |
338 | * inputs - pointer to Client to be listed, | |
339 | * pointer to ListClient for params | |
340 | * outputs - none | |
341 | * side effects - the safelist process begins for a | |
342 | * client. | |
343 | * | |
344 | * Please do not ever call this on a non-local client. | |
345 | * If you do, you will get SIGSEGV. | |
346 | */ | |
347 | static void safelist_client_instantiate(struct Client *client_p, struct ListClient *params) | |
348 | { | |
349 | s_assert(MyClient(client_p)); | |
350 | s_assert(params != NULL); | |
351 | ||
352 | client_p->localClient->safelist_data = params; | |
353 | ||
354 | sendto_one(client_p, form_str(RPL_LISTSTART), me.name, client_p->name); | |
355 | ||
356 | /* pop the client onto the queue for processing */ | |
357 | rb_dlinkAddAlloc(client_p, &safelisting_clients); | |
358 | ||
359 | /* give the user some initial data to work with */ | |
360 | safelist_iterate_client(client_p); | |
361 | } | |
362 | ||
363 | /* | |
364 | * safelist_client_release() | |
365 | * | |
366 | * inputs - pointer to Client being listed on | |
367 | * outputs - none | |
368 | * side effects - the client is no longer being | |
369 | * listed | |
370 | * | |
371 | * Please do not ever call this on a non-local client. | |
372 | * If you do, you will get SIGSEGV. | |
373 | */ | |
374 | static void safelist_client_release(struct Client *client_p) | |
375 | { | |
376 | s_assert(MyClient(client_p)); | |
377 | ||
378 | rb_dlinkFindDestroy(client_p, &safelisting_clients); | |
379 | ||
380 | rb_free(client_p->localClient->safelist_data); | |
381 | ||
382 | client_p->localClient->safelist_data = NULL; | |
383 | ||
384 | sendto_one(client_p, form_str(RPL_LISTEND), me.name, client_p->name); | |
385 | } | |
386 | ||
387 | /* | |
388 | * safelist_channel_named() | |
389 | * | |
390 | * inputs - client pointer, channel name, operspy | |
391 | * outputs - none | |
392 | * side effects - a named channel is listed | |
393 | */ | |
394 | static void safelist_channel_named(struct Client *source_p, const char *name, int operspy) | |
395 | { | |
396 | struct Channel *chptr; | |
397 | char *p; | |
398 | int visible; | |
399 | ||
400 | sendto_one(source_p, form_str(RPL_LISTSTART), me.name, source_p->name); | |
401 | ||
402 | if ((p = strchr(name, ','))) | |
403 | *p = '\0'; | |
404 | ||
405 | if (*name == '\0') | |
406 | { | |
407 | sendto_one_numeric(source_p, ERR_NOSUCHNICK, form_str(ERR_NOSUCHNICK), name); | |
408 | sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name); | |
409 | return; | |
410 | } | |
411 | ||
412 | chptr = find_channel(name); | |
413 | ||
414 | if (chptr == NULL) | |
415 | { | |
416 | sendto_one_numeric(source_p, ERR_NOSUCHNICK, form_str(ERR_NOSUCHNICK), name); | |
417 | sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name); | |
418 | return; | |
419 | } | |
420 | ||
421 | visible = !SecretChannel(chptr) || IsMember(source_p, chptr); | |
422 | if (visible || operspy) | |
423 | list_one_channel(source_p, chptr, visible); | |
424 | ||
425 | sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name); | |
426 | return; | |
427 | } | |
428 | ||
429 | /* | |
430 | * safelist_one_channel() | |
431 | * | |
432 | * inputs - client pointer and channel pointer | |
433 | * outputs - none | |
434 | * side effects - a channel is listed if it meets the | |
435 | * requirements | |
436 | */ | |
437 | static void safelist_one_channel(struct Client *source_p, struct Channel *chptr) | |
438 | { | |
439 | struct ListClient *safelist_data = source_p->localClient->safelist_data; | |
440 | int visible; | |
441 | ||
442 | visible = !SecretChannel(chptr) || IsMember(source_p, chptr); | |
443 | if (!visible && !safelist_data->operspy) | |
444 | return; | |
445 | ||
446 | if ((unsigned int)chptr->members.length < safelist_data->users_min | |
447 | || (unsigned int)chptr->members.length > safelist_data->users_max) | |
448 | return; | |
449 | ||
450 | if (safelist_data->topic_min && chptr->topic_time < safelist_data->topic_min) | |
451 | return; | |
452 | ||
453 | /* If a topic TS is provided, don't show channels without a topic set. */ | |
454 | if (safelist_data->topic_max && (chptr->topic_time > safelist_data->topic_max | |
455 | || chptr->topic_time == 0)) | |
456 | return; | |
457 | ||
458 | if (safelist_data->created_min && chptr->channelts < safelist_data->created_min) | |
459 | return; | |
460 | ||
461 | if (safelist_data->created_max && chptr->channelts > safelist_data->created_max) | |
462 | return; | |
463 | ||
464 | list_one_channel(source_p, chptr, visible); | |
465 | } | |
466 | ||
467 | /* | |
468 | * safelist_iterate_client() | |
469 | * | |
470 | * inputs - client pointer | |
471 | * outputs - none | |
472 | * side effects - the client's sendq is filled up again | |
473 | */ | |
474 | static void safelist_iterate_client(struct Client *source_p) | |
475 | { | |
476 | rb_dlink_node *ptr; | |
477 | int iter; | |
478 | ||
479 | for (iter = source_p->localClient->safelist_data->hash_indice; iter < CH_MAX; iter++) | |
480 | { | |
481 | if (safelist_sendq_exceeded(source_p->from) == YES) | |
482 | { | |
483 | source_p->localClient->safelist_data->hash_indice = iter; | |
484 | return; | |
485 | } | |
486 | ||
487 | RB_DLINK_FOREACH(ptr, channelTable[iter].head) | |
488 | safelist_one_channel(source_p, (struct Channel *) ptr->data); | |
489 | } | |
490 | ||
491 | safelist_client_release(source_p); | |
492 | } | |
493 | ||
494 | static void safelist_iterate_clients(void *unused) | |
495 | { | |
496 | rb_dlink_node *n, *n2; | |
497 | ||
498 | RB_DLINK_FOREACH_SAFE(n, n2, safelisting_clients.head) | |
499 | safelist_iterate_client((struct Client *)n->data); | |
500 | } |