+ long double 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;
+
+ std::vector<TranslateType> translation;
+
+ /** How many seconds worth of penalty does this command have?
+ */
+ const int Penalty;
+
+ /** Create a new command.
+ * @param Instance Pointer to creator class
+ * @param cmd Command name. This must be UPPER CASE.
+ * @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.
+ * 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(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
+ {
+ use_count = 0;
+ total_bytes = 0;
+ source = "<core>";
+ syntax = "";
+ translation.clear();
+ }
+
+ /** 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* const* parameters, int pcnt, User* 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<classbase*>& /* params */)
+ {
+ 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* const* /* 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() {}