include/ctables.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *   Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #pragma once
  25
  26 /** Used to indicate command success codes
  27  */
  28 enum CmdResult
  29 {
  30         CMD_FAILURE = 0,        /* Command exists, but failed */
  31         CMD_SUCCESS = 1,        /* Command exists, and succeeded */
  32         CMD_INVALID = 2,        /* Command doesnt exist at all! */
  33         CMD_EPERM = 3       /* Command failed because of a permission check */
  34 };
  35
  36 /** Flag for commands that are only allowed from servers */
  37 const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
  38
  39 /** Translation types for translation of parameters to UIDs.
  40  * This allows the core commands to not have to be aware of how UIDs
  41  * work (making it still possible to write other linking modules which
  42  * do not use UID (but why would you want to?)
  43  */
  44 enum TranslateType
  45 {
  46         TR_TEXT,                /* Raw text, leave as-is */
  47         TR_NICK,                /* Nickname, translate to UUID for server->server */
  48         TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
  49 };
  50
  51 /** Routing types for a command. Any command which is created defaults
  52  * to having its command broadcasted on success. This behaviour may be
  53  * overridden to one of the route types shown below (see the #defines
  54  * below for more information on each one's behaviour)
  55  */
  56 enum RouteType
  57 {
  58         ROUTE_TYPE_LOCALONLY,
  59         ROUTE_TYPE_BROADCAST,
  60         ROUTE_TYPE_UNICAST,
  61         ROUTE_TYPE_MESSAGE,
  62         ROUTE_TYPE_OPT_BCAST,
  63         ROUTE_TYPE_OPT_UCAST
  64 };
  65
  66 /** Defines routing information for a command, containing a destination
  67  * server id (if applicable) and a routing type from the enum above.
  68  */
  69 struct RouteDescriptor
  70 {
  71         /** Routing type from the enum above
  72          */
  73         RouteType type;
  74         /** For unicast, the destination server's name
  75          */
  76         std::string serverdest;
  77
  78         /** Create a RouteDescriptor
  79          */
  80         RouteDescriptor(RouteType t, const std::string &d)
  81                 : type(t), serverdest(d) { }
  82 };
  83
  84 /** Do not route this command */
  85 #define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
  86 /** Route this command to all servers, fail if not understood */
  87 #define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
  88 /** Route this command to a single server (do nothing if own server name specified) */
  89 #define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
  90 /** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
  91 #define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
  92 /** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
  93 #define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
  94 /** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
  95 #define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
  96
  97 /** A structure that defines a command. Every command available
  98  * in InspIRCd must be defined as derived from Command.
  99  */
 100 class CoreExport CommandBase : public ServiceProvider
 101 {
 102  public:
 103         /** User flags needed to execute the command or 0
 104          */
 105         char flags_needed;
 106
 107         /** Minimum number of parameters command takes
 108         */
 109         const unsigned int min_params;
 110
 111         /** Maximum number of parameters command takes.
 112          * This is used by the command parser to join extra parameters into one last param.
 113          * If not set, no munging is done to this command.
 114          */
 115         const unsigned int max_params;
 116
 117         /** used by /stats m
 118          */
 119         unsigned long use_count;
 120
 121         /** True if the command is disabled to non-opers
 122          */
 123         bool disabled;
 124
 125         /** True if the command can be issued before registering
 126          */
 127         bool works_before_reg;
 128
 129         /** True if the command allows an empty last parameter.
 130          * When false and the last parameter is empty, it's popped BEFORE
 131          * checking there are enough params, etc. (i.e. the handler won't
 132          * be called if there aren't enough params after popping the empty
 133          * param).
 134          * True by default
 135          */
 136         bool allow_empty_last_param;
 137
 138         /** Syntax string for the command, displayed if non-empty string.
 139          * This takes place of the text in the 'not enough parameters' numeric.
 140          */
 141         std::string syntax;
 142
 143         /** Translation type list for possible parameters, used to tokenize
 144          * parameters into UIDs and SIDs etc.
 145          */
 146         std::vector<TranslateType> translation;
 147
 148         /** How many seconds worth of penalty does this command have?
 149          */
 150         int Penalty;
 151
 152         /** Create a new command.
 153          * @param me The module which created this command.
 154          * @param cmd Command name. This must be UPPER CASE.
 155          * @param minpara Minimum parameters required for the command.
 156          * @param maxpara Maximum number of parameters this command may have - extra parameters
 157          * will be tossed into one last space-seperated param.
 158          */
 159         CommandBase(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
 160                 ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
 161                 use_count(0), disabled(false), works_before_reg(false), allow_empty_last_param(true),
 162                 Penalty(1)
 163         {
 164         }
 165
 166         virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 167         {
 168                 return ROUTE_LOCALONLY;
 169         }
 170
 171         /** Encode a parameter for server->server transmission.
 172          * Used for parameters for which the translation type is TR_CUSTOM.
 173          * @param parameter The parameter to encode. Can be modified in place.
 174          * @param index The parameter index (0 == first parameter).
 175          */
 176         virtual void EncodeParameter(std::string& parameter, int index)
 177         {
 178         }
 179
 180         /** Decode a parameter from server->server transmission.
 181          * Not currently used in this version of InspIRCd.
 182          * Used for parameters for which the translation type is TR_CUSTOM.
 183          * @param parameter The parameter to decode. Can be modified in place.
 184          * @param index The parameter index (0 == first parameter).
 185          */
 186         virtual void DecodeParameter(std::string& parameter, int index)
 187         {
 188         }
 189
 190         /** Disable or enable this command.
 191          * @param setting True to disable the command.
 192          */
 193         void Disable(bool setting)
 194         {
 195                 disabled = setting;
 196         }
 197
 198         /** Obtain this command's disable state.
 199          * @return true if the command is currently disabled
 200          * (disabled commands can be used only by operators)
 201          */
 202         bool IsDisabled()
 203         {
 204                 return disabled;
 205         }
 206
 207         /** @return true if the command works before registration.
 208          */
 209         bool WorksBeforeReg()
 210         {
 211                 return works_before_reg;
 212         }
 213
 214         virtual ~CommandBase();
 215 };
 216
 217 class CoreExport Command : public CommandBase
 218 {
 219  public:
 220         Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
 221                 : CommandBase(me, cmd, minpara, maxpara)
 222         {
 223         }
 224
 225         /** Handle the command from a user.
 226          * @param parameters The parameters for the command.
 227          * @param user The user who issued the command.
 228          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 229          */
 230         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 231
 232         /** Destructor
 233          * Removes this command from the command parser
 234          */
 235         ~Command();
 236 };
 237
 238 class CoreExport SplitCommand : public Command
 239 {
 240  public:
 241         SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0)
 242                 : Command(me, cmd, minpara, maxpara) {}
 243         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user);
 244         virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
 245         virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
 246         virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
 247 };
 248
 249 /** Shortcut macros for defining translation lists
 250  */
 251 #define TRANSLATE1(x1)  translation.push_back(x1);
 252 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 253 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
 254 #define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
 255 #define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 256         translation.push_back(x5);
 257 #define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 258         translation.push_back(x5);translation.push_back(x6);
 259 #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);\
 260         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
 261 #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);\
 262         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);