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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
*
* 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
/** Used to indicate command success codes
*/
enum CmdResult
{
CMD_FAILURE = 0, /* Command exists, but failed */
CMD_SUCCESS = 1, /* Command exists, and succeeded */
CMD_INVALID = 2, /* Command doesnt exist at all! */
CMD_EPERM = 3 /* Command failed because of a permission check */
};
/** Flag for commands that are only allowed from servers */
const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
/** Translation types for translation of parameters to UIDs.
* This allows the core commands to not have to be aware of how UIDs
* work (making it still possible to write other linking modules which
* do not use UID (but why would you want to?)
*/
enum TranslateType
{
TR_END, /* End of known parameters, everything after this is TR_TEXT */
TR_TEXT, /* Raw text, leave as-is */
TR_NICK, /* Nickname, translate to UUID for server->server */
TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */
};
/** Routing types for a command. Any command which is created defaults
* to having its command broadcasted on success. This behaviour may be
* overridden to one of the route types shown below (see the #defines
* below for more information on each one's behaviour)
*/
enum RouteType
{
ROUTE_TYPE_LOCALONLY,
ROUTE_TYPE_BROADCAST,
ROUTE_TYPE_UNICAST,
ROUTE_TYPE_MESSAGE,
ROUTE_TYPE_OPT_BCAST,
ROUTE_TYPE_OPT_UCAST
};
/** Defines routing information for a command, containing a destination
* server id (if applicable) and a routing type from the enum above.
*/
struct RouteDescriptor
{
/** Routing type from the enum above
*/
RouteType type;
/** For unicast, the destination server's name
*/
std::string serverdest;
/** Create a RouteDescriptor
*/
RouteDescriptor(RouteType t, const std::string &d)
: type(t), serverdest(d) { }
};
/** Do not route this command */
#define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
/** Route this command to all servers, fail if not understood */
#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
/** Route this command to a single server (do nothing if own server name specified) */
#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
/** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
#define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
/** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
/** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
#define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
/** A structure that defines a command. Every command available
* in InspIRCd must be defined as derived from Command.
*/
class CoreExport Command : public ServiceProvider
{
public:
/** User flags needed to execute the command or 0
*/
char flags_needed;
/** Minimum number of parameters command takes
*/
const unsigned int min_params;
/** Maximum number of parameters command takes.
* This is used by the command parser to join extra parameters into one last param.
* If not set, no munging is done to this command.
*/
const unsigned int max_params;
/** used by /stats m
*/
unsigned long use_count;
/** True if the command is disabled to non-opers
*/
bool disabled;
/** True if the command can be issued before registering
*/
bool works_before_reg;
/** True if the command allows an empty last parameter.
* When false and the last parameter is empty, it's popped BEFORE
* checking there are enough params, etc. (i.e. the handler won't
* be called if there aren't enough params after popping the empty
* param).
* True by default
*/
bool allow_empty_last_param;
/** Syntax string for the command, displayed if non-empty string.
* This takes place of the text in the 'not enough parameters' numeric.
*/
std::string syntax;
/** Translation type list for possible parameters, used to tokenize
* parameters into UIDs and SIDs etc.
*/
std::vector<TranslateType> translation;
/** How many seconds worth of penalty does this command have?
*/
int Penalty;
/** Create a new command.
* @param me The module which created this command.
* @param cmd Command name. This must be UPPER CASE.
* @param minpara Minimum parameters required for the command.
* @param maxpara Maximum number of parameters this command may have - extra parameters
* will be tossed into one last space-seperated param.
*/
Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
use_count(0), disabled(false), works_before_reg(false), allow_empty_last_param(true),
Penalty(1)
{
}
/** Handle the command from a user.
* @param parameters The parameters for the command.
* @param user The user who issued the command.
* @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
*/
virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
{
return ROUTE_LOCALONLY;
}
/** Encode a parameter for server->server transmission.
* Used for parameters for which the translation type is TR_CUSTOM.
* @param parameter The parameter to encode. Can be modified in place.
* @param index The parameter index (0 == first parameter).
*/
virtual void EncodeParameter(std::string& parameter, int index)
{
}
/** Decode a parameter from server->server transmission.
* Not currently used in this version of InspIRCd.
* Used for parameters for which the translation type is TR_CUSTOM.
* @param parameter The parameter to decode. Can be modified in place.
* @param index The parameter index (0 == first parameter).
*/
virtual void DecodeParameter(std::string& parameter, int index)
{
}
/** Disable or enable this command.
* @param setting True to disable the command.
*/
void Disable(bool setting)
{
disabled = setting;
}
/** Obtain this command's disable state.
* @return true if the command is currently disabled
* (disabled commands can be used only by operators)
*/
bool IsDisabled()
{
return disabled;
}
/** @return true if the command works before registration.
*/
bool WorksBeforeReg()
{
return works_before_reg;
}
virtual ~Command();
};
class CoreExport SplitCommand : public Command
{
public:
SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0)
: Command(me, cmd, minpara, maxpara) {}
virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user);
virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
};
/** Shortcut macros for defining translation lists
*/
#define TRANSLATE1(x1) translation.push_back(x1);
#define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
#define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
#define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
#define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
translation.push_back(x5);
#define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
translation.push_back(x5);translation.push_back(x6);
#define TRANSLATE7(x1,x2,x3,x4,x5,x6,x7) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
#define TRANSLATE8(x1,x2,x3,x4,x5,x6,x7,x8) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
|
