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.52 2005/07/28 16:23:55 fw Exp $";
30 #include "conn-func.h"
37 #include "irc-write.h"
53 LOCAL CHANNEL *My_Channels;
54 LOCAL CL2CHAN *My_Cl2Chan;
57 LOCAL CL2CHAN *Get_Cl2Chan PARAMS(( CHANNEL *Chan, CLIENT *Client ));
58 LOCAL CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client ));
59 LOCAL bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer ));
60 LOCAL CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan ));
61 LOCAL CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan ));
62 LOCAL 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);
104 /* Channel anlegen */
105 chan = Channel_Create( Conf_Channel[i].name );
108 Channel_ModeAdd( chan, 'P' );
109 if (!array_copy(&chan->topic, &Conf_Channel[i].topic)) {
110 Log( LOG_WARNING, "Could not set topic for new pre-defined channel: %s",
113 array_free(&Conf_Channel[i].topic);
114 c = Conf_Channel[i].modes;
115 while( *c ) Channel_ModeAdd( chan, *c++ );
116 Log( LOG_INFO, "Created pre-defined channel \"%s\".", Conf_Channel[i].name );
118 else Log( LOG_ERR, "Can't create pre-defined channel \"%s\"!", Conf_Channel[i].name );
120 } /* Channel_InitPredefined */
127 CL2CHAN *cl2chan, *cl2chan_next;
129 /* Channel-Strukturen freigeben */
134 array_free(&c->topic);
139 /* Channel-Zuordnungstabelle freigeben */
140 cl2chan = My_Cl2Chan;
143 cl2chan_next = cl2chan->next;
145 cl2chan = cl2chan_next;
151 Channel_Join( CLIENT *Client, char *Name )
155 assert( Client != NULL );
156 assert( Name != NULL );
158 /* Valider Channel-Name? */
159 if( ! Channel_IsValidName( Name ))
161 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
166 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 );
195 chan = Channel_Search( Name );
196 if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
198 IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
202 /* User aus Channel entfernen */
203 if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
209 Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
213 assert( Client != NULL );
214 assert( Origin != NULL );
215 assert( Name != NULL );
216 assert( Reason != NULL );
219 chan = Channel_Search( Name );
222 IRC_WriteStrClient( Origin, ERR_NOSUCHCHANNEL_MSG, Client_ID( Origin ), Name );
226 /* Ist der User Mitglied in dem Channel? */
227 if( ! Channel_IsMemberOf( chan, Origin ))
229 IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
233 /* Ist der User Channel-Operator? */
234 if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
236 IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
240 /* Ist der Ziel-User Mitglied im Channel? */
241 if( ! Channel_IsMemberOf( chan, Client ))
243 IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
247 Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
252 Channel_Quit( CLIENT *Client, char *Reason )
256 assert( Client != NULL );
257 assert( Reason != NULL );
259 IRC_WriteStrRelatedPrefix( Client, Client, false, "QUIT :%s", Reason );
265 Remove_Client( REMOVE_QUIT, c, Client, Client, Reason, false );
272 Channel_Count( void )
284 } /* Channel_Count */
288 Channel_MemberCount( CHANNEL *Chan )
293 assert( Chan != NULL );
295 cl2chan = My_Cl2Chan;
298 if( cl2chan->channel == Chan ) count++;
299 cl2chan = cl2chan->next;
302 } /* Channel_MemberCount */
306 Channel_CountForUser( CLIENT *Client )
308 /* Count number of channels a user is member of. */
313 assert( Client != NULL );
315 cl2chan = My_Cl2Chan;
318 if( cl2chan->client == Client ) count++;
319 cl2chan = cl2chan->next;
323 } /* Channel_CountForUser */
327 Channel_PCount( void )
329 /* Count the number of persistent (mode 'P') channels */
337 if( strchr( chan->modes, 'P' )) count++;
342 } /* Channel_PCount */
346 Channel_Name( CHANNEL *Chan )
348 assert( Chan != NULL );
354 Channel_Modes( CHANNEL *Chan )
356 assert( Chan != NULL );
358 } /* Channel_Modes */
362 Channel_Key( CHANNEL *Chan )
364 assert( Chan != NULL );
370 Channel_MaxUsers( CHANNEL *Chan )
372 assert( Chan != NULL );
373 return Chan->maxusers;
374 } /* Channel_MaxUsers */
378 Channel_First( void )
381 } /* Channel_First */
385 Channel_Next( CHANNEL *Chan )
387 assert( Chan != NULL );
393 Channel_Search( char *Name )
395 /* Channel-Struktur suchen */
400 assert( Name != NULL );
402 search_hash = Hash( Name );
406 if( search_hash == c->hash )
408 /* lt. Hash-Wert: Treffer! */
409 if( strcasecmp( Name, c->name ) == 0 ) return c;
414 } /* Channel_Search */
418 Channel_FirstMember( CHANNEL *Chan )
420 assert( Chan != NULL );
421 return Get_First_Cl2Chan( NULL, Chan );
422 } /* Channel_FirstMember */
426 Channel_NextMember( CHANNEL *Chan, CL2CHAN *Cl2Chan )
428 assert( Chan != NULL );
429 assert( Cl2Chan != NULL );
430 return Get_Next_Cl2Chan( Cl2Chan->next, NULL, Chan );
431 } /* Channel_NextMember */
435 Channel_FirstChannelOf( CLIENT *Client )
437 assert( Client != NULL );
438 return Get_First_Cl2Chan( Client, NULL );
439 } /* Channel_FirstChannelOf */
443 Channel_NextChannelOf( CLIENT *Client, CL2CHAN *Cl2Chan )
445 assert( Client != NULL );
446 assert( Cl2Chan != NULL );
447 return Get_Next_Cl2Chan( Cl2Chan->next, Client, NULL );
448 } /* Channel_NextChannelOf */
452 Channel_GetClient( CL2CHAN *Cl2Chan )
454 assert( Cl2Chan != NULL );
455 return Cl2Chan->client;
456 } /* Channel_GetClient */
460 Channel_GetChannel( CL2CHAN *Cl2Chan )
462 assert( Cl2Chan != NULL );
463 return Cl2Chan->channel;
464 } /* Channel_GetChannel */
468 Channel_IsValidName( char *Name )
470 /* Pruefen, ob Name als Channelname gueltig */
472 char *ptr, badchars[10];
474 assert( Name != NULL );
476 if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
479 strcpy( badchars, " ,:\007" );
482 if( strchr( badchars, *ptr )) return false;
487 } /* Channel_IsValidName */
491 Channel_ModeAdd( CHANNEL *Chan, char Mode )
494 * If the channel already had this mode, return false.
495 * If the channel mode was newly set return true.
500 assert( Chan != NULL );
502 x[0] = Mode; x[1] = '\0';
503 if( ! strchr( Chan->modes, x[0] ))
505 /* Channel does not have this mode yet, set it */
506 strlcat( Chan->modes, x, sizeof( Chan->modes ));
510 } /* Channel_ModeAdd */
514 Channel_ModeDel( CHANNEL *Chan, char Mode )
517 * if the mode was removed return true.
518 * if the channel did not have the mode, return false.
522 assert( Chan != NULL );
524 x[0] = Mode; x[1] = '\0';
526 p = strchr( Chan->modes, x[0] );
527 if( ! p ) return false;
529 /* Channel has mode -> delete */
536 } /* Channel_ModeDel */
540 Channel_UserModeAdd( CHANNEL *Chan, CLIENT *Client, char Mode )
542 /* Set Channel-User-Mode.
543 * if mode was newly set, return true.
544 * if the User already had this channel-mode, return false.
550 assert( Chan != NULL );
551 assert( Client != NULL );
553 cl2chan = Get_Cl2Chan( Chan, Client );
554 assert( cl2chan != NULL );
556 x[0] = Mode; x[1] = '\0';
557 if( ! strchr( cl2chan->modes, x[0] ))
559 /* mode not set, -> set it */
560 strlcat( cl2chan->modes, x, sizeof( cl2chan->modes ));
564 } /* Channel_UserModeAdd */
568 Channel_UserModeDel( CHANNEL *Chan, CLIENT *Client, char Mode )
570 /* Delete Channel-User-Mode.
571 * If Mode was removed, return true.
572 * If User did not have the Channel-Mode, return false.
578 assert( Chan != NULL );
579 assert( Client != NULL );
581 cl2chan = Get_Cl2Chan( Chan, Client );
582 assert( cl2chan != NULL );
584 x[0] = Mode; x[1] = '\0';
586 p = strchr( cl2chan->modes, x[0] );
587 if( ! p ) return false;
589 /* Client has Mode -> delete */
596 } /* Channel_UserModeDel */
600 Channel_UserModes( CHANNEL *Chan, CLIENT *Client )
602 /* return Users' Channel-Modes */
606 assert( Chan != NULL );
607 assert( Client != NULL );
609 cl2chan = Get_Cl2Chan( Chan, Client );
610 assert( cl2chan != NULL );
612 return cl2chan->modes;
613 } /* Channel_UserModes */
617 Channel_IsMemberOf( CHANNEL *Chan, CLIENT *Client )
619 /* Test if Client is on Channel Chan */
621 assert( Chan != NULL );
622 assert( Client != NULL );
624 if( Get_Cl2Chan( Chan, Client )) return true;
626 } /* Channel_IsMemberOf */
630 Channel_Topic( CHANNEL *Chan )
633 assert( Chan != NULL );
634 ret = array_start(&Chan->topic);
635 return ret ? ret : "";
636 } /* Channel_Topic */
640 Channel_SetTopic( CHANNEL *Chan, char *Topic )
643 assert( Chan != NULL );
644 assert( Topic != NULL );
647 if (len < array_bytes(&Chan->topic))
648 array_free(&Chan->topic);
650 if (!array_copyb(&Chan->topic, Topic, len))
651 Log(LOG_WARNING, "could not set new Topic %s: %s", Topic, strerror(errno));
653 array_cat0(&Chan->topic);
654 } /* Channel_SetTopic */
658 Channel_SetModes( CHANNEL *Chan, char *Modes )
660 assert( Chan != NULL );
661 assert( Modes != NULL );
663 strlcpy( Chan->modes, Modes, sizeof( Chan->modes ));
664 } /* Channel_SetModes */
668 Channel_SetKey( CHANNEL *Chan, char *Key )
670 assert( Chan != NULL );
671 assert( Key != NULL );
673 strlcpy( Chan->key, Key, sizeof( Chan->key ));
674 Log( LOG_DEBUG, "Channel %s: Key is now \"%s\".", Chan->name, Chan->key );
675 } /* Channel_SetKey */
679 Channel_SetMaxUsers( CHANNEL *Chan, long Count )
681 assert( Chan != NULL );
683 Chan->maxusers = Count;
684 Log( LOG_DEBUG, "Channel %s: Member limit is now %ld.", Chan->name, Chan->maxusers );
685 } /* Channel_SetMaxUsers */
689 Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
691 bool is_member, has_voice, is_op, ok;
693 /* Okay, target is a channel */
694 is_member = has_voice = is_op = false;
695 if( Channel_IsMemberOf( Chan, From ))
698 if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
699 if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
702 /* Is the client allowed to write to channel? */
704 if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
705 if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
707 /* Is the client banned? */
708 if( Lists_CheckBanned( From, Chan ))
710 /* Client is banned, bus is he channel operator or has voice? */
711 if(( ! has_voice ) && ( ! is_op )) ok = false;
714 if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
717 if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
718 return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
719 } /* Channel_Write */
723 Channel_Create( char *Name )
725 /* Create new CHANNEL structure and add it to linked list */
728 assert( Name != NULL );
730 c = (CHANNEL *)malloc( sizeof( CHANNEL ));
733 Log( LOG_EMERG, "Can't allocate memory! [New_Chan]" );
736 memset( c, 0, sizeof( CHANNEL ));
737 strlcpy( c->name, Name, sizeof( c->name ));
738 c->hash = Hash( c->name );
739 c->next = My_Channels;
742 Log( LOG_DEBUG, "Created new channel structure for \"%s\".", Name );
745 } /* Channel_Create */
749 Get_Cl2Chan( CHANNEL *Chan, CLIENT *Client )
753 assert( Chan != NULL );
754 assert( Client != NULL );
756 cl2chan = My_Cl2Chan;
759 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) return cl2chan;
760 cl2chan = cl2chan->next;
767 Add_Client( CHANNEL *Chan, CLIENT *Client )
771 assert( Chan != NULL );
772 assert( Client != NULL );
774 /* neue CL2CHAN-Struktur anlegen */
775 cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
778 Log( LOG_EMERG, "Can't allocate memory! [Add_Client]" );
781 cl2chan->channel = Chan;
782 cl2chan->client = Client;
783 strcpy( cl2chan->modes, "" );
786 cl2chan->next = My_Cl2Chan;
787 My_Cl2Chan = cl2chan;
789 Log( LOG_DEBUG, "User \"%s\" joined channel \"%s\".", Client_Mask( Client ), Chan->name );
796 Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
798 CL2CHAN *cl2chan, *last_cl2chan;
801 assert( Chan != NULL );
802 assert( Client != NULL );
803 assert( Origin != NULL );
804 assert( Reason != NULL );
807 cl2chan = My_Cl2Chan;
810 if(( cl2chan->channel == Chan ) && ( cl2chan->client == Client )) break;
811 last_cl2chan = cl2chan;
812 cl2chan = cl2chan->next;
814 if( ! cl2chan ) return false;
816 c = cl2chan->channel;
819 /* Aus Verkettung loesen und freigeben */
820 if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
821 else My_Cl2Chan = cl2chan->next;
827 /* QUIT: andere Server wurden bereits informiert, vgl. Client_Destroy();
828 * hier also "nur" noch alle User in betroffenen Channeln infomieren */
829 assert( InformServer == false );
830 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
833 /* User wurde geKICKed: ggf. andere Server sowie alle betroffenen User
834 * im entsprechenden Channel informieren */
835 if( InformServer ) IRC_WriteStrServersPrefix( Client_NextHop( Origin ), Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
836 IRC_WriteStrChannelPrefix( Client, c, Origin, false, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
837 if(( Client_Conn( Client ) > NONE ) && ( Client_Type( Client ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Client, Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason );
838 Log( LOG_DEBUG, "User \"%s\" has been kicked of \"%s\" by \"%s\": %s.", Client_Mask( Client ), c->name, Client_ID( Origin ), Reason );
842 if( InformServer ) IRC_WriteStrServersPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
843 IRC_WriteStrChannelPrefix( Origin, c, Client, false, "PART %s :%s", c->name, Reason );
844 if(( Client_Conn( Origin ) > NONE ) && ( Client_Type( Origin ) == CLIENT_USER )) IRC_WriteStrClientPrefix( Origin, Client, "PART %s :%s", c->name, Reason );
845 Log( LOG_DEBUG, "User \"%s\" left channel \"%s\" (%s).", Client_Mask( Client ), c->name, Reason );
848 /* Wenn Channel nun leer und nicht pre-defined: loeschen */
849 if( ! strchr( Channel_Modes( Chan ), 'P' ))
851 if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
855 } /* Remove_Client */
859 Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
861 return Get_Next_Cl2Chan( My_Cl2Chan, Client, Chan );
862 } /* Get_First_Cl2Chan */
866 Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
870 assert( Client != NULL || Channel != NULL );
875 if(( Client ) && ( cl2chan->client == Client )) return cl2chan;
876 if(( Channel ) && ( cl2chan->channel == Channel )) return cl2chan;
877 cl2chan = cl2chan->next;
880 } /* Get_Next_Cl2Chan */
884 Delete_Channel( CHANNEL *Chan )
886 /* Channel-Struktur loeschen */
888 CHANNEL *chan, *last_chan;
894 if( chan == Chan ) break;
898 if( ! chan ) return false;
900 Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
902 /* Invite- und Ban-Lists aufraeumen */
903 Lists_DeleteChannel( chan );
905 /* Neu verketten und freigeben */
906 if( last_chan ) last_chan->next = chan->next;
907 else My_Channels = chan->next;
911 } /* Delete_Channel */