2 * charybdis: An advanced ircd.
3 * m_list_safelist.c: Version of /list that uses the safelist code.
5 * Copyright (c) 2006 William Pitcock <nenolod@nenolod.net>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * 1. Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
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.
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.
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.
33 * $Id: m_list.c 3372 2007-04-03 10:18:07Z nenolod $
44 #include "s_newconf.h"
46 #include "supported.h"
51 #include "inline/stringops.h"
54 #include "irc_radixtree.h"
56 static rb_dlink_list safelisting_clients
= { NULL
, NULL
, 0 };
58 static int _modinit(void);
59 static void _moddeinit(void);
61 static int m_list(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
62 static int mo_list(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
64 static void list_one_channel(struct Client
*source_p
, struct Channel
*chptr
, int visible
);
66 static void safelist_one_channel(struct Client
*source_p
, struct Channel
*chptr
, struct ListClient
*params
);
67 static void safelist_check_cliexit(hook_data_client_exit
* hdata
);
68 static void safelist_client_instantiate(struct Client
*, struct ListClient
*);
69 static void safelist_client_release(struct Client
*);
70 static void safelist_iterate_client(struct Client
*source_p
);
71 static void safelist_iterate_clients(void *unused
);
72 static void safelist_channel_named(struct Client
*source_p
, const char *name
, int operspy
);
74 struct Message list_msgtab
= {
76 {mg_unreg
, {m_list
, 0}, mg_ignore
, mg_ignore
, mg_ignore
, {mo_list
, 0}}
79 mapi_clist_av1 list_clist
[] = { &list_msgtab
, NULL
};
81 mapi_hfn_list_av1 list_hfnlist
[] = {
82 {"client_exit", (hookfn
) safelist_check_cliexit
},
86 DECLARE_MODULE_AV1(list
, _modinit
, _moddeinit
, list_clist
, NULL
, list_hfnlist
, "$Revision: 3372 $");
88 static struct ev_entry
*iterate_clients_ev
= NULL
;
90 static int _modinit(void)
92 iterate_clients_ev
= rb_event_add("safelist_iterate_clients", safelist_iterate_clients
, NULL
, 3);
98 * U = user count search (< >)
99 * C = creation time search (C> C<)
100 * T = topic search (T> T<)
102 add_isupport("SAFELIST", isupport_string
, "");
103 add_isupport("ELIST", isupport_string
, "CTU");
108 static void _moddeinit(void)
110 rb_event_delete(iterate_clients_ev
);
112 delete_isupport("SAFELIST");
113 delete_isupport("ELIST");
116 static void safelist_check_cliexit(hook_data_client_exit
* hdata
)
118 /* Cancel the safelist request if we are disconnecting
119 * from the server. That way it doesn't core. :P --nenolod
121 if (MyClient(hdata
->target
) && hdata
->target
->localClient
->safelist_data
!= NULL
)
123 safelist_client_release(hdata
->target
);
130 * XXX - With SAFELIST, do we really need to continue pacing?
131 * In theory, the server cannot be lagged by this. --nenolod
133 static int m_list(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
135 static time_t last_used
= 0L;
137 if (source_p
->localClient
->safelist_data
!= NULL
)
139 sendto_one_notice(source_p
, ":/LIST aborted");
140 safelist_client_release(source_p
);
144 if (parc
< 2 || !IsChannelName(parv
[1]))
146 /* pace this due to the sheer traffic involved */
147 if (((last_used
+ ConfigFileEntry
.pace_wait
) > rb_current_time()))
149 sendto_one(source_p
, form_str(RPL_LOAD2HI
), me
.name
, source_p
->name
, "LIST");
150 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
154 last_used
= rb_current_time();
157 return mo_list(msgbuf_p
, client_p
, source_p
, parc
, parv
);
163 static int mo_list(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
165 struct ListClient
*params
;
171 if (source_p
->localClient
->safelist_data
!= NULL
)
173 sendto_one_notice(source_p
, ":/LIST aborted");
174 safelist_client_release(source_p
);
180 args
= LOCAL_COPY(parv
[1]);
183 if (args
&& *args
== '!' && IsOperSpy(source_p
))
186 report_operspy(source_p
, "LIST", args
);
190 /* Single channel. */
191 if (args
&& IsChannelName(args
))
193 safelist_channel_named(source_p
, args
, operspy
);
197 /* Multiple channels, possibly with parameters. */
198 params
= rb_malloc(sizeof(struct ListClient
));
200 params
->users_min
= ConfigChannel
.displayed_usercount
;
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;
206 if (args
&& !EmptyString(args
))
208 /* Cancel out default minimum. */
209 params
->users_min
= 0;
211 for (i
= 0; i
< 7; i
++)
213 if ((p
= strchr(args
, ',')) != NULL
)
221 params
->users_max
= atoi(args
);
222 if (params
->users_max
== 0)
223 params
->users_max
= INT_MAX
;
228 else if (*args
== '>')
232 params
->users_min
= atoi(args
) + 1;
234 params
->users_min
= 0;
236 else if (*args
== 'C' || *args
== 'c')
241 /* Creation time earlier than last x minutes. */
245 params
->created_max
= rb_current_time() - (60 * atoi(args
));
248 else if (*args
== '<')
250 /* Creation time within last x minutes. */
254 params
->created_min
= rb_current_time() - (60 * atoi(args
));
258 else if (*args
== 'T' || *args
== 't')
263 /* Topic change time earlier than last x minutes. */
267 params
->topic_max
= rb_current_time() - (60 * atoi(args
));
270 else if (*args
== '<')
272 /* Topic change time within last x minutes. */
276 params
->topic_min
= rb_current_time() - (60 * atoi(args
));
288 safelist_client_instantiate(source_p
, params
);
296 * inputs - client pointer, channel pointer, whether normally visible
298 * side effects - a channel is listed
300 static void list_one_channel(struct Client
*source_p
, struct Channel
*chptr
,
303 char topic
[TOPICLEN
+ 1];
305 if (chptr
->topic
!= NULL
)
306 rb_strlcpy(topic
, chptr
->topic
, sizeof topic
);
310 sendto_one(source_p
, form_str(RPL_LIST
), me
.name
, source_p
->name
,
312 chptr
->chname
, rb_dlink_list_length(&chptr
->members
),
317 * safelist_sendq_exceeded()
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
324 * When safelisting, we only use half of the SendQ at any
327 static int safelist_sendq_exceeded(struct Client
*client_p
)
329 if (rb_linebuf_len(&client_p
->localClient
->buf_sendq
) > (get_sendq(client_p
) / 2))
336 * safelist_client_instantiate()
338 * inputs - pointer to Client to be listed,
339 * pointer to ListClient for params
341 * side effects - the safelist process begins for a
344 * Please do not ever call this on a non-local client.
345 * If you do, you will get SIGSEGV.
347 static void safelist_client_instantiate(struct Client
*client_p
, struct ListClient
*params
)
349 s_assert(MyClient(client_p
));
350 s_assert(params
!= NULL
);
352 client_p
->localClient
->safelist_data
= params
;
354 sendto_one(client_p
, form_str(RPL_LISTSTART
), me
.name
, client_p
->name
);
356 /* pop the client onto the queue for processing */
357 rb_dlinkAddAlloc(client_p
, &safelisting_clients
);
359 /* give the user some initial data to work with */
360 safelist_iterate_client(client_p
);
364 * safelist_client_release()
366 * inputs - pointer to Client being listed on
368 * side effects - the client is no longer being
371 * Please do not ever call this on a non-local client.
372 * If you do, you will get SIGSEGV.
374 static void safelist_client_release(struct Client
*client_p
)
376 s_assert(MyClient(client_p
));
378 rb_dlinkFindDestroy(client_p
, &safelisting_clients
);
380 rb_free(client_p
->localClient
->safelist_data
->chname
);
381 rb_free(client_p
->localClient
->safelist_data
);
383 client_p
->localClient
->safelist_data
= NULL
;
385 sendto_one(client_p
, form_str(RPL_LISTEND
), me
.name
, client_p
->name
);
389 * safelist_channel_named()
391 * inputs - client pointer, channel name, operspy
393 * side effects - a named channel is listed
395 static void safelist_channel_named(struct Client
*source_p
, const char *name
, int operspy
)
397 struct Channel
*chptr
;
401 sendto_one(source_p
, form_str(RPL_LISTSTART
), me
.name
, source_p
->name
);
403 if ((p
= strchr(name
, ',')))
408 sendto_one_numeric(source_p
, ERR_NOSUCHNICK
, form_str(ERR_NOSUCHNICK
), name
);
409 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
413 chptr
= find_channel(name
);
417 sendto_one_numeric(source_p
, ERR_NOSUCHNICK
, form_str(ERR_NOSUCHNICK
), name
);
418 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
422 visible
= !SecretChannel(chptr
) || IsMember(source_p
, chptr
);
423 if (visible
|| operspy
)
424 list_one_channel(source_p
, chptr
, visible
);
426 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
431 * safelist_one_channel()
433 * inputs - client pointer and channel pointer
435 * side effects - a channel is listed if it meets the
438 static void safelist_one_channel(struct Client
*source_p
, struct Channel
*chptr
, struct ListClient
*params
)
442 visible
= !SecretChannel(chptr
) || IsMember(source_p
, chptr
);
443 if (!visible
&& !params
->operspy
)
446 if ((unsigned int)chptr
->members
.length
< params
->users_min
447 || (unsigned int)chptr
->members
.length
> params
->users_max
)
450 if (params
->topic_min
&& chptr
->topic_time
< params
->topic_min
)
453 /* If a topic TS is provided, don't show channels without a topic set. */
454 if (params
->topic_max
&& (chptr
->topic_time
> params
->topic_max
455 || chptr
->topic_time
== 0))
458 if (params
->created_min
&& chptr
->channelts
< params
->created_min
)
461 if (params
->created_max
&& chptr
->channelts
> params
->created_max
)
464 list_one_channel(source_p
, chptr
, visible
);
468 * safelist_iterate_client()
470 * inputs - client pointer
472 * side effects - the client's sendq is filled up again
474 static void safelist_iterate_client(struct Client
*source_p
)
476 struct Channel
*chptr
;
477 struct irc_radixtree_iteration_state iter
;
479 IRC_RADIXTREE_FOREACH_FROM(chptr
, &iter
, channel_tree
, source_p
->localClient
->safelist_data
->chname
)
481 if (safelist_sendq_exceeded(source_p
->from
) == YES
)
483 rb_free(source_p
->localClient
->safelist_data
->chname
);
484 source_p
->localClient
->safelist_data
->chname
= rb_strdup(chptr
->chname
);
489 safelist_one_channel(source_p
, chptr
, source_p
->localClient
->safelist_data
);
492 safelist_client_release(source_p
);
495 static void safelist_iterate_clients(void *unused
)
497 rb_dlink_node
*n
, *n2
;
499 RB_DLINK_FOREACH_SAFE(n
, n2
, safelisting_clients
.head
)
500 safelist_iterate_client((struct Client
*)n
->data
);