* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
#ifndef __CTABLES_H__
#define __CTABLES_H__
-
-#include "inspircd_config.h"
-#include "hash_map.h"
-#include "base.h"
-
-/* Forward declarations - required */
-class userrec;
-class InspIRCd;
-
/** 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 - DEPRECIATED */
+ CMD_INVALID = 2 /* Command doesnt exist at all! */
};
enum TranslateType
/** 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 CoreExport command_t : public Extensible
+class CoreExport Command : public Extensible
{
protected:
/** Owner/Creator object
char flags_needed;
/** Minimum number of parameters command takes
*/
- int min_params;
+ unsigned 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;
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.
- * @param flags User modes required to execute the command.
+ * @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_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, 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.push_back(TR_END);
+ translation.clear();
}
/** Handle the command from a user.
* @param parameters The parameters for the command.
- * @param pcnt The number of parameters available in 'parameters'
* @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 char** parameters, int pcnt, userrec* user) = 0;
+ virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;
/** Handle an internal request from another command, the core, or a module
* @param Command ID
* 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*> ¶ms)
+ virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
{
return CMD_INVALID;
}
/** Handle the command from a server.
* Not currently used in this version of InspIRCd.
* @param parameters The parameters given
- * @param pcnt The number of parameters available
* @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 char** parameters, int pcnt, const std::string &servername)
+ virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
{
return CMD_INVALID;
}
/** Standard constructor gubbins
*/
- virtual ~command_t() {}
+ virtual ~Command()
+ {
+ syntax.clear();
+ }
};
/** 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*> Commandtable;
#define TRANSLATE1(x1) translation.push_back(x1);
#define TRANSLATE2(x1,x2) translation.push_back(x1);translation.push_back(x2);
projects / user / henk / code / inspircd.git / blobdiff