include/command_parse.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
   5  *   Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services>
   6  *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
   7  *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
   8  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   9  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
  10  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  11  *   Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  12  *
  13  * This file is part of InspIRCd.  InspIRCd is free software: you can
  14  * redistribute it and/or modify it under the terms of the GNU General Public
  15  * License as published by the Free Software Foundation, version 2.
  16  *
  17  * This program is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  19  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  20  * details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26
  27 #pragma once
  28
  29 /** This class handles command management and parsing.
  30  * It allows you to add and remove commands from the map,
  31  * call command handlers by name, and chop up comma separated
  32  * parameters into multiple calls.
  33  */
  34 class CoreExport CommandParser
  35 {
  36  public:
  37         typedef TR1NS::unordered_map<std::string, Command*, irc::insensitive, irc::StrHashComp> CommandMap;
  38
  39  private:
  40         /** Process a command from a user.
  41          * @param user The user to parse the command for.
  42          * @param command The name of the command.
  43          * @param parameters The parameters to the command.
  44          */
  45         void ProcessCommand(LocalUser* user, std::string& command, CommandBase::Params& parameters);
  46
  47         /** Command list, a hash_map of command names to Command*
  48          */
  49         CommandMap cmdlist;
  50
  51  public:
  52         /** Default constructor.
  53          */
  54         CommandParser();
  55
  56         /** Get a command name -> Command* map containing all client to server commands
  57          * @return A map of command handlers keyed by command names
  58          */
  59         const CommandMap& GetCommands() const { return cmdlist; }
  60
  61         /** Calls the handler for a given command.
  62          * @param commandname The command to find. This should be in uppercase.
  63          * @param parameters Parameter list
  64          * @param user The user to call the handler on behalf of
  65          * @param cmd If non-NULL and the command was executed it is set to the command handler,
  66          * otherwise it isn't written to.
  67          * @return This method will return CMD_SUCCESS if the command handler was found and called,
  68          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
  69          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
  70          * command simply did not exist at all or the wrong number of parameters were given, or the user
  71          * was not privilaged enough to execute the command.
  72          */
  73         CmdResult CallHandler(const std::string& commandname, const CommandBase::Params& parameters, User* user, Command** cmd = NULL);
  74
  75         /** Get the handler function for a command.
  76          * @param commandname The command required. Always use uppercase for this parameter.
  77          * @return a pointer to the command handler, or NULL
  78          */
  79         Command* GetHandler(const std::string &commandname);
  80
  81         /** LoopCall is used to call a command handler repeatedly based on the contents of a comma separated list.
  82          * There are two ways to call this method, either with one potential list or with two potential lists.
  83          * We need to handle two potential lists for JOIN, because a JOIN may contain two lists of items at once:
  84          * the channel names and their keys as follows:
  85          *
  86          * JOIN \#chan1,\#chan2,\#chan3 key1,,key3
  87          *
  88          * Therefore, we need to deal with both lists concurrently. If there are two lists then the method reads
  89          * them both together until the first runs out of tokens.
  90          * With one list it is much simpler, and is used in NAMES, WHOIS, PRIVMSG etc.
  91          *
  92          * If there is only one list and there are duplicates in it, then the command handler is only called for
  93          * unique items. Entries are compared using "irc comparison".
  94          * If the usemax parameter is true (the default) the function only parses until it reaches
  95          * ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
  96          *
  97          * The OnPostCommand hook is executed for each item after it has been processed by the handler, with the
  98          * original line parameter being empty (to indicate that the command in that form was created by this function).
  99          * This only applies if the user executing the command is local.
 100          *
 101          * If there are two lists and the second list runs out of tokens before the first list then parameters[extra]
 102          * will be an EMPTY string when Handle() is called for the remaining tokens in the first list, even if it is
 103          * in the middle of parameters[]! Moreover, empty tokens in the second list are allowed, and those will also
 104          * result in the appropriate entry being empty in parameters[].
 105          * This is different than what command handlers usually expect; the command parser only allows an empty param
 106          * as the last item in the vector.
 107          *
 108          * @param user The user who sent the command
 109          * @param handler The command handler to call for each parameter in the list
 110          * @param parameters Parameter list as a vector of strings
 111          * @param splithere The first parameter index to split as a comma separated list
 112          * @param extra The second parameter index to split as a comma separated list, or -1 (the default) if there is only one list
 113          * @param usemax True to limit the command to MaxTargets targets (default), or false to process all tokens
 114          * @return This function returns true when it identified a list in the given parameter and finished calling the
 115          * command handler for each entry on the list. When this occurs, the caller should return without doing anything,
 116          * otherwise it should continue into its main section of code.
 117          */
 118         static bool LoopCall(User* user, Command* handler, const CommandBase::Params& parameters, unsigned int splithere, int extra = -1, bool usemax = true);
 119
 120         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 121          * @param buffer The buffer line to process
 122          * @param user The user to whom this line belongs
 123          */
 124         void ProcessBuffer(LocalUser* user, const std::string& buffer);
 125
 126         /** Add a new command to the commands hash
 127          * @param f The new Command to add to the list
 128          * @return True if the command was added
 129          */
 130         bool AddCommand(Command *f);
 131
 132         /** Removes a command.
 133          */
 134         void RemoveCommand(Command* x);
 135
 136         /** Translate a single item based on the TranslationType given.
 137          * @param to The translation type to use for the process
 138          * @param item The input string
 139          * @param dest The output string. The translation result will be appended to this string
 140          * @param custom_translator Used to translate the parameter if the translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
 141          * @param paramnumber The index of the parameter we are translating.
 142          */
 143         static void TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator = NULL, unsigned int paramnumber = 0);
 144
 145         /** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
 146          * @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
 147          * @param source The strings to translate
 148          * @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
 149          * @param custom_translator Used to translate the parameter if the translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
 150          * @return dest The output string
 151          */
 152         static std::string TranslateUIDs(const std::vector<TranslateType>& to, const CommandBase::Params& source, bool prefix_final = false, CommandBase* custom_translator = NULL);
 153 };