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.47 2005/04/27 07:34:25 alex Exp $";
29 #include "conn-func.h"
36 #include "irc-write.h"
52 LOCAL CHANNEL *My_Channels;
53 LOCAL CL2CHAN *My_Cl2Chan;
56 LOCAL CL2CHAN *Get_Cl2Chan PARAMS(( CHANNEL *Chan, CLIENT *Client ));
57 LOCAL CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client ));
58 LOCAL bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer ));
59 LOCAL CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan ));
60 LOCAL CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan ));
61 LOCAL bool Delete_Channel PARAMS(( CHANNEL *Chan ));
73 Channel_InitPredefined( void )
75 /* Vordefinierte persistente Channels erzeugen */
81 for( i = 0; i < Conf_Channel_Count; i++ )
83 /* Ist ein Name konfiguriert? */
84 if( ! Conf_Channel[i].name[0] ) continue;
86 /* Gueltiger Channel-Name? */
87 if( ! Channel_IsValidName( Conf_Channel[i].name ))
89 Log( LOG_ERR, "Can't create pre-defined channel: invalid name: \"%s\"!", Conf_Channel[i].name );
93 /* Gibt es den Channel bereits? */
94 chan = Channel_Search( Conf_Channel[i].name );
97 Log( LOG_INFO, "Can't create pre-defined channel \"%s\": name already in use.", Conf_Channel[i].name );
101 /* Channel anlegen */
102 chan = Channel_Create( Conf_Channel[i].name );
105 Channel_ModeAdd( chan, 'P' );
106 Channel_SetTopic( chan, Conf_Channel[i].topic );
107 c = Conf_Channel[i].modes;
108 while( *c ) Channel_ModeAdd( chan, *c++ );
109 Log( LOG_INFO, "Created pre-defined channel \"%s\".", Conf_Channel[i].name );
111 else Log( LOG_ERR, "Can't create pre-defined channel \"%s\"!", Conf_Channel[i].name );
113 } /* Channel_InitPredefined */
120 CL2CHAN *cl2chan, *cl2chan_next;
122 /* Channel-Strukturen freigeben */
131 /* Channel-Zuordnungstabelle freigeben */
132 cl2chan = My_Cl2Chan;
135 cl2chan_next = cl2chan->next;
137 cl2chan = cl2chan_next;
143 Channel_Join( CLIENT *Client, char *Name )
147 assert( Client != NULL );
148 assert( Name != NULL );
150 /* Valider Channel-Name? */
151 if( ! Channel_IsValidName( Name ))
153 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
158 chan = Channel_Search( Name );
161 /* Ist der Client bereits Mitglied? */
162 if( Get_Cl2Chan( chan, Client )) return false;
166 /* Gibt es noch nicht? Dann neu anlegen: */
167 chan = Channel_Create( Name );
168 if( ! chan ) return false;
171 /* User dem Channel hinzufuegen */
172 if( ! Add_Client( chan, Client )) return false;
178 Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
182 assert( Client != NULL );
183 assert( Name != NULL );
184 assert( Reason != NULL );
187 chan = Channel_Search( Name );
188 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
190 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
194 /* User aus Channel entfernen */
195 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
201 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
205 assert( Client != NULL );
206 assert( Origin != NULL );
207 assert( Name != NULL );
208 assert( Reason != NULL );
211 chan = Channel_Search( Name );
214 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
218 /* Ist der User Mitglied in dem Channel? */
219 if( ! Channel_IsMemberOf( chan, Origin ))
221 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
225 /* Ist der User Channel-Operator? */
226 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
228 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
232 /* Ist der Ziel-User Mitglied im Channel? */
233 if( ! Channel_IsMemberOf( chan, Client ))
235 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
239 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
244 Channel_Quit( CLIENT *Client, char *Reason )
248 assert( Client != NULL );
249 assert( Reason != NULL );
255 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
262 Channel_Count( void )
274 } /* Channel_Count */
278 Channel_MemberCount( CHANNEL *Chan )
283 assert( Chan != NULL );
285 cl2chan = My_Cl2Chan;
288 if( cl2chan->channel == Chan ) count++;
289 cl2chan = cl2chan->next;
292 } /* Channel_MemberCount */
296 Channel_CountForUser( CLIENT *Client )
298 /* Count number of channels a user is member of. */
303 assert( Client != NULL );
305 cl2chan = My_Cl2Chan;
308 if( cl2chan->client == Client ) count++;
309 cl2chan = cl2chan->next;
313 } /* Channel_CountForUser */
317 Channel_PCount( void )
319 /* Count the number of persistent (mode 'P') channels */
327 if( strchr( chan->modes, 'P' )) count++;
332 } /* Channel_PCount */
336 Channel_Name( CHANNEL *Chan )
338 assert( Chan != NULL );
344 Channel_Modes( CHANNEL *Chan )
346 assert( Chan != NULL );
348 } /* Channel_Modes */
352 Channel_Key( CHANNEL *Chan )
354 assert( Chan != NULL );
360 Channel_MaxUsers( CHANNEL *Chan )
362 assert( Chan != NULL );
363 return Chan->maxusers;
364 } /* Channel_MaxUsers */
368 Channel_First( void )
371 } /* Channel_First */
375 Channel_Next( CHANNEL *Chan )
377 assert( Chan != NULL );
383 Channel_Search( char *Name )
385 /* Channel-Struktur suchen */
390 assert( Name != NULL );
392 search_hash = Hash( Name );
396 if( search_hash == c->hash )
398 /* lt. Hash-Wert: Treffer! */
399 if( strcasecmp( Name, c->name ) == 0 ) return c;
404 } /* Channel_Search */
408 Channel_FirstMember( CHANNEL *Chan )
410 assert( Chan != NULL );
411 return Get_First_Cl2Chan( NULL, Chan );
412 } /* Channel_FirstMember */
416 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
418 assert( Chan != NULL );
419 assert( Cl2Chan != NULL );
420 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
421 } /* Channel_NextMember */
425 Channel_FirstChannelOf( CLIENT *Client )
427 assert( Client != NULL );
428 return Get_First_Cl2Chan( Client, NULL );
429 } /* Channel_FirstChannelOf */
433 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
435 assert( Client != NULL );
436 assert( Cl2Chan != NULL );
437 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
438 } /* Channel_NextChannelOf */
442 Channel_GetClient( CL2CHAN *Cl2Chan )
444 assert( Cl2Chan != NULL );
445 return Cl2Chan->client;
446 } /* Channel_GetClient */
450 Channel_GetChannel( CL2CHAN *Cl2Chan )
452 assert( Cl2Chan != NULL );
453 return Cl2Chan->channel;
454 } /* Channel_GetChannel */
458 Channel_IsValidName( char *Name )
460 /* Pruefen, ob Name als Channelname gueltig */
462 char *ptr, badchars[10];
464 assert( Name != NULL );
466 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
469 strcpy( badchars, " ,:\007" );
472 if( strchr( badchars, *ptr )) return false;
477 } /* Channel_IsValidName */
481 Channel_ModeAdd( CHANNEL *Chan, char Mode )
484 * If the channel already had this mode, return false.
485 * If the channel mode was newly set return true.
490 assert( Chan != NULL );
492 x[0] = Mode; x[1] = '\0';
493 if( ! strchr( Chan->modes, x[0] ))
495 /* Channel does not have this mode yet, set it */
496 strlcat( Chan->modes, x, sizeof( Chan->modes ));
500 } /* Channel_ModeAdd */
504 Channel_ModeDel( CHANNEL *Chan, char Mode )
507 * if the mode was removed return true.
508 * if the channel did not have the mode, return false.
512 assert( Chan != NULL );
514 x[0] = Mode; x[1] = '\0';
516 p = strchr( Chan->modes, x[0] );
517 if( ! p ) return false;
519 /* Channel has mode -> delete */
526 } /* Channel_ModeDel */
530 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
532 /* Set Channel-User-Mode.
533 * if mode was newly set, return true.
534 * if the User already had this channel-mode, return false.
540 assert( Chan != NULL );
541 assert( Client != NULL );
543 cl2chan = Get_Cl2Chan( Chan, Client );
544 assert( cl2chan != NULL );
546 x[0] = Mode; x[1] = '\0';
547 if( ! strchr( cl2chan->modes, x[0] ))
549 /* mode not set, -> set it */
550 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
554 } /* Channel_UserModeAdd */
558 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
560 /* Delete Channel-User-Mode.
561 * If Mode was removed, return true.
562 * If User did not have the Channel-Mode, return false.
568 assert( Chan != NULL );
569 assert( Client != NULL );
571 cl2chan = Get_Cl2Chan( Chan, Client );
572 assert( cl2chan != NULL );
574 x[0] = Mode; x[1] = '\0';
576 p = strchr( cl2chan->modes, x[0] );
577 if( ! p ) return false;
579 /* Client has Mode -> delete */
586 } /* Channel_UserModeDel */
590 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
592 /* return Users' Channel-Modes */
596 assert( Chan != NULL );
597 assert( Client != NULL );
599 cl2chan = Get_Cl2Chan( Chan, Client );
600 assert( cl2chan != NULL );
602 return cl2chan->modes;
603 } /* Channel_UserModes */
607 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
609 /* Test if Client is on Channel Chan */
611 assert( Chan != NULL );
612 assert( Client != NULL );
614 if( Get_Cl2Chan( Chan, Client )) return true;
616 } /* Channel_IsMemberOf */
620 Channel_Topic( CHANNEL *Chan )
622 assert( Chan != NULL );
624 } /* Channel_Topic */
628 Channel_SetTopic( CHANNEL *Chan, char *Topic )
630 assert( Chan != NULL );
631 assert( Topic != NULL );
633 strlcpy( Chan->topic, Topic, sizeof( Chan->topic ));
634 } /* Channel_SetTopic */
638 Channel_SetModes( CHANNEL *Chan, char *Modes )
640 assert( Chan != NULL );
641 assert( Modes != NULL );
643 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
644 } /* Channel_SetModes */
648 Channel_SetKey( CHANNEL *Chan, char *Key )
650 assert( Chan != NULL );
651 assert( Key != NULL );
653 strlcpy( Chan->key, Key, sizeof( Chan->key ));
654 Log( LOG_DEBUG, "Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
655 } /* Channel_SetKey */
659 Channel_SetMaxUsers( CHANNEL *Chan, long Count )
661 assert( Chan != NULL );
663 Chan->maxusers = Count;
664 Log( LOG_DEBUG, "Channel %s: Member limit is now %ld.", Chan->name, Chan->maxusers );
665 } /* Channel_SetMaxUsers */
669 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
671 bool is_member, has_voice, is_op, ok;
673 /* Okay, target is a channel */
674 is_member = has_voice = is_op = false;
675 if( Channel_IsMemberOf( Chan, From ))
678 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
679 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
682 /* Is the client allowed to write to channel? */
684 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
685 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
687 /* Is the client banned? */
688 if( Lists_CheckBanned( From, Chan ))
690 /* Client is banned, bus is he channel operator or has voice? */
691 if(( ! has_voice ) && ( ! is_op )) ok = false;
694 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
697 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
698 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
699 } /* Channel_Write */
703 Channel_Create( char *Name )
705 /* Create new CHANNEL structure and add it to linked list */
708 assert( Name != NULL );
710 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
713 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
716 memset( c, 0, sizeof( CHANNEL ));
717 strlcpy( c->name, Name, sizeof( c->name ));
718 c->hash = Hash( c->name );
719 c->next = My_Channels;
722 Log( LOG_DEBUG, "Created new channel structure for \"%s\".", Name );
725 } /* Channel_Create */
729 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
733 assert( Chan != NULL );
734 assert( Client != NULL );
736 cl2chan = My_Cl2Chan;
739 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
740 cl2chan = cl2chan->next;
747 Add_Client( CHANNEL *Chan, CLIENT *Client )
751 assert( Chan != NULL );
752 assert( Client != NULL );
754 /* neue CL2CHAN-Struktur anlegen */
755 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
758 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
761 cl2chan->channel = Chan;
762 cl2chan->client = Client;
763 strcpy( cl2chan->modes, "" );
766 cl2chan->next = My_Cl2Chan;
767 My_Cl2Chan = cl2chan;
769 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
776 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
778 CL2CHAN *cl2chan, *last_cl2chan;
781 assert( Chan != NULL );
782 assert( Client != NULL );
783 assert( Origin != NULL );
784 assert( Reason != NULL );
787 cl2chan = My_Cl2Chan;
790 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
791 last_cl2chan = cl2chan;
792 cl2chan = cl2chan->next;
794 if( ! cl2chan ) return false;
796 c = cl2chan->channel;
799 /* Aus Verkettung loesen und freigeben */
800 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
801 else My_Cl2Chan = cl2chan->next;
807 /* QUIT: andere Server wurden bereits informiert, vgl. Client_Destroy();
808 * hier also "nur" noch alle User in betroffenen Channeln infomieren */
809 assert( InformServer == false );
810 IRC_WriteStrChannelPrefix( Origin, c, Origin, false, "QUIT :%s", Reason );
811 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
814 /* User wurde geKICKed: ggf. andere Server sowie alle betroffenen User
815 * im entsprechenden Channel informieren */
816 if( InformServer ) IRC_WriteStrServersPrefix( Client_NextHop( Origin ), Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
817 IRC_WriteStrChannelPrefix( Client, c, Origin, false, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
818 if(( Client_Conn( Client ) > NONE ) && ( Client_Type( Client ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Client, Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
819 Log( LOG_DEBUG, "User \"%s\" has been kicked of \"%s\" by \"%s\": %s.", Client_Mask( Client ), c->name, Client_ID( Origin ), Reason );
823 if( InformServer ) IRC_WriteStrServersPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
824 IRC_WriteStrChannelPrefix( Origin, c, Client, false, "PART %s :%s", c->name, Reason );
825 if(( Client_Conn( Origin ) > NONE ) && ( Client_Type( Origin ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
826 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
829 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
830 if( ! strchr( Channel_Modes( Chan ), 'P' ))
832 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
836 } /* Remove_Client */
840 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
842 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
843 } /* Get_First_Cl2Chan */
847 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
851 assert( Client != NULL || Channel != NULL );
856 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
857 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
858 cl2chan = cl2chan->next;
861 } /* Get_Next_Cl2Chan */
865 Delete_Channel( CHANNEL *Chan )
867 /* Channel-Struktur loeschen */
869 CHANNEL *chan, *last_chan;
875 if( chan == Chan ) break;
879 if( ! chan ) return false;
881 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
883 /* Invite- und Ban-Lists aufraeumen */
884 Lists_DeleteChannel( chan );
886 /* Neu verketten und freigeben */
887 if( last_chan ) last_chan->next = chan->next;
888 else My_Channels = chan->next;
892 } /* Delete_Channel */