include/ctables.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 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 enum TranslateType
  27 {
  28         TR_END,                 /* End of known parameters, everything after this is TR_TEXT */
  29         TR_TEXT,                /* Raw text, leave as-is */
  30         TR_NICK,                /* Nickname, translate to UUID for server->server */
  31         TR_NICKLIST,            /* Comma seperated nickname list, translate to UUIDs */
  32         TR_SPACENICKLIST        /* Space seperated nickname list, translate to UUIDs */
  33 };
  34
  35 /** For commands which should not be replicated to other
  36  * servers, we usually return CMD_FAILURE. this isnt readable,
  37  * so we define this alias for CMD_FAILURE called
  38  * CMD_LOCALONLY, which of course does the same thing but is
  39  * much more readable.
  40  */
  41 #define CMD_LOCALONLY CMD_FAILURE
  42
  43
  44 /** A structure that defines a command. Every command available
  45  * in InspIRCd must be defined as derived from Command.
  46  */
  47 class CoreExport Command : public Extensible
  48 {
  49  protected:
  50         /** Owner/Creator object
  51          */
  52         InspIRCd* ServerInstance;
  53  public:
  54         /** Command name
  55         */
  56          std::string command;
  57         /** User flags needed to execute the command or 0
  58          */
  59         char flags_needed;
  60         /** Minimum number of parameters command takes
  61         */
  62         unsigned int min_params;
  63         /** used by /stats m
  64          */
  65         long double use_count;
  66         /** used by /stats m
  67          */
  68         long double total_bytes;
  69         /** used for resource tracking between modules
  70          */
  71         std::string source;
  72         /** True if the command is disabled to non-opers
  73          */
  74         bool disabled;
  75         /** True if the command can be issued before registering
  76          */
  77         bool works_before_reg;
  78         /** Syntax string for the command, displayed if non-empty string.
  79          * This takes place of the text in the 'not enough parameters' numeric.
  80          */
  81         std::string syntax;
  82
  83         std::vector<TranslateType> translation;
  84
  85         /** How many seconds worth of penalty does this command have?
  86          */
  87         const int Penalty;
  88
  89         /** Create a new command.
  90          * @param Instance Pointer to creator class
  91          * @param cmd Command name. This must be UPPER CASE.
  92          * @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.
  93          * For oper only commands, set this to 'o', otherwise use 0.
  94          * @param minpara Minimum parameters required for the command.
  95          * @param before_reg If this is set to true, the command will
  96          * be allowed before the user is 'registered' (has sent USER,
  97          * NICK, optionally PASS, and been resolved).
  98          */
  99         Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) :  ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg),   Penalty(penalty)
 100         {
 101                 use_count = 0;
 102                 total_bytes = 0;
 103                 source = "<core>";
 104                 syntax = "";
 105                 translation.clear();
 106         }
 107
 108         /** Handle the command from a user.
 109          * @param parameters The parameters for the command.
 110          * @param user The user who issued the command.
 111          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 112          * If the command succeeds but should remain local to this server,
 113          * return CMD_LOCALONLY.
 114          */
 115         virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 116
 117         /** Handle an internal request from another command, the core, or a module
 118          * @param Command ID
 119          * @param Zero or more parameters, whos form is specified by the command ID.
 120          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 121          * If the command succeeds but should remain local to this server,
 122          * return CMD_LOCALONLY.
 123          */
 124         virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
 125         {
 126                 return CMD_INVALID;
 127         }
 128
 129         /** Handle the command from a server.
 130          * Not currently used in this version of InspIRCd.
 131          * @param parameters The parameters given
 132          * @param servername The server name which issued the command
 133          * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
 134          * If the command succeeds but should remain local to this server,
 135          * return CMD_LOCALONLY.
 136          */
 137         virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
 138         {
 139                 return CMD_INVALID;
 140         }
 141
 142         /** Disable or enable this command.
 143          * @param setting True to disable the command.
 144          */
 145         void Disable(bool setting)
 146         {
 147                 disabled = setting;
 148         }
 149
 150         /** Obtain this command's disable state.
 151          * @return true if the command is currently disabled
 152          * (disabled commands can be used only by operators)
 153          */
 154         bool IsDisabled()
 155         {
 156                 return disabled;
 157         }
 158
 159         /** @return true if the command works before registration.
 160          */
 161         bool WorksBeforeReg()
 162         {
 163                 return works_before_reg;
 164         }
 165
 166         /** Standard constructor gubbins
 167          */
 168         virtual ~Command()
 169         {
 170                 syntax.clear();
 171         }
 172 };
 173
 174 /** A hash of commands used by the core
 175  */
 176 typedef nspace::hash_map<std::string,Command*> Commandtable;
 177
 178 #define TRANSLATE1(x1)  translation.push_back(x1);
 179 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 180 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
 181 #define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
 182 #define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 183         translation.push_back(x5);
 184 #define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
 185         translation.push_back(x5);translation.push_back(x6);
 186 #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);\
 187         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
 188 #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);\
 189         translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
 190
 191 #endif
 192