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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/* +------------------------------------+
* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
* Inspire is copyright (C) 2002-2004 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.
*
* ---------------------------------------------------
*/
#include "inspircd_config.h"
#include "channels.h"
#include "connection.h"
#include <string>
#ifndef __USERS_H__
#define __USERS_H__
#define STATUS_OP 4
#define STATUS_HOP 2
#define STATUS_VOICE 1
#define STATUS_NORMAL 0
#define CC_ALLOW 0
#define CC_DENY 1
/** Holds a channel name to which a user has been invited.
*/
class Invited : public classbase
{
public:
char channel[CHANMAX];
};
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
class ConnectClass : public classbase
{
public:
/** Type of line, either CC_ALLOW or CC_DENY
*/
int type;
/** Max time to register the connection in seconds
*/
int registration_timeout;
/** Number of lines in buffer before excess flood is triggered
*/
int flood;
/** Host mask for this line
*/
char host[MAXBUF];
/** (Optional) Password for this line
*/
char pass[MAXBUF];
ConnectClass()
{
registration_timeout = 0;
flood = 0;
strlcpy(host,"",MAXBUF);
strlcpy(pass,"",MAXBUF);
}
};
/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
*/
typedef std::vector<Invited> InvitedList;
/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
*/
typedef std::vector<ConnectClass> ClassVector;
/** Holds all information about a user
* This class stores all information about a user connected to the irc server. Everything about a
* connection is stored here primarily, from the user's socket ID (file descriptor) through to the
* user's nickname and hostname. Use the Find method of the server class to locate a specific user
* by nickname.
*/
class userrec : public connection
{
private:
/** A list of channels the user has a pending invite to.
*/
InvitedList invites;
public:
/** The users nickname.
* An invalid nickname indicates an unregistered connection prior to the NICK command.
*/
char nick[NICKMAX];
/** The users ident reply.
*/
char ident[64];
/** The host displayed to non-opers (used for cloaking etc).
* This usually matches the value of userrec::host.
*/
char dhost[256];
/** The users full name.
*/
char fullname[128];
/** The user's mode string.
* This may contain any of the following RFC characters: o, w, s, i
* Your module may define other mode characters as it sees fit.
*/
char modes[MAXBUF];
ucrec chans[MAXCHANS];
/** The server the user is connected to.
*/
char server[256];
/** The user's away message.
* If this string is empty, the user is not marked as away.
*/
char awaymsg[512];
/** Stores the result of the last GetFullHost or GetRealHost call.
* You may use this to increase the speed of use of this class.
*/
char result[256];
/** Number of lines the user can place into the buffer
* (up to the global NetBufferSize bytes) before they
* are disconnected for excess flood
*/
int flood;
/** Number of seconds this user is given to send USER/NICK
* If they do not send their details in this time limit they
* will be disconnected
*/
unsigned long timeout;
/** The oper type they logged in as, if they are an oper.
* This is used to check permissions in operclasses, so that
* we can say 'yay' or 'nay' to any commands they issue.
* The value of this is the value of a valid 'type name=' tag.
*/
char oper[NICKMAX];
userrec();
virtual ~userrec() { }
/** Returns the full displayed host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form.
*/
virtual char* GetFullHost();
/** Returns the full real host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
* e.g. through a module, then this method will ignore it and return the true hostname.
*/
virtual char* GetFullRealHost();
/** Returns true if a user is invited to a channel.
*/
virtual bool IsInvited(char* channel);
/** Adds a channel to a users invite list (invites them to a channel)
*/
virtual void InviteTo(char* channel);
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
* to which the user has previously been invited, to clear the invitation.
*/
virtual void RemoveInvite(char* channel);
/** Returns true or false for if a user can execute a privilaged oper command.
* This is done by looking up their oper type from userrec::oper, then referencing
* this to their oper classes and checking the commands they can execute.
*/
bool HasPermission(char* command);
};
#endif
|
