]> jfr.im git - solanum.git/blobdiff - modules/m_cap.c
Merge pull request #279 from edk0/operhide
[solanum.git] / modules / m_cap.c
index 2619c27cb81337759d03777caab30e9519a3c6e5..6dc58cbab55d71433ea407f945e132461d3f48e4 100644 (file)
 #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 MsgBuf *, struct Client *, struct Client *, int, const char **);
+static void m_cap(struct MsgBuf *, struct Client *, struct Client *, int, const char **);
 
 struct Message cap_msgtab = {
        "CAP", 0, 0, 0, 0,
@@ -54,16 +56,21 @@ struct Message cap_msgtab = {
 };
 
 mapi_clist_av1 cap_clist[] = { &cap_msgtab, NULL };
-DECLARE_MODULE_AV1(cap, NULL, NULL, cap_clist, NULL, NULL, "$Revision: 676 $");
+
+DECLARE_MODULE_AV2(cap, NULL, NULL, cap_clist, NULL, NULL, NULL, NULL, cap_desc);
 
 #define IsCapableEntry(c, e)           IsCapable(c, 1 << (e)->value)
 #define HasCapabilityFlag(c, f)                (c->ownerdata != NULL && (((struct ClientCapability *)c->ownerdata)->flags & (f)) == f)
 
 static inline int
-clicap_visible(const struct CapabilityEntry *cap)
+clicap_visible(struct Client *client_p, const struct CapabilityEntry *cap)
 {
        struct ClientCapability *clicap;
 
+       /* orphaned caps shouldn't be visible */
+       if (cap->flags & CAP_ORPHANED)
+               return 0;
+
        if (cap->ownerdata == NULL)
                return 1;
 
@@ -71,7 +78,7 @@ clicap_visible(const struct CapabilityEntry *cap)
        if (clicap->visible == NULL)
                return 1;
 
-       return clicap->visible();
+       return clicap->visible(client_p);
 }
 
 /* clicap_find()
@@ -139,84 +146,75 @@ clicap_find(const char *data, int *negate, int *finished)
  *   Generates a list of capabilities.
  *
  * Inputs: client to send to, subcmd to send,
- *         flags to match against: 0 to do none, -1 if client has no flags,
- *         int to whether we are doing CAP CLEAR
+ *         flags to match against: 0 to do none, -1 if client has no flags
  * Outputs: None
  */
 static void
-clicap_generate(struct Client *source_p, const char *subcmd, int flags, int clear)
+clicap_generate(struct Client *source_p, const char *subcmd, int flags)
 {
-       char buf[BUFSIZE];
-       char capbuf[BUFSIZE];
-       char *p;
-       int buflen = 0;
-       int curlen, mlen;
+       static char buf_prefix[DATALEN + 1];
+       static char buf_list[DATALEN + 1];
+       const char *str_cont = " * :";
+       const char *str_final = " :";
+       int len_prefix;
+       int max_list;
        struct CapabilityEntry *entry;
-       struct DictionaryIter iter;
+       rb_dictionary_iter iter;
 
-       mlen = sprintf(buf, ":%s CAP %s %s",
+       buf_prefix[0] = '\0';
+       len_prefix = rb_snprintf_try_append(buf_prefix, sizeof(buf_prefix),
+                       ":%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)
-       {
-               sendto_one(source_p, "%s :", buf);
+       if (flags == -1 || len_prefix < 0) {
+               sendto_one(source_p, "%s%s", buf_prefix, str_final);
                return;
        }
 
-       DICTIONARY_FOREACH(entry, &iter, cli_capindex->cap_dict)
-       {
-               if(flags)
-               {
-                       if(!IsCapableEntry(source_p, entry))
-                               continue;
-                       /* they are capable of this, check sticky */
-                       else if(clear && HasCapabilityFlag(entry, CLICAP_FLAGS_STICKY))
-                               continue;
-               }
+       buf_list[0] = '\0';
+       max_list = sizeof(buf_prefix) - len_prefix - strlen(str_cont);
+
+       RB_DICTIONARY_FOREACH(entry, &iter, cli_capindex->cap_dict) {
+               struct ClientCapability *clicap = entry->ownerdata;
+               const char *data = NULL;
 
-               if (!clicap_visible(entry))
+               if (flags && !IsCapableEntry(source_p, entry))
                        continue;
 
-               /* \r\n\0, possible "-~=", space, " *" */
-               if(buflen + strlen(entry->cap) >= 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';
-
-                       sendto_one(source_p, "%s * :%s", buf, capbuf);
-                       p = capbuf;
-                       buflen = mlen;
-               }
+               if (!clicap_visible(source_p, entry))
+                       continue;
 
-               if(clear)
-               {
-                       *p++ = '-';
-                       buflen++;
-               }
+               if (!flags && (source_p->flags & FLAGS_CLICAP_DATA) && clicap != NULL && clicap->data != NULL)
+                       data = clicap->data(source_p);
 
-               curlen = sprintf(p, "%s ", entry->cap);
-               p += curlen;
-               buflen += curlen;
-       }
+               for (int attempts = 0; attempts < 2; attempts++) {
+                       if (rb_snprintf_try_append(buf_list, max_list, "%s%s%s%s",
+                                       buf_list[0] == '\0' ? "" : " ", /* space between caps */
+                                       entry->cap,
+                                       data != NULL ? "=" : "", /* '=' between cap and data */
+                                       data != NULL ? data : "") < 0
+                                       && buf_list[0] != '\0') {
 
-       /* remove trailing space */
-       if(buflen != mlen)
-               *(p - 1) = '\0';
-       else
-               *p = '\0';
+                               if (!(source_p->flags & FLAGS_CLICAP_DATA)) {
+                                       /* the client doesn't support multiple lines */
+                                       break;
+                               }
+
+                               /* doesn't fit in the buffer, output what we have */
+                               sendto_one(source_p, "%s%s%s", buf_prefix, str_cont, buf_list);
+
+                               /* reset the buffer and go around the loop one more time */
+                               buf_list[0] = '\0';
+                       } else {
+                               break;
+                       }
+               }
+       }
 
-       sendto_one(source_p, "%s :%s", buf, capbuf);
+       sendto_one(source_p, "%s%s%s", buf_prefix, str_final, buf_list);
 }
 
 static void
@@ -252,15 +250,6 @@ cap_ack(struct Client *source_p, const char *arg)
        source_p->localClient->caps &= ~capdel;
 }
 
-static void
-cap_clear(struct Client *source_p, const char *arg)
-{
-       clicap_generate(source_p, "ACK",
-                       source_p->localClient->caps ? source_p->localClient->caps : -1, 1);
-
-       source_p->localClient->caps = 0;
-}
-
 static void
 cap_end(struct Client *source_p, const char *arg)
 {
@@ -280,26 +269,40 @@ cap_list(struct Client *source_p, const char *arg)
 {
        /* list of what theyre currently using */
        clicap_generate(source_p, "LIST",
-                       source_p->localClient->caps ? source_p->localClient->caps : -1, 0);
+                       source_p->localClient->caps ? source_p->localClient->caps : -1);
 }
 
 static void
 cap_ls(struct Client *source_p, const char *arg)
 {
+       int caps_version = 301;
+
        if(!IsRegistered(source_p))
                source_p->flags |= FLAGS_CLICAP;
 
+       if (!EmptyString(arg)) {
+               caps_version = atoi(arg);
+       }
+
+       if (caps_version >= 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);
+       clicap_generate(source_p, "LS", 0);
 }
 
 static void
 cap_req(struct Client *source_p, const char *arg)
 {
-       char buf[BUFSIZE];
-       char pbuf[2][BUFSIZE];
+       static char buf_prefix[DATALEN + 1];
+       static char buf_list[2][DATALEN + 1];
+       const char *str_cont = " * :";
+       const char *str_final = " :";
+       int len_prefix;
+       int max_list;
        struct CapabilityEntry *cap;
-       int buflen, plen;
        int i = 0;
        int capadd = 0, capdel = 0;
        int finished = 0, negate;
@@ -310,27 +313,20 @@ cap_req(struct Client *source_p, const char *arg)
        if(EmptyString(arg))
                return;
 
-       buflen = snprintf(buf, sizeof(buf), ":%s CAP %s ACK",
-                       me.name, EmptyString(source_p->name) ? "*" : source_p->name);
+       buf_prefix[0] = '\0';
+       len_prefix = rb_snprintf_try_append(buf_prefix, sizeof(buf_prefix),
+                       ":%s CAP %s ACK",
+                       me.name,
+                       EmptyString(source_p->name) ? "*" : source_p->name);
 
-       pbuf[0][0] = '\0';
-       plen = 0;
+       buf_list[0][0] = '\0';
+       buf_list[1][0] = '\0';
+       max_list = sizeof(buf_prefix) - len_prefix - strlen(str_cont);
 
        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 + namelen + 6 >= BUFSIZE)
-               {
-                       pbuf[1][0] = '\0';
-                       plen = 0;
-                       i = 1;
-               }
+               const char *type;
 
                if(negate)
                {
@@ -340,33 +336,52 @@ cap_req(struct Client *source_p, const char *arg)
                                break;
                        }
 
-                       strcat(pbuf[i], "-");
-                       plen++;
-
+                       type = "-";
                        capdel |= (1 << cap->value);
                }
                else
                {
-                       if (!clicap_visible(cap))
+                       if (!clicap_visible(source_p, cap))
                        {
                                finished = 0;
                                break;
                        }
 
+                       type = "";
                        capadd |= (1 << cap->value);
                }
 
                /* 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++;
+                       type = "~";
                }
 
-               strcat(pbuf[i], cap->cap);
-               if (!finished) {
-                       strcat(pbuf[i], " ");
-                       plen += (namelen + 1);
+               for (int attempts = 0; attempts < 2; attempts++) {
+                       if (rb_snprintf_try_append(buf_list[i], max_list, "%s%s%s",
+                                       buf_list[i][0] == '\0' ? "" : " ", /* space between caps */
+                                       type,
+                                       cap->cap) < 0
+                                       && buf_list[i][0] != '\0') {
+
+                               if (!(source_p->flags & FLAGS_CLICAP_DATA)) {
+                                       /* the client doesn't support multiple lines */
+                                       break;
+                               }
+
+                               /* doesn't fit in the buffer, move to the next one */
+                               if (i < 2) {
+                                       i++;
+                               } else {
+                                       /* uh-oh */
+                                       break;
+                               }
+
+                               /* reset the buffer and go around the loop one more time */
+                               buf_list[i][0] = '\0';
+                       } else {
+                               break;
+                       }
                }
        }
 
