trunk/modules/m_cap.c

/*
 *  ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
 *
 *  Copyright (c) 2004 Kevin L. Mitchell <klmitch@mit.edu>
 *  Copyright (c) 2006-2014 ircd-hybrid development team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 *  USA
 */

/*! \file m_cap.c
 * \brief Includes required functions for processing the CAP command.
 * \version $Id$
 */

#include "stdinc.h"
#include "client.h"
#include "hash.h"
#include "ircd.h"
#include "numeric.h"
#include "user.h"
#include "send.h"
#include "parse.h"
#include "modules.h"
#include "irc_string.h"


#define CAPFL_HIDDEN    0x0001  /**< Do not advertize this capability */
#define CAPFL_PROHIBIT  0x0002  /**< Client may not set this capability */
#define CAPFL_PROTO     0x0004  /**< Cap must be acknowledged by client */
#define CAPFL_STICKY    0x0008  /**< Cap may not be cleared once set */

typedef int (*bqcmp)(const void *, const void *);

static struct capabilities
{
  unsigned int cap;
  unsigned int flags;
  const char *name;
  size_t namelen;
} capab_list[] = {
#define _CAP(cap, flags, name)  \
    { (cap), (flags), (name), sizeof(name) - 1 }
  _CAP(CAP_UHNAMES, 0, "userhost-in-names"),
  _CAP(CAP_MULTI_PREFIX, 0, "multi-prefix"),
  _CAP(CAP_AWAY_NOTIFY, 0, "away-notify")
#undef _CAP
};

#define CAPAB_LIST_LEN  (sizeof(capab_list) / sizeof(struct capabilities))

static int
capab_sort(const struct capabilities *cap1, const struct capabilities *cap2)
{
  return strcasecmp(cap1->name, cap2->name);
}

static int
capab_search(const char *key, const struct capabilities *cap)
{
  const char *rb = cap->name;

  while (ToLower(*key) == ToLower(*rb))  /* Walk equivalent part of strings */
    if (*key++ == '\0')  /* Hit the end, all right... */
      return 0;
    else    /* OK, let's move on... */
      rb++;

  /*
   * If the character they differ on happens to be a space, and it happens
   * to be the same length as the capability name, then we've found a
   * match; otherwise, return the difference of the two.
   */
  return (IsSpace(*key) && *rb == '\0') ? 0 : (ToLower(*key) - ToLower(*rb));
}

static struct capabilities *
find_cap(const char **caplist_p, int *neg_p)
{
  static int inited = 0;
  const char *caplist = *caplist_p;
  struct capabilities *cap = NULL;

  *neg_p = 0;  /* Clear negative flag... */

  if (!inited)
  {
    /* First, let's sort the array... */
    qsort(capab_list, CAPAB_LIST_LEN, sizeof(struct capabilities), (bqcmp)capab_sort);
    ++inited;
  }

  /* Next, find first non-whitespace character... */
  while (*caplist && IsSpace(*caplist))
    ++caplist;

  /* We are now at the beginning of an element of the list; is it negative? */
  if (*caplist == '-')
  {
    ++caplist;  /* Yes; step past the flag... */
    *neg_p = 1;  /* Remember that it is negative... */
  }

  /* OK, now see if we can look up the capability... */
  if (*caplist)
  {
    if (!(cap = bsearch(caplist, capab_list, CAPAB_LIST_LEN,
                        sizeof(struct capabilities),
                        (bqcmp)capab_search)))
    {
      /* Couldn't find the capability; advance to first whitespace character */
      while (*caplist && !IsSpace(*caplist))
        ++caplist;
    }
    else
      caplist += cap->namelen;  /* Advance to end of capability name */

    /* Strip trailing spaces */
    while (*caplist && IsSpace(*caplist))
      ++caplist;
  }

  assert(caplist != *caplist_p || !*caplist);  /* We *must* advance */

  /* Move ahead in capability list string--or zero pointer if we hit end */
  *caplist_p = *caplist ? caplist : 0;

  return cap;  /* And return the capability (if any) */
}

