1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/* +------------------------------------+
* | 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.
* 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! */
};
/** 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 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
|
