X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=1e30b22f89572f9f7f0e9d5a0f49b675cb4b85f0;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=abf65f56127122f2e742b76592b3b65fdd8f23fe;hpb=0ec19b7ac91eedc83b31c3da733e237bfe28fc48;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index abf65f561..1e30b22f8 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -1,11 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2012-2015, 2018 Attila Molnar + * Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2007-2008 Robin Burchell * Copyright (C) 2007 Dennis Friis - * Copyright (C) 2003, 2007 Craig Edwards + * Copyright (C) 2003, 2006-2010 Craig Edwards * * 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 @@ -23,14 +26,17 @@ #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 */ @@ -107,9 +113,41 @@ struct RouteDescriptor class CoreExport CommandBase : public ServiceProvider { public: - /** User flags needed to execute the command or 0 - */ - char flags_needed; + /** 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; } + ClientProtocol::TagMap& GetTags() { return tags; } + }; /** Minimum number of parameters command takes */ @@ -121,18 +159,6 @@ class CoreExport CommandBase : public ServiceProvider */ 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 @@ -142,97 +168,127 @@ class CoreExport CommandBase : public ServiceProvider */ 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 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. + * will be tossed into one last space-separated param. */ CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters); + 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); - - /** 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 void EncodeParameter(std::string& parameter, unsigned int index); 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. + protected: + /** Initializes a new instance of the Command class. + * @param me The module which created this instance. + * @param cmd The name of the command. + * @param minpara The minimum number of parameters that the command accepts. + * @param maxpara The maximum number of parameters that the command accepts. */ + Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); + + public: + /** Unregisters this command from the command parser. */ + ~Command() CXX11_OVERRIDE; + + /** The user modes required to be able to execute this command. */ + unsigned char flags_needed; + + /** Whether the command will not be forwarded by the linking module even if it comes via ENCAP. */ bool force_manual_route; - Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); + /** The number of seconds worth of penalty that executing this command gives. */ + unsigned int Penalty; + + /** The number of times this command has been executed. */ + unsigned long use_count; + + /** If non-empty then the syntax of the parameter for this command. */ + std::string syntax; + + /** Whether the command can be issued before registering. */ + bool works_before_reg; /** Handle the command from a user. + * @param user The user who issued the command. * @param parameters The parameters for the command. + * @return Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID + * if the command was malformed. + */ + virtual CmdResult Handle(User* user, const Params& parameters) = 0; + + /** Registers this command with the command parser. */ + void RegisterService() CXX11_OVERRIDE; + + /** Tells the user they did not specify enough parameters. * @param user The user who issued the command. - * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. + * @param parameters The parameters for the command. */ - virtual CmdResult Handle(const std::vector& parameters, User* user) = 0; + virtual void TellNotEnoughParameters(LocalUser* user, const Params& parameters); - /** Destructor - * Removes this command from the command parser + /** Tells the user they need to be registered to execute this command. + * @param user The user who issued the command. + * @param parameters The parameters for the command. */ - ~Command(); + virtual void TellNotRegistered(LocalUser* user, const Params& parameters); }; class CoreExport SplitCommand : public Command { +protected: + /** Initializes a new instance of the SplitCommand class. + * @param me The module which created this instance. + * @param cmd The name of the command. + * @param minpara The minimum number of parameters that the command accepts. + * @param maxpara The maximum number of parameters that the command accepts. + */ + SplitCommand(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); + 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& 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); + /** @copydoc Command::Handle */ + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE; + + /** Handle the command from a local user. + * @param user The user who issued the command. + * @param parameters The parameters for the command. + * @return Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID + * if the command was malformed. + */ + virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters); + + /** Handle the command from a remote user. + * @param user The user who issued the command. + * @param parameters The parameters for the command. + * @return Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID + * if the command was malformed. + */ + virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters); + + /** Handle the command from a server user. + * @param user The user who issued the command. + * @param parameters The parameters for the command. + * @return Returns CMD_FAILURE on failure, CMD_SUCCESS on success, or CMD_INVALID + * if the command was malformed. + */ + virtual CmdResult HandleServer(FakeUser* user, const Params& parameters); }; /** Shortcut macros for defining translation lists