include/ctables.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/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_NICKLIST,            /* Comma seperated nickname list, translate to UUIDs */
  37         TR_SPACENICKLIST,       /* Space seperated nickname list, translate to UUIDs */
  38         TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
  39 };
  40
  41 /** For commands which should not be replicated to other
  42  * servers, we usually return CMD_FAILURE. this isnt readable,
  43  * so we define this alias for CMD_FAILURE called
  44  * CMD_LOCALONLY, which of course does the same thing but is
  45  * much more readable.
  46  */
  47 #define CMD_LOCALONLY CMD_FAILURE
  48
  49
  50 /** A structure that defines a command. Every command available
  51  * in InspIRCd must be defined as derived from Command.
  52  */
  53 class CoreExport Command : public Extensible
  54 {
  55  protected:
  56         /** Owner/Creator object
  57          */
  58         InspIRCd* ServerInstance;
  59  public:
  60         /** Command name
  61         */
  62          std::string command;
  63
  64         /** User flags needed to execute the command or 0
  65          */
  66         char flags_needed;
  67
  68         /** Minimum number of parameters command takes
  69         */
  70         const unsigned int min_params;
  71
  72         /** Maximum number of parameters command takes.
  73          * This is used by the command parser to join extra parameters into one last param.
  74          * If not set, no munging is done to this command.
  75          */
  76         const unsigned int max_params;
  77
  78         /** used by /stats m
  79          */
  80         long double use_count;
  81
  82         /** used by /stats m
  83          */
  84         long double total_bytes;
  85
  86         /** used for resource tracking between modules
  87          */
  88         std::string source;
  89
  90         /** True if the command is disabled to non-opers
  91          */
  92         bool disabled;
  93
  94         /** True if the command can be issued before registering
  95          */
  96         bool works_before_reg;
  97
  98         /** Syntax string for the command, displayed if non-empty string.
  99          * This takes place of the text in the 'not enough parameters' numeric.
 100          */
 101         std::string syntax;
 102
 103         /** Translation type list for possible parameters, used to tokenize
 104          * parameters into UIDs and SIDs etc.
 105          */
 106         std::vector<TranslateType> translation;
 107
 108         /** How many seconds worth of penalty does this command have?
 109          */
 110         const int Penalty;
 111
 112         /** Create a new command.
 113          * @param Instance Pointer to creator class
 114          * @param cmd Command name. This must be UPPER CASE.
 115          * @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.
 116          * For oper only commands, set this to 'o', otherwise use 0.
 117          * @param minpara Minimum parameters required for the command.
 118          * @param maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
 119          * @param before_reg If this is set to true, the command will
 120          * be allowed before the user is 'registered' (has sent USER,
 121          * NICK, optionally PASS, and been resolved).
 122          */
 123         Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) :         ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty)
 124         {
 125                 use_count = 0;
 126                 total_bytes = 0;
 127                 source = "<core>";
 128                 syntax = "";
 129                 translation.clear();
 130         }
 131
 132         Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) :    ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
 133         {
 134                 use_count = 0;
 135                 total_bytes = 0;
 136                 source = "<core>";
 137                 syntax = "";
 138                 translation.clear();
 139         }
 140
 141         /** Handle the command from a user.
 142          * @param parameters The parameters for the command.
 143          * @param user The user who issued the command.
 144          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 145          * If the command succeeds but should remain local to this server,
 146          * return CMD_LOCALONLY.
 147          */
 148         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 149
 150         /** Handle an internal request from another command, the core, or a module
 151          * @param Command ID
 152          * @param Zero or more parameters, whos form is specified by the command ID.
 153          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 154          * If the command succeeds but should remain local to this server,
 155          * return CMD_LOCALONLY.
 156          */
 157         virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
 158         {
 159                 return CMD_INVALID;
 160         }
 161
 162         /** Handle the command from a server.
 163          * Not currently used in this version of InspIRCd.
 164          * @param parameters The parameters given
 165          * @param servername The server name which issued the command
 166          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 167          * If the command succeeds but should remain local to this server,
 168          * return CMD_LOCALONLY.
 169          */
 170         virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
 171         {
 172                 return CMD_INVALID;
 173         }
 174
 175         /** Encode a parameter for server->server transmission.
 176          * Used for parameters for which the translation type is TR_CUSTOM.
 177          * @param parameter The parameter to encode. Can be modified in place.
 178          * @param index The parameter index (0 == first parameter).
 179          */
 180         virtual void EncodeParameter(std::string& parameter, int index)
 181         {
 182         }
 183
 184         /** Decode a parameter from server->server transmission.
 185          * Not currently used in this version of InspIRCd.
 186          * Used for parameters for which the translation type is TR_CUSTOM.
 187          * @param parameter The parameter to decode. Can be modified in place.
 188          * @param index The parameter index (0 == first parameter).
 189          */
 190         virtual void DecodeParameter(std::string& parameter, int index)
 191         {
 192         }
 193
 194         /** Disable or enable this command.
 195          * @param setting True to disable the command.
 196          */
 197         void Disable(bool setting)
 198         {
 199                 disabled = setting;
 200         }
 201
 202         /** Obtain this command's disable state.
 203          * @return true if the command is currently disabled
 204          * (disabled commands can be used only by operators)
 205          */
 206         bool IsDisabled()
 207         {
 208                 return disabled;
 209         }
 210
 211         /** @return true if the command works before registration.
 212          */
 213         bool WorksBeforeReg()
 214         {
 215                 return works_before_reg;
 216         }
 217
 218         /** Standard constructor gubbins
 219          */
 220         virtual ~Command()
 221         {
 222                 syntax.clear();
 223         }
 224 };
 225
 226 /** A hash of commands used by the core
 227  */
 228 typedef nspace::hash_map<std::string,Command*> Commandtable;
 229
 230 /** Shortcut macros for defining translation lists
 231  */
 232 #define TRANSLATE1(x1)  translation.push_back(x1);
 233 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 234 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
 235 #define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
 236 #define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 237         translation.push_back(x5);
 238 #define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 239         translation.push_back(x5);translation.push_back(x6);
 240 #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);\
 241         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
 242 #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);\
 243         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
 244
 245 #endif