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          * @return NULL on success, pointer to dlerrr() error message on failure
  77          */
  78         const char* LoadCommand(const char* name);
  79
  80         /** Removes a command if the sources match. Used as a helper for
  81          *  safe hash_map delete while iter in RemoveCommands(const char* source).
  82          */
  83         void RemoveCommand(nspace::hash_map<std::string,command_t*>::iterator safei, const char* source);
  84
  85
  86  public:
  87         /** Command list, a hash_map of command names to command_t*
  88          */
  89         command_table cmdlist;
  90
  91         /** Reload a core command.
  92          * This will only reload commands implemented by the core,
  93          * to reload a modular command, you must reload that module.
  94          * @param cmd The command to reload. This will cause the shared
  95          * object which implements this command to be closed, and then reloaded.
  96          * @return True if the command was reloaded, false if it could not be found
  97          * or another error occured
  98          */
  99         bool ReloadCommand(const char* cmd, userrec* user);
 100
 101         /** Default constructor.
 102          * @param Instance The creator of this class
 103          */
 104         CommandParser(InspIRCd* Instance);
 105
 106         /** Calls the handler for a given command.
 107          * @param commandname The command to find. This should be in uppercase.
 108          * @param parameters Parameter list as an array of array of char (that's not a typo).
 109          * @param pcnt The number of items in the parameters list
 110          * @param user The user to call the handler on behalf of
 111          * @return This method will return CMD_SUCCESS if the command handler was found and called,
 112          * and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
 113          * and called, but the command did not complete successfully, and it will return CMD_INVALID if the
 114          * command simply did not exist at all or the wrong number of parameters were given, or the user
 115          * was not privilaged enough to execute the command.
 116          */
 117         CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
 118
 119         /** Get the handler function for a command.
 120          * @param commandname The command required. Always use uppercase for this parameter.
 121          * @return a pointer to the command handler, or NULL
 122          */
 123         command_t* GetHandler(const std::string &commandname);
 124
 125         /** This function returns true if a command is valid with the given number of parameters and user.
 126          * @param commandname The command name to check
 127          * @param pcnt The parameter count
 128          * @param user The user to check against
 129          * @return If the user given has permission to execute the command, and the parameter count is
 130          * equal to or greater than the minimum number of parameters to the given command, then this
 131          * function will return true, otherwise it will return false.
 132          */
 133         bool IsValidCommand(const std::string &commandname, int pcnt, userrec * user);
 134
 135         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
 136          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
 137          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
 138          * the channel names and their keys as follows:
 139          *
 140          * JOIN #chan1,#chan2,#chan3 key1,,key3
 141          *
 142          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
 143          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
 144          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
 145          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
 146          *
 147          * @param user The user who sent the command
 148          * @param CommandObj the command object to call for each parameter in the list
 149          * @param parameters Parameter list as an array of array of char (that's not a typo).
 150          * @param The number of items in the parameters list
 151          * @param splithere The first parameter index to split as a comma seperated list
 152          * @param extra The second parameter index to split as a comma seperated list
 153          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 154          * caller should return without doing anything, otherwise it should continue into its main section of code.
 155          */
 156         int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
 157
 158         /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
 159          * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
 160          * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
 161          * the channel names and their keys as follows:
 162          *
 163          * JOIN #chan1,#chan2,#chan3 key1,,key3
 164          *
 165          * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
 166          * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
 167          * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
 168          * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
 169          *
 170          * @param user The user who sent the command
 171          * @param CommandObj the command object to call for each parameter in the list
 172          * @param parameters Parameter list as an array of array of char (that's not a typo).
 173          * @param The number of items in the parameters list
 174          * @param splithere The first parameter index to split as a comma seperated list
 175          * @param extra The second parameter index to split as a comma seperated list
 176          * @return This function will return 1 when there are no more parameters to process. When this occurs, its
 177          * caller should return without doing anything, otherwise it should continue into its main section of code.
 178          */
 179         int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
 180
 181         /** Take a raw input buffer from a recvq, and process it on behalf of a user.
 182          * @param buffer The buffer line to process
 183          * @param user The user to whom this line belongs
 184          */
 185         void ProcessBuffer(std::string &buffer,userrec *user);
 186
 187         /** Remove all commands relating to module 'source'.
 188          * @param source A module name which has introduced new commands
 189          * @return True This function returns true if commands were removed
 190          */
 191         bool RemoveCommands(const char* source);
 192
 193         /** Add a new command to the commands hash
 194          * @param f The new command_t to add to the list
 195          * @param so_handle The handle to the shared object where the command can be found.
 196          * Only core commands loaded via cmd_*.so files should set this parameter to anything
 197          * meaningful. Module authors should leave this parameter at its default of NULL.
 198          * @return True if the command was added
 199          */
 200         bool CreateCommand(command_t *f, void* so_handle = NULL);
 201 };
 202
 203 /** Command handler class for the RELOAD command.
 204  * A command cant really reload itself, so this has to be in here.
 205  */
 206 class cmd_reload : public command_t
 207 {
 208  public:
 209         /** Standard constructor
 210          */
 211         cmd_reload (InspIRCd* Instance) : command_t(Instance,"RELOAD",'o',1) { syntax = "<core-command>"; }
 212         /** Handle RELOAD
 213          */
 214         CmdResult Handle(const char** parameters, int pcnt, userrec *user);
 215 };
 216
 217 /** A lookup table of values for multiplier characters used by
 218  * InspIRCd::Duration(). In this lookup table, the indexes for
 219  * the ascii values 'm' and 'M' have the value '60', the indexes
 220  * for the ascii values 'D' and 'd' have a value of '86400', etc.
 221  */
 222 const int duration_multi[] =
 223 {
 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, 1, 1, 1, 1, 1, 1, 1,
 228         1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
 229         1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 230         604800, 1, 31536000, 1, 1, 1, 1, 1, 1, 1, 1,
 231         1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
 232         1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31536000,
 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, 1,
 241         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
 242 };
 243
 244 #endif
 245