2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
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-write.h"
40 #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 */
72 * Check weather a local client is allowed to join an already existing
75 * @param Client Client that sent the JOIN command
76 * @param chan Channel to check
77 * @param channame Name of the channel
78 * @param key Provided channel key (or NULL)
79 * @returns true if client is allowed to join, false otherwise
82 join_allowed(CLIENT *Client, CHANNEL *chan, const char *channame,
85 bool is_invited, is_banned;
86 const char *channel_modes;
88 /* Allow IRC operators to overwrite channel limits */
89 if (strchr(Client_Modes(Client), 'o'))
92 is_banned = Lists_Check(Channel_GetListBans(chan), Client);
93 is_invited = Lists_Check(Channel_GetListInvites(chan), Client);
95 if (is_banned && !is_invited) {
96 /* Client is banned from channel (and not on invite list) */
97 IRC_WriteStrClient(Client, ERR_BANNEDFROMCHAN_MSG,
98 Client_ID(Client), channame);
102 channel_modes = Channel_Modes(chan);
103 if (strchr(channel_modes, 'i') && !is_invited) {
104 /* Channel is "invite-only" and client is not on invite list */
105 IRC_WriteStrClient(Client, ERR_INVITEONLYCHAN_MSG,
106 Client_ID(Client), channame);
110 if (!Channel_CheckKey(chan, Client, key ? key : "")) {
111 /* Channel is protected by a channel key and the client
112 * didn't specify the correct one */
113 IRC_WriteStrClient(Client, ERR_BADCHANNELKEY_MSG,
114 Client_ID(Client), channame);
118 if (strchr(channel_modes, 'l') &&
119 (Channel_MaxUsers(chan) <= Channel_MemberCount(chan))) {
120 /* There are more clints joined to this channel than allowed */
121 IRC_WriteStrClient(Client, ERR_CHANNELISFULL_MSG,
122 Client_ID(Client), channame);
126 if (strchr(channel_modes, 'z') && !Conn_UsesSSL(Client_Conn(Client))) {
127 /* Only "secure" clients are allowed, but clients doesn't
128 * use SSL encryption */
129 IRC_WriteStrClient(Client, ERR_SECURECHANNEL_MSG,
130 Client_ID(Client), channame);
134 if (strchr(channel_modes, 'O') && !Client_OperByMe(Client)) {
135 /* Only IRC operators are allowed! */
136 IRC_WriteStrClient(Client, ERR_OPONLYCHANNEL_MSG,
137 Client_ID(Client), channame);
141 if (strchr(channel_modes, 'R') && !strchr(Client_Modes(Client), 'R')) {
142 /* Only registered users are allowed! */
143 IRC_WriteStrClient(Client, ERR_REGONLYCHANNEL_MSG,
144 Client_ID(Client), channame);
153 * Set user channel modes.
155 * @param chan Channel
156 * @param target User to set modes for
157 * @param flags Channel modes to add
160 join_set_channelmodes(CHANNEL *chan, CLIENT *target, const char *flags)
164 Channel_UserModeAdd(chan, target, *flags);
169 /* If channel persistent and client is ircop: make client chanop */
170 if (strchr(Channel_Modes(chan), 'P') && strchr(Client_Modes(target), 'o'))
171 Channel_UserModeAdd(chan, target, 'o');
172 } /* join_set_channelmodes */
176 * Forward JOIN command to a specific server
178 * This function diffentiates between servers using RFC 2813 mode that
179 * support the JOIN command with appended ASCII 7 character and channel
180 * modes, and servers using RFC 1459 protocol which require separate JOIN
183 * @param To Forward JOIN (and MODE) command to this peer server
184 * @param Prefix Client used to prefix the genrated commands
185 * @param Data Parameters of JOIN command to forward, probably
186 * containing channel modes separated by ASCII 7.
189 cb_join_forward(CLIENT *To, CLIENT *Prefix, void *Data)
192 char str[COMMAND_LEN], *ptr = NULL;
194 strlcpy(str, (char *)Data, sizeof(str));
195 conn = Client_Conn(To);
197 if (Conn_Options(conn) & CONN_RFC1459) {
198 /* RFC 1459 compatibility mode, appended modes are NOT
199 * supported, so strip them off! */
200 ptr = strchr(str, 0x7);
205 IRC_WriteStrClientPrefix(To, Prefix, "JOIN %s", str);
207 IRC_WriteStrClientPrefix(To, Prefix, "MODE %s +%s %s", str, ptr,
209 } /* cb_join_forward */
213 * Forward JOIN command to all servers
215 * This function calls cb_join_forward(), which differentiates between
216 * protocol implementations (e.g. RFC 2812, RFC 1459).
218 * @param Client Client used to prefix the genrated commands
219 * @param target Forward JOIN (and MODE) command to this peer server
220 * @param chan Channel structure
221 * @param channame Channel name
224 join_forward(CLIENT *Client, CLIENT *target, CHANNEL *chan,
225 const char *channame)
227 char modes[CHANNEL_MODE_LEN], str[COMMAND_LEN];
229 /* RFC 2813, 4.2.1: channel modes are separated from the channel
230 * name with ASCII 7, if any, and not spaces: */
231 strlcpy(&modes[1], Channel_UserModes(chan, target), sizeof(modes) - 1);
237 /* forward to other servers (if it is not a local channel) */
238 if (!Channel_IsLocal(chan)) {
239 snprintf(str, sizeof(str), "%s%s", channame, modes);
240 IRC_WriteStrServersPrefixFlag_CB(Client, target, '\0',
241 cb_join_forward, str);
244 /* tell users in this channel about the new client */
245 IRC_WriteStrChannelPrefix(Client, chan, target, false,
246 "JOIN :%s", channame);
248 /* synchronize channel modes */
250 IRC_WriteStrChannelPrefix(Client, chan, target, false,
251 "MODE %s +%s %s", channame,
252 &modes[1], Client_ID(target));
258 * Aknowledge user JOIN request and send "channel info" numerics.
260 * @param Client Client used to prefix the genrated commands
261 * @param target Forward commands/numerics to this user
262 * @param chan Channel structure
263 * @param channame Channel name
266 join_send_topic(CLIENT *Client, CLIENT *target, CHANNEL *chan,
267 const char *channame)
271 if (Client_Type(Client) != CLIENT_USER)
273 /* acknowledge join */
274 if (!IRC_WriteStrClientPrefix(Client, target, "JOIN :%s", channame))
277 /* Send topic to client, if any */
278 topic = Channel_Topic(chan);
279 assert(topic != NULL);
281 if (!IRC_WriteStrClient(Client, RPL_TOPIC_MSG,
282 Client_ID(Client), channame, topic))
285 if (!IRC_WriteStrClient(Client, RPL_TOPICSETBY_MSG,
286 Client_ID(Client), channame,
287 Channel_TopicWho(chan),
288 Channel_TopicTime(chan)))
292 /* send list of channel members to client */
293 if (!IRC_Send_NAMES(Client, chan))
295 return IRC_WriteStrClient(Client, RPL_ENDOFNAMES_MSG, Client_ID(Client),
297 } /* join_send_topic */
301 * Handler for the IRC "JOIN" command.
303 * See RFC 2812, 3.2.1 "Join message"; RFC 2813, 4.2.1 "Join message".
305 * @param Client The client from which this command has been received
306 * @param Req Request structure with prefix and all parameters
307 * @returns CONNECTED or DISCONNECTED
310 IRC_JOIN( CLIENT *Client, REQUEST *Req )
312 char *channame, *key = NULL, *flags, *lastkey = NULL, *lastchan = NULL;
316 assert (Client != NULL);
317 assert (Req != NULL);
319 /* Bad number of arguments? */
320 if (Req->argc < 1 || Req->argc > 2)
321 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
322 Client_ID(Client), Req->command);
324 /* Who is the sender? */
325 if (Client_Type(Client) == CLIENT_SERVER)
326 target = Client_Search(Req->prefix);
331 return IRC_WriteStrClient(Client, ERR_NOSUCHNICK_MSG,
332 Client_ID(Client), Req->prefix);
334 /* Is argument "0"? */
335 if (Req->argc == 1 && !strncmp("0", Req->argv[0], 2))
336 return part_from_all_channels(Client, target);
338 /* Are channel keys given? */
340 key = strtok_r(Req->argv[1], ",", &lastkey);
342 channame = Req->argv[0];
343 channame = strtok_r(channame, ",", &lastchan);
345 /* Make sure that "channame" is not the empty string ("JOIN :") */
347 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
348 Client_ID(Client), Req->command);
353 /* Did the server include channel-user-modes? */
354 if (Client_Type(Client) == CLIENT_SERVER) {
355 flags = strchr(channame, 0x7);
362 chan = Channel_Search(channame);
363 if (!chan && Conf_PredefChannelsOnly) {
364 /* channel must be created, but forbidden by config */
365 IRC_WriteStrClient(Client, ERR_BANNEDFROMCHAN_MSG,
366 Client_ID(Client), channame);
371 if (Client_Type(Client) == CLIENT_USER) {
372 /* Test if the user has reached the channel limit */
373 if ((Conf_MaxJoins > 0) &&
374 (Channel_CountForUser(Client) >= Conf_MaxJoins))
375 return IRC_WriteStrClient(Client,
376 ERR_TOOMANYCHANNELS_MSG,
377 Client_ID(Client), channame);
379 /* Already existing channel: check if the
380 * client is allowed to join */
381 if (!join_allowed(Client, chan, channame, key))
384 /* New channel: first user will become channel
385 * operator unless this is a modeless channel */
386 if (*channame != '+')
390 /* Local client: update idle time */
391 Conn_UpdateIdle(Client_Conn(Client));
393 /* Remote server: we don't need to know whether the
394 * client is invited or not, but we have to make sure
395 * that the "one shot" entries (generated by INVITE
396 * commands) in this list become deleted when a user
397 * joins a channel this way. */
399 (void)Lists_Check(Channel_GetListInvites(chan),
403 /* Join channel (and create channel if it doesn't exist) */
404 if (!Channel_Join(target, channame))
407 if (!chan) { /* channel is new; it has been created above */
408 chan = Channel_Search(channame);
409 assert(chan != NULL);
410 if (Channel_IsModeless(chan)) {
411 Channel_ModeAdd(chan, 't'); /* /TOPIC not allowed */
412 Channel_ModeAdd(chan, 'n'); /* no external msgs */
415 assert(chan != NULL);
417 join_set_channelmodes(chan, target, flags);
419 join_forward(Client, target, chan, channame);
421 if (!join_send_topic(Client, target, chan, channame))
422 break; /* write error */
426 channame = strtok_r(NULL, ",", &lastchan);
428 key = strtok_r(NULL, ",", &lastkey);
435 * Handler for the IRC "PART" command.
437 * See RFC 2812, 3.2.2: "Part message".
439 * @param Client The client from which this command has been received
440 * @param Req Request structure with prefix and all parameters
441 * @returns CONNECTED or DISCONNECTED
444 IRC_PART(CLIENT * Client, REQUEST * Req)
449 assert(Client != NULL);
452 if (Req->argc < 1 || Req->argc > 2)
453 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
454 Client_ID(Client), Req->command);
457 if (Client_Type(Client) == CLIENT_SERVER)
458 target = Client_Search(Req->prefix);
462 return IRC_WriteStrClient(Client, ERR_NOSUCHNICK_MSG,
463 Client_ID(Client), Req->prefix);
465 /* Loop over all the given channel names */
466 chan = strtok(Req->argv[0], ",");
468 /* Make sure that "chan" is not the empty string ("PART :") */
470 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
471 Client_ID(Client), Req->command);
474 Channel_Part(target, Client, chan,
475 Req->argc > 1 ? Req->argv[1] : Client_ID(target));
476 chan = strtok(NULL, ",");
479 /* Update idle time, if local client */
480 if (Client_Conn(Client) > NONE)
481 Conn_UpdateIdle(Client_Conn(Client));
488 * Handler for the IRC "TOPIC" command.
490 * See RFC 2812, 3.2.4 "Topic message".
492 * @param Client The client from which this command has been received
493 * @param Req Request structure with prefix and all parameters
494 * @returns CONNECTED or DISCONNECTED
497 IRC_TOPIC( CLIENT *Client, REQUEST *Req )
502 bool onchannel, topicok, use_servermode, r;
504 assert( Client != NULL );
505 assert( Req != NULL );
507 if (Req->argc < 1 || Req->argc > 2)
508 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
509 Client_ID(Client), Req->command);
511 if (Client_Type(Client) == CLIENT_SERVER)
512 from = Client_Search(Req->prefix);
517 return IRC_WriteStrClient(Client, ERR_NOSUCHNICK_MSG,
518 Client_ID(Client), Req->prefix);
520 chan = Channel_Search(Req->argv[0]);
522 return IRC_WriteStrClient(from, ERR_NOSUCHCHANNEL_MSG,
523 Client_ID(from), Req->argv[0]);
525 Channel_CheckAdminRights(chan, Client, from,
526 &onchannel, &topicok, &use_servermode);
528 if (!onchannel && !topicok)
529 return IRC_WriteStrClient(from, ERR_NOTONCHANNEL_MSG,
530 Client_ID(from), Req->argv[0]);
532 if (Req->argc == 1) {
533 /* Request actual topic */
534 topic = Channel_Topic(chan);
536 r = IRC_WriteStrClient(from, RPL_TOPIC_MSG,
538 Channel_Name(chan), topic);
542 r = IRC_WriteStrClient(from, RPL_TOPICSETBY_MSG,
545 Channel_TopicWho(chan),
546 Channel_TopicTime(chan));
551 return IRC_WriteStrClient(from, RPL_NOTOPIC_MSG,
556 if (strchr(Channel_Modes(chan), 't')) {
557 /* Topic Lock. Is the user a channel or IRC operator? */
559 return IRC_WriteStrClient(from, ERR_CHANOPRIVSNEEDED_MSG,
565 Channel_SetTopic(chan, from, Req->argv[1]);
566 LogDebug("%s \"%s\" set topic on \"%s\": %s",
567 Client_TypeText(from), Client_Mask(from), Channel_Name(chan),
568 Req->argv[1][0] ? Req->argv[1] : "<none>");
571 from = Client_ThisServer();
573 /* Update channel and forward new topic to other servers */
574 if (!Channel_IsLocal(chan))
575 IRC_WriteStrServersPrefix(Client, from, "TOPIC %s :%s",
576 Req->argv[0], Req->argv[1]);
577 IRC_WriteStrChannelPrefix(Client, chan, from, false, "TOPIC %s :%s",
578 Req->argv[0], Req->argv[1]);
580 if (Client_Type(Client) == CLIENT_USER)
581 return IRC_WriteStrClientPrefix(Client, Client, "TOPIC %s :%s",
582 Req->argv[0], Req->argv[1]);
589 * Handler for the IRC "LIST" command.
591 * See RFC 2812, 3.2.6 "List message".
593 * This implementation handles the local case as well as the forwarding of the
594 * LIST command to other servers in the IRC network.
596 * @param Client The client from which this command has been received.
597 * @param Req Request structure with prefix and all parameters.
598 * @return CONNECTED or DISCONNECTED.
601 IRC_LIST( CLIENT *Client, REQUEST *Req )
605 CLIENT *from, *target;
608 assert(Client != NULL);
611 /* Bad number of prameters? */
613 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
614 Client_ID(Client), Req->command);
617 pattern = strtok(Req->argv[0], ",");
621 /* Get sender from prefix, if any */
622 if (Client_Type(Client) == CLIENT_SERVER)
623 from = Client_Search(Req->prefix);
628 return IRC_WriteStrClient(Client, ERR_NOSUCHSERVER_MSG,
629 Client_ID(Client), Req->prefix);
631 if (Req->argc == 2) {
632 /* Forward to other server? */
633 target = Client_Search(Req->argv[1]);
634 if (! target || Client_Type(target) != CLIENT_SERVER)
635 return IRC_WriteStrClient(from, ERR_NOSUCHSERVER_MSG,
639 if (target != Client_ThisServer()) {
640 /* Target is indeed an other server, forward it! */
641 return IRC_WriteStrClientPrefix(target, from,
649 /* Loop through all the channels */
651 ngt_LowerStr(pattern);
652 chan = Channel_First();
654 /* Check search pattern */
655 if (MatchCaseInsensitive(pattern, Channel_Name(chan))) {
657 if (!strchr(Channel_Modes(chan), 's')
658 || Channel_IsMemberOf(chan, from)) {
659 if (IRC_CheckListTooBig(from, count,
663 if (!IRC_WriteStrClient(from,
664 RPL_LIST_MSG, Client_ID(from),
666 Channel_MemberCount(chan),
667 Channel_Topic( chan )))
672 chan = Channel_Next(chan);
675 /* Get next name ... */
677 pattern = strtok(NULL, ",");
682 IRC_SetPenalty(from, 2);
683 return IRC_WriteStrClient(from, RPL_LISTEND_MSG, Client_ID(from));
688 * Handler for the IRC+ command "CHANINFO".
690 * See doc/Protocol.txt, section II.3:
691 * "Exchange channel-modes, topics, and persistent channels".
693 * @param Client The client from which this command has been received
694 * @param Req Request structure with prefix and all parameters
695 * @returns CONNECTED or DISCONNECTED
698 IRC_CHANINFO( CLIENT *Client, REQUEST *Req )
700 char modes_add[COMMAND_LEN], l[16], *ptr;
705 assert( Client != NULL );
706 assert( Req != NULL );
708 /* Bad number of parameters? */
709 if (Req->argc < 2 || Req->argc == 4 || Req->argc > 5)
710 return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
711 Client_ID(Client), Req->command);
713 /* Compatibility kludge */
714 if( Req->argc == 5 ) arg_topic = 4;
715 else if( Req->argc == 3 ) arg_topic = 2;
719 from = Client_Search( Req->prefix );
720 if( ! from ) return IRC_WriteStrClient( Client, ERR_NOSUCHNICK_MSG, Client_ID( Client ), Req->prefix );
722 /* Search or create channel */
723 chan = Channel_Search( Req->argv[0] );
724 if( ! chan ) chan = Channel_Create( Req->argv[0] );
725 if( ! chan ) return CONNECTED;
727 if( Req->argv[1][0] == '+' )
729 ptr = Channel_Modes( chan );
732 /* OK, this channel doesn't have modes jet, set the received ones: */
733 Channel_SetModes( chan, &Req->argv[1][1] );
737 if( strchr( Channel_Modes( chan ), 'k' )) Channel_SetKey( chan, Req->argv[2] );
738 if( strchr( Channel_Modes( chan ), 'l' )) Channel_SetMaxUsers( chan, atol( Req->argv[3] ));
742 /* Delete modes which we never want to inherit */
743 Channel_ModeDel( chan, 'l' );
744 Channel_ModeDel( chan, 'k' );
747 strcpy( modes_add, "" );
748 ptr = Channel_Modes( chan );
753 snprintf( l, sizeof( l ), " %lu", Channel_MaxUsers( chan ));
754 strlcat( modes_add, l, sizeof( modes_add ));
758 strlcat( modes_add, " ", sizeof( modes_add ));
759 strlcat( modes_add, Channel_Key( chan ), sizeof( modes_add ));
764 /* Inform members of this channel */
765 IRC_WriteStrChannelPrefix( Client, chan, from, false, "MODE %s +%s%s", Req->argv[0], Channel_Modes( chan ), modes_add );
768 else Log( LOG_WARNING, "CHANINFO: invalid MODE format ignored!" );
773 ptr = Channel_Topic( chan );
774 if(( ! *ptr ) && ( Req->argv[arg_topic][0] ))
776 /* OK, there is no topic jet */
777 Channel_SetTopic(chan, Client, Req->argv[arg_topic]);
778 IRC_WriteStrChannelPrefix(Client, chan, from, false,
779 "TOPIC %s :%s", Req->argv[0], Channel_Topic(chan));
783 /* Forward CHANINFO to other serevrs */
784 if( Req->argc == 5 ) IRC_WriteStrServersPrefixFlag( Client, from, 'C', "CHANINFO %s %s %s %s :%s", Req->argv[0], Req->argv[1], Req->argv[2], Req->argv[3], Req->argv[4] );
785 else if( Req->argc == 3 ) IRC_WriteStrServersPrefixFlag( Client, from, 'C', "CHANINFO %s %s :%s", Req->argv[0], Req->argv[1], Req->argv[2] );
786 else IRC_WriteStrServersPrefixFlag( Client, from, 'C', "CHANINFO %s %s", Req->argv[0], Req->argv[1] );