Include explicit routing information in Command, will replace CMD_LOCALONLY return value

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@11601 e03df62e-2008-0410-955e-edbf42e46eb7

2 files changed, 35 insertions, 9 deletions

diff --git a/include/command_parse.h b/include/command_parse.h
index 62f47bd2d..3177dc95b 100644
--- a/include/command_parse.h
+++ b/include/command_parse.h
@@ -199,11 +199,19 @@ class CoreExport CommandParser : public classbase
 	 * @param to The translation type to use for the process.
 	 * @param source The input string
 	 * @param dest The output string, it is safe to pass source and dest as the same variable only for translation type TR_TEXT.
-	 * @return returns the number of substitutions made. Will always be 0 or 1 for TR_TEXT and 0..n for other types.
+	 * @return returns the number of substitutions made. Will always be 0 or 1
 	 */
 	int TranslateUIDs(TranslateType to, const std::string &source, std::string &dest);
 
-	int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest);
+	/** Translate nicknames in a list of strings into UIDs, based on the TranslateTypes given.
+	 * @param to The translation types to use for the process. If this list is too short, TR_TEXT is assumed for the rest.
+	 * @param source The strings to translate
+	 * @param dest The output string
+	 * @param prefix_final True if the final source argument should have a colon prepended (if it could contain a space)
+	 * @param custom_translator Used to translate the parameter if the TR_CUSTOM type is found in to
+	 * @return returns the number of substitutions made.
+	 */
+	int TranslateUIDs(const std::vector<TranslateType> to, const std::vector<std::string> &source, std::string &dest, bool prefix_final = false, Command* custom_translator = NULL);
 };
 
 /** Command handler class for the RELOAD command.
diff --git a/include/ctables.h b/include/ctables.h
index 9018d9c35..b07d3f4e0 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -21,6 +21,7 @@ enum CmdResult
 	CMD_FAILURE = 0,	/* Command exists, but failed */
 	CMD_SUCCESS = 1,	/* Command exists, and succeeded */
 	CMD_INVALID = 2		/* Command doesnt exist at all! */
+#define CMD_LOCALONLY CMD_FAILURE
 };
 
 /** Translation types for translation of parameters to UIDs.
@@ -36,14 +37,26 @@ enum TranslateType
 	TR_CUSTOM		/* Custom translation handled by EncodeParameter/DecodeParameter */
 };
 
-/** 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
- * much more readable.
- */
-#define CMD_LOCALONLY CMD_FAILURE
+enum RouteType
+{
+	ROUTE_TYPE_LOCALONLY,
+	ROUTE_TYPE_BROADCAST,
+	ROUTE_TYPE_UNICAST
+};
+
+struct RouteDescriptor
+{
+	const RouteType type;
+	/** For unicast, the destination server's name
+	 */
+	const std::string serverdest;
+	RouteDescriptor(RouteType t, const std::string d)
+		: type(t), serverdest(d) { }
+};
 
+#define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
+#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
+#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
 
 /** A structure that defines a command. Every command available
  * in InspIRCd must be defined as derived from Command.
@@ -145,6 +158,11 @@ class CoreExport Command : public Extensible
 	 */
 	virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 
+	virtual RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+	{
+		return ROUTE_BROADCAST;
+	}
+
 	/** 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.