X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusermanager.h;h=941569e8c02e7af1813ec95468fd7e924a3d36d8;hb=a7a0f69c6bf32b63c3314a097929c533296b1c86;hp=f8337ff8c063d4254f013e88a1f816b98cdabf1b;hpb=61e944f9fd3dc323858cbb5636abd024225aa027;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/usermanager.h b/include/usermanager.h index f8337ff8c..941569e8c 100644 --- a/include/usermanager.h +++ b/include/usermanager.h @@ -1,28 +1,194 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2008 Robin Burchell * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __USERMANAGER_H -#define __USERMANAGER_H -class CoreExport UserManager : public classbase +#pragma once + +#include + +class CoreExport UserManager : public fakederef { - private: - InspIRCd *ServerInstance; public: - UserManager(InspIRCd *Instance) + struct CloneCounts { - ServerInstance = Instance; - } -}; + unsigned int global; + unsigned int local; + CloneCounts() : global(0), local(0) { } + }; + + /** Container that maps IP addresses to clone counts + */ + typedef std::map CloneMap; + + /** Sequence container in which each element is a User* + */ + typedef std::vector OperList; + + /** A list holding local users + */ + typedef insp::intrusive_list LocalList; + + private: + /** Map of IP addresses for clone counting + */ + CloneMap clonemap; + + /** A CloneCounts that contains zero for both local and global + */ + const CloneCounts zeroclonecounts; + + /** Local client list, a list containing only local clients + */ + LocalList local_users; + + /** Last used already sent id, used when sending messages to neighbors to help determine whether the message has + * been sent to a particular user or not. See User::ForEachNeighbor() for more info. + */ + already_sent_t already_sent_id; + + public: + /** Constructor, initializes variables + */ + UserManager(); + + /** Destructor, destroys all users in clientlist + */ + ~UserManager(); + + /** Client list, a hash_map containing all clients, local and remote + */ + 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; + + /** Oper list, a vector containing all local and remote opered users + */ + OperList all_opers; -#endif + /** Number of unregistered users online right now. + * (Unregistered means before USER/NICK/dns) + */ + unsigned int unregistered_count; + + /** 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. + * @param socket The socket id (file descriptor) this user is on + * @param via The socket that this user connected using + * @param client The IP address and client port of the user + * @param server The server IP address and port used by the user + * @return This function has no return value, but a call to AddClient may remove the user. + */ + void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server); + + /** 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, 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 std::string* operreason = NULL); + + /** Add a user to the clone map + * @param user The user to add + */ + void AddClone(User* user); + + /** Remove all clone counts from the user, you should + * use this if you change the user's IP address + * after they have registered. + * @param user The user to remove + */ + void RemoveCloneCounts(User *user); + + /** Rebuild clone counts + */ + void RehashCloneCounts(); + + /** Return the number of local and global clones of this user + * @param user The user to get the clone counts for + * @return The clone counts of this user. The returned reference is volatile - you + * must assume that it becomes invalid as soon as you call any function other than + * your own. + */ + const CloneCounts& GetCloneCounts(User* user) const; + + /** Return a map containg IP addresses and their clone counts + * @return The clone count map + */ + const CloneMap& GetCloneMap() const { return clonemap; } + + /** 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() const { return this->clientlist.size(); } + + /** Return a count of fully registered connections on the network + * @return The number of registered users on the network + */ + unsigned int RegisteredUserCount() { return this->clientlist.size() - this->UnregisteredUserCount(); } + + /** Return a count of opered (umode +o) users on the network + * @return The number of opers on the network + */ + unsigned int OperCount() const { return this->all_opers.size(); } + + /** Return a count of local unregistered (before NICK/USER) users + * @return The number of local unregistered (unknown) connections + */ + unsigned int UnregisteredUserCount() const { return this->unregistered_count; } + + /** Return a count of local registered users + * @return The number of registered local users + */ + unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); } + + /** Get a hash map containing all users, keyed by their nickname + * @return A hash map mapping nicknames to User pointers + */ + user_hash& GetUsers() { return clientlist; } + + /** Get a list containing all local users + * @return A const list of local users + */ + const LocalList& GetLocalUsers() const { return local_users; } + + /** 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); + + /** Retrieves the next already sent id, guaranteed to be not equal to any user's already_sent field + * @return Next already_sent id + */ + already_sent_t NextAlreadySentId(); +};