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 void FindSym(void** v, void* h);
59 /** Command list, a hash_map of command names to command_t*
61 command_table cmdlist;
63 void LoadCommand(const char* name);
65 /** Default constructor.
66 * @param Instance The creator of this class
68 CommandParser(InspIRCd* Instance);
70 /** Calls the handler for a given command.
71 * @param commandname The command to find. This should be in uppercase.
72 * @param parameters Parameter list as an array of array of char (that's not a typo).
73 * @param pcnt The number of items in the parameters list
74 * @param user The user to call the handler on behalf of
75 * @return This method will return true if the command handler was found and called
77 bool CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
79 /** This function returns true if a command is valid with the given number of parameters and user.
80 * @param commandname The command name to check
81 * @param pcnt The parameter count
82 * @param user The user to check against
83 * @return If the user given has permission to execute the command, and the parameter count is
84 * equal to or greater than the minimum number of parameters to the given command, then this
85 * function will return true, otherwise it will return false.
87 bool IsValidCommand(const std::string &commandname, int pcnt, userrec * user);
89 /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
90 * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
91 * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
92 * the channel names and their keys as follows:
94 * JOIN #chan1,#chan2,#chan3 key1,,key3
96 * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
97 * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
98 * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
99 * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
101 * @param user The user who sent the command
102 * @param CommandObj the command object to call for each parameter in the list
103 * @param parameters Parameter list as an array of array of char (that's not a typo).
104 * @param The number of items in the parameters list
105 * @param splithere The first parameter index to split as a comma seperated list
106 * @param extra The second parameter index to split as a comma seperated list
107 * @return This function will return 1 when there are no more parameters to process. When this occurs, its
108 * caller should return without doing anything, otherwise it should continue into its main section of code.
110 int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere, unsigned int extra);
112 /** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
113 * There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
114 * We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
115 * the channel names and their keys as follows:
117 * JOIN #chan1,#chan2,#chan3 key1,,key3
119 * Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
120 * two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
121 * The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
122 * Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
124 * @param user The user who sent the command
125 * @param CommandObj the command object to call for each parameter in the list
126 * @param parameters Parameter list as an array of array of char (that's not a typo).
127 * @param The number of items in the parameters list
128 * @param splithere The first parameter index to split as a comma seperated list
129 * @param extra The second parameter index to split as a comma seperated list
130 * @return This function will return 1 when there are no more parameters to process. When this occurs, its
131 * caller should return without doing anything, otherwise it should continue into its main section of code.
133 int LoopCall(userrec* user, command_t* CommandObj, const char** parameters, int pcnt, unsigned int splithere);
135 /** Take a raw input buffer from a recvq, and process it on behalf of a user.
136 * @param buffer The buffer line to process
137 * @param user The user to whom this line belongs
139 void ProcessBuffer(std::string &buffer,userrec *user);
141 /** Remove all commands relating to module 'source'.
142 * @param source A module name which has introduced new commands
143 * @return True This function returns true if commands were removed
145 bool RemoveCommands(const char* source);
147 /** Add a new command to the commands hash
148 * @param f The new command_t to add to the list
149 * @return True if the command was added
151 bool CreateCommand(command_t *f);