X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=1c7d5b4bd5dadd1e45d619323ebab6411b71ca72;hb=15b87e3b2bddd3d9502318e9cbd1f7c9abdd0a06;hp=f016dd4c5b4fae6e30e1d2dd4f1ae26dce701fe8;hpb=def08e968b2ed922d7ee69d92d6754f858d00f57;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index f016dd4c5..1c7d5b4bd 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -21,17 +21,19 @@ */ -#ifndef CTABLES_H -#define CTABLES_H +#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 */ @@ -44,7 +46,6 @@ const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works */ 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 */ @@ -77,10 +78,17 @@ struct RouteDescriptor */ 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 */ @@ -99,12 +107,47 @@ struct RouteDescriptor /** 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: + /** Encapsulates parameters to a command. */ + class Params : public std::vector + { + private: + /* IRCv3 message tags. */ + ClientProtocol::TagMap tags; + + public: + /** Initializes a new instance from parameter and tag references. + * @param paramsref Message parameters. + * @param tagsref IRCv3 message tags. + */ + Params(const std::vector& paramsref, const ClientProtocol::TagMap& tagsref) + : std::vector(paramsref) + , tags(tagsref) + { + } + + /** Initializes a new instance from parameter iterators. + * @param first The first element in the parameter array. + * @param last The last element in the parameter array. + */ + template + Params(Iterator first, Iterator last) + : std::vector(first, last) + { + } + + /** Initializes a new empty instance. */ + Params() { } + + /** Retrieves the IRCv3 message tags. */ + const ClientProtocol::TagMap& GetTags() const { return tags; } + }; + /** User flags needed to execute the command or 0 */ - char flags_needed; + unsigned char flags_needed; /** Minimum number of parameters command takes */ @@ -118,20 +161,21 @@ class CoreExport Command : public ServiceProvider /** used by /stats m */ - long use_count; - - /** used by /stats m - */ - long total_bytes; - - /** True if the command is disabled to non-opers - */ - bool disabled; + unsigned long use_count; /** 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. */ @@ -144,7 +188,7 @@ class CoreExport Command : public ServiceProvider /** How many seconds worth of penalty does this command have? */ - int Penalty; + unsigned int Penalty; /** Create a new command. * @param me The module which created this command. @@ -153,79 +197,63 @@ class CoreExport Command : public ServiceProvider * @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), total_bytes(0), disabled(false), works_before_reg(false), 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& parameters, User* user) = 0; + CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters) - { - return ROUTE_LOCALONLY; - } + virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& 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) - { - } + virtual void EncodeParameter(std::string& parameter, unsigned 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). + /** @return true if the command works before registration. */ - virtual void DecodeParameter(std::string& parameter, int index) + bool WorksBeforeReg() { + return works_before_reg; } - /** Disable or enable this command. - * @param setting True to disable the 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. */ - void Disable(bool setting) - { - disabled = setting; - } + bool force_manual_route; - /** Obtain this command's disable state. - * @return true if the command is currently disabled - * (disabled commands can be used only by operators) + 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. */ - bool IsDisabled() - { - return disabled; - } + virtual CmdResult Handle(User* user, const Params& parameters) = 0; - /** @return true if the command works before registration. + /** Register this object in the CommandParser */ - bool WorksBeforeReg() - { - return works_before_reg; - } + void RegisterService() CXX11_OVERRIDE; - virtual ~Command(); + /** Destructor + * Removes this command from the command parser + */ + ~Command(); }; class CoreExport SplitCommand : public Command { public: - SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) + SplitCommand(Module* me, const std::string &cmd, unsigned int minpara = 0, unsigned int maxpara = 0) : Command(me, cmd, minpara, maxpara) {} - virtual CmdResult Handle(const std::vector& parameters, User* user); - virtual CmdResult HandleLocal(const std::vector& parameters, LocalUser* user); - virtual CmdResult HandleRemote(const std::vector& parameters, RemoteUser* user); - virtual CmdResult HandleServer(const std::vector& parameters, FakeUser* user); + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE; + virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters); + virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters); + virtual CmdResult HandleServer(FakeUser* user, const Params& parameters); }; /** Shortcut macros for defining translation lists @@ -242,5 +270,3 @@ class CoreExport SplitCommand : public Command 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); - -#endif