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 /** This class handles command management and parsing.
28 * It allows you to add and remove commands from the map,
29 * call command handlers by name, and chop up comma seperated
30 * parameters into multiple calls.
32 class CommandParser : public classbase
35 /** The creator of this class
37 InspIRCd* ServerInstance;
39 /** Process a parameter string into a list of items
40 * @param command_p The output list of items
41 * @param parameters The input string
42 * @return The number of parameters parsed into command_p
44 int ProcessParameters(char **command_p,char *parameters);
46 /** Process a command from a user.
47 * @param user The user to parse the command for
48 * @param cmd The command string to process
50 void ProcessCommand(userrec *user, std::string &cmd);
52 /** Insert the default RFC1459 commands into the command hash.
54 void SetupCommandTable();
56 /** Command list, a hash_map of command names to command_t*
58 command_table cmdlist;
60 /** Default constructor.
61 * @param Instance The creator of this class
63 CommandParser(InspIRCd* Instance);
65 /** Calls the handler for a given command.
66 * @param commandname The command to find. This should be in uppercase.
67 * @param parameters Parameter list as an array of array of char (that's not a typo).
68 * @param pcnt The number of items in the parameters list
69 * @param user The user to call the handler on behalf of
70 * @return This method will return true if the command handler was found and called
72 bool CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
74 /** This function returns true if a command is valid with the given number of parameters and user.
75 * @param commandname The command name to check
76 * @param pcnt The parameter count
77 * @param user The user to check against
78 * @return If the user given has permission to execute the command, and the parameter count is
79 * equal to or greater than the minimum number of parameters to the given command, then this
80 * function will return true, otherwise it will return false.
82 bool IsValidCommand(const std::string &commandname, int pcnt, userrec * user);
84 /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
85 * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
86 * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
87 * the channel names and their keys as follows:
89 * JOIN #chan1,#chan2,#chan3 key1,,key3
91 * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
92 * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
93 * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
94 * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
96 * @param user The user who sent the command
97 * @param CommandObj the command object to call for each parameter in the list
98 * @param parameters Parameter list as an array of array of char (that's not a typo).
99 * @param The number of items in the parameters list
100 * @param splithere The first parameter index to split as a comma seperated list
101 * @param extra The second parameter index to split as a comma seperated list
102 * @return This function will return 1 when there are no more parameters to process. When this occurs, its
103 * caller should return without doing anything, otherwise it should continue into its main section of code.
105 int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
107 /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
108 * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
109 * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
110 * the channel names and their keys as follows:
112 * JOIN #chan1,#chan2,#chan3 key1,,key3
114 * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
115 * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
116 * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
117 * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
119 * @param user The user who sent the command
120 * @param CommandObj the command object to call for each parameter in the list
121 * @param parameters Parameter list as an array of array of char (that's not a typo).
122 * @param The number of items in the parameters list
123 * @param splithere The first parameter index to split as a comma seperated list
124 * @param extra The second parameter index to split as a comma seperated list
125 * @return This function will return 1 when there are no more parameters to process. When this occurs, its
126 * caller should return without doing anything, otherwise it should continue into its main section of code.
128 int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
130 /** Take a raw input buffer from a recvq, and process it on behalf of a user.
131 * @param buffer The buffer line to process
132 * @param user The user to whom this line belongs
134 void ProcessBuffer(std::string &buffer,userrec *user);
136 /** Remove all commands relating to module 'source'.
137 * @param source A module name which has introduced new commands
138 * @return True This function returns true if commands were removed
140 bool RemoveCommands(const char* source);
142 /** Add a new command to the commands hash
143 * @param f The new command_t to add to the list
144 * @return True if the command was added
146 bool CreateCommand(command_t *f);