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