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.54 2005/09/02 12:50:25 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 Channel_SetTopic(chan, NULL,
110 array_start(&Conf_Channel[i].topic));
111 array_free(&Conf_Channel[i].topic);
113 c = Conf_Channel[i].modes;
115 Channel_ModeAdd(chan, *c++);
117 Log(LOG_INFO, "Created pre-defined channel \"%s\".",
118 Conf_Channel[i].name );
120 else Log(LOG_ERR, "Can't create pre-defined channel \"%s\"!",
121 Conf_Channel[i].name );
123 } /* Channel_InitPredefined */
130 CL2CHAN *cl2chan, *cl2chan_next;
132 /* Channel-Strukturen freigeben */
137 array_free(&c->topic);
142 /* Channel-Zuordnungstabelle freigeben */
143 cl2chan = My_Cl2Chan;
146 cl2chan_next = cl2chan->next;
148 cl2chan = cl2chan_next;
154 Channel_Join( CLIENT *Client, char *Name )
158 assert( Client != NULL );
159 assert( Name != NULL );
161 /* Valider Channel-Name? */
162 if( ! Channel_IsValidName( Name ))
164 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
169 chan = Channel_Search( Name );
172 /* Ist der Client bereits Mitglied? */
173 if( Get_Cl2Chan( chan, Client )) return false;
177 /* Gibt es noch nicht? Dann neu anlegen: */
178 chan = Channel_Create( Name );
179 if( ! chan ) return false;
182 /* User dem Channel hinzufuegen */
183 if( ! Add_Client( chan, Client )) return false;
189 Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
193 assert( Client != NULL );
194 assert( Name != NULL );
195 assert( Reason != NULL );
198 chan = Channel_Search( Name );
199 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
201 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
205 /* User aus Channel entfernen */
206 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
212 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
216 assert( Client != NULL );
217 assert( Origin != NULL );
218 assert( Name != NULL );
219 assert( Reason != NULL );
222 chan = Channel_Search( Name );
225 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
229 /* Ist der User Mitglied in dem Channel? */
230 if( ! Channel_IsMemberOf( chan, Origin ))
232 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
236 /* Ist der User Channel-Operator? */
237 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
239 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
243 /* Ist der Ziel-User Mitglied im Channel? */
244 if( ! Channel_IsMemberOf( chan, Client ))
246 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
250 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
255 Channel_Quit( CLIENT *Client, char *Reason )
259 assert( Client != NULL );
260 assert( Reason != NULL );
262 IRC_WriteStrRelatedPrefix( Client, Client, false, "QUIT :%s", Reason );
268 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
275 Channel_Count( void )
287 } /* Channel_Count */
291 Channel_MemberCount( CHANNEL *Chan )
296 assert( Chan != NULL );
298 cl2chan = My_Cl2Chan;
301 if( cl2chan->channel == Chan ) count++;
302 cl2chan = cl2chan->next;
305 } /* Channel_MemberCount */
309 Channel_CountForUser( CLIENT *Client )
311 /* Count number of channels a user is member of. */
316 assert( Client != NULL );
318 cl2chan = My_Cl2Chan;
321 if( cl2chan->client == Client ) count++;
322 cl2chan = cl2chan->next;
326 } /* Channel_CountForUser */
330 Channel_PCount( void )
332 /* Count the number of persistent (mode 'P') channels */
340 if( strchr( chan->modes, 'P' )) count++;
345 } /* Channel_PCount */
349 Channel_Name( CHANNEL *Chan )
351 assert( Chan != NULL );
357 Channel_Modes( CHANNEL *Chan )
359 assert( Chan != NULL );
361 } /* Channel_Modes */
365 Channel_Key( CHANNEL *Chan )
367 assert( Chan != NULL );
373 Channel_MaxUsers( CHANNEL *Chan )
375 assert( Chan != NULL );
376 return Chan->maxusers;
377 } /* Channel_MaxUsers */
381 Channel_First( void )
384 } /* Channel_First */
388 Channel_Next( CHANNEL *Chan )
390 assert( Chan != NULL );
396 Channel_Search( char *Name )
398 /* Channel-Struktur suchen */
403 assert( Name != NULL );
405 search_hash = Hash( Name );
409 if( search_hash == c->hash )
411 /* lt. Hash-Wert: Treffer! */
412 if( strcasecmp( Name, c->name ) == 0 ) return c;
417 } /* Channel_Search */
421 Channel_FirstMember( CHANNEL *Chan )
423 assert( Chan != NULL );
424 return Get_First_Cl2Chan( NULL, Chan );
425 } /* Channel_FirstMember */
429 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
431 assert( Chan != NULL );
432 assert( Cl2Chan != NULL );
433 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
434 } /* Channel_NextMember */
438 Channel_FirstChannelOf( CLIENT *Client )
440 assert( Client != NULL );
441 return Get_First_Cl2Chan( Client, NULL );
442 } /* Channel_FirstChannelOf */
446 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
448 assert( Client != NULL );
449 assert( Cl2Chan != NULL );
450 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
451 } /* Channel_NextChannelOf */
455 Channel_GetClient( CL2CHAN *Cl2Chan )
457 assert( Cl2Chan != NULL );
458 return Cl2Chan->client;
459 } /* Channel_GetClient */
463 Channel_GetChannel( CL2CHAN *Cl2Chan )
465 assert( Cl2Chan != NULL );
466 return Cl2Chan->channel;
467 } /* Channel_GetChannel */
471 Channel_IsValidName( char *Name )
473 /* Pruefen, ob Name als Channelname gueltig */
475 char *ptr, badchars[10];
477 assert( Name != NULL );
479 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
482 strcpy( badchars, " ,:\007" );
485 if( strchr( badchars, *ptr )) return false;
490 } /* Channel_IsValidName */
494 Channel_ModeAdd( CHANNEL *Chan, char Mode )
497 * If the channel already had this mode, return false.
498 * If the channel mode was newly set return true.
503 assert( Chan != NULL );
505 x[0] = Mode; x[1] = '\0';
506 if( ! strchr( Chan->modes, x[0] ))
508 /* Channel does not have this mode yet, set it */
509 strlcat( Chan->modes, x, sizeof( Chan->modes ));
513 } /* Channel_ModeAdd */
517 Channel_ModeDel( CHANNEL *Chan, char Mode )
520 * if the mode was removed return true.
521 * if the channel did not have the mode, return false.
525 assert( Chan != NULL );
527 x[0] = Mode; x[1] = '\0';
529 p = strchr( Chan->modes, x[0] );
530 if( ! p ) return false;
532 /* Channel has mode -> delete */
539 } /* Channel_ModeDel */
543 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
545 /* Set Channel-User-Mode.
546 * if mode was newly set, return true.
547 * if the User already had this channel-mode, return false.
553 assert( Chan != NULL );
554 assert( Client != NULL );
556 cl2chan = Get_Cl2Chan( Chan, Client );
557 assert( cl2chan != NULL );
559 x[0] = Mode; x[1] = '\0';
560 if( ! strchr( cl2chan->modes, x[0] ))
562 /* mode not set, -> set it */
563 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
567 } /* Channel_UserModeAdd */
571 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
573 /* Delete Channel-User-Mode.
574 * If Mode was removed, return true.
575 * If User did not have the Channel-Mode, return false.
581 assert( Chan != NULL );
582 assert( Client != NULL );
584 cl2chan = Get_Cl2Chan( Chan, Client );
585 assert( cl2chan != NULL );
587 x[0] = Mode; x[1] = '\0';
589 p = strchr( cl2chan->modes, x[0] );
590 if( ! p ) return false;
592 /* Client has Mode -> delete */
599 } /* Channel_UserModeDel */
603 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
605 /* return Users' Channel-Modes */
609 assert( Chan != NULL );
610 assert( Client != NULL );
612 cl2chan = Get_Cl2Chan( Chan, Client );
613 assert( cl2chan != NULL );
615 return cl2chan->modes;
616 } /* Channel_UserModes */
620 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
622 /* Test if Client is on Channel Chan */
624 assert( Chan != NULL );
625 assert( Client != NULL );
627 if( Get_Cl2Chan( Chan, Client )) return true;
629 } /* Channel_IsMemberOf */
633 Channel_Topic( CHANNEL *Chan )
636 assert( Chan != NULL );
637 ret = array_start(&Chan->topic);
638 return ret ? ret : "";
639 } /* Channel_Topic */
645 Channel_TopicTime(CHANNEL *Chan)
647 assert(Chan != NULL);
648 return (unsigned int) Chan->topic_time;
649 } /* Channel_TopicTime */
653 Channel_TopicWho(CHANNEL *Chan)
655 assert(Chan != NULL);
656 return Chan->topic_who;
657 } /* Channel_TopicWho */
663 Channel_SetTopic(CHANNEL *Chan, CLIENT *Client, char *Topic)
666 assert( Chan != NULL );
667 assert( Topic != NULL );
670 if (len < array_bytes(&Chan->topic))
671 array_free(&Chan->topic);
673 if (!array_copyb(&Chan->topic, Topic, len))
674 Log(LOG_WARNING, "could not set new Topic \"%s\" on %s: %s",
675 Topic, Chan->name, strerror(errno));
677 array_cat0(&Chan->topic);
680 Chan->topic_time = time(NULL);
681 if (Client != NULL && Client_Type(Client) != CLIENT_SERVER)
682 strlcpy(Chan->topic_who, Client_ID(Client),
683 sizeof Chan->topic_who);
685 strlcpy(Chan->topic_who, DEFAULT_TOPIC_ID,
686 sizeof Chan->topic_who);
690 } /* Channel_SetTopic */
694 Channel_SetModes( CHANNEL *Chan, char *Modes )
696 assert( Chan != NULL );
697 assert( Modes != NULL );
699 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
700 } /* Channel_SetModes */
704 Channel_SetKey( CHANNEL *Chan, char *Key )
706 assert( Chan != NULL );
707 assert( Key != NULL );
709 strlcpy( Chan->key, Key, sizeof( Chan->key ));
710 Log( LOG_DEBUG, "Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
711 } /* Channel_SetKey */
715 Channel_SetMaxUsers( CHANNEL *Chan, long Count )
717 assert( Chan != NULL );
719 Chan->maxusers = Count;
720 Log( LOG_DEBUG, "Channel %s: Member limit is now %ld.", Chan->name, Chan->maxusers );
721 } /* Channel_SetMaxUsers */
725 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
727 bool is_member, has_voice, is_op, ok;
729 /* Okay, target is a channel */
730 is_member = has_voice = is_op = false;
731 if( Channel_IsMemberOf( Chan, From ))
734 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
735 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
738 /* Is the client allowed to write to channel? */
740 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
741 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
743 /* Is the client banned? */
744 if( Lists_CheckBanned( From, Chan ))
746 /* Client is banned, bus is he channel operator or has voice? */
747 if(( ! has_voice ) && ( ! is_op )) ok = false;
750 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
753 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
754 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
755 } /* Channel_Write */
759 Channel_Create( char *Name )
761 /* Create new CHANNEL structure and add it to linked list */
764 assert( Name != NULL );
766 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
769 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
772 memset( c, 0, sizeof( CHANNEL ));
773 strlcpy( c->name, Name, sizeof( c->name ));
774 c->hash = Hash( c->name );
775 c->next = My_Channels;
778 Log( LOG_DEBUG, "Created new channel structure for \"%s\".", Name );
781 } /* Channel_Create */
785 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
789 assert( Chan != NULL );
790 assert( Client != NULL );
792 cl2chan = My_Cl2Chan;
795 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
796 cl2chan = cl2chan->next;
803 Add_Client( CHANNEL *Chan, CLIENT *Client )
807 assert( Chan != NULL );
808 assert( Client != NULL );
810 /* neue CL2CHAN-Struktur anlegen */
811 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
814 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
817 cl2chan->channel = Chan;
818 cl2chan->client = Client;
819 strcpy( cl2chan->modes, "" );
822 cl2chan->next = My_Cl2Chan;
823 My_Cl2Chan = cl2chan;
825 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
832 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
834 CL2CHAN *cl2chan, *last_cl2chan;
837 assert( Chan != NULL );
838 assert( Client != NULL );
839 assert( Origin != NULL );
840 assert( Reason != NULL );
843 cl2chan = My_Cl2Chan;
846 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
847 last_cl2chan = cl2chan;
848 cl2chan = cl2chan->next;
850 if( ! cl2chan ) return false;
852 c = cl2chan->channel;
855 /* Aus Verkettung loesen und freigeben */
856 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
857 else My_Cl2Chan = cl2chan->next;
863 /* QUIT: andere Server wurden bereits informiert, vgl. Client_Destroy();
864 * hier also "nur" noch alle User in betroffenen Channeln infomieren */
865 assert( InformServer == false );
866 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
869 /* User wurde geKICKed: ggf. andere Server sowie alle betroffenen User
870 * im entsprechenden Channel informieren */
871 if( InformServer ) IRC_WriteStrServersPrefix( Client_NextHop( Origin ), Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
872 IRC_WriteStrChannelPrefix( Client, c, Origin, false, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
873 if(( Client_Conn( Client ) > NONE ) && ( Client_Type( Client ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Client, Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
874 Log( LOG_DEBUG, "User \"%s\" has been kicked of \"%s\" by \"%s\": %s.", Client_Mask( Client ), c->name, Client_ID( Origin ), Reason );
878 if( InformServer ) IRC_WriteStrServersPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
879 IRC_WriteStrChannelPrefix( Origin, c, Client, false, "PART %s :%s", c->name, Reason );
880 if(( Client_Conn( Origin ) > NONE ) && ( Client_Type( Origin ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
881 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
884 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
885 if( ! strchr( Channel_Modes( Chan ), 'P' ))
887 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
891 } /* Remove_Client */
895 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
897 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
898 } /* Get_First_Cl2Chan */
902 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
906 assert( Client != NULL || Channel != NULL );
911 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
912 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
913 cl2chan = cl2chan->next;
916 } /* Get_Next_Cl2Chan */
920 Delete_Channel( CHANNEL *Chan )
922 /* Channel-Struktur loeschen */
924 CHANNEL *chan, *last_chan;
930 if( chan == Chan ) break;
934 if( ! chan ) return false;
936 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
938 /* Invite- und Ban-Lists aufraeumen */
939 Lists_DeleteChannel( chan );
941 /* Neu verketten und freigeben */
942 if( last_chan ) last_chan->next = chan->next;
943 else My_Channels = chan->next;
947 } /* Delete_Channel */