]> jfr.im git - solanum.git/blobdiff - modules/m_list.c
extensions/umode_hide_idle_time: mask times for hidden sources (#373)
[solanum.git] / modules / m_list.c
index fbecd52034e4e64cc00f41a508bd3fd7395d01fe..c50d508a3c5453486ee7691db822a63da5028aeb 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * charybdis: An advanced ircd.
+ * Solanum: a slightly advanced ircd
  * m_list_safelist.c: Version of /list that uses the safelist code.
  *
- * Copyright (c) 2006 William Pitcock <nenolod@nenolod.net>
+ * Copyright (c) 2006 Ariadne Conill <ariadne@dereferenced.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
@@ -29,8 +29,6 @@
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
- *
- * $Id: m_list.c 3372 2007-04-03 10:18:07Z nenolod $
  */
 
 #include "stdinc.h"
 #include "inline/stringops.h"
 #include "s_assert.h"
 #include "logger.h"
+#include "rb_radixtree.h"
+
+static const char list_desc[] = "Provides the LIST command to clients to view non-hidden channels";
+
+static rb_dlink_list safelisting_clients = { NULL, NULL, 0 };
+
+static struct ev_entry *iterate_clients_ev = NULL;
 
 static int _modinit(void);
 static void _moddeinit(void);
 
-static int m_list(struct Client *, struct Client *, int, const char **);
-static int mo_list(struct Client *, struct Client *, int, const char **);
-
-struct ListOptions
-{
-       unsigned int users_min, users_max;
-       time_t created_min, created_max, topic_min, topic_max;
-       int operspy;
-};
+static void m_list(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
+static void mo_list(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
 
 static void list_one_channel(struct Client *source_p, struct Channel *chptr, int visible);
 
-static void safelist_one_channel(struct Client *source_p, struct Channel *chptr, struct ListOptions *params);
+static void safelist_one_channel(struct Client *source_p, struct Channel *chptr, struct ListClient *params);
+static void safelist_check_cliexit(void *);
+static void safelist_client_instantiate(struct Client *, struct ListClient *);
+static void safelist_client_release(struct Client *);
+static void safelist_iterate_client(struct Client *source_p);
+static void safelist_iterate_clients(void *unused);
 static void safelist_channel_named(struct Client *source_p, const char *name, int operspy);
 
 struct Message list_msgtab = {
-       "LIST", 0, 0, 0, MFLG_SLOW,
+       "LIST", 0, 0, 0, 0,
        {mg_unreg, {m_list, 0}, mg_ignore, mg_ignore, mg_ignore, {mo_list, 0}}
 };
 
 mapi_clist_av1 list_clist[] = { &list_msgtab, NULL };
 
-DECLARE_MODULE_AV1(list, _modinit, _moddeinit, list_clist, NULL, NULL, "$Revision: 3372 $");
+mapi_hfn_list_av1 list_hfnlist[] = {
+       {"client_exit", safelist_check_cliexit},
+       {NULL, NULL}
+};
+
+DECLARE_MODULE_AV2(list, _modinit, _moddeinit, list_clist, NULL, list_hfnlist, NULL, NULL, list_desc);
 
 static int _modinit(void)
 {
+       iterate_clients_ev = rb_event_add("safelist_iterate_clients", safelist_iterate_clients, NULL, 3);
+
        /* ELIST=[tokens]:
         *
         * M = mask search
@@ -90,27 +100,49 @@ static int _modinit(void)
         * T = topic search (T> T<)
         */
        add_isupport("SAFELIST", isupport_string, "");
-       add_isupport("ELIST", isupport_string, "CTU");
+       add_isupport("ELIST", isupport_string, "CMNTU");
 
        return 0;
 }
 
 static void _moddeinit(void)
 {
+       rb_event_delete(iterate_clients_ev);
+
        delete_isupport("SAFELIST");
        delete_isupport("ELIST");
 }
 
+static void safelist_check_cliexit(void *data)
+{
+       hook_data_client_exit * hdata = data;
+       /* Cancel the safelist request if we are disconnecting
+        * from the server. That way it doesn't core. :P --nenolod
+        */
+       if (MyClient(hdata->target) && hdata->target->localClient->safelist_data != NULL)
+       {
+               safelist_client_release(hdata->target);
+       }
+}
+
 /* m_list()
  *      parv[1] = channel
  *
  * XXX - With SAFELIST, do we really need to continue pacing?
  *       In theory, the server cannot be lagged by this. --nenolod
  */
-static int m_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
+static void
+m_list(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
 {
        static time_t last_used = 0L;
 
+       if (source_p->localClient->safelist_data != NULL)
+       {
+               sendto_one_notice(source_p, ":/LIST aborted");
+               safelist_client_release(source_p);
+               return;
+       }
+
        if (parc < 2 || !IsChannelName(parv[1]))
        {
                /* pace this due to the sheer traffic involved */
@@ -118,30 +150,33 @@ static int m_list(struct Client *client_p, struct Client *source_p, int parc, co
                {
                        sendto_one(source_p, form_str(RPL_LOAD2HI), me.name, source_p->name, "LIST");
                        sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
-                       return 0;
+                       return;
                }
                else
                        last_used = rb_current_time();
        }
 
-       return mo_list(client_p, source_p, parc, parv);
+       mo_list(msgbuf_p, client_p, source_p, parc, parv);
 }
 
 /* mo_list()
  *      parv[1] = channel
  */
-static int mo_list(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
+static void
+mo_list(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
 {
-       struct ListOptions *params;
+       struct ListClient *params;
        char *p;
        char *args = NULL;
        int i;
        int operspy = 0;
-       int sendq_limit = get_sendq_hard(client_p);
-       rb_dlink_node *ptr;
 
-       sendq_limit /= 10;
-       sendq_limit *= 9;
+       if (source_p->localClient->safelist_data != NULL)
+       {
+               sendto_one_notice(source_p, ":/LIST aborted");
+               safelist_client_release(source_p);
+               return;
+       }
 
        if (parc > 1)
        {
@@ -156,20 +191,22 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
        }
 
        /* Single channel. */
-       if (args && IsChannelName(args))
+       if (args && IsChannelName(args) && !strpbrk(args, "*?, "))
        {
                safelist_channel_named(source_p, args, operspy);
-               return 0;
+               return;
        }
 
        /* Multiple channels, possibly with parameters. */
-       params = rb_malloc(sizeof(struct ListOptions));
+       params = rb_malloc(sizeof(struct ListClient));
 
        params->users_min = ConfigChannel.displayed_usercount;
        params->users_max = INT_MAX;
        params->operspy = operspy;
        params->created_min = params->topic_min =
                params->created_max = params->topic_max = 0;
+       params->mask = NULL;
+       params->nomask = NULL;
 
        if (args && !EmptyString(args))
        {
@@ -184,22 +221,23 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
                        if (*args == '<')
                        {
                                args++;
-                               if (IsDigit(*args))
-                               {
-                                       params->users_max = atoi(args);
-                                       if (params->users_max == 0)
-                                               params->users_max = INT_MAX;
-                                       else
-                                               params->users_max--;
-                               }
+                               if (!IsDigit(*args)) goto fail;
+
+                               params->users_max = atoi(args);
+                               if (params->users_max == 0)
+                                       params->users_max = INT_MAX;
+                               else
+                                       params->users_max--;
                        }
                        else if (*args == '>')
                        {
                                args++;
                                if (IsDigit(*args))
                                        params->users_min = atoi(args) + 1;
-                               else
+                               else if (args[0] == '-' && IsDigit(args[1]))
                                        params->users_min = 0;
+                               else
+                                       goto fail;
                        }
                        else if (*args == 'C' || *args == 'c')
                        {
@@ -208,19 +246,19 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
                                {
                                        /* Creation time earlier than last x minutes. */
                                        args++;
-                                       if (IsDigit(*args))
-                                       {
-                                               params->created_max = rb_current_time() - (60 * atoi(args));
-                                       }
+                                       if (!IsDigit(*args)) goto fail;
+                                       params->created_max = rb_current_time() - (60 * atoi(args));
                                }
                                else if (*args == '<')
                                {
                                        /* Creation time within last x minutes. */
                                        args++;
-                                       if (IsDigit(*args))
-                                       {
-                                               params->created_min = rb_current_time() - (60 * atoi(args));
-                                       }
+                                       if (!IsDigit(*args)) goto fail;
+                                       params->created_min = rb_current_time() - (60 * atoi(args));
+                               }
+                               else
+                               {
+                                       goto fail;
                                }
                        }
                        else if (*args == 'T' || *args == 't')
@@ -230,21 +268,36 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
                                {
                                        /* Topic change time earlier than last x minutes. */
                                        args++;
-                                       if (IsDigit(*args))
-                                       {
-                                               params->topic_max = rb_current_time() - (60 * atoi(args));
-                                       }
+                                       if (!IsDigit(*args)) goto fail;
+                                       params->topic_max = rb_current_time() - (60 * atoi(args));
                                }
                                else if (*args == '<')
                                {
                                        /* Topic change time within last x minutes. */
                                        args++;
-                                       if (IsDigit(*args))
-                                       {
-                                               params->topic_min = rb_current_time() - (60 * atoi(args));
-                                       }
+                                       if (!IsDigit(*args)) goto fail;
+                                       params->topic_min = rb_current_time() - (60 * atoi(args));
+                               }
+                               else
+                               {
+                                       goto fail;
                                }
                        }
+                       else if (*args == '!')
+                       {
+                               args++;
+                               rb_free(params->nomask);
+                               params->nomask = rb_strdup(args);
+                       }
+                       else if (*args == '?' || *args == '*' || IsChanPrefix(*args))
+                       {
+                               rb_free(params->mask);
+                               params->mask = rb_strdup(args);
+                       }
+                       else
+                       {
+                               goto fail;
+                       }
 
                        if (EmptyString(p))
                                break;
@@ -253,22 +306,14 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
                }
        }
 
-       sendto_one(client_p, form_str(RPL_LISTSTART), me.name, client_p->name);
-
-       RB_DLINK_FOREACH(ptr, global_channel_list.head)
-       {
-               safelist_one_channel(client_p, ptr->data, params);
-
-               if (rb_linebuf_len(&client_p->localClient->buf_sendq) > sendq_limit)
-               {
-                       sendto_one(source_p, form_str(ERR_TOOMANYMATCHES), me.name, source_p->name, "LIST");
-                       break;
-               }
-       }
+       safelist_client_instantiate(source_p, params);
+       return;
 
+fail:
+       rb_free(params);
+       sendto_one(source_p, form_str(RPL_LISTSTART), me.name, source_p->name);
+       sendto_one_notice(source_p, ":Invalid parameters for /LIST");
        sendto_one(source_p, form_str(RPL_LISTEND), me.name, source_p->name);
-
-       return 0;
 }
 
 /*
@@ -281,29 +326,96 @@ static int mo_list(struct Client *client_p, struct Client *source_p, int parc, c
 static void list_one_channel(struct Client *source_p, struct Channel *chptr,
                int visible)
 {
+       char topic[TOPICLEN + 1];
+
+       if (chptr->topic != NULL)
+               rb_strlcpy(topic, chptr->topic, sizeof topic);
+       else
+               topic[0] = '\0';
+       strip_colour(topic);
        sendto_one(source_p, form_str(RPL_LIST), me.name, source_p->name,
                   visible ? "" : "!",
                   chptr->chname, rb_dlink_list_length(&chptr->members),
-                  chptr->topic != NULL ? chptr->topic : "");
+                  topic);
 }
 
 /*
  * safelist_sendq_exceeded()
  *
  * inputs       - pointer to client that needs checking
- * outputs      - 1 if a client has exceeded the reserved
- *                sendq limit, 0 if not
+ * outputs      - true if a client has exceeded the reserved
+ *                sendq limit, false if not
  * side effects - none
  *
  * When safelisting, we only use half of the SendQ at any
  * given time.
  */
-static int safelist_sendq_exceeded(struct Client *client_p)
+static bool safelist_sendq_exceeded(struct Client *client_p)
 {
-       if (rb_linebuf_len(&client_p->localClient->buf_sendq) > (get_sendq(client_p) / 2))
-               return YES;
-       else
-               return NO;
+       return rb_linebuf_len(&client_p->localClient->buf_sendq) > (get_sendq(client_p) / 2);
+}
+
+/*
+ * safelist_client_instantiate()
+ *
+ * inputs       - pointer to Client to be listed,
+ *                pointer to ListClient for params
+ * outputs      - none
+ * side effects - the safelist process begins for a
+ *                client.
+ *
+ * Please do not ever call this on a non-local client.
+ * If you do, you will get SIGSEGV.
+ */
+static void safelist_client_instantiate(struct Client *client_p, struct ListClient *params)
+{
+       struct Channel *chptr;
+
+       s_assert(MyClient(client_p));
+       s_assert(params != NULL);
+
+       client_p->localClient->safelist_data = params;
+
+       sendto_one(client_p, form_str(RPL_LISTSTART), me.name, client_p->name);
+
+       /* pop the client onto the queue for processing */
+       rb_dlinkAddAlloc(client_p, &safelisting_clients);
+
+       /* give the user some initial data to work with */
+       if (params->mask && (chptr = find_channel(params->mask)))
+       {
+               bool visible = !SecretChannel(chptr) || IsMember(client_p, chptr);
+               if (visible || params->operspy)
+                       list_one_channel(client_p, chptr, visible);
+       }
+       safelist_iterate_client(client_p);
+}
+
+/*
+ * safelist_client_release()
+ *
+ * inputs       - pointer to Client being listed on
+ * outputs      - none
+ * side effects - the client is no longer being
+ *                listed
+ */
+static void safelist_client_release(struct Client *client_p)
+{
+       if(!MyClient(client_p))
+               return;
+
+       s_assert(MyClient(client_p));
+
+       rb_dlinkFindDestroy(client_p, &safelisting_clients);
+
+       rb_free(client_p->localClient->safelist_data->chname);
+       rb_free(client_p->localClient->safelist_data->mask);
+       rb_free(client_p->localClient->safelist_data->nomask);
+       rb_free(client_p->localClient->safelist_data);
+
+       client_p->localClient->safelist_data = NULL;
+
+       sendto_one(client_p, form_str(RPL_LISTEND), me.name, client_p->name);
 }
 
 /*
@@ -356,7 +468,7 @@ static void safelist_channel_named(struct Client *source_p, const char *name, in
  * side effects - a channel is listed if it meets the
  *                requirements
  */
-static void safelist_one_channel(struct Client *source_p, struct Channel *chptr, struct ListOptions *params)
+static void safelist_one_channel(struct Client *source_p, struct Channel *chptr, struct ListClient *params)
 {
        int visible;
 
@@ -382,5 +494,47 @@ static void safelist_one_channel(struct Client *source_p, struct Channel *chptr,
        if (params->created_max && chptr->channelts > params->created_max)
                return;
 
+       if (params->mask && (!irccmp(params->mask, chptr->chname) || !match(params->mask, chptr->chname)))
+               return;
+
+       if (params->nomask && match(params->nomask, chptr->chname))
+               return;
+
        list_one_channel(source_p, chptr, visible);
 }
+
+/*
+ * safelist_iterate_client()
+ *
+ * inputs       - client pointer
+ * outputs      - none
+ * side effects - the client's sendq is filled up again
+ */
+static void safelist_iterate_client(struct Client *source_p)
+{
+       struct Channel *chptr;
+       rb_radixtree_iteration_state iter;
+
+       RB_RADIXTREE_FOREACH_FROM(chptr, &iter, channel_tree, source_p->localClient->safelist_data->chname)
+       {
+               if (safelist_sendq_exceeded(source_p->from))
+               {
+                       rb_free(source_p->localClient->safelist_data->chname);
+                       source_p->localClient->safelist_data->chname = rb_strdup(chptr->chname);
+
+                       return;
+               }
+
+               safelist_one_channel(source_p, chptr, source_p->localClient->safelist_data);
+       }
+
+       safelist_client_release(source_p);
+}
+
+static void safelist_iterate_clients(void *unused)
+{
+       rb_dlink_node *n, *n2;
+
+       RB_DLINK_FOREACH_SAFE(n, n2, safelisting_clients.head)
+               safelist_iterate_client((struct Client *)n->data);
+}