#include "hash_map.h"
#include "base.h"
-class userrec;
+/* Forward declarations - required */
+class User;
class InspIRCd;
/** Used to indicate command success codes
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! */
+ CMD_USER_DELETED = 3 /* User was deleted - DEPRECIATED */
};
-/* For commands which should not be replicated to other
+enum TranslateType
+{
+ TR_END, /* End of known parameters, everything after this is TR_TEXT */
+ TR_TEXT, /* Raw text, leave as-is */
+ TR_NICK, /* Nickname, translate to UUID for server->server */
+ TR_NICKLIST, /* Comma seperated nickname list, translate to UUIDs */
+ TR_SPACENICKLIST /* Space seperated nickname list, translate to UUIDs */
+};
+
+/** For commands which should not be replicated to other
* servers, we usually return CMD_FAILURE. this isnt readable,
* so we define this alias for CMD_FAILURE called
* CMD_LOCALONLY, which of course does the same thing but is
#define CMD_LOCALONLY CMD_FAILURE
-/** A structure that defines a command
+/** A structure that defines a command. Every command available
+ * in InspIRCd must be defined as derived from Command.
*/
-class command_t : public Extensible
+class CoreExport Command : public Extensible
{
protected:
+ /** Owner/Creator object
+ */
InspIRCd* ServerInstance;
public:
/** Command name
int min_params;
/** used by /stats m
*/
- long use_count;
+ long double use_count;
/** used by /stats m
*/
- long total_bytes;
+ long double total_bytes;
/** used for resource tracking between modules
*/
std::string source;
*/
std::string syntax;
- 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)
+ 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 modes required to execute the command.
+ * 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, char flags, int minpara, int before_reg = false, int penalty = 1) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
{
- use_count = total_bytes = 0;
+ use_count = 0;
+ total_bytes = 0;
source = "<core>";
syntax = "";
+ translation.clear();
}
- virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
-
- virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶ms)
+ /** 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** 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;
}
- virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+ /** 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** /* 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;
}
- virtual ~command_t() {}
+ /** Standard constructor gubbins
+ */
+ virtual ~Command() {}
};
-typedef nspace::hash_map<std::string,command_t*> command_table;
+/** A hash of commands used by the core
+ */
+typedef nspace::hash_map<std::string,Command*> Commandable;
+
+#define TRANSLATE1(x1) translation.push_back(x1);
+#define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
+#define TRANSLATE3(x1,x2,x3) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
+#define TRANSLATE4(x1,x2,x3,x4) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
+#define TRANSLATE5(x1,x2,x3,x4,x5) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
+ translation.push_back(x5);
+#define TRANSLATE6(x1,x2,x3,x4,x5,x6) translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
+ translation.push_back(x5);translation.push_back(x6);
+#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);\
+ translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
+#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);\
+ translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
#endif
+