1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #ifndef __USERMANAGER_H
15 #define __USERMANAGER_H
19 /** A list of ip addresses cross referenced against clone counts */
20 typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
22 class CoreExport UserManager
25 /** Map of local ip addresses for clone counting
27 clonemap local_clones;
31 for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
40 /** Client list, a hash_map containing all clients, local and remote
42 user_hash* clientlist;
44 /** Client list stored by UUID. Contains all clients, and is updated
45 * automatically by the constructor and destructor of User.
49 /** Local client list, a vector containing only local clients
51 std::vector<LocalUser*> local_users;
53 /** Oper list, a vector containing all local and remote opered users
55 std::list<User*> all_opers;
57 /** Number of unregistered users online right now.
58 * (Unregistered means before USER/NICK/dns)
60 int unregistered_count;
62 /** Map of global ip addresses for clone counting
63 * XXX - this should be private, but m_clones depends on it currently.
65 clonemap global_clones;
67 /** Add a client to the system.
68 * This will create a new User, insert it into the user_hash,
69 * initialize it as not yet registered, and add it to the socket engine.
70 * @param Instance a pointer to the server instance
71 * @param socket The socket id (file descriptor) this user is on
72 * @param via The socket that this user connected using
73 * @param client The IP address and client port of the user
74 * @param server The server IP address and port used by the user
75 * @return This function has no return value, but a call to AddClient may remove the user.
77 void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
79 /** Disconnect a user gracefully
80 * @param user The user to remove
81 * @param r The quit reason to show to normal users
82 * @param oreason The quit reason to show to opers
83 * @return Although this function has no return type, on exit the user provided will no longer exist.
85 void QuitUser(User *user, const std::string &quitreason, const char* operreason = "");
87 /** Add a user to the local clone map
88 * @param user The user to add
90 void AddLocalClone(User *user);
92 /** Add a user to the global clone map
93 * @param user The user to add
95 void AddGlobalClone(User *user);
97 /** Remove all clone counts from the user, you should
98 * use this if you change the user's IP address
99 * after they have registered.
100 * @param user The user to remove
102 void RemoveCloneCounts(User *user);
104 /** Return the number of global clones of this user
105 * @param user The user to get a count for
106 * @return The global clone count of this user
108 unsigned long GlobalCloneCount(User *user);
110 /** Return the number of local clones of this user
111 * @param user The user to get a count for
112 * @return The local clone count of this user
114 unsigned long LocalCloneCount(User *user);
116 /** Return a count of users, unknown and known connections
117 * @return The number of users
119 unsigned int UserCount();
121 /** Return a count of fully registered connections only
122 * @return The number of registered users
124 unsigned int RegisteredUserCount();
126 /** Return a count of opered (umode +o) users only
127 * @return The number of opers
129 unsigned int OperCount();
131 /** Return a count of unregistered (before NICK/USER) users only
132 * @return The number of unregistered (unknown) connections
134 unsigned int UnregisteredUserCount();
136 /** Return a count of local users on this server only
137 * @return The number of local users
139 unsigned int LocalUserCount();
144 /** Number of users with a certain mode set on them
146 int ModeCount(const char mode);
148 /** Send a server notice to all local users
149 * @param text The text format string to send
150 * @param ... The format arguments
152 void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
154 /** Send a server message (PRIVMSG) to all local users
155 * @param text The text format string to send
156 * @param ... The format arguments
158 void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3);