X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=37ed92ce0dac923b83ee2c24f217d76b1e8a0d27;hb=9175a3799dbf1e0809fb1bb540ca715243c0be2a;hp=1464494a3960354cd8b556b52be1b9624125f20b;hpb=449bbb6e04f73685341fc22acb4b579794bd56ac;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/ctables.h b/include/ctables.h
index 1464494a3..37ed92ce0 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -23,13 +23,19 @@ enum CmdResult
 	CMD_INVALID = 2		/* Command doesnt exist at all! */
 };
 
+/** Translation types for translation of parameters to UIDs.
+ * This allows the core commands to not have to be aware of how UIDs
+ * work (making it still possible to write other linking modules which
+ * do not use UID (but why would you want to?)
+ */
 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 */
+	TR_SPACENICKLIST,	/* Space seperated nickname list, translate to UUIDs */
+	TR_CUSTOM		/* Custom translation handled by EncodeParameter/DecodeParameter */
 };
 
 /** For commands which should not be replicated to other
@@ -59,7 +65,7 @@ class CoreExport Command : public Extensible
 	char flags_needed;
 	/** Minimum number of parameters command takes
 	*/
-	int min_params;
+	unsigned int min_params;
 	/** used by /stats m
 	 */
 	long double use_count;
@@ -80,6 +86,9 @@ class CoreExport Command : public Extensible
 	 */
 	std::string syntax;
 
+	/** Translation type list for possible parameters, used to tokenize
+	 * parameters into UIDs and SIDs etc.
+	 */
 	std::vector<TranslateType> translation;
 
 	/** How many seconds worth of penalty does this command have?
@@ -96,7 +105,7 @@ class CoreExport Command : public Extensible
 	 * 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)
+	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;
@@ -107,13 +116,12 @@ class CoreExport Command : public Extensible
 
 	/** 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;
+	virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 
 	/** Handle an internal request from another command, the core, or a module
 	 * @param Command ID
@@ -130,17 +138,35 @@ class CoreExport Command : public Extensible
 	/** 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 */)
+	virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
 	{
 		return CMD_INVALID;
 	}
 
+	/** Encode a parameter for server->server transmission.
+	 * Used for parameters for which the translation type is TR_CUSTOM.
+	 * @param parameter The parameter to encode. Can be modified in place.
+	 * @param index The parameter index (0 == first parameter).
+	 */
+	virtual void EncodeParameter(std::string& parameter, int index)
+	{
+	}
+
+	/** Decode a parameter from server->server transmission.
+	 * Not currently used in this version of InspIRCd.
+	 * Used for parameters for which the translation type is TR_CUSTOM.
+	 * @param parameter The parameter to decode. Can be modified in place.
+	 * @param index The parameter index (0 == first parameter).
+	 */
+	virtual void DecodeParameter(std::string& parameter, int index)
+	{
+	}
+
 	/** Disable or enable this command.
 	 * @param setting True to disable the command.
 	 */
@@ -167,13 +193,18 @@ class CoreExport Command : public Extensible
 
 	/** Standard constructor gubbins
 	 */
-	virtual ~Command() {}
+	virtual ~Command()
+	{
+		syntax.clear();
+	}
 };
 
 /** A hash of commands used by the core
  */
-typedef nspace::hash_map<std::string,Command*> Commandable;
+typedef nspace::hash_map<std::string,Command*> Commandtable;
 
+/** Shortcut macros for defining translation lists
+ */
 #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);