trunk/modules/m_cap.c

/*
 *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
 *
 *  Copyright (C) 2004 Kevin L. Mitchell <klmitch@mit.edu>
 *  Copyright (C) 2006-2012 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
 *
 *  $Id$
 */

/** @file
 * @brief Capability negotiation commands
 * @version $Id$
 */

#include "stdinc.h"
#include "client.h"
#include "hash.h"
#include "ircd.h"
#include "numeric.h"
#include "conf.h"
#include "s_user.h"
#include "s_serv.h"
#include "send.h"
#include "parse.h"
#include "modules.h"
#include "packet.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_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 */
  }

  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);
}

/** Handle a capability request or response from a client.
 * \param client_p Client that sent us the message.
 * \param source_p Original source of message.
 * \param parc     Number of arguments.
 * \param parv     Argument vector.
 */
static void
m_cap(struct Client *client_p, 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;

  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(source_p, form_str(ERR_INVALIDCAPCMD), me.name,
               source_p->name[0] ? source_p->name : "*", subcmd);
    return;
  }

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

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:	1734
Committed:	Fri Jan 11 12:59:24 2013 UTC (12 years, 7 months ago) by michael
Content type:	text/x-csrc
File size:	12262 byte(s)
Log Message:	- Add support for "away-notify" client capability
#	Content
1	/*
2	* ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3	*
4	* Copyright (C) 2004 Kevin L. Mitchell <klmitch@mit.edu>
5	* Copyright (C) 2006-2012 Hybrid Development Team
6	*
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	* $Id$
23	*/
24
25	/** @file
26	* @brief Capability negotiation commands
27	* @version $Id$
28	*/
29
30	#include "stdinc.h"
31	#include "client.h"
32	#include "hash.h"
33	#include "ircd.h"
34	#include "numeric.h"
35	#include "conf.h"
36	#include "s_user.h"
37	#include "s_serv.h"
38	#include "send.h"
39	#include "parse.h"
40	#include "modules.h"
41	#include "packet.h"
42	#include "irc_string.h"
43
44
45	#define CAPFL_HIDDEN 0x0001 /*< Do not advertize this capability /
46	#define CAPFL_PROHIBIT 0x0002 /*< Client may not set this capability /
47	#define CAPFL_PROTO 0x0004 /*< Cap must be acknowledged by client /
48	#define CAPFL_STICKY 0x0008 /*< Cap may not be cleared once set /
49
50	typedef int (bqcmp)(const void , const void *);
51
52	static struct capabilities
53	{
54	unsigned int cap;
55	unsigned int flags;
56	const char *name;
57	size_t namelen;
58	} capab_list[] = {
59	#define _CAP(cap, flags, name) \
60	{ (cap), (flags), (name), sizeof(name) - 1 }
61	_CAP(CAP_MULTI_PREFIX, 0, "multi-prefix"),
62	_CAP(CAP_AWAY_NOTIFY, 0, "away-notify")
63	#undef _CAP
64	};
65
66	#define CAPAB_LIST_LEN (sizeof(capab_list) / sizeof(struct capabilities))
67
68	static int
69	capab_sort(const struct capabilities cap1, const struct capabilities cap2)
70	{
71	return strcasecmp(cap1->name, cap2->name);
72	}
73
74	static int
75	capab_search(const char key, const struct capabilities cap)
76	{
77	const char *rb = cap->name;
78
79	while (ToLower(key) == ToLower(rb)) /* walk equivalent part of strings */
80	if (key++ == '\0') / hit the end, all right... */
81	return 0;
82	else /* OK, let's move on... */
83	rb++;
84
85	/*
86	* If the character they differ on happens to be a space, and it happens
87	* to be the same length as the capability name, then we've found a
88	* match; otherwise, return the difference of the two.
89	*/
90	return (IsSpace(key) && rb == '\0') ? 0 : (ToLower(key) - ToLower(rb));
91	}
92
93	static struct capabilities *
94	find_cap(const char *caplist_p, int neg_p)
95	{
96	static int inited = 0;
97	const char caplist = caplist_p;
98	struct capabilities *cap = NULL;
99
100	neg_p = 0; / clear negative flag... */
101
102	if (!inited)
103	{
104	/* First, let's sort the array... */
105	qsort(capab_list, CAPAB_LIST_LEN, sizeof(struct capabilities), (bqcmp)capab_sort);
106	++inited;
107	}
108
109	/* Next, find first non-whitespace character... */
110	while (caplist && IsSpace(caplist))
111	++caplist;
112
113	/* We are now at the beginning of an element of the list; is it negative? */
114	if (*caplist == '-')
115	{
116	++caplist; /* yes; step past the flag... */
117	neg_p = 1; / remember that it is negative... */
118	}
119
120	/* OK, now see if we can look up the capability... */
121	if (*caplist)
122	{
123	if (!(cap = bsearch(caplist, capab_list, CAPAB_LIST_LEN,
124	sizeof(struct capabilities),
125	(bqcmp)capab_search)))
126	{
127	/* Couldn't find the capability; advance to first whitespace character */
128	while (caplist && !IsSpace(caplist))
129	++caplist;
130	}
131	else
132	caplist += cap->namelen; /* advance to end of capability name */
133	}
134
135	assert(caplist != caplist_p \|\| !caplist); /* we must advance */
136
137	/* move ahead in capability list string--or zero pointer if we hit end */
138	caplist_p = caplist ? caplist : 0;
139
140	return cap; /* and return the capability (if any) */
141	}
142
143	/** Send a CAP \a subcmd list of capability changes to \a source_p.
144	* If more than one line is necessary, each line before the last has
145	* an added "*" parameter before that line's capability list.
146	* @param[in] source_p Client receiving capability list.
147	* @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	send_caplist(struct Client *source_p, unsigned int set,
153	unsigned int rem, const char *subcmd)
154	{
155	char capbuf[IRCD_BUFSIZE] = "", pfx[16];
156	char cmdbuf[IRCD_BUFSIZE] = "";
157	unsigned int i, loc, len, flags, pfx_len, clen;
158
159	/* set up the buffer for the final LS message... */
160	clen = snprintf(cmdbuf, sizeof(capbuf), ":%s CAP %s %s ", me.name,
161	source_p->name[0] ? source_p->name : "*", subcmd);
162
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	len = capab_list[i].namelen + pfx_len; /* how much we'd add... */
196
197	if (sizeof(capbuf) < (clen + loc + len + 15))
198	{
199	/* would add too much; must flush */
200	sendto_one(source_p, "%s* :%s", cmdbuf, capbuf);
201	capbuf[(loc = 0)] = '\0'; /* re-terminate the buffer... */
202	}
203
204	loc += snprintf(capbuf + loc, sizeof(capbuf) - loc,
205	"%s%s", pfx, capab_list[i].name);
206	}
207
208	sendto_one(source_p, "%s:%s", cmdbuf, capbuf);
209
210	return 0; /* convenience return */
211	}
212
213	static int
214	cap_ls(struct Client source_p, const char caplist)
215	{
216	if (IsUnknown(source_p)) /* registration hasn't completed; suspend it... */
217	source_p->localClient->registration \|= REG_NEED_CAP;
218
219	return send_caplist(source_p, 0, 0, "LS"); /* send list of capabilities */
220	}
221
222	static int
223	cap_req(struct Client source_p, const char caplist)
224	{
225	const char *cl = caplist;
226	struct capabilities *cap = NULL;
227	unsigned int set = 0, rem = 0;
228	unsigned int cs = source_p->localClient->cap_client; /* capability set */
229	unsigned int as = source_p->localClient->cap_active; /* active set */
230	int neg = 0;
231
232	if (IsUnknown(source_p)) /* registration hasn't completed; suspend it... */
233	source_p->localClient->registration \|= REG_NEED_CAP;
234
235	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	sendto_one(source_p, ":%s CAP %s NAK :%s", me.name,
240	source_p->name[0] ? source_p->name : "*", caplist);
241	return 0; /* can't complete requested op... */
242	}
243
244	if (neg)
245	{
246	/* set or clear the capability... */
247	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	send_caplist(source_p, set, rem, "ACK");
267
268	source_p->localClient->cap_client = cs;
269	source_p->localClient->cap_active = as;
270
271	return 0;
272	}
273
274	static int
275	cap_ack(struct Client source_p, const char caplist)
276	{
277	const char *cl = caplist;
278	struct capabilities *cap = NULL;
279	int neg = 0;
280
281	/*
282	* Coming from the client, this generally indicates that the client
283	* is using a new backwards-incompatible protocol feature. As such,
284	* it does not require further response from the server.
285	*/
286	while (cl)
287	{
288	/* walk through the capabilities list... */
289	if (!(cap = find_cap(&cl, &neg)) \|\| /* look up capability... */
290	(neg ? (source_p->localClient->cap_active & cap->cap) :
291	!(source_p->localClient->cap_active & cap->cap))) /* uh... */
292	continue;
293
294	if (neg) /* set or clear the active capability... */
295	source_p->localClient->cap_active &= ~cap->cap;
296	else
297	source_p->localClient->cap_active \|= cap->cap;
298	}
299
300	return 0;
301	}
302
303	static int
304	cap_clear(struct Client source_p, const char caplist)
305	{
306	struct capabilities *cap = NULL;
307	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	if (!(source_p->localClient->cap_active & cap->cap) \|\| (cap->flags & CAPFL_STICKY))
316	continue;
317
318	cleared \|= cap->cap;
319	source_p->localClient->cap_client &= ~cap->cap;
320
321	if (!(cap->flags & CAPFL_PROTO))
322	source_p->localClient->cap_active &= ~cap->cap;
323	}
324
325	return send_caplist(source_p, 0, cleared, "ACK");
326	}
327
328	static int
329	cap_end(struct Client source_p, const char caplist)
330	{
331	if (!IsUnknown(source_p)) /* registration has completed... */
332	return 0; /* so just ignore the message... */
333
334	/* capability negotiation is now done... */
335	source_p->localClient->registration &= ~REG_NEED_CAP;
336
337	/* if client is now done... */
338	if (!source_p->localClient->registration)
339	{
340	register_local_user(source_p);
341	return 0;
342	}
343
344	return 0; /* Can't do registration yet... */
345	}
346
347	static int
348	cap_list(struct Client source_p, const char caplist)
349	{
350	/* Send the list of the client's capabilities */
351	return send_caplist(source_p, source_p->localClient->cap_client, 0, "LIST");
352	}
353
354	static struct subcmd
355	{
356	const char *cmd;
357	int (proc)(struct Client , const char *);
358	} cmdlist[] = {
359	{ "ACK", cap_ack },
360	{ "CLEAR", cap_clear },
361	{ "END", cap_end },
362	{ "LIST", cap_list },
363	{ "LS", cap_ls },
364	{ "NAK", NULL },
365	{ "REQ", cap_req }
366	};
367
368	static int
369	subcmd_search(const char cmd, const struct subcmd elem)
370	{
371	return strcasecmp(cmd, elem->cmd);
372	}
373
374	/** Handle a capability request or response from a client.
375	* \param client_p Client that sent us the message.
376	* \param source_p Original source of message.
377	* \param parc Number of arguments.
378	* \param parv Argument vector.
379	*/
380	static void
381	m_cap(struct Client client_p, struct Client source_p, int parc, char *parv[])
382	{
383	const char subcmd = NULL, caplist = NULL;
384	struct subcmd *cmd = NULL;
385
386	if (EmptyString(parv[1])) /* a subcommand is required */
387	return;
388
389	subcmd = parv[1];
390
391	if (parc > 2) /* a capability list was provided */
392	caplist = parv[2];
393
394	/* find the subcommand handler */
395	if (!(cmd = bsearch(subcmd, cmdlist,
396	sizeof(cmdlist) / sizeof(struct subcmd),
397	sizeof(struct subcmd), (bqcmp)subcmd_search)))
398	{
399	sendto_one(source_p, form_str(ERR_INVALIDCAPCMD), me.name,
400	source_p->name[0] ? source_p->name : "*", subcmd);
401	return;
402	}
403
404	/* then execute it... */
405	if (cmd->proc)
406	(cmd->proc)(source_p, caplist);
407	}
408
409	static struct Message cap_msgtab = {
410	"CAP", 0, 0, 2, MAXPARA, MFLG_SLOW, 0,
411	{ m_cap, m_cap, m_ignore, m_ignore, m_cap, m_ignore }
412	};
413
414	static void
415	module_init(void)
416	{
417	mod_add_cmd(&cap_msgtab);
418	}
419
420	static void
421	module_exit(void)
422	{
423	mod_del_cmd(&cap_msgtab);
424	}
425
426	struct module module_entry = {
427	.node = { NULL, NULL, NULL },
428	.name = NULL,
429	.version = "$Revision$",
430	.handle = NULL,
431	.modinit = module_init,
432	.modexit = module_exit,
433	.flags = 0
434	};