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