Change allocation of InspIRCd::Timers to be physically part of the object containing it

[user/henk/code/inspircd.git] / include / usermanager.h

diff --git a/include/usermanager.h b/include/usermanager.h
index f5df25f00a2d808f36c40d4580ad26a4d2dff41a..040f91852a73ab024e71189c7d9157a851819a62 100644 (file)
--- a/include/usermanager.h
+++ b/include/usermanager.h
@@ -30,28 +30,24 @@ class CoreExport UserManager
        /** Map of local ip addresses for clone counting
         */
        clonemap local_clones;
+
  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
         */
@@ -66,10 +62,6 @@ class CoreExport UserManager
         */
        unsigned int unregistered_count;
 
-       /** Number of elements in local_users
-        */
-       unsigned int local_count;
-
        /** Map of global ip addresses for clone counting
         * XXX - this should be private, but m_clones depends on it currently.
         */
@@ -81,6 +73,16 @@ class CoreExport UserManager
      */
        void GarbageCollect();
 
+       /** Perform background user events such as PING checks
+        */
+       void DoBackgroundUserStuff();
+
+       /** 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
+        */
+       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.
@@ -95,10 +97,10 @@ 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
         * @param user The user to add
@@ -129,34 +131,35 @@ class CoreExport UserManager
         */
        unsigned long LocalCloneCount(User *user);
 
-       /** 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