X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=37ed92ce0dac923b83ee2c24f217d76b1e8a0d27;hb=2be4fff3e371b8add4fa6f471414e1f88418875f;hp=65b469948e32d1d2669d9e29ae02c61ed62f633f;hpb=293df6a8b55e89c127e60e92711ef0ef1027bff8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index 65b469948..37ed92ce0 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,12 +2,9 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2008 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * @@ -17,17 +14,48 @@ #ifndef __CTABLES_H__ #define __CTABLES_H__ -#include "inspircd_config.h" -#include +/** 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! */ +}; + +/** 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 */ +}; -class userrec; +/** 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 -/*typedef void (handlerfunc) (char**, int, userrec*);*/ -/** A structure that defines a command +/** A structure that defines a command. Every command available + * in InspIRCd must be defined as derived from Command. */ -class command_t +class CoreExport Command : public Extensible { + protected: + /** Owner/Creator object + */ + InspIRCd* ServerInstance; public: /** Command name */ @@ -37,29 +65,158 @@ class command_t char flags_needed; /** Minimum number of parameters command takes */ - int min_params; + unsigned int min_params; /** used by /stats m */ - long use_count; + long double use_count; /** used by /stats m */ - long total_bytes; + long double total_bytes; /** used for resource tracking between modules */ std::string source; + /** 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; - command_t(std::string cmd, char flags, int minpara) : command(cmd), flags_needed(flags), min_params(minpara) + /** 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 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, const char *flags, int minpara, int before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg), Penalty(penalty) { - use_count = total_bytes = 0; + use_count = 0; + total_bytes = 0; source = ""; + syntax = ""; + translation.clear(); } - virtual void Handle(char** parameters, int pcnt, userrec* user) = 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. + * If the command succeeds but should remain local to this server, + * return CMD_LOCALONLY. + */ + 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 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. + * If the command succeeds but should remain local to this server, + * return CMD_LOCALONLY. + */ + virtual CmdResult HandleServer(const std::vector& /* parameters */, const std::string& /* servername */) + { + return CMD_INVALID; + } - virtual ~command_t() {} + /** 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(); + } }; -typedef std::deque command_table; +/** 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