2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2012-2015, 2018 Attila Molnar <attilamolnar@hush.com>
5 * Copyright (C) 2012-2013, 2017-2018 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
7 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
8 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
9 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
10 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * Copyright (C) 2006-2010 Craig Edwards <brain@inspircd.org>
13 * This file is part of InspIRCd. InspIRCd is free software: you can
14 * redistribute it and/or modify it under the terms of the GNU General Public
15 * License as published by the Free Software Foundation, version 2.
17 * This program is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 /** Used to indicate the result of trying to execute a command. */
32 /** The command exists but its execution failed. */
35 /** The command exists and its execution succeeded. */
38 /* The command does not exist. */
42 /** Flag for commands that are only allowed from servers */
43 const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
45 /** Translation types for translation of parameters to UIDs.
46 * This allows the core commands to not have to be aware of how UIDs
47 * work (making it still possible to write other linking modules which
48 * do not use UID (but why would you want to?)
52 TR_TEXT, /* Raw text, leave as-is */
53 TR_NICK, /* Nickname, translate to UUID for server->server */
54 TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */
57 /** Routing types for a command. Any command which is created defaults
58 * to having its command broadcasted on success. This behaviour may be
59 * overridden to one of the route types shown below (see the #defines
60 * below for more information on each one's behaviour)
72 /** Defines routing information for a command, containing a destination
73 * server id (if applicable) and a routing type from the enum above.
75 struct RouteDescriptor
77 /** Routing type from the enum above
80 /** For unicast, the destination server's name
82 std::string serverdest;
84 /** For unicast, the destination Server
88 /** Create a RouteDescriptor
90 RouteDescriptor(RouteType t, const std::string &d)
91 : type(t), serverdest(d), server(NULL) { }
93 RouteDescriptor(RouteType t, Server* srv)
94 : type(t), server(srv) { }
97 /** Do not route this command */
98 #define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
99 /** Route this command to all servers, fail if not understood */
100 #define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
101 /** Route this command to a single server (do nothing if own server name specified) */
102 #define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
103 /** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
104 #define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
105 /** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
106 #define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
107 /** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
108 #define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
110 /** A structure that defines a command. Every command available
111 * in InspIRCd must be defined as derived from Command.
113 class CoreExport CommandBase : public ServiceProvider
116 /** Encapsulates parameters to a command. */
117 class Params : public std::vector<std::string>
120 /* IRCv3 message tags. */
121 ClientProtocol::TagMap tags;
124 /** Initializes a new instance from parameter and tag references.
125 * @param paramsref Message parameters.
126 * @param tagsref IRCv3 message tags.
128 Params(const std::vector<std::string>& paramsref, const ClientProtocol::TagMap& tagsref)
129 : std::vector<std::string>(paramsref)
134 /** Initializes a new instance from parameter iterators.
135 * @param first The first element in the parameter array.
136 * @param last The last element in the parameter array.
138 template<typename Iterator>
139 Params(Iterator first, Iterator last)
140 : std::vector<std::string>(first, last)
144 /** Initializes a new empty instance. */
147 /** Retrieves the IRCv3 message tags. */
148 const ClientProtocol::TagMap& GetTags() const { return tags; }
151 /** User flags needed to execute the command or 0
153 unsigned char flags_needed;
155 /** Minimum number of parameters command takes
157 const unsigned int min_params;
159 /** Maximum number of parameters command takes.
160 * This is used by the command parser to join extra parameters into one last param.
161 * If not set, no munging is done to this command.
163 const unsigned int max_params;
167 unsigned long use_count;
169 /** True if the command can be issued before registering
171 bool works_before_reg;
173 /** True if the command allows an empty last parameter.
174 * When false and the last parameter is empty, it's popped BEFORE
175 * checking there are enough params, etc. (i.e. the handler won't
176 * be called if there aren't enough params after popping the empty
180 bool allow_empty_last_param;
182 /** Syntax string for the command, displayed if non-empty string.
183 * This takes place of the text in the 'not enough parameters' numeric.
187 /** Translation type list for possible parameters, used to tokenize
188 * parameters into UIDs and SIDs etc.
190 std::vector<TranslateType> translation;
192 /** How many seconds worth of penalty does this command have?
194 unsigned int Penalty;
196 /** Create a new command.
197 * @param me The module which created this command.
198 * @param cmd Command name. This must be UPPER CASE.
199 * @param minpara Minimum parameters required for the command.
200 * @param maxpara Maximum number of parameters this command may have - extra parameters
201 * will be tossed into one last space-seperated param.
203 CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
205 virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& parameters);
207 /** Encode a parameter for server->server transmission.
208 * Used for parameters for which the translation type is TR_CUSTOM.
209 * @param parameter The parameter to encode. Can be modified in place.
210 * @param index The parameter index (0 == first parameter).
212 virtual void EncodeParameter(std::string& parameter, unsigned int index);
214 /** @return true if the command works before registration.
216 bool WorksBeforeReg()
218 return works_before_reg;
221 virtual ~CommandBase();
224 class CoreExport Command : public CommandBase
227 /** If true, the command will not be forwarded by the linking module even if it comes via ENCAP.
228 * Can be used to forward commands before their effects.
230 bool force_manual_route;
232 Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
234 /** Handle the command from a user.
235 * @param parameters The parameters for the command.
236 * @param user The user who issued the command.
237 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
239 virtual CmdResult Handle(User* user, const Params& parameters) = 0;
241 /** Register this object in the CommandParser
243 void RegisterService() CXX11_OVERRIDE;
246 * Removes this command from the command parser
251 class CoreExport SplitCommand : public Command
254 SplitCommand(Module* me, const std::string &cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
255 : Command(me, cmd, minpara, maxpara) {}
256 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
257 virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters);
258 virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters);
259 virtual CmdResult HandleServer(FakeUser* user, const Params& parameters);
262 /** Shortcut macros for defining translation lists
264 #define TRANSLATE1(x1) translation.push_back(x1);
265 #define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
266 #define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
267 #define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
268 #define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
269 translation.push_back(x5);
270 #define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
271 translation.push_back(x5);translation.push_back(x6);
272 #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);\
273 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
274 #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);\
275 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);