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.56 2006/07/24 22:54:09 alex 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 ));
74 Channel_InitPredefined( void )
76 /* Vordefinierte persistente Channels erzeugen */
82 for( i = 0; i < Conf_Channel_Count; i++ )
84 /* Ist ein Name konfiguriert? */
85 if( ! Conf_Channel[i].name[0] ) continue;
87 /* Gueltiger Channel-Name? */
88 if( ! Channel_IsValidName( Conf_Channel[i].name ))
90 Log( LOG_ERR, "Can't create pre-defined channel: invalid name: \"%s\"!", Conf_Channel[i].name );
91 array_free(&Conf_Channel[i].topic);
95 /* Gibt es den Channel bereits? */
96 chan = Channel_Search( Conf_Channel[i].name );
99 Log( LOG_INFO, "Can't create pre-defined channel \"%s\": name already in use.", Conf_Channel[i].name );
100 array_free(&Conf_Channel[i].topic);
105 chan = Channel_Create(Conf_Channel[i].name);
107 Channel_ModeAdd(chan, 'P');
109 if (array_start(&Conf_Channel[i].topic) != NULL)
110 Channel_SetTopic(chan, NULL,
111 array_start(&Conf_Channel[i].topic));
112 array_free(&Conf_Channel[i].topic);
114 c = Conf_Channel[i].modes;
116 Channel_ModeAdd(chan, *c++);
118 Log(LOG_INFO, "Created pre-defined channel \"%s\".",
119 Conf_Channel[i].name );
121 else Log(LOG_ERR, "Can't create pre-defined channel \"%s\"!",
122 Conf_Channel[i].name );
124 } /* Channel_InitPredefined */
131 CL2CHAN *cl2chan, *cl2chan_next;
133 /* Channel-Strukturen freigeben */
138 array_free(&c->topic);
143 /* Channel-Zuordnungstabelle freigeben */
144 cl2chan = My_Cl2Chan;
147 cl2chan_next = cl2chan->next;
149 cl2chan = cl2chan_next;
155 Channel_Join( CLIENT *Client, char *Name )
159 assert( Client != NULL );
160 assert( Name != NULL );
162 if( ! Channel_IsValidName( Name )) {
163 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
167 chan = Channel_Search( Name );
169 /* Ist der Client bereits Mitglied? */
170 if( Get_Cl2Chan( chan, Client )) return false;
174 /* Gibt es noch nicht? Dann neu anlegen: */
175 chan = Channel_Create( Name );
176 if( ! chan ) return false;
179 /* User dem Channel hinzufuegen */
180 if( ! Add_Client( chan, Client )) return false;
186 Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
190 assert( Client != NULL );
191 assert( Name != NULL );
192 assert( Reason != NULL );
194 chan = Channel_Search( Name );
195 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
197 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
201 /* User aus Channel entfernen */
202 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
208 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
212 assert( Client != NULL );
213 assert( Origin != NULL );
214 assert( Name != NULL );
215 assert( Reason != NULL );
218 chan = Channel_Search( Name );
221 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
225 if( ! Channel_IsMemberOf( chan, Origin ))
227 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
231 /* Is User Channel-Operator? */
232 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
234 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
238 /* Ist the kickED User member of channel? */
239 if( ! Channel_IsMemberOf( chan, Client ))
241 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
245 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
250 Channel_Quit( CLIENT *Client, char *Reason )
254 assert( Client != NULL );
255 assert( Reason != NULL );
257 IRC_WriteStrRelatedPrefix( Client, Client, false, "QUIT :%s", Reason );
263 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
270 Channel_Count( void )
282 } /* Channel_Count */
286 Channel_MemberCount( CHANNEL *Chan )
291 assert( Chan != NULL );
293 cl2chan = My_Cl2Chan;
296 if( cl2chan->channel == Chan ) count++;
297 cl2chan = cl2chan->next;
300 } /* Channel_MemberCount */
304 Channel_CountForUser( CLIENT *Client )
306 /* Count number of channels a user is member of. */
311 assert( Client != NULL );
313 cl2chan = My_Cl2Chan;
316 if( cl2chan->client == Client ) count++;
317 cl2chan = cl2chan->next;
321 } /* Channel_CountForUser */
325 Channel_PCount( void )
327 /* Count the number of persistent (mode 'P') channels */
335 if( strchr( chan->modes, 'P' )) count++;
340 } /* Channel_PCount */
344 Channel_Name( CHANNEL *Chan )
346 assert( Chan != NULL );
352 Channel_Modes( CHANNEL *Chan )
354 assert( Chan != NULL );
356 } /* Channel_Modes */
360 Channel_Key( CHANNEL *Chan )
362 assert( Chan != NULL );
368 Channel_MaxUsers( CHANNEL *Chan )
370 assert( Chan != NULL );
371 return Chan->maxusers;
372 } /* Channel_MaxUsers */
376 Channel_First( void )
379 } /* Channel_First */
383 Channel_Next( CHANNEL *Chan )
385 assert( Chan != NULL );
391 Channel_Search( char *Name )
393 /* Channel-Struktur suchen */
398 assert( Name != NULL );
400 search_hash = Hash( Name );
404 if( search_hash == c->hash )
406 /* lt. Hash-Wert: Treffer! */
407 if( strcasecmp( Name, c->name ) == 0 ) return c;
412 } /* Channel_Search */
416 Channel_FirstMember( CHANNEL *Chan )
418 assert( Chan != NULL );
419 return Get_First_Cl2Chan( NULL, Chan );
420 } /* Channel_FirstMember */
424 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
426 assert( Chan != NULL );
427 assert( Cl2Chan != NULL );
428 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
429 } /* Channel_NextMember */
433 Channel_FirstChannelOf( CLIENT *Client )
435 assert( Client != NULL );
436 return Get_First_Cl2Chan( Client, NULL );
437 } /* Channel_FirstChannelOf */
441 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
443 assert( Client != NULL );
444 assert( Cl2Chan != NULL );
445 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
446 } /* Channel_NextChannelOf */
450 Channel_GetClient( CL2CHAN *Cl2Chan )
452 assert( Cl2Chan != NULL );
453 return Cl2Chan->client;
454 } /* Channel_GetClient */
458 Channel_GetChannel( CL2CHAN *Cl2Chan )
460 assert( Cl2Chan != NULL );
461 return Cl2Chan->channel;
462 } /* Channel_GetChannel */
466 Channel_IsValidName( char *Name )
468 /* Pruefen, ob Name als Channelname gueltig */
470 char *ptr, badchars[10];
472 assert( Name != NULL );
474 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
477 strcpy( badchars, " ,:\007" );
480 if( strchr( badchars, *ptr )) return false;
485 } /* Channel_IsValidName */
489 Channel_ModeAdd( CHANNEL *Chan, char Mode )
492 * If the channel already had this mode, return false.
493 * If the channel mode was newly set return true.
498 assert( Chan != NULL );
500 x[0] = Mode; x[1] = '\0';
501 if( ! strchr( Chan->modes, x[0] ))
503 /* Channel does not have this mode yet, set it */
504 strlcat( Chan->modes, x, sizeof( Chan->modes ));
508 } /* Channel_ModeAdd */
512 Channel_ModeDel( CHANNEL *Chan, char Mode )
515 * if the mode was removed return true.
516 * if the channel did not have the mode, return false.
520 assert( Chan != NULL );
522 p = strchr( Chan->modes, Mode );
523 if( ! p ) return false;
525 /* Channel has mode -> delete */
532 } /* Channel_ModeDel */
536 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
538 /* Set Channel-User-Mode.
539 * if mode was newly set, return true.
540 * if the User already had this channel-mode, return false.
546 assert( Chan != NULL );
547 assert( Client != NULL );
549 cl2chan = Get_Cl2Chan( Chan, Client );
550 assert( cl2chan != NULL );
552 x[0] = Mode; x[1] = '\0';
553 if( ! strchr( cl2chan->modes, x[0] ))
555 /* mode not set, -> set it */
556 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
560 } /* Channel_UserModeAdd */
564 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
566 /* Delete Channel-User-Mode.
567 * If Mode was removed, return true.
568 * If User did not have the Channel-Mode, return false.
574 assert( Chan != NULL );
575 assert( Client != NULL );
577 cl2chan = Get_Cl2Chan( Chan, Client );
578 assert( cl2chan != NULL );
580 p = strchr( cl2chan->modes, Mode );
581 if( ! p ) return false;
583 /* Client has Mode -> delete */
590 } /* Channel_UserModeDel */
594 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
596 /* return Users' Channel-Modes */
600 assert( Chan != NULL );
601 assert( Client != NULL );
603 cl2chan = Get_Cl2Chan( Chan, Client );
604 assert( cl2chan != NULL );
606 return cl2chan->modes;
607 } /* Channel_UserModes */
611 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
613 /* Test if Client is on Channel Chan */
615 assert( Chan != NULL );
616 assert( Client != NULL );
618 if( Get_Cl2Chan( Chan, Client )) return true;
620 } /* Channel_IsMemberOf */
624 Channel_Topic( CHANNEL *Chan )
627 assert( Chan != NULL );
628 ret = array_start(&Chan->topic);
629 return ret ? ret : "";
630 } /* Channel_Topic */
636 Channel_TopicTime(CHANNEL *Chan)
638 assert(Chan != NULL);
639 return (unsigned int) Chan->topic_time;
640 } /* Channel_TopicTime */
644 Channel_TopicWho(CHANNEL *Chan)
646 assert(Chan != NULL);
647 return Chan->topic_who;
648 } /* Channel_TopicWho */
654 Channel_SetTopic(CHANNEL *Chan, CLIENT *Client, char *Topic)
657 assert( Chan != NULL );
658 assert( Topic != NULL );
661 if (len < array_bytes(&Chan->topic))
662 array_free(&Chan->topic);
664 if (!array_copyb(&Chan->topic, Topic, len))
665 Log(LOG_WARNING, "could not set new Topic \"%s\" on %s: %s",
666 Topic, Chan->name, strerror(errno));
668 array_cat0(&Chan->topic);
671 Chan->topic_time = time(NULL);
672 if (Client != NULL && Client_Type(Client) != CLIENT_SERVER)
673 strlcpy(Chan->topic_who, Client_ID(Client),
674 sizeof Chan->topic_who);
676 strlcpy(Chan->topic_who, DEFAULT_TOPIC_ID,
677 sizeof Chan->topic_who);
681 } /* Channel_SetTopic */
685 Channel_SetModes( CHANNEL *Chan, char *Modes )
687 assert( Chan != NULL );
688 assert( Modes != NULL );
690 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
691 } /* Channel_SetModes */
695 Channel_SetKey( CHANNEL *Chan, char *Key )
697 assert( Chan != NULL );
698 assert( Key != NULL );
700 strlcpy( Chan->key, Key, sizeof( Chan->key ));
701 Log( LOG_DEBUG, "Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
702 } /* Channel_SetKey */
706 Channel_SetMaxUsers( CHANNEL *Chan, long Count )
708 assert( Chan != NULL );
710 Chan->maxusers = Count;
711 Log( LOG_DEBUG, "Channel %s: Member limit is now %ld.", Chan->name, Chan->maxusers );
712 } /* Channel_SetMaxUsers */
716 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
718 bool is_member, has_voice, is_op, ok;
720 /* Okay, target is a channel */
721 is_member = has_voice = is_op = false;
722 if( Channel_IsMemberOf( Chan, From ))
725 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
726 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
729 /* Is the client allowed to write to channel? */
731 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
732 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
734 /* Is the client banned? */
735 if( Lists_CheckBanned( From, Chan ))
737 /* Client is banned, but is he channel operator or has voice? */
738 if(( ! has_voice ) && ( ! is_op )) ok = false;
741 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
744 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
745 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
746 } /* Channel_Write */
750 Channel_Create( char *Name )
752 /* Create new CHANNEL structure and add it to linked list */
755 assert( Name != NULL );
757 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
760 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
763 memset( c, 0, sizeof( CHANNEL ));
764 strlcpy( c->name, Name, sizeof( c->name ));
765 c->hash = Hash( c->name );
766 c->next = My_Channels;
769 Log( LOG_DEBUG, "Created new channel structure for \"%s\".", Name );
772 } /* Channel_Create */
776 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
780 assert( Chan != NULL );
781 assert( Client != NULL );
783 cl2chan = My_Cl2Chan;
786 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
787 cl2chan = cl2chan->next;
794 Add_Client( CHANNEL *Chan, CLIENT *Client )
798 assert( Chan != NULL );
799 assert( Client != NULL );
801 /* neue CL2CHAN-Struktur anlegen */
802 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
805 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
808 cl2chan->channel = Chan;
809 cl2chan->client = Client;
810 strcpy( cl2chan->modes, "" );
813 cl2chan->next = My_Cl2Chan;
814 My_Cl2Chan = cl2chan;
816 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
823 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
825 CL2CHAN *cl2chan, *last_cl2chan;
828 assert( Chan != NULL );
829 assert( Client != NULL );
830 assert( Origin != NULL );
831 assert( Reason != NULL );
834 cl2chan = My_Cl2Chan;
837 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
838 last_cl2chan = cl2chan;
839 cl2chan = cl2chan->next;
841 if( ! cl2chan ) return false;
843 c = cl2chan->channel;
846 /* Aus Verkettung loesen und freigeben */
847 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
848 else My_Cl2Chan = cl2chan->next;
854 /* QUIT: andere Server wurden bereits informiert, vgl. Client_Destroy();
855 * hier also "nur" noch alle User in betroffenen Channeln infomieren */
856 assert( InformServer == false );
857 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
860 /* User wurde geKICKed: ggf. andere Server sowie alle betroffenen User
861 * im entsprechenden Channel informieren */
862 if( InformServer ) IRC_WriteStrServersPrefix( Client_NextHop( Origin ), Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
863 IRC_WriteStrChannelPrefix( Client, c, Origin, false, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
864 if(( Client_Conn( Client ) > NONE ) && ( Client_Type( Client ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Client, Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
865 Log( LOG_DEBUG, "User \"%s\" has been kicked of \"%s\" by \"%s\": %s.", Client_Mask( Client ), c->name, Client_ID( Origin ), Reason );
869 if( InformServer ) IRC_WriteStrServersPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
870 IRC_WriteStrChannelPrefix( Origin, c, Client, false, "PART %s :%s", c->name, Reason );
871 if(( Client_Conn( Origin ) > NONE ) && ( Client_Type( Origin ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
872 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
875 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
876 if( ! strchr( Channel_Modes( Chan ), 'P' ))
878 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
882 } /* Remove_Client */
886 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
888 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
889 } /* Get_First_Cl2Chan */
893 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
897 assert( Client != NULL || Channel != NULL );
902 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
903 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
904 cl2chan = cl2chan->next;
907 } /* Get_Next_Cl2Chan */
911 Delete_Channel( CHANNEL *Chan )
913 /* Channel-Struktur loeschen */
915 CHANNEL *chan, *last_chan;
921 if( chan == Chan ) break;
925 if( ! chan ) return false;
927 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
929 /* Invite- und Ban-Lists aufraeumen */
930 Lists_DeleteChannel( chan );
932 /* Neu verketten und freigeben */
933 if( last_chan ) last_chan->next = chan->next;
934 else My_Channels = chan->next;
938 } /* Delete_Channel */