src/ngircd/irc-macros.h

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001-2013 Alexander Barton (alex@barton.de) and Contributors.
   4  *
   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.
  10  */
  11
  12 #ifndef __irc_macros_h__
  13 #define __irc_macros_h__
  14
  15 /**
  16  * @file
  17  * Macros for functions that handle IRC commands.
  18  */
  19
  20 /**
  21  * Make sure that number of passed parameters is equal to Count.
  22  *
  23  * If there are not exactly Count parameters, send an error to the client and
  24  * return from the function.
  25  */
  26 #define _IRC_ARGC_EQ_OR_RETURN_(Client, Req, Count) \
  27 if (Req->argc != Count) { \
  28         return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
  29                                   Client_ID(Client), Req->command); \
  30 }
  31
  32 /**
  33  * Make sure that number of passed parameters is less or equal than Max.
  34  *
  35  * If there are more than Max parameters, send an error to the client and
  36  * return from the function.
  37  */
  38 #define _IRC_ARGC_LE_OR_RETURN_(Client, Req, Max) \
  39 if (Req->argc > Max) { \
  40         return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
  41                                   Client_ID(Client), Req->command); \
  42 }
  43
  44 /**
  45  * Make sure that number of passed parameters is greater or equal than Min.
  46  *
  47  * If there aren't at least Min parameters, send an error to the client and
  48  * return from the function.
  49  */
  50 #define _IRC_ARGC_GE_OR_RETURN_(Client, Req, Min) \
  51 if (Req->argc < Min) { \
  52         return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
  53                                   Client_ID(Client), Req->command); \
  54 }
  55
  56 /**
  57  * Make sure that number of passed parameters is in between Min and Max.
  58  *
  59  * If there aren't at least Min parameters or if there are more than Max
  60  * parameters, send an error to the client and return from the function.
  61  */
  62 #define _IRC_ARGC_BETWEEN_OR_RETURN_(Client, Req, Min, Max) \
  63 if (Req->argc < Min || Req->argc > Max) { \
  64         return IRC_WriteErrClient(Client, ERR_NEEDMOREPARAMS_MSG, \
  65                                   Client_ID(Client), Req->command); \
  66 }
  67
  68 /**
  69  * Get sender of an IRC command.
  70  *
  71  * The sender is either stored in the prefix if the command has been
  72  * received from a server or set to the client. If the sender is invalid,
  73  * send an error to the client and return from the function.
  74  */
  75 #define _IRC_GET_SENDER_OR_RETURN_(Sender, Req, Client) \
  76         if (Client_Type(Client) == CLIENT_SERVER) \
  77                 Sender = Client_Search(Req->prefix); \
  78         else \
  79                 Sender = Client; \
  80         if (!Sender) \
  81                 return IRC_WriteErrClient(Client, ERR_NOSUCHNICK_MSG, \
  82                                           Client_ID(Client), Req->prefix);
  83
  84 /**
  85  * Get target of an IRC command and make sure that it is a server.
  86  *
  87  * Set the target to the local server if no target parameter is given in the
  88  * received command, and send an error to the client and return from the
  89  * function if the given target isn't resolvable to a server: the target
  90  * parameter can be a server name, a nick name (then the target is set to
  91  * the server to which this nick is connected), or a mask matching at least
  92  * one server name in the network.
  93  */
  94 #define _IRC_GET_TARGET_SERVER_OR_RETURN_(Target, Req, Argc, From) \
  95         if (Req->argc > Argc) { \
  96                 Target = Client_Search(Req->argv[Argc]); \
  97                 if (!Target) \
  98                         Target = Client_SearchServer(Req->argv[Argc]); \
  99                 if (!Target) \
 100                         return IRC_WriteErrClient(From, ERR_NOSUCHSERVER_MSG, \
 101                                           Client_ID(From), Req->argv[Argc]); \
 102                 if (Client_Type(Target) != CLIENT_SERVER) \
 103                         Target = Client_Introducer(Target); \
 104         } else \
 105                 Target = Client_ThisServer();
 106
 107 #endif  /* __irc_macros_h__ */
 108
 109 /* -eof- */