X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=b57a29b4dd6ad5529d33652b0ee7236e26762067;hb=1c1c5fc3f01c42a09d34594989679bbc8fb21c0d;hp=33b4d564ce0a65e00033f8d8ef100288bcca9874;hpb=f81a2e12b09634cacd4ccf9da584c835ee71bf24;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index 33b4d564c..b57a29b4d 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,59 +2,272 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * Inspire is copyright (C) 2002-2003 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * 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. * * --------------------------------------------------- - - $Log$ - Revision 1.2 2003/01/26 23:52:59 brain - Modified documentation for base classes - Added base classes + */ + +#ifndef __CTABLES_H__ +#define __CTABLES_H__ - Revision 1.1.1.1 2003/01/23 19:45:58 brain - InspIRCd second source tree +/** 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! */ +}; - Revision 1.3 2003/01/15 22:47:44 brain - Changed user and channel structs to classes (finally) +/** 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_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */ +}; - Revision 1.2 2003/01/09 21:09:50 brain - added '/stats M' command +/** 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) + */ +enum RouteType +{ + ROUTE_TYPE_LOCALONLY, + ROUTE_TYPE_BROADCAST, + ROUTE_TYPE_UNICAST, + ROUTE_TYPE_OPT_BCAST, + ROUTE_TYPE_OPT_UCAST +}; - Revision 1.1 2003/01/07 01:02:14 brain +/** 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 + */ + const RouteType type; + /** For unicast, the destination server's name + */ + const std::string serverdest; - definitions for command table types + /** 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 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. */ -#include "inspircd_config.h" -#include "inspircd.h" -#include "base.h" +class CoreExport Command : public Extensible +{ + protected: + /** Owner/Creator object + */ + InspIRCd* ServerInstance; + public: + /** Command name + */ + std::string command; -#ifndef __CTABLES_H__ -#define __CTABLES_H__ + /** Creator module, NULL for core commands */ + Module* creator; -typedef void (handlerfunc) (char**, int, userrec*); + /** User flags needed to execute the command or 0 + */ + char flags_needed; -/* a structure that defines a command */ + /** Minimum number of parameters command takes + */ + const unsigned int min_params; -class command_t : public classbase -{ - public: - char command[MAXBUF]; /* command name */ - handlerfunc *handler_function; /* handler function as in typedef */ - char flags_needed; /* user flags needed to execute the command or 0 */ - int min_params; /* minimum number of parameters command takes */ - long use_count; /* used by /stats m */ - long total_bytes; /* used by /stats m */ + /** 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; + + /** 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; + + /** 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(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; + } + + /** 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; + + virtual RouteDescriptor GetRouting(User* user, const std::vector& parameters) + { + return ROUTE_LOCALONLY; + } + + /** 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. + */ + virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque& /* params */) + { + return CMD_INVALID; + } + + /** Handle the command from a server. + * Not currently used in this version of InspIRCd. + * @param parameters The parameters given + * @param servername The server name which issued the command + * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure. + */ + 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. + */ + 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; + } + + /** Standard constructor gubbins + */ + virtual ~Command() + { + syntax.clear(); + } }; -#endif +/** 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); +#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); +#define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4); +#define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ + translation.push_back(x5); +#define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\ + translation.push_back(x5);translation.push_back(x6); +#define TRANSLATE7(x1,x2,x3,x4,x5,x6,x7) 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); +#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