/** Send a CAP \a subcmd list of capability changes to \a source_p.
 * If more than one line is necessary, each line before the last has
 * an added "*" parameter before that line's capability list.
 * @param[in] source_p Client receiving capability list.
 * @param[in] set Capabilities to show as set (with ack and sticky modifiers).
 * @param[in] rem Capabalities to show as removed (with no other modifier).
 * @param[in] subcmd Name of capability subcommand.
 */
static int
send_caplist(struct Client *source_p, unsigned int set,
             unsigned int rem, const char *subcmd)
{
  char capbuf[IRCD_BUFSIZE] = "", pfx[16];
  char cmdbuf[IRCD_BUFSIZE] = "";
  unsigned int i, loc, len, flags, pfx_len, clen;

  /* Set up the buffer for the final LS message... */
  clen = snprintf(cmdbuf, sizeof(capbuf), ":%s CAP %s %s ", me.name,
                  source_p->name[0] ? source_p->name : "*", subcmd);

  for (i = 0, loc = 0; i < CAPAB_LIST_LEN; ++i)
  {
    flags = capab_list[i].flags;

    /*
     * This is a little bit subtle, but just involves applying de
     * Morgan's laws to the obvious check: We must display the
     * capability if (and only if) it is set in \a rem or \a set, or
     * if both are null and the capability is hidden.
     */
    if (!(rem && (rem & capab_list[i].cap)) &&
        !(set && (set & capab_list[i].cap)) &&
         (rem || set || (flags & CAPFL_HIDDEN)))
      continue;

    /* Build the prefix (space separator and any modifiers needed). */
    pfx_len = 0;

    if (loc)
      pfx[pfx_len++] = ' ';
    if (rem && (rem & capab_list[i].cap))
      pfx[pfx_len++] = '-';
    else
    {
      if (flags & CAPFL_PROTO)
        pfx[pfx_len++] = '~';
      if (flags & CAPFL_STICKY)
        pfx[pfx_len++] = '=';
    }

    pfx[pfx_len] = '\0';

    len = capab_list[i].namelen + pfx_len;  /* How much we'd add... */

    if (sizeof(capbuf) < (clen + loc + len + 15))
    {
      /* Would add too much; must flush */
      sendto_one(source_p, "%s* :%s", cmdbuf, capbuf);
      capbuf[(loc = 0)] = '\0';  /* Re-terminate the buffer... */
    }

    loc += snprintf(capbuf + loc, sizeof(capbuf) - loc,
                    "%s%s", pfx, capab_list[i].name);
  }

  sendto_one(source_p, "%s:%s", cmdbuf, capbuf);

  return 0;  /* Convenience return */
}

static int
cap_ls(struct Client *source_p, const char *caplist)
{
  if (IsUnknown(source_p))  /* Registration hasn't completed; suspend it... */
    source_p->localClient->registration |= REG_NEED_CAP;

  return send_caplist(source_p, 0, 0, "LS");  /* Send list of capabilities */
}

