xline gutting, once more. There is no longer an active_lines vector, and no requireme...

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

diff --git a/include/ctables.h b/include/ctables.h
index 92a0659afac915f9f9fd4d5a94c8e57589dc175b..aafd27e4a9f643ef33534c1b3948bbfb166c50b5 100644 (file)
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -19,7 +19,8 @@
 #include "hash_map.h"
 #include "base.h"
 
-class userrec;
+/* Forward declarations - required */
+class User;
 class InspIRCd;
 
 /** Used to indicate command success codes
@@ -29,10 +30,19 @@ 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_USER_DELETED = 3,   /* User was deleted! */
+       CMD_USER_DELETED = 3    /* User was deleted - DEPRECIATED */
 };
 
-/* For commands which should not be replicated to other
+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 */
+};
+
+/** 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
@@ -42,9 +52,9 @@ enum CmdResult
 
 
 /** A structure that defines a command. Every command available
- * in InspIRCd must be defined as derived from command_t.
+ * in InspIRCd must be defined as derived from Command.
  */
-class command_t : public Extensible
+class CoreExport Command : public Extensible
 {
  protected:
        /** Owner/Creator object
@@ -62,10 +72,10 @@ class command_t : public Extensible
        int min_params;
        /** used by /stats m
         */
-       long use_count;
+       long double use_count;
        /** used by /stats m
         */
-       float total_bytes;
+       long double total_bytes;
        /** used for resource tracking between modules
         */
        std::string source;
@@ -80,6 +90,12 @@ class command_t : public Extensible
         */
        std::string syntax;
 
+       std::vector<TranslateType> translation;
+
+       /** How many seconds worth of penalty does this command have?
+        */
+       const int Penalty;
+
        /** Create a new command.
         * @param Instance Pointer to creator class
         * @param cmd Command name. This must be UPPER CASE.
@@ -90,12 +106,13 @@ class command_t : public Extensible
         * be allowed before the user is 'registered' (has sent USER,
         * NICK, optionally PASS, and been resolved).
         */
-       command_t(InspIRCd* Instance, const std::string &cmd, char flags, int minpara, int before_reg = false) : ServerInstance(Instance), command(cmd), flags_needed(flags), min_params(minpara), disabled(false), works_before_reg(before_reg)
+       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)
        {
                use_count = 0;
                total_bytes = 0;
                source = "<core>";
                syntax = "";
+               translation.clear();
        }
 
        /** Handle the command from a user.
@@ -106,7 +123,7 @@ class command_t : public Extensible
         * If the command succeeds but should remain local to this server,
         * return CMD_LOCALONLY.
         */
-       virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
+       virtual CmdResult Handle(const char** parameters, int pcnt, User* user) = 0;
 
        /** Handle an internal request from another command, the core, or a module
         * @param Command ID
@@ -115,7 +132,7 @@ class command_t : public Extensible
         * If the command succeeds but should remain local to this server,
         * return CMD_LOCALONLY.
         */
-       virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> &params)
+       virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
        {
                return CMD_INVALID;
        }
@@ -129,7 +146,7 @@ class command_t : public Extensible
         * 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 char** /* parameters */, int /* pcnt */, const std::string& /* servername */)
        {
                return CMD_INVALID;
        }
@@ -160,12 +177,25 @@ class command_t : public Extensible
 
        /** Standard constructor gubbins
         */
-       virtual ~command_t() {}
+       virtual ~Command() {}
 };
 
 /** A hash of commands used by the core
  */
-typedef nspace::hash_map<std::string,command_t*> command_table;
+typedef nspace::hash_map<std::string,Command*> Commandable;
+
+#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);
+#define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
+#define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
+       translation.push_back(x5);
+#define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
+       translation.push_back(x5);translation.push_back(x6);
+#define TRANSLATE7(x1,x2,x3,x4,x5,x6,x7)  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);
+#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