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 #pragma once
  24
  25 /** This class handles command management and parsing.
  26  * It allows you to add and remove commands from the map,
  27  * call command handlers by name, and chop up comma seperated
  28  * parameters into multiple calls.
  29  */
  30 class CoreExport CommandParser
  31 {
  32  private:
  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         void ProcessCommand(LocalUser* user, std::string& cmd);
  45
  46  public:
  47         /** Command list, a hash_map of command names to Command*
  48          */
  49         Commandtable cmdlist;
  50
  51         /** Default constructor.
  52          */
  53         CommandParser();
  54
  55         /** Calls the handler for a given command.
  56          * @param commandname The command to find. This should be in uppercase.
  57          * @param parameters Parameter list
  58          * @param user The user to call the handler on behalf of
  59          * @return This method will return CMD_SUCCESS if the command handler was found and called,
  60          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
  61          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
  62          * command simply did not exist at all or the wrong number of parameters were given, or the user
  63          * was not privilaged enough to execute the command.
  64          */
  65         CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
  66
  67         /** Get the handler function for a command.
  68          * @param commandname The command required. Always use uppercase for this parameter.
  69          * @return a pointer to the command handler, or NULL
  70          */
  71         Command* GetHandler(const std::string &commandname);
  72
  73         /** This function returns true if a command is valid with the given number of parameters and user.
  74          * @param commandname The command name to check
  75          * @param pcnt The parameter count
  76          * @param user The user to check against
  77          * @return If the user given has permission to execute the command, and the parameter count is
  78          * equal to or greater than the minimum number of parameters to the given command, then this
  79          * function will return true, otherwise it will return false.
  80          */
  81         bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
  82
  83         /** LoopCall is used to call a command handler repeatedly based on the contents of a comma seperated list.
  84          * There are two ways to call this method, either with one potential list or with two potential lists.
  85          * We need to handle two potential lists for JOIN, because a JOIN may contain two lists of items at once:
  86          * the channel names and their keys as follows:
  87          *
  88          * JOIN \#chan1,\#chan2,\#chan3 key1,,key3
  89          *
  90          * Therefore, we need to deal with both lists concurrently. If there are two lists then the method reads
  91          * them both together until the first runs out of tokens.
  92          * With one list it is much simpler, and is used in NAMES, WHOIS, PRIVMSG etc.
  93          *
  94          * If there is only one list and there are duplicates in it, then the command handler is only called for
  95          * unique items. Entries are compared using "irc comparision" (see irc::string).
  96          * If the usemax parameter is true (the default) the function only parses until it reaches
  97          * ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  98          *
  99          * The OnPostCommand hook is executed for each item after it has been processed by the handler, with the
 100          * original line parameter being empty (to indicate that the command in that form was created by this function).
 101          * This only applies if the user executing the command is local.
 102          *
 103          * If there are two lists and the second list runs out of tokens before the first list then parameters[extra]
 104          * will be an EMPTY string when Handle() is called for the remaining tokens in the first list, even if it is
 105          * in the middle of parameters[]! Moreover, empty tokens in the second list are allowed, and those will also
 106          * result in the appropiate entry being empty in parameters[].
 107          * This is different than what command handlers usually expect; the command parser only allows an empty param
 108          * as the last item in the vector.
 109          *
 110          * @param user The user who sent the command
 111          * @param handler The command handler to call for each parameter in the list
 112          * @param parameters Parameter list as a vector of strings
 113          * @param splithere The first parameter index to split as a comma seperated list
 114          * @param extra The second parameter index to split as a comma seperated list, or -1 (the default) if there is only one list
 115          * @param usemax True to limit the command to MaxTargets targets (default), or false to process all tokens
 116          * @return This function returns true when it identified a list in the given parameter and finished calling the
 117          * command handler for each entry on the list. When this occurs, the caller should return without doing anything,
 118          * otherwise it should continue into its main section of code.
 119          */
 120         static bool LoopCall(User* user, Command* handler, const std::vector<std::string>& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
 121
 122         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 123          * @param buffer The buffer line to process
 124          * @param user The user to whom this line belongs
 125          */
 126         void ProcessBuffer(std::string &buffer,LocalUser *user);
 127
 128         /** Add a new command to the commands hash
 129          * @param f The new Command to add to the list
 130          * @return True if the command was added
 131          */
 132         bool AddCommand(Command *f);
 133
 134         /** Removes a command.
 135          */
 136         void RemoveCommand(Command* x);
 137
 138         /** Translate nicknames in a string into UIDs, based on the TranslationType given.
 139          * @param to The translation type to use for the process.
 140          * @param source The input string
 141          * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
 142          * @return returns the number of substitutions made. Will always be 0 or 1
 143          */
 144         int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
 145
 146         /** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
 147          * @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
 148          * @param source The strings to translate
 149          * @param dest The output string
 150          * @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
 151          * @param custom_translator Used to translate the parameter if the TR_CUSTOM type is found in to
 152          * @return returns the number of substitutions made.
 153          */
 154         int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final = false, Command* custom_translator = NULL);
 155 };
 156
 157 /** A lookup table of values for multiplier characters used by
 158  * InspIRCd::Duration(). In this lookup table, the indexes for
 159  * the ascii values 'm' and 'M' have the value '60', the indexes
 160  * for the ascii values 'D' and 'd' have a value of '86400', etc.
 161  */
 162 const int duration_multi[] =
 163 {
 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, 1,
 167         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 168         1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
 169         1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 170         604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
 171         1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
 172         1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
 173         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 174         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 175         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 176         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 177         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 178         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 179         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 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
 182 };