X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=5aff66e54ba491a117c4e637f20f5c98dc154b68;hb=901babedd35b248e923779e9d6261b26e3c7c4b7;hp=229edcfa2564aea295979c9f8c966d3fbbc24bc7;hpb=27e2941ec9a9a7609749b7310a787548ddf716a5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 229edcfa2..5aff66e54 100644 --- a/include/users.h +++ b/include/users.h @@ -15,9 +15,7 @@ #define __USERS_H__ #include "socket.h" -#include "connection.h" #include "dns.h" - #include "mode.h" /** Channel status for a user @@ -45,16 +43,14 @@ enum ClassTypes { /** RFC1459 channel modes */ enum UserModes { - /** +s: Server notices */ - UM_SERVERNOTICE = 's' - 65, + /** +s: Server notice mask */ + UM_SNOMASK = '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 + UM_OPERATOR = 'o' - 65 }; /** Registration state of a user, e.g. @@ -143,7 +139,7 @@ public: 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) + port(source->port), RefCount(0), disabled(false), limit(source->limit) { } @@ -191,7 +187,7 @@ public: 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) + port(source->port), RefCount(0), disabled(false), limit(source->limit) { } @@ -259,7 +255,7 @@ public: */ unsigned long limit; - int GetMaxChans() + size_t GetMaxChans() { return maxchans; } @@ -278,7 +274,7 @@ public: /** Returns the registration timeout */ - unsigned int GetRegTimeout() + time_t GetRegTimeout() { return (registration_timeout ? registration_timeout : 90); } @@ -416,7 +412,7 @@ class CoreExport VisData * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their * file descriptor value. */ -class CoreExport User : public connection +class CoreExport User : public EventHandler { private: /** Pointer to creator. @@ -431,25 +427,25 @@ class CoreExport User : public connection */ InvitedList invites; - /** Number of channels this user is currently on + /** Cached nick!ident@dhost value using the displayed hostname */ - unsigned int ChannelCount; + std::string cached_fullhost; - /** Cached nick!ident@host value using the real hostname + /** Cached ident@ip value using the real IP address */ - char* cached_fullhost; + std::string cached_hostip; - /** Cached nick!ident@ip value using the real IP address + /** Cached ident@realhost value using the real hostname */ - char* cached_hostip; + std::string cached_makehost; - /** Cached nick!ident@host value using the masked hostname + /** Cached nick!ident@realhost value using the real hostname */ - char* cached_makehost; + std::string cached_fullrealhost; - /** Cached nick!ident@realhost value using the real hostname + /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. */ - char* cached_fullrealhost; + std::string cachedip; /** When we erase the user (in the destructor), * we call this method to subtract one from all @@ -457,10 +453,6 @@ class CoreExport User : public connection */ void DecrementModes(); - /** Max channels for this user - */ - unsigned int MaxChans; - std::map* AllowedOperCommands; /** Allowed user modes from oper classes. */ @@ -470,33 +462,65 @@ class CoreExport User : public connection bool* AllowedChanModes; public: - /** Module responsible for raw i/o - */ - Module* io; - /** 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. :) */ ConnectClass *MyClass; - /** 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. + /** User visibility state, see definition of VisData. */ - UserResolver* res_forward; + VisData* Visibility; - /** Resolvers for looking up this users hostname - * This is instantiated by User::StartDNSLookup(), - * and on success, instantiates User::res_reverse. + /** Hostname of connection. + * This should be valid as per RFC1035. */ - UserResolver* res_reverse; + std::string host; - /** User visibility state, see definition of VisData. + /** Stats counter for bytes inbound */ - VisData* Visibility; + int bytes_in; + + /** Stats counter for bytes outbound + */ + int bytes_out; + + /** Stats counter for commands inbound + */ + int cmds_in; + + /** Stats counter for commands outbound + */ + int cmds_out; + + /** True if user has authenticated, false if otherwise + */ + bool haspassed; + + /** 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. + */ + char registered; + + /** Time the connection was last pinged + */ + time_t lastping; + + /** Time the connection was created, set in the constructor. This + * may be different from the time the user's classbase object was + * created. + */ + time_t signon; + + /** Time that the connection last sent a message, used to calculate idle time + */ + time_t idle_lastmsg; - /** Stored reverse lookup from res_forward + /** Used by PING checking code + */ + time_t nping; + + /** Stored reverse lookup from res_forward. Should not be used after resolution. */ std::string stored_host; @@ -506,48 +530,47 @@ class CoreExport User : public connection */ void StartDNSLookup(); - unsigned int GetMaxChans(); - /** 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]; - + 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]; - + std::string ident; + /** The host displayed to non-opers (used for cloaking etc). * This usually matches the value of User::host. */ - char dhost[65]; - + std::string dhost; + /** The users full name (GECOS). */ - char fullname[MAXGECOS+1]; - + std::string fullname; + /** 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 + * NOT a null terminated string. + * Also NOT an array. + * Much love to the STL for giving us an easy to use bitset, saving us RAM. + * if (modes[modeletter-65]) is set, then 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::bitset<64> modes; /** 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 */ @@ -560,26 +583,20 @@ class CoreExport User : public connection /** 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()! */ 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]; - + std::string oper; + /** True when DNS lookups are completed. * The UserResolver classes res_forward and res_reverse will * set this value once they complete. @@ -590,8 +607,8 @@ class CoreExport User : public connection * This is stored even if the block doesnt need a password, so that * modules may check it. */ - char password[64]; - + std::string password; + /** User's receive queue. * Lines from the IRCd awaiting processing are stored here. * Upgraded april 2005, old system a bit hairy. @@ -634,10 +651,6 @@ class CoreExport User : public connection * GetIPString/GetPort to obtain its values. */ sockaddr* ip; - - /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. - */ - std::string cachedip; /** Initialize the clients sockaddr * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6 @@ -661,9 +674,14 @@ class CoreExport User : public connection */ const char* GetIPString(bool translate4in6 = true); - /* Write error string + /** Get a CIDR mask from the IP of this user, using a static internal buffer. + * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16 + * This may be used for CIDR clone detection, etc. + * + * (XXX, brief note: when we do the sockets rewrite, this should move down a + * level so it may be used on more derived objects. -- w00t) */ - std::string WriteError; + const char *GetCIDRMask(int range); /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. */ @@ -689,16 +707,17 @@ class CoreExport User : public connection */ User(InspIRCd* Instance, const std::string &uid = ""); - /** Check if the user matches a G or K line, and disconnect them if they do + /** Check if the user matches a G or K line, and disconnect them if they do. + * Returns true if the user matched a ban, false else. */ - void CheckLines(); + bool CheckLines(); /** 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. * @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 @@ -706,7 +725,7 @@ class CoreExport User : public connection * 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. @@ -741,7 +760,7 @@ class CoreExport User : public connection /** Create a displayable mode string for this users umodes * @param The mode string */ - const char* FormatModes(); + const char* FormatModes(bool showparameters = false); /** Returns true if a specific mode is set * @param m The user mode @@ -807,7 +826,7 @@ class CoreExport User : public connection * @param a The string to add to the users read buffer * @return True if the string was successfully added to the read buffer */ - bool AddBuffer(std::string a); + bool AddBuffer(const std::string &a); /** This method returns true if the buffer contains at least one carriage return * character (e.g. one complete line may be read) @@ -829,24 +848,9 @@ class CoreExport User : public connection */ std::string GetBuffer(); - /** 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. - */ - void SetWriteError(const std::string &error); - - /** 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 - */ - const char* GetWriteError(); - /** 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. + * 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 AddWriteBuf(const std::string &data); @@ -874,13 +878,13 @@ class CoreExport User : public connection * 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 */ - char* MakeHost(); + const std::string& MakeHost(); /** 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 */ - char* MakeHostIP(); + const std::string& MakeHostIP(); /** Shuts down and closes the user's socket * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this, @@ -1113,7 +1117,7 @@ class CoreExport User : public connection /** Get oper-specific quit message shown only to opers when the user quits. * (overrides any sent by QuitUser) */ - const char* GetOperQuit(); + const std::string& GetOperQuit(); /** Increases a user's command penalty by a set amount. */