X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=1e30b22f89572f9f7f0e9d5a0f49b675cb4b85f0;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=cc80053d85de35e9c304fb5992cdabf631253368;hpb=fa452641bf37077fcda964d59e404a76e1fb13e5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index cc80053d8..1e30b22f8 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -1,28 +1,47 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * 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, 2006-2010 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * 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 + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __CTABLES_H__ -#define __CTABLES_H__ -/** Used to indicate command success codes - */ +#pragma once + +/** 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! */ + /** 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 */ +const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works + /** Translation types for translation of parameters to UIDs. * This allows the core commands to not have to be aware of how UIDs * work (making it still possible to write other linking modules which @@ -30,7 +49,6 @@ enum CmdResult */ 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 */ @@ -63,10 +81,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 */ @@ -85,19 +110,44 @@ struct RouteDescriptor /** A structure that defines a command. Every command available * in InspIRCd must be defined as derived from Command. */ -class CoreExport Command : public classbase +class CoreExport CommandBase : public ServiceProvider { public: - /** Command name - */ - const std::string command; + /** Encapsulates parameters to a command. */ + class Params : public std::vector + { + private: + /* IRCv3 message tags. */ + ClientProtocol::TagMap tags; - /** Creator module - never NULL */ - Module* const creator; + 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) + { + } - /** User flags needed to execute the command or 0 - */ - char flags_needed; + /** 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 */ @@ -109,115 +159,138 @@ class CoreExport Command : public classbase */ const unsigned int max_params; - /** used by /stats m + /** 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 */ - long double use_count; + bool allow_empty_last_param; - /** used by /stats m + /** Translation type list for possible parameters, used to tokenize + * parameters into UIDs and SIDs etc. */ - long double total_bytes; + std::vector translation; - /** True if the command is disabled to non-opers + /** 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-separated param. */ - bool disabled; + CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - /** True if the command can be issued before registering - */ - bool works_before_reg; + virtual RouteDescriptor GetRouting(User* user, const CommandBase::Params& parameters); - /** Syntax string for the command, displayed if non-empty string. - * This takes place of the text in the 'not enough parameters' numeric. + /** 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). */ - std::string syntax; + virtual void EncodeParameter(std::string& parameter, unsigned int index); - /** Translation type list for possible parameters, used to tokenize - * parameters into UIDs and SIDs etc. - */ - std::vector translation; + virtual ~CommandBase(); +}; - /** How many seconds worth of penalty does this command have? +class CoreExport Command : public CommandBase +{ + 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. */ - int Penalty; + Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - /** Create a new command. - * @param Instance Pointer to creator class - * @param cmd Command name. This must be UPPER CASE. - * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up. - * For oper only commands, set this to 'o', otherwise use 0. - * @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. - * @param before_reg If this is set to true, the command will - * be allowed before the user is 'registered' (has sent USER, - * NICK, optionally PASS, and been resolved). - */ - Command(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) : - command(cmd), creator(me), flags_needed(0), min_params(minpara), max_params(maxpara), - use_count(0), total_bytes(0), disabled(false), works_before_reg(false), Penalty(1) - { - } + 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; + + /** 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 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. + * @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(const std::vector& parameters, User* user) = 0; + virtual CmdResult Handle(User* user, const Params& parameters) = 0; - virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters) - { - return ROUTE_LOCALONLY; - } + /** Registers this command with the command parser. */ + void RegisterService() CXX11_OVERRIDE; - /** 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). + /** Tells the user they did not specify enough parameters. + * @param user The user who issued the command. + * @param parameters The parameters for the command. */ - virtual void EncodeParameter(std::string& parameter, int index) - { - } + virtual void TellNotEnoughParameters(LocalUser* user, const Params& parameters); - /** 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). + /** 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. */ - virtual void DecodeParameter(std::string& parameter, int index) - { - } + virtual void TellNotRegistered(LocalUser* user, const Params& parameters); +}; - /** Disable or enable this command. - * @param setting True to disable the command. +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. */ - void Disable(bool setting) - { - disabled = setting; - } + SplitCommand(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0); - /** Obtain this command's disable state. - * @return true if the command is currently disabled - * (disabled commands can be used only by operators) + public: + /** @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. */ - bool IsDisabled() - { - return disabled; - } + virtual CmdResult HandleLocal(LocalUser* user, const Params& parameters); - /** @return true if the command works before registration. + /** 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. */ - bool WorksBeforeReg() - { - return works_before_reg; - } + virtual CmdResult HandleRemote(RemoteUser* user, const Params& parameters); - virtual ~Command(); + /** 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); }; -/** A hash of commands used by the core - */ -typedef nspace::hash_map Commandtable; - /** Shortcut macros for defining translation lists */ #define TRANSLATE1(x1) translation.push_back(x1); @@ -232,5 +305,3 @@ typedef nspace::hash_map Commandtable; 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