mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-10 02:59:01 -04:00
b2f3ac1161
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@6241 e03df62e-2008-0410-955e-edbf42e46eb7
120 lines
2.8 KiB
C++
120 lines
2.8 KiB
C++
/* +------------------------------------+
|
|
* | Inspire Internet Relay Chat Daemon |
|
|
* +------------------------------------+
|
|
*
|
|
* 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"
|
|
|
|
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! */
|
|
};
|
|
|
|
/* 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
|
|
*/
|
|
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;
|
|
|
|
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 CmdResult Handle(const char** parameters, int pcnt, userrec* user) = 0;
|
|
|
|
virtual CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶ms)
|
|
{
|
|
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() {}
|
|
};
|
|
|
|
typedef nspace::hash_map<std::string,command_t*> command_table;
|
|
|
|
#endif
|