]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/ctables.h
Fix unused HandleServer to use new system too, and update comments to match api
[user/henk/code/inspircd.git] / include / ctables.h
index 33b4d564ce0a65e00033f8d8ef100288bcca9874..d9f660f7145f5a652da3a51669a857a6fb79f89c 100644 (file)
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2003 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2008 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.
  *
  * ---------------------------------------------------
+ */
  
- $Log$
- Revision 1.2  2003/01/26 23:52:59  brain
- Modified documentation for base classes
- Added base classes
+#ifndef __CTABLES_H__
+#define __CTABLES_H__
+
+/** 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! */
+};
+
+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
+ * much more readable.
+ */
+#define CMD_LOCALONLY CMD_FAILURE
 
- Revision 1.1.1.1  2003/01/23 19:45:58  brain
- InspIRCd second source tree
 
- Revision 1.3  2003/01/15 22:47:44  brain
- Changed user and channel structs to classes (finally)
+/** A structure that defines a command. Every command available
+ * in InspIRCd must be defined as derived from Command.
+ */
+class CoreExport Command : public Extensible
+{
+ protected:
+       /** Owner/Creator object
+        */
+       InspIRCd* ServerInstance;
+ public:
+       /** Command name
+       */
+        std::string command;
+       /** User flags needed to execute the command or 0
+        */
+       char flags_needed;
+       /** Minimum number of parameters command takes
+       */
+       unsigned int min_params;
+       /** used by /stats m
+        */
+       long double use_count;
+       /** used by /stats m
+        */
+       long double total_bytes;
+       /** 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;
 
- Revision 1.2  2003/01/09 21:09:50  brain
- added '/stats M' command
+       std::vector<TranslateType> translation;
 
- Revision 1.1  2003/01/07 01:02:14  brain
+       /** How many seconds worth of penalty does this command have?
+        */
+       const int Penalty;
 
- definitions for command table types
+       /** Create a new command.
+        * @param Instance Pointer to creator class
+        * @param cmd Command name. This must be UPPER CASE.
+        * @param flags User mode required to execute the command. May ONLY be one mode - it's a string to give warnings if people mix params up.
+        * For oper only commands, set this to 'o', otherwise use 0.
+        * @param minpara Minimum parameters required for the command.
+        * @param before_reg If this is set to true, the command will
+        * be allowed before the user is 'registered' (has sent USER,
+        * NICK, optionally PASS, and been resolved).
+        */
+       Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) :  ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), 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.
+        * @param parameters The parameters for the command.
+        * @param user The user who issued the command.
+        * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+        * If the command succeeds but should remain local to this server,
+        * return CMD_LOCALONLY.
+        */
+       virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
 
- * ---------------------------------------------------
- */
-#include "inspircd_config.h"
-#include "inspircd.h"
-#include "base.h"
+       /** 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.
+        * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+        * 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 */)
+       {
+               return CMD_INVALID;
+       }
 
-#ifndef __CTABLES_H__
-#define __CTABLES_H__
+       /** Handle the command from a server.
+        * Not currently used in this version of InspIRCd.
+        * @param parameters The parameters given
+        * @param servername The server name which issued the command
+        * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+        * If the command succeeds but should remain local to this server,
+        * return CMD_LOCALONLY.
+        */
+       virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
+       {
+               return CMD_INVALID;
+       }
 
-typedef void (handlerfunc) (char**, int, userrec*);
+       /** Disable or enable this command.
+        * @param setting True to disable the command.
+        */
+       void Disable(bool setting)
+       {
+               disabled = setting;
+       }
 
-/* a structure that defines a command */
+       /** Obtain this command's disable state.
+        * @return true if the command is currently disabled
+        * (disabled commands can be used only by operators)
+        */
+       bool IsDisabled()
+       {
+               return disabled;
+       }
 
-class command_t : public classbase
-{
- public:
-       char command[MAXBUF]; /* command name */
-       handlerfunc *handler_function; /* handler function as in typedef */
-       char flags_needed; /* user flags needed to execute the command or 0 */
-       int min_params; /* minimum number of parameters command takes */
-       long use_count; /* used by /stats m */
-       long total_bytes; /* used by /stats m */
+       /** @return true if the command works before registration.
+        */
+       bool WorksBeforeReg()
+       {
+               return works_before_reg;
+       }
+
+       /** Standard constructor gubbins
+        */
+       virtual ~Command()
+       {
+               syntax.clear();
+       }
 };
 
+/** A hash of commands used by the core
+ */
+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