include/usermanager.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   5  *
   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.
   9  *
  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
  13  * details.
  14  *
  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/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 #include <list>
  23
  24 class CoreExport UserManager
  25 {
  26  public:
  27         struct CloneCounts
  28         {
  29                 unsigned int global;
  30                 unsigned int local;
  31                 CloneCounts() : global(0), local(0) { }
  32         };
  33
  34         /** Container that maps IP addresses to clone counts
  35          */
  36         typedef std::map<irc::sockets::cidr_mask, CloneCounts> CloneMap;
  37
  38  private:
  39         /** Map of IP addresses for clone counting
  40          */
  41         CloneMap clonemap;
  42
  43         /** A CloneCounts that contains zero for both local and global
  44          */
  45         const CloneCounts zeroclonecounts;
  46
  47  public:
  48         /** Constructor, initializes variables
  49          */
  50         UserManager();
  51
  52         /** Destructor, destroys all users in clientlist
  53          */
  54         ~UserManager();
  55
  56         /** Client list, a hash_map containing all clients, local and remote
  57          */
  58         user_hash clientlist;
  59
  60         /** Client list stored by UUID. Contains all clients, and is updated
  61          * automatically by the constructor and destructor of User.
  62          */
  63         user_hash uuidlist;
  64
  65         /** Local client list, a list containing only local clients
  66          */
  67         LocalUserList local_users;
  68
  69         /** Oper list, a vector containing all local and remote opered users
  70          */
  71         std::list<User*> all_opers;
  72
  73         /** Number of unregistered users online right now.
  74          * (Unregistered means before USER/NICK/dns)
  75          */
  76         unsigned int unregistered_count;
  77
  78         /**
  79          * Reset the already_sent IDs so we don't wrap it around and drop a message
  80          * Also removes all expired invites
  81      */
  82         void GarbageCollect();
  83
  84         /** Perform background user events such as PING checks
  85          */
  86         void DoBackgroundUserStuff();
  87
  88         /** Returns true when all modules have done pre-registration checks on a user
  89          * @param user The user to verify
  90          * @return True if all modules have finished checking this user
  91          */
  92         bool AllModulesReportReady(LocalUser* user);
  93
  94         /** Add a client to the system.
  95          * This will create a new User, insert it into the user_hash,
  96          * initialize it as not yet registered, and add it to the socket engine.
  97          * @param socket The socket id (file descriptor) this user is on
  98          * @param via The socket that this user connected using
  99          * @param client The IP address and client port of the user
 100          * @param server The server IP address and port used by the user
 101          * @return This function has no return value, but a call to AddClient may remove the user.
 102          */
 103         void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 104
 105         /** Disconnect a user gracefully
 106          * @param user The user to remove
 107          * @param quitreason The quit reason to show to normal users
 108          * @param operreason The quit reason to show to opers, can be NULL if same as quitreason
 109          * @return Although this function has no return type, on exit the user provided will no longer exist.
 110          */
 111         void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
 112
 113         /** Add a user to the clone map
 114          * @param user The user to add
 115          */
 116         void AddClone(User* user);
 117
 118         /** Remove all clone counts from the user, you should
 119          * use this if you change the user's IP address
 120          * after they have registered.
 121          * @param user The user to remove
 122          */
 123         void RemoveCloneCounts(User *user);
 124
 125         /** Return the number of local and global clones of this user
 126          * @param user The user to get the clone counts for
 127          * @return The clone counts of this user. The returned reference is volatile - you
 128          * must assume that it becomes invalid as soon as you call any function other than
 129          * your own.
 130          */
 131         const CloneCounts& GetCloneCounts(User* user) const;
 132
 133         /** Return a map containg IP addresses and their clone counts
 134          * @return The clone count map
 135          */
 136         const CloneMap& GetCloneMap() const { return clonemap; }
 137
 138         /** Return a count of all global users, unknown and known connections
 139          * @return The number of users on the network, including local unregistered users
 140          */
 141         unsigned int UserCount() const { return this->clientlist.size(); }
 142
 143         /** Return a count of fully registered connections on the network
 144          * @return The number of registered users on the network
 145          */
 146         unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
 147
 148         /** Return a count of opered (umode +o) users on the network
 149          * @return The number of opers on the network
 150          */
 151         unsigned int OperCount() const { return this->all_opers.size(); }
 152
 153         /** Return a count of local unregistered (before NICK/USER) users
 154          * @return The number of local unregistered (unknown) connections
 155          */
 156         unsigned int UnregisteredUserCount() const { return this->unregistered_count; }
 157
 158         /** Return a count of local registered users
 159          * @return The number of registered local users
 160          */
 161         unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
 162
 163         /** Get a hash map containing all users, keyed by their nickname
 164          * @return A hash map mapping nicknames to User pointers
 165          */
 166         user_hash& GetUsers() { return clientlist; }
 167
 168         /** Send a server notice to all local users
 169          * @param text The text format string to send
 170          * @param ... The format arguments
 171          */
 172         void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
 173 };