]> jfr.im git - solanum.git/blobdiff - modules/m_cap.c
Message handlers should return void.
[solanum.git] / modules / m_cap.c
index bf9299533f398990ca47970ddb05735e04522980..726fbe4a894e55db5d85f957aefbb2e322293cb2 100644 (file)
@@ -1,7 +1,8 @@
 /* modules/m_cap.c
- * 
+ *
  *  Copyright (C) 2005 Lee Hardy <lee@leeh.co.uk>
  *  Copyright (C) 2005 ircd-ratbox development team
+ *  Copyright (C) 2016 William Pitcock <nenolod@dereferenced.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
@@ -26,8 +27,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_cap.c 676 2006-02-03 20:05:09Z gxti $
  */
 
 #include "stdinc.h"
 #include "modules.h"
 #include "s_serv.h"
 #include "s_user.h"
+#include "send.h"
+#include "s_conf.h"
+#include "hash.h"
+
+static const char cap_desc[] = "Provides the commands used for client capability negotiation";
 
 typedef int (*bqcmp)(const void *, const void *);
 
-static int m_cap(struct Client *, struct Client *, int, const char **);
-static int modinit(void);
+static void m_cap(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
 
 struct Message cap_msgtab = {
-       "CAP", 0, 0, 0, MFLG_SLOW,
+       "CAP", 0, 0, 0, 0,
        {{m_cap, 2}, {m_cap, 2}, mg_ignore, mg_ignore, mg_ignore, {m_cap, 2}}
 };
 
 mapi_clist_av1 cap_clist[] = { &cap_msgtab, NULL };
-DECLARE_MODULE_AV1(cap, modinit, NULL, cap_clist, NULL, NULL, "$Revision: 676 $");
 
-#define _CLICAP(name, capserv, capclient, flags)       \
-       { (name), (capserv), (capclient), (flags), sizeof(name) - 1 }
+DECLARE_MODULE_AV2(cap, NULL, NULL, cap_clist, NULL, NULL, NULL, NULL, cap_desc);
 
-#define CLICAP_FLAGS_STICKY    0x001
+#define IsCapableEntry(c, e)           IsCapable(c, 1 << (e)->value)
+#define HasCapabilityFlag(c, f)                (c->ownerdata != NULL && (((struct ClientCapability *)c->ownerdata)->flags & (f)) == f)
 
-static struct clicap
+static inline int
+clicap_visible(struct Client *client_p, const struct CapabilityEntry *cap)
 {
-       const char *name;
-       int cap_serv;           /* for altering s->c */
-       int cap_cli;            /* for altering c->s */
-       int flags;
-       int namelen;
-} clicap_list[] = {
-       _CLICAP("multi-prefix", CLICAP_MULTI_PREFIX, 0, 0),
-       _CLICAP("sasl", CLICAP_SASL, 0, 0),
-       _CLICAP("source-account-hostmask", CLICAP_ACCOUNT_HOSTMASK, 0, 0),
-};
+       struct ClientCapability *clicap;
 
-#define CLICAP_LIST_LEN (sizeof(clicap_list) / sizeof(struct clicap))
+       /* orphaned caps shouldn't be visible */
+       if (cap->flags & CAP_ORPHANED)
+               return 0;
 
-static int clicap_sort(struct clicap *, struct clicap *);
+       if (cap->ownerdata == NULL)
+               return 1;
 
-static int
-modinit(void)
-{
-       qsort(clicap_list, CLICAP_LIST_LEN, sizeof(struct clicap),
-               (bqcmp) clicap_sort);
-       return 0;
-}
+       clicap = cap->ownerdata;
+       if (clicap->visible == NULL)
+               return 1;
 
-static int
-clicap_sort(struct clicap *one, struct clicap *two)
-{
-       return irccmp(one->name, two->name);
-}
-
-static int
-clicap_compare(const char *name, struct clicap *cap)
-{
-       return irccmp(name, cap->name);
+       return clicap->visible(client_p);
 }
 
 /* clicap_find()
@@ -105,12 +89,12 @@ clicap_compare(const char *name, struct clicap *cap)
  *         int pointer to whether we finish with success
  * Ouputs: Cap entry if found, NULL otherwise.
  */
-static struct clicap *
+static struct CapabilityEntry *
 clicap_find(const char *data, int *negate, int *finished)
 {
        static char buf[BUFSIZE];
        static char *p;
-       struct clicap *cap;
+       struct CapabilityEntry *cap;
        char *s;
 
        *negate = 0;
@@ -147,8 +131,7 @@ clicap_find(const char *data, int *negate, int *finished)
        if((s = strchr(p, ' ')))
                *s++ = '\0';
 
-       if((cap = bsearch(p, clicap_list, CLICAP_LIST_LEN, 
-                               sizeof(struct clicap), (bqcmp) clicap_compare)))
+       if((cap = capability_find(cli_capindex, p)) != NULL)
        {
                if(s)
                        p = s;
@@ -170,21 +153,18 @@ clicap_find(const char *data, int *negate, int *finished)
 static void
 clicap_generate(struct Client *source_p, const char *subcmd, int flags, int clear)
 {
-       char buf[BUFSIZE];
-       char capbuf[BUFSIZE];
-       char *p;
+       char buf[BUFSIZE] = { 0 };
+       char capbuf[BUFSIZE] = { 0 };
        int buflen = 0;
        int curlen, mlen;
-       size_t i;
+       struct CapabilityEntry *entry;
+       struct DictionaryIter iter;
 
-       mlen = rb_sprintf(buf, ":%s CAP %s %s",
-                       me.name, 
-                       EmptyString(source_p->name) ? "*" : source_p->name, 
+       mlen = snprintf(buf, sizeof buf, ":%s CAP %s %s",
+                       me.name,
+                       EmptyString(source_p->name) ? "*" : source_p->name,
                        subcmd);
 
-       p = capbuf;
-       buflen = mlen;
-
        /* shortcut, nothing to do */
        if(flags == -1)
        {
@@ -192,75 +172,51 @@ clicap_generate(struct Client *source_p, const char *subcmd, int flags, int clea
                return;
        }
 
-       for(i = 0; i < CLICAP_LIST_LEN; i++)
+       DICTIONARY_FOREACH(entry, &iter, cli_capindex->cap_dict)
        {
+               size_t caplen = 0;
+               struct ClientCapability *clicap = entry->ownerdata;
+               const char *data = NULL;
+
                if(flags)
                {
-                       if(!IsCapable(source_p, clicap_list[i].cap_serv))
+                       if(!IsCapableEntry(source_p, entry))
                                continue;
                        /* they are capable of this, check sticky */
-                       else if(clear && clicap_list[i].flags & CLICAP_FLAGS_STICKY)
+                       else if(clear && HasCapabilityFlag(entry, CLICAP_FLAGS_STICKY))
                                continue;
                }
 
+               if (!clicap_visible(source_p, entry))
+                       continue;
+
+               caplen = strlen(entry->cap);
+               if (!flags && (source_p->flags & FLAGS_CLICAP_DATA) && clicap != NULL && clicap->data != NULL)
+                       data = clicap->data(source_p);
+
+               if (data != NULL)
+                       caplen += strlen(data) + 1;
+
                /* \r\n\0, possible "-~=", space, " *" */
-               if(buflen + clicap_list[i].namelen >= BUFSIZE - 10)
+               if(buflen + mlen >= BUFSIZE - 10)
                {
                        /* remove our trailing space -- if buflen == mlen
                         * here, we didnt even succeed in adding one.
                         */
-                       if(buflen != mlen)
-                               *(p - 1) = '\0';
-                       else
-                               *p = '\0';
+                       capbuf[buflen] = '\0';
 
                        sendto_one(source_p, "%s * :%s", buf, capbuf);
-                       p = capbuf;
-                       buflen = mlen;
-               }
-
-               if(clear)
-               {
-                       *p++ = '-';
-                       buflen++;
 
-                       /* needs a client ack */
-                       if(clicap_list[i].cap_cli && 
-                          IsCapable(source_p, clicap_list[i].cap_cli))
-                       {
-                               *p++ = '~';
-                               buflen++;
-                       }
-               }
-               else
-               {
-                       if(clicap_list[i].flags & CLICAP_FLAGS_STICKY)
-                       {
-                               *p++ = '=';
-                               buflen++;
-                       }
-
-                       /* if we're doing an LS, then we only send this if
-                        * they havent ack'd
-                        */
-                       if(clicap_list[i].cap_cli &&
-                          (!flags || !IsCapable(source_p, clicap_list[i].cap_cli)))
-                       {
-                               *p++ = '~';
-                               buflen++;
-                       }
+                       buflen = mlen;
+                       memset(capbuf, 0, sizeof capbuf);
                }
 
-               curlen = rb_sprintf(p, "%s ", clicap_list[i].name);
-               p += curlen;
-               buflen += curlen;
+               buflen = rb_snprintf_append(capbuf, sizeof capbuf, "%s%s%s%s ",
+                               clear ? "-" : "", entry->cap, data != NULL ? "=" : "", data != NULL ? data : "");
        }
 
        /* remove trailing space */
-       if(buflen != mlen)
-               *(p - 1) = '\0';
-       else
-               *p = '\0';
+       capbuf[buflen] = '\0';
 
        sendto_one(source_p, "%s :%s", buf, capbuf);
 }
@@ -268,7 +224,7 @@ clicap_generate(struct Client *source_p, const char *subcmd, int flags, int clea
 static void
 cap_ack(struct Client *source_p, const char *arg)
 {
-       struct clicap *cap;
+       struct CapabilityEntry *cap;
        int capadd = 0, capdel = 0;
        int finished = 0, negate;
 
@@ -279,19 +235,19 @@ cap_ack(struct Client *source_p, const char *arg)
            cap = clicap_find(NULL, &negate, &finished))
        {
                /* sent an ACK for something they havent REQd */
-               if(!IsCapable(source_p, cap->cap_serv))
+               if(!IsCapableEntry(source_p, cap))
                        continue;
 
                if(negate)
                {
                        /* dont let them ack something sticky off */
-                       if(cap->flags & CLICAP_FLAGS_STICKY)
+                       if(HasCapabilityFlag(cap, CLICAP_FLAGS_STICKY))
                                continue;
 
-                       capdel |= cap->cap_cli;
+                       capdel |= (1 << cap->value);
                }
                else
-                       capadd |= cap->cap_cli;
+                       capadd |= (1 << cap->value);
        }
 
        source_p->localClient->caps |= capadd;
@@ -301,15 +257,10 @@ cap_ack(struct Client *source_p, const char *arg)
 static void
 cap_clear(struct Client *source_p, const char *arg)
 {
-       clicap_generate(source_p, "ACK", 
+       clicap_generate(source_p, "ACK",
                        source_p->localClient->caps ? source_p->localClient->caps : -1, 1);
 
-       /* XXX - sticky capabs */
-#ifdef CLICAP_STICKY
-       source_p->localClient->caps = source_p->localClient->caps & CLICAP_STICKY;
-#else
        source_p->localClient->caps = 0;
-#endif
 }
 
 static void
@@ -322,9 +273,7 @@ cap_end(struct Client *source_p, const char *arg)
 
        if(source_p->name[0] && source_p->flags & FLAGS_SENTUSER)
        {
-               char buf[USERLEN+1];
-               rb_strlcpy(buf, source_p->username, sizeof(buf));
-               register_local_user(source_p, source_p, buf);
+               register_local_user(source_p, source_p);
        }
 }
 
@@ -342,6 +291,12 @@ cap_ls(struct Client *source_p, const char *arg)
        if(!IsRegistered(source_p))
                source_p->flags |= FLAGS_CLICAP;
 
+       if (arg != NULL && !strcmp(arg, "302"))
+       {
+               source_p->flags |= FLAGS_CLICAP_DATA;
+               source_p->localClient->caps |= CLICAP_CAP_NOTIFY;
+       }
+
        /* list of what we support */
        clicap_generate(source_p, "LS", 0, 0);
 }
@@ -351,7 +306,7 @@ cap_req(struct Client *source_p, const char *arg)
 {
        char buf[BUFSIZE];
        char pbuf[2][BUFSIZE];
-       struct clicap *cap;
+       struct CapabilityEntry *cap;
        int buflen, plen;
        int i = 0;
        int capadd = 0, capdel = 0;
@@ -363,7 +318,7 @@ cap_req(struct Client *source_p, const char *arg)
        if(EmptyString(arg))
                return;
 
-       buflen = rb_snprintf(buf, sizeof(buf), ":%s CAP %s ACK",
+       buflen = snprintf(buf, sizeof(buf), ":%s CAP %s ACK",
                        me.name, EmptyString(source_p->name) ? "*" : source_p->name);
 
        pbuf[0][0] = '\0';
@@ -372,11 +327,13 @@ cap_req(struct Client *source_p, const char *arg)
        for(cap = clicap_find(arg, &negate, &finished); cap;
            cap = clicap_find(NULL, &negate, &finished))
        {
+               size_t namelen = strlen(cap->cap);
+
                /* filled the first array, but cant send it in case the
                 * request fails.  one REQ should never fill more than two
                 * buffers --fl
                 */
-               if(buflen + plen + cap->namelen + 6 >= BUFSIZE)
+               if(buflen + plen + namelen + 6 >= BUFSIZE)
                {
                        pbuf[1][0] = '\0';
                        plen = 0;
@@ -385,7 +342,7 @@ cap_req(struct Client *source_p, const char *arg)
 
                if(negate)
                {
-                       if(cap->flags & CLICAP_FLAGS_STICKY)
+                       if(HasCapabilityFlag(cap, CLICAP_FLAGS_STICKY))
                        {
                                finished = 0;
                                break;
@@ -394,28 +351,31 @@ cap_req(struct Client *source_p, const char *arg)
                        strcat(pbuf[i], "-");
                        plen++;
 
-                       capdel |= cap->cap_serv;
+                       capdel |= (1 << cap->value);
                }
                else
                {
-                       if(cap->flags & CLICAP_FLAGS_STICKY)
+                       if (!clicap_visible(source_p, cap))
                        {
-                               strcat(pbuf[i], "=");
-                               plen++;
+                               finished = 0;
+                               break;
                        }
 
-                       capadd |= cap->cap_serv;
+                       capadd |= (1 << cap->value);
                }
 
-               if(cap->cap_cli)
+               /* XXX this probably should exclude REQACK'd caps from capadd/capdel, but keep old behaviour for now */
+               if(HasCapabilityFlag(cap, CLICAP_FLAGS_REQACK))
                {
                        strcat(pbuf[i], "~");
                        plen++;
                }
 
-               strcat(pbuf[i], cap->name);
-               strcat(pbuf[i], " ");
-               plen += (cap->namelen + 1);
+               strcat(pbuf[i], cap->cap);
+               if (!finished) {
+                       strcat(pbuf[i], " ");
+                       plen += (namelen + 1);
+               }
        }
 
        if(!finished)
@@ -457,8 +417,8 @@ clicap_cmd_search(const char *command, struct clicap_cmd *entry)
        return irccmp(command, entry->cmd);
 }
 
-static int
-m_cap(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
+static void
+m_cap(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
 {
        struct clicap_cmd *cmd;
 
@@ -469,9 +429,8 @@ m_cap(struct Client *client_p, struct Client *source_p, int parc, const char *pa
                sendto_one(source_p, form_str(ERR_INVALIDCAPCMD),
                                me.name, EmptyString(source_p->name) ? "*" : source_p->name,
                                parv[1]);
-               return 0;
+               return;
        }
 
        (cmd->func)(source_p, parv[2]);
-       return 0;
 }