]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/usermanager.h
Change allocation of UserManager::uuidlist to be physically part of the object contai...
[user/henk/code/inspircd.git] / include / usermanager.h
index 92b40b373ba6b595768f40180945e6c6b04bd6c5..b1c3520e9551db9cfcb7f6b9c9d58206bf41e740 100644 (file)
@@ -17,8 +17,7 @@
  */
 
 
-#ifndef USERMANAGER_H
-#define USERMANAGER_H
+#pragma once
 
 #include <list>
 
@@ -31,17 +30,16 @@ class CoreExport UserManager
        /** Map of local ip addresses for clone counting
         */
        clonemap local_clones;
+
  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 and allocates the hashmaps
+        */
+       UserManager();
+
+       /** Destructor, destroys all users in clientlist and then deallocates
+        * the hashmaps
+        */
+       ~UserManager();
 
        /** Client list, a hash_map containing all clients, local and remote
         */
@@ -50,11 +48,11 @@ class CoreExport UserManager
        /** 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 vector containing only local clients
+       /** Local client list, a list containing only local clients
         */
-       std::vector<LocalUser*> local_users;
+       LocalUserList local_users;
 
        /** Oper list, a vector containing all local and remote opered users
         */
@@ -63,13 +61,29 @@ class CoreExport UserManager
        /** Number of unregistered users online right now.
         * (Unregistered means before USER/NICK/dns)
         */
-       int unregistered_count;
+       unsigned int unregistered_count;
 
        /** Map of global ip addresses for clone counting
         * XXX - this should be private, but m_clones depends on it currently.
         */
        clonemap global_clones;
 
+       /**
+        * 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
+        */
+       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.
@@ -84,10 +98,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
@@ -118,49 +132,34 @@ 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();
-
-
-
-
-       /** Number of users with a certain mode set on them
-        */
-       int ModeCount(const char mode);
+       unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
 
        /** 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