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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2013-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
/** 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 separated
* parameters into multiple calls.
*/
class CoreExport CommandParser
{
public:
typedef TR1NS::unordered_map<std::string, Command*, irc::insensitive, irc::StrHashComp> CommandMap;
private:
/** Process a command from a user.
* @param user The user to parse the command for.
* @param command The name of the command.
* @param parameters The parameters to the command.
*/
void ProcessCommand(LocalUser* user, std::string& command, CommandBase::Params& parameters);
/** Command list, a hash_map of command names to Command*
*/
CommandMap cmdlist;
public:
/** Default constructor.
*/
CommandParser();
/** Get a command name -> Command* map containing all client to server commands
* @return A map of command handlers keyed by command names
*/
const CommandMap& GetCommands() const { return cmdlist; }
/** 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
* @param cmd If non-NULL and the command was executed it is set to the command handler,
* otherwise it isn't written to.
* @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 CommandBase::Params& parameters, User* user, Command** cmd = NULL);
/** 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);
/** LoopCall is used to call a command handler repeatedly based on the contents of a comma separated list.
* There are two ways to call this method, either with one potential list or with two potential lists.
* We need to handle 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. If there are two lists then the method reads
* them both together until the first runs out of tokens.
* With one list it is much simpler, and is used in NAMES, WHOIS, PRIVMSG etc.
*
* If there is only one list and there are duplicates in it, then the command handler is only called for
* unique items. Entries are compared using "irc comparison".
* If the usemax parameter is true (the default) the function only parses until it reaches
* ServerInstance->Config->MaxTargets number of targets, to stop abuse via spam.
*
* The OnPostCommand hook is executed for each item after it has been processed by the handler, with the
* original line parameter being empty (to indicate that the command in that form was created by this function).
* This only applies if the user executing the command is local.
*
* If there are two lists and the second list runs out of tokens before the first list then parameters[extra]
* will be an EMPTY string when Handle() is called for the remaining tokens in the first list, even if it is
* in the middle of parameters[]! Moreover, empty tokens in the second list are allowed, and those will also
* result in the appropriate entry being empty in parameters[].
* This is different than what command handlers usually expect; the command parser only allows an empty param
* as the last item in the vector.
*
* @param user The user who sent the command
* @param handler The command handler to call for each parameter in the list
* @param parameters Parameter list as a vector of strings
* @param splithere The first parameter index to split as a comma separated list
* @param extra The second parameter index to split as a comma separated list, or -1 (the default) if there is only one list
* @param usemax True to limit the command to MaxTargets targets (default), or false to process all tokens
* @return This function returns true when it identified a list in the given parameter and finished calling the
* command handler for each entry on the list. When this occurs, the caller should return without doing anything,
* otherwise it should continue into its main section of code.
*/
static bool LoopCall(User* user, Command* handler, const CommandBase::Params& parameters, unsigned int splithere, 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
*/
void ProcessBuffer(LocalUser* user, const std::string& buffer);
/** 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 a single item based on the TranslationType given.
* @param to The translation type to use for the process
* @param item The input string
* @param dest The output string. The translation result will be appended to this string
* @param custom_translator Used to translate the parameter if the translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
* @param paramnumber The index of the parameter we are translating.
*/
static void TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, CommandBase* custom_translator = NULL, unsigned int paramnumber = 0);
/** 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 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 translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
* @return dest The output string
*/
static std::string TranslateUIDs(const std::vector<TranslateType>& to, const CommandBase::Params& source, bool prefix_final = false, CommandBase* custom_translator = NULL);
};
|
