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. Every command available
45 * in InspIRCd must be defined as derived from command_t.
47 class command_t : public Extensible
50 /** Owner/Creator object
52 InspIRCd* ServerInstance;
57 /** User flags needed to execute the command or 0
60 /** Minimum number of parameters command takes
69 /** used for resource tracking between modules
72 /** True if the command is disabled to non-opers
75 /** True if the command can be issued before registering
77 bool works_before_reg;
78 /** Syntax string for the command, displayed if non-empty string.
79 * This takes place of the text in the 'not enough parameters' numeric.
83 /** Create a new command.
84 * @param Instance Pointer to creator class
85 * @param cmd Command name. This must be UPPER CASE.
86 * @param flags User modes required to execute the command.
87 * For oper only commands, set this to 'o', otherwise use 0.
88 * @param minpara Minimum parameters required for the command.
89 * @param before_reg If this is set to true, the command will
90 * be allowed before the user is 'registered' (has sent USER,
91 * NICK, optionally PASS, and been resolved).
93 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)
101 /** Handle the command from a user.
102 * @param parameters The parameters for the command.
103 * @param pcnt The number of parameters available in 'parameters'
104 * @param user The user who issued the command.
105 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
106 * If the command succeeds but should remain local to this server,
107 * return CMD_LOCALONLY.
109 virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
111 /** Handle an internal request from another command, the core, or a module
113 * @param Zero or more parameters, whos form is specified by the command ID.
114 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
115 * If the command succeeds but should remain local to this server,
116 * return CMD_LOCALONLY.
118 virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶ms)
123 /** Handle the command from a server.
124 * Not currently used in this version of InspIRCd.
125 * @param parameters The parameters given
126 * @param pcnt The number of parameters available
127 * @param servername The server name which issued the command
128 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
129 * If the command succeeds but should remain local to this server,
130 * return CMD_LOCALONLY.
132 virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
137 /** Disable or enable this command.
138 * @param setting True to disable the command.
140 void Disable(bool setting)
145 /** Obtain this command's disable state.
146 * @return true if the command is currently disabled
147 * (disabled commands can be used only by operators)
154 /** @return true if the command works before registration.
156 bool WorksBeforeReg()
158 return works_before_reg;
161 /** Standard constructor gubbins
163 virtual ~command_t() {}
166 /** A hash of commands used by the core
168 typedef nspace::hash_map<std::string,command_t*> command_table;