X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=4d7994e8ef995eb6527e454514b111301fcd4a59;hb=31897d26f2ae1f0fc794a5af512dd4e81053611b;hp=0fa51268d7bd191869412a461d53e1512730a0ef;hpb=d48726ce802019f2e1573ebef7ae9f50a14f0a31;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 0fa51268d..4d7994e8e 100644 --- a/include/users.h +++ b/include/users.h @@ -1,37 +1,42 @@ -/* +------------------------------------+ - * | 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) 2019 linuxdaemon + * Copyright (C) 2019 Matt Schatz + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012-2016, 2018 Attila Molnar + * Copyright (C) 2012-2013, 2016-2019 Sadie Powell + * Copyright (C) 2012, 2018-2019 Robby + * Copyright (C) 2012 DjSlash + * Copyright (C) 2012 ChrisTX + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2008 John Brooks + * Copyright (C) 2007-2009 Robin Burchell + * Copyright (C) 2007, 2009 Dennis Friis + * Copyright (C) 2006-2008 Craig Edwards * - * 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 __USERS_H__ -#define __USERS_H__ -#include "socket.h" -#include "connection.h" -#include "dns.h" +#pragma once +#include "socket.h" +#include "inspsocket.h" #include "mode.h" - -/** Channel status for a user - */ -enum ChanStatus { - /** Op */ - STATUS_OP = 4, - /** Halfop */ - STATUS_HOP = 2, - /** Voice */ - STATUS_VOICE = 1, - /** None */ - STATUS_NORMAL = 0 -}; +#include "membership.h" /** connect class types */ @@ -39,22 +44,9 @@ enum ClassTypes { /** connect:allow */ CC_ALLOW = 0, /** connect:deny */ - CC_DENY = 1 -}; - -/** RFC1459 channel modes - */ -enum UserModes { - /** +s: Server notices */ - UM_SERVERNOTICE = 's' - 65, - /** +w: WALLOPS */ - UM_WALLOPS = 'w' - 65, - /** +i: Invisible */ - UM_INVISIBLE = 'i' - 65, - /** +o: Operator */ - UM_OPERATOR = 'o' - 65, - /** +n: Server notice mask */ - UM_SNOMASK = 'n' - 65 + CC_DENY = 1, + /** named connect block (for opers, etc) */ + CC_NAMED = 2 }; /** Registration state of a user, e.g. @@ -62,7 +54,7 @@ enum UserModes { */ enum RegistrationState { -#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0. +#ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0. REG_NONE = 0, /* Has sent nothing */ #endif @@ -72,53 +64,61 @@ enum RegistrationState { REG_ALL = 7 /* REG_NICKUSER plus next bit along */ }; -/* Required forward declaration */ -class Channel; -class UserResolver; +enum UserType { + USERTYPE_LOCAL = 1, + USERTYPE_REMOTE = 2, + USERTYPE_SERVER = 3 +}; /** Holds information relevent to <connect allow> and <connect deny> tags in the config file. */ -class CoreExport ConnectClass : public classbase +struct CoreExport ConnectClass : public refcountbase { - private: + reference config; /** Type of line, either CC_ALLOW or CC_DENY */ char type; + + /** True if this class uses fake lag to manage flood, false if it kills */ + bool fakelag; + /** Connect class name */ std::string name; + /** Max time to register the connection in seconds */ unsigned int registration_timeout; - /** Number of lines in buffer before excess flood is triggered - */ - unsigned int flood; + /** Host mask for this line */ std::string host; + /** Number of seconds between pings for this line */ unsigned int pingtime; - /** (Optional) Password for this line - */ - std::string pass; - - /** (Optional) Hash Method for this line - */ - std::string hash; - /** Threshold value for flood disconnect + /** Maximum size of sendq for users in this class (bytes) + * Users cannot send commands if they go over this limit */ - unsigned int threshold; + unsigned long softsendqmax; /** Maximum size of sendq for users in this class (bytes) + * Users are killed if they go over this limit */ - unsigned long sendqmax; + unsigned long hardsendqmax; /** Maximum size of recvq for users in this class (bytes) */ unsigned long recvqmax; + /** Seconds worth of penalty before penalty system activates + */ + unsigned int penaltythreshold; + + /** Maximum rate of commands (units: millicommands per second) */ + unsigned int commandrate; + /** Local max when connecting by this connection class */ unsigned long maxlocal; @@ -127,184 +127,54 @@ class CoreExport ConnectClass : public classbase */ unsigned long maxglobal; - /** Max channels for this class + /** True if max connections for this class is hit and a warning is wanted */ - unsigned int maxchans; + bool maxconnwarn; - /** Port number this connect class applies to + /** Max channels for this class */ - int port; - -public: + unsigned int maxchans; - /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows). + /** How many users may be in this connect class before they are refused? + * (0 = no limit = default) */ - ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name), - registration_timeout(source->registration_timeout), flood(source->flood), host(source->host), - pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(0) - { - } + unsigned long limit; - /** Create a new connect class with no settings. + /** If set to true, no user DNS lookups are to be performed */ - ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""), - threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0) - { - } + bool resolvehostnames; - /** Create a new connect class to ALLOW connections. - * @param thename Name of the connect class - * @param timeout The registration timeout - * @param fld The flood value - * @param hst The IP mask to allow - * @param ping The ping frequency - * @param pas The password to be used - * @param hsh The hash to be used - * @param thres The flooding threshold - * @param sendq The maximum sendq value - * @param recvq The maximum recvq value - * @param maxl The maximum local sessions - * @param maxg The maximum global sessions - */ - ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping, - const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq, - unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) : - type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh), - threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { } - - /** Create a new connect class to DENY connections - * @param thename Name of the connect class - * @param hst The IP mask to deny - */ - ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0), - flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0) - { - } - - /* Create a new connect class based on another class - * @param thename The name of the connect class - * @param source Another connect class to inherit all but the name from + /** + * If non-empty the server ports which this user has to be using */ - ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename), - registration_timeout(source->registration_timeout), flood(source->flood), host(source->host), - pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(0) - { - } + insp::flat_set ports; - void SetDisabled(bool t) - { - this->disabled = t; - } - - bool GetDisabled() - { - return this->disabled; - } + /** If non-empty then the password a user must specify in PASS to be assigned to this class. */ + std::string password; - /* Update an existing entry with new values - */ - void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping, - const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq, - unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit) - { - if (timeout) - registration_timeout = timeout; - if (fld) - flood = fld; - if (!hst.empty()) - host = hst; - if (ping) - pingtime = ping; - if (!pas.empty()) - pass = pas; - if (thres) - threshold = thres; - if (sendq) - sendqmax = sendq; - if (recvq) - recvqmax = recvq; - if (maxl) - maxlocal = maxl; - if (maxg) - maxglobal = maxg; - if (maxc) - maxchans = maxc; - if (p) - port = p; - - this->limit = llimit; - } - - /** Reference counter. Contains an int as to how many users are connected to this class. :) - * This will be 0 if no users are connected. If a is removed from the config, and there - * are 0 users on it - it will go away in RAM. :) - */ - unsigned long RefCount; + /** If non-empty then the hash algorithm that the password field is hashed with. */ + std::string passwordhash; - /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written + /** Create a new connect class with no settings. */ - bool disabled; - - /** How many users may be in this connect class before they are refused? (0 = disabled = default) + ConnectClass(ConfigTag* tag, char type, const std::string& mask); + /** Create a new connect class with inherited settings. */ - unsigned long limit; - - int GetMaxChans() - { - return maxchans; - } + ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent); - /** Returns the type, CC_ALLOW or CC_DENY - */ - char GetType() - { - return (type == CC_ALLOW ? CC_ALLOW : CC_DENY); - } + /** Update the settings in this block to match the given block */ + void Update(const ConnectClass* newSettings); - std::string& GetName() - { - return name; - } + const std::string& GetName() { return name; } + const std::string& GetHost() { return host; } /** Returns the registration timeout */ - unsigned int GetRegTimeout() + time_t GetRegTimeout() { return (registration_timeout ? registration_timeout : 90); } - /** Returns the flood limit - */ - unsigned int GetFlood() - { - return (threshold ? flood : 999); - } - - /** Returns the allowed or denied IP mask - */ - const std::string& GetHost() - { - return host; - } - - /** Get port number - */ - int GetPort() - { - return port; - } - - /** Set port number - */ - void SetPort(int p) - { - port = p; - } - /** Returns the ping frequency */ unsigned int GetPingTime() @@ -312,42 +182,41 @@ public: return (pingtime ? pingtime : 120); } - /** Returns the password or an empty string + /** Returns the maximum sendq value (soft limit) + * Note that this is in addition to internal OS buffers */ - const std::string& GetPass() + unsigned long GetSendqSoftMax() { - return pass; + return (softsendqmax ? softsendqmax : 4096); } - /** Returns the hash or an empty string + /** Returns the maximum sendq value (hard limit) */ - const std::string& GetHash() + unsigned long GetSendqHardMax() { - return hash; + return (hardsendqmax ? hardsendqmax : 0x100000); } - /** Returns the flood threshold value + /** Returns the maximum recvq value */ - unsigned int GetThreshold() + unsigned long GetRecvqMax() { - return (threshold ? threshold : 1); + return (recvqmax ? recvqmax : 4096); } - /** Returns the maximum sendq value + /** Returns the penalty threshold value */ - unsigned long GetSendqMax() + unsigned int GetPenaltyThreshold() { - return (sendqmax ? sendqmax : 262114); + return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20); } - /** Returns the maximum recvq value - */ - unsigned long GetRecvqMax() + unsigned int GetCommandRate() { - return (recvqmax ? recvqmax : 4096); + return commandrate ? commandrate : 1000; } - /** Returusn the maximum number of local sessions + /** Return the maximum number of local sessions */ unsigned long GetMaxLocal() { @@ -362,359 +231,210 @@ public: } }; -/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire. - */ -typedef std::vector< std::pair > InvitedList; - -/** Holds a complete list of all allow and deny tags from the configuration file (connection classes) - */ -typedef std::vector ClassVector; - -/** Typedef for the list of user-channel records for a user - */ -typedef std::map UserChanList; - -/** Shorthand for an iterator into a UserChanList - */ -typedef UserChanList::iterator UCListIter; - -/* Required forward declaration - */ -class User; - -/** Visibility data for a user. - * If a user has a non-null instance of this class in their User, - * then it is used to determine if this user is visible to other users - * or not. - */ -class CoreExport VisData -{ - public: - /** Create a visdata - */ - VisData(); - /** Destroy a visdata - */ - virtual ~VisData(); - /** Is this user visible to some other user? - * @param user The other user to compare to - * @return true True if the user is visible to the other user, false if not - */ - virtual bool VisibleTo(User* user); -}; - /** Holds all information about a user * This class stores all information about a user connected to the irc server. Everything about a * connection is stored here primarily, from the user's socket ID (file descriptor) through to the - * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user - * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their - * file descriptor value. + * user's nickname and hostname. */ -class CoreExport User : public connection +class CoreExport User : public Extensible { private: - /** Pointer to creator. - * This is required to make use of core functions - * from within the User class. - */ - InspIRCd* ServerInstance; - - /** A list of channels the user has a pending invite to. - * Upon INVITE channels are added, and upon JOIN, the - * channels are removed from this list. - */ - InvitedList invites; - - /** Number of channels this user is currently on - */ - unsigned int ChannelCount; - - /** Cached nick!ident@host value using the real hostname + /** Cached nick!ident@dhost value using the displayed hostname */ - char* cached_fullhost; + std::string cached_fullhost; - /** Cached nick!ident@ip value using the real IP address + /** Cached ident@ip value using the real IP address */ - char* cached_hostip; + std::string cached_hostip; - /** Cached nick!ident@host value using the masked hostname + /** Cached ident@realhost value using the real hostname */ - char* cached_makehost; + std::string cached_makehost; /** Cached nick!ident@realhost value using the real hostname */ - char* cached_fullrealhost; - - /** When we erase the user (in the destructor), - * we call this method to subtract one from all - * mode characters this user is making use of. - */ - void DecrementModes(); + std::string cached_fullrealhost; - /** Max channels for this user + /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. */ - unsigned int MaxChans; - - std::map* AllowedOperCommands; + std::string cachedip; - /** Allowed user modes from oper classes. */ - bool* AllowedUserModes; + /** If set then the hostname which is displayed to users. */ + std::string displayhost; - /** Allowed channel modes from oper classes. */ - bool* AllowedChanModes; + /** The real hostname of this user. */ + std::string realhost; - public: - /** Module responsible for raw i/o - */ - Module* io; + /** The real name of this user. */ + std::string realname; - /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections. - * The pointer is guarenteed to *always* be valid. :) + /** The user's mode list. + * Much love to the STL for giving us an easy to use bitset, saving us RAM. + * if (modes[modeid]) is set, then the mode is set. + * For example, to work out if mode +i is set, we check the field + * User::modes[invisiblemode->modeid] == true. */ - ConnectClass *MyClass; + std::bitset modes; - /** Resolvers for looking up this users IP address - * This will occur if and when res_reverse completes. - * When this class completes its lookup, User::dns_done - * will be set from false to true. + public: + /** To execute a function for each local neighbor of a user, inherit from this class and + * pass an instance of it to User::ForEachNeighbor(). */ - UserResolver* res_forward; + class ForEachNeighborHandler + { + public: + /** Method to execute for each local neighbor of a user. + * Derived classes must implement this. + * @param user Current neighbor + */ + virtual void Execute(LocalUser* user) = 0; + }; - /** Resolvers for looking up this users hostname - * This is instantiated by User::StartDNSLookup(), - * and on success, instantiates User::res_reverse. + /** List of Memberships for this user */ - UserResolver* res_reverse; + typedef insp::intrusive_list ChanList; - /** User visibility state, see definition of VisData. - */ - VisData* Visibility; + /** Time that the object was instantiated (used for TS calculation etc) + */ + time_t age; - /** Stored reverse lookup from res_forward + /** Time the connection was created, set in the constructor. This + * may be different from the time the user's classbase object was + * created. */ - std::string stored_host; + time_t signon; - /** Starts a DNS lookup of the user's IP. - * This will cause two UserResolver classes to be instantiated. - * When complete, these objects set User::dns_done to true. + /** Client address that the user is connected from. + * Do not modify this value directly, use SetClientIP() to change it. + * Port is not valid for remote users. */ - void StartDNSLookup(); - - unsigned int GetMaxChans(); + irc::sockets::sockaddrs client_sa; /** The users nickname. * An invalid nickname indicates an unregistered connection prior to the NICK command. * Use InspIRCd::IsNick() to validate nicknames. */ - char nick[NICKMAX]; + std::string nick; /** The user's unique identifier. * This is the unique identifier which the user has across the network. */ - char uuid[UUID_LENGTH]; + const std::string uuid; /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. */ - char ident[IDENTMAX+2]; - - /** The host displayed to non-opers (used for cloaking etc). - * This usually matches the value of User::host. - */ - char dhost[65]; - - /** The users full name (GECOS). - */ - char fullname[MAXGECOS+1]; - - /** The user's mode list. - * This is NOT a null terminated string! In the 1.1 version of InspIRCd - * this is an array of values in a similar way to channel modes. - * A value of 1 in field (modeletter-65) indicates that the mode is - * set, for example, to work out if mode +s is set, we check the field - * User::modes['s'-65] != 0. - * The following RFC characters o, w, s, i have constants defined via an - * enum, such as UM_SERVERNOTICE and UM_OPETATOR. - */ - char modes[64]; + std::string ident; /** What snomasks are set on this user. * This functions the same as the above modes. */ - char snomasks[64]; + std::bitset<64> snomasks; - /** Channels this user is on, and the permissions they have there + /** Channels this user is on */ - UserChanList chans; + ChanList chans; /** The server the user is connected to. */ - const char* server; + Server* server; /** The user's away message. * If this string is empty, the user is not marked as away. */ - char awaymsg[MAXAWAY+1]; + std::string awaymsg; /** Time the user last went away. - * This is ONLY RELIABLE if user IS_AWAY()! + * This is ONLY RELIABLE if user IsAway()! */ time_t awaytime; - /** Timestamp of current time + connection class timeout. - * This user must send USER/NICK before this timestamp is - * reached or they will be disconnected. - */ - time_t timeout; - /** The oper type they logged in as, if they are an oper. - * This is used to check permissions in operclasses, so that - * we can say 'yay' or 'nay' to any commands they issue. - * The value of this is the value of a valid 'type name=' tag. - */ - char oper[NICKMAX]; - - /** True when DNS lookups are completed. - * The UserResolver classes res_forward and res_reverse will - * set this value once they complete. - */ - bool dns_done; - - /** Password specified by the user when they registered. - * This is stored even if the block doesnt need a password, so that - * modules may check it. - */ - char password[64]; - - /** User's receive queue. - * Lines from the IRCd awaiting processing are stored here. - * Upgraded april 2005, old system a bit hairy. - */ - std::string recvq; - - /** User's send queue. - * Lines waiting to be sent are stored here until their buffer is flushed. - */ - std::string sendq; - - /** Message user will quit with. Not to be set externally. */ - std::string quitmsg; + reference oper; - /** Quit message shown to opers - not to be set externally. + /** Used by User to indicate the registration status of the connection + * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate + * the connection state. */ - std::string operquitmsg; - - /** Whether or not to send an snotice about this user's quitting - */ - bool quietquit; - - /** Flood counters - lines received - */ - unsigned int lines_in; - - /** Flood counters - time lines_in is due to be reset - */ - time_t reset_due; + unsigned int registered:3; /** If this is set to true, then all socket operations for the user * are dropped into the bit-bucket. * This value is set by QuitUser, and is not needed seperately from that call. * Please note that setting this value alone will NOT cause the user to quit. */ - bool quitting; - - /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/ - * GetIPString/GetPort to obtain its values. - */ - sockaddr* ip; - - /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. - */ - std::string cachedip; + unsigned int quitting:1; - /** Initialize the clients sockaddr - * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6 - * @param ip A human-readable IP address for this user matching the protcol_family - * @param port The port number of this user or zero for a remote user - */ - void SetSockAddr(int protocol_family, const char* ip, int port); + /** What type of user is this? */ + const UserType usertype:2; - /** Get port number from sockaddr - * @return The port number of this user. + /** Get client IP string from sockaddr, using static internal buffer + * @return The IP string */ - int GetPort(); + const std::string& GetIPString(); - /** Get protocol family from sockaddr - * @return The protocol family of this user, either AF_INET or AF_INET6 + /** Retrieves this user's hostname. + * @param uncloak If true then return the real host; otherwise, the display host. */ - int GetProtocolFamily(); + const std::string& GetHost(bool uncloak) const; - /** Get IP string from sockaddr, using static internal buffer - * @return The IP string - */ - const char* GetIPString(); + /** Retrieves this user's displayed hostname. */ + const std::string& GetDisplayedHost() const; - /* Write error string - */ - std::string WriteError; + /** Retrieves this user's real hostname. */ + const std::string& GetRealHost() const; - /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. - */ - bool exempt; + /** Retrieves this user's real name. */ + const std::string& GetRealName() const; - /** This value contains how far into the penalty threshold the user is. Once its over - * the penalty threshold then commands are held and processed on-timer. + /** Get CIDR mask, using default range, for this user */ - int Penalty; + irc::sockets::cidr_mask GetCIDRMask(); - /** True if we are flushing penalty lines + /** Sets the client IP for this user + * @return true if the conversion was successful */ - bool OverPenalty; + virtual bool SetClientIP(const std::string& address); - /** If this bool is set then penalty rules do not apply to this user - */ - bool ExemptFromPenalty; + virtual void SetClientIP(const irc::sockets::sockaddrs& sa); - /** Default constructor + /** Constructor * @throw CoreException if the UID allocated to the user already exists - * @param Instance Creator instance - * @param uid User UUID, or empty to allocate one automatically */ - User(InspIRCd* Instance, const std::string &uid = ""); + User(const std::string& uid, Server* srv, UserType objtype); /** Returns the full displayed host of the user * This member function returns the hostname of the user as seen by other users - * on the server, in nick!ident&at;host form. + * on the server, in nick!ident\@host form. * @return The full masked host of the user */ - virtual char* GetFullHost(); + virtual const std::string& GetFullHost(); /** Returns the full real host of the user * This member function returns the hostname of the user as seen by other users - * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation, + * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation, * e.g. through a module, then this method will ignore it and return the true hostname. * @return The full real host of the user */ - virtual char* GetFullRealHost(); + virtual const std::string& GetFullRealHost(); /** This clears any cached results that are used for GetFullRealHost() etc. * The results of these calls are cached as generating them can be generally expensive. */ void InvalidateCache(); - /** Create a displayable mode string for this users snomasks - * @return The notice mask character sequence + /** Returns whether this user is currently away or not. If true, + * further information can be found in User::awaymsg and User::awaytime + * @return True if the user is away, false otherwise */ - const char* FormatNoticeMasks(); + bool IsAway() const { return (!awaymsg.empty()); } - /** Process a snomask modifier string, e.g. +abc-de - * @param sm A sequence of notice mask characters - * @return The cleaned mode sequence which can be output, - * e.g. in the above example if masks c and e are not - * valid, this function will return +ab-d + /** Returns whether this user is an oper or not. If true, + * oper information can be obtained from User::oper + * @return True if the user is an oper, false otherwise */ - std::string ProcessNoticeMasks(const char *sm); + bool IsOper() const { return oper; } /** Returns true if a notice mask is set * @param sm A notice mask character to check @@ -722,47 +442,28 @@ class CoreExport User : public connection */ bool IsNoticeMaskSet(unsigned char sm); - /** Changed a specific notice mask value - * @param sm The server notice mask to change - * @param value An on/off value for this mask - */ - void SetNoticeMask(unsigned char sm, bool value); - - /** Create a displayable mode string for this users umodes - * @param The mode string + /** Get the mode letters of modes set on the user as a string. + * @param includeparams True to get the parameters of the modes as well. Defaults to false. + * @return Mode letters of modes set on the user and optionally the parameters of those modes, if any. + * The returned string always begins with a '+' character. If the user has no modes set, "+" is returned. */ - const char* FormatModes(); + std::string GetModeLetters(bool includeparams = false) const; /** Returns true if a specific mode is set * @param m The user mode * @return True if the mode is set */ - bool IsModeSet(unsigned char m); + bool IsModeSet(unsigned char m) const; + bool IsModeSet(const ModeHandler* mh) const; + bool IsModeSet(const ModeHandler& mh) const { return IsModeSet(&mh); } + bool IsModeSet(UserModeReference& moderef) const; /** Set a specific usermode to on or off - * @param m The user mode + * @param mh The user mode * @param value On or off setting of the mode */ - void SetMode(unsigned char m, bool value); - - /** Returns true if a user is invited to a channel. - * @param channel A channel name to look up - * @return True if the user is invited to the given channel - */ - virtual bool IsInvited(const irc::string &channel); - - /** Adds a channel to a users invite list (invites them to a channel) - * @param channel A channel name to add - * @param timeout When the invite should expire (0 == never) - */ - virtual void InviteTo(const irc::string &channel, time_t timeout); - - /** Removes a channel from a users invite list. - * This member function is called on successfully joining an invite only channel - * to which the user has previously been invited, to clear the invitation. - * @param channel The channel to remove the invite to - */ - virtual void RemoveInvite(const irc::string &channel); + void SetMode(ModeHandler* mh, bool value); + void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); } /** Returns true or false for if a user can execute a privilaged oper command. * This is done by looking up their oper type from User::oper, then referencing @@ -770,410 +471,506 @@ class CoreExport User : public connection * @param command A command (should be all CAPS) * @return True if this user can execute the command */ - bool HasPermission(const std::string &command); + virtual bool HasCommandPermission(const std::string& command); + + /** Returns true if a user has a given permission. + * This is used to check whether or not users may perform certain actions which admins may not wish to give to + * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc. + * + * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file. + * @return True if this user has the permission in question. + */ + virtual bool HasPrivPermission(const std::string& privstr); /** Returns true or false if a user can set a privileged user or channel mode. * This is done by looking up their oper type from User::oper, then referencing * this to their oper classes, and checking the modes they can set. - * @param mode The mode the check - * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER). + * @param mh Mode to check * @return True if the user can set or unset this mode. */ - bool HasModePermission(unsigned char mode, ModeType type); + virtual bool HasModePermission(const ModeHandler* mh) const; - /** Calls read() to read some data for this user using their fd. - * @param buffer The buffer to read into - * @param size The size of data to read - * @return The number of bytes read, or -1 if an error occured. + /** Determines whether this user can set the specified snomask. + * @param chr The server notice mask character to look up. + * @return True if the user can set the specified snomask; otherwise, false. */ - int ReadData(void* buffer, size_t size); + virtual bool HasSnomaskPermission(char chr) const; - /** This method adds data to the read buffer of the user. - * The buffer can grow to any size within limits of the available memory, - * managed by the size of a std::string, however if any individual line in - * the buffer grows over 600 bytes in length (which is 88 chars over the - * RFC-specified limit per line) then the method will return false and the - * text will not be inserted. - * @param a The string to add to the users read buffer - * @return True if the string was successfully added to the read buffer + /** Creates a usermask with real host. + * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host + * @return the usermask in the format user\@host */ - bool AddBuffer(std::string a); + const std::string& MakeHost(); - /** This method returns true if the buffer contains at least one carriage return - * character (e.g. one complete line may be read) - * @return True if there is at least one complete line in the users buffer + /** Creates a usermask with real ip. + * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip + * @return the usermask in the format user\@ip */ - bool BufferIsReady(); + const std::string& MakeHostIP(); - /** This function clears the entire buffer by setting it to an empty string. + /** Oper up the user using the given opertype. + * This will also give the +o usermode. */ - void ClearBuffer(); + void Oper(OperInfo* info); - /** This method returns the first available string at the tail end of the buffer - * and advances the tail end of the buffer past the string. This means it is - * a one way operation in a similar way to strtok(), and multiple calls return - * multiple lines if they are available. The results of this function if there - * are no lines to be read are unknown, always use BufferIsReady() to check if - * it is ok to read the buffer before calling GetBuffer(). - * @return The string at the tail end of this users buffer + /** Oper down. + * This will clear the +o usermode and unset the user's oper type */ - std::string GetBuffer(); + void UnOper(); - /** Sets the write error for a connection. This is done because the actual disconnect - * of a client may occur at an inopportune time such as half way through /LIST output. - * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and - * errored clients purged. - * @param error The error string to set. + /** Sends a server notice to this user. + * @param text The contents of the message to send. */ - void SetWriteError(const std::string &error); + void WriteNotice(const std::string& text); - /** Returns the write error which last occured on this connection or an empty string - * if none occured. - * @return The error string which has occured for this user + /** Send a NOTICE message from the local server to the user. + * @param text Text to send */ - const char* GetWriteError(); + virtual void WriteRemoteNotice(const std::string& text); - /** Adds to the user's write buffer. - * You may add any amount of text up to this users sendq value, if you exceed the - * sendq value, SetWriteError() will be called to set the users error string to - * "SendQ exceeded", and further buffer adds will be dropped. - * @param data The data to add to the write buffer - */ - void AddWriteBuf(const std::string &data); + virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric); - /** Flushes as much of the user's buffer to the file descriptor as possible. - * This function may not always flush the entire buffer, rather instead as much of it - * as it possibly can. If the send() call fails to send the entire buffer, the buffer - * position is advanced forwards and the rest of the data sent at the next call to - * this method. - */ - void FlushWriteBuf(); + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1) + { + Numeric::Numeric n(numeric); + n.push(p1); + WriteRemoteNumeric(n); + } - /** Returns the list of channels this user has been invited to but has not yet joined. - * @return A list of channels the user is invited to - */ - InvitedList* GetInviteList(); + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + WriteRemoteNumeric(n); + } - /** Creates a wildcard host. - * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname - * @return The wildcarded hostname in *!*@host form - */ - char* MakeWildHost(); + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + WriteRemoteNumeric(n); + } - /** Creates a usermask with real host. - * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host - * @return the usermask in the format user@host + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + n.push(p4); + WriteRemoteNumeric(n); + } + + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + n.push(p4); + n.push(p5); + WriteRemoteNumeric(n); + } + + void WriteNumeric(const Numeric::Numeric& numeric); + + template + void WriteNumeric(unsigned int numeric, T1 p1) + { + Numeric::Numeric n(numeric); + n.push(p1); + WriteNumeric(n); + } + + template + void WriteNumeric(unsigned int numeric, T1 p1, T2 p2) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + WriteNumeric(n); + } + + template + void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + WriteNumeric(n); + } + + template + void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + n.push(p4); + WriteNumeric(n); + } + + template + void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + n.push(p3); + n.push(p4); + n.push(p5); + WriteNumeric(n); + } + + /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF + * @param protoev Protocol event to send, may contain any number of messages. + * @param include_self Should the message be sent back to the author? */ - char* MakeHost(); + void WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self = true); - /** Creates a usermask with real ip. - * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip - * @return the usermask in the format user@ip + /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users + * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely. + * This function is used for example to send something conditionally to neighbors, or to send different messages + * to different users depending on their oper status. + * @param handler Function object to call, inherited from ForEachNeighborHandler. + * @param include_self True to include this user in the set of neighbors, false otherwise. + * Modules may override this. Has no effect if this user is not local. */ - char* MakeHostIP(); + void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true); - /** Shuts down and closes the user's socket - * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this, - * which will call CloseSocket() for you. + /** Return true if the user shares at least one channel with another user + * @param other The other user to compare the channel list against + * @return True if the given user shares at least one channel with this user */ - void CloseSocket(); + bool SharesChannelWith(User *other); - /** Disconnect a user gracefully - * @param user The user to remove - * @param r The quit reason to show to normal users - * @param oreason The quit reason to show to opers - * @return Although this function has no return type, on exit the user provided will no longer exist. + /** Change the displayed hostname of this user. + * @param host The new displayed hostname of this user. + * @return True if the hostname was changed successfully; otherwise, false. */ - static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = ""); + bool ChangeDisplayedHost(const std::string& host); - /** Add the user to WHOWAS system + /** Change the real hostname of this user. + * @param host The new real hostname of this user. + * @param resetdisplay Whether to reset the display host to this value. */ - void AddToWhoWas(); + void ChangeRealHost(const std::string& host, bool resetdisplay); - /** Oper up the user using the given opertype. - * This will also give the +o usermode. - * @param opertype The oper type to oper as + /** Change the ident (username) of a user. + * ALWAYS use this function, rather than writing User::ident directly, + * as this triggers module events allowing the change to be syncronized to + * remote servers. + * @param newident The new ident to set + * @return True if the change succeeded, false if it didn't */ - void Oper(const std::string &opertype, const std::string &opername); + bool ChangeIdent(const std::string& newident); - /** Call this method to find the matching for a user, and to check them against it. + /** Change a users realname field. + * @param real The user's new real name + * @return True if the change succeeded, false if otherwise */ - void CheckClass(); + bool ChangeRealName(const std::string& real); - /** Use this method to fully connect a user. - * This will send the message of the day, check G/K/E lines, etc. + /** Change a user's nick + * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds. + * @param newts The time at which this nick change happened. + * @return True if the change succeeded */ - void FullConnect(); + bool ChangeNick(const std::string& newnick, time_t newts = 0); - /** Change this users hash key to a new string. - * You should not call this function directly. It is used by the core - * to update the users hash entry on a nickchange. - * @param New new user_hash key - * @return Pointer to User in hash (usually 'this') + /** Remove this user from all channels they are on, and delete any that are now empty. + * This is used by QUIT, and will not send part messages! */ - User* UpdateNickHash(const char* New); + void PurgeEmptyChannels(); - /** Force a nickname change. - * If the nickname change fails (for example, because the nick in question - * already exists) this function will return false, and you must then either - * output an error message, or quit the user for nickname collision. - * @param newnick The nickname to change to - * @return True if the nickchange was successful. + /** Default destructor */ - bool ForceNickChange(const char* newnick); + virtual ~User(); + CullResult cull() CXX11_OVERRIDE; - /** Oper down. - * This will clear the +o usermode and unset the user's oper type + /** @copydoc Serializable::Deserialize */ + bool Deserialize(Data& data) CXX11_OVERRIDE; + + /** @copydoc Serializable::Deserialize */ + bool Serialize(Serializable::Data& data) CXX11_OVERRIDE; +}; + +class CoreExport UserIOHandler : public StreamSocket +{ + private: + size_t checked_until; + public: + LocalUser* const user; + UserIOHandler(LocalUser* me) + : StreamSocket(StreamSocket::SS_USER) + , checked_until(0) + , user(me) + { + } + void OnDataReady() CXX11_OVERRIDE; + bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) CXX11_OVERRIDE; + void OnError(BufferedSocketError error) CXX11_OVERRIDE; + + /** Adds to the user's write buffer. + * You may add any amount of text up to this users sendq value, if you exceed the + * sendq value, the user will be removed, and further buffer adds will be dropped. + * @param data The data to add to the write buffer */ - void UnOper(); + void AddWriteBuf(const std::string &data); - /** Write text to this user, appending CR/LF. - * @param text A std::string to send to the user + /** Swaps the internals of this UserIOHandler with another one. + * @param other A UserIOHandler to swap internals with. */ - void Write(std::string text); + void SwapInternals(UserIOHandler& other); +}; + +typedef unsigned int already_sent_t; - /** Write text to this user, appending CR/LF. - * @param text The format string for text to send to the user - * @param ... POD-type format arguments +class CoreExport LocalUser : public User, public insp::intrusive_list_node +{ + /** Add a serialized message to the send queue of the user. + * @param serialized Bytes to add. */ - void Write(const char *text, ...) CUSTOM_PRINTF(2, 3); + void Write(const ClientProtocol::SerializedMessage& serialized); - /** Write text to this user, appending CR/LF and prepending :server.name - * @param text A std::string to send to the user + /** Send a protocol event to the user, consisting of one or more messages. + * @param protoev Event to send, may contain any number of messages. + * @param msglist Message list used temporarily internally to pass to hooks and store messages + * before Write(). */ - void WriteServ(const std::string& text); + void Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist); - /** Write text to this user, appending CR/LF and prepending :server.name - * @param text The format string for text to send to the user - * @param ... POD-type format arguments + /** Message list, can be passed to the two parameter Send(). */ - void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3); + static ClientProtocol::MessageList sendmsglist; - void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4); + public: + LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server); + LocalUser(int fd, const std::string& uuid, Serializable::Data& data); - void WriteNumeric(unsigned int numeric, const std::string &text); + CullResult cull() CXX11_OVERRIDE; - /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter. - * @param user The user to prepend the :nick!user@host of - * @param text A std::string to send to the user - */ - void WriteFrom(User *user, const std::string &text); + UserIOHandler eh; - /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter. - * @param user The user to prepend the :nick!user@host of - * @param text The format string for text to send to the user - * @param ... POD-type format arguments + /** Serializer to use when communicating with the user */ - void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4); + ClientProtocol::Serializer* serializer; - /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host. - * @param dest The user to route the message to - * @param text A std::string to send to the user + /** Stats counter for bytes inbound */ - void WriteTo(User *dest, const std::string &data); + unsigned int bytes_in; - /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host. - * @param dest The user to route the message to - * @param text The format string for text to send to the user - * @param ... POD-type format arguments + /** Stats counter for bytes outbound */ - void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4); + unsigned int bytes_out; - /** Write to all users that can see this user (including this user in the list), appending CR/LF - * @param text A std::string to send to the users + /** Stats counter for commands inbound */ - void WriteCommon(const std::string &text); + unsigned int cmds_in; - /** Write to all users that can see this user (including this user in the list), appending CR/LF - * @param text The format string for text to send to the users - * @param ... POD-type format arguments + /** Stats counter for commands outbound */ - void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3); + unsigned int cmds_out; - /** Write to all users that can see this user (not including this user in the list), appending CR/LF - * @param text The format string for text to send to the users - * @param ... POD-type format arguments + /** Password specified by the user when they registered (if any). + * This is stored even if the \ block doesnt need a password, so that + * modules may check it. */ - void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3); + std::string password; - /** Write to all users that can see this user (not including this user in the list), appending CR/LF - * @param text A std::string to send to the users + /** Contains a pointer to the connect class a user is on from */ - void WriteCommonExcept(const std::string &text); + reference MyClass; - /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific - * quit message for opers only. - * @param normal_text Normal user quit message - * @param oper_text Oper only quit message + /** Get the connect class which this user belongs to. + * @return A pointer to this user's connect class. */ - void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text); + ConnectClass* GetClass() const { return MyClass; } - /** Write a WALLOPS message from this user to all local opers. - * If this user is not opered, the function will return without doing anything. - * @param text The format string to send in the WALLOPS message - * @param ... Format arguments + /** Call this method to find the matching \ for a user, and to check them against it. */ - void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3); + void CheckClass(bool clone_count = true); - /** Write a WALLOPS message from this user to all local opers. - * If this user is not opered, the function will return without doing anything. - * @param text The text to send in the WALLOPS message + /** Server address and port that this user is connected to. */ - void WriteWallOps(const std::string &text); + irc::sockets::sockaddrs server_sa; - /** Return true if the user shares at least one channel with another user - * @param other The other user to compare the channel list against - * @return True if the given user shares at least one channel with this user + /** Recursion fix: user is out of SendQ and will be quit as soon as possible. + * This can't be handled normally because QuitUser itself calls Write on other + * users, which could trigger their SendQ to overrun. */ - bool SharesChannelWith(User *other); + unsigned int quitting_sendq:1; - /** Change the displayed host of a user. - * ALWAYS use this function, rather than writing User::dhost directly, - * as this triggers module events allowing the change to be syncronized to - * remote servers. This will also emulate a QUIT and rejoin (where configured) - * before setting their host field. - * @param host The new hostname to set - * @return True if the change succeeded, false if it didn't + /** has the user responded to their previous ping? */ - bool ChangeDisplayedHost(const char* host); + unsigned int lastping:1; - /** Change the ident (username) of a user. - * ALWAYS use this function, rather than writing User::ident directly, - * as this correctly causes the user to seem to quit (where configured) - * before setting their ident field. - * @param host The new ident to set - * @return True if the change succeeded, false if it didn't + /** This is true if the user matched an exception (E-line). It is used to save time on ban checks. */ - bool ChangeIdent(const char* newident); + unsigned int exempt:1; - /** Change a users realname field. - * ALWAYS use this function, rather than writing User::fullname directly, - * as this triggers module events allowing the change to be syncronized to - * remote servers. - * @param gecos The user's new realname - * @return True if the change succeeded, false if otherwise - */ - bool ChangeName(const char* gecos); + /** The time at which this user should be pinged next. */ + time_t nextping; - /** Send a command to all local users from this user - * The command given must be able to send text with the - * first parameter as a servermask (e.g. $*), so basically - * you should use PRIVMSG or NOTICE. - * @param command the command to send - * @param text The text format string to send - * @param ... Format arguments + /** Time that the connection last sent a message, used to calculate idle time */ - void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4); + time_t idle_lastmsg; - /** Compile a channel list for this user, and send it to the user 'source' - * Used internally by WHOIS - * @param The user to send the channel list to if it is not too long - * @return This user's channel list + /** This value contains how far into the penalty threshold the user is. + * This is used either to enable fake lag or for excess flood quits */ - std::string ChannelList(User* source); + unsigned int CommandFloodPenalty; - /** Split the channel list in cl which came from dest, and spool it to this user - * Used internally by WHOIS - * @param dest The user the original channel list came from - * @param cl The channel list as a string obtained from User::ChannelList() - */ - void SplitChanList(User* dest, const std::string &cl); + already_sent_t already_sent; - /** Remove this user from all channels they are on, and delete any that are now empty. - * This is used by QUIT, and will not send part messages! + /** Check if the user matches a G- or K-line, and disconnect them if they do. + * @param doZline True if Z-lines should be checked (if IP has changed since initial connect) + * Returns true if the user matched a ban, false else. */ - void PurgeEmptyChannels(); + bool CheckLines(bool doZline = false); - /** Get the connect class which this user belongs to. - * @return A pointer to this user's connect class + /** Use this method to fully connect a user. + * This will send the message of the day, check G/K/E-lines, etc. */ - ConnectClass *GetClass(); + void FullConnect(); /** Set the connect class to which this user belongs to. - * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking tags from the configuration file. + * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking \ tags from the configuration file. * @return A reference to this user's current connect class. */ - ConnectClass *SetClass(const std::string &explicit_name = ""); + void SetClass(const std::string &explicit_name = ""); - /** Show the message of the day to this user - */ - void ShowMOTD(); + bool SetClientIP(const std::string& address) CXX11_OVERRIDE; + + void SetClientIP(const irc::sockets::sockaddrs& sa) CXX11_OVERRIDE; - /** Show the server RULES file to this user + /** Send a NOTICE message from the local server to the user. + * The message will be sent even if the user is connected to a remote server. + * @param text Text to send */ - void ShowRULES(); + void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE; - /** Set oper-specific quit message shown to opers only when the user quits - * (overrides any sent by QuitUser) + /** Returns true or false for if a user can execute a privilaged oper command. + * This is done by looking up their oper type from User::oper, then referencing + * this to their oper classes and checking the commands they can execute. + * @param command A command (should be all CAPS) + * @return True if this user can execute the command */ - void SetOperQuit(const std::string &oquit); + bool HasCommandPermission(const std::string& command) CXX11_OVERRIDE; - /** Get oper-specific quit message shown only to opers when the user quits. - * (overrides any sent by QuitUser) + /** Returns true if a user has a given permission. + * This is used to check whether or not users may perform certain actions which admins may not wish to give to + * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc. + * + * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file. + * @return True if this user has the permission in question. */ - const char* GetOperQuit(); + bool HasPrivPermission(const std::string& privstr) CXX11_OVERRIDE; - /** Increases a user's command penalty by a set amount. + /** Returns true or false if a user can set a privileged user or channel mode. + * This is done by looking up their oper type from User::oper, then referencing + * this to their oper classes, and checking the modes they can set. + * @param mh Mode to check + * @return True if the user can set or unset this mode. */ - void IncreasePenalty(int increase); + bool HasModePermission(const ModeHandler* mh) const CXX11_OVERRIDE; + + /** @copydoc User::HasSnomaskPermission */ + bool HasSnomaskPermission(char chr) const CXX11_OVERRIDE; - /** Decreases a user's command penalty by a set amount. + /** Change nick to uuid, unset REG_NICK and send a nickname overruled numeric. + * This is called when another user (either local or remote) needs the nick of this user and this user + * isn't registered. */ - void DecreasePenalty(int decrease); + void OverruleNick(); - /** Handle socket event. - * From EventHandler class. - * @param et Event type - * @param errornum Error number for EVENT_ERROR events + /** Send a protocol event to the user, consisting of one or more messages. + * @param protoev Event to send, may contain any number of messages. */ - void HandleEvent(EventType et, int errornum = 0); + void Send(ClientProtocol::Event& protoev); - /** Default destructor + /** Send a single message to the user. + * @param protoevprov Protocol event provider. + * @param msg Message to send. */ - virtual ~User(); + void Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg); + + /** @copydoc Serializable::Deserialize */ + bool Deserialize(Data& data) CXX11_OVERRIDE; + + /** @copydoc Serializable::Deserialize */ + bool Serialize(Serializable::Data& data) CXX11_OVERRIDE; }; -/** Derived from Resolver, and performs user forward/reverse lookups. - */ -class CoreExport UserResolver : public Resolver +class RemoteUser : public User { - private: - /** User this class is 'attached' to. - */ - User* bound_user; - /** File descriptor teh lookup is bound to - */ - int bound_fd; - /** True if the lookup is forward, false if is a reverse lookup - */ - bool fwd; public: - /** Create a resolver. - * @param Instance The creating instance - * @param user The user to begin lookup on - * @param to_resolve The IP or host to resolve - * @param qt The query type - * @param cache Modified by the constructor if the result was cached - */ - UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache); + RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE) + { + } +}; - /** Called on successful lookup - * @param result Result string - * @param ttl Time to live for result - * @param cached True if the result was found in the cache - * @param resultnum Result number, we are only interested in result 0 - */ - void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0); +class CoreExport FakeUser : public User +{ + public: + FakeUser(const std::string& uid, Server* srv) + : User(uid, srv, USERTYPE_SERVER) + { + nick = srv->GetName(); + } - /** Called on failed lookup - * @param e Error code - * @param errormessage Error message string - */ - void OnError(ResolverError e, const std::string &errormessage); + FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc) + : User(uid, new Server(uid, sname, sdesc), USERTYPE_SERVER) + { + nick = sname; + } + + CullResult cull() CXX11_OVERRIDE; + const std::string& GetFullHost() CXX11_OVERRIDE; + const std::string& GetFullRealHost() CXX11_OVERRIDE; }; -/* Configuration callbacks */ -//class ServerConfig; +/* Faster than dynamic_cast */ +/** Is a local user */ +inline LocalUser* IS_LOCAL(User* u) +{ + return (u != NULL && u->usertype == USERTYPE_LOCAL) ? static_cast(u) : NULL; +} +/** Is a remote user */ +inline RemoteUser* IS_REMOTE(User* u) +{ + return (u != NULL && u->usertype == USERTYPE_REMOTE) ? static_cast(u) : NULL; +} +/** Is a server fakeuser */ +inline FakeUser* IS_SERVER(User* u) +{ + return (u != NULL && u->usertype == USERTYPE_SERVER) ? static_cast(u) : NULL; +} + +inline bool User::IsModeSet(const ModeHandler* mh) const +{ + return ((mh->GetId() != ModeParser::MODEID_MAX) && (modes[mh->GetId()])); +} -#endif +inline bool User::IsModeSet(UserModeReference& moderef) const +{ + if (!moderef) + return false; + return IsModeSet(*moderef); +} +inline void User::SetMode(ModeHandler* mh, bool value) +{ + if (mh && mh->GetId() != ModeParser::MODEID_MAX) + modes[mh->GetId()] = value; +}