@@ -377,13 +392,12 @@ cap_req(struct Client *source_p, const char *arg)
                return;
        }
 
-       if(i)
-       {
-               sendto_one(source_p, "%s * :%s", buf, pbuf[0]);
-               sendto_one(source_p, "%s :%s", buf, pbuf[1]);
+       if (i) {
+               sendto_one(source_p, "%s%s%s", buf_prefix, str_cont, buf_list[0]);
+               sendto_one(source_p, "%s%s%s", buf_prefix, str_final, buf_list[1]);
+       } else {
+               sendto_one(source_p, "%s%s%s", buf_prefix, str_final, buf_list[0]);
        }
-       else
-               sendto_one(source_p, "%s :%s", buf, pbuf[0]);
 
        source_p->localClient->caps |= capadd;
        source_p->localClient->caps &= ~capdel;
@@ -396,7 +410,6 @@ static struct clicap_cmd
 } clicap_cmdlist[] = {
        /* This list *MUST* be in alphabetical order */
        { "ACK",        cap_ack         },
-       { "CLEAR",      cap_clear       },
        { "END",        cap_end         },
        { "LIST",       cap_list        },
        { "LS",         cap_ls          },
@@ -409,7 +422,7 @@ clicap_cmd_search(const char *command, struct clicap_cmd *entry)
        return irccmp(command, entry->cmd);
 }
 
-static int
+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;
@@ -421,9 +434,8 @@ m_cap(struct MsgBuf *msgbuf_p, struct Client *client_p, struct Client *source_p,
                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;
 }