albino
/
ngircd-tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update irc.c to use irc-macros.h 

This includes code cleanups and better documentation for some
functions, too.
This commit is contained in:
Alexander Barton 2013-07-18 23:35:33 +02:00
parent b54e664a63
commit fa15eb1698
1 changed files with 105 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

159
src/ngircd/irc.c
View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2012 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * 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 * it under the terms of the GNU General Public License as published by
@ -27,6 +27,7 @@
#include "channel.h" #include "channel.h"
#include "conn-encoding.h" #include "conn-encoding.h"
#include "defines.h" #include "defines.h"
#include "irc-macros.h"
#include "irc-write.h" #include "irc-write.h"
#include "log.h" #include "log.h"
#include "match.h" #include "match.h"
@ -37,7 +38,6 @@
#include "exp.h" #include "exp.h"
#include "irc.h" #include "irc.h"
static char *Option_String PARAMS((CONN_ID Idx)); static char *Option_String PARAMS((CONN_ID Idx));
static bool Send_Message PARAMS((CLIENT *Client, REQUEST *Req, int ForceType, static bool Send_Message PARAMS((CLIENT *Client, REQUEST *Req, int ForceType,
bool SendErrors)); bool SendErrors));
@ -46,7 +46,6 @@ static bool Send_Message_Mask PARAMS((CLIENT *from, char *command,
bool SendErrors)); bool SendErrors));
static bool Help PARAMS((CLIENT *Client, const char *Topic)); static bool Help PARAMS((CLIENT *Client, const char *Topic));
/** /**
* Check if a list limit is reached and inform client accordingly. * Check if a list limit is reached and inform client accordingly.
* *
@ -75,7 +74,13 @@ IRC_CheckListTooBig(CLIENT *From, const int Count, const int Limit,
return true; return true;
} }
/**
* Handler for the IRC "ERROR" command.
*
* @param Client The client from which this command has been received.
* @param Req Request structure with prefix and all parameters.
* @return CONNECTED or DISCONNECTED.
*/
GLOBAL bool GLOBAL bool
IRC_ERROR(CLIENT *Client, REQUEST *Req) IRC_ERROR(CLIENT *Client, REQUEST *Req)
{ {
@ -103,7 +108,6 @@ IRC_ERROR( CLIENT *Client, REQUEST *Req )
return CONNECTED; return CONNECTED;
} /* IRC_ERROR */ } /* IRC_ERROR */
/** /**
* Handler for the IRC "KILL" command. * Handler for the IRC "KILL" command.
* *
@ -115,10 +119,10 @@ IRC_ERROR( CLIENT *Client, REQUEST *Req )
* KILL command being received over the network! Client is Client_ThisServer() * KILL command being received over the network! Client is Client_ThisServer()
* in this case, and the prefix in Req is NULL. * in this case, and the prefix in Req is NULL.
* *
* @param Client The client from which this command has been received * @param Client The client from which this command has been received or
* or Client_ThisServer() when generated interanlly. * Client_ThisServer() when generated interanlly.
* @param Req Request structure with prefix and all parameters. * @param Req Request structure with prefix and all parameters.
* @returns CONNECTED or DISCONNECTED. * @return CONNECTED or DISCONNECTED.
*/ */
GLOBAL bool GLOBAL bool
IRC_KILL(CLIENT *Client, REQUEST *Req) IRC_KILL(CLIENT *Client, REQUEST *Req)
@ -134,9 +138,7 @@ IRC_KILL( CLIENT *Client, REQUEST *Req )
return IRC_WriteStrClient(Client, ERR_NOPRIVILEGES_MSG, return IRC_WriteStrClient(Client, ERR_NOPRIVILEGES_MSG,
Client_ID(Client)); Client_ID(Client));
if (Req->argc != 2) _IRC_ARGC_EQ_OR_RETURN_(Client, Req, 2)
return IRC_WriteStrClient(Client, ERR_NEEDMOREPARAMS_MSG,
Client_ID(Client), Req->command);
/* Get prefix (origin); use the client if no prefix is given. */ /* Get prefix (origin); use the client if no prefix is given. */
if (Req->prefix) if (Req->prefix)
@ -145,7 +147,8 @@ IRC_KILL( CLIENT *Client, REQUEST *Req )
prefix = Client; prefix = Client;
/* Log a warning message and use this server as origin when the /* Log a warning message and use this server as origin when the
* prefix (origin) is invalid. */ * prefix (origin) is invalid. And this is the reason why we don't
* use the _IRC_GET_SENDER_OR_RETURN_ macro above! */
if (!prefix) { if (!prefix) {
Log(LOG_WARNING, "Got KILL with invalid prefix: \"%s\"!", Log(LOG_WARNING, "Got KILL with invalid prefix: \"%s\"!",
Req->prefix ); Req->prefix );
@ -174,19 +177,16 @@ IRC_KILL( CLIENT *Client, REQUEST *Req )
/* Do we host such a client? */ /* Do we host such a client? */
c = Client_Search( Req->argv[0] ); c = Client_Search( Req->argv[0] );
if( c ) if (c) {
{ if (Client_Type(c) != CLIENT_USER
if(( Client_Type( c ) != CLIENT_USER ) && && Client_Type(c) != CLIENT_GOTNICK) {
( Client_Type( c ) != CLIENT_GOTNICK ))
{
/* Target of this KILL is not a regular user, this is /* Target of this KILL is not a regular user, this is
* invalid! So we ignore this case if we received a * invalid! So we ignore this case if we received a
* regular KILL from the network and try to kill the * regular KILL from the network and try to kill the
* client/connection anyway (but log an error!) if the * client/connection anyway (but log an error!) if the
* origin is the local server. */ * origin is the local server. */
if( Client != Client_ThisServer( )) if (Client != Client_ThisServer()) {
{
/* Invalid KILL received from remote */ /* Invalid KILL received from remote */
if (Client_Type(c) == CLIENT_SERVER) if (Client_Type(c) == CLIENT_SERVER)
msg = ERR_CANTKILLSERVER_MSG; msg = ERR_CANTKILLSERVER_MSG;
@ -196,7 +196,8 @@ IRC_KILL( CLIENT *Client, REQUEST *Req )
Client_ID(Client)); Client_ID(Client));
} }
Log( LOG_ERR, "Got KILL for invalid client type: %d, \"%s\"!", Log(LOG_ERR,
"Got KILL for invalid client type: %d, \"%s\"!",
Client_Type( c ), Req->argv[0] ); Client_Type( c ), Req->argv[0] );
} }
@ -211,18 +212,22 @@ IRC_KILL( CLIENT *Client, REQUEST *Req )
Client_Destroy(c, NULL, reason, false); Client_Destroy(c, NULL, reason, false);
} }
else else
Log( LOG_NOTICE, "Client with nick \"%s\" is unknown here.", Req->argv[0] ); Log(LOG_NOTICE, "Client with nick \"%s\" is unknown here.",
Req->argv[0]);
/* Are we still connected or were we killed, too? */ /* Are we still connected or were we killed, too? */
if(( my_conn > NONE ) && ( Conn_GetClient( my_conn ))) if (my_conn > NONE && Conn_GetClient(my_conn))
return CONNECTED; return CONNECTED;
else else
return DISCONNECTED; return DISCONNECTED;
} /* IRC_KILL */ } /* IRC_KILL */
/** /**
* Handler for the IRC command NOTICE. * Handler for the IRC "NOTICE" command.
*
* @param Client The client from which this command has been received.
* @param Req Request structure with prefix and all parameters.
* @return CONNECTED or DISCONNECTED.
*/ */
GLOBAL bool GLOBAL bool
IRC_NOTICE(CLIENT *Client, REQUEST *Req) IRC_NOTICE(CLIENT *Client, REQUEST *Req)
@ -230,9 +235,12 @@ IRC_NOTICE(CLIENT *Client, REQUEST *Req)
return Send_Message(Client, Req, CLIENT_USER, false); return Send_Message(Client, Req, CLIENT_USER, false);
} /* IRC_NOTICE */ } /* IRC_NOTICE */
/** /**
* Handler for the IRC command PRIVMSG. * Handler for the IRC "PRIVMSG" command.
*
* @param Client The client from which this command has been received.
* @param Req Request structure with prefix and all parameters.
* @return CONNECTED or DISCONNECTED.
*/ */
GLOBAL bool GLOBAL bool
IRC_PRIVMSG(CLIENT *Client, REQUEST *Req) IRC_PRIVMSG(CLIENT *Client, REQUEST *Req)
@ -240,9 +248,12 @@ IRC_PRIVMSG(CLIENT *Client, REQUEST *Req)
return Send_Message(Client, Req, CLIENT_USER, true); return Send_Message(Client, Req, CLIENT_USER, true);
} /* IRC_PRIVMSG */ } /* IRC_PRIVMSG */
/** /**
* Handler for the IRC command SQUERY. * Handler for the IRC "SQUERY" command.
*
* @param Client The client from which this command has been received.
* @param Req Request structure with prefix and all parameters.
* @return CONNECTED or DISCONNECTED.
*/ */
GLOBAL bool GLOBAL bool
IRC_SQUERY(CLIENT *Client, REQUEST *Req) IRC_SQUERY(CLIENT *Client, REQUEST *Req)
@ -250,7 +261,13 @@ IRC_SQUERY(CLIENT *Client, REQUEST *Req)
return Send_Message(Client, Req, CLIENT_SERVICE, true); return Send_Message(Client, Req, CLIENT_SERVICE, true);
} /* IRC_SQUERY */ } /* IRC_SQUERY */
/*
* Handler for the IRC "TRACE" command.
*
* @param Client The client from which this command has been received.
* @param Req Request structure with prefix and all parameters.
* @return CONNECTED or DISCONNECTED.
*/
GLOBAL bool GLOBAL bool
IRC_TRACE(CLIENT *Client, REQUEST *Req) IRC_TRACE(CLIENT *Client, REQUEST *Req)
{ {
@ -261,27 +278,32 @@ IRC_TRACE( CLIENT *Client, REQUEST *Req )
assert(Client != NULL); assert(Client != NULL);
assert(Req != NULL); assert(Req != NULL);
IRC_SetPenalty(Client, 3);
/* Bad number of arguments? */ /* Bad number of arguments? */
if( Req->argc > 1 ) return IRC_WriteStrClient( Client, ERR_NORECIPIENT_MSG, Client_ID( Client ), Req->command ); if (Req->argc > 1)
return IRC_WriteStrClient(Client, ERR_NORECIPIENT_MSG,
Client_ID(Client), Req->command);
/* Search sender */ _IRC_GET_SENDER_OR_RETURN_(from, Req, Client)
if( Client_Type( Client ) == CLIENT_SERVER ) from = Client_Search( Req->prefix ); _IRC_GET_TARGET_SERVER_OR_RETURN_(target, Req, 0, from)
else from = Client;
if( ! from ) return IRC_WriteStrClient( Client, ERR_NOSUCHNICK_MSG, Client_ID( Client ), Req->prefix );
/* Search target */
if( Req->argc == 1 ) target = Client_Search( Req->argv[0] );
else target = Client_ThisServer( );
/* Forward command to other server? */ /* Forward command to other server? */
if( target != Client_ThisServer( )) if (target != Client_ThisServer()) {
{
if(( ! target ) || ( Client_Type( target ) != CLIENT_SERVER )) return IRC_WriteStrClient( from, ERR_NOSUCHSERVER_MSG, Client_ID( from ), Req->argv[0] );
/* Send RPL_TRACELINK back to initiator */ /* Send RPL_TRACELINK back to initiator */
idx = Client_Conn( Client ); assert( idx > NONE ); idx = Client_Conn(Client);
idx2 = Client_Conn( Client_NextHop( target )); assert( idx2 > NONE ); assert(idx > NONE);
if( ! IRC_WriteStrClient( from, RPL_TRACELINK_MSG, Client_ID( from ), PACKAGE_NAME, PACKAGE_VERSION, Client_ID( target ), Client_ID( Client_NextHop( target )), Option_String( idx2 ), time( NULL ) - Conn_StartTime( idx2 ), Conn_SendQ( idx ), Conn_SendQ( idx2 ))) return DISCONNECTED; idx2 = Client_Conn(Client_NextHop(target));
assert(idx2 > NONE);
if (!IRC_WriteStrClient(from, RPL_TRACELINK_MSG,
Client_ID(from), PACKAGE_NAME,
PACKAGE_VERSION, Client_ID(target),
Client_ID(Client_NextHop(target)),
Option_String(idx2),
time(NULL) - Conn_StartTime(idx2),
Conn_SendQ(idx), Conn_SendQ(idx2)))
return DISCONNECTED;
/* Forward command */ /* Forward command */
IRC_WriteStrClientPrefix(target, from, "TRACE %s", Req->argv[0]); IRC_WriteStrClientPrefix(target, from, "TRACE %s", Req->argv[0]);
@ -290,32 +312,39 @@ IRC_TRACE( CLIENT *Client, REQUEST *Req )
/* Infos about all connected servers */ /* Infos about all connected servers */
c = Client_First(); c = Client_First();
while( c ) while (c) {
{ if (Client_Conn(c) > NONE) {
if( Client_Conn( c ) > NONE )
{
/* Local client */ /* Local client */
if( Client_Type( c ) == CLIENT_SERVER ) if (Client_Type(c) == CLIENT_SERVER) {
{
/* Server link */ /* Server link */
strlcpy(user, Client_User(c), sizeof(user)); strlcpy(user, Client_User(c), sizeof(user));
if( user[0] == '~' ) strlcpy( user, "unknown", sizeof( user )); if (user[0] == '~')
if( ! IRC_WriteStrClient( from, RPL_TRACESERVER_MSG, Client_ID( from ), Client_ID( c ), user, Client_Hostname( c ), Client_Mask( Client_ThisServer( )), Option_String( Client_Conn( c )))) return DISCONNECTED; strlcpy(user, "unknown", sizeof(user));
if (!IRC_WriteStrClient(from,
RPL_TRACESERVER_MSG,
Client_ID(from), Client_ID(c),
user, Client_Hostname(c),
Client_Mask(Client_ThisServer()),
Option_String(Client_Conn(c))))
return DISCONNECTED;
} }
if(( Client_Type( c ) == CLIENT_USER ) && ( strchr( Client_Modes( c ), 'o' ))) if (Client_Type(c) == CLIENT_USER
{ && strchr(Client_Modes(c), 'o')) {
/* IRC Operator */ /* IRC Operator */
if( ! IRC_WriteStrClient( from, RPL_TRACEOPERATOR_MSG, Client_ID( from ), Client_ID( c ))) return DISCONNECTED; if (!IRC_WriteStrClient(from,
RPL_TRACEOPERATOR_MSG,
Client_ID(from), Client_ID(c)))
return DISCONNECTED;
} }
} }
c = Client_Next( c ); c = Client_Next( c );
} }
IRC_SetPenalty( Client, 3 ); return IRC_WriteStrClient(from, RPL_TRACEEND_MSG, Client_ID(from),
return IRC_WriteStrClient( from, RPL_TRACEEND_MSG, Client_ID( from ), Conf_ServerName, PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_DebugLevel ); Conf_ServerName, PACKAGE_NAME,
PACKAGE_VERSION, NGIRCd_DebugLevel);
} /* IRC_TRACE */ } /* IRC_TRACE */
/** /**
* Handler for the IRC "HELP" command. * Handler for the IRC "HELP" command.
* *
@ -331,13 +360,10 @@ IRC_HELP(CLIENT *Client, REQUEST *Req)
assert(Client != NULL); assert(Client != NULL);
assert(Req != NULL); assert(Req != NULL);
/* Bad number of arguments? */
if (Req->argc > 1)
return IRC_WriteStrClient(Client, ERR_NORECIPIENT_MSG,
Client_ID(Client), Req->command);
IRC_SetPenalty(Client, 2); IRC_SetPenalty(Client, 2);
_IRC_ARGC_LE_OR_RETURN_(Client, Req, 1)
if ((Req->argc == 0 && array_bytes(&Conf_Helptext) > 0) if ((Req->argc == 0 && array_bytes(&Conf_Helptext) > 0)
|| (Req->argc >= 1 && strcasecmp(Req->argv[0], "Commands") != 0)) { || (Req->argc >= 1 && strcasecmp(Req->argv[0], "Commands") != 0)) {
/* Help text available and requested */ /* Help text available and requested */
@ -359,7 +385,6 @@ IRC_HELP(CLIENT *Client, REQUEST *Req)
return CONNECTED; return CONNECTED;
} /* IRC_HELP */ } /* IRC_HELP */
/** /**
* Send help for a given topic to the client. * Send help for a given topic to the client.
* *
@ -425,7 +450,6 @@ Help(CLIENT *Client, const char *Topic)
return CONNECTED; return CONNECTED;
} }
static char * static char *
#ifdef ZLIB #ifdef ZLIB
Option_String(CONN_ID Idx) Option_String(CONN_ID Idx)
@ -450,7 +474,6 @@ Option_String(UNUSED CONN_ID Idx)
return option_txt; return option_txt;
} /* Option_String */ } /* Option_String */
static bool static bool
Send_Message(CLIENT * Client, REQUEST * Req, int ForceType, bool SendErrors) Send_Message(CLIENT * Client, REQUEST * Req, int ForceType, bool SendErrors)
{ {
@ -674,7 +697,6 @@ Send_Message(CLIENT * Client, REQUEST * Req, int ForceType, bool SendErrors)
return CONNECTED; return CONNECTED;
} /* Send_Message */ } /* Send_Message */
static bool static bool
Send_Message_Mask(CLIENT * from, char * command, char * targetMask, Send_Message_Mask(CLIENT * from, char * command, char * targetMask,
char * message, bool SendErrors) char * message, bool SendErrors)
@ -734,5 +756,4 @@ Send_Message_Mask(CLIENT * from, char * command, char * targetMask,
return CONNECTED; return CONNECTED;
} /* Send_Message_Mask */ } /* Send_Message_Mask */
/* -eof- */ /* -eof- */