2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001,2002 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.46 2005/03/19 18:43:48 fw Exp $";
28 #include "conn-func.h"
35 #include "irc-write.h"
51 LOCAL CHANNEL *My_Channels;
52 LOCAL CL2CHAN *My_Cl2Chan;
55 LOCAL CL2CHAN *Get_Cl2Chan PARAMS(( CHANNEL *Chan, CLIENT *Client ));
56 LOCAL CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client ));
57 LOCAL bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer ));
58 LOCAL CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan ));
59 LOCAL CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan ));
60 LOCAL bool Delete_Channel PARAMS(( CHANNEL *Chan ));
72 Channel_InitPredefined( void )
74 /* Vordefinierte persistente Channels erzeugen */
80 for( i = 0; i < Conf_Channel_Count; i++ )
82 /* Ist ein Name konfiguriert? */
83 if( ! Conf_Channel[i].name[0] ) continue;
85 /* Gueltiger Channel-Name? */
86 if( ! Channel_IsValidName( Conf_Channel[i].name ))
88 Log( LOG_ERR, "Can't create pre-defined channel: invalid name: \"%s\"!", Conf_Channel[i].name );
92 /* Gibt es den Channel bereits? */
93 chan = Channel_Search( Conf_Channel[i].name );
96 Log( LOG_INFO, "Can't create pre-defined channel \"%s\": name already in use.", Conf_Channel[i].name );
100 /* Channel anlegen */
101 chan = Channel_Create( Conf_Channel[i].name );
104 Channel_ModeAdd( chan, 'P' );
105 Channel_SetTopic( chan, Conf_Channel[i].topic );
106 c = Conf_Channel[i].modes;
107 while( *c ) Channel_ModeAdd( chan, *c++ );
108 Log( LOG_INFO, "Created pre-defined channel \"%s\".", Conf_Channel[i].name );
110 else Log( LOG_ERR, "Can't create pre-defined channel \"%s\"!", Conf_Channel[i].name );
112 } /* Channel_InitPredefined */
119 CL2CHAN *cl2chan, *cl2chan_next;
121 /* Channel-Strukturen freigeben */
130 /* Channel-Zuordnungstabelle freigeben */
131 cl2chan = My_Cl2Chan;
134 cl2chan_next = cl2chan->next;
136 cl2chan = cl2chan_next;
142 Channel_Join( CLIENT *Client, char *Name )
146 assert( Client != NULL );
147 assert( Name != NULL );
149 /* Valider Channel-Name? */
150 if( ! Channel_IsValidName( Name ))
152 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
157 chan = Channel_Search( Name );
160 /* Ist der Client bereits Mitglied? */
161 if( Get_Cl2Chan( chan, Client )) return false;
165 /* Gibt es noch nicht? Dann neu anlegen: */
166 chan = Channel_Create( Name );
167 if( ! chan ) return false;
170 /* User dem Channel hinzufuegen */
171 if( ! Add_Client( chan, Client )) return false;
177 Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
181 assert( Client != NULL );
182 assert( Name != NULL );
183 assert( Reason != NULL );
186 chan = Channel_Search( Name );
187 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
189 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
193 /* User aus Channel entfernen */
194 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
200 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
204 assert( Client != NULL );
205 assert( Origin != NULL );
206 assert( Name != NULL );
207 assert( Reason != NULL );
210 chan = Channel_Search( Name );
213 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
217 /* Ist der User Mitglied in dem Channel? */
218 if( ! Channel_IsMemberOf( chan, Origin ))
220 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
224 /* Ist der User Channel-Operator? */
225 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
227 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
231 /* Ist der Ziel-User Mitglied im Channel? */
232 if( ! Channel_IsMemberOf( chan, Client ))
234 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
238 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
243 Channel_Quit( CLIENT *Client, char *Reason )
247 assert( Client != NULL );
248 assert( Reason != NULL );
254 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
261 Channel_Count( void )
273 } /* Channel_Count */
277 Channel_MemberCount( CHANNEL *Chan )
282 assert( Chan != NULL );
284 cl2chan = My_Cl2Chan;
287 if( cl2chan->channel == Chan ) count++;
288 cl2chan = cl2chan->next;
291 } /* Channel_MemberCount */
295 Channel_CountForUser( CLIENT *Client )
297 /* Count number of channels a user is member of. */
302 assert( Client != NULL );
304 cl2chan = My_Cl2Chan;
307 if( cl2chan->client == Client ) count++;
308 cl2chan = cl2chan->next;
312 } /* Channel_CountForUser */
316 Channel_PCount( void )
318 /* Count the number of persistent (mode 'P') channels */
326 if( strchr( chan->modes, 'P' )) count++;
331 } /* Channel_PCount */
335 Channel_Name( CHANNEL *Chan )
337 assert( Chan != NULL );
343 Channel_Modes( CHANNEL *Chan )
345 assert( Chan != NULL );
347 } /* Channel_Modes */
351 Channel_Key( CHANNEL *Chan )
353 assert( Chan != NULL );
359 Channel_MaxUsers( CHANNEL *Chan )
361 assert( Chan != NULL );
362 return Chan->maxusers;
363 } /* Channel_MaxUsers */
367 Channel_First( void )
370 } /* Channel_First */
374 Channel_Next( CHANNEL *Chan )
376 assert( Chan != NULL );
382 Channel_Search( char *Name )
384 /* Channel-Struktur suchen */
389 assert( Name != NULL );
391 search_hash = Hash( Name );
395 if( search_hash == c->hash )
397 /* lt. Hash-Wert: Treffer! */
398 if( strcasecmp( Name, c->name ) == 0 ) return c;
403 } /* Channel_Search */
407 Channel_FirstMember( CHANNEL *Chan )
409 assert( Chan != NULL );
410 return Get_First_Cl2Chan( NULL, Chan );
411 } /* Channel_FirstMember */
415 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
417 assert( Chan != NULL );
418 assert( Cl2Chan != NULL );
419 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
420 } /* Channel_NextMember */
424 Channel_FirstChannelOf( CLIENT *Client )
426 assert( Client != NULL );
427 return Get_First_Cl2Chan( Client, NULL );
428 } /* Channel_FirstChannelOf */
432 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
434 assert( Client != NULL );
435 assert( Cl2Chan != NULL );
436 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
437 } /* Channel_NextChannelOf */
441 Channel_GetClient( CL2CHAN *Cl2Chan )
443 assert( Cl2Chan != NULL );
444 return Cl2Chan->client;
445 } /* Channel_GetClient */
449 Channel_GetChannel( CL2CHAN *Cl2Chan )
451 assert( Cl2Chan != NULL );
452 return Cl2Chan->channel;
453 } /* Channel_GetChannel */
457 Channel_IsValidName( char *Name )
459 /* Pruefen, ob Name als Channelname gueltig */
461 char *ptr, badchars[10];
463 assert( Name != NULL );
465 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
468 strcpy( badchars, " ,:\007" );
471 if( strchr( badchars, *ptr )) return false;
476 } /* Channel_IsValidName */
480 Channel_ModeAdd( CHANNEL *Chan, char Mode )
483 * If the channel already had this mode, return false.
484 * If the channel mode was newly set return true.
489 assert( Chan != NULL );
491 x[0] = Mode; x[1] = '\0';
492 if( ! strchr( Chan->modes, x[0] ))
494 /* Channel does not have this mode yet, set it */
495 strlcat( Chan->modes, x, sizeof( Chan->modes ));
499 } /* Channel_ModeAdd */
503 Channel_ModeDel( CHANNEL *Chan, char Mode )
506 * if the mode was removed return true.
507 * if the channel did not have the mode, return false.
511 assert( Chan != NULL );
513 x[0] = Mode; x[1] = '\0';
515 p = strchr( Chan->modes, x[0] );
516 if( ! p ) return false;
518 /* Channel has mode -> delete */
525 } /* Channel_ModeDel */
529 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
531 /* Set Channel-User-Mode.
532 * if mode was newly set, return true.
533 * if the User already had this channel-mode, return false.
539 assert( Chan != NULL );
540 assert( Client != NULL );
542 cl2chan = Get_Cl2Chan( Chan, Client );
543 assert( cl2chan != NULL );
545 x[0] = Mode; x[1] = '\0';
546 if( ! strchr( cl2chan->modes, x[0] ))
548 /* mode not set, -> set it */
549 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
553 } /* Channel_UserModeAdd */
557 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
559 /* Delete Channel-User-Mode.
560 * If Mode was removed, return true.
561 * If User did not have the Channel-Mode, return false.
567 assert( Chan != NULL );
568 assert( Client != NULL );
570 cl2chan = Get_Cl2Chan( Chan, Client );
571 assert( cl2chan != NULL );
573 x[0] = Mode; x[1] = '\0';
575 p = strchr( cl2chan->modes, x[0] );
576 if( ! p ) return false;
578 /* Client has Mode -> delete */
585 } /* Channel_UserModeDel */
589 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
591 /* return Users' Channel-Modes */
595 assert( Chan != NULL );
596 assert( Client != NULL );
598 cl2chan = Get_Cl2Chan( Chan, Client );
599 assert( cl2chan != NULL );
601 return cl2chan->modes;
602 } /* Channel_UserModes */
606 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
608 /* Test if Client is on Channel Chan */
610 assert( Chan != NULL );
611 assert( Client != NULL );
613 if( Get_Cl2Chan( Chan, Client )) return true;
615 } /* Channel_IsMemberOf */
619 Channel_Topic( CHANNEL *Chan )
621 assert( Chan != NULL );
623 } /* Channel_Topic */
627 Channel_SetTopic( CHANNEL *Chan, char *Topic )
629 assert( Chan != NULL );
630 assert( Topic != NULL );
632 strlcpy( Chan->topic, Topic, sizeof( Chan->topic ));
633 } /* Channel_SetTopic */
637 Channel_SetModes( CHANNEL *Chan, char *Modes )
639 assert( Chan != NULL );
640 assert( Modes != NULL );
642 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
643 } /* Channel_SetModes */
647 Channel_SetKey( CHANNEL *Chan, char *Key )
649 assert( Chan != NULL );
650 assert( Key != NULL );
652 strlcpy( Chan->key, Key, sizeof( Chan->key ));
653 Log( LOG_DEBUG, "Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
654 } /* Channel_SetKey */
658 Channel_SetMaxUsers( CHANNEL *Chan, long Count )
660 assert( Chan != NULL );
662 Chan->maxusers = Count;
663 Log( LOG_DEBUG, "Channel %s: Member limit is now %ld.", Chan->name, Chan->maxusers );
664 } /* Channel_SetMaxUsers */
668 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
670 bool is_member, has_voice, is_op, ok;
672 /* Okay, target is a channel */
673 is_member = has_voice = is_op = false;
674 if( Channel_IsMemberOf( Chan, From ))
677 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
678 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
681 /* Is the client allowed to write to channel? */
683 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
684 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
686 /* Is the client banned? */
687 if( Lists_CheckBanned( From, Chan ))
689 /* Client is banned, bus is he channel operator or has voice? */
690 if(( ! has_voice ) && ( ! is_op )) ok = false;
693 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
696 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
697 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
698 } /* Channel_Write */
702 Channel_Create( char *Name )
704 /* Create new CHANNEL structure and add it to linked list */
707 assert( Name != NULL );
709 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
712 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
715 memset( c, 0, sizeof( CHANNEL ));
716 strlcpy( c->name, Name, sizeof( c->name ));
717 c->hash = Hash( c->name );
718 c->next = My_Channels;
721 Log( LOG_DEBUG, "Created new channel structure for \"%s\".", Name );
724 } /* Channel_Create */
728 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
732 assert( Chan != NULL );
733 assert( Client != NULL );
735 cl2chan = My_Cl2Chan;
738 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
739 cl2chan = cl2chan->next;
746 Add_Client( CHANNEL *Chan, CLIENT *Client )
750 assert( Chan != NULL );
751 assert( Client != NULL );
753 /* neue CL2CHAN-Struktur anlegen */
754 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
757 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
760 cl2chan->channel = Chan;
761 cl2chan->client = Client;
762 strcpy( cl2chan->modes, "" );
765 cl2chan->next = My_Cl2Chan;
766 My_Cl2Chan = cl2chan;
768 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
775 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
777 CL2CHAN *cl2chan, *last_cl2chan;
780 assert( Chan != NULL );
781 assert( Client != NULL );
782 assert( Origin != NULL );
783 assert( Reason != NULL );
786 cl2chan = My_Cl2Chan;
789 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
790 last_cl2chan = cl2chan;
791 cl2chan = cl2chan->next;
793 if( ! cl2chan ) return false;
795 c = cl2chan->channel;
798 /* Aus Verkettung loesen und freigeben */
799 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
800 else My_Cl2Chan = cl2chan->next;
806 /* QUIT: andere Server wurden bereits informiert, vgl. Client_Destroy();
807 * hier also "nur" noch alle User in betroffenen Channeln infomieren */
808 assert( InformServer == false );
809 IRC_WriteStrChannelPrefix( Origin, c, Origin, false, "QUIT :%s", Reason );
810 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
813 /* User wurde geKICKed: ggf. andere Server sowie alle betroffenen User
814 * im entsprechenden Channel informieren */
815 if( InformServer ) IRC_WriteStrServersPrefix( Client_NextHop( Origin ), Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
816 IRC_WriteStrChannelPrefix( Client, c, Origin, false, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
817 if(( Client_Conn( Client ) > NONE ) && ( Client_Type( Client ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Client, Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
818 Log( LOG_DEBUG, "User \"%s\" has been kicked of \"%s\" by \"%s\": %s.", Client_Mask( Client ), c->name, Client_ID( Origin ), Reason );
822 if( InformServer ) IRC_WriteStrServersPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
823 IRC_WriteStrChannelPrefix( Origin, c, Client, false, "PART %s :%s", c->name, Reason );
824 if(( Client_Conn( Origin ) > NONE ) && ( Client_Type( Origin ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
825 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
828 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
829 if( ! strchr( Channel_Modes( Chan ), 'P' ))
831 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
835 } /* Remove_Client */
839 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
841 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
842 } /* Get_First_Cl2Chan */
846 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
850 assert( Client != NULL || Channel != NULL );
855 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
856 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
857 cl2chan = cl2chan->next;
860 } /* Get_Next_Cl2Chan */
864 Delete_Channel( CHANNEL *Chan )
866 /* Channel-Struktur loeschen */
868 CHANNEL *chan, *last_chan;
874 if( chan == Chan ) break;
878 if( ! chan ) return false;
880 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
882 /* Invite- und Ban-Lists aufraeumen */
883 Lists_DeleteChannel( chan );
885 /* Neu verketten und freigeben */
886 if( last_chan ) last_chan->next = chan->next;
887 else My_Channels = chan->next;
891 } /* Delete_Channel */