X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=src%2Fngircd%2Fchannel.c;h=587668105ff36340cb884b97ae3a28793e42d1c7;hb=477f2fd9e719d757ff3d6f3515f845c37e13e354;hp=3341cb49a70a27c35ab65bc1ef68a3f8a1e813ed;hpb=5675be4cd95a32885d5c197559725ff7ddf11e27;p=ngircd.git

diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c
index 3341cb49..58766810 100644
--- a/src/ngircd/channel.c
+++ b/src/ngircd/channel.c
@@ -17,7 +17,7 @@
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: channel.c,v 1.63 2007/06/11 20:06:46 fw Exp $";
+static char UNUSED id[] = "$Id: channel.c,v 1.65 2008/02/05 16:31:35 fw Exp $";
 
 #include "imp.h"
 #include <assert.h>
@@ -56,7 +56,7 @@ static CL2CHAN *My_Cl2Chan;
 
 static CL2CHAN *Get_Cl2Chan PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 static CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client ));
-static bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer ));
+static bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, const char *Reason, bool InformServer ));
 static CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan ));
 static CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan ));
 static bool Delete_Channel PARAMS(( CHANNEL *Chan ));
@@ -89,18 +89,18 @@ Channel_GetListInvites(CHANNEL *c)
 GLOBAL void
 Channel_InitPredefined( void )
 {
-	/* Vordefinierte persistente Channels erzeugen */
+	/* Generate predefined persistent channels */
 
 	CHANNEL *chan;
 	char *c;
 	unsigned int i;
-	
+
 	for( i = 0; i < Conf_Channel_Count; i++ )
 	{
-		/* Ist ein Name konfiguriert? */
+		/* Check for Name configuration */
 		if( ! Conf_Channel[i].name[0] ) continue;
 
-		/* Gueltiger Channel-Name? */
+		/* Check for invalid channel name */
 		if( ! Channel_IsValidName( Conf_Channel[i].name ))
 		{
 			Log( LOG_ERR, "Can't create pre-defined channel: invalid name: \"%s\"!", Conf_Channel[i].name );
@@ -108,7 +108,7 @@ Channel_InitPredefined( void )
 			continue;
 		}
 
-		/* Gibt es den Channel bereits? */
+		/* Check if the channel name is already in use */
 		chan = Channel_Search( Conf_Channel[i].name );
 		if( chan )
 		{
@@ -149,7 +149,7 @@ Channel_Exit( void )
 	CHANNEL *c, *c_next;
 	CL2CHAN *cl2chan, *cl2chan_next;
 
-	/* Channel-Strukturen freigeben */
+	/* free struct Channel */
 	c = My_Channels;
 	while( c )
 	{
@@ -159,7 +159,7 @@ Channel_Exit( void )
 		c = c_next;
 	}
 
-	/* Channel-Zuordnungstabelle freigeben */
+	/* Free Channel allocation table */
 	cl2chan = My_Cl2Chan;
 	while( c )
 	{
@@ -170,61 +170,92 @@ Channel_Exit( void )
 } /* Channel_Exit */
 
 
+/**
+ * Join Channel
+ * This function lets a client join a channel.  First, the function
+ * checks that the specified channel name is valid and that the client
+ * isn't already a member.  If the specified channel doesn't exist,
+ * a new channel is created.  Client is added to channel by function
+ * Add_Client().
+ */
 GLOBAL bool
 Channel_Join( CLIENT *Client, char *Name )
 {
 	CHANNEL *chan;
-	
-	assert( Client != NULL );
-	assert( Name != NULL );
 
-	if( ! Channel_IsValidName( Name )) {
-		IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
+	assert(Client != NULL);
+	assert(Name != NULL);
+
+	/* Check that the channel name is valid */
+	if (! Channel_IsValidName(Name)) {
+		IRC_WriteStrClient(Client, ERR_NOSUCHCHANNEL_MSG,
+				   Client_ID(Client), Name);
 		return false;
 	}
 
-	chan = Channel_Search( Name );
-	if( chan ) {
-		/* Ist der Client bereits Mitglied? */
-		if( Get_Cl2Chan( chan, Client )) return false;
-	}
-	else
-	{
-		/* Gibt es noch nicht? Dann neu anlegen: */
-		chan = Channel_Create( Name );
-		if (!chan) return false;
+	chan = Channel_Search(Name);
+	if(chan) {
+		/* Check if the client is already in the channel */
+		if (Get_Cl2Chan(chan, Client))
+			return false;
+	} else {
+		/* If the specified channel does not exist, the channel
+		 * is now created */
+		chan = Channel_Create(Name);
+		if (!chan)
+			return false;
 	}
 
-	/* User dem Channel hinzufuegen */
-	if( ! Add_Client( chan, Client )) return false;
-	else return true;
+	/* Add user to Channel */
+	if (! Add_Client(chan, Client))
+		return false;
+
+	return true;
 } /* Channel_Join */
 
 
+/**
+ * Part client from channel.
+ * This function lets a client part from a channel. First, the function checks
+ * if the channel exists and the client is a member of it and sends out
+ * appropriate error messages if not. The real work is done by the function
+ * Remove_Client().
+ */
 GLOBAL bool
-Channel_Part( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
+Channel_Part(CLIENT * Client, CLIENT * Origin, const char *Name, const char *Reason)
 {
 	CHANNEL *chan;
 
-	assert( Client != NULL );
-	assert( Name != NULL );
-	assert( Reason != NULL );
+	assert(Client != NULL);
+	assert(Name != NULL);
+	assert(Reason != NULL);
 
-	chan = Channel_Search( Name );
-	if(( ! chan ) || ( ! Get_Cl2Chan( chan, Client )))
-	{
-		IRC_WriteStrClient( Client, ERR_NOSUCHCHANNEL_MSG, Client_ID( Client ), Name );
+	/* Check that specified channel exists */
+	chan = Channel_Search(Name);
+	if (!chan) {
+		IRC_WriteStrClient(Client, ERR_NOSUCHCHANNEL_MSG,
+				   Client_ID(Client), Name);
+		return false;
+	}
+
+	/* Check that the client is in the channel */
+	if (!Get_Cl2Chan(chan, Client)) {
+		IRC_WriteStrClient(Client, ERR_NOTONCHANNEL_MSG,
+				   Client_ID(Client), Name);
 		return false;
 	}
 
-	/* User aus Channel entfernen */
-	if( ! Remove_Client( REMOVE_PART, chan, Client, Origin, Reason, true)) return false;
-	else return true;
+	/* Part client from channel */
+	if (!Remove_Client(REMOVE_PART, chan, Client, Origin, Reason, true))
+		return false;
+	else
+		return true;
 } /* Channel_Part */
 
 
+/* Kick user from Channel */
 GLOBAL void
-Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
+Channel_Kick( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason )
 {
 	CHANNEL *chan;
 
@@ -233,6 +264,7 @@ Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
 	assert( Name != NULL );
 	assert( Reason != NULL );
 
+	/* Check that channel exists */
 	chan = Channel_Search( Name );
 	if( ! chan )
 	{
@@ -240,26 +272,28 @@ Channel_Kick( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason )
 		return;
 	}
 
+	/* Check that user is on the specified channel */
 	if( ! Channel_IsMemberOf( chan, Origin ))
 	{
 		IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
 		return;
 	}
 
-	/* Is User Channel-Operator? */
+	/* Check if user has operator status */
 	if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
 	{
 		IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
 		return;
 	}
 
-	/* Ist the kickED User member of channel? */
+	/* Check that the client to be kicked is on the specified channel */
 	if( ! Channel_IsMemberOf( chan, Client ))
 	{
 		IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
 		return;
 	}
 
+	/* Kick Client from channel */
 	Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
 } /* Channel_Kick */
 
@@ -289,7 +323,7 @@ Channel_Count( void )
 {
 	CHANNEL *c;
 	unsigned long count = 0;
-	
+
 	c = My_Channels;
 	while( c )
 	{
@@ -325,9 +359,9 @@ Channel_CountForUser( CLIENT *Client )
 
 	CL2CHAN *cl2chan;
 	int count = 0;
-	
+
 	assert( Client != NULL );
-	
+
 	cl2chan = My_Cl2Chan;
 	while( cl2chan )
 	{
@@ -339,7 +373,6 @@ Channel_CountForUser( CLIENT *Client )
 } /* Channel_CountForUser */
 
 
-
 GLOBAL const char *
 Channel_Name( const CHANNEL *Chan )
 {
@@ -388,10 +421,10 @@ Channel_Next( CHANNEL *Chan )
 
 
 GLOBAL CHANNEL *
-Channel_Search( char *Name )
+Channel_Search( const char *Name )
 {
-	/* Channel-Struktur suchen */
-	
+	/* Search channel structure */
+
 	CHANNEL *c;
 	UINT32 search_hash;
 
@@ -403,7 +436,7 @@ Channel_Search( char *Name )
 	{
 		if( search_hash == c->hash )
 		{
-			/* lt. Hash-Wert: Treffer! */
+			/* hash hit */
 			if( strcasecmp( Name, c->name ) == 0 ) return c;
 		}
 		c = c->next;
@@ -467,7 +500,10 @@ Channel_IsValidName( const char *Name )
 {
 	assert( Name != NULL );
 
-	if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
+	if (strchr("+#", Name[0]) == NULL)
+		return false;
+	if (strlen(Name) >= CHANNEL_NAME_LEN)
+		return false;
 
 	return Name[strcspn(Name, " ,:\007")] == 0;
 } /* Channel_IsValidName */
@@ -615,7 +651,7 @@ Channel_Topic( CHANNEL *Chan )
 	return ret ? ret : "";
 } /* Channel_Topic */
 
-	
+
 #ifndef STRICT_RFC
 
 GLOBAL unsigned int
@@ -695,38 +731,66 @@ Channel_SetMaxUsers(CHANNEL *Chan, unsigned long Count)
 } /* Channel_SetMaxUsers */
 
 
-GLOBAL bool
-Channel_Write( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text )
+static bool
+Can_Send_To_Channel(CHANNEL *Chan, CLIENT *From)
 {
-	bool is_member, has_voice, is_op, ok;
+	bool is_member, has_voice, is_op;
 
-	/* Okay, target is a channel */
 	is_member = has_voice = is_op = false;
-	if( Channel_IsMemberOf( Chan, From ))
-	{
+
+	if (Channel_IsMemberOf(Chan, From)) {
 		is_member = true;
-		if( strchr( Channel_UserModes( Chan, From ), 'v' )) has_voice = true;
-		if( strchr( Channel_UserModes( Chan, From ), 'o' )) is_op = true;
+		if (strchr(Channel_UserModes(Chan, From), 'v'))
+			has_voice = true;
+		if (strchr(Channel_UserModes(Chan, From), 'o'))
+			is_op = true;
 	}
 
-	/* Is the client allowed to write to channel? */
-	ok = true;
-	if( strchr( Channel_Modes( Chan ), 'n' ) && ( ! is_member )) ok = false;
-	if( strchr( Channel_Modes( Chan ), 'm' ) && ( ! is_op ) && ( ! has_voice )) ok = false;
+	/*
+	 * Is the client allowed to write to channel?
+	 *
+	 * If channel mode n set: non-members cannot send to channel.
+	 * If channel mode m set: need voice.
+	 */
+	if (strchr(Channel_Modes(Chan), 'n') && !is_member)
+		return false;
 
-	/* Is the client banned? */
-	if( Lists_Check(&Chan->list_bans, From))
-	{
-		/* Client is banned, but is he channel operator or has voice? */
-		if(( ! has_voice ) && ( ! is_op )) ok = false;
-	}
+	if (is_op || has_voice)
+		return true;
+
+	if (strchr(Channel_Modes(Chan), 'm'))
+		return false;
+
+	return !Lists_Check(&Chan->list_bans, From);
+}
 
-	if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
 
-	/* Send text */
-	if( Client_Conn( From ) > NONE ) Conn_UpdateIdle( Client_Conn( From ));
-	return IRC_WriteStrChannelPrefix( Client, Chan, From, true, "PRIVMSG %s :%s", Channel_Name( Chan ), Text );
-} /* Channel_Write */
+GLOBAL bool
+Channel_Write(CHANNEL *Chan, CLIENT *From, CLIENT *Client, const char *Text)
+{
+	if (!Can_Send_To_Channel(Chan, From))
+		return IRC_WriteStrClient(From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID(From), Channel_Name(Chan));
+
+	if (Client_Conn(From) > NONE)
+		Conn_UpdateIdle(Client_Conn(From));
+
+	return IRC_WriteStrChannelPrefix(Client, Chan, From, true,
+			"PRIVMSG %s :%s", Channel_Name(Chan), Text);
+}
+
+
+GLOBAL bool
+Channel_Notice(CHANNEL *Chan, CLIENT *From, CLIENT *Client, const char *Text)
+{
+	if (!Can_Send_To_Channel(Chan, From))
+		return true; /* no error, see RFC 2812 */
+
+	if (Client_Conn(From) > NONE)
+		Conn_UpdateIdle(Client_Conn(From));
+
+	return IRC_WriteStrChannelPrefix(Client, Chan, From, true,
+			"NOTICE %s :%s", Channel_Name(Chan), Text);
+}
 
 
 GLOBAL CHANNEL *
@@ -779,7 +843,7 @@ Add_Client( CHANNEL *Chan, CLIENT *Client )
 	assert( Chan != NULL );
 	assert( Client != NULL );
 
-	/* neue CL2CHAN-Struktur anlegen */
+	/* Create new CL2CHAN structure */
 	cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
 	if( ! cl2chan )
 	{
@@ -790,7 +854,7 @@ Add_Client( CHANNEL *Chan, CLIENT *Client )
 	cl2chan->client = Client;
 	strcpy( cl2chan->modes, "" );
 
-	/* Verketten */
+	/* concatenate */
 	cl2chan->next = My_Cl2Chan;
 	My_Cl2Chan = cl2chan;
 
@@ -801,11 +865,11 @@ Add_Client( CHANNEL *Chan, CLIENT *Client )
 
 
 static bool
-Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Reason, bool InformServer )
+Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, const char *Reason, bool InformServer )
 {
 	CL2CHAN *cl2chan, *last_cl2chan;
 	CHANNEL *c;
-	
+
 	assert( Chan != NULL );
 	assert( Client != NULL );
 	assert( Origin != NULL );
@@ -824,7 +888,7 @@ Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Re
 	c = cl2chan->channel;
 	assert( c != NULL );
 
-	/* Aus Verkettung loesen und freigeben */
+	/* maintain cl2chan list */
 	if( last_cl2chan ) last_cl2chan->next = cl2chan->next;
 	else My_Cl2Chan = cl2chan->next;
 	free( cl2chan );
@@ -851,7 +915,7 @@ Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Re
 				IRC_WriteStrClientPrefix(Client, Origin, "KICK %s %s :%s",
 								c->name, Client_ID( Client ), Reason);
 			}
-			LogDebug("User \"%s\" has been kicked of \"%s\" by \"%s\": %s.",
+			LogDebug("User \"%s\" has been kicked off \"%s\" by \"%s\": %s.",
 				Client_Mask( Client ), c->name, Client_ID(Origin), Reason);
 			break;
 		default: /* PART */
@@ -870,12 +934,12 @@ Remove_Client( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, char *Re
 			}
 	}
 
-	/* Wenn Channel nun leer und nicht pre-defined: loeschen */
+	/* When channel is empty and is not pre-defined, delete */
 	if( ! strchr( Channel_Modes( Chan ), 'P' ))
 	{
 		if( ! Get_First_Cl2Chan( NULL, Chan )) Delete_Channel( Chan );
 	}
-		
+
 	return true;
 } /* Remove_Client */
 
@@ -955,7 +1019,7 @@ Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
 	CL2CHAN *cl2chan;
 
 	assert( Client != NULL || Channel != NULL );
-	
+
 	cl2chan = Start;
 	while( cl2chan )
 	{
@@ -970,7 +1034,7 @@ Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel )
 static bool
 Delete_Channel( CHANNEL *Chan )
 {
-	/* Channel-Struktur loeschen */
+	/* delete channel structure */
 
 	CHANNEL *chan, *last_chan;
 
@@ -986,11 +1050,11 @@ Delete_Channel( CHANNEL *Chan )
 
 	Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name );
 
-	/* Invite- und Ban-Lists aufraeumen */
+	/* free invite and ban lists */
 	Lists_Free( &chan->list_bans );
 	Lists_Free( &chan->list_invites );
 
-	/* Neu verketten und freigeben */
+	/* maintain channel list */
 	if( last_chan ) last_chan->next = chan->next;
 	else My_Channels = chan->next;
 	free( chan );