]> jfr.im git - solanum.git/blame - modules/m_cap.c
Merge pull request #100 from Mkaysi/readme
[solanum.git] / modules / m_cap.c
CommitLineData
212380e3 1/* modules/m_cap.c
55abcbb2 2 *
212380e3
AC
3 * Copyright (C) 2005 Lee Hardy <lee@leeh.co.uk>
4 * Copyright (C) 2005 ircd-ratbox development team
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * 1.Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2.Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3.The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 * $Id: m_cap.c 676 2006-02-03 20:05:09Z gxti $
31 */
32
33#include "stdinc.h"
212380e3
AC
34#include "class.h"
35#include "client.h"
4562c604 36#include "match.h"
212380e3
AC
37#include "ircd.h"
38#include "numeric.h"
39#include "msg.h"
40#include "parse.h"
41#include "modules.h"
42#include "s_serv.h"
43#include "s_user.h"
77d3d2db 44#include "send.h"
bbce62d2 45#include "s_conf.h"
dafbd7fa 46#include "hash.h"
212380e3
AC
47
48typedef int (*bqcmp)(const void *, const void *);
49
50static int m_cap(struct Client *, struct Client *, int, const char **);
51static int modinit(void);
52
53struct Message cap_msgtab = {
54 "CAP", 0, 0, 0, MFLG_SLOW,
55 {{m_cap, 2}, {m_cap, 2}, mg_ignore, mg_ignore, mg_ignore, {m_cap, 2}}
56};
57
58mapi_clist_av1 cap_clist[] = { &cap_msgtab, NULL };
59DECLARE_MODULE_AV1(cap, modinit, NULL, cap_clist, NULL, NULL, "$Revision: 676 $");
60
0044d400
AC
61#define _CLICAP(name, capserv, capclient, caprequired, flags) \
62 { (name), (capserv), (capclient), (caprequired), (flags), sizeof(name) - 1 }
212380e3
AC
63
64#define CLICAP_FLAGS_STICKY 0x001
65
66static struct clicap
67{
68 const char *name;
69 int cap_serv; /* for altering s->c */
70 int cap_cli; /* for altering c->s */
0044d400 71 int cap_required_serv; /* required dependency cap */
212380e3
AC
72 int flags;
73 int namelen;
74} clicap_list[] = {
0044d400 75 _CLICAP("multi-prefix", CLICAP_MULTI_PREFIX, 0, 0, 0),
aaaf9faf 76 _CLICAP("sasl", CLICAP_SASL, 0, 0, CLICAP_FLAGS_STICKY),
0044d400
AC
77 _CLICAP("account-notify", CLICAP_ACCOUNT_NOTIFY, 0, 0, 0),
78 _CLICAP("extended-join", CLICAP_EXTENDED_JOIN, 0, 0, 0),
79 _CLICAP("away-notify", CLICAP_AWAY_NOTIFY, 0, 0, 0),
80 _CLICAP("tls", CLICAP_TLS, 0, 0, 0),
1b54aa5c 81 _CLICAP("userhost-in-names", CLICAP_USERHOST_IN_NAMES, 0, 0, 0),
13de7083 82 _CLICAP("cap-notify", CLICAP_CAP_NOTIFY, 0, 0, 0),
212380e3
AC
83};
84
85#define CLICAP_LIST_LEN (sizeof(clicap_list) / sizeof(struct clicap))
86
87static int clicap_sort(struct clicap *, struct clicap *);
88
89static int
90modinit(void)
91{
92 qsort(clicap_list, CLICAP_LIST_LEN, sizeof(struct clicap),
93 (bqcmp) clicap_sort);
94 return 0;
95}
96
97static int
98clicap_sort(struct clicap *one, struct clicap *two)
99{
100 return irccmp(one->name, two->name);
101}
102
103static int
104clicap_compare(const char *name, struct clicap *cap)
105{
106 return irccmp(name, cap->name);
107}
108
109/* clicap_find()
110 * Used iteratively over a buffer, extracts individual cap tokens.
111 *
112 * Inputs: buffer to start iterating over (NULL to iterate over existing buf)
113 * int pointer to whether the cap token is negated
114 * int pointer to whether we finish with success
115 * Ouputs: Cap entry if found, NULL otherwise.
116 */
117static struct clicap *
118clicap_find(const char *data, int *negate, int *finished)
119{
120 static char buf[BUFSIZE];
121 static char *p;
122 struct clicap *cap;
123 char *s;
124
125 *negate = 0;
126
127 if(data)
128 {
f427c8b0 129 rb_strlcpy(buf, data, sizeof(buf));
212380e3
AC
130 p = buf;
131 }
132
133 if(*finished)
134 return NULL;
135
136 /* skip any whitespace */
137 while(*p && IsSpace(*p))
138 p++;
139
140 if(EmptyString(p))
141 {
142 *finished = 1;
143 return NULL;
144 }
145
146 if(*p == '-')
147 {
148 *negate = 1;
149 p++;
150
151 /* someone sent a '-' without a parameter.. */
152 if(*p == '\0')
153 return NULL;
154 }
155
156 if((s = strchr(p, ' ')))
157 *s++ = '\0';
158
55abcbb2 159 if((cap = bsearch(p, clicap_list, CLICAP_LIST_LEN,
212380e3
AC
160 sizeof(struct clicap), (bqcmp) clicap_compare)))
161 {
162 if(s)
163 p = s;
164 else
165 *finished = 1;
166 }
167
168 return cap;
169}
170
171/* clicap_generate()
172 * Generates a list of capabilities.
173 *
174 * Inputs: client to send to, subcmd to send,
175 * flags to match against: 0 to do none, -1 if client has no flags,
176 * int to whether we are doing CAP CLEAR
177 * Outputs: None
178 */
179static void
180clicap_generate(struct Client *source_p, const char *subcmd, int flags, int clear)
181{
182 char buf[BUFSIZE];
183 char capbuf[BUFSIZE];
184 char *p;
185 int buflen = 0;
186 int curlen, mlen;
34e02db6 187 size_t i;
212380e3 188
7cdb0a09 189 mlen = rb_sprintf(buf, ":%s CAP %s %s",
55abcbb2
KB
190 me.name,
191 EmptyString(source_p->name) ? "*" : source_p->name,
212380e3
AC
192 subcmd);
193
194 p = capbuf;
195 buflen = mlen;
196
197 /* shortcut, nothing to do */
198 if(flags == -1)
199 {
200 sendto_one(source_p, "%s :", buf);
201 return;
202 }
203
204 for(i = 0; i < CLICAP_LIST_LEN; i++)
205 {
206 if(flags)
207 {
208 if(!IsCapable(source_p, clicap_list[i].cap_serv))
209 continue;
210 /* they are capable of this, check sticky */
211 else if(clear && clicap_list[i].flags & CLICAP_FLAGS_STICKY)
212 continue;
213 }
214
bbce62d2
MT
215 if (clicap_list[i].cap_serv == CLICAP_SASL)
216 {
217 struct Client *agent_p = NULL;
218
219 if (!ConfigFileEntry.sasl_service)
220 continue;
221
222 agent_p = find_named_client(ConfigFileEntry.sasl_service);
223 if (agent_p == NULL || !IsService(agent_p))
224 continue;
225 }
226
212380e3
AC
227 /* \r\n\0, possible "-~=", space, " *" */
228 if(buflen + clicap_list[i].namelen >= BUFSIZE - 10)
229 {
230 /* remove our trailing space -- if buflen == mlen
231 * here, we didnt even succeed in adding one.
232 */
233 if(buflen != mlen)
234 *(p - 1) = '\0';
235 else
236 *p = '\0';
237
238 sendto_one(source_p, "%s * :%s", buf, capbuf);
239 p = capbuf;
240 buflen = mlen;
241 }
242
243 if(clear)
244 {
245 *p++ = '-';
246 buflen++;
212380e3
AC
247 }
248
7cdb0a09 249 curlen = rb_sprintf(p, "%s ", clicap_list[i].name);
212380e3
AC
250 p += curlen;
251 buflen += curlen;
252 }
253
254 /* remove trailing space */
255 if(buflen != mlen)
256 *(p - 1) = '\0';
257 else
258 *p = '\0';
259
260 sendto_one(source_p, "%s :%s", buf, capbuf);
261}
262
263static void
264cap_ack(struct Client *source_p, const char *arg)
265{
266 struct clicap *cap;
267 int capadd = 0, capdel = 0;
268 int finished = 0, negate;
269
270 if(EmptyString(arg))
271 return;
272
273 for(cap = clicap_find(arg, &negate, &finished); cap;
274 cap = clicap_find(NULL, &negate, &finished))
275 {
276 /* sent an ACK for something they havent REQd */
277 if(!IsCapable(source_p, cap->cap_serv))
278 continue;
279
280 if(negate)
281 {
282 /* dont let them ack something sticky off */
283 if(cap->flags & CLICAP_FLAGS_STICKY)
284 continue;
285
286 capdel |= cap->cap_cli;
287 }
288 else
289 capadd |= cap->cap_cli;
290 }
291
292 source_p->localClient->caps |= capadd;
293 source_p->localClient->caps &= ~capdel;
294}
295
296static void
297cap_clear(struct Client *source_p, const char *arg)
298{
55abcbb2 299 clicap_generate(source_p, "ACK",
212380e3
AC
300 source_p->localClient->caps ? source_p->localClient->caps : -1, 1);
301
302 /* XXX - sticky capabs */
303#ifdef CLICAP_STICKY
304 source_p->localClient->caps = source_p->localClient->caps & CLICAP_STICKY;
305#else
306 source_p->localClient->caps = 0;
307#endif
308}
309
310static void
311cap_end(struct Client *source_p, const char *arg)
312{
313 if(IsRegistered(source_p))
314 return;
315
095328a7 316 source_p->flags &= ~FLAGS_CLICAP;
212380e3 317
1fb3b1e1 318 if(source_p->name[0] && source_p->flags & FLAGS_SENTUSER)
212380e3
AC
319 {
320 char buf[USERLEN+1];
f427c8b0 321 rb_strlcpy(buf, source_p->username, sizeof(buf));
212380e3
AC
322 register_local_user(source_p, source_p, buf);
323 }
324}
325
326static void
327cap_list(struct Client *source_p, const char *arg)
328{
329 /* list of what theyre currently using */
330 clicap_generate(source_p, "LIST",
331 source_p->localClient->caps ? source_p->localClient->caps : -1, 0);
332}
333
334static void
335cap_ls(struct Client *source_p, const char *arg)
336{
337 if(!IsRegistered(source_p))
095328a7 338 source_p->flags |= FLAGS_CLICAP;
212380e3
AC
339
340 /* list of what we support */
341 clicap_generate(source_p, "LS", 0, 0);
342}
343
344static void
345cap_req(struct Client *source_p, const char *arg)
346{
347 char buf[BUFSIZE];
348 char pbuf[2][BUFSIZE];
349 struct clicap *cap;
350 int buflen, plen;
351 int i = 0;
352 int capadd = 0, capdel = 0;
353 int finished = 0, negate;
354
355 if(!IsRegistered(source_p))
095328a7 356 source_p->flags |= FLAGS_CLICAP;
212380e3
AC
357
358 if(EmptyString(arg))
359 return;
360
7cdb0a09 361 buflen = rb_snprintf(buf, sizeof(buf), ":%s CAP %s ACK",
212380e3
AC
362 me.name, EmptyString(source_p->name) ? "*" : source_p->name);
363
364 pbuf[0][0] = '\0';
365 plen = 0;
366
367 for(cap = clicap_find(arg, &negate, &finished); cap;
368 cap = clicap_find(NULL, &negate, &finished))
369 {
370 /* filled the first array, but cant send it in case the
371 * request fails. one REQ should never fill more than two
372 * buffers --fl
373 */
374 if(buflen + plen + cap->namelen + 6 >= BUFSIZE)
375 {
376 pbuf[1][0] = '\0';
377 plen = 0;
378 i = 1;
379 }
380
381 if(negate)
382 {
383 if(cap->flags & CLICAP_FLAGS_STICKY)
384 {
385 finished = 0;
386 break;
387 }
388
389 strcat(pbuf[i], "-");
390 plen++;
391
392 capdel |= cap->cap_serv;
393 }
394 else
395 {
3a48406b 396 if(cap->cap_required_serv && !((capadd & cap->cap_required_serv) == cap->cap_required_serv || IsCapable(source_p, cap->cap_required_serv)))
0044d400
AC
397 {
398 finished = 0;
399 break;
400 }
401
bbce62d2
MT
402 if (cap->cap_serv == CLICAP_SASL)
403 {
404 struct Client *agent_p = NULL;
405
406 if (!ConfigFileEntry.sasl_service)
407 {
408 finished = 0;
409 break;
410 }
411
412 agent_p = find_named_client(ConfigFileEntry.sasl_service);
413 if (agent_p == NULL || !IsService(agent_p))
414 {
415 finished = 0;
416 break;
417 }
418 }
419
212380e3
AC
420 capadd |= cap->cap_serv;
421 }
422
423 if(cap->cap_cli)
424 {
425 strcat(pbuf[i], "~");
426 plen++;
427 }
428
429 strcat(pbuf[i], cap->name);
430 strcat(pbuf[i], " ");
431 plen += (cap->namelen + 1);
432 }
433
434 if(!finished)
435 {
436 sendto_one(source_p, ":%s CAP %s NAK :%s",
437 me.name, EmptyString(source_p->name) ? "*" : source_p->name, arg);
438 return;
439 }
440
441 if(i)
442 {
443 sendto_one(source_p, "%s * :%s", buf, pbuf[0]);
444 sendto_one(source_p, "%s :%s", buf, pbuf[1]);
445 }
446 else
447 sendto_one(source_p, "%s :%s", buf, pbuf[0]);
448
449 source_p->localClient->caps |= capadd;
450 source_p->localClient->caps &= ~capdel;
451}
452
453static struct clicap_cmd
454{
455 const char *cmd;
456 void (*func)(struct Client *source_p, const char *arg);
457} clicap_cmdlist[] = {
458 /* This list *MUST* be in alphabetical order */
459 { "ACK", cap_ack },
460 { "CLEAR", cap_clear },
461 { "END", cap_end },
462 { "LIST", cap_list },
463 { "LS", cap_ls },
464 { "REQ", cap_req },
465};
466
467static int
468clicap_cmd_search(const char *command, struct clicap_cmd *entry)
469{
470 return irccmp(command, entry->cmd);
471}
472
473static int
474m_cap(struct Client *client_p, struct Client *source_p, int parc, const char *parv[])
475{
476 struct clicap_cmd *cmd;
477
478 if(!(cmd = bsearch(parv[1], clicap_cmdlist,
479 sizeof(clicap_cmdlist) / sizeof(struct clicap_cmd),
480 sizeof(struct clicap_cmd), (bqcmp) clicap_cmd_search)))
481 {
482 sendto_one(source_p, form_str(ERR_INVALIDCAPCMD),
48a038f4
JT
483 me.name, EmptyString(source_p->name) ? "*" : source_p->name,
484 parv[1]);
212380e3
AC
485 return 0;
486 }
487
488 (cmd->func)(source_p, parv[2]);
489 return 0;
490}