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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 *  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)
{
  const char *caplist = *caplist_p;
  struct capabilities *cap = NULL;

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

  /* 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 : NULL;

  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 cleared = 0;

  for (unsigned int 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", NULL, 0, 0, 2, MAXPARA, MFLG_SLOW, 0,
  { m_cap, m_cap, m_ignore, m_ignore, m_cap, m_ignore }
};

static void
module_init(void)
{
  /* First, let's sort the array */
  qsort(capab_list, CAPAB_LIST_LEN, sizeof(struct capabilities), (bqcmp)capab_sort);
  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:	4565
Committed:	Sun Aug 24 10:27:40 2014 UTC (11 years ago) by michael
Content type:	text/x-csrc
File size:	12553 byte(s)
Log Message:	- Update GPL 2 license headers
#	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	michael	4565	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
20	michael	503	* 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	michael	3875	else /* OK, let's move on... */
79	michael	503	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			const char caplist = caplist_p;
93	michael	872	struct capabilities *cap = NULL;
94	michael	503
95	michael	2820	neg_p = 0; / Clear negative flag... */
96	michael	503
97			/* Next, find first non-whitespace character... */
98			while (caplist && IsSpace(caplist))
99			++caplist;
100
101			/* We are now at the beginning of an element of the list; is it negative? */
102	michael	872	if (*caplist == '-')
103			{
104	michael	2820	++caplist; /* Yes; step past the flag... */
105			neg_p = 1; / Remember that it is negative... */
106	michael	503	}
107
108			/* OK, now see if we can look up the capability... */
109	michael	872	if (*caplist)
110			{
111	michael	503	if (!(cap = bsearch(caplist, capab_list, CAPAB_LIST_LEN,
112			sizeof(struct capabilities),
113			(bqcmp)capab_search)))
114			{
115			/* Couldn't find the capability; advance to first whitespace character */
116			while (caplist && !IsSpace(caplist))
117	michael	2345	++caplist;
118	michael	503	}
119			else
120	michael	2820	caplist += cap->namelen; /* Advance to end of capability name */
121	michael	3497
122			/* Strip trailing spaces */
123			while (caplist && IsSpace(caplist))
124			++caplist;
125	michael	503	}
126
127	michael	2820	assert(caplist != caplist_p \|\| !caplist); /* We must advance */
128	michael	503
129	michael	2820	/* Move ahead in capability list string--or zero pointer if we hit end */
130	michael	3565	caplist_p = caplist ? caplist : NULL;
131	michael	503
132	michael	2820	return cap; /* And return the capability (if any) */
133	michael	503	}
134
135	michael	1230	/** Send a CAP \a subcmd list of capability changes to \a source_p.
136	michael	503	* If more than one line is necessary, each line before the last has
137			* an added "*" parameter before that line's capability list.
138	michael	1230	* @param[in] source_p Client receiving capability list.
139	michael	503	* @param[in] set Capabilities to show as set (with ack and sticky modifiers).
140			* @param[in] rem Capabalities to show as removed (with no other modifier).
141			* @param[in] subcmd Name of capability subcommand.
142			*/
143			static int
144	michael	1230	send_caplist(struct Client *source_p, unsigned int set,
145	michael	503	unsigned int rem, const char *subcmd)
146			{
147			char capbuf[IRCD_BUFSIZE] = "", pfx[16];
148			char cmdbuf[IRCD_BUFSIZE] = "";
149	michael	575	unsigned int i, loc, len, flags, pfx_len, clen;
150	michael	503
151	michael	2820	/* Set up the buffer for the final LS message... */
152	michael	503	clen = snprintf(cmdbuf, sizeof(capbuf), ":%s CAP %s %s ", me.name,
153	michael	1230	source_p->name[0] ? source_p->name : "*", subcmd);
154	michael	503
155			for (i = 0, loc = 0; i < CAPAB_LIST_LEN; ++i)
156			{
157			flags = capab_list[i].flags;
158
159			/*
160			* This is a little bit subtle, but just involves applying de
161			* Morgan's laws to the obvious check: We must display the
162			* capability if (and only if) it is set in \a rem or \a set, or
163			* if both are null and the capability is hidden.
164			*/
165			if (!(rem && (rem & capab_list[i].cap)) &&
166			!(set && (set & capab_list[i].cap)) &&
167			(rem \|\| set \|\| (flags & CAPFL_HIDDEN)))
168			continue;
169
170			/* Build the prefix (space separator and any modifiers needed). */
171			pfx_len = 0;
172
173			if (loc)
174			pfx[pfx_len++] = ' ';
175			if (rem && (rem & capab_list[i].cap))
176			pfx[pfx_len++] = '-';
177			else
178			{
179			if (flags & CAPFL_PROTO)
180			pfx[pfx_len++] = '~';
181			if (flags & CAPFL_STICKY)
182			pfx[pfx_len++] = '=';
183			}
184
185			pfx[pfx_len] = '\0';
186
187	michael	2820	len = capab_list[i].namelen + pfx_len; /* How much we'd add... */
188	michael	503
189			if (sizeof(capbuf) < (clen + loc + len + 15))
190			{
191	michael	2820	/* Would add too much; must flush */
192	michael	1230	sendto_one(source_p, "%s* :%s", cmdbuf, capbuf);
193	michael	2820	capbuf[(loc = 0)] = '\0'; /* Re-terminate the buffer... */
194	michael	503	}
195
196			loc += snprintf(capbuf + loc, sizeof(capbuf) - loc,
197			"%s%s", pfx, capab_list[i].name);
198			}
199
200	michael	1230	sendto_one(source_p, "%s:%s", cmdbuf, capbuf);
201	michael	503
202	michael	2820	return 0; /* Convenience return */
203	michael	503	}
204
205			static int
206	michael	1230	cap_ls(struct Client source_p, const char caplist)
207	michael	503	{
208	michael	2820	if (IsUnknown(source_p)) /* Registration hasn't completed; suspend it... */
209	michael	1230	source_p->localClient->registration \|= REG_NEED_CAP;
210	michael	503
211	michael	2820	return send_caplist(source_p, 0, 0, "LS"); /* Send list of capabilities */
212	michael	503	}
213
214			static int
215	michael	1230	cap_req(struct Client source_p, const char caplist)
216	michael	503	{
217			const char *cl = caplist;
218	michael	872	struct capabilities *cap = NULL;
219	michael	503	unsigned int set = 0, rem = 0;
220	michael	1230	unsigned int cs = source_p->localClient->cap_client; /* capability set */
221			unsigned int as = source_p->localClient->cap_active; /* active set */
222	michael	872	int neg = 0;
223	michael	503
224	michael	2820	if (IsUnknown(source_p)) /* Registration hasn't completed; suspend it... */
225	michael	1230	source_p->localClient->registration \|= REG_NEED_CAP;
226	michael	503
227	michael	2820	while (cl) { /* Walk through the capabilities list... */
228	michael	3875	if (!(cap = find_cap(&cl, &neg)) /* Look up capability... */
229	michael	2820	\|\| (!neg && (cap->flags & CAPFL_PROHIBIT)) /* Is it prohibited? */
230			\|\| (neg && (cap->flags & CAPFL_STICKY))) { /* Is it sticky? */
231	michael	1230	sendto_one(source_p, ":%s CAP %s NAK :%s", me.name,
232			source_p->name[0] ? source_p->name : "*", caplist);
233	michael	2820	return 0; /* Can't complete requested op... */
234	michael	503	}
235
236			if (neg)
237			{
238	michael	2820	/* Set or clear the capability... */
239	michael	503	rem \|= cap->cap;
240			set &= ~cap->cap;
241			cs &= ~cap->cap;
242
243			if (!(cap->flags & CAPFL_PROTO))
244			as &= ~cap->cap;
245			}
246			else
247			{
248			rem &= ~cap->cap;
249			set \|= cap->cap;
250			cs \|= cap->cap;
251
252			if (!(cap->flags & CAPFL_PROTO))
253			as \|= cap->cap;
254			}
255			}
256
257			/* Notify client of accepted changes and copy over results. */
258	michael	1230	send_caplist(source_p, set, rem, "ACK");
259	michael	503
260	michael	1230	source_p->localClient->cap_client = cs;
261			source_p->localClient->cap_active = as;
262	michael	503
263			return 0;
264			}
265
266			static int
267	michael	1230	cap_ack(struct Client source_p, const char caplist)
268	michael	503	{
269			const char *cl = caplist;
270			struct capabilities *cap = NULL;
271	michael	872	int neg = 0;
272	michael	503
273			/*
274			* Coming from the client, this generally indicates that the client
275	michael	2820	* is using a new backwards-incompatible protocol feature. As such,
276	michael	503	* it does not require further response from the server.
277			*/
278			while (cl)
279			{
280	michael	2820	/* Walk through the capabilities list... */
281			if (!(cap = find_cap(&cl, &neg)) \|\| /* Look up capability... */
282	michael	2345	(neg ? (source_p->localClient->cap_active & cap->cap) :
283			!(source_p->localClient->cap_active & cap->cap))) /* uh... */
284	michael	503	continue;
285
286	michael	2820	if (neg) /* Set or clear the active capability... */
287	michael	1230	source_p->localClient->cap_active &= ~cap->cap;
288	michael	503	else
289	michael	1230	source_p->localClient->cap_active \|= cap->cap;
290	michael	503	}
291
292			return 0;
293			}
294
295			static int
296	michael	1230	cap_clear(struct Client source_p, const char caplist)
297	michael	503	{
298	michael	872	struct capabilities *cap = NULL;
299	michael	503	unsigned int cleared = 0;
300
301	michael	3565	for (unsigned int ii = 0; ii < CAPAB_LIST_LEN; ++ii)
302	michael	503	{
303			cap = &capab_list[ii];
304
305			/* Only clear active non-sticky capabilities. */
306	michael	1230	if (!(source_p->localClient->cap_active & cap->cap) \|\| (cap->flags & CAPFL_STICKY))
307	michael	503	continue;
308
309			cleared \|= cap->cap;
310	michael	1230	source_p->localClient->cap_client &= ~cap->cap;
311	michael	503
312			if (!(cap->flags & CAPFL_PROTO))
313	michael	1230	source_p->localClient->cap_active &= ~cap->cap;
314	michael	503	}
315
316	michael	1230	return send_caplist(source_p, 0, cleared, "ACK");
317	michael	503	}
318
319			static int
320	michael	1230	cap_end(struct Client source_p, const char caplist)
321	michael	503	{
322	michael	2820	if (!IsUnknown(source_p)) /* Registration has completed... */
323			return 0; /* So just ignore the message... */
324	michael	503
325	michael	2820	/* Capability negotiation is now done... */
326	michael	1230	source_p->localClient->registration &= ~REG_NEED_CAP;
327	michael	503
328	michael	2820	/* If client is now done... */
329	michael	1230	if (!source_p->localClient->registration)
330	michael	503	{
331	michael	1230	register_local_user(source_p);
332	michael	503	return 0;
333			}
334
335	michael	2345	return 0; /* Can't do registration yet... */
336	michael	503	}
337
338			static int
339	michael	1230	cap_list(struct Client source_p, const char caplist)
340	michael	503	{
341			/* Send the list of the client's capabilities */
342	michael	1230	return send_caplist(source_p, source_p->localClient->cap_client, 0, "LIST");
343	michael	503	}
344
345			static struct subcmd
346			{
347	michael	575	const char *cmd;
348	michael	1230	int (proc)(struct Client , const char *);
349	michael	503	} cmdlist[] = {
350			{ "ACK", cap_ack },
351			{ "CLEAR", cap_clear },
352			{ "END", cap_end },
353			{ "LIST", cap_list },
354			{ "LS", cap_ls },
355	michael	575	{ "NAK", NULL },
356	michael	503	{ "REQ", cap_req }
357			};
358
359			static int
360			subcmd_search(const char cmd, const struct subcmd elem)
361			{
362	michael	536	return strcasecmp(cmd, elem->cmd);
363	michael	503	}
364
365	michael	3332	/*! \brief CAP command handler
366			*
367			* \param source_p Pointer to allocated Client struct from which the message
368			* originally comes from. This can be a local or remote client.
369			* \param parc Integer holding the number of supplied arguments.
370			* \param parv Argument vector where parv[0] .. parv[parc-1] are non-NULL
371			* pointers.
372			* \note Valid arguments for this command are:
373			* - parv[0] = command
374			* - parv[1] = CAP subcommand
375			* - parv[2] = space-separated list of capabilities
376	michael	503	*/
377	michael	2820	static int
378	michael	3156	m_cap(struct Client source_p, int parc, char parv[])
379	michael	503	{
380	michael	1222	const char subcmd = NULL, caplist = NULL;
381	michael	503	struct subcmd *cmd = NULL;
382
383	michael	2820	if (EmptyString(parv[1])) /* A subcommand is required */
384			return 0;
385	michael	503
386			subcmd = parv[1];
387
388	michael	2820	if (parc > 2) /* A capability list was provided */
389	michael	503	caplist = parv[2];
390
391	michael	2820	/* Find the subcommand handler */
392	michael	503	if (!(cmd = bsearch(subcmd, cmdlist,
393			sizeof(cmdlist) / sizeof(struct subcmd),
394			sizeof(struct subcmd), (bqcmp)subcmd_search)))
395			{
396	michael	3109	sendto_one_numeric(source_p, &me, ERR_INVALIDCAPCMD, subcmd);
397	michael	2820	return 0;
398	michael	503	}
399
400	michael	2820	/* Then execute it... */
401	michael	503	if (cmd->proc)
402	michael	1230	(cmd->proc)(source_p, caplist);
403	michael	2820	return 0;
404	michael	503	}
405	michael	1230
406	michael	2820	static struct Message cap_msgtab =
407			{
408	michael	4545	"CAP", NULL, 0, 0, 2, MAXPARA, MFLG_SLOW, 0,
409	michael	1230	{ m_cap, m_cap, m_ignore, m_ignore, m_cap, m_ignore }
410			};
411
412			static void
413			module_init(void)
414			{
415	michael	4384	/* First, let's sort the array */
416			qsort(capab_list, CAPAB_LIST_LEN, sizeof(struct capabilities), (bqcmp)capab_sort);
417	michael	1230	mod_add_cmd(&cap_msgtab);
418			}
419
420			static void
421			module_exit(void)
422			{
423			mod_del_cmd(&cap_msgtab);
424			}
425
426	michael	2820	struct module module_entry =
427			{
428	michael	1230	.node = { NULL, NULL, NULL },
429			.name = NULL,
430			.version = "$Revision$",
431			.handle = NULL,
432			.modinit = module_init,
433			.modexit = module_exit,
434			.flags = 0
435			};