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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <list>
class CoreExport UserManager : public fakederef<UserManager>
{
public:
struct CloneCounts
{
unsigned int global;
unsigned int local;
CloneCounts() : global(0), local(0) { }
};
/** Container that maps IP addresses to clone counts
*/
typedef std::map<irc::sockets::cidr_mask, CloneCounts> CloneMap;
/** Sequence container in which each element is a User*
*/
typedef std::vector<User*> OperList;
/** A list holding local users
*/
typedef insp::intrusive_list<LocalUser> LocalList;
private:
/** Map of IP addresses for clone counting
*/
CloneMap clonemap;
/** A CloneCounts that contains zero for both local and global
*/
const CloneCounts zeroclonecounts;
/** Local client list, a list containing only local clients
*/
LocalList local_users;
public:
/** Constructor, initializes variables
*/
UserManager();
/** Destructor, destroys all users in clientlist
*/
~UserManager();
/** Client list, a hash_map containing all clients, local and remote
*/
user_hash clientlist;
/** Client list stored by UUID. Contains all clients, and is updated
* automatically by the constructor and destructor of User.
*/
user_hash uuidlist;
/** Oper list, a vector containing all local and remote opered users
*/
OperList all_opers;
/** Number of unregistered users online right now.
* (Unregistered means before USER/NICK/dns)
*/
unsigned int unregistered_count;
/**
* Reset the already_sent IDs so we don't wrap it around and drop a message
*/
void GarbageCollect();
/** Perform background user events such as PING checks
*/
void DoBackgroundUserStuff();
/** Returns true when all modules have done pre-registration checks on a user
* @param user The user to verify
* @return True if all modules have finished checking this user
*/
bool AllModulesReportReady(LocalUser* user);
/** Add a client to the system.
* This will create a new User, insert it into the user_hash,
* initialize it as not yet registered, and add it to the socket engine.
* @param socket The socket id (file descriptor) this user is on
* @param via The socket that this user connected using
* @param client The IP address and client port of the user
* @param server The server IP address and port used by the user
* @return This function has no return value, but a call to AddClient may remove the user.
*/
void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
/** Disconnect a user gracefully
* @param user The user to remove
* @param quitreason The quit reason to show to normal users
* @param operreason The quit reason to show to opers, can be NULL if same as quitreason
* @return Although this function has no return type, on exit the user provided will no longer exist.
*/
void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
/** Add a user to the clone map
* @param user The user to add
*/
void AddClone(User* user);
/** Remove all clone counts from the user, you should
* use this if you change the user's IP address
* after they have registered.
* @param user The user to remove
*/
void RemoveCloneCounts(User *user);
/** Rebuild clone counts
*/
void RehashCloneCounts();
/** Return the number of local and global clones of this user
* @param user The user to get the clone counts for
* @return The clone counts of this user. The returned reference is volatile - you
* must assume that it becomes invalid as soon as you call any function other than
* your own.
*/
const CloneCounts& GetCloneCounts(User* user) const;
/** Return a map containg IP addresses and their clone counts
* @return The clone count map
*/
const CloneMap& GetCloneMap() const { return clonemap; }
/** Return a count of all global users, unknown and known connections
* @return The number of users on the network, including local unregistered users
*/
unsigned int UserCount() const { return this->clientlist.size(); }
/** Return a count of fully registered connections on the network
* @return The number of registered users on the network
*/
unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
/** Return a count of opered (umode +o) users on the network
* @return The number of opers on the network
*/
unsigned int OperCount() const { return this->all_opers.size(); }
/** Return a count of local unregistered (before NICK/USER) users
* @return The number of local unregistered (unknown) connections
*/
unsigned int UnregisteredUserCount() const { return this->unregistered_count; }
/** Return a count of local registered users
* @return The number of registered local users
*/
unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
/** Get a hash map containing all users, keyed by their nickname
* @return A hash map mapping nicknames to User pointers
*/
user_hash& GetUsers() { return clientlist; }
/** Get a list containing all local users
* @return A const list of local users
*/
const LocalList& GetLocalUsers() const { return local_users; }
/** Send a server notice to all local users
* @param text The text format string to send
* @param ... The format arguments
*/
void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Retrieves the next already sent id, guaranteed to be not equal to any user's already_sent field
* @return Next already_sent id
*/
already_sent_t NextAlreadySentId();
};
|