static int
cap_req(struct Client *source_p, const char *caplist)
{
  const char *cl = caplist;
  struct capabilities *cap = NULL;
  unsigned int set = 0, rem = 0;
  unsigned int cs = source_p->localClient->cap_client; /* capability set */
  unsigned int as = source_p->localClient->cap_active; /* active set */
  int neg = 0;

  if (IsUnknown(source_p))  /* Registration hasn't completed; suspend it... */
    source_p->localClient->registration |= REG_NEED_CAP;

  while (cl) {  /* Walk through the capabilities list... */
    if (!(cap = find_cap(&cl, &neg)) /* Look up capability... */
        || (!neg && (cap->flags & CAPFL_PROHIBIT))  /* Is it prohibited? */
        || (neg && (cap->flags & CAPFL_STICKY))) {  /* Is it sticky? */
      sendto_one(source_p, ":%s CAP %s NAK :%s", me.name,
                 source_p->name[0] ? source_p->name : "*", caplist);
      return 0;  /* Can't complete requested op... */
    }

    if (neg)
    {
      /* Set or clear the capability... */
      rem |=  cap->cap;
      set &= ~cap->cap;
      cs  &= ~cap->cap;

      if (!(cap->flags & CAPFL_PROTO))
        as &= ~cap->cap;
    }
    else
    {
      rem &= ~cap->cap;
      set |=  cap->cap;
      cs  |=  cap->cap;

      if (!(cap->flags & CAPFL_PROTO))
        as |= cap->cap;
    }
  }

  /* Notify client of accepted changes and copy over results. */
  send_caplist(source_p, set, rem, "ACK");

  source_p->localClient->cap_client = cs;
  source_p->localClient->cap_active = as;

  return 0;
}

static int
cap_ack(struct Client *source_p, const char *caplist)
{
  const char *cl = caplist;
  struct capabilities *cap = NULL;
  int neg = 0;

  /*
   * Coming from the client, this generally indicates that the client
   * is using a new backwards-incompatible protocol feature. As such,
   * it does not require further response from the server.
   */
  while (cl)
  {
    /* Walk through the capabilities list... */
    if (!(cap = find_cap(&cl, &neg)) ||  /* Look up capability... */
        (neg ? (source_p->localClient->cap_active & cap->cap) :
              !(source_p->localClient->cap_active & cap->cap)))  /* uh... */
      continue;

    if (neg)  /* Set or clear the active capability... */
      source_p->localClient->cap_active &= ~cap->cap;
    else
      source_p->localClient->cap_active |=  cap->cap;
  }

  return 0;
}

static int
cap_clear(struct Client *source_p, const char *caplist)
{
  struct capabilities *cap = NULL;
  unsigned int ii;
  unsigned int cleared = 0;

  for (ii = 0; ii < CAPAB_LIST_LEN; ++ii)
  {
    cap = &capab_list[ii];

    /* Only clear active non-sticky capabilities. */
    if (!(source_p->localClient->cap_active & cap->cap) || (cap->flags & CAPFL_STICKY))
      continue;

    cleared |= cap->cap;
    source_p->localClient->cap_client &= ~cap->cap;

    if (!(cap->flags & CAPFL_PROTO))
      source_p->localClient->cap_active &= ~cap->cap;
  }

  return send_caplist(source_p, 0, cleared, "ACK");
}

static int
cap_end(struct Client *source_p, const char *caplist)
{
  if (!IsUnknown(source_p))  /* Registration has completed... */
    return 0;  /* So just ignore the message... */

  /* Capability negotiation is now done... */
  source_p->localClient->registration &= ~REG_NEED_CAP;

  /* If client is now done... */
  if (!source_p->localClient->registration)
  {
    register_local_user(source_p);
    return 0;
  }

  return 0;  /* Can't do registration yet... */
}

static int
cap_list(struct Client *source_p, const char *caplist)
{
  /* Send the list of the client's capabilities */
  return send_caplist(source_p, source_p->localClient->cap_client, 0, "LIST");
}

static struct subcmd
{
  const char *cmd;
  int (*proc)(struct Client *, const char *);
} cmdlist[] = {
  { "ACK",   cap_ack   },
  { "CLEAR", cap_clear },
  { "END",   cap_end   },
  { "LIST",  cap_list  },
  { "LS",    cap_ls    },
  { "NAK",   NULL      },
  { "REQ",   cap_req   }
};

static int
subcmd_search(const char *cmd, const struct subcmd *elem)
{
  return strcasecmp(cmd, elem->cmd);
}

