-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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/>.
*/
-#ifndef USERMANAGER_H
-#define USERMANAGER_H
-#include <list>
+#pragma once
-/** A list of ip addresses cross referenced against clone counts */
-typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
+#include <list>
-class CoreExport UserManager
+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 local ip addresses for clone counting
+ /** Map of IP addresses for clone counting
*/
- clonemap local_clones;
+ 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;
+
+ /** Last used already sent id, used when sending messages to neighbors to help determine whether the message has
+ * been sent to a particular user or not. See User::ForEachNeighbor() for more info.
+ */
+ already_sent_t already_sent_id;
+
public:
- ~UserManager()
- {
- for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
- {
- delete i->second;
- }
- clientlist->clear();
- delete clientlist;
- delete uuidlist;
- }
+ /** 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;
+ 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;
-
- /** Local client list, a vector containing only local clients
- */
- std::vector<LocalUser*> local_users;
+ user_hash uuidlist;
/** Oper list, a vector containing all local and remote opered users
*/
- std::list<User*> all_opers;
+ OperList all_opers;
/** Number of unregistered users online right now.
* (Unregistered means before USER/NICK/dns)
*/
- int unregistered_count;
+ unsigned int unregistered_count;
+
+ /** Perform background user events such as PING checks
+ */
+ void DoBackgroundUserStuff();
- /** Map of global ip addresses for clone counting
- * XXX - this should be private, but m_clones depends on it currently.
+ /** 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
*/
- clonemap global_clones;
+ 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 Instance a pointer to the server instance
* @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
/** Disconnect a user gracefully
* @param user The user to remove
- * @param r The quit reason to show to normal users
- * @param oreason The quit reason to show to opers
+ * @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 char* operreason = "");
+ void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
- /** Add a user to the local clone map
+ /** Add a user to the clone map
* @param user The user to add
*/
- void AddLocalClone(User *user);
-
- /** Add a user to the global clone map
- * @param user The user to add
- */
- void AddGlobalClone(User *user);
+ void AddClone(User* user);
/** Remove all clone counts from the user, you should
* use this if you change the user's IP address
*/
void RemoveCloneCounts(User *user);
- /** Return the number of global clones of this user
- * @param user The user to get a count for
- * @return The global clone count of this user
+ /** Rebuild clone counts
*/
- unsigned long GlobalCloneCount(User *user);
+ void RehashCloneCounts();
- /** Return the number of local clones of this user
- * @param user The user to get a count for
- * @return The local clone count of this user
+ /** 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.
*/
- unsigned long LocalCloneCount(User *user);
+ const CloneCounts& GetCloneCounts(User* user) const;
- /** Return a count of users, unknown and known connections
- * @return The number of users
+ /** Return a map containg IP addresses and their clone counts
+ * @return The clone count map
*/
- unsigned int UserCount();
+ const CloneMap& GetCloneMap() const { return clonemap; }
- /** Return a count of fully registered connections only
- * @return The number of registered users
+ /** 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 RegisteredUserCount();
+ unsigned int UserCount() const { return this->clientlist.size(); }
- /** Return a count of opered (umode +o) users only
- * @return The number of opers
+ /** Return a count of fully registered connections on the network
+ * @return The number of registered users on the network
*/
- unsigned int OperCount();
+ unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
- /** Return a count of unregistered (before NICK/USER) users only
- * @return The number of unregistered (unknown) connections
+ /** Return a count of opered (umode +o) users on the network
+ * @return The number of opers on the network
*/
- unsigned int UnregisteredUserCount();
+ unsigned int OperCount() const { return this->all_opers.size(); }
- /** Return a count of local users on this server only
- * @return The number of local users
+ /** Return a count of local unregistered (before NICK/USER) users
+ * @return The number of local unregistered (unknown) connections
*/
- unsigned int LocalUserCount();
-
+ 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; }
- /** Number of users with a certain mode set on them
+ /** Get a list containing all local users
+ * @return A const list of local users
*/
- int ModeCount(const char mode);
+ const LocalList& GetLocalUsers() const { return local_users; }
/** Send a server notice to all local users
* @param text The text format string to send
*/
void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
- /** Send a server message (PRIVMSG) to all local users
- * @param text The text format string to send
- * @param ... The format arguments
+ /** Retrieves the next already sent id, guaranteed to be not equal to any user's already_sent field
+ * @return Next already_sent id
*/
- void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
+ already_sent_t NextAlreadySentId();
};
-
-#endif
projects / user / henk / code / inspircd.git / blobdiff