]> jfr.im git - irc/rqf/shadowircd.git/blame - modules/m_list.c
Implement operspy for /LIST.
[irc/rqf/shadowircd.git] / modules / m_list.c
CommitLineData
212380e3 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 *
212380e3 33 */
34
35#include "stdinc.h"
212380e3 36#include "channel.h"
37#include "client.h"
38#include "hash.h"
13ae2f4b 39#include "match.h"
212380e3 40#include "ircd.h"
41#include "numeric.h"
42#include "s_conf.h"
e78f804d 43#include "s_newconf.h"
212380e3 44#include "s_serv.h"
45#include "send.h"
46#include "msg.h"
47#include "parse.h"
48#include "modules.h"
212380e3 49
08d11e34 50static rb_dlink_list safelisting_clients = { NULL, NULL, 0 };
212380e3 51
52static int _modinit(void);
53static void _moddeinit(void);
54
55static int m_list(struct Client *, struct Client *, int, const char **);
56static int mo_list(struct Client *, struct Client *, int, const char **);
57
58static void safelist_check_cliexit(hook_data_client_exit * hdata);
59static void safelist_client_instantiate(struct Client *, struct ListClient *);
60static void safelist_client_release(struct Client *);
61static void safelist_one_channel(struct Client *source_p, struct Channel *chptr);
62static void safelist_iterate_client(struct Client *source_p);
63static void safelist_iterate_clients(void *unused);
64static void safelist_channel_named(struct Client *source_p, const char *name);
65
66struct Message list_msgtab = {
67 "LIST", 0, 0, 0, MFLG_SLOW,
68 {mg_unreg, {m_list, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_list, 0}}
69};
70
71mapi_clist_av1 list_clist[] = { &list_msgtab, NULL };
72
73mapi_hfn_list_av1 list_hfnlist[] = {
74 {"client_exit", (hookfn) safelist_check_cliexit},
75 {NULL, NULL}
76};
77
607cf49f 78DECLARE_MODULE_AV1(list, _modinit, _moddeinit, list_clist, NULL, list_hfnlist, "$Revision: 3372 $");
212380e3 79
03e24016
WP
80static struct ev_entry *iterate_clients_ev = NULL;
81
212380e3 82static int _modinit(void)
83{
03e24016 84 iterate_clients_ev = rb_event_add("safelist_iterate_clients", safelist_iterate_clients, NULL, 3);
212380e3 85
86 return 0;
87}
88
89static void _moddeinit(void)
90{
03e24016 91 rb_event_delete(iterate_clients_ev);
212380e3 92}
93
94static void safelist_check_cliexit(hook_data_client_exit * hdata)
95{
96 /* Cancel the safelist request if we are disconnecting
97 * from the server. That way it doesn't core. :P --nenolod
98 */
99 if (MyClient(hdata->target) && hdata->target->localClient->safelist_data != NULL)
100 {
101 safelist_client_release(hdata->target);
102 }
103}
104
105/* m_list()
212380e3 106 * parv[1] = channel
107 *
108 * XXX - With SAFELIST, do we really need to continue pacing?
109 * In theory, the server cannot be lagged by this. --nenolod
110 */
111static int m_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
112{
113 static time_t last_used = 0L;
114
115 if (source_p->localClient->safelist_data != NULL)
116 {
117 sendto_one_notice(source_p, ":/LIST aborted");
212380e3 118 safelist_client_release(source_p);
119 return 0;
120 }
121
122 if (parc < 2 || !IsChannelName(parv[1]))
123 {
124 /* pace this due to the sheer traffic involved */
9f6bbe3c 125 if (((last_used + ConfigFileEntry.pace_wait) > rb_current_time()))
212380e3 126 {
127 sendto_one(source_p, form_str(RPL_LOAD2HI), me.name, source_p->name, "LIST");
128 sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
129 return 0;
130 }
131 else
9f6bbe3c 132 last_used = rb_current_time();
212380e3 133 }
134
135 return mo_list(client_p, source_p, parc, parv);
136}
137
138/* mo_list()
212380e3 139 * parv[1] = channel
140 */
141static int mo_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
142{
143 struct ListClient params;
144 char *p, *args;
145 int i;
146
147 if (source_p->localClient->safelist_data != NULL)
148 {
149 sendto_one_notice(source_p, ":/LIST aborted");
212380e3 150 safelist_client_release(source_p);
151 return 0;
152 }
153
6898ce9d
JH
154 /* Let the user set it */
155 params.users_min = ConfigFileEntry.hide_channel_below_users;
212380e3 156 params.users_max = INT_MAX;
e78f804d 157 params.operspy = 0;
212380e3 158
159 if (parc > 1 && parv[1] != NULL && !IsChannelName(parv[1]))
160 {
161 args = LOCAL_COPY(parv[1]);
e78f804d
JH
162
163 /* Cancel out default minimum. */
164 params.users_min = 0;
212380e3 165
166 for (i = 0; i < 2; i++)
167 {
168 if ((p = strchr(args, ',')) != NULL)
169 *p++ = '\0';
170
171 if (*args == '<')
172 {
173 args++;
174 if (IsDigit(*args))
175 {
176 params.users_max = atoi(args);
177 if (params.users_max == 0)
178 params.users_max = INT_MAX;
179 else
180 params.users_max--;
181 }
182 else
183 params.users_max = INT_MAX;
184 }
185 else if (*args == '>')
186 {
187 args++;
188 if (IsDigit(*args))
189 params.users_min = atoi(args) + 1;
190 else
191 params.users_min = 0;
192 }
e78f804d
JH
193 /* Only accept operspy as the first option. */
194 else if (*args == '!' && IsOperSpy(source_p) && i == 0)
195 {
196 params.operspy = 1;
197 report_operspy(source_p, "LIST", p);
198 }
212380e3 199
200 if (EmptyString(p))
201 break;
202 else
203 args = p;
204 }
205 }
206 else if (parc > 1 && IsChannelName(parv[1]))
207 {
208 safelist_channel_named(source_p, parv[1]);
209 return 0;
210 }
211
212 safelist_client_instantiate(source_p, &params);
213
214 return 0;
215}
216
217/*
218 * safelist_sendq_exceeded()
219 *
220 * inputs - pointer to client that needs checking
221 * outputs - 1 if a client has exceeded the reserved
222 * sendq limit, 0 if not
223 * side effects - none
224 *
225 * When safelisting, we only use half of the SendQ at any
226 * given time.
227 */
228static int safelist_sendq_exceeded(struct Client *client_p)
229{
03e24016 230 if (rb_linebuf_len(&client_p->localClient->buf_sendq) > (get_sendq(client_p) / 2))
212380e3 231 return YES;
232 else
233 return NO;
234}
235
236/*
237 * safelist_client_instantiate()
238 *
239 * inputs - pointer to Client to be listed,
240 * struct ListClient to copy for params
241 * outputs - none
242 * side effects - the safelist process begins for a
243 * client.
244 *
245 * Please do not ever call this on a non-local client.
246 * If you do, you will get SIGSEGV.
247 */
248static void safelist_client_instantiate(struct Client *client_p, struct ListClient *params)
249{
250 struct ListClient *self;
251
252 s_assert(MyClient(client_p));
253 s_assert(params != NULL);
254
8e43b0b4 255 self = rb_malloc(sizeof(struct ListClient));
212380e3 256
257 self->hash_indice = 0;
258 self->users_min = params->users_min;
259 self->users_max = params->users_max;
e78f804d 260 self->operspy = params->operspy;
212380e3 261
262 client_p->localClient->safelist_data = self;
263
264 sendto_one(client_p, form_str(RPL_LISTSTART), me.name, client_p->name);
265
266 /* pop the client onto the queue for processing */
03e24016 267 rb_dlinkAddAlloc(client_p, &safelisting_clients);
212380e3 268
269 /* give the user some initial data to work with */
270 safelist_iterate_client(client_p);
271}
272
273/*
274 * safelist_client_release()
275 *
276 * inputs - pointer to Client being listed on
277 * outputs - none
278 * side effects - the client is no longer being
279 * listed
280 *
281 * Please do not ever call this on a non-local client.
282 * If you do, you will get SIGSEGV.
283 */
284static void safelist_client_release(struct Client *client_p)
285{
286 s_assert(MyClient(client_p));
287
9f6c3353 288 rb_dlinkFindDestroy(client_p, &safelisting_clients);
212380e3 289
90a3c35b 290 rb_free(client_p->localClient->safelist_data);
212380e3 291
292 client_p->localClient->safelist_data = NULL;
293
294 sendto_one(client_p, form_str(RPL_LISTEND), me.name, client_p->name);
295}
296
297/*
298 * safelist_channel_named()
299 *
300 * inputs - client pointer, channel name
301 * outputs - none
302 * side effects - a named channel is listed
303 */
304static void safelist_channel_named(struct Client *source_p, const char *name)
305{
306 struct Channel *chptr;
307 char *p;
308 char *n = LOCAL_COPY(name);
309
310 sendto_one(source_p, form_str(RPL_LISTSTART), me.name, source_p->name);
311
312 if ((p = strchr(n, ',')))
313 *p = '\0';
314
315 if (*n == '\0')
316 {
317 sendto_one_numeric(source_p, ERR_NOSUCHNICK, form_str(ERR_NOSUCHNICK), name);
318 sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
319 return;
320 }
321
322 chptr = find_channel(n);
323
324 if (chptr == NULL)
325 {
326 sendto_one_numeric(source_p, ERR_NOSUCHNICK, form_str(ERR_NOSUCHNICK), n);
327 sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
328 return;
329 }
330
97a6160b 331 if (!SecretChannel(chptr) || IsMember(source_p, chptr))
e78f804d
JH
332 sendto_one(source_p, form_str(RPL_LIST), me.name, source_p->name, "",
333 chptr->chname, rb_dlink_list_length(&chptr->members),
212380e3 334 chptr->topic == NULL ? "" : chptr->topic);
335
336 sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
337 return;
338}
339
340/*
341 * safelist_one_channel()
342 *
343 * inputs - client pointer and channel pointer
344 * outputs - none
345 * side effects - a channel is listed if it meets the
346 * requirements
347 */
348static void safelist_one_channel(struct Client *source_p, struct Channel *chptr)
349{
350 struct ListClient *safelist_data = source_p->localClient->safelist_data;
351
e78f804d 352 if (SecretChannel(chptr) && !IsMember(source_p, chptr) && !safelist_data->operspy)
212380e3 353 return;
354
355 if ((unsigned int)chptr->members.length < safelist_data->users_min
356 || (unsigned int)chptr->members.length > safelist_data->users_max)
357 return;
358
e78f804d
JH
359 sendto_one(source_p, form_str(RPL_LIST), me.name, source_p->name,
360 (safelist_data->operspy && SecretChannel(chptr)) ? "!" : "",
361 chptr->chname, rb_dlink_list_length(&chptr->members),
362 chptr->topic == NULL ? "" : chptr->topic);
212380e3 363}
364
365/*
366 * safelist_iterate_client()
367 *
368 * inputs - client pointer
369 * outputs - none
370 * side effects - the client's sendq is filled up again
371 */
372static void safelist_iterate_client(struct Client *source_p)
373{
08d11e34 374 rb_dlink_node *ptr;
212380e3 375 int iter;
376
377 for (iter = source_p->localClient->safelist_data->hash_indice; iter < CH_MAX; iter++)
378 {
379 if (safelist_sendq_exceeded(source_p->from) == YES)
380 {
381 source_p->localClient->safelist_data->hash_indice = iter;
382 return;
383 }
384
08d11e34 385 RB_DLINK_FOREACH(ptr, channelTable[iter].head)
212380e3 386 safelist_one_channel(source_p, (struct Channel *) ptr->data);
387 }
388
389 safelist_client_release(source_p);
390}
391
392static void safelist_iterate_clients(void *unused)
393{
08d11e34 394 rb_dlink_node *n, *n2;
212380e3 395
08d11e34 396 RB_DLINK_FOREACH_SAFE(n, n2, safelisting_clients.head)
212380e3 397 safelist_iterate_client((struct Client *)n->data);
398}