]>
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
153 clicap_generate(struct Client
*source_p
, const char *subcmd
, int flags
)
155 char buf
[BUFSIZE
] = { 0 };
156 char capbuf
[BUFSIZE
] = { 0 };
159 struct CapabilityEntry
*entry
;
160 rb_dictionary_iter iter
;
162 mlen
= snprintf(buf
, sizeof buf
, ":%s CAP %s %s",
164 EmptyString(source_p
->name
) ? "*" : source_p
->name
,
167 /* shortcut, nothing to do */
170 sendto_one(source_p
, "%s :", buf
);
174 RB_DICTIONARY_FOREACH(entry
, &iter
, cli_capindex
->cap_dict
)
177 struct ClientCapability
*clicap
= entry
->ownerdata
;
178 const char *data
= NULL
;
180 if(flags
&& !IsCapableEntry(source_p
, entry
))
183 if (!clicap_visible(source_p
, entry
))
186 caplen
= strlen(entry
->cap
);
187 if (!flags
&& (source_p
->flags
& FLAGS_CLICAP_DATA
) && clicap
!= NULL
&& clicap
->data
!= NULL
)
188 data
= clicap
->data(source_p
);
191 caplen
+= strlen(data
) + 1;
193 /* \r\n\0, possible "-~=", space, " *" */
194 if(buflen
+ mlen
>= BUFSIZE
- 10)
196 /* remove our trailing space -- if buflen == mlen
197 * here, we didnt even succeed in adding one.
199 capbuf
[buflen
] = '\0';
201 sendto_one(source_p
, "%s * :%s", buf
, capbuf
);
204 memset(capbuf
, 0, sizeof capbuf
);
207 buflen
= rb_snprintf_append(capbuf
, sizeof capbuf
, "%s%s%s ",
208 entry
->cap
, data
!= NULL
? "=" : "", data
!= NULL
? data
: "");
211 /* remove trailing space */
212 capbuf
[buflen
] = '\0';
214 sendto_one(source_p
, "%s :%s", buf
, capbuf
);
218 cap_ack(struct Client
*source_p
, const char *arg
)
220 struct CapabilityEntry
*cap
;
221 int capadd
= 0, capdel
= 0;
222 int finished
= 0, negate
;
227 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
228 cap
= clicap_find(NULL
, &negate
, &finished
))
230 /* sent an ACK for something they havent REQd */
231 if(!IsCapableEntry(source_p
, cap
))
236 /* dont let them ack something sticky off */
237 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_STICKY
))
240 capdel
|= (1 << cap
->value
);
243 capadd
|= (1 << cap
->value
);
246 source_p
->localClient
->caps
|= capadd
;
247 source_p
->localClient
->caps
&= ~capdel
;
251 cap_end(struct Client
*source_p
, const char *arg
)
253 if(IsRegistered(source_p
))
256 source_p
->flags
&= ~FLAGS_CLICAP
;
258 if(source_p
->name
[0] && source_p
->flags
& FLAGS_SENTUSER
)
260 register_local_user(source_p
, source_p
);
265 cap_list(struct Client
*source_p
, const char *arg
)
267 /* list of what theyre currently using */
268 clicap_generate(source_p
, "LIST",
269 source_p
->localClient
->caps
? source_p
->localClient
->caps
: -1);
273 cap_ls(struct Client
*source_p
, const char *arg
)
275 if(!IsRegistered(source_p
))
276 source_p
->flags
|= FLAGS_CLICAP
;
278 if (arg
!= NULL
&& !strcmp(arg
, "302"))
280 source_p
->flags
|= FLAGS_CLICAP_DATA
;
281 source_p
->localClient
->caps
|= CLICAP_CAP_NOTIFY
;
284 /* list of what we support */
285 clicap_generate(source_p
, "LS", 0);
289 cap_req(struct Client
*source_p
, const char *arg
)
292 char pbuf
[2][BUFSIZE
];
293 struct CapabilityEntry
*cap
;
296 int capadd
= 0, capdel
= 0;
297 int finished
= 0, negate
;
299 if(!IsRegistered(source_p
))
300 source_p
->flags
|= FLAGS_CLICAP
;
305 buflen
= snprintf(buf
, sizeof(buf
), ":%s CAP %s ACK",
306 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
);
311 for(cap
= clicap_find(arg
, &negate
, &finished
); cap
;
312 cap
= clicap_find(NULL
, &negate
, &finished
))
314 size_t namelen
= strlen(cap
->cap
);
316 /* filled the first array, but cant send it in case the
317 * request fails. one REQ should never fill more than two
320 if(buflen
+ plen
+ namelen
+ 6 >= BUFSIZE
)
329 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_STICKY
))
335 strcat(pbuf
[i
], "-");
338 capdel
|= (1 << cap
->value
);
342 if (!clicap_visible(source_p
, cap
))
348 capadd
|= (1 << cap
->value
);
351 /* XXX this probably should exclude REQACK'd caps from capadd/capdel, but keep old behaviour for now */
352 if(HasCapabilityFlag(cap
, CLICAP_FLAGS_REQACK
))
354 strcat(pbuf
[i
], "~");
358 strcat(pbuf
[i
], cap
->cap
);
360 strcat(pbuf
[i
], " ");
361 plen
+= (namelen
+ 1);
367 sendto_one(source_p
, ":%s CAP %s NAK :%s",
368 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
, arg
);
374 sendto_one(source_p
, "%s * :%s", buf
, pbuf
[0]);
375 sendto_one(source_p
, "%s :%s", buf
, pbuf
[1]);
378 sendto_one(source_p
, "%s :%s", buf
, pbuf
[0]);
380 source_p
->localClient
->caps
|= capadd
;
381 source_p
->localClient
->caps
&= ~capdel
;
384 static struct clicap_cmd
387 void (*func
)(struct Client
*source_p
, const char *arg
);
388 } clicap_cmdlist
[] = {
389 /* This list *MUST* be in alphabetical order */
392 { "LIST", cap_list
},
398 clicap_cmd_search(const char *command
, struct clicap_cmd
*entry
)
400 return irccmp(command
, entry
->cmd
);
404 m_cap(struct MsgBuf
*msgbuf_p
, struct Client
*client_p
, struct Client
*source_p
, int parc
, const char *parv
[])
406 struct clicap_cmd
*cmd
;
408 if(!(cmd
= bsearch(parv
[1], clicap_cmdlist
,
409 sizeof(clicap_cmdlist
) / sizeof(struct clicap_cmd
),
410 sizeof(struct clicap_cmd
), (bqcmp
) clicap_cmd_search
)))
412 sendto_one(source_p
, form_str(ERR_INVALIDCAPCMD
),
413 me
.name
, EmptyString(source_p
->name
) ? "*" : source_p
->name
,
418 (cmd
->func
)(source_p
, parv
[2]);