]>
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
5 * Copyright (C) 2016 William Pitcock <nenolod@dereferenced.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * 1.Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * 2.Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3.The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
47 static const char cap_desc
[] = "Provides the commands used for client capability negotiation";
49 typedef int (*bqcmp
)(const void *, const void *);
51 static void m_cap(struct MsgBuf
*, struct Client
*, struct Client
*, int, const char **);
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
};
60 DECLARE_MODULE_AV2(cap
, NULL
, NULL
, cap_clist
, NULL
, NULL
, NULL
, NULL
, cap_desc
);
62 #define IsCapableEntry(c, e) IsCapable(c, 1 << (e)->value)
63 #define HasCapabilityFlag(c, f) (c->ownerdata != NULL && (((struct ClientCapability *)c->ownerdata)->flags & (f)) == f)
66 clicap_visible(struct Client
*client_p
, const struct CapabilityEntry
*cap
)
68 struct ClientCapability
*clicap
;
70 /* orphaned caps shouldn't be visible */
71 if (cap
->flags
& CAP_ORPHANED
)
74 if (cap
->ownerdata
== NULL
)
77 clicap
= cap
->ownerdata
;
78 if (clicap
->visible
== NULL
)
81 return clicap
->visible(client_p
);
85 * Used iteratively over a buffer, extracts individual cap tokens.
87 * Inputs: buffer to start iterating over (NULL to iterate over existing buf)
88 * int pointer to whether the cap token is negated
89 * int pointer to whether we finish with success
90 * Ouputs: Cap entry if found, NULL otherwise.
92 static struct CapabilityEntry
*
93 clicap_find(const char *data
, int *negate
, int *finished
)
95 static char buf
[BUFSIZE
];
97 struct CapabilityEntry
*cap
;
104 rb_strlcpy(buf
, data
, sizeof(buf
));
111 /* skip any whitespace */
112 while(*p
&& IsSpace(*p
))
126 /* someone sent a '-' without a parameter.. */
131 if((s
= strchr(p
, ' ')))
134 if((cap
= capability_find(cli_capindex
, p
)) != NULL
)
146 * Generates a list of capabilities.
148 * Inputs: client to send to, subcmd to send,
149 * flags to match against: 0 to do none, -1 if client has no flags,
150 * int to whether we are doing CAP CLEAR
154 clicap_generate(struct Client
*source_p
, const char *subcmd
, int flags
, int clear
)
156 char buf
[BUFSIZE
] = { 0 };
157 char capbuf
[BUFSIZE
] = { 0 };
160 struct CapabilityEntry
*entry
;
161 struct DictionaryIter iter
;
163 mlen
= snprintf(buf
, sizeof buf
, ":%s CAP %s %s",
165 EmptyString(source_p
->name
) ? "*" : source_p
->name
,
168 /* shortcut, nothing to do */
171 sendto_one(source_p
, "%s :", buf
);
175 DICTIONARY_FOREACH(entry
, &iter
, cli_capindex
->cap_dict
)
178 struct ClientCapability
*clicap
= entry
->ownerdata
;
179 const char *data
= NULL
;
183 if(!IsCapableEntry(source_p
, entry
))
185 /* they are capable of this, check sticky */
186 else if(clear
&& HasCapabilityFlag(entry
, CLICAP_FLAGS_STICKY
))
190 if (!clicap_visible(source_p
, entry
))
193 caplen
= strlen(entry
->cap
);
194 if (!flags
&& (source_p
->flags
& FLAGS_CLICAP_DATA
) && clicap
!= NULL
&& clicap
->data
!= NULL
)
195 data
= clicap
->data(source_p
);
198 caplen
+= strlen(data
) + 1;
200 /* \r\n\0, possible "-~=", space, " *" */
201 if(buflen
+ mlen
>= BUFSIZE
- 10)
203 /* remove our trailing space -- if buflen == mlen
204 * here, we didnt even succeed in adding one.
206 capbuf
[buflen
] = '\0';
208 sendto_one(source_p
, "%s * :%s", buf
, capbuf
);
211 memset(capbuf
, 0, sizeof capbuf
);
214 buflen
= rb_snprintf_append(capbuf
, sizeof capbuf
, "%s%s%s%s ",
215 clear
? "-" : "", entry
->cap
, data
!= NULL
? "=" : "", data
!= NULL
? data
: "");
218 /* remove trailing space */
219 capbuf
[buflen
] = '\0';
221 sendto_one(source_p
, "%s :%s", buf
, capbuf
);
225 cap_ack(struct Client
*source_p
, const char *arg
)
227 struct CapabilityEntry
*cap
;
228 int capadd
= 0, capdel
= 0;
229 int finished
= 0, negate
;
234 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
235 cap
= clicap_find(NULL
, &negate
, &finished
))
237 /* sent an ACK for something they havent REQd */
238 if(!IsCapableEntry(source_p
, cap
))
243 /* dont let them ack something sticky off */
244 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_STICKY
))
247 capdel
|= (1 << cap
->value
);
250 capadd
|= (1 << cap
->value
);
253 source_p
->localClient
->caps
|= capadd
;
254 source_p
->localClient
->caps
&= ~capdel
;
258 cap_clear(struct Client
*source_p
, const char *arg
)
260 clicap_generate(source_p
, "ACK",
261 source_p
->localClient
->caps
? source_p
->localClient
->caps
: -1, 1);
263 source_p
->localClient
->caps
= 0;
267 cap_end(struct Client
*source_p
, const char *arg
)
269 if(IsRegistered(source_p
))
272 source_p
->flags
&= ~FLAGS_CLICAP
;
274 if(source_p
->name
[0] && source_p
->flags
& FLAGS_SENTUSER
)
276 register_local_user(source_p
, source_p
);
281 cap_list(struct Client
*source_p
, const char *arg
)
283 /* list of what theyre currently using */
284 clicap_generate(source_p
, "LIST",
285 source_p
->localClient
->caps
? source_p
->localClient
->caps
: -1, 0);
289 cap_ls(struct Client
*source_p
, const char *arg
)
291 if(!IsRegistered(source_p
))
292 source_p
->flags
|= FLAGS_CLICAP
;
294 if (arg
!= NULL
&& !strcmp(arg
, "302"))
296 source_p
->flags
|= FLAGS_CLICAP_DATA
;
297 source_p
->localClient
->caps
|= CLICAP_CAP_NOTIFY
;
300 /* list of what we support */
301 clicap_generate(source_p
, "LS", 0, 0);
305 cap_req(struct Client
*source_p
, const char *arg
)
308 char pbuf
[2][BUFSIZE
];
309 struct CapabilityEntry
*cap
;
312 int capadd
= 0, capdel
= 0;
313 int finished
= 0, negate
;
315 if(!IsRegistered(source_p
))
316 source_p
->flags
|= FLAGS_CLICAP
;
321 buflen
= snprintf(buf
, sizeof(buf
), ":%s CAP %s ACK",
322 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
327 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
328 cap
= clicap_find(NULL
, &negate
, &finished
))
330 size_t namelen
= strlen(cap
->cap
);
332 /* filled the first array, but cant send it in case the
333 * request fails. one REQ should never fill more than two
336 if(buflen
+ plen
+ namelen
+ 6 >= BUFSIZE
)
345 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_STICKY
))
351 strcat(pbuf
[i
], "-");
354 capdel
|= (1 << cap
->value
);
358 if (!clicap_visible(source_p
, cap
))
364 capadd
|= (1 << cap
->value
);
367 /* XXX this probably should exclude REQACK'd caps from capadd/capdel, but keep old behaviour for now */
368 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_REQACK
))
370 strcat(pbuf
[i
], "~");
374 strcat(pbuf
[i
], cap
->cap
);
376 strcat(pbuf
[i
], " ");
377 plen
+= (namelen
+ 1);
383 sendto_one(source_p
, ":%s CAP %s NAK :%s",
384 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
, arg
);
390 sendto_one(source_p
, "%s * :%s", buf
, pbuf
[0]);
391 sendto_one(source_p
, "%s :%s", buf
, pbuf
[1]);
394 sendto_one(source_p
, "%s :%s", buf
, pbuf
[0]);
396 source_p
->localClient
->caps
|= capadd
;
397 source_p
->localClient
->caps
&= ~capdel
;
400 static struct clicap_cmd
403 void (*func
)(struct Client
*source_p
, const char *arg
);
404 } clicap_cmdlist
[] = {
405 /* This list *MUST* be in alphabetical order */
407 { "CLEAR", cap_clear
},
409 { "LIST", cap_list
},
415 clicap_cmd_search(const char *command
, struct clicap_cmd
*entry
)
417 return irccmp(command
, entry
->cmd
);
421 m_cap(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
423 struct clicap_cmd
*cmd
;
425 if(!(cmd
= bsearch(parv
[1], clicap_cmdlist
,
426 sizeof(clicap_cmdlist
) / sizeof(struct clicap_cmd
),
427 sizeof(struct clicap_cmd
), (bqcmp
) clicap_cmd_search
)))
429 sendto_one(source_p
, form_str(ERR_INVALIDCAPCMD
),
430 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
,
435 (cmd
->func
)(source_p
, parv
[2]);