X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusermanager.h;h=eb1d75e8d50b188621aa6e2b32889c6299724cc4;hb=d60103cada2c954f6d735c0ae4fb7d9b1b5ed844;hp=0fe418ba3fb25dbf02972049fa176b7c983d7da3;hpb=bfaf7e3b27981a5144faba6d17c6e29fac735dbb;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/usermanager.h b/include/usermanager.h index 0fe418ba3..eb1d75e8d 100644 --- a/include/usermanager.h +++ b/include/usermanager.h @@ -1,51 +1,70 @@ -/* +------------------------------------+ - * | 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 -#include +#pragma once -/** A list of ip addresses cross referenced against clone counts */ -typedef std::map clonemap; +#include -class CoreExport UserManager : public classbase +class CoreExport UserManager { + public: + struct CloneCounts + { + unsigned int global; + unsigned int local; + CloneCounts() : global(0), local(0) { } + }; + + /** Container that maps IP addresses to clone counts + */ + typedef std::map CloneMap; + private: - InspIRCd *ServerInstance; + /** Map of IP addresses for clone counting + */ + CloneMap clonemap; - /** Map of local ip addresses for clone counting + /** A CloneCounts that contains zero for both local and global */ - clonemap local_clones; + const CloneCounts zeroclonecounts; + public: - UserManager(InspIRCd *Instance) - { - ServerInstance = Instance; - } + /** 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; + 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; + user_hash uuidlist; - /** Local client list, a vector containing only local clients + /** Local client list, a list containing only local clients */ - std::vector local_users; + LocalUserList local_users; /** Oper list, a vector containing all local and remote opered users */ @@ -54,107 +73,101 @@ class CoreExport UserManager : public classbase /** Number of unregistered users online right now. * (Unregistered means before USER/NICK/dns) */ - int unregistered_count; + unsigned int unregistered_count; + + /** + * 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(); - /** Map of global ip addresses for clone counting - * XXX - this should be private, but m_clones depends on it currently. + /** 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 */ - clonemap global_clones; + 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 Instance a pointer to the server instance * @param socket The socket id (file descriptor) this user is on - * @param port The port number this user connected on - * @param iscached This variable is reserved for future use - * @param ip The IP address of the user + * @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 AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip); + void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server); - /** Add a user to the local clone map - * @param user The user to add + /** 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 AddLocalClone(User *user); + void QuitUser(User* user, const std::string& quitreason, const std::string* operreason = NULL); - /** Add a user to the global clone map + /** Add a user to the clone map * @param user The user to add */ - void AddGlobalClone(User *user); + void AddClone(User* user); /** Remove all clone counts from the user, you should - * use this if you change the user's IP address + * use this if you change the user's IP address * after they have registered. * @param user The user to remove */ void RemoveCloneCounts(User *user); - /** Return the number of global clones of this user - * @param user The user to get a count for - * @return The global clone count of this user + /** 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. */ - unsigned long GlobalCloneCount(User *user); + const CloneCounts& GetCloneCounts(User* user) const; - /** Return the number of local clones of this user - * @param user The user to get a count for - * @return The local clone count of this user + /** Return a map containg IP addresses and their clone counts + * @return The clone count map */ - unsigned long LocalCloneCount(User *user); + const CloneMap& GetCloneMap() const { return clonemap; } - /** 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(); - + unsigned int LocalUserCount() const { return (this->local_users.size() - this->UnregisteredUserCount()); } - - - /** Number of users with a certain mode set on them + /** Get a hash map containing all users, keyed by their nickname + * @return A hash map mapping nicknames to User pointers */ - int ModeCount(const char mode); + user_hash& GetUsers() { return clientlist; } /** 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, ...); - - /** 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, ...); - - /** Send text to all users with a specific set of modes - * @param modes The modes to check against, without a +, e.g. 'og' - * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the - * mode characters in the first parameter causes receipt of the message, and - * if you specify WM_OR, all the modes must be present. - * @param text The text format string to send - * @param ... The format arguments - */ - void WriteMode(const char* modes, int flags, const char* text, ...); + void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3); }; - -#endif