1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/* +------------------------------------+
* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
* InspIRCd: (C) 2002-2010 InspIRCd Development Team
* See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
#ifndef __COMMAND_PARSE_H
#define __COMMAND_PARSE_H
/** A list of dll/so files containing the command handlers for the core
*/
typedef std::map<std::string, void*> SharedObjectList;
/** This class handles command management and parsing.
* It allows you to add and remove commands from the map,
* call command handlers by name, and chop up comma seperated
* parameters into multiple calls.
*/
class CoreExport CommandParser
{
private:
/** Parameter buffer
*/
std::vector<std::string> para;
/** Process a parameter string into a list of items
* @param command_p The output list of items
* @param parameters The input string
* @return The number of parameters parsed into command_p
*/
int ProcessParameters(std::vector<std::string>& command_p, char* parameters);
/** Process a command from a user.
* @param user The user to parse the command for
* @param cmd The command string to process
*/
bool ProcessCommand(User *user, std::string &cmd);
public:
/** Command list, a hash_map of command names to Command*
*/
Commandtable cmdlist;
/** Default constructor.
* @param Instance The creator of this class
*/
CommandParser();
/** Calls the handler for a given command.
* @param commandname The command to find. This should be in uppercase.
* @param parameters Parameter list
* @param user The user to call the handler on behalf of
* @return This method will return CMD_SUCCESS if the command handler was found and called,
* and the command completeld successfully. It will return CMD_FAILURE if the command handler was found
* and called, but the command did not complete successfully, and it will return CMD_INVALID if the
* command simply did not exist at all or the wrong number of parameters were given, or the user
* was not privilaged enough to execute the command.
*/
CmdResult CallHandler(const std::string &commandname, const std::vector<std::string>& parameters, User *user);
/** Get the handler function for a command.
* @param commandname The command required. Always use uppercase for this parameter.
* @return a pointer to the command handler, or NULL
*/
Command* GetHandler(const std::string &commandname);
/** This function returns true if a command is valid with the given number of parameters and user.
* @param commandname The command name to check
* @param pcnt The parameter count
* @param user The user to check against
* @return If the user given has permission to execute the command, and the parameter count is
* equal to or greater than the minimum number of parameters to the given command, then this
* function will return true, otherwise it will return false.
*/
bool IsValidCommand(const std::string &commandname, unsigned int pcnt, User * user);
/** LoopCall is used to call a command classes handler repeatedly based on the contents of a comma seperated list.
* There are two overriden versions of this method, one of which takes two potential lists and the other takes one.
* We need a version which takes two potential lists for JOIN, because a JOIN may contain two lists of items at once,
* the channel names and their keys as follows:
*
* JOIN #chan1,#chan2,#chan3 key1,,key3
*
* Therefore, we need to deal with both lists concurrently. The first instance of this method does that by creating
* two instances of irc::commasepstream and reading them both together until the first runs out of tokens.
* The second version is much simpler and just has the one stream to read, and is used in NAMES, WHOIS, PRIVMSG etc.
* Both will only parse until they reach ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
*
* @param user The user who sent the command
* @param CommandObj the command object to call for each parameter in the list
* @param parameters Parameter list as an array of array of char (that's not a typo).
* @param The number of items in the parameters list
* @param splithere The first parameter index to split as a comma seperated list
* @param extra The second parameter index to split as a comma seperated list
* @param usemax Limit the command to MaxTargets targets
* @return This function will return 1 when there are no more parameters to process. When this occurs, its
* caller should return without doing anything, otherwise it should continue into its main section of code.
*/
int LoopCall(User* user, Command* CommandObj, const std::vector<std::string>& parameters, unsigned int splithere, unsigned int extra = -1, bool usemax = true);
/** Take a raw input buffer from a recvq, and process it on behalf of a user.
* @param buffer The buffer line to process
* @param user The user to whom this line belongs
*/
bool ProcessBuffer(std::string &buffer,User *user);
/** Process lines in a users sendq.
* @param current The user to process
* @param one_only if one_only is set only one command is processed from the sendq.
*/
void DoLines(User* current, bool one_only = false);
/** Add a new command to the commands hash
* @param f The new Command to add to the list
* @return True if the command was added
*/
bool AddCommand(Command *f);
/** Removes a command.
*/
void RemoveCommand(Command* x);
/** Translate nicknames in a string into UIDs, based on the TranslationType given.
* @param to The translation type to use for the process.
* @param source The input string
* @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
* @return returns the number of substitutions made. Will always be 0 or 1
*/
int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
/** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
* @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
* @param source The strings to translate
* @param dest The output string
* @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
* @param custom_translator Used to translate the parameter if the TR_CUSTOM type is found in to
* @return returns the number of substitutions made.
*/
int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final = false, Command* custom_translator = NULL);
};
/** A lookup table of values for multiplier characters used by
* InspIRCd::Duration(). In this lookup table, the indexes for
* the ascii values 'm' and 'M' have the value '60', the indexes
* for the ascii values 'D' and 'd' have a value of '86400', etc.
*/
const int duration_multi[] =
{
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 86400, 1, 1, 1, 3600,
1, 1, 1, 1, 60, 1, 1, 1, 1, 1, 1, 1, 1, 1,
604800, 1, 31557600, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 86400, 1, 1, 1, 3600, 1, 1, 1, 1, 60,
1, 1, 1, 1, 1, 1, 1, 1, 1, 604800, 1, 31557600,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
};
#endif
|
