1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 #include "inspircd_config.h"
25 /** Used to indicate command success codes
29 CMD_FAILURE = 0, /* Command exists, but failed */
30 CMD_SUCCESS = 1, /* Command exists, and succeeded */
31 CMD_INVALID = 2, /* Command doesnt exist at all! */
32 CMD_USER_DELETED = 3, /* User was deleted! */
35 /* For commands which should not be replicated to other
36 * servers, we usually return CMD_FAILURE. this isnt readable,
37 * so we define this alias for CMD_FAILURE called
38 * CMD_LOCALONLY, which of course does the same thing but is
41 #define CMD_LOCALONLY CMD_FAILURE
44 /** A structure that defines a command
46 class command_t : public Extensible
49 InspIRCd* ServerInstance;
54 /** User flags needed to execute the command or 0
57 /** Minimum number of parameters command takes
66 /** used for resource tracking between modules
69 /** True if the command is disabled to non-opers
72 /** True if the command can be issued before registering
74 bool works_before_reg;
75 /** Syntax string for the command, displayed if non-empty string.
76 * This takes place of the text in the 'not enough parameters' numeric.
80 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)
82 use_count = total_bytes = 0;
87 virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
89 virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶ms)
94 virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
99 void Disable(bool setting)
109 bool WorksBeforeReg()
111 return works_before_reg;
114 virtual ~command_t() {}
117 typedef nspace::hash_map<std::string,command_t*> command_table;