/*
* ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2005 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2008 by Alexander Barton (alex@barton.de)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include "portab.h"
-static char UNUSED id[] = "$Id: channel.c,v 1.62 2006/12/29 14:09:50 fw Exp $";
-
#include "imp.h"
#include <assert.h>
#include <stdlib.h>
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 ));
GLOBAL void
Channel_Init( void )
{
+ CHANNEL *sc;
+
My_Channels = NULL;
My_Cl2Chan = NULL;
+
+ sc = Channel_Create("&SERVER");
+ if (sc) {
+ Channel_SetModes(sc, "mnPt");
+ Channel_SetTopic(sc, Client_ThisServer(), "Server Messages");
+ }
} /* Channel_Init */
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 );
continue;
}
- /* Gibt es den Channel bereits? */
+ /* Check if the channel name is already in use */
chan = Channel_Search( Conf_Channel[i].name );
if( chan )
{
CHANNEL *c, *c_next;
CL2CHAN *cl2chan, *cl2chan_next;
- /* Channel-Strukturen freigeben */
+ /* free struct Channel */
c = My_Channels;
while( c )
{
c = c_next;
}
- /* Channel-Zuordnungstabelle freigeben */
+ /* Free Channel allocation table */
cl2chan = My_Cl2Chan;
while( c )
{
} /* 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 *Peer, CLIENT *Target, CLIENT *Origin, const char *Name,
+ const char *Reason )
{
CHANNEL *chan;
- assert( Client != NULL );
- assert( Origin != NULL );
- assert( Name != NULL );
- assert( Reason != NULL );
+ assert(Peer != NULL);
+ assert(Target != NULL);
+ assert(Origin != NULL);
+ assert(Name != NULL);
+ assert(Reason != NULL);
+ /* Check that channel exists */
chan = Channel_Search( Name );
if( ! chan )
{
return;
}
- if( ! Channel_IsMemberOf( chan, Origin ))
- {
- IRC_WriteStrClient( Origin, ERR_NOTONCHANNEL_MSG, Client_ID( Origin ), Name );
- return;
- }
+ if (Client_Type(Peer) != CLIENT_SERVER &&
+ Client_Type(Origin) != CLIENT_SERVICE) {
+ /* 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? */
- if( ! strchr( Channel_UserModes( chan, Origin ), 'o' ))
- {
- IRC_WriteStrClient( Origin, ERR_CHANOPRIVSNEEDED_MSG, Client_ID( Origin ), Name);
- return;
+ /* 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? */
- if( ! Channel_IsMemberOf( chan, Client ))
- {
- IRC_WriteStrClient( Origin, ERR_USERNOTINCHANNEL_MSG, Client_ID( Origin ), Client_ID( Client ), Name );
+ /* Check that the client to be kicked is on the specified channel */
+ if (!Channel_IsMemberOf(chan, Target)) {
+ IRC_WriteStrClient(Origin, ERR_USERNOTINCHANNEL_MSG,
+ Client_ID(Origin), Client_ID(Target), Name );
return;
}
- Remove_Client( REMOVE_KICK, chan, Client, Origin, Reason, true);
+ /* Kick Client from channel */
+ Remove_Client( REMOVE_KICK, chan, Target, Origin, Reason, true);
} /* Channel_Kick */
{
CHANNEL *c;
unsigned long count = 0;
-
+
c = My_Channels;
while( c )
{
CL2CHAN *cl2chan;
int count = 0;
-
+
assert( Client != NULL );
-
+
cl2chan = My_Cl2Chan;
while( cl2chan )
{
} /* Channel_CountForUser */
-
GLOBAL const char *
Channel_Name( const CHANNEL *Chan )
{
GLOBAL CHANNEL *
-Channel_Search( char *Name )
+Channel_Search( const char *Name )
{
- /* Channel-Struktur suchen */
-
+ /* Search channel structure */
+
CHANNEL *c;
UINT32 search_hash;
{
if( search_hash == c->hash )
{
- /* lt. Hash-Wert: Treffer! */
+ /* hash hit */
if( strcasecmp( Name, c->name ) == 0 ) return c;
}
c = c->next;
{
assert( Name != NULL );
- if(( Name[0] != '#' ) || ( strlen( Name ) >= CHANNEL_NAME_LEN )) return false;
+#ifdef STRICT_RFC
+ if (strlen(Name) <= 1)
+ return false;
+#endif
+ if (strchr("#&+", Name[0]) == NULL)
+ return false;
+ if (strlen(Name) >= CHANNEL_NAME_LEN)
+ return false;
return Name[strcspn(Name, " ,:\007")] == 0;
} /* Channel_IsValidName */
assert( Chan != NULL );
assert( Client != NULL );
- return Get_Cl2Chan(Chan, Client);
+ return Get_Cl2Chan(Chan, Client) != NULL;
} /* Channel_IsMemberOf */
return ret ? ret : "";
} /* Channel_Topic */
-
+
#ifndef STRICT_RFC
GLOBAL unsigned int
} /* 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 ))
- {
+
+ /* The server itself always can send messages :-) */
+ if (Client_ThisServer() == From)
+ return true;
+
+ 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;
+
+ if (is_op || has_voice)
+ return true;
- /* 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 (strchr(Channel_Modes(Chan), 'm'))
+ return false;
+
+ return !Lists_Check(&Chan->list_bans, From);
+}
+
+
+GLOBAL bool
+Channel_Write(CHANNEL *Chan, CLIENT *From, CLIENT *Client, const char *Command,
+ bool SendErrors, const char *Text)
+{
+ if (!Can_Send_To_Channel(Chan, From)) {
+ if (! SendErrors)
+ return CONNECTED; /* no error, see RFC 2812 */
+ return IRC_WriteStrClient(From, ERR_CANNOTSENDTOCHAN_MSG,
+ Client_ID(From), Channel_Name(Chan));
}
- if( ! ok ) return IRC_WriteStrClient( From, ERR_CANNOTSENDTOCHAN_MSG, Client_ID( From ), Channel_Name( Chan ));
+ if (Client_Conn(From) > NONE)
+ Conn_UpdateIdle(Client_Conn(From));
- /* 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 */
+ return IRC_WriteStrChannelPrefix(Client, Chan, From, true,
+ "%s %s :%s", Command, Channel_Name(Chan), Text);
+}
GLOBAL CHANNEL *
assert( Chan != NULL );
assert( Client != NULL );
- /* neue CL2CHAN-Struktur anlegen */
+ /* Create new CL2CHAN structure */
cl2chan = (CL2CHAN *)malloc( sizeof( CL2CHAN ));
if( ! cl2chan )
{
cl2chan->client = Client;
strcpy( cl2chan->modes, "" );
- /* Verketten */
+ /* concatenate */
cl2chan->next = My_Cl2Chan;
My_Cl2Chan = cl2chan;
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 );
assert( Reason != NULL );
+ /* Do not inform other servers if the channel is local to this server,
+ * regardless of what the caller requested! */
+ if(InformServer)
+ InformServer = !Channel_IsLocal(Chan);
+
last_cl2chan = NULL;
cl2chan = My_Cl2Chan;
while( cl2chan )
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 );
switch( Type )
{
case REMOVE_QUIT:
- /* QUIT: other servers have already been notified, see Client_Destroy();
- * so only inform other clients in same channel. */
+ /* QUIT: other servers have already been notified,
+ * see Client_Destroy(); so only inform other clients
+ * in same channel. */
assert( InformServer == false );
LogDebug("User \"%s\" left channel \"%s\" (%s).",
Client_Mask( Client ), c->name, Reason );
break;
case REMOVE_KICK:
- /* User was KICKed: inform other servers and all users in channel */
+ /* User was KICKed: inform other servers (public
+ * channels) and all users in the channel */
if( InformServer )
IRC_WriteStrServersPrefix( Client_NextHop( Origin ),
Origin, "KICK %s %s :%s", c->name, Client_ID( Client ), Reason);
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 */
}
}
- /* 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 */
}
+/**
+ * Log a message to the local &SERVER channel, if it exists.
+ */
+GLOBAL void
+Channel_LogServer(char *msg)
+{
+ CHANNEL *sc;
+ CLIENT *c;
+
+ assert(msg != NULL);
+
+ sc = Channel_Search("&SERVER");
+ if (!sc)
+ return;
+
+ c = Client_ThisServer();
+ Channel_Write(sc, c, c, "PRIVMSG", false, msg);
+} /* Channel_LogServer */
+
+
static CL2CHAN *
Get_First_Cl2Chan( CLIENT *Client, CHANNEL *Chan )
{
CL2CHAN *cl2chan;
assert( Client != NULL || Channel != NULL );
-
+
cl2chan = Start;
while( cl2chan )
{
static bool
Delete_Channel( CHANNEL *Chan )
{
- /* Channel-Struktur loeschen */
+ /* delete channel structure */
CHANNEL *chan, *last_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 );
return true;
} /* Delete_Channel */
-
/* -eof- */