include/ctables.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __CTABLES_H__
  15 #define __CTABLES_H__
  16
  17 /** Used to indicate command success codes
  18  */
  19 enum CmdResult
  20 {
  21         CMD_FAILURE = 0,        /* Command exists, but failed */
  22         CMD_SUCCESS = 1,        /* Command exists, and succeeded */
  23         CMD_INVALID = 2         /* Command doesnt exist at all! */
  24 };
  25
  26 /** Translation types for translation of parameters to UIDs.
  27  * This allows the core commands to not have to be aware of how UIDs
  28  * work (making it still possible to write other linking modules which
  29  * do not use UID (but why would you want to?)
  30  */
  31 enum TranslateType
  32 {
  33         TR_END,                 /* End of known parameters, everything after this is TR_TEXT */
  34         TR_TEXT,                /* Raw text, leave as-is */
  35         TR_NICK,                /* Nickname, translate to UUID for server->server */
  36         TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
  37 };
  38
  39 /** Routing types for a command. Any command which is created defaults
  40  * to having its command broadcasted on success. This behaviour may be
  41  * overridden to one of the route types shown below (see the #defines
  42  * below for more information on each one's behaviour)
  43  */
  44 enum RouteType
  45 {
  46         ROUTE_TYPE_LOCALONLY,
  47         ROUTE_TYPE_BROADCAST,
  48         ROUTE_TYPE_UNICAST,
  49         ROUTE_TYPE_MESSAGE,
  50         ROUTE_TYPE_OPT_BCAST,
  51         ROUTE_TYPE_OPT_UCAST
  52 };
  53
  54 /** Defines routing information for a command, containing a destination
  55  * server id (if applicable) and a routing type from the enum above.
  56  */
  57 struct RouteDescriptor
  58 {
  59         /** Routing type from the enum above
  60          */
  61         RouteType type;
  62         /** For unicast, the destination server's name
  63          */
  64         std::string serverdest;
  65
  66         /** Create a RouteDescriptor
  67          */
  68         RouteDescriptor(RouteType t, const std::string &d)
  69                 : type(t), serverdest(d) { }
  70 };
  71
  72 /** Do not route this command */
  73 #define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
  74 /** Route this command to all servers, fail if not understood */
  75 #define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
  76 /** Route this command to a single server (do nothing if own server name specified) */
  77 #define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
  78 /** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
  79 #define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
  80 /** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
  81 #define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
  82 /** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
  83 #define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
  84
  85 /** A structure that defines a command. Every command available
  86  * in InspIRCd must be defined as derived from Command.
  87  */
  88 class CoreExport Command : public ServiceProvider
  89 {
  90  public:
  91         /** User flags needed to execute the command or 0
  92          */
  93         char flags_needed;
  94
  95         /** Minimum number of parameters command takes
  96         */
  97         const unsigned int min_params;
  98
  99         /** Maximum number of parameters command takes.
 100          * This is used by the command parser to join extra parameters into one last param.
 101          * If not set, no munging is done to this command.
 102          */
 103         const unsigned int max_params;
 104
 105         /** used by /stats m
 106          */
 107         long double use_count;
 108
 109         /** used by /stats m
 110          */
 111         long double total_bytes;
 112
 113         /** True if the command is disabled to non-opers
 114          */
 115         bool disabled;
 116
 117         /** True if the command can be issued before registering
 118          */
 119         bool works_before_reg;
 120
 121         /** Syntax string for the command, displayed if non-empty string.
 122          * This takes place of the text in the 'not enough parameters' numeric.
 123          */
 124         std::string syntax;
 125
 126         /** Translation type list for possible parameters, used to tokenize
 127          * parameters into UIDs and SIDs etc.
 128          */
 129         std::vector<TranslateType> translation;
 130
 131         /** How many seconds worth of penalty does this command have?
 132          */
 133         int Penalty;
 134
 135         /** Create a new command.
 136          * @param Instance Pointer to creator class
 137          * @param cmd Command name. This must be UPPER CASE.
 138          * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up.
 139          * For oper only commands, set this to 'o', otherwise use 0.
 140          * @param minpara Minimum parameters required for the command.
 141          * @param maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
 142          * @param before_reg If this is set to true, the command will
 143          * be allowed before the user is 'registered' (has sent USER,
 144          * NICK, optionally PASS, and been resolved).
 145          */
 146         Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
 147                 ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
 148                 use_count(0), total_bytes(0), disabled(false), works_before_reg(false), Penalty(1)
 149         {
 150         }
 151
 152         /** Handle the command from a user.
 153          * @param parameters The parameters for the command.
 154          * @param user The user who issued the command.
 155          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 156          */
 157         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 158
 159         virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 160         {
 161                 return ROUTE_LOCALONLY;
 162         }
 163
 164         /** Encode a parameter for server->server transmission.
 165          * Used for parameters for which the translation type is TR_CUSTOM.
 166          * @param parameter The parameter to encode. Can be modified in place.
 167          * @param index The parameter index (0 == first parameter).
 168          */
 169         virtual void EncodeParameter(std::string& parameter, int index)
 170         {
 171         }
 172
 173         /** Decode a parameter from server->server transmission.
 174          * Not currently used in this version of InspIRCd.
 175          * Used for parameters for which the translation type is TR_CUSTOM.
 176          * @param parameter The parameter to decode. Can be modified in place.
 177          * @param index The parameter index (0 == first parameter).
 178          */
 179         virtual void DecodeParameter(std::string& parameter, int index)
 180         {
 181         }
 182
 183         /** Disable or enable this command.
 184          * @param setting True to disable the command.
 185          */
 186         void Disable(bool setting)
 187         {
 188                 disabled = setting;
 189         }
 190
 191         /** Obtain this command's disable state.
 192          * @return true if the command is currently disabled
 193          * (disabled commands can be used only by operators)
 194          */
 195         bool IsDisabled()
 196         {
 197                 return disabled;
 198         }
 199
 200         /** @return true if the command works before registration.
 201          */
 202         bool WorksBeforeReg()
 203         {
 204                 return works_before_reg;
 205         }
 206
 207         virtual ~Command();
 208 };
 209
 210 class CoreExport SplitCommand : public Command
 211 {
 212  public:
 213         SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0)
 214                 : Command(me, cmd, minpara, maxpara) {}
 215         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user);
 216         virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
 217         virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
 218         virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
 219 };
 220
 221 /** Shortcut macros for defining translation lists
 222  */
 223 #define TRANSLATE1(x1)  translation.push_back(x1);
 224 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 225 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
 226 #define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
 227 #define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 228         translation.push_back(x5);
 229 #define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 230         translation.push_back(x5);translation.push_back(x6);
 231 #define TRANSLATE7(x1,x2,x3,x4,x5,x6,x7)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 232         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
 233 #define TRANSLATE8(x1,x2,x3,x4,x5,x6,x7,x8)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 234         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
 235
 236 #endif