include/command_parse.h

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