]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/ctables.h
Add TTL stuff to dns system (pass it to inherited objects)
[user/henk/code/inspircd.git] / include / ctables.h
index d98e1701d516bef0152d8bb50958235b51c77ced..7d1173307b563f632c2c97adf732f80accdaf90b 100644 (file)
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
 #ifndef __CTABLES_H__
 #define __CTABLES_H__
 
+
 #include "inspircd_config.h"
+#include "hash_map.h"
+#include "base.h"
 
-#ifdef GCC3
-#include <ext/hash_map>
-#else
-#include <hash_map>
-#endif
+class userrec;
+class InspIRCd;
 
-#ifdef GCC3
-#define nspace __gnu_cxx
-#else
-#define nspace std
-#endif
+/** Used to indicate command success codes
+ */
+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! */
+};
 
-class userrec;
+/* 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
 
-/*typedef void (handlerfunc) (char**, int, userrec*);*/
 
 /** A structure that defines a command
  */
-class command_t
+class command_t : public Extensible
 {
+ protected:
+       InspIRCd* ServerInstance;
  public:
        /** Command name
        */
@@ -58,14 +66,50 @@ class command_t
        /** used for resource tracking between modules
         */
        std::string source;
+       /** True if the command is disabled to non-opers
+        */
+       bool disabled;
+       /** True if the command can be issued before registering
+        */
+       bool works_before_reg;
+       /** Syntax string for the command, displayed if non-empty string.
+        * This takes place of the text in the 'not enough parameters' numeric.
+        */
+       std::string syntax;
 
-       command_t(const std::string &cmd, char flags, int minpara) : command(cmd), flags_needed(flags), min_params(minpara)
+       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)
        {
                use_count = total_bytes = 0;
                source = "<core>";
+               syntax = "";
        }
 
-       virtual void Handle(char** parameters, int pcnt, userrec* user) = 0;
+       virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
+
+       virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> &params)
+       {
+               return CMD_INVALID;
+       }
+
+       virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+       {
+               return CMD_INVALID;
+       }
+
+       void Disable(bool setting)
+       {
+               disabled = setting;
+       }
+
+       bool IsDisabled()
+       {
+               return disabled;
+       }
+
+       bool WorksBeforeReg()
+       {
+               return works_before_reg;
+       }
 
        virtual ~command_t() {}
 };
@@ -73,4 +117,3 @@ class command_t
 typedef nspace::hash_map<std::string,command_t*> command_table;
 
 #endif
-