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 /** A list of ip addresses cross referenced against clone counts */
25 typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
27 class CoreExport UserManager
30 /** Map of local ip addresses for clone counting
32 clonemap local_clones;
35 /** Constructor, initializes variables
39 /** Destructor, destroys all users in clientlist
43 /** Client list, a hash_map containing all clients, local and remote
47 /** Client list stored by UUID. Contains all clients, and is updated
48 * automatically by the constructor and destructor of User.
52 /** Local client list, a list containing only local clients
54 LocalUserList local_users;
56 /** Oper list, a vector containing all local and remote opered users
58 std::list<User*> all_opers;
60 /** Number of unregistered users online right now.
61 * (Unregistered means before USER/NICK/dns)
63 unsigned int unregistered_count;
65 /** Map of global ip addresses for clone counting
66 * XXX - this should be private, but m_clones depends on it currently.
68 clonemap global_clones;
71 * Reset the already_sent IDs so we don't wrap it around and drop a message
72 * Also removes all expired invites
74 void GarbageCollect();
76 /** Perform background user events such as PING checks
78 void DoBackgroundUserStuff();
80 /** Returns true when all modules have done pre-registration checks on a user
81 * @param user The user to verify
82 * @return True if all modules have finished checking this user
84 bool AllModulesReportReady(LocalUser* user);
86 /** Add a client to the system.
87 * This will create a new User, insert it into the user_hash,
88 * initialize it as not yet registered, and add it to the socket engine.
89 * @param socket The socket id (file descriptor) this user is on
90 * @param via The socket that this user connected using
91 * @param client The IP address and client port of the user
92 * @param server The server IP address and port used by the user
93 * @return This function has no return value, but a call to AddClient may remove the user.
95 void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
97 /** Disconnect a user gracefully
98 * @param user The user to remove
99 * @param quitreason The quit reason to show to normal users
100 * @param operreason The quit reason to show to opers, can be NULL if same as quitreason
101 * @return Although this function has no return type, on exit the user provided will no longer exist.
103 void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
105 /** Add a user to the local clone map
106 * @param user The user to add
108 void AddLocalClone(User *user);
110 /** Add a user to the global clone map
111 * @param user The user to add
113 void AddGlobalClone(User *user);
115 /** Remove all clone counts from the user, you should
116 * use this if you change the user's IP address
117 * after they have registered.
118 * @param user The user to remove
120 void RemoveCloneCounts(User *user);
122 /** Return the number of global clones of this user
123 * @param user The user to get a count for
124 * @return The global clone count of this user
126 unsigned long GlobalCloneCount(User *user);
128 /** Return the number of local clones of this user
129 * @param user The user to get a count for
130 * @return The local clone count of this user
132 unsigned long LocalCloneCount(User *user);
134 /** Return a count of all global users, unknown and known connections
135 * @return The number of users on the network, including local unregistered users
137 unsigned int UserCount() const { return this->clientlist.size(); }
139 /** Return a count of fully registered connections on the network
140 * @return The number of registered users on the network
142 unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
144 /** Return a count of opered (umode +o) users on the network
145 * @return The number of opers on the network
147 unsigned int OperCount() const { return this->all_opers.size(); }
149 /** Return a count of local unregistered (before NICK/USER) users
150 * @return The number of local unregistered (unknown) connections
152 unsigned int UnregisteredUserCount() const { return this->unregistered_count; }
154 /** Return a count of local registered users
155 * @return The number of registered local users
157 unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
159 /** Get a hash map containing all users, keyed by their nickname
160 * @return A hash map mapping nicknames to User pointers
162 user_hash& GetUsers() { return clientlist; }
164 /** Send a server notice to all local users
165 * @param text The text format string to send
166 * @param ... The format arguments
168 void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);