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/>.
25 /** A list of ip addresses cross referenced against clone counts */
26 typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
28 class CoreExport UserManager
31 /** Map of local ip addresses for clone counting
33 clonemap local_clones;
39 for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
48 /** Client list, a hash_map containing all clients, local and remote
50 user_hash* clientlist;
52 /** Client list stored by UUID. Contains all clients, and is updated
53 * automatically by the constructor and destructor of User.
57 /** Local client list, a list containing only local clients
59 LocalUserList local_users;
61 /** Oper list, a vector containing all local and remote opered users
63 std::list<User*> all_opers;
65 /** Number of unregistered users online right now.
66 * (Unregistered means before USER/NICK/dns)
68 unsigned int unregistered_count;
70 /** Number of elements in local_users
72 unsigned int local_count;
74 /** Map of global ip addresses for clone counting
75 * XXX - this should be private, but m_clones depends on it currently.
77 clonemap global_clones;
79 /** Add a client to the system.
80 * This will create a new User, insert it into the user_hash,
81 * initialize it as not yet registered, and add it to the socket engine.
82 * @param socket The socket id (file descriptor) this user is on
83 * @param via The socket that this user connected using
84 * @param client The IP address and client port of the user
85 * @param server The server IP address and port used by the user
86 * @return This function has no return value, but a call to AddClient may remove the user.
88 void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
90 /** Disconnect a user gracefully
91 * @param user The user to remove
92 * @param quitreason The quit reason to show to normal users
93 * @param operreason The quit reason to show to opers
94 * @return Although this function has no return type, on exit the user provided will no longer exist.
96 void QuitUser(User *user, const std::string &quitreason, const char* operreason = "");
98 /** Add a user to the local clone map
99 * @param user The user to add
101 void AddLocalClone(User *user);
103 /** Add a user to the global clone map
104 * @param user The user to add
106 void AddGlobalClone(User *user);
108 /** Remove all clone counts from the user, you should
109 * use this if you change the user's IP address
110 * after they have registered.
111 * @param user The user to remove
113 void RemoveCloneCounts(User *user);
115 /** Return the number of global clones of this user
116 * @param user The user to get a count for
117 * @return The global clone count of this user
119 unsigned long GlobalCloneCount(User *user);
121 /** Return the number of local clones of this user
122 * @param user The user to get a count for
123 * @return The local clone count of this user
125 unsigned long LocalCloneCount(User *user);
127 /** Return a count of users, unknown and known connections
128 * @return The number of users
130 unsigned int UserCount();
132 /** Return a count of fully registered connections only
133 * @return The number of registered users
135 unsigned int RegisteredUserCount();
137 /** Return a count of opered (umode +o) users only
138 * @return The number of opers
140 unsigned int OperCount();
142 /** Return a count of unregistered (before NICK/USER) users only
143 * @return The number of unregistered (unknown) connections
145 unsigned int UnregisteredUserCount();
147 /** Return a count of local users on this server only
148 * @return The number of local users
150 unsigned int LocalUserCount();
155 /** Number of users with a certain mode set on them
157 int ModeCount(const char mode);
159 /** Send a server notice to all local users
160 * @param text The text format string to send
161 * @param ... The format arguments
163 void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
165 /** Send a server message (PRIVMSG) to all local users
166 * @param text The text format string to send
167 * @param ... The format arguments
169 void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3);