Allow commands to optionally route themselves using ENCAP

[user/henk/code/inspircd.git] / include / ctables.h

diff --git a/include/ctables.h b/include/ctables.h
index 7ff47abbfcad1ca814899783822b2c3dad830266..a543b7e3756ebc9e230af183d11d99b8c9248de5 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -3,14 +3,14 @@
  *       +------------------------------------+
  *
  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
- 
+
 #ifndef __CTABLES_H__
 #define __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.
@@ -33,19 +34,38 @@ 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_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,
+       ROUTE_TYPE_OPT_BCAST,
+       ROUTE_TYPE_OPT_UCAST
+};
+
+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) { }
+};
 
+/** Do not route this command */
+#define ROUTE_LOCALONLY (RouteDescriptor(ROUTE_TYPE_LOCALONLY, ""))
+/** Route this command to all servers, fail if not understood */
+#define ROUTE_BROADCAST (RouteDescriptor(ROUTE_TYPE_BROADCAST, ""))
+/** Route this command to a single server (do nothing if own server name specified) */
+#define ROUTE_UNICAST(x) (RouteDescriptor(ROUTE_TYPE_UNICAST, x))
+/** Route this command to all servers, ignore if not understood */
+#define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
+/** Route this command to a single server, ignore if not understood */
+#define ROUTE_OPT_UCAST(x) (RouteDescriptor(ROUTE_TYPE_OPT_UCAST, x))
 
 /** A structure that defines a command. Every command available
  * in InspIRCd must be defined as derived from Command.
@@ -147,6 +167,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.
@@ -243,4 +268,3 @@ typedef nspace::hash_map<std::string,Command*> Commandtable;
        translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);
 
 #endif
-