1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 /** Used to indicate command success codes
21 CMD_FAILURE = 0, /* Command exists, but failed */
22 CMD_SUCCESS = 1, /* Command exists, and succeeded */
23 CMD_INVALID = 2 /* Command doesnt exist at all! */
26 /** Translation types for translation of parameters to UIDs.
27 * This allows the core commands to not have to be aware of how UIDs
28 * work (making it still possible to write other linking modules which
29 * do not use UID (but why would you want to?)
33 TR_END, /* End of known parameters, everything after this is TR_TEXT */
34 TR_TEXT, /* Raw text, leave as-is */
35 TR_NICK, /* Nickname, translate to UUID for server->server */
36 TR_CUSTOM /* Custom translation handled by EncodeParameter/DecodeParameter */
39 /** For commands which should not be replicated to other
40 * servers, we usually return CMD_FAILURE. this isnt readable,
41 * so we define this alias for CMD_FAILURE called
42 * CMD_LOCALONLY, which of course does the same thing but is
45 #define CMD_LOCALONLY CMD_FAILURE
48 /** A structure that defines a command. Every command available
49 * in InspIRCd must be defined as derived from Command.
51 class CoreExport Command : public Extensible
54 /** Owner/Creator object
56 InspIRCd* ServerInstance;
62 /** User flags needed to execute the command or 0
66 /** Minimum number of parameters command takes
68 const unsigned int min_params;
70 /** Maximum number of parameters command takes.
71 * This is used by the command parser to join extra parameters into one last param.
72 * If not set, no munging is done to this command.
74 const unsigned int max_params;
78 long double use_count;
82 long double total_bytes;
84 /** used for resource tracking between modules
88 /** True if the command is disabled to non-opers
92 /** True if the command can be issued before registering
94 bool works_before_reg;
96 /** Syntax string for the command, displayed if non-empty string.
97 * This takes place of the text in the 'not enough parameters' numeric.
101 /** Translation type list for possible parameters, used to tokenize
102 * parameters into UIDs and SIDs etc.
104 std::vector<TranslateType> translation;
106 /** How many seconds worth of penalty does this command have?
110 /** Create a new command.
111 * @param Instance Pointer to creator class
112 * @param cmd Command name. This must be UPPER CASE.
113 * @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.
114 * For oper only commands, set this to 'o', otherwise use 0.
115 * @param minpara Minimum parameters required for the command.
116 * @param maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
117 * @param before_reg If this is set to true, the command will
118 * be allowed before the user is 'registered' (has sent USER,
119 * NICK, optionally PASS, and been resolved).
121 Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty)
130 Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
139 /** Handle the command from a user.
140 * @param parameters The parameters for the command.
141 * @param user The user who issued the command.
142 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
143 * If the command succeeds but should remain local to this server,
144 * return CMD_LOCALONLY.
146 virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
148 /** Handle an internal request from another command, the core, or a module
150 * @param Zero or more parameters, whos form is specified by the command ID.
151 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
152 * If the command succeeds but should remain local to this server,
153 * return CMD_LOCALONLY.
155 virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
160 /** Handle the command from a server.
161 * Not currently used in this version of InspIRCd.
162 * @param parameters The parameters given
163 * @param servername The server name which issued the command
164 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
165 * If the command succeeds but should remain local to this server,
166 * return CMD_LOCALONLY.
168 virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
173 /** Encode a parameter for server->server transmission.
174 * Used for parameters for which the translation type is TR_CUSTOM.
175 * @param parameter The parameter to encode. Can be modified in place.
176 * @param index The parameter index (0 == first parameter).
178 virtual void EncodeParameter(std::string& parameter, int index)
182 /** Decode a parameter from server->server transmission.
183 * Not currently used in this version of InspIRCd.
184 * Used for parameters for which the translation type is TR_CUSTOM.
185 * @param parameter The parameter to decode. Can be modified in place.
186 * @param index The parameter index (0 == first parameter).
188 virtual void DecodeParameter(std::string& parameter, int index)
192 /** Disable or enable this command.
193 * @param setting True to disable the command.
195 void Disable(bool setting)
200 /** Obtain this command's disable state.
201 * @return true if the command is currently disabled
202 * (disabled commands can be used only by operators)
209 /** @return true if the command works before registration.
211 bool WorksBeforeReg()
213 return works_before_reg;
216 /** Standard constructor gubbins
224 /** A hash of commands used by the core
226 typedef nspace::hash_map<std::string,Command*> Commandtable;
228 /** Shortcut macros for defining translation lists
230 #define TRANSLATE1(x1) translation.push_back(x1);
231 #define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
232 #define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
233 #define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
234 #define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
235 translation.push_back(x5);
236 #define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
237 translation.push_back(x5);translation.push_back(x6);
238 #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);\
239 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
240 #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);\
241 translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);