2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2005 by 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.
20 static char UNUSED id[] = "$Id: channel.c,v 1.61 2006/12/07 22:23:39 fw Exp $";
30 #include "conn-func.h"
37 #include "irc-write.h"
53 static CHANNEL *My_Channels;
54 static CL2CHAN *My_Cl2Chan;
57 static CL2CHAN *Get_Cl2Chan PARAMS(( CHANNEL *Chan, CLIENT *Client ));
58 static CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client ));
59 static bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer ));
60 static CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan ));
61 static CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan ));
62 static bool Delete_Channel PARAMS(( CHANNEL *Chan ));
73 GLOBAL struct list_head *
74 Channel_GetListBans(CHANNEL *c)
81 GLOBAL struct list_head *
82 Channel_GetListInvites(CHANNEL *c)
85 return &c->list_invites;
90 Channel_InitPredefined( void )
92 /* Vordefinierte persistente Channels erzeugen */
98 for( i = 0; i < Conf_Channel_Count; i++ )
100 /* Ist ein Name konfiguriert? */
101 if( ! Conf_Channel[i].name[0] ) continue;
103 /* Gueltiger Channel-Name? */
104 if( ! Channel_IsValidName( Conf_Channel[i].name ))
106 Log( LOG_ERR, "Can't create pre-defined channel: invalid name: \"%s\"!", Conf_Channel[i].name );
107 array_free(&Conf_Channel[i].topic);
111 /* Gibt es den Channel bereits? */
112 chan = Channel_Search( Conf_Channel[i].name );
115 Log( LOG_INFO, "Can't create pre-defined channel \"%s\": name already in use.", Conf_Channel[i].name );
116 array_free(&Conf_Channel[i].topic);
121 chan = Channel_Create(Conf_Channel[i].name);
123 Channel_ModeAdd(chan, 'P');
125 if (array_start(&Conf_Channel[i].topic) != NULL)
126 Channel_SetTopic(chan, NULL,
127 array_start(&Conf_Channel[i].topic));
128 array_free(&Conf_Channel[i].topic);
130 c = Conf_Channel[i].modes;
132 Channel_ModeAdd(chan, *c++);
134 Log(LOG_INFO, "Created pre-defined channel \"%s\".",
135 Conf_Channel[i].name );
137 else Log(LOG_ERR, "Can't create pre-defined channel \"%s\"!",
138 Conf_Channel[i].name );
140 } /* Channel_InitPredefined */
147 CL2CHAN *cl2chan, *cl2chan_next;
149 /* Channel-Strukturen freigeben */
154 array_free(&c->topic);
159 /* Channel-Zuordnungstabelle freigeben */
160 cl2chan = My_Cl2Chan;
163 cl2chan_next = cl2chan->next;
165 cl2chan = cl2chan_next;
171 Channel_Join( CLIENT *Client, char *Name )
175 assert( Client != NULL );
176 assert( Name != NULL );
178 if( ! Channel_IsValidName( Name )) {
179 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
183 chan = Channel_Search( Name );
185 /* Ist der Client bereits Mitglied? */
186 if( Get_Cl2Chan( chan, Client )) return false;
190 /* Gibt es noch nicht? Dann neu anlegen: */
191 chan = Channel_Create( Name );
192 if (!chan) return false;
195 /* User dem Channel hinzufuegen */
196 if( ! Add_Client( chan, Client )) return false;
202 Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
206 assert( Client != NULL );
207 assert( Name != NULL );
208 assert( Reason != NULL );
210 chan = Channel_Search( Name );
211 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
213 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
217 /* User aus Channel entfernen */
218 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
224 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
228 assert( Client != NULL );
229 assert( Origin != NULL );
230 assert( Name != NULL );
231 assert( Reason != NULL );
233 chan = Channel_Search( Name );
236 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
240 if( ! Channel_IsMemberOf( chan, Origin ))
242 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
246 /* Is User Channel-Operator? */
247 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
249 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
253 /* Ist the kickED User member of channel? */
254 if( ! Channel_IsMemberOf( chan, Client ))
256 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
260 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
265 Channel_Quit( CLIENT *Client, char *Reason )
269 assert( Client != NULL );
270 assert( Reason != NULL );
272 IRC_WriteStrRelatedPrefix( Client, Client, false, "QUIT :%s", Reason );
278 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
285 Channel_Count( void )
288 unsigned long count = 0;
297 } /* Channel_Count */
301 Channel_MemberCount( CHANNEL *Chan )
304 unsigned long count = 0;
306 assert( Chan != NULL );
308 cl2chan = My_Cl2Chan;
311 if( cl2chan->channel == Chan ) count++;
312 cl2chan = cl2chan->next;
315 } /* Channel_MemberCount */
319 Channel_CountForUser( CLIENT *Client )
321 /* Count number of channels a user is member of. */
326 assert( Client != NULL );
328 cl2chan = My_Cl2Chan;
331 if( cl2chan->client == Client ) count++;
332 cl2chan = cl2chan->next;
336 } /* Channel_CountForUser */
341 Channel_Name( const CHANNEL *Chan )
343 assert( Chan != NULL );
349 Channel_Modes( CHANNEL *Chan )
351 assert( Chan != NULL );
353 } /* Channel_Modes */
357 Channel_Key( CHANNEL *Chan )
359 assert( Chan != NULL );
365 Channel_MaxUsers( CHANNEL *Chan )
367 assert( Chan != NULL );
368 return Chan->maxusers;
369 } /* Channel_MaxUsers */
373 Channel_First( void )
376 } /* Channel_First */
380 Channel_Next( CHANNEL *Chan )
382 assert( Chan != NULL );
388 Channel_Search( char *Name )
390 /* Channel-Struktur suchen */
395 assert( Name != NULL );
397 search_hash = Hash( Name );
401 if( search_hash == c->hash )
403 /* lt. Hash-Wert: Treffer! */
404 if( strcasecmp( Name, c->name ) == 0 ) return c;
409 } /* Channel_Search */
413 Channel_FirstMember( CHANNEL *Chan )
415 assert( Chan != NULL );
416 return Get_First_Cl2Chan( NULL, Chan );
417 } /* Channel_FirstMember */
421 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
423 assert( Chan != NULL );
424 assert( Cl2Chan != NULL );
425 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
426 } /* Channel_NextMember */
430 Channel_FirstChannelOf( CLIENT *Client )
432 assert( Client != NULL );
433 return Get_First_Cl2Chan( Client, NULL );
434 } /* Channel_FirstChannelOf */
438 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
440 assert( Client != NULL );
441 assert( Cl2Chan != NULL );
442 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
443 } /* Channel_NextChannelOf */
447 Channel_GetClient( CL2CHAN *Cl2Chan )
449 assert( Cl2Chan != NULL );
450 return Cl2Chan->client;
451 } /* Channel_GetClient */
455 Channel_GetChannel( CL2CHAN *Cl2Chan )
457 assert( Cl2Chan != NULL );
458 return Cl2Chan->channel;
459 } /* Channel_GetChannel */
463 Channel_IsValidName( const char *Name )
465 assert( Name != NULL );
467 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
469 return Name[strcspn(Name, " ,:\007")] == 0;
470 } /* Channel_IsValidName */
474 Channel_ModeAdd( CHANNEL *Chan, char Mode )
477 * If the channel already had this mode, return false.
478 * If the channel mode was newly set return true.
483 assert( Chan != NULL );
485 x[0] = Mode; x[1] = '\0';
486 if( ! strchr( Chan->modes, x[0] ))
488 /* Channel does not have this mode yet, set it */
489 strlcat( Chan->modes, x, sizeof( Chan->modes ));
493 } /* Channel_ModeAdd */
497 Channel_ModeDel( CHANNEL *Chan, char Mode )
500 * if the mode was removed return true.
501 * if the channel did not have the mode, return false.
505 assert( Chan != NULL );
507 p = strchr( Chan->modes, Mode );
508 if( ! p ) return false;
510 /* Channel has mode -> delete */
517 } /* Channel_ModeDel */
521 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
523 /* Set Channel-User-Mode.
524 * if mode was newly set, return true.
525 * if the User already had this channel-mode, return false.
531 assert( Chan != NULL );
532 assert( Client != NULL );
534 cl2chan = Get_Cl2Chan( Chan, Client );
535 assert( cl2chan != NULL );
537 x[0] = Mode; x[1] = '\0';
538 if( ! strchr( cl2chan->modes, x[0] ))
540 /* mode not set, -> set it */
541 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
545 } /* Channel_UserModeAdd */
549 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
551 /* Delete Channel-User-Mode.
552 * If Mode was removed, return true.
553 * If User did not have the Channel-Mode, return false.
559 assert( Chan != NULL );
560 assert( Client != NULL );
562 cl2chan = Get_Cl2Chan( Chan, Client );
563 assert( cl2chan != NULL );
565 p = strchr( cl2chan->modes, Mode );
566 if( ! p ) return false;
568 /* Client has Mode -> delete */
575 } /* Channel_UserModeDel */
579 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
581 /* return Users' Channel-Modes */
585 assert( Chan != NULL );
586 assert( Client != NULL );
588 cl2chan = Get_Cl2Chan( Chan, Client );
589 assert( cl2chan != NULL );
591 return cl2chan->modes;
592 } /* Channel_UserModes */
596 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
598 /* Test if Client is on Channel Chan */
600 assert( Chan != NULL );
601 assert( Client != NULL );
602 return Get_Cl2Chan(Chan, Client);
603 } /* Channel_IsMemberOf */
607 Channel_Topic( CHANNEL *Chan )
610 assert( Chan != NULL );
611 ret = array_start(&Chan->topic);
612 return ret ? ret : "";
613 } /* Channel_Topic */
619 Channel_TopicTime(CHANNEL *Chan)
621 assert(Chan != NULL);
622 return (unsigned int) Chan->topic_time;
623 } /* Channel_TopicTime */
627 Channel_TopicWho(CHANNEL *Chan)
629 assert(Chan != NULL);
630 return Chan->topic_who;
631 } /* Channel_TopicWho */
637 Channel_SetTopic(CHANNEL *Chan, CLIENT *Client, char *Topic)
640 assert( Chan != NULL );
641 assert( Topic != NULL );
644 if (len < array_bytes(&Chan->topic))
645 array_free(&Chan->topic);
647 if (len >= COMMAND_LEN || !array_copyb(&Chan->topic, Topic, len+1))
648 Log(LOG_WARNING, "could not set new Topic \"%s\" on %s: %s",
649 Topic, Chan->name, strerror(errno));
651 Chan->topic_time = time(NULL);
652 if (Client != NULL && Client_Type(Client) != CLIENT_SERVER)
653 strlcpy(Chan->topic_who, Client_ID(Client),
654 sizeof Chan->topic_who);
656 strlcpy(Chan->topic_who, DEFAULT_TOPIC_ID,
657 sizeof Chan->topic_who);
661 } /* Channel_SetTopic */
665 Channel_SetModes( CHANNEL *Chan, char *Modes )
667 assert( Chan != NULL );
668 assert( Modes != NULL );
670 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
671 } /* Channel_SetModes */
675 Channel_SetKey( CHANNEL *Chan, char *Key )
677 assert( Chan != NULL );
678 assert( Key != NULL );
680 strlcpy( Chan->key, Key, sizeof( Chan->key ));
681 LogDebug("Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
682 } /* Channel_SetKey */
686 Channel_SetMaxUsers(CHANNEL *Chan, unsigned long Count)
688 assert( Chan != NULL );
690 Chan->maxusers = Count;
691 LogDebug("Channel %s: Member limit is now %lu.", Chan->name, Chan->maxusers );
692 } /* Channel_SetMaxUsers */
696 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
698 bool is_member, has_voice, is_op, ok;
700 /* Okay, target is a channel */
701 is_member = has_voice = is_op = false;
702 if( Channel_IsMemberOf( Chan, From ))
705 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
706 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
709 /* Is the client allowed to write to channel? */
711 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
712 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
714 /* Is the client banned? */
715 if( Lists_Check(&Chan->list_bans, From))
717 /* Client is banned, but is he channel operator or has voice? */
718 if(( ! has_voice ) && ( ! is_op )) ok = false;
721 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
724 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
725 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
726 } /* Channel_Write */
730 Channel_Create( char *Name )
732 /* Create new CHANNEL structure and add it to linked list */
735 assert( Name != NULL );
737 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
740 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
743 memset( c, 0, sizeof( CHANNEL ));
744 strlcpy( c->name, Name, sizeof( c->name ));
745 c->hash = Hash( c->name );
746 c->next = My_Channels;
748 LogDebug("Created new channel structure for \"%s\".", Name);
750 } /* Channel_Create */
754 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
758 assert( Chan != NULL );
759 assert( Client != NULL );
761 cl2chan = My_Cl2Chan;
764 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
765 cl2chan = cl2chan->next;
772 Add_Client( CHANNEL *Chan, CLIENT *Client )
776 assert( Chan != NULL );
777 assert( Client != NULL );
779 /* neue CL2CHAN-Struktur anlegen */
780 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
783 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
786 cl2chan->channel = Chan;
787 cl2chan->client = Client;
788 strcpy( cl2chan->modes, "" );
791 cl2chan->next = My_Cl2Chan;
792 My_Cl2Chan = cl2chan;
794 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
801 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
803 CL2CHAN *cl2chan, *last_cl2chan;
806 assert( Chan != NULL );
807 assert( Client != NULL );
808 assert( Origin != NULL );
809 assert( Reason != NULL );
812 cl2chan = My_Cl2Chan;
815 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
816 last_cl2chan = cl2chan;
817 cl2chan = cl2chan->next;
819 if( ! cl2chan ) return false;
821 c = cl2chan->channel;
824 /* Aus Verkettung loesen und freigeben */
825 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
826 else My_Cl2Chan = cl2chan->next;
832 /* QUIT: other servers have already been notified, see Client_Destroy();
833 * so only inform other clients in same channel. */
834 assert( InformServer == false );
835 LogDebug("User \"%s\" left channel \"%s\" (%s).",
836 Client_Mask( Client ), c->name, Reason );
839 /* User was KICKed: inform other servers and all users in channel */
841 IRC_WriteStrServersPrefix( Client_NextHop( Origin ),
842 Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason);
843 IRC_WriteStrChannelPrefix(Client, c, Origin, false, "KICK %s %s :%s",
844 c->name, Client_ID( Client ), Reason );
845 if ((Client_Conn(Client) > NONE) &&
846 (Client_Type(Client) == CLIENT_USER))
848 IRC_WriteStrClientPrefix(Client, Origin, "KICK %s %s :%s",
849 c->name, Client_ID( Client ), Reason);
851 LogDebug("User \"%s\" has been kicked of \"%s\" by \"%s\": %s.",
852 Client_Mask( Client ), c->name, Client_ID(Origin), Reason);
856 IRC_WriteStrServersPrefix(Origin, Client, "PART %s :%s", c->name, Reason);
858 IRC_WriteStrChannelPrefix(Origin, c, Client, false, "PART %s :%s",
861 if ((Client_Conn(Origin) > NONE) &&
862 (Client_Type(Origin) == CLIENT_USER))
864 IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason);
865 LogDebug("User \"%s\" left channel \"%s\" (%s).",
866 Client_Mask(Client), c->name, Reason);
870 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
871 if( ! strchr( Channel_Modes( Chan ), 'P' ))
873 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
877 } /* Remove_Client */
881 Channel_AddBan(CHANNEL *c, const char *mask )
883 struct list_head *h = Channel_GetListBans(c);
884 return Lists_Add(h, mask, false);
889 Channel_AddInvite(CHANNEL *c, const char *mask, bool onlyonce)
891 struct list_head *h = Channel_GetListInvites(c);
892 return Lists_Add(h, mask, onlyonce);
897 ShowInvitesBans(struct list_head *head, CLIENT *Client, CHANNEL *Channel, bool invite)
900 char *msg = invite ? RPL_INVITELIST_MSG : RPL_BANLIST_MSG;
903 assert( Client != NULL );
904 assert( Channel != NULL );
906 e = Lists_GetFirst(head);
908 if( ! IRC_WriteStrClient( Client, msg, Client_ID( Client ),
909 Channel_Name( Channel ), Lists_GetMask(e) )) return DISCONNECTED;
910 e = Lists_GetNext(e);
913 msg_end = invite ? RPL_ENDOFINVITELIST_MSG : RPL_ENDOFBANLIST_MSG;
914 return IRC_WriteStrClient( Client, msg_end, Client_ID( Client ), Channel_Name( Channel ));
919 Channel_ShowBans( CLIENT *Client, CHANNEL *Channel )
923 assert( Channel != NULL );
925 h = Channel_GetListBans(Channel);
926 return ShowInvitesBans(h, Client, Channel, false);
931 Channel_ShowInvites( CLIENT *Client, CHANNEL *Channel )
935 assert( Channel != NULL );
937 h = Channel_GetListInvites(Channel);
938 return ShowInvitesBans(h, Client, Channel, true);
943 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
945 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
946 } /* Get_First_Cl2Chan */
950 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
954 assert( Client != NULL || Channel != NULL );
959 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
960 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
961 cl2chan = cl2chan->next;
964 } /* Get_Next_Cl2Chan */
968 Delete_Channel( CHANNEL *Chan )
970 /* Channel-Struktur loeschen */
972 CHANNEL *chan, *last_chan;
978 if( chan == Chan ) break;
982 if( ! chan ) return false;
984 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
986 /* Invite- und Ban-Lists aufraeumen */
987 Lists_Free( &chan->list_bans );
988 Lists_Free( &chan->list_invites );
990 /* Neu verketten und freigeben */
991 if( last_chan ) last_chan->next = chan->next;
992 else My_Channels = chan->next;
996 } /* Delete_Channel */