#pragma once
-/** Used to indicate command success codes
- */
+/** Used to indicate the result of trying to execute a command. */
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 */
+ /** The command exists but its execution failed. */
+ CMD_FAILURE = 0,
+
+ /** The command exists and its execution succeeded. */
+ CMD_SUCCESS = 1,
+
+ /* The command does not exist. */
+ CMD_INVALID = 2
};
/** Flag for commands that are only allowed from servers */
*/
std::string serverdest;
+ /** For unicast, the destination Server
+ */
+ Server* server;
+
/** Create a RouteDescriptor
*/
RouteDescriptor(RouteType t, const std::string &d)
- : type(t), serverdest(d) { }
+ : type(t), serverdest(d), server(NULL) { }
+
+ RouteDescriptor(RouteType t, Server* srv)
+ : type(t), server(srv) { }
};
/** Do not route this command */
/** A structure that defines a command. Every command available
* in InspIRCd must be defined as derived from Command.
*/
-class CoreExport Command : public ServiceProvider
+class CoreExport CommandBase : public ServiceProvider
{
public:
/** User flags needed to execute the command or 0
* @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)
- {
- }
+ CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
- /** 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;
- }
+ virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters);
/** 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)
- {
- }
+ virtual void EncodeParameter(std::string& parameter, int index);
/** Disable or enable this command.
* @param setting True to disable the command.
return works_before_reg;
}
- virtual ~Command();
+ virtual ~CommandBase();
+};
+
+class CoreExport Command : public CommandBase
+{
+ public:
+ /** If true, the command will not be forwarded by the linking module even if it comes via ENCAP.
+ * Can be used to forward commands before their effects.
+ */
+ bool force_manual_route;
+
+ Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
+
+ /** 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;
+
+ /** Register this object in the CommandParser
+ */
+ void RegisterService() CXX11_OVERRIDE;
+
+ /** Destructor
+ * Removes this command from the command parser
+ */
+ ~Command();
};
class CoreExport SplitCommand : public Command