X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=92a0659afac915f9f9fd4d5a94c8e57589dc175b;hb=3ec7995bf4981119115d14ce2cfce0cb5795f803;hp=e422e166144c52afaa4852f4f6e139c4a8a13723;hpb=8f282762b0a90458a808e13c4a52196ebd14534a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/ctables.h b/include/ctables.h index e422e1661..92a0659af 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,38 +2,170 @@ * | 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-2007 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. * * --------------------------------------------------- */ + +#ifndef __CTABLES_H__ +#define __CTABLES_H__ + + #include "inspircd_config.h" -#include "inspircd.h" +#include "hash_map.h" #include "base.h" -#ifndef __CTABLES_H__ -#define __CTABLES_H__ +class userrec; +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! */ +}; -typedef void (handlerfunc) (char**, int, 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 -/* a structure that defines a command */ -class command_t : public classbase +/** A structure that defines a command. Every command available + * in InspIRCd must be defined as derived from command_t. + */ +class command_t : public Extensible { + protected: + /** Owner/Creator object + */ + InspIRCd* ServerInstance; 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 */ + /** Command name + */ + std::string command; + /** User flags needed to execute the command or 0 + */ + char flags_needed; + /** Minimum number of parameters command takes + */ + int min_params; + /** used by /stats m + */ + long use_count; + /** used by /stats m + */ + float 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; + + /** 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. + * 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_t(InspIRCd* Instance, const std::string &cmd, char flags, int minpara, int before_reg = false) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg) + { + use_count = 0; + total_bytes = 0; + source = ""; + syntax = ""; + } + + /** 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, userrec* 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 ¶ms) + { + return CMD_INVALID; + } + + /** 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) + { + return CMD_INVALID; + } + + /** 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_t() {} }; +/** A hash of commands used by the core + */ +typedef nspace::hash_map command_table; + #endif