include/command_parse.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #ifndef COMMAND_PARSE_H
  24 #define COMMAND_PARSE_H
  25
  26 /** This class handles command management and parsing.
  27  * It allows you to add and remove commands from the map,
  28  * call command handlers by name, and chop up comma seperated
  29  * parameters into multiple calls.
  30  */
  31 class CoreExport CommandParser
  32 {
  33  private:
  34         /** Process a parameter string into a list of items
  35          * @param command_p The output list of items
  36          * @param parameters The input string
  37          * @return The number of parameters parsed into command_p
  38          */
  39         int ProcessParameters(std::vector<std::string>& command_p, char* parameters);
  40
  41         /** Process a command from a user.
  42          * @param user The user to parse the command for
  43          * @param cmd The command string to process
  44          */
  45         bool ProcessCommand(LocalUser *user, std::string &cmd);
  46
  47  public:
  48         /** Command list, a hash_map of command names to Command*
  49          */
  50         Commandtable cmdlist;
  51
  52         /** Default constructor.
  53          */
  54         CommandParser();
  55
  56         /** Calls the handler for a given command.
  57          * @param commandname The command to find. This should be in uppercase.
  58          * @param parameters Parameter list
  59          * @param user The user to call the handler on behalf of
  60          * @return This method will return CMD_SUCCESS if the command handler was found and called,
  61          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
  62          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
  63          * command simply did not exist at all or the wrong number of parameters were given, or the user
  64          * was not privilaged enough to execute the command.
  65          */
  66         CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
  67
  68         /** Get the handler function for a command.
  69          * @param commandname The command required. Always use uppercase for this parameter.
  70          * @return a pointer to the command handler, or NULL
  71          */
  72         Command* GetHandler(const std::string &commandname);
  73
  74         /** This function returns true if a command is valid with the given number of parameters and user.
  75          * @param commandname The command name to check
  76          * @param pcnt The parameter count
  77          * @param user The user to check against
  78          * @return If the user given has permission to execute the command, and the parameter count is
  79          * equal to or greater than the minimum number of parameters to the given command, then this
  80          * function will return true, otherwise it will return false.
  81          */
  82         bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
  83
  84         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
  85          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
  86          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
  87          * the channel names and their keys as follows:
  88          *
  89          * JOIN \#chan1,\#chan2,\#chan3 key1,,key3
  90          *
  91          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
  92          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
  93          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
  94          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  95          *
  96          * @param user The user who sent the command
  97          * @param CommandObj the command object to call for each parameter in the list
  98          * @param parameters Parameter list as an array of array of char (that's not a typo).
  99          * @param splithere The first parameter index to split as a comma seperated list
 100          * @param extra The second parameter index to split as a comma seperated list
 101          * @param usemax Limit the command to MaxTargets targets
 102          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 103          * caller should return without doing anything, otherwise it should continue into its main section of code.
 104          */
 105         int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
 106
 107         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 108          * @param buffer The buffer line to process
 109          * @param user The user to whom this line belongs
 110          */
 111         bool ProcessBuffer(std::string &buffer,LocalUser *user);
 112
 113         /** Add a new command to the commands hash
 114          * @param f The new Command to add to the list
 115          * @return True if the command was added
 116          */
 117         bool AddCommand(Command *f);
 118
 119         /** Removes a command.
 120          */
 121         void RemoveCommand(Command* x);
 122
 123         /** Translate nicknames in a string into UIDs, based on the TranslationType given.
 124          * @param to The translation type to use for the process.
 125          * @param source The input string
 126          * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
 127          * @return returns the number of substitutions made. Will always be 0 or 1
 128          */
 129         int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
 130
 131         /** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
 132          * @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
 133          * @param source The strings to translate
 134          * @param dest The output string
 135          * @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
 136          * @param custom_translator Used to translate the parameter if the TR_CUSTOM type is found in to
 137          * @return returns the number of substitutions made.
 138          */
 139         int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final = false, Command* custom_translator = NULL);
 140 };
 141
 142 /** A lookup table of values for multiplier characters used by
 143  * InspIRCd::Duration(). In this lookup table, the indexes for
 144  * the ascii values 'm' and 'M' have the value '60', the indexes
 145  * for the ascii values 'D' and 'd' have a value of '86400', etc.
 146  */
 147 const int duration_multi[] =
 148 {
 149         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 150         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 151         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 152         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 153         1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
 154         1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 155         604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
 156         1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
 157         1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
 158         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 159         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 160         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 161         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 162         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 163         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 164         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 165         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 166         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
 167 };
 168
 169 #endif