X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=9376dbbcc4df88a2a4761079b27ad541dec90369;hb=7f7ffef3b4d5dc6242918a48713d6fab96928a80;hp=0bd8f360c921e358969c20ce19c39a582b825e97;hpb=fcacc8e0306382bc3f938073092c3729d77e2b41;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/ctables.h b/include/ctables.h
index 0bd8f360c..9376dbbcc 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -21,17 +21,19 @@
  */
 
 
-#ifndef CTABLES_H
-#define CTABLES_H
+#pragma once
 
-/** Used to indicate command success codes
- */
+/** Used to indicate the result of trying to execute a command. */
 enum CmdResult
 {
-	CMD_FAILURE = 0,	/* Command exists, but failed */
-	CMD_SUCCESS = 1,	/* Command exists, and succeeded */
-	CMD_INVALID = 2,	/* Command doesnt exist at all! */
-	CMD_EPERM = 3       /* Command failed because of a permission check */
+	/** The command exists but its execution failed. */
+	CMD_FAILURE = 0,
+
+	/** The command exists and its execution succeeded. */
+	CMD_SUCCESS = 1,
+
+	/* The command does not exist. */
+	CMD_INVALID = 2
 };
 
 /** Flag for commands that are only allowed from servers */
@@ -44,7 +46,6 @@ const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
  */
 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_CUSTOM		/* Custom translation handled by EncodeParameter/DecodeParameter */
@@ -77,10 +78,17 @@ struct RouteDescriptor
 	 */
 	std::string serverdest;
 
+	/** For unicast, the destination Server
+	 */
+	Server* server;
+
 	/** Create a RouteDescriptor
 	 */
 	RouteDescriptor(RouteType t, const std::string &d)
-		: type(t), serverdest(d) { }
+		: type(t), serverdest(d), server(NULL) { }
+
+	RouteDescriptor(RouteType t, Server* srv)
+		: type(t), server(srv) { }
 };
 
 /** Do not route this command */
@@ -99,7 +107,7 @@ struct RouteDescriptor
 /** A structure that defines a command. Every command available
  * in InspIRCd must be defined as derived from Command.
  */
-class CoreExport Command : public ServiceProvider
+class CoreExport CommandBase : public ServiceProvider
 {
  public:
 	/** User flags needed to execute the command or 0
@@ -118,11 +126,7 @@ class CoreExport Command : public ServiceProvider
 
 	/** used by /stats m
 	 */
-	long use_count;
-
-	/** used by /stats m
-	 */
-	long total_bytes;
+	unsigned long use_count;
 
 	/** True if the command is disabled to non-opers
 	 */
@@ -132,6 +136,15 @@ class CoreExport Command : public ServiceProvider
 	 */
 	bool works_before_reg;
 
+	/** True if the command allows an empty last parameter.
+	 * When false and the last parameter is empty, it's popped BEFORE
+	 * checking there are enough params, etc. (i.e. the handler won't
+	 * be called if there aren't enough params after popping the empty
+	 * param).
+	 * True by default
+	 */
+	bool allow_empty_last_param;
+
 	/** Syntax string for the command, displayed if non-empty string.
 	 * This takes place of the text in the 'not enough parameters' numeric.
 	 */
@@ -147,52 +160,22 @@ class CoreExport Command : public ServiceProvider
 	int Penalty;
 
 	/** Create a new command.
-	 * @param Instance Pointer to creator class
+	 * @param me The module which created this command.
 	 * @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 maxpara Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.
-	 * @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(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0) :
-		ServiceProvider(me, cmd, SERVICE_COMMAND), flags_needed(0), min_params(minpara), max_params(maxpara),
-		use_count(0), total_bytes(0), disabled(false), works_before_reg(false), Penalty(1)
-	{
-	}
-
-	/** Handle the command from a user.
-	 * @param parameters The parameters for the command.
-	 * @param user The user who issued the command.
-	 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+	 * @param maxpara Maximum number of parameters this command may have - extra parameters
+	 * will be tossed into one last space-seperated param.
 	 */
-	virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
+	CommandBase(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
 
-	virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
-	{
-		return ROUTE_LOCALONLY;
-	}
+	virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters);
 
 	/** 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)
-	{
-	}
+	virtual void EncodeParameter(std::string& parameter, int index);
 
 	/** Disable or enable this command.
 	 * @param setting True to disable the command.
@@ -218,7 +201,34 @@ class CoreExport Command : public ServiceProvider
 		return works_before_reg;
 	}
 
-	virtual ~Command();
+	virtual ~CommandBase();
+};
+
+class CoreExport Command : public CommandBase
+{
+ public:
+	/** If true, the command will not be forwarded by the linking module even if it comes via ENCAP.
+	 * Can be used to forward commands before their effects.
+	 */
+	bool force_manual_route;
+
+	Command(Module* me, const std::string& cmd, unsigned int minpara = 0, unsigned int maxpara = 0);
+
+	/** Handle the command from a user.
+	 * @param parameters The parameters for the command.
+	 * @param user The user who issued the command.
+	 * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+	 */
+	virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
+
+	/** Register this object in the CommandParser
+	 */
+	void RegisterService() CXX11_OVERRIDE;
+
+	/** Destructor
+	 * Removes this command from the command parser
+	 */
+	~Command();
 };
 
 class CoreExport SplitCommand : public Command
@@ -246,5 +256,3 @@ class CoreExport SplitCommand : public Command
 	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