/*! \brief CAP command handler
 *
 * \param source_p Pointer to allocated Client struct from which the message
 *                 originally comes from.  This can be a local or remote client.
 * \param parc     Integer holding the number of supplied arguments.
 * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
 *                 pointers.
 * \note Valid arguments for this command are:
 *      - parv[0] = command
 *      - parv[1] = CAP subcommand
 *      - parv[2] = space-separated list of capabilities
 */
static int
m_cap(struct Client *source_p, int parc, char *parv[])
{
  const char *subcmd = NULL, *caplist = NULL;
  struct subcmd *cmd = NULL;

  if (EmptyString(parv[1]))  /* A subcommand is required */
    return 0;

  subcmd = parv[1];

  if (parc > 2)  /* A capability list was provided */
    caplist = parv[2];

  /* Find the subcommand handler */
  if (!(cmd = bsearch(subcmd, cmdlist,
                      sizeof(cmdlist) / sizeof(struct subcmd),
                      sizeof(struct subcmd), (bqcmp)subcmd_search)))
  {
    sendto_one_numeric(source_p, &me, ERR_INVALIDCAPCMD, subcmd);
    return 0;
  }

  /* Then execute it... */
  if (cmd->proc)
    (cmd->proc)(source_p, caplist);
  return 0;
}

static struct Message cap_msgtab =
{
  "CAP", 0, 0, 2, MAXPARA, MFLG_SLOW, 0,
  { m_cap, m_cap, m_ignore, m_ignore, m_cap, m_ignore }
};

static void
module_init(void)
{
  mod_add_cmd(&cap_msgtab);
}

static void
module_exit(void)
{
  mod_del_cmd(&cap_msgtab);
}

struct module module_entry =
{
  .node    = { NULL, NULL, NULL },
  .name    = NULL,
  .version = "$Revision$",
  .handle  = NULL,
  .modinit = module_init,
  .modexit = module_exit,
  .flags   = 0
};
Revision:	3497
Committed:	Sat May 10 18:59:07 2014 UTC (11 years, 3 months ago) by michael
Content type:	text/x-csrc
File size:	12617 byte(s)
Log Message:	- m_cap.c: from p4: Ignore trailing spaces from CAP REQ/ACKs to prevent rejecting requests
#	User	Rev	Content
1	michael	503	/*
2	michael	2820	* ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon (ircd)
3	michael	503	*
4	michael	2820	* Copyright (c) 2004 Kevin L. Mitchell <klmitch@mit.edu>
5			* Copyright (c) 2006-2014 ircd-hybrid development team
6	michael	503	*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 2 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20			* USA
21			*/
22
23	michael	2820	/*! \file m_cap.c
24			* \brief Includes required functions for processing the CAP command.
25			* \version $Id$
26	michael	503	*/
27
28			#include "stdinc.h"
29			#include "client.h"
30			#include "hash.h"
31			#include "ircd.h"
32			#include "numeric.h"
33	michael	3347	#include "user.h"
34	michael	503	#include "send.h"
35			#include "parse.h"
36			#include "modules.h"
37			#include "irc_string.h"
38
39
40			#define CAPFL_HIDDEN 0x0001 /*< Do not advertize this capability /
41			#define CAPFL_PROHIBIT 0x0002 /*< Client may not set this capability /
42			#define CAPFL_PROTO 0x0004 /*< Cap must be acknowledged by client /
43			#define CAPFL_STICKY 0x0008 /*< Cap may not be cleared once set /
44
45			typedef int (bqcmp)(const void , const void *);
46
47			static struct capabilities
48			{
49			unsigned int cap;
50			unsigned int flags;
51			const char *name;
52			size_t namelen;
53			} capab_list[] = {
54			#define _CAP(cap, flags, name) \
55	michael	2345	{ (cap), (flags), (name), sizeof(name) - 1 }
56	michael	2910	_CAP(CAP_UHNAMES, 0, "userhost-in-names"),
57	michael	1734	_CAP(CAP_MULTI_PREFIX, 0, "multi-prefix"),
58			_CAP(CAP_AWAY_NOTIFY, 0, "away-notify")
59	michael	503	#undef _CAP
60			};
61
62	michael	2345	#define CAPAB_LIST_LEN (sizeof(capab_list) / sizeof(struct capabilities))
63	michael	503
64			static int
65			capab_sort(const struct capabilities cap1, const struct capabilities cap2)
66			{
67	michael	536	return strcasecmp(cap1->name, cap2->name);
68	michael	503	}
69
70			static int
71			capab_search(const char key, const struct capabilities cap)
72			{
73			const char *rb = cap->name;
74
75	michael	2820	while (ToLower(key) == ToLower(rb)) /* Walk equivalent part of strings */
76			if (key++ == '\0') / Hit the end, all right... */
77	michael	503	return 0;
78			else /* OK, let's move on... */
79			rb++;
80
81	michael	872	/*
82			* If the character they differ on happens to be a space, and it happens
83	michael	503	* to be the same length as the capability name, then we've found a
84			* match; otherwise, return the difference of the two.
85			*/
86			return (IsSpace(key) && rb == '\0') ? 0 : (ToLower(key) - ToLower(rb));
87			}
88
89			static struct capabilities *
90			find_cap(const char *caplist_p, int neg_p)
91			{
92			static int inited = 0;
93			const char caplist = caplist_p;
94	michael	872	struct capabilities *cap = NULL;
95	michael	503
96	michael	2820	neg_p = 0; / Clear negative flag... */
97	michael	503
98			if (!inited)
99			{
100			/* First, let's sort the array... */
101			qsort(capab_list, CAPAB_LIST_LEN, sizeof(struct capabilities), (bqcmp)capab_sort);
102			++inited;
103			}
104
105			/* Next, find first non-whitespace character... */
106			while (caplist && IsSpace(caplist))
107			++caplist;
108
109			/* We are now at the beginning of an element of the list; is it negative? */
110	michael	872	if (*caplist == '-')
111			{
112	michael	2820	++caplist; /* Yes; step past the flag... */
113			neg_p = 1; / Remember that it is negative... */
114	michael	503	}
115
116			/* OK, now see if we can look up the capability... */
117	michael	872	if (*caplist)
118			{
119	michael	503	if (!(cap = bsearch(caplist, capab_list, CAPAB_LIST_LEN,
120			sizeof(struct capabilities),
121			(bqcmp)capab_search)))
122			{
123			/* Couldn't find the capability; advance to first whitespace character */
124			while (caplist && !IsSpace(caplist))
125	michael	2345	++caplist;
126	michael	503	}
127			else
128	michael	2820	caplist += cap->namelen; /* Advance to end of capability name */
129	michael	3497
130			/* Strip trailing spaces */
131			while (caplist && IsSpace(caplist))
132			++caplist;
133	michael	503	}
134
135	michael	2820	assert(caplist != caplist_p \|\| !caplist); /* We must advance */
136	michael	503
137	michael	2820	/* Move ahead in capability list string--or zero pointer if we hit end */
138	michael	503	caplist_p = caplist ? caplist : 0;
139
140	michael	2820	return cap; /* And return the capability (if any) */
141	michael	503	}
142
143	michael	1230	/** Send a CAP \a subcmd list of capability changes to \a source_p.
144	michael	503	* If more than one line is necessary, each line before the last has
145			* an added "*" parameter before that line's capability list.
146	michael	1230	* @param[in] source_p Client receiving capability list.
147	michael	503	* @param[in] set Capabilities to show as set (with ack and sticky modifiers).
148			* @param[in] rem Capabalities to show as removed (with no other modifier).
149			* @param[in] subcmd Name of capability subcommand.
150			*/
151			static int
152	michael	1230	send_caplist(struct Client *source_p, unsigned int set,
153	michael	503	unsigned int rem, const char *subcmd)
154			{
155			char capbuf[IRCD_BUFSIZE] = "", pfx[16];
156			char cmdbuf[IRCD_BUFSIZE] = "";
157	michael	575	unsigned int i, loc, len, flags, pfx_len, clen;
158	michael	503
159	michael	2820	/* Set up the buffer for the final LS message... */
160	michael	503	clen = snprintf(cmdbuf, sizeof(capbuf), ":%s CAP %s %s ", me.name,
161	michael	1230	source_p->name[0] ? source_p->name : "*", subcmd);
162	michael	503
163			for (i = 0, loc = 0; i < CAPAB_LIST_LEN; ++i)
164			{
165			flags = capab_list[i].flags;
166
167			/*
168			* This is a little bit subtle, but just involves applying de
169			* Morgan's laws to the obvious check: We must display the
170			* capability if (and only if) it is set in \a rem or \a set, or
171			* if both are null and the capability is hidden.
172			*/
173			if (!(rem && (rem & capab_list[i].cap)) &&
174			!(set && (set & capab_list[i].cap)) &&
175			(rem \|\| set \|\| (flags & CAPFL_HIDDEN)))
176			continue;
177
178			/* Build the prefix (space separator and any modifiers needed). */
179			pfx_len = 0;
180
181			if (loc)
182			pfx[pfx_len++] = ' ';
183			if (rem && (rem & capab_list[i].cap))
184			pfx[pfx_len++] = '-';
185			else
186			{
187			if (flags & CAPFL_PROTO)
188			pfx[pfx_len++] = '~';
189			if (flags & CAPFL_STICKY)
190			pfx[pfx_len++] = '=';
191			}
192
193			pfx[pfx_len] = '\0';
194
195	michael	2820	len = capab_list[i].namelen + pfx_len; /* How much we'd add... */
196	michael	503
197			if (sizeof(capbuf) < (clen + loc + len + 15))
198			{
199	michael	2820	/* Would add too much; must flush */
200	michael	1230	sendto_one(source_p, "%s* :%s", cmdbuf, capbuf);
201	michael	2820	capbuf[(loc = 0)] = '\0'; /* Re-terminate the buffer... */
202	michael	503	}
203
204			loc += snprintf(capbuf + loc, sizeof(capbuf) - loc,
205			"%s%s", pfx, capab_list[i].name);
206			}
207
208	michael	1230	sendto_one(source_p, "%s:%s", cmdbuf, capbuf);
209	michael	503
210	michael	2820	return 0; /* Convenience return */
211	michael	503	}
212
213			static int
214	michael	1230	cap_ls(struct Client source_p, const char caplist)
215	michael	503	{
216	michael	2820	if (IsUnknown(source_p)) /* Registration hasn't completed; suspend it... */
217	michael	1230	source_p->localClient->registration \|= REG_NEED_CAP;
218	michael	503
219	michael	2820	return send_caplist(source_p, 0, 0, "LS"); /* Send list of capabilities */
220	michael	503	}
221
222			static int
223	michael	1230	cap_req(struct Client source_p, const char caplist)
224	michael	503	{
225			const char *cl = caplist;
226	michael	872	struct capabilities *cap = NULL;
227	michael	503	unsigned int set = 0, rem = 0;
228	michael	1230	unsigned int cs = source_p->localClient->cap_client; /* capability set */
229			unsigned int as = source_p->localClient->cap_active; /* active set */
230	michael	872	int neg = 0;
231	michael	503
232	michael	2820	if (IsUnknown(source_p)) /* Registration hasn't completed; suspend it... */
233	michael	1230	source_p->localClient->registration \|= REG_NEED_CAP;
234	michael	503
235	michael	2820	while (cl) { /* Walk through the capabilities list... */
236			if (!(cap = find_cap(&cl, &neg)) /* Look up capability... */
237			\|\| (!neg && (cap->flags & CAPFL_PROHIBIT)) /* Is it prohibited? */
238			\|\| (neg && (cap->flags & CAPFL_STICKY))) { /* Is it sticky? */
239	michael	1230	sendto_one(source_p, ":%s CAP %s NAK :%s", me.name,
240			source_p->name[0] ? source_p->name : "*", caplist);
241	michael	2820	return 0; /* Can't complete requested op... */
242	michael	503	}
243
244			if (neg)
245			{
246	michael	2820	/* Set or clear the capability... */
247	michael	503	rem \|= cap->cap;
248			set &= ~cap->cap;
249			cs &= ~cap->cap;
250
251			if (!(cap->flags & CAPFL_PROTO))
252			as &= ~cap->cap;
253			}
254			else
255			{
256			rem &= ~cap->cap;
257			set \|= cap->cap;
258			cs \|= cap->cap;
259
260			if (!(cap->flags & CAPFL_PROTO))
261			as \|= cap->cap;
262			}
263			}
264
265			/* Notify client of accepted changes and copy over results. */
266	michael	1230	send_caplist(source_p, set, rem, "ACK");
267	michael	503
268	michael	1230	source_p->localClient->cap_client = cs;
269			source_p->localClient->cap_active = as;
270	michael	503
271			return 0;
272			}
273
274			static int
275	michael	1230	cap_ack(struct Client source_p, const char caplist)
276	michael	503	{
277			const char *cl = caplist;
278			struct capabilities *cap = NULL;
279	michael	872	int neg = 0;
280	michael	503
281			/*
282			* Coming from the client, this generally indicates that the client
283	michael	2820	* is using a new backwards-incompatible protocol feature. As such,
284	michael	503	* it does not require further response from the server.
285			*/
286			while (cl)
287			{
288	michael	2820	/* Walk through the capabilities list... */
289			if (!(cap = find_cap(&cl, &neg)) \|\| /* Look up capability... */
290	michael	2345	(neg ? (source_p->localClient->cap_active & cap->cap) :
291			!(source_p->localClient->cap_active & cap->cap))) /* uh... */
292	michael	503	continue;
293
294	michael	2820	if (neg) /* Set or clear the active capability... */
295	michael	1230	source_p->localClient->cap_active &= ~cap->cap;
296	michael	503	else
297	michael	1230	source_p->localClient->cap_active \|= cap->cap;
298	michael	503	}
299
300			return 0;
301			}
302
303			static int
304	michael	1230	cap_clear(struct Client source_p, const char caplist)
305	michael	503	{
306	michael	872	struct capabilities *cap = NULL;
307	michael	503	unsigned int ii;
308			unsigned int cleared = 0;
309
310			for (ii = 0; ii < CAPAB_LIST_LEN; ++ii)
311			{
312			cap = &capab_list[ii];
313
314			/* Only clear active non-sticky capabilities. */
315	michael	1230	if (!(source_p->localClient->cap_active & cap->cap) \|\| (cap->flags & CAPFL_STICKY))
316	michael	503	continue;
317
318			cleared \|= cap->cap;
319	michael	1230	source_p->localClient->cap_client &= ~cap->cap;
320	michael	503
321			if (!(cap->flags & CAPFL_PROTO))
322	michael	1230	source_p->localClient->cap_active &= ~cap->cap;
323	michael	503	}
324
325	michael	1230	return send_caplist(source_p, 0, cleared, "ACK");
326	michael	503	}
327
328			static int
329	michael	1230	cap_end(struct Client source_p, const char caplist)
330	michael	503	{
331	michael	2820	if (!IsUnknown(source_p)) /* Registration has completed... */
332			return 0; /* So just ignore the message... */
333	michael	503
334	michael	2820	/* Capability negotiation is now done... */
335	michael	1230	source_p->localClient->registration &= ~REG_NEED_CAP;
336	michael	503
337	michael	2820	/* If client is now done... */
338	michael	1230	if (!source_p->localClient->registration)
339	michael	503	{
340	michael	1230	register_local_user(source_p);
341	michael	503	return 0;
342			}
343
344	michael	2345	return 0; /* Can't do registration yet... */
345	michael	503	}
346
347			static int
348	michael	1230	cap_list(struct Client source_p, const char caplist)
349	michael	503	{
350			/* Send the list of the client's capabilities */
351	michael	1230	return send_caplist(source_p, source_p->localClient->cap_client, 0, "LIST");
352	michael	503	}
353
354			static struct subcmd
355			{
356	michael	575	const char *cmd;
357	michael	1230	int (proc)(struct Client , const char *);
358	michael	503	} cmdlist[] = {
359			{ "ACK", cap_ack },
360			{ "CLEAR", cap_clear },
361			{ "END", cap_end },
362			{ "LIST", cap_list },
363			{ "LS", cap_ls },
364	michael	575	{ "NAK", NULL },
365	michael	503	{ "REQ", cap_req }
366			};
367
368			static int
369			subcmd_search(const char cmd, const struct subcmd elem)
370			{
371	michael	536	return strcasecmp(cmd, elem->cmd);
372	michael	503	}
373
374	michael	3332	/*! \brief CAP command handler
375			*
376			* \param source_p Pointer to allocated Client struct from which the message
377			* originally comes from. This can be a local or remote client.
378			* \param parc Integer holding the number of supplied arguments.
379			* \param parv Argument vector where parv[0] .. parv[parc-1] are non-NULL
380			* pointers.
381			* \note Valid arguments for this command are:
382			* - parv[0] = command
383			* - parv[1] = CAP subcommand
384			* - parv[2] = space-separated list of capabilities
385	michael	503	*/
386	michael	2820	static int
387	michael	3156	m_cap(struct Client source_p, int parc, char parv[])
388	michael	503	{
389	michael	1222	const char subcmd = NULL, caplist = NULL;
390	michael	503	struct subcmd *cmd = NULL;
391
392	michael	2820	if (EmptyString(parv[1])) /* A subcommand is required */
393			return 0;
394	michael	503
395			subcmd = parv[1];
396
397	michael	2820	if (parc > 2) /* A capability list was provided */
398	michael	503	caplist = parv[2];
399
400	michael	2820	/* Find the subcommand handler */
401	michael	503	if (!(cmd = bsearch(subcmd, cmdlist,
402			sizeof(cmdlist) / sizeof(struct subcmd),
403			sizeof(struct subcmd), (bqcmp)subcmd_search)))
404			{
405	michael	3109	sendto_one_numeric(source_p, &me, ERR_INVALIDCAPCMD, subcmd);
406	michael	2820	return 0;
407	michael	503	}
408
409	michael	2820	/* Then execute it... */
410	michael	503	if (cmd->proc)
411	michael	1230	(cmd->proc)(source_p, caplist);
412	michael	2820	return 0;
413	michael	503	}
414	michael	1230
415	michael	2820	static struct Message cap_msgtab =
416			{
417	michael	1230	"CAP", 0, 0, 2, MAXPARA, MFLG_SLOW, 0,
418			{ m_cap, m_cap, m_ignore, m_ignore, m_cap, m_ignore }
419			};
420
421			static void
422			module_init(void)
423			{
424			mod_add_cmd(&cap_msgtab);
425			}
426
427			static void
428			module_exit(void)
429			{
430			mod_del_cmd(&cap_msgtab);
431			}
432
433	michael	2820	struct module module_entry =
434			{
435	michael	1230	.node = { NULL, NULL, NULL },
436			.name = NULL,
437			.version = "$Revision$",
438			.handle = NULL,
439			.modinit = module_init,
440			.modexit = module_exit,
441			.flags = 0
442			};