]>
jfr.im git - solanum.git/blob - modules/m_cap.c
3 * Copyright (C) 2005 Lee Hardy <lee@leeh.co.uk>
4 * Copyright (C) 2005 ircd-ratbox development team
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
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.
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.
30 * $Id: m_cap.c 676 2006-02-03 20:05:09Z gxti $
48 typedef int (*bqcmp
)(const void *, const void *);
50 static int m_cap(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
51 static int modinit(void);
53 struct Message cap_msgtab
= {
55 {{m_cap
, 2}, {m_cap
, 2}, mg_ignore
, mg_ignore
, mg_ignore
, {m_cap
, 2}}
58 mapi_clist_av1 cap_clist
[] = { &cap_msgtab
, NULL
};
59 DECLARE_MODULE_AV1(cap
, modinit
, NULL
, cap_clist
, NULL
, NULL
, "$Revision: 676 $");
61 #define _CLICAP(name, capserv, capclient, caprequired, flags) \
62 { (name), (capserv), (capclient), (caprequired), (flags), sizeof(name) - 1 }
64 #define CLICAP_FLAGS_STICKY 0x001
69 int cap_serv
; /* for altering s->c */
70 int cap_cli
; /* for altering c->s */
71 int cap_required_serv
; /* required dependency cap */
75 _CLICAP("multi-prefix", CLICAP_MULTI_PREFIX
, 0, 0, 0),
76 _CLICAP("sasl", CLICAP_SASL
, 0, 0, CLICAP_FLAGS_STICKY
),
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),
81 _CLICAP("userhost-in-names", CLICAP_USERHOST_IN_NAMES
, 0, 0, 0),
82 _CLICAP("cap-notify", CLICAP_CAP_NOTIFY
, 0, 0, 0),
83 _CLICAP("chghost", CLICAP_CHGHOST
, 0, 0, 0),
86 #define CLICAP_LIST_LEN (sizeof(clicap_list) / sizeof(struct clicap))
88 static int clicap_sort(struct clicap
*, struct clicap
*);
93 qsort(clicap_list
, CLICAP_LIST_LEN
, sizeof(struct clicap
),
99 clicap_sort(struct clicap
*one
, struct clicap
*two
)
101 return irccmp(one
->name
, two
->name
);
105 clicap_compare(const char *name
, struct clicap
*cap
)
107 return irccmp(name
, cap
->name
);
111 * Used iteratively over a buffer, extracts individual cap tokens.
113 * Inputs: buffer to start iterating over (NULL to iterate over existing buf)
114 * int pointer to whether the cap token is negated
115 * int pointer to whether we finish with success
116 * Ouputs: Cap entry if found, NULL otherwise.
118 static struct clicap
*
119 clicap_find(const char *data
, int *negate
, int *finished
)
121 static char buf
[BUFSIZE
];
130 rb_strlcpy(buf
, data
, sizeof(buf
));
137 /* skip any whitespace */
138 while(*p
&& IsSpace(*p
))
152 /* someone sent a '-' without a parameter.. */
157 if((s
= strchr(p
, ' ')))
160 if((cap
= bsearch(p
, clicap_list
, CLICAP_LIST_LEN
,
161 sizeof(struct clicap
), (bqcmp
) clicap_compare
)))
173 * Generates a list of capabilities.
175 * Inputs: client to send to, subcmd to send,
176 * flags to match against: 0 to do none, -1 if client has no flags,
177 * int to whether we are doing CAP CLEAR
181 clicap_generate(struct Client
*source_p
, const char *subcmd
, int flags
, int clear
)
184 char capbuf
[BUFSIZE
];
190 mlen
= sprintf(buf
, ":%s CAP %s %s",
192 EmptyString(source_p
->name
) ? "*" : source_p
->name
,
198 /* shortcut, nothing to do */
201 sendto_one(source_p
, "%s :", buf
);
205 for(i
= 0; i
< CLICAP_LIST_LEN
; i
++)
209 if(!IsCapable(source_p
, clicap_list
[i
].cap_serv
))
211 /* they are capable of this, check sticky */
212 else if(clear
&& clicap_list
[i
].flags
& CLICAP_FLAGS_STICKY
)
216 if (clicap_list
[i
].cap_serv
== CLICAP_SASL
)
218 struct Client
*agent_p
= NULL
;
220 if (!ConfigFileEntry
.sasl_service
)
223 agent_p
= find_named_client(ConfigFileEntry
.sasl_service
);
224 if (agent_p
== NULL
|| !IsService(agent_p
))
228 /* \r\n\0, possible "-~=", space, " *" */
229 if(buflen
+ clicap_list
[i
].namelen
>= BUFSIZE
- 10)
231 /* remove our trailing space -- if buflen == mlen
232 * here, we didnt even succeed in adding one.
239 sendto_one(source_p
, "%s * :%s", buf
, capbuf
);
250 curlen
= sprintf(p
, "%s ", clicap_list
[i
].name
);
255 /* remove trailing space */
261 sendto_one(source_p
, "%s :%s", buf
, capbuf
);
265 cap_ack(struct Client
*source_p
, const char *arg
)
268 int capadd
= 0, capdel
= 0;
269 int finished
= 0, negate
;
274 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
275 cap
= clicap_find(NULL
, &negate
, &finished
))
277 /* sent an ACK for something they havent REQd */
278 if(!IsCapable(source_p
, cap
->cap_serv
))
283 /* dont let them ack something sticky off */
284 if(cap
->flags
& CLICAP_FLAGS_STICKY
)
287 capdel
|= cap
->cap_cli
;
290 capadd
|= cap
->cap_cli
;
293 source_p
->localClient
->caps
|= capadd
;
294 source_p
->localClient
->caps
&= ~capdel
;
298 cap_clear(struct Client
*source_p
, const char *arg
)
300 clicap_generate(source_p
, "ACK",
301 source_p
->localClient
->caps
? source_p
->localClient
->caps
: -1, 1);
303 /* XXX - sticky capabs */
305 source_p
->localClient
->caps
= source_p
->localClient
->caps
& CLICAP_STICKY
;
307 source_p
->localClient
->caps
= 0;
312 cap_end(struct Client
*source_p
, const char *arg
)
314 if(IsRegistered(source_p
))
317 source_p
->flags
&= ~FLAGS_CLICAP
;
319 if(source_p
->name
[0] && source_p
->flags
& FLAGS_SENTUSER
)
321 register_local_user(source_p
, source_p
);
326 cap_list(struct Client
*source_p
, const char *arg
)
328 /* list of what theyre currently using */
329 clicap_generate(source_p
, "LIST",
330 source_p
->localClient
->caps
? source_p
->localClient
->caps
: -1, 0);
334 cap_ls(struct Client
*source_p
, const char *arg
)
336 if(!IsRegistered(source_p
))
337 source_p
->flags
|= FLAGS_CLICAP
;
339 /* list of what we support */
340 clicap_generate(source_p
, "LS", 0, 0);
344 cap_req(struct Client
*source_p
, const char *arg
)
347 char pbuf
[2][BUFSIZE
];
351 int capadd
= 0, capdel
= 0;
352 int finished
= 0, negate
;
354 if(!IsRegistered(source_p
))
355 source_p
->flags
|= FLAGS_CLICAP
;
360 buflen
= snprintf(buf
, sizeof(buf
), ":%s CAP %s ACK",
361 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
366 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
367 cap
= clicap_find(NULL
, &negate
, &finished
))
369 /* filled the first array, but cant send it in case the
370 * request fails. one REQ should never fill more than two
373 if(buflen
+ plen
+ cap
->namelen
+ 6 >= BUFSIZE
)
382 if(cap
->flags
& CLICAP_FLAGS_STICKY
)
388 strcat(pbuf
[i
], "-");
391 capdel
|= cap
->cap_serv
;
395 if(cap
->cap_required_serv
&& !((capadd
& cap
->cap_required_serv
) == cap
->cap_required_serv
|| IsCapable(source_p
, cap
->cap_required_serv
)))
401 if (cap
->cap_serv
== CLICAP_SASL
)
403 struct Client
*agent_p
= NULL
;
405 if (!ConfigFileEntry
.sasl_service
)
411 agent_p
= find_named_client(ConfigFileEntry
.sasl_service
);
412 if (agent_p
== NULL
|| !IsService(agent_p
))
419 capadd
|= cap
->cap_serv
;
424 strcat(pbuf
[i
], "~");
428 strcat(pbuf
[i
], cap
->name
);
430 strcat(pbuf
[i
], " ");
431 plen
+= (cap
->namelen
+ 1);
437 sendto_one(source_p
, ":%s CAP %s NAK :%s",
438 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
, arg
);
444 sendto_one(source_p
, "%s * :%s", buf
, pbuf
[0]);
445 sendto_one(source_p
, "%s :%s", buf
, pbuf
[1]);
448 sendto_one(source_p
, "%s :%s", buf
, pbuf
[0]);
450 source_p
->localClient
->caps
|= capadd
;
451 source_p
->localClient
->caps
&= ~capdel
;
454 static struct clicap_cmd
457 void (*func
)(struct Client
*source_p
, const char *arg
);
458 } clicap_cmdlist
[] = {
459 /* This list *MUST* be in alphabetical order */
461 { "CLEAR", cap_clear
},
463 { "LIST", cap_list
},
469 clicap_cmd_search(const char *command
, struct clicap_cmd
*entry
)
471 return irccmp(command
, entry
->cmd
);
475 m_cap(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
477 struct clicap_cmd
*cmd
;
479 if(!(cmd
= bsearch(parv
[1], clicap_cmdlist
,
480 sizeof(clicap_cmdlist
) / sizeof(struct clicap_cmd
),
481 sizeof(struct clicap_cmd
), (bqcmp
) clicap_cmd_search
)))
483 sendto_one(source_p
, form_str(ERR_INVALIDCAPCMD
),
484 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
,
489 (cmd
->func
)(source_p
, parv
[2]);