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.
42 #include "s_newconf.h"
44 #include "supported.h"
49 #include "inline/stringops.h"
52 #include "rb_radixtree.h"
54 static const char list_desc
[] = "Provides the LIST command to clients to view non-hidden channels";
56 static rb_dlink_list safelisting_clients
= { NULL
, NULL
, 0 };
58 static struct ev_entry
*iterate_clients_ev
= NULL
;
60 static int _modinit(void);
61 static void _moddeinit(void);
63 static void m_list(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
64 static void mo_list(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
66 static void list_one_channel(struct Client
*source_p
, struct Channel
*chptr
, int visible
);
68 static void safelist_one_channel(struct Client
*source_p
, struct Channel
*chptr
, struct ListClient
*params
);
69 static void safelist_check_cliexit(hook_data_client_exit
* hdata
);
70 static void safelist_client_instantiate(struct Client
*, struct ListClient
*);
71 static void safelist_client_release(struct Client
*);
72 static void safelist_iterate_client(struct Client
*source_p
);
73 static void safelist_iterate_clients(void *unused
);
74 static void safelist_channel_named(struct Client
*source_p
, const char *name
, int operspy
);
76 struct Message list_msgtab
= {
78 {mg_unreg
, {m_list
, 0}, mg_ignore
, mg_ignore
, mg_ignore
, {mo_list
, 0}}
81 mapi_clist_av1 list_clist
[] = { &list_msgtab
, NULL
};
83 mapi_hfn_list_av1 list_hfnlist
[] = {
84 {"client_exit", (hookfn
) safelist_check_cliexit
},
88 DECLARE_MODULE_AV2(list
, _modinit
, _moddeinit
, list_clist
, NULL
, list_hfnlist
, NULL
, NULL
, list_desc
);
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
134 m_list(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
136 static time_t last_used
= 0L;
138 if (source_p
->localClient
->safelist_data
!= NULL
)
140 sendto_one_notice(source_p
, ":/LIST aborted");
141 safelist_client_release(source_p
);
145 if (parc
< 2 || !IsChannelName(parv
[1]))
147 /* pace this due to the sheer traffic involved */
148 if (((last_used
+ ConfigFileEntry
.pace_wait
) > rb_current_time()))
150 sendto_one(source_p
, form_str(RPL_LOAD2HI
), me
.name
, source_p
->name
, "LIST");
151 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
155 last_used
= rb_current_time();
158 mo_list(msgbuf_p
, client_p
, source_p
, parc
, parv
);
165 mo_list(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
167 struct ListClient
*params
;
173 if (source_p
->localClient
->safelist_data
!= NULL
)
175 sendto_one_notice(source_p
, ":/LIST aborted");
176 safelist_client_release(source_p
);
182 args
= LOCAL_COPY(parv
[1]);
185 if (args
&& *args
== '!' && IsOperSpy(source_p
))
188 report_operspy(source_p
, "LIST", args
);
192 /* Single channel. */
193 if (args
&& IsChannelName(args
))
195 safelist_channel_named(source_p
, args
, operspy
);
199 /* Multiple channels, possibly with parameters. */
200 params
= rb_malloc(sizeof(struct ListClient
));
202 params
->users_min
= ConfigChannel
.displayed_usercount
;
203 params
->users_max
= INT_MAX
;
204 params
->operspy
= operspy
;
205 params
->created_min
= params
->topic_min
=
206 params
->created_max
= params
->topic_max
= 0;
208 if (args
&& !EmptyString(args
))
210 /* Cancel out default minimum. */
211 params
->users_min
= 0;
213 for (i
= 0; i
< 7; i
++)
215 if ((p
= strchr(args
, ',')) != NULL
)
223 params
->users_max
= atoi(args
);
224 if (params
->users_max
== 0)
225 params
->users_max
= INT_MAX
;
230 else if (*args
== '>')
234 params
->users_min
= atoi(args
) + 1;
236 params
->users_min
= 0;
238 else if (*args
== 'C' || *args
== 'c')
243 /* Creation time earlier than last x minutes. */
247 params
->created_max
= rb_current_time() - (60 * atoi(args
));
250 else if (*args
== '<')
252 /* Creation time within last x minutes. */
256 params
->created_min
= rb_current_time() - (60 * atoi(args
));
260 else if (*args
== 'T' || *args
== 't')
265 /* Topic change time earlier than last x minutes. */
269 params
->topic_max
= rb_current_time() - (60 * atoi(args
));
272 else if (*args
== '<')
274 /* Topic change time within last x minutes. */
278 params
->topic_min
= rb_current_time() - (60 * atoi(args
));
290 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 - true if a client has exceeded the reserved
321 * sendq limit, false if not
322 * side effects - none
324 * When safelisting, we only use half of the SendQ at any
327 static bool safelist_sendq_exceeded(struct Client
*client_p
)
329 return rb_linebuf_len(&client_p
->localClient
->buf_sendq
) > (get_sendq(client_p
) / 2);
333 * safelist_client_instantiate()
335 * inputs - pointer to Client to be listed,
336 * pointer to ListClient for params
338 * side effects - the safelist process begins for a
341 * Please do not ever call this on a non-local client.
342 * If you do, you will get SIGSEGV.
344 static void safelist_client_instantiate(struct Client
*client_p
, struct ListClient
*params
)
346 s_assert(MyClient(client_p
));
347 s_assert(params
!= NULL
);
349 client_p
->localClient
->safelist_data
= params
;
351 sendto_one(client_p
, form_str(RPL_LISTSTART
), me
.name
, client_p
->name
);
353 /* pop the client onto the queue for processing */
354 rb_dlinkAddAlloc(client_p
, &safelisting_clients
);
356 /* give the user some initial data to work with */
357 safelist_iterate_client(client_p
);
361 * safelist_client_release()
363 * inputs - pointer to Client being listed on
365 * side effects - the client is no longer being
368 static void safelist_client_release(struct Client
*client_p
)
370 if(!MyClient(client_p
))
373 s_assert(MyClient(client_p
));
375 rb_dlinkFindDestroy(client_p
, &safelisting_clients
);
377 rb_free(client_p
->localClient
->safelist_data
->chname
);
378 rb_free(client_p
->localClient
->safelist_data
);
380 client_p
->localClient
->safelist_data
= NULL
;
382 sendto_one(client_p
, form_str(RPL_LISTEND
), me
.name
, client_p
->name
);
386 * safelist_channel_named()
388 * inputs - client pointer, channel name, operspy
390 * side effects - a named channel is listed
392 static void safelist_channel_named(struct Client
*source_p
, const char *name
, int operspy
)
394 struct Channel
*chptr
;
398 sendto_one(source_p
, form_str(RPL_LISTSTART
), me
.name
, source_p
->name
);
400 if ((p
= strchr(name
, ',')))
405 sendto_one_numeric(source_p
, ERR_NOSUCHNICK
, form_str(ERR_NOSUCHNICK
), name
);
406 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
410 chptr
= find_channel(name
);
414 sendto_one_numeric(source_p
, ERR_NOSUCHNICK
, form_str(ERR_NOSUCHNICK
), name
);
415 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
419 visible
= !SecretChannel(chptr
) || IsMember(source_p
, chptr
);
420 if (visible
|| operspy
)
421 list_one_channel(source_p
, chptr
, visible
);
423 sendto_one(source_p
, form_str(RPL_LISTEND
), me
.name
, source_p
->name
);
428 * safelist_one_channel()
430 * inputs - client pointer and channel pointer
432 * side effects - a channel is listed if it meets the
435 static void safelist_one_channel(struct Client
*source_p
, struct Channel
*chptr
, struct ListClient
*params
)
439 visible
= !SecretChannel(chptr
) || IsMember(source_p
, chptr
);
440 if (!visible
&& !params
->operspy
)
443 if ((unsigned int)chptr
->members
.length
< params
->users_min
444 || (unsigned int)chptr
->members
.length
> params
->users_max
)
447 if (params
->topic_min
&& chptr
->topic_time
< params
->topic_min
)
450 /* If a topic TS is provided, don't show channels without a topic set. */
451 if (params
->topic_max
&& (chptr
->topic_time
> params
->topic_max
452 || chptr
->topic_time
== 0))
455 if (params
->created_min
&& chptr
->channelts
< params
->created_min
)
458 if (params
->created_max
&& chptr
->channelts
> params
->created_max
)
461 list_one_channel(source_p
, chptr
, visible
);
465 * safelist_iterate_client()
467 * inputs - client pointer
469 * side effects - the client's sendq is filled up again
471 static void safelist_iterate_client(struct Client
*source_p
)
473 struct Channel
*chptr
;
474 rb_radixtree_iteration_state iter
;
476 RB_RADIXTREE_FOREACH_FROM(chptr
, &iter
, channel_tree
, source_p
->localClient
->safelist_data
->chname
)
478 if (safelist_sendq_exceeded(source_p
->from
))
480 rb_free(source_p
->localClient
->safelist_data
->chname
);
481 source_p
->localClient
->safelist_data
->chname
= rb_strdup(chptr
->chname
);
486 safelist_one_channel(source_p
, chptr
, source_p
->localClient
->safelist_data
);
489 safelist_client_release(source_p
);
492 static void safelist_iterate_clients(void *unused
)
494 rb_dlink_node
*n
, *n2
;
496 RB_DLINK_FOREACH_SAFE(n
, n2
, safelisting_clients
.head
)
497 safelist_iterate_client((struct Client
*)n
->data
);