X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=cc80053d85de35e9c304fb5992cdabf631253368;hb=fa452641bf37077fcda964d59e404a76e1fb13e5;hp=d6331647554b48587c8c3d3b11a9360d0708c92d;hpb=e4acbc95b8b6cd5b28d38a2242c02e8ff4991e4a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index d63316475..cc80053d8 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,153 +2,189 @@ * | 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 { CMD_FAILURE = 0, /* Command exists, but failed */ CMD_SUCCESS = 1, /* Command exists, and succeeded */ - CMD_INVALID = 2, /* Command doesnt exist at all! */ - CMD_USER_DELETED = 3 /* User was deleted - DEPRECIATED */ + CMD_INVALID = 2 /* Command doesnt exist at all! */ }; +/** 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. +/** Routing types for a command. Any command which is created defaults + * to having its command broadcasted on success. This behaviour may be + * overridden to one of the route types shown below (see the #defines + * below for more information on each one's behaviour) */ -#define CMD_LOCALONLY CMD_FAILURE +enum RouteType +{ + ROUTE_TYPE_LOCALONLY, + ROUTE_TYPE_BROADCAST, + ROUTE_TYPE_UNICAST, + ROUTE_TYPE_MESSAGE, + ROUTE_TYPE_OPT_BCAST, + ROUTE_TYPE_OPT_UCAST +}; +/** Defines routing information for a command, containing a destination + * server id (if applicable) and a routing type from the enum above. + */ +struct RouteDescriptor +{ + /** Routing type from the enum above + */ + RouteType type; + /** For unicast, the destination server's name + */ + std::string serverdest; + + /** Create a RouteDescriptor + */ + 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 as a message with the given target (any of user, #channel, @#channel, $servermask) */ +#define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x)) +/** Route this command to all servers wrapped via ENCAP, so ignored if not understood */ +#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, "")) +/** Route this command to a single server wrapped via ENCAP, so ignored 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. */ -class CoreExport Command : public Extensible +class CoreExport Command : public classbase { - protected: - /** Owner/Creator object - */ - InspIRCd* ServerInstance; public: /** Command name */ - std::string command; + const std::string command; + + /** Creator module - never NULL */ + Module* const 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? */ - const int Penalty; + int Penalty; /** 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(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) { - 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; - /** Handle an internal request from another command, the core, or a module - * @param Command ID - * @param Zero or more parameters, whos form is specified by the command ID. - * @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 RouteDescriptor GetRouting(User* user, const std::vector& parameters) + { + return ROUTE_LOCALONLY; + } + + /** 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 CmdResult HandleInternal(const unsigned int /* id */, const std::deque& /* params */) + virtual void EncodeParameter(std::string& parameter, int index) { - return CMD_INVALID; } - /** Handle the command from a server. + /** Decode a parameter from server->server transmission. * 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. + * 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 CmdResult HandleServer(const char** /* parameters */, int /* pcnt */, const std::string& /* servername */) + virtual void DecodeParameter(std::string& parameter, int index) { - return CMD_INVALID; } /** Disable or enable this command. @@ -175,15 +211,15 @@ class CoreExport Command : public Extensible return works_before_reg; } - /** Standard constructor gubbins - */ - virtual ~Command() {} + virtual ~Command(); }; /** 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); @@ -198,4 +234,3 @@ typedef nspace::hash_map Commandable; translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8); #endif -