2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2003, 2007 Craig Edwards <craigedwards@brainbox.cc>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 /** Used to indicate the result of trying to execute a command. */
29 /** The command exists but its execution failed. */
32 /** The command exists and its execution succeeded. */
35 /* The command does not exist. */
39 /** Flag for commands that are only allowed from servers */
40 const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
42 /** Translation types for translation of parameters to UIDs.
43 * This allows the core commands to not have to be aware of how UIDs
44 * work (making it still possible to write other linking modules which
45 * do not use UID (but why would you want to?)
49 TR_TEXT, /* Raw text, leave as-is */
50 TR_NICK, /* Nickname, translate to UUID for server->server */
51 TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */
54 /** Routing types for a command. Any command which is created defaults
55 * to having its command broadcasted on success. This behaviour may be
56 * overridden to one of the route types shown below (see the #defines
57 * below for more information on each one's behaviour)
69 /** Defines routing information for a command, containing a destination
70 * server id (if applicable) and a routing type from the enum above.
72 struct RouteDescriptor
74 /** Routing type from the enum above
77 /** For unicast, the destination server's name
79 std::string serverdest;
81 /** For unicast, the destination Server
85 /** Create a RouteDescriptor
87 RouteDescriptor(RouteType t, const std::string &d)
88 : type(t), serverdest(d), server(NULL) { }
90 RouteDescriptor(RouteType t, Server* srv)
91 : type(t), server(srv) { }
94 /** Do not route this command */
95 #define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
96 /** Route this command to all servers, fail if not understood */
97 #define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
98 /** Route this command to a single server (do nothing if own server name specified) */
99 #define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
100 /** Route this command as a message with the given target (any of user, #channel, @#channel, $servermask) */
101 #define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
102 /** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
103 #define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
104 /** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
105 #define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
107 /** A structure that defines a command. Every command available
108 * in InspIRCd must be defined as derived from Command.
110 class CoreExport CommandBase : public ServiceProvider
113 /** Encapsulates parameters to a command. */
114 class Params : public std::vector<std::string>
117 /* IRCv3 message tags. */
118 ClientProtocol::TagMap tags;
121 /** Initializes a new instance from parameter and tag references.
122 * @param paramsref Message parameters.
123 * @param tagsref IRCv3 message tags.
125 Params(const std::vector<std::string>& paramsref, const ClientProtocol::TagMap& tagsref)
126 : std::vector<std::string>(paramsref)
131 /** Initializes a new instance from parameter iterators.
132 * @param first The first element in the parameter array.
133 * @param last The last element in the parameter array.
135 template<typename Iterator>
136 Params(Iterator first, Iterator last)
137 : std::vector<std::string>(first, last)
141 /** Initializes a new empty instance. */
144 /** Retrieves the IRCv3 message tags. */
145 const ClientProtocol::TagMap& GetTags() const { return tags; }
148 /** User flags needed to execute the command or 0
150 unsigned char flags_needed;
152 /** Minimum number of parameters command takes
154 const unsigned int min_params;
156 /** Maximum number of parameters command takes.
157 * This is used by the command parser to join extra parameters into one last param.
158 * If not set, no munging is done to this command.
160 const unsigned int max_params;
164 unsigned long use_count;
166 /** True if the command can be issued before registering
168 bool works_before_reg;
170 /** True if the command allows an empty last parameter.
171 * When false and the last parameter is empty, it's popped BEFORE
172 * checking there are enough params, etc. (i.e. the handler won't
173 * be called if there aren't enough params after popping the empty
177 bool allow_empty_last_param;
179 /** Syntax string for the command, displayed if non-empty string.
180 * This takes place of the text in the 'not enough parameters' numeric.
184 /** Translation type list for possible parameters, used to tokenize
185 * parameters into UIDs and SIDs etc.
187 std::vector<TranslateType> translation;
189 /** How many seconds worth of penalty does this command have?
191 unsigned int Penalty;
193 /** Create a new command.
194 * @param me The module which created this command.
195 * @param cmd Command name. This must be UPPER CASE.
196 * @param minpara Minimum parameters required for the command.
197 * @param maxpara Maximum number of parameters this command may have - extra parameters
198 * will be tossed into one last space-seperated param.
200 CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
202 virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& parameters);
204 /** Encode a parameter for server->server transmission.
205 * Used for parameters for which the translation type is TR_CUSTOM.
206 * @param parameter The parameter to encode. Can be modified in place.
207 * @param index The parameter index (0 == first parameter).
209 virtual void EncodeParameter(std::string& parameter, unsigned int index);
211 /** @return true if the command works before registration.
213 bool WorksBeforeReg()
215 return works_before_reg;
218 virtual ~CommandBase();
221 class CoreExport Command : public CommandBase
224 /** If true, the command will not be forwarded by the linking module even if it comes via ENCAP.
225 * Can be used to forward commands before their effects.
227 bool force_manual_route;
229 Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
231 /** Handle the command from a user.
232 * @param parameters The parameters for the command.
233 * @param user The user who issued the command.
234 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
236 virtual CmdResult Handle(User* user, const Params& parameters) = 0;
238 /** Register this object in the CommandParser
240 void RegisterService() CXX11_OVERRIDE;
243 * Removes this command from the command parser
248 class CoreExport SplitCommand : public Command
251 SplitCommand(Module* me, const std::string &cmd, unsigned int minpara = 0, unsigned int maxpara = 0)
252 : Command(me, cmd, minpara, maxpara) {}
253 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
254 virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters);
255 virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters);
256 virtual CmdResult HandleServer(FakeUser* user, const Params& parameters);
259 /** Shortcut macros for defining translation lists
261 #define TRANSLATE1(x1) translation.push_back(x1);
262 #define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
263 #define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
264 #define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
265 #define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
266 translation.push_back(x5);
267 #define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
268 translation.push_back(x5);translation.push_back(x6);
269 #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);\
270 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
271 #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);\
272 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);