X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=315b38f4396e08af8b8e7fc30473fdcc6a67e587;hb=0155dd1e97f323668442d3fc07b927e8f9004dbe;hp=0bd767df0b3096b0a2f41097e50ef7256a7b8445;hpb=34fe4276bd6bc6fee5293d4817c8e36e4fffd75c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index 0bd767df0..315b38f43 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,27 +2,18 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ - + #ifndef __CTABLES_H__ #define __CTABLES_H__ - -#include "inspircd_config.h" -#include "hash_map.h" -#include "base.h" - -/* Forward declarations - required */ -class User; -class InspIRCd; - /** Used to indicate command success codes */ enum CmdResult @@ -30,25 +21,51 @@ enum CmdResult CMD_FAILURE = 0, /* Command exists, but failed */ CMD_SUCCESS = 1, /* Command exists, and succeeded */ CMD_INVALID = 2 /* Command doesnt exist at all! */ +#define CMD_LOCALONLY CMD_FAILURE }; +/** 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 + * do not use UID (but why would you want to?) + */ 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_NICKLIST, /* Comma seperated nickname list, translate to UUIDs */ - TR_SPACENICKLIST /* Space seperated nickname list, translate to UUIDs */ + TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */ }; -/** For commands which should not be replicated to other - * servers, we usually return CMD_FAILURE. this isnt readable, - * so we define this alias for CMD_FAILURE called - * CMD_LOCALONLY, which of course does the same thing but is - * much more readable. - */ -#define CMD_LOCALONLY CMD_FAILURE +enum RouteType +{ + ROUTE_TYPE_LOCALONLY, + ROUTE_TYPE_BROADCAST, + ROUTE_TYPE_UNICAST, + ROUTE_TYPE_OPT_BCAST, + ROUTE_TYPE_OPT_UCAST +}; + +struct RouteDescriptor +{ + const RouteType type; + /** For unicast, the destination server's name + */ + const std::string serverdest; + RouteDescriptor(RouteType t, const std::string d) + : type(t), serverdest(d) { } +}; +/** Do not route this command */ +#define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, "")) +/** Route this command to all servers, fail if not understood */ +#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, "")) +/** Route this command to a single server (do nothing if own server name specified) */ +#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x)) +/** Route this command to all servers, ignore if not understood */ +#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, "")) +/** Route this command to a single server, ignore if not understood */ +#define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x)) /** A structure that defines a command. Every command available * in InspIRCd must be defined as derived from Command. @@ -62,33 +79,49 @@ class CoreExport Command : public Extensible public: /** Command name */ - std::string command; + std::string command; + + /** Creator module, NULL for core commands */ + Module* creator; + /** User flags needed to execute the command or 0 */ char flags_needed; + /** Minimum number of parameters command takes */ - int min_params; + const unsigned int min_params; + + /** Maximum number of parameters command takes. + * This is used by the command parser to join extra parameters into one last param. + * If not set, no munging is done to this command. + */ + const unsigned int max_params; + /** used by /stats m */ long double use_count; + /** used by /stats m - */ - long double total_bytes; - /** used for resource tracking between modules */ - std::string source; + long double total_bytes; + /** True if the command is disabled to non-opers */ bool disabled; + /** True if the command can be issued before registering */ bool works_before_reg; + /** 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? @@ -98,31 +131,43 @@ class CoreExport Command : public Extensible /** Create a new command. * @param Instance Pointer to creator class * @param cmd Command name. This must be UPPER CASE. - * @param flags User modes required to execute the command. + * @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(InspIRCd* Instance, const std::string &cmd, char flags, int minpara, int before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg), Penalty(penalty) + Command(InspIRCd* Instance, Module* me, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) : + ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0), + min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty) + { + use_count = 0; + total_bytes = 0; + } + + Command(InspIRCd* Instance, Module* me, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) : + ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0), + min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty) { use_count = 0; total_bytes = 0; - source = ""; - syntax = ""; - translation.clear(); } /** Handle the command from a user. * @param parameters The parameters for the command. - * @param pcnt The number of parameters available in 'parameters' * @param user The user who issued the command. * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. * If the command succeeds but should remain local to this server, * return CMD_LOCALONLY. */ - virtual CmdResult Handle(const char** parameters, int pcnt, User* user) = 0; + virtual CmdResult Handle(const std::vector& parameters, User* user) = 0; + + virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters) + { + return ROUTE_BROADCAST; + } /** Handle an internal request from another command, the core, or a module * @param Command ID @@ -139,17 +184,35 @@ class CoreExport Command : public Extensible /** Handle the command from a server. * Not currently used in this version of InspIRCd. * @param parameters The parameters given - * @param pcnt The number of parameters available * @param servername The server name which issued the command * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. * If the command succeeds but should remain local to this server, * return CMD_LOCALONLY. */ - virtual CmdResult HandleServer(const char** /* parameters */, int /* pcnt */, const std::string& /* servername */) + virtual CmdResult HandleServer(const std::vector& /* parameters */, const std::string& /* servername */) { return CMD_INVALID; } + /** 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) + { + } + /** Disable or enable this command. * @param setting True to disable the command. */ @@ -176,13 +239,18 @@ class CoreExport Command : public Extensible /** Standard constructor gubbins */ - virtual ~Command() {} + virtual ~Command() + { + syntax.clear(); + } }; /** A hash of commands used by the core */ -typedef nspace::hash_map Commandable; +typedef nspace::hash_map Commandtable; +/** Shortcut macros for defining translation lists + */ #define TRANSLATE1(x1) translation.push_back(x1); #define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2); #define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3); @@ -197,4 +265,3 @@ typedef nspace::hash_map Commandable; translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8); #endif -