#ifndef __CTABLES_H__
#define __CTABLES_H__
+
#include "inspircd_config.h"
#include "hash_map.h"
#include "base.h"
class userrec;
+class InspIRCd;
-/*typedef void (handlerfunc) (char**, int, userrec*);*/
+/** 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! */
+};
/** A structure that defines a command
*/
class command_t : public Extensible
{
+ protected:
+ InspIRCd* ServerInstance;
public:
/** Command name
*/
/** 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(const std::string &cmd, char flags, int minpara) : command(cmd), flags_needed(flags), min_params(minpara)
+ 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 = total_bytes = 0;
source = "<core>";
+ syntax = "";
}
- virtual void Handle(const char** parameters, int pcnt, userrec* user) = 0;
+ virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
+
+ virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+ {
+ return CMD_INVALID;
+ }
+
+ void Disable(bool setting)
+ {
+ disabled = setting;
+ }
+
+ bool IsDisabled()
+ {
+ return disabled;
+ }
+
+ bool WorksBeforeReg()
+ {
+ return works_before_reg;
+ }
virtual ~command_t() {}
};