include/command_parse.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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 __COMMAND_PARSE_H
  15 #define __COMMAND_PARSE_H
  16
  17 #include <string>
  18 #include "users.h"
  19 #include "ctables.h"
  20 #include "typedefs.h"
  21
  22 /** Required forward declaration
  23  */
  24 class InspIRCd;
  25
  26 /** A list of dll/so files containing the command handlers for the core
  27  */
  28 typedef std::map<std::string, void*> SharedObjectList;
  29
  30 /** This class handles command management and parsing.
  31  * It allows you to add and remove commands from the map,
  32  * call command handlers by name, and chop up comma seperated
  33  * parameters into multiple calls.
  34  */
  35 class CoreExport CommandParser : public classbase
  36 {
  37  private:
  38         /** The creator of this class
  39          */
  40         InspIRCd* ServerInstance;
  41
  42         /** Parameter buffer
  43          */
  44         std::vector<std::string> para;
  45
  46         /** Process a parameter string into a list of items
  47          * @param command_p The output list of items
  48          * @param parameters The input string
  49          * @return The number of parameters parsed into command_p
  50          */
  51         int ProcessParameters(char **command_p,char *parameters);
  52
  53         /** Process a command from a user.
  54          * @param user The user to parse the command for
  55          * @param cmd The command string to process
  56          */
  57         void ProcessCommand(userrec *user, std::string &cmd);
  58
  59         /** Insert the default RFC1459 commands into the command hash.
  60          */
  61         void SetupCommandTable();
  62
  63         /** Finds the init_command symbol in a .so file
  64          * @param v A function pointer to be initialized
  65          * @param h A valid shared object handle
  66          * @return True if the symbol could be found
  67          */
  68         bool FindSym(void** v, void* h);
  69
  70         /** A list of core-implemented modes and their shared object handles
  71          */
  72         SharedObjectList RFCCommands;
  73
  74         /** Load a command from a shared object on disk.
  75          * @param name The shared object to load (without path)
  76          */
  77         void LoadCommand(const char* name);
  78
  79         /** Removes a command if the sources match. Used as a helper for
  80          *  safe hash_map delete while iter in RemoveCommands(const char* source).
  81          */
  82         void RemoveCommand(nspace::hash_map<std::string,command_t*>::iterator safei, const char* source);
  83
  84
  85  public:
  86         /** Command list, a hash_map of command names to command_t*
  87          */
  88         command_table cmdlist;
  89
  90         /** Reload a core command.
  91          * This will only reload commands implemented by the core,
  92          * to reload a modular command, you must reload that module.
  93          * @param cmd The command to reload. This will cause the shared
  94          * object which implements this command to be closed, and then reloaded.
  95          * @return True if the command was reloaded, false if it could not be found
  96          * or another error occured
  97          */
  98         bool ReloadCommand(const char* cmd);
  99
 100         /** Default constructor.
 101          * @param Instance The creator of this class
 102          */
 103         CommandParser(InspIRCd* Instance);
 104
 105         /** Calls the handler for a given command.
 106          * @param commandname The command to find. This should be in uppercase.
 107          * @param parameters Parameter list as an array of array of char (that's not a typo).
 108          * @param pcnt The number of items in the parameters list
 109          * @param user The user to call the handler on behalf of
 110          * @return This method will return CMD_SUCCESS if the command handler was found and called,
 111          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
 112          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
 113          * command simply did not exist at all or the wrong number of parameters were given, or the user
 114          * was not privilaged enough to execute the command.
 115          */
 116         CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
 117
 118         /** Get the handler function for a command.
 119          * @param commandname The command required. Always use uppercase for this parameter.
 120          * @return a pointer to the command handler, or NULL
 121          */
 122         command_t* GetHandler(const std::string &commandname);
 123
 124         /** This function returns true if a command is valid with the given number of parameters and user.
 125          * @param commandname The command name to check
 126          * @param pcnt The parameter count
 127          * @param user The user to check against
 128          * @return If the user given has permission to execute the command, and the parameter count is
 129          * equal to or greater than the minimum number of parameters to the given command, then this
 130          * function will return true, otherwise it will return false.
 131          */
 132         bool IsValidCommand(const std::string &commandname, int pcnt, userrec * user);
 133
 134         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
 135          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
 136          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
 137          * the channel names and their keys as follows:
 138          *
 139          * JOIN #chan1,#chan2,#chan3 key1,,key3
 140          *
 141          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
 142          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
 143          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
 144          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
 145          *
 146          * @param user The user who sent the command
 147          * @param CommandObj the command object to call for each parameter in the list
 148          * @param parameters Parameter list as an array of array of char (that's not a typo).
 149          * @param The number of items in the parameters list
 150          * @param splithere The first parameter index to split as a comma seperated list
 151          * @param extra The second parameter index to split as a comma seperated list
 152          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 153          * caller should return without doing anything, otherwise it should continue into its main section of code.
 154          */
 155         int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
 156
 157         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
 158          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
 159          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
 160          * the channel names and their keys as follows:
 161          *
 162          * JOIN #chan1,#chan2,#chan3 key1,,key3
 163          *
 164          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
 165          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
 166          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
 167          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
 168          *
 169          * @param user The user who sent the command
 170          * @param CommandObj the command object to call for each parameter in the list
 171          * @param parameters Parameter list as an array of array of char (that's not a typo).
 172          * @param The number of items in the parameters list
 173          * @param splithere The first parameter index to split as a comma seperated list
 174          * @param extra The second parameter index to split as a comma seperated list
 175          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 176          * caller should return without doing anything, otherwise it should continue into its main section of code.
 177          */
 178         int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
 179
 180         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 181          * @param buffer The buffer line to process
 182          * @param user The user to whom this line belongs
 183          */
 184         void ProcessBuffer(std::string &buffer,userrec *user);
 185
 186         /** Remove all commands relating to module 'source'.
 187          * @param source A module name which has introduced new commands
 188          * @return True This function returns true if commands were removed
 189          */
 190         bool RemoveCommands(const char* source);
 191
 192         /** Add a new command to the commands hash
 193          * @param f The new command_t to add to the list
 194          * @param so_handle The handle to the shared object where the command can be found.
 195          * Only core commands loaded via cmd_*.so files should set this parameter to anything
 196          * meaningful. Module authors should leave this parameter at its default of NULL.
 197          * @return True if the command was added
 198          */
 199         bool CreateCommand(command_t *f, void* so_handle = NULL);
 200 };
 201
 202 /** Command handler class for the RELOAD command.
 203  * A command cant really reload itself, so this has to be in here.
 204  */
 205 class cmd_reload : public command_t
 206 {
 207  public:
 208         /** Standard constructor
 209          */
 210         cmd_reload (InspIRCd* Instance) : command_t(Instance,"RELOAD",'o',1) { syntax = "<core-command>"; }
 211         /** Handle RELOAD
 212          */
 213         CmdResult Handle(const char** parameters, int pcnt, userrec *user);
 214 };
 215
 216 /** A lookup table of values for multiplier characters used by
 217  * InspIRCd::Duration(). In this lookup table, the indexes for
 218  * the ascii values 'm' and 'M' have the value '60', the indexes
 219  * for the ascii values 'D' and 'd' have a value of '86400', etc.
 220  */
 221 const int duration_multi[] =
 222 {
 223         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 224         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 225         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 226         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 227         1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
 228         1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 229         604800, 1, 31536000, 1, 1, 1, 1, 1, 1, 1, 1,
 230         1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
 231         1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31536000,
 232         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 233         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 234         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 235         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 236         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 237         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 238         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 239         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 240         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
 241 };
 242
 243 #endif
 244