include/command_parse.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 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 __COMMAND_PARSE_H
  15 #define __COMMAND_PARSE_H
  16
  17 /** A list of dll/so files containing the command handlers for the core
  18  */
  19 typedef std::map<std::string, void*> SharedObjectList;
  20
  21 /** This class handles command management and parsing.
  22  * It allows you to add and remove commands from the map,
  23  * call command handlers by name, and chop up comma seperated
  24  * parameters into multiple calls.
  25  */
  26 class CoreExport CommandParser
  27 {
  28  private:
  29         /** Parameter buffer
  30          */
  31         std::vector<std::string> para;
  32
  33         /** Process a parameter string into a list of items
  34          * @param command_p The output list of items
  35          * @param parameters The input string
  36          * @return The number of parameters parsed into command_p
  37          */
  38         int ProcessParameters(std::vector<std::string>& command_p, char* parameters);
  39
  40         /** Process a command from a user.
  41          * @param user The user to parse the command for
  42          * @param cmd The command string to process
  43          */
  44         bool ProcessCommand(User *user, std::string &cmd);
  45
  46
  47
  48  public:
  49         /** Command list, a hash_map of command names to Command*
  50          */
  51         Commandtable cmdlist;
  52
  53         /** Default constructor.
  54          * @param Instance The creator of this class
  55          */
  56         CommandParser();
  57
  58         /** Calls the handler for a given command.
  59          * @param commandname The command to find. This should be in uppercase.
  60          * @param parameters Parameter list
  61          * @param user The user to call the handler on behalf of
  62          * @return This method will return CMD_SUCCESS if the command handler was found and called,
  63          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
  64          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
  65          * command simply did not exist at all or the wrong number of parameters were given, or the user
  66          * was not privilaged enough to execute the command.
  67          */
  68         CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
  69
  70         /** Get the handler function for a command.
  71          * @param commandname The command required. Always use uppercase for this parameter.
  72          * @return a pointer to the command handler, or NULL
  73          */
  74         Command* GetHandler(const std::string &commandname);
  75
  76         /** This function returns true if a command is valid with the given number of parameters and user.
  77          * @param commandname The command name to check
  78          * @param pcnt The parameter count
  79          * @param user The user to check against
  80          * @return If the user given has permission to execute the command, and the parameter count is
  81          * equal to or greater than the minimum number of parameters to the given command, then this
  82          * function will return true, otherwise it will return false.
  83          */
  84         bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
  85
  86         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  87          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  88          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  89          * the channel names and their keys as follows:
  90          *
  91          * JOIN #chan1,#chan2,#chan3 key1,,key3
  92          *
  93          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  94          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  95          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  96          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  97          *
  98          * @param user The user who sent the command
  99          * @param CommandObj the command object to call for each parameter in the list
 100          * @param parameters Parameter list as an array of array of char (that's not a typo).
 101          * @param The number of items in the parameters list
 102          * @param splithere The first parameter index to split as a comma seperated list
 103          * @param extra The second parameter index to split as a comma seperated list
 104          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 105          * caller should return without doing anything, otherwise it should continue into its main section of code.
 106          */
 107         int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra);
 108
 109         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
 110          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
 111          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
 112          * the channel names and their keys as follows:
 113          *
 114          * JOIN #chan1,#chan2,#chan3 key1,,key3
 115          *
 116          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
 117          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
 118          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
 119          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
 120          *
 121          * @param user The user who sent the command
 122          * @param CommandObj the command object to call for each parameter in the list
 123          * @param parameters Parameter list as an array of array of char (that's not a typo).
 124          * @param The number of items in the parameters list
 125          * @param splithere The first parameter index to split as a comma seperated list
 126          * @param extra The second parameter index to split as a comma seperated list
 127          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 128          * caller should return without doing anything, otherwise it should continue into its main section of code.
 129          */
 130         int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere);
 131
 132         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 133          * @param buffer The buffer line to process
 134          * @param user The user to whom this line belongs
 135          */
 136         bool ProcessBuffer(std::string &buffer,User *user);
 137
 138         /** Process lines in a users sendq.
 139          * @param current The user to process
 140          * @param one_only if one_only is set only one command is processed from the sendq.
 141          */
 142         void DoLines(User* current, bool one_only = false);
 143
 144         /** Add a new command to the commands hash
 145          * @param f The new Command to add to the list
 146          * @return True if the command was added
 147          */
 148         bool AddCommand(Command *f);
 149
 150         /** Removes a command.
 151          */
 152         void RemoveCommand(Command* x);
 153
 154         /** Translate nicknames in a string into UIDs, based on the TranslationType given.
 155          * @param to The translation type to use for the process.
 156          * @param source The input string
 157          * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
 158          * @return returns the number of substitutions made. Will always be 0 or 1
 159          */
 160         int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
 161
 162         /** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
 163          * @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
 164          * @param source The strings to translate
 165          * @param dest The output string
 166          * @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
 167          * @param custom_translator Used to translate the parameter if the TR_CUSTOM type is found in to
 168          * @return returns the number of substitutions made.
 169          */
 170         int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final = false, Command* custom_translator = NULL);
 171 };
 172
 173 /** A lookup table of values for multiplier characters used by
 174  * InspIRCd::Duration(). In this lookup table, the indexes for
 175  * the ascii values 'm' and 'M' have the value '60', the indexes
 176  * for the ascii values 'D' and 'd' have a value of '86400', etc.
 177  */
 178 const int duration_multi[] =
 179 {
 180         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 181         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 182         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 183         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 184         1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
 185         1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 186         604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
 187         1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
 188         1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
 189         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 190         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 191         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 192         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 193         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 194         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 195         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 196         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 197         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
 198 };
 199
 200 #endif