2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 * Please read the file COPYING, README and AUTHORS for more information.
16 * IRC channel commands
28 #include "conn-func.h"
36 #include "irc-macros.h"
37 #include "irc-write.h"
41 #include "irc-channel.h"
44 * Part from all channels.
46 * RFC 2812, (3.2.1 Join message Command):
47 * Note that this message accepts a special argument ("0"), which is a
48 * special request to leave all channels the user is currently a member of.
49 * The server will process this message as if the user had sent a PART
50 * command (See Section 3.2.2) for each channel he is a member of.
52 * @param client Client that initiated the part request
53 * @param target Client that should part all joined channels
54 * @returns CONNECTED or DISCONNECTED
57 part_from_all_channels(CLIENT* client, CLIENT *target)
62 while ((cl2chan = Channel_FirstChannelOf(target))) {
63 chan = Channel_GetChannel(cl2chan);
64 assert( chan != NULL );
65 Channel_Part(target, client, Channel_Name(chan), Client_ID(target));
68 } /* part_from_all_channels */
71 * Check weather a local client is allowed to join an already existing
74 * @param Client Client that sent the JOIN command
75 * @param chan Channel to check
76 * @param channame Name of the channel
77 * @param key Provided channel key (or NULL)
78 * @returns true if client is allowed to join, false otherwise
81 join_allowed(CLIENT *Client, CHANNEL *chan, const char *channame,
84 bool is_invited, is_banned, is_exception;
86 /* Allow IRC operators to overwrite channel limits */
87 if (Client_HasMode(Client, 'o'))
90 is_banned = Lists_Check(Channel_GetListBans(chan), Client);
91 is_exception = Lists_Check(Channel_GetListExcepts(chan), Client);
92 is_invited = Lists_Check(Channel_GetListInvites(chan), Client);
94 if (is_banned && !is_invited && !is_exception) {
95 /* Client is banned from channel (and not on invite list) */
96 IRC_WriteErrClient(Client, ERR_BANNEDFROMCHAN_MSG,
97 Client_ID(Client), channame);
101 if (Channel_HasMode(chan, 'i') && !is_invited) {
102 /* Channel is "invite-only" and client is not on invite list */
103 IRC_WriteErrClient(Client, ERR_INVITEONLYCHAN_MSG,
104 Client_ID(Client), channame);
108 if (!Channel_CheckKey(chan, Client, key ? key : "")) {
109 /* Channel is protected by a channel key and the client
110 * didn't specify the correct one */
111 IRC_WriteErrClient(Client, ERR_BADCHANNELKEY_MSG,
112 Client_ID(Client), channame);
116 if (Channel_HasMode(chan, 'l') &&
117 (Channel_MaxUsers(chan) <= Channel_MemberCount(chan))) {
118 /* There are more clints joined to this channel than allowed */
119 IRC_WriteErrClient(Client, ERR_CHANNELISFULL_MSG,
120 Client_ID(Client), channame);
124 if (Channel_HasMode(chan, 'z') && !Conn_UsesSSL(Client_Conn(Client))) {
125 /* Only "secure" clients are allowed, but clients doesn't
126 * use SSL encryption */
127 IRC_WriteErrClient(Client, ERR_SECURECHANNEL_MSG,
128 Client_ID(Client), channame);
132 if (Channel_HasMode(chan, 'O') && !Client_OperByMe(Client)) {
133 /* Only IRC operators are allowed! */
134 IRC_WriteErrClient(Client, ERR_OPONLYCHANNEL_MSG,
135 Client_ID(Client), channame);
139 if (Channel_HasMode(chan, 'R') && !Client_HasMode(Client, 'R')) {
140 /* Only registered users are allowed! */
141 IRC_WriteErrClient(Client, ERR_REGONLYCHANNEL_MSG,
142 Client_ID(Client), channame);
150 * Set user channel modes.
152 * @param chan Channel
153 * @param target User to set modes for
154 * @param flags Channel modes to add
157 join_set_channelmodes(CHANNEL *chan, CLIENT *target, const char *flags)
161 Channel_UserModeAdd(chan, target, *flags);
166 /* If the channel is persistent (+P) and client is an IRC op:
167 * make client chanop, if not disabled in configuration. */
168 if (Channel_HasMode(chan, 'P') && Conf_OperChanPAutoOp
169 && Client_HasMode(target, 'o'))
170 Channel_UserModeAdd(chan, target, 'o');
171 } /* join_set_channelmodes */
174 * Forward JOIN command to a specific server
176 * This function differentiates between servers using RFC 2813 mode that
177 * support the JOIN command with appended ASCII 7 character and channel
178 * modes, and servers using RFC 1459 protocol which require separate JOIN
181 * @param To Forward JOIN (and MODE) command to this peer server
182 * @param Prefix Client used to prefix the genrated commands
183 * @param Data Parameters of JOIN command to forward, probably
184 * containing channel modes separated by ASCII 7.
187 cb_join_forward(CLIENT *To, CLIENT *Prefix, void *Data)
190 char str[COMMAND_LEN], *ptr = NULL;
192 strlcpy(str, (char *)Data, sizeof(str));
193 conn = Client_Conn(To);
195 if (Conn_Options(conn) & CONN_RFC1459) {
196 /* RFC 1459 compatibility mode, appended modes are NOT
197 * supported, so strip them off! */
198 ptr = strchr(str, 0x7);
203 IRC_WriteStrClientPrefix(To, Prefix, "JOIN %s", str);
205 IRC_WriteStrClientPrefix(To, Prefix, "MODE %s +%s %s", str, ptr,
207 } /* cb_join_forward */
210 * Forward JOIN command to all servers
212 * This function calls cb_join_forward(), which differentiates between
213 * protocol implementations (e.g. RFC 2812, RFC 1459).
215 * @param Client Client used to prefix the genrated commands
216 * @param target Forward JOIN (and MODE) command to this peer server
217 * @param chan Channel structure
218 * @param channame Channel name
221 join_forward(CLIENT *Client, CLIENT *target, CHANNEL *chan,
222 const char *channame)
224 char modes[CHANNEL_MODE_LEN], str[COMMAND_LEN];
226 /* RFC 2813, 4.2.1: channel modes are separated from the channel
227 * name with ASCII 7, if any, and not spaces: */
228 strlcpy(&modes[1], Channel_UserModes(chan, target), sizeof(modes) - 1);
234 /* forward to other servers (if it is not a local channel) */
235 if (!Channel_IsLocal(chan)) {
236 snprintf(str, sizeof(str), "%s%s", channame, modes);
237 IRC_WriteStrServersPrefixFlag_CB(Client, target, '\0',
238 cb_join_forward, str);
241 /* tell users in this channel about the new client */
242 IRC_WriteStrChannelPrefix(Client, chan, target, false,
243 "JOIN :%s", channame);
245 /* synchronize channel modes */
247 IRC_WriteStrChannelPrefix(Client, chan, target, false,
248 "MODE %s +%s %s", channame,
249 &modes[1], Client_ID(target));
254 * Acknowledge user JOIN request and send "channel info" numerics.
256 * @param Client Client used to prefix the genrated commands
257 * @param target Forward commands/numerics to this user
258 * @param chan Channel structure
259 * @param channame Channel name
262 join_send_topic(CLIENT *Client, CLIENT *target, CHANNEL *chan,
263 const char *channame)
267 if (Client_Type(Client) != CLIENT_USER)
269 /* acknowledge join */
270 if (!IRC_WriteStrClientPrefix(Client, target, "JOIN :%s", channame))
273 /* Send topic to client, if any */
274 topic = Channel_Topic(chan);
275 assert(topic != NULL);
277 if (!IRC_WriteStrClient(Client, RPL_TOPIC_MSG,
278 Client_ID(Client), channame, topic))
281 if (!IRC_WriteStrClient(Client, RPL_TOPICSETBY_MSG,
282 Client_ID(Client), channame,
283 Channel_TopicWho(chan),
284 Channel_TopicTime(chan)))
288 /* send list of channel members to client */
289 if (!IRC_Send_NAMES(Client, chan))
291 return IRC_WriteStrClient(Client, RPL_ENDOFNAMES_MSG, Client_ID(Client),
293 } /* join_send_topic */
296 * Handler for the IRC "JOIN" command.
298 * @param Client The client from which this command has been received.
299 * @param Req Request structure with prefix and all parameters.
300 * @return CONNECTED or DISCONNECTED.
303 IRC_JOIN( CLIENT *Client, REQUEST *Req )
305 char *channame, *key = NULL, *flags, *lastkey = NULL, *lastchan = NULL;
309 assert (Client != NULL);
310 assert (Req != NULL);
312 _IRC_ARGC_GE_OR_RETURN_(Client, Req, 1)
313 _IRC_ARGC_LE_OR_RETURN_(Client, Req, 2)
314 _IRC_GET_SENDER_OR_RETURN_(target, Req, Client)
316 /* Is argument "0"? */
317 if (Req->argc == 1 && !strncmp("0", Req->argv[0], 2))
318 return part_from_all_channels(Client, target);
320 /* Are channel keys given? */
322 key = strtok_r(Req->argv[1], ",", &lastkey);
324 channame = Req->argv[0];
325 channame = strtok_r(channame, ",", &lastchan);
327 /* Make sure that "channame" is not the empty string ("JOIN :") */
329 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG,
330 Client_ID(Client), Req->command);
335 /* Did the server include channel-user-modes? */
336 if (Client_Type(Client) == CLIENT_SERVER) {
337 flags = strchr(channame, 0x7);
344 chan = Channel_Search(channame);
345 if (!chan && !strchr(Conf_AllowedChannelTypes, channame[0])) {
346 /* channel must be created, but forbidden by config */
347 IRC_WriteErrClient(Client, ERR_NOSUCHCHANNEL_MSG,
348 Client_ID(Client), channame);
353 if (Client_Type(Client) == CLIENT_USER) {
355 /* Already existing channel: already member? */
356 if (Channel_IsMemberOf(chan, Client))
360 /* Test if the user has reached the channel limit */
361 if ((Conf_MaxJoins > 0) &&
362 (Channel_CountForUser(Client) >= Conf_MaxJoins)) {
363 if (!IRC_WriteErrClient(Client,
364 ERR_TOOMANYCHANNELS_MSG,
365 Client_ID(Client), channame))
371 /* Already existing channel: check if the
372 * client is allowed to join */
373 if (!join_allowed(Client, chan, channame, key))
376 /* New channel: first user will become channel
377 * operator unless this is a modeless channel */
378 if (*channame != '+')
382 /* Local client: update idle time */
383 Conn_UpdateIdle(Client_Conn(Client));
385 /* Remote server: we don't need to know whether the
386 * client is invited or not, but we have to make sure
387 * that the "one shot" entries (generated by INVITE
388 * commands) in this list become deleted when a user
389 * joins a channel this way. */
391 (void)Lists_Check(Channel_GetListInvites(chan),
395 /* Join channel (and create channel if it doesn't exist) */
396 if (!Channel_Join(target, channame))
399 if (!chan) { /* channel is new; it has been created above */
400 chan = Channel_Search(channame);
401 assert(chan != NULL);
402 if (Channel_IsModeless(chan)) {
403 Channel_ModeAdd(chan, 't'); /* /TOPIC not allowed */
404 Channel_ModeAdd(chan, 'n'); /* no external msgs */
407 assert(chan != NULL);
409 join_set_channelmodes(chan, target, flags);
411 join_forward(Client, target, chan, channame);
413 if (!join_send_topic(Client, target, chan, channame))
414 break; /* write error */
418 channame = strtok_r(NULL, ",", &lastchan);
420 key = strtok_r(NULL, ",", &lastkey);
426 * Handler for the IRC "PART" command.
428 * @param Client The client from which this command has been received.
429 * @param Req Request structure with prefix and all parameters.
430 * @return CONNECTED or DISCONNECTED.
433 IRC_PART(CLIENT * Client, REQUEST * Req)
438 assert(Client != NULL);
441 _IRC_ARGC_GE_OR_RETURN_(Client, Req, 1)
442 _IRC_ARGC_LE_OR_RETURN_(Client, Req, 2)
443 _IRC_GET_SENDER_OR_RETURN_(target, Req, Client)
445 /* Loop over all the given channel names */
446 chan = strtok(Req->argv[0], ",");
448 /* Make sure that "chan" is not the empty string ("PART :") */
450 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG,
451 Client_ID(Client), Req->command);
454 Channel_Part(target, Client, chan,
455 Req->argc > 1 ? Req->argv[1] : Client_ID(target));
456 chan = strtok(NULL, ",");
459 /* Update idle time, if local client */
460 if (Client_Conn(Client) > NONE)
461 Conn_UpdateIdle(Client_Conn(Client));
467 * Handler for the IRC "TOPIC" command.
469 * @param Client The client from which this command has been received.
470 * @param Req Request structure with prefix and all parameters.
471 * @return CONNECTED or DISCONNECTED.
474 IRC_TOPIC( CLIENT *Client, REQUEST *Req )
481 assert( Client != NULL );
482 assert( Req != NULL );
484 IRC_SetPenalty(Client, 1);
486 _IRC_ARGC_GE_OR_RETURN_(Client, Req, 1)
487 _IRC_ARGC_LE_OR_RETURN_(Client, Req, 2)
488 _IRC_GET_SENDER_OR_RETURN_(from, Req, Client)
490 chan = Channel_Search(Req->argv[0]);
492 return IRC_WriteErrClient(from, ERR_NOSUCHCHANNEL_MSG,
493 Client_ID(from), Req->argv[0]);
495 /* Only remote servers and channel members are allowed to change the
496 * channel topic, and IRC operators when the Conf_OperCanMode option
497 * is set in the server configuration. */
498 if (Client_Type(Client) != CLIENT_SERVER) {
499 topic_power = Client_HasMode(from, 'o');
500 if (!Channel_IsMemberOf(chan, from)
501 && !(Conf_OperCanMode && topic_power))
502 return IRC_WriteErrClient(from, ERR_NOTONCHANNEL_MSG,
503 Client_ID(from), Req->argv[0]);
507 if (Req->argc == 1) {
508 /* Request actual topic */
509 topic = Channel_Topic(chan);
511 r = IRC_WriteStrClient(from, RPL_TOPIC_MSG,
513 Channel_Name(chan), topic);
517 r = IRC_WriteStrClient(from, RPL_TOPICSETBY_MSG,
520 Channel_TopicWho(chan),
521 Channel_TopicTime(chan));
526 return IRC_WriteStrClient(from, RPL_NOTOPIC_MSG,
531 if (Channel_HasMode(chan, 't')) {
532 /* Topic Lock. Is the user a channel op or IRC operator? */
534 !Channel_UserHasMode(chan, from, 'h') &&
535 !Channel_UserHasMode(chan, from, 'o') &&
536 !Channel_UserHasMode(chan, from, 'a') &&
537 !Channel_UserHasMode(chan, from, 'q'))
538 return IRC_WriteErrClient(from, ERR_CHANOPRIVSNEEDED_MSG,
544 Channel_SetTopic(chan, from, Req->argv[1]);
545 LogDebug("%s \"%s\" set topic on \"%s\": %s",
546 Client_TypeText(from), Client_Mask(from), Channel_Name(chan),
547 Req->argv[1][0] ? Req->argv[1] : "<none>");
549 if (Conf_OperServerMode)
550 from = Client_ThisServer();
552 /* Update channel and forward new topic to other servers */
553 if (!Channel_IsLocal(chan))
554 IRC_WriteStrServersPrefix(Client, from, "TOPIC %s :%s",
555 Req->argv[0], Req->argv[1]);
556 IRC_WriteStrChannelPrefix(Client, chan, from, false, "TOPIC %s :%s",
557 Req->argv[0], Req->argv[1]);
559 if (Client_Type(Client) == CLIENT_USER)
560 return IRC_WriteStrClientPrefix(Client, Client, "TOPIC %s :%s",
561 Req->argv[0], Req->argv[1]);
567 * Handler for the IRC "LIST" command.
569 * @param Client The client from which this command has been received.
570 * @param Req Request structure with prefix and all parameters.
571 * @return CONNECTED or DISCONNECTED.
574 IRC_LIST( CLIENT *Client, REQUEST *Req )
578 CLIENT *from, *target;
581 assert(Client != NULL);
584 IRC_SetPenalty(Client, 2);
586 _IRC_ARGC_LE_OR_RETURN_(Client, Req, 2)
587 _IRC_GET_SENDER_OR_RETURN_(from, Req, Client)
590 pattern = strtok(Req->argv[0], ",");
594 if (Req->argc == 2) {
595 /* Forward to other server? */
596 target = Client_Search(Req->argv[1]);
597 if (! target || Client_Type(target) != CLIENT_SERVER)
598 return IRC_WriteErrClient(from, ERR_NOSUCHSERVER_MSG,
602 if (target != Client_ThisServer()) {
603 /* Target is indeed an other server, forward it! */
604 return IRC_WriteStrClientPrefix(target, from,
612 /* Loop through all the channels */
614 ngt_LowerStr(pattern);
615 chan = Channel_First();
617 /* Check search pattern */
618 if (MatchCaseInsensitive(pattern, Channel_Name(chan))) {
620 if (!Channel_HasMode(chan, 's')
621 || Channel_IsMemberOf(chan, from)
622 || (!Conf_MorePrivacy && Client_OperByMe(Client))) {
623 if ((Conf_MaxListSize > 0)
624 && IRC_CheckListTooBig(from, count,
628 if (!IRC_WriteStrClient(from,
629 RPL_LIST_MSG, Client_ID(from),
631 Channel_MemberCount(chan),
632 Channel_Topic( chan )))
637 chan = Channel_Next(chan);
640 /* Get next name ... */
642 pattern = strtok(NULL, ",");
647 return IRC_WriteStrClient(from, RPL_LISTEND_MSG, Client_ID(from));
651 * Handler for the IRC+ "CHANINFO" command.
653 * @param Client The client from which this command has been received.
654 * @param Req Request structure with prefix and all parameters.
655 * @return CONNECTED or DISCONNECTED.
658 IRC_CHANINFO( CLIENT *Client, REQUEST *Req )
660 char modes_add[COMMAND_LEN], l[16];
665 assert( Client != NULL );
666 assert( Req != NULL );
668 /* Bad number of parameters? */
669 if (Req->argc < 2 || Req->argc == 4 || Req->argc > 5)
670 return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG,
671 Client_ID(Client), Req->command);
673 /* Compatibility kludge */
676 else if(Req->argc == 3)
681 _IRC_GET_SENDER_OR_RETURN_(from, Req, Client)
683 /* Search or create channel */
684 chan = Channel_Search( Req->argv[0] );
686 chan = Channel_Create( Req->argv[0] );
690 if (Req->argv[1][0] == '+') {
691 if (!*Channel_Modes(chan)) {
692 /* OK, this channel doesn't have modes yet,
693 * set the received ones: */
694 Channel_SetModes(chan, &Req->argv[1][1]);
697 if(Channel_HasMode(chan, 'k'))
698 Channel_SetKey(chan, Req->argv[2]);
699 if(Channel_HasMode(chan, 'l'))
700 Channel_SetMaxUsers(chan, atol(Req->argv[3]));
702 /* Delete modes which we never want to inherit */
703 Channel_ModeDel(chan, 'l');
704 Channel_ModeDel(chan, 'k');
707 strcpy(modes_add, "");
708 if (Channel_HasMode(chan, 'l')) {
709 snprintf(l, sizeof(l), " %lu",
710 Channel_MaxUsers(chan));
711 strlcat(modes_add, l, sizeof(modes_add));
713 if (Channel_HasMode(chan, 'k')) {
714 strlcat(modes_add, " ", sizeof(modes_add));
715 strlcat(modes_add, Channel_Key(chan),
719 /* Inform members of this channel */
720 IRC_WriteStrChannelPrefix(Client, chan, from, false,
721 "MODE %s +%s%s", Req->argv[0],
722 Channel_Modes(chan), modes_add);
726 Log(LOG_WARNING, "CHANINFO: invalid MODE format ignored!");
730 if (!*Channel_Topic(chan) && Req->argv[arg_topic][0]) {
731 /* OK, there is no topic jet */
732 Channel_SetTopic(chan, Client, Req->argv[arg_topic]);
733 IRC_WriteStrChannelPrefix(Client, chan, from, false,
734 "TOPIC %s :%s", Req->argv[0], Channel_Topic(chan));
738 /* Forward CHANINFO to other servers */
740 IRC_WriteStrServersPrefixFlag(Client, from, 'C',
741 "CHANINFO %s %s %s %s :%s",
742 Req->argv[0], Req->argv[1],
743 Req->argv[2], Req->argv[3],
745 else if (Req->argc == 3)
746 IRC_WriteStrServersPrefixFlag(Client, from, 'C',
747 "CHANINFO %s %s :%s",
748 Req->argv[0], Req->argv[1],
751 IRC_WriteStrServersPrefixFlag(Client, from, 'C',
753 Req->argv[0], Req->argv[1]);