Change SERVICE_{CMODE,UMODE} to SERVICE_MODE, which makes more sense

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

diff --git a/include/ctables.h b/include/ctables.h
index d3baec04132b91e9824457d4d5375aa890fc9935..9c2a6181c18576d8cbd29808dd9d81a36faff178 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
  * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
@@ -20,9 +20,13 @@ 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_INVALID = 2,        /* Command doesnt exist at all! */
+       CMD_EPERM = 3       /* Command failed because of a permission check */
 };
 
+/** Flag for commands that are only allowed from servers */
+const char FLAG_SERVERONLY = 7; // technically anything nonzero below 'A' works
+
 /** 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
@@ -46,6 +50,7 @@ enum RouteType
        ROUTE_TYPE_LOCALONLY,
        ROUTE_TYPE_BROADCAST,
        ROUTE_TYPE_UNICAST,
+       ROUTE_TYPE_MESSAGE,
        ROUTE_TYPE_OPT_BCAST,
        ROUTE_TYPE_OPT_UCAST
 };
@@ -57,10 +62,10 @@ struct RouteDescriptor
 {
        /** Routing type from the enum above
         */
-       const RouteType type;
+       RouteType type;
        /** For unicast, the destination server's name
         */
-       const std::string serverdest;
+       std::string serverdest;
 
        /** Create a RouteDescriptor
         */
@@ -74,6 +79,8 @@ struct RouteDescriptor
 #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 as a message with the given target (any of user, #channel, @#channel, $servermask) */
+#define ROUTE_MESSAGE(x) (RouteDescriptor(ROUTE_TYPE_MESSAGE, x))
 /** Route this command to all servers wrapped via ENCAP, so ignored if not understood */
 #define ROUTE_OPT_BCAST (RouteDescriptor(ROUTE_TYPE_OPT_BCAST, ""))
 /** Route this command to a single server wrapped via ENCAP, so ignored if not understood */
@@ -82,20 +89,9 @@ struct RouteDescriptor
 /** A structure that defines a command. Every command available
  * in InspIRCd must be defined as derived from Command.
  */
-class CoreExport Command : public Extensible
+class CoreExport Command : public ServiceProvider
 {
- protected:
-       /** Owner/Creator object
-        */
-       InspIRCd* ServerInstance;
  public:
-       /** Command name
-       */
-       std::string command;
-
-       /** Creator module, NULL for core commands */
-       Module* creator;
-
        /** User flags needed to execute the command or 0
         */
        char flags_needed;
@@ -138,7 +134,7 @@ class CoreExport Command : public Extensible
 
        /** How many seconds worth of penalty does this command have?
         */
-       const int Penalty;
+       int Penalty;
 
        /** Create a new command.
         * @param Instance Pointer to creator class
@@ -151,20 +147,10 @@ class CoreExport Command : public Extensible
         * be allowed before the user is 'registered' (has sent USER,
         * NICK, optionally PASS, and been resolved).
         */
-       Command(InspIRCd* Instance, Module* me, const std::string &cmd, const char *flags, int minpara, bool before_reg = false, int penalty = 1) :
-               ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0),
-               min_params(minpara), max_params(0), disabled(false), works_before_reg(before_reg), Penalty(penalty)
-       {
-               use_count = 0;
-               total_bytes = 0;
-       }
-
-       Command(InspIRCd* Instance, Module* me, const std::string &cmd, const char *flags, int minpara, int maxpara, bool before_reg = false, int penalty = 1) :
-               ServerInstance(Instance), command(cmd), creator(me), flags_needed(flags ? *flags : 0),
-               min_params(minpara), max_params(maxpara), disabled(false), works_before_reg(before_reg), Penalty(penalty)
+       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)
        {
-               use_count = 0;
-               total_bytes = 0;
        }
 
        /** Handle the command from a user.
@@ -222,17 +208,19 @@ class CoreExport Command : public Extensible
                return works_before_reg;
        }
 
-       /** Standard constructor gubbins
-        */
-       virtual ~Command()
-       {
-               syntax.clear();
-       }
+       virtual ~Command();
 };
 
-/** A hash of commands used by the core
- */
-typedef nspace::hash_map<std::string,Command*> Commandtable;
+class CoreExport SplitCommand : public Command
+{
+ public:
+       SplitCommand(Module* me, const std::string &cmd, int minpara = 0, int maxpara = 0)
+               : Command(me, cmd, minpara, maxpara) {}
+       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user);
+       virtual CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user);
+       virtual CmdResult HandleRemote(const std::vector<std::string>& parameters, RemoteUser* user);
+       virtual CmdResult HandleServer(const std::vector<std::string>& parameters, FakeUser* user);
+};
 
 /** Shortcut macros for defining translation lists
  */