2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 * This file is part of InspIRCd. InspIRCd is free software: you can
7 * redistribute it and/or modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation, version 2.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class CoreExport UserManager : public fakederef<UserManager>
31 CloneCounts() : global(0), local(0) { }
34 /** Container that maps IP addresses to clone counts
36 typedef std::map<irc::sockets::cidr_mask, CloneCounts> CloneMap;
38 /** Sequence container in which each element is a User*
40 typedef std::vector<User*> OperList;
42 /** A list holding local users
44 typedef insp::intrusive_list<LocalUser> LocalList;
47 /** Map of IP addresses for clone counting
51 /** A CloneCounts that contains zero for both local and global
53 const CloneCounts zeroclonecounts;
55 /** Local client list, a list containing only local clients
57 LocalList local_users;
60 /** Constructor, initializes variables
64 /** Destructor, destroys all users in clientlist
68 /** Client list, a hash_map containing all clients, local and remote
72 /** Client list stored by UUID. Contains all clients, and is updated
73 * automatically by the constructor and destructor of User.
77 /** Oper list, a vector containing all local and remote opered users
81 /** Number of unregistered users online right now.
82 * (Unregistered means before USER/NICK/dns)
84 unsigned int unregistered_count;
87 * Reset the already_sent IDs so we don't wrap it around and drop a message
88 * Also removes all expired invites
90 void GarbageCollect();
92 /** Perform background user events such as PING checks
94 void DoBackgroundUserStuff();
96 /** Returns true when all modules have done pre-registration checks on a user
97 * @param user The user to verify
98 * @return True if all modules have finished checking this user
100 bool AllModulesReportReady(LocalUser* user);
102 /** Add a client to the system.
103 * This will create a new User, insert it into the user_hash,
104 * initialize it as not yet registered, and add it to the socket engine.
105 * @param socket The socket id (file descriptor) this user is on
106 * @param via The socket that this user connected using
107 * @param client The IP address and client port of the user
108 * @param server The server IP address and port used by the user
109 * @return This function has no return value, but a call to AddClient may remove the user.
111 void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
113 /** Disconnect a user gracefully
114 * @param user The user to remove
115 * @param quitreason The quit reason to show to normal users
116 * @param operreason The quit reason to show to opers, can be NULL if same as quitreason
117 * @return Although this function has no return type, on exit the user provided will no longer exist.
119 void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
121 /** Add a user to the clone map
122 * @param user The user to add
124 void AddClone(User* user);
126 /** Remove all clone counts from the user, you should
127 * use this if you change the user's IP address
128 * after they have registered.
129 * @param user The user to remove
131 void RemoveCloneCounts(User *user);
133 /** Return the number of local and global clones of this user
134 * @param user The user to get the clone counts for
135 * @return The clone counts of this user. The returned reference is volatile - you
136 * must assume that it becomes invalid as soon as you call any function other than
139 const CloneCounts& GetCloneCounts(User* user) const;
141 /** Return a map containg IP addresses and their clone counts
142 * @return The clone count map
144 const CloneMap& GetCloneMap() const { return clonemap; }
146 /** Return a count of all global users, unknown and known connections
147 * @return The number of users on the network, including local unregistered users
149 unsigned int UserCount() const { return this->clientlist.size(); }
151 /** Return a count of fully registered connections on the network
152 * @return The number of registered users on the network
154 unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
156 /** Return a count of opered (umode +o) users on the network
157 * @return The number of opers on the network
159 unsigned int OperCount() const { return this->all_opers.size(); }
161 /** Return a count of local unregistered (before NICK/USER) users
162 * @return The number of local unregistered (unknown) connections
164 unsigned int UnregisteredUserCount() const { return this->unregistered_count; }
166 /** Return a count of local registered users
167 * @return The number of registered local users
169 unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
171 /** Get a hash map containing all users, keyed by their nickname
172 * @return A hash map mapping nicknames to User pointers
174 user_hash& GetUsers() { return clientlist; }
176 /** Get a list containing all local users
177 * @return A const list of local users
179 const LocalList& GetLocalUsers() const { return local_users; }
181 /** Send a server notice to all local users
182 * @param text The text format string to send
183 * @param ... The format arguments
185 void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);