* | 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-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.
*
* ---------------------------------------------------
+ */
- $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__
- 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)
+#include "inspircd_config.h"
+#include "hash_map.h"
+#include "base.h"
- Revision 1.2 2003/01/09 21:09:50 brain
- added '/stats M' command
+class userrec;
+class InspIRCd;
- Revision 1.1 2003/01/07 01:02:14 brain
+/** 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! */
+};
- definitions for command table types
+/* 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
- * ---------------------------------------------------
+/** A structure that defines a command
*/
-#include "inspircd_config.h"
-#include "inspircd.h"
-#include "base.h"
+class command_t : public Extensible
+{
+ protected:
+ 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
+ */
+ int min_params;
+ /** used by /stats m
+ */
+ long use_count;
+ /** used by /stats m
+ */
+ long 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;
-#ifndef __CTABLES_H__
-#define __CTABLES_H__
+ 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 = "";
+ }
-typedef void (handlerfunc) (char**, int, userrec*);
+ virtual CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
-/* a structure that defines a command */
+ virtual CmdResult HandleServer(const char** parameters, int pcnt, const std::string &servername)
+ {
+ return CMD_INVALID;
+ }
-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 */
+ void Disable(bool setting)
+ {
+ disabled = setting;
+ }
+
+ bool IsDisabled()
+ {
+ return disabled;
+ }
+
+ bool WorksBeforeReg()
+ {
+ return works_before_reg;
+ }
+
+ virtual ~command_t() {}
};
-#endif
+typedef nspace::hash_map<std::string,command_t*> command_table;
+#endif