diff options
Diffstat (limited to 'include/usermanager.h')
| -rw-r--r-- | include/usermanager.h | 145 |
1 files changed, 75 insertions, 70 deletions
diff --git a/include/usermanager.h b/include/usermanager.h index ac8ae1cb3..a419916f2 100644 --- a/include/usermanager.h +++ b/include/usermanager.h @@ -17,42 +17,54 @@ */ -#ifndef USERMANAGER_H -#define USERMANAGER_H +#pragma once #include <list> -/** A list of ip addresses cross referenced against clone counts */ -typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap; - class CoreExport 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; + private: - /** Map of local ip addresses for clone counting + /** Map of IP addresses for clone counting + */ + CloneMap clonemap; + + /** A CloneCounts that contains zero for both local and global */ - clonemap local_clones; + const CloneCounts zeroclonecounts; + public: + /** Constructor, initializes variables + */ UserManager(); - ~UserManager() - { - for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++) - { - delete i->second; - } - clientlist->clear(); - delete clientlist; - delete uuidlist; - } + /** 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; + user_hash uuidlist; /** Local client list, a list containing only local clients */ @@ -60,21 +72,28 @@ class CoreExport UserManager /** 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) */ unsigned int unregistered_count; - /** Number of elements in local_users + /** + * Reset the already_sent IDs so we don't wrap it around and drop a message + * Also removes all expired invites + */ + void GarbageCollect(); + + /** Perform background user events such as PING checks */ - unsigned int local_count; + 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, @@ -90,20 +109,15 @@ class CoreExport UserManager /** 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 + * @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 @@ -112,61 +126,52 @@ class CoreExport UserManager */ 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 + /** 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 GlobalCloneCount(User *user); + const CloneCounts& GetCloneCounts(User* user) const; - /** 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 a map containg IP addresses and their clone counts + * @return The clone count map */ - unsigned long LocalCloneCount(User *user); + const CloneMap& GetCloneMap() const { return clonemap; } - /** Return a count of users, unknown and known connections - * @return The number of 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 UserCount(); + unsigned int UserCount() const { return this->clientlist.size(); } - /** Return a count of fully registered connections only - * @return The number of registered users + /** Return a count of fully registered connections on the network + * @return The number of registered users on the network */ - unsigned int RegisteredUserCount(); + unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); } - /** Return a count of opered (umode +o) users only - * @return The number of opers + /** Return a count of opered (umode +o) users on the network + * @return The number of opers on the network */ - unsigned int OperCount(); + unsigned int OperCount() const { return this->all_opers.size(); } - /** Return a count of unregistered (before NICK/USER) users only - * @return The number of unregistered (unknown) connections + /** Return a count of local unregistered (before NICK/USER) users + * @return The number of local unregistered (unknown) connections */ - unsigned int UnregisteredUserCount(); + unsigned int UnregisteredUserCount() const { return this->unregistered_count; } - /** Return a count of local users on this server only - * @return The number of local users + /** Return a count of local registered users + * @return The number of registered local users */ - unsigned int LocalUserCount(); - - + unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); } - - /** Number of users with a certain mode set on them + /** Get a hash map containing all users, keyed by their nickname + * @return A hash map mapping nicknames to User pointers */ - int ModeCount(const char mode); + user_hash& GetUsers() { return clientlist; } /** 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); - - /** Send a server message (PRIVMSG) to all local users - * @param text The text format string to send - * @param ... The format arguments - */ - void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3); }; - -#endif |