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 : public fakederef<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         /** Sequence container in which each element is a User*
  39          */
  40         typedef std::vector<User*> OperList;
  41
  42         /** A list holding local users
  43         */
  44         typedef insp::intrusive_list<LocalUser> LocalList;
  45
  46  private:
  47         /** Map of IP addresses for clone counting
  48          */
  49         CloneMap clonemap;
  50
  51         /** A CloneCounts that contains zero for both local and global
  52          */
  53         const CloneCounts zeroclonecounts;
  54
  55         /** Local client list, a list containing only local clients
  56          */
  57         LocalList local_users;
  58
  59         /** Last used already sent id, used when sending messages to neighbors to help determine whether the message has
  60          * been sent to a particular user or not. See User::ForEachNeighbor() for more info.
  61          */
  62         already_sent_t already_sent_id;
  63
  64  public:
  65         /** Constructor, initializes variables
  66          */
  67         UserManager();
  68
  69         /** Destructor, destroys all users in clientlist
  70          */
  71         ~UserManager();
  72
  73         /** Client list, a hash_map containing all clients, local and remote
  74          */
  75         user_hash clientlist;
  76
  77         /** Client list stored by UUID. Contains all clients, and is updated
  78          * automatically by the constructor and destructor of User.
  79          */
  80         user_hash uuidlist;
  81
  82         /** Oper list, a vector containing all local and remote opered users
  83          */
  84         OperList all_opers;
  85
  86         /** Number of unregistered users online right now.
  87          * (Unregistered means before USER/NICK/dns)
  88          */
  89         unsigned int unregistered_count;
  90
  91         /** Perform background user events such as PING checks
  92          */
  93         void DoBackgroundUserStuff();
  94
  95         /** Returns true when all modules have done pre-registration checks on a user
  96          * @param user The user to verify
  97          * @return True if all modules have finished checking this user
  98          */
  99         bool AllModulesReportReady(LocalUser* user);
 100
 101         /** Add a client to the system.
 102          * This will create a new User, insert it into the user_hash,
 103          * initialize it as not yet registered, and add it to the socket engine.
 104          * @param socket The socket id (file descriptor) this user is on
 105          * @param via The socket that this user connected using
 106          * @param client The IP address and client port of the user
 107          * @param server The server IP address and port used by the user
 108          * @return This function has no return value, but a call to AddClient may remove the user.
 109          */
 110         void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 111
 112         /** Disconnect a user gracefully
 113          * @param user The user to remove
 114          * @param quitreason The quit reason to show to normal users
 115          * @param operreason The quit reason to show to opers, can be NULL if same as quitreason
 116          * @return Although this function has no return type, on exit the user provided will no longer exist.
 117          */
 118         void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL);
 119
 120         /** Add a user to the clone map
 121          * @param user The user to add
 122          */
 123         void AddClone(User* user);
 124
 125         /** Remove all clone counts from the user, you should
 126          * use this if you change the user's IP address
 127          * after they have registered.
 128          * @param user The user to remove
 129          */
 130         void RemoveCloneCounts(User *user);
 131
 132         /** Rebuild clone counts
 133          */
 134         void RehashCloneCounts();
 135
 136         /** Return the number of local and global clones of this user
 137          * @param user The user to get the clone counts for
 138          * @return The clone counts of this user. The returned reference is volatile - you
 139          * must assume that it becomes invalid as soon as you call any function other than
 140          * your own.
 141          */
 142         const CloneCounts& GetCloneCounts(User* user) const;
 143
 144         /** Return a map containg IP addresses and their clone counts
 145          * @return The clone count map
 146          */
 147         const CloneMap& GetCloneMap() const { return clonemap; }
 148
 149         /** Return a count of all global users, unknown and known connections
 150          * @return The number of users on the network, including local unregistered users
 151          */
 152         unsigned int UserCount() const { return this->clientlist.size(); }
 153
 154         /** Return a count of fully registered connections on the network
 155          * @return The number of registered users on the network
 156          */
 157         unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); }
 158
 159         /** Return a count of opered (umode +o) users on the network
 160          * @return The number of opers on the network
 161          */
 162         unsigned int OperCount() const { return this->all_opers.size(); }
 163
 164         /** Return a count of local unregistered (before NICK/USER) users
 165          * @return The number of local unregistered (unknown) connections
 166          */
 167         unsigned int UnregisteredUserCount() const { return this->unregistered_count; }
 168
 169         /** Return a count of local registered users
 170          * @return The number of registered local users
 171          */
 172         unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); }
 173
 174         /** Get a hash map containing all users, keyed by their nickname
 175          * @return A hash map mapping nicknames to User pointers
 176          */
 177         user_hash& GetUsers() { return clientlist; }
 178
 179         /** Get a list containing all local users
 180          * @return A const list of local users
 181          */
 182         const LocalList& GetLocalUsers() const { return local_users; }
 183
 184         /** Send a server notice to all local users
 185          * @param text The text format string to send
 186          * @param ... The format arguments
 187          */
 188         void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
 189
 190         /** Retrieves the next already sent id, guaranteed to be not equal to any user's already_sent field
 191          * @return Next already_sent id
 192          */
 193         already_sent_t NextAlreadySentId();
 194 };