modules/m_list.c

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