X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=fdfa4606bc96d1dac04e14cf227ec347cf075c3d;hb=398e82a1142e8d361b206b4a2b15e3f6325a51b2;hp=883fbadf8a064cf63728cd95e208173f61b80bf4;hpb=f4ea51671f367d6e473049d52919a3c879329c6f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 883fbadf8..fdfa4606b 100644 --- a/include/users.h +++ b/include/users.h @@ -15,19 +15,12 @@ #define __USERS_H__ #include "socket.h" -#include "connection.h" #include "dns.h" #include "mode.h" -#include "linebuffer.h" - -#include // XXX XXX XXX this should probably be moved to globals.h, and globals.h should probably be merged in with inspircd.h sometime. -- w00t -#define _GLIBCXX_FORCE_NEW 1 - /** Channel status for a user */ -enum ChanStatus -{ +enum ChanStatus { /** Op */ STATUS_OP = 4, /** Halfop */ @@ -40,8 +33,7 @@ enum ChanStatus /** connect class types */ -enum ClassTypes -{ +enum ClassTypes { /** connect:allow */ CC_ALLOW = 0, /** connect:deny */ @@ -50,34 +42,30 @@ enum ClassTypes /** RFC1459 channel modes */ -enum UserModes -{ - /** +s: Server notices */ - UM_SERVERNOTICE = 's' - 65, +enum UserModes { + /** +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. * have they sent USER, NICK, PASS yet? */ -enum RegistrationState -{ -#ifndef REG_NONE /* This is already defined in win32, luckily it is still 0. -- Burlex - XXX perhaps we should undef it just in case.. Relying on magic numbers... -- w00t */ +enum RegistrationState { + +#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0. REG_NONE = 0, /* Has sent nothing */ #endif REG_USER = 1, /* Has sent USER */ REG_NICK = 2, /* Has sent NICK */ REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */ - REG_ALL = 7 /* REG_NICKUSER plus next bit along */ + REG_ALL = 7 /* REG_NICKUSER plus next bit along */ }; /* Required forward declaration */ @@ -267,7 +255,7 @@ public: */ unsigned long limit; - int GetMaxChans() + size_t GetMaxChans() { return maxchans; } @@ -286,7 +274,7 @@ public: /** Returns the registration timeout */ - unsigned int GetRegTimeout() + time_t GetRegTimeout() { return (registration_timeout ? registration_timeout : 90); } @@ -424,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. @@ -439,19 +427,15 @@ class CoreExport User : public connection */ 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 */ std::string cached_fullhost; - /** Cached nick!ident@ip value using the real IP address + /** Cached ident@ip value using the real IP address */ std::string cached_hostip; - /** Cached nick!ident@host value using the masked hostname + /** Cached ident@realhost value using the real hostname */ std::string cached_makehost; @@ -459,52 +443,84 @@ class CoreExport User : public connection */ std::string cached_fullrealhost; + /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. + */ + std::string cachedip; + /** 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(); - /** Max channels for this user - */ - unsigned int MaxChans; - std::map* AllowedOperCommands; /** Allowed user modes from oper classes. */ - bool* AllowedUserModes; + std::bitset<64> AllowedUserModes; /** Allowed channel modes from oper classes. */ - bool* AllowedChanModes; + std::bitset<64> 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; - /** Stored reverse lookup from res_forward + /** 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; + + /** Used by PING checking code + */ + time_t nping; + + /** Stored reverse lookup from res_forward. Should not be used after resolution. */ std::string stored_host; @@ -514,8 +530,6 @@ 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. @@ -542,20 +556,21 @@ class CoreExport User : public connection 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. */ - unsigned char modes[64]; + std::bitset<64> modes; /** What snomasks are set on this user. * This functions the same as the above modes. */ - unsigned char snomasks[64]; + std::bitset<64> snomasks; /** Channels this user is on, and the permissions they have there */ @@ -575,12 +590,6 @@ class CoreExport User : public connection */ 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. @@ -606,15 +615,10 @@ class CoreExport User : public connection */ std::string recvq; - /** How many bytes are currently in the user's sendq. - */ - unsigned long sendqlength; - /** List of pointers to buffer objects, this is the actual user's sendq. + /** User's send queue. + * Lines waiting to be sent are stored here until their buffer is flushed. */ - std::list > sendq; - /** How far into the current sendq line is the user? - */ - unsigned long sendqpos; + std::string sendq; /** Message user will quit with. Not to be set externally. */ @@ -647,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 @@ -674,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. */ @@ -702,9 +707,10 @@ 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 @@ -754,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 @@ -842,27 +848,12 @@ 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 a line buffer to the user's sendq. + /** 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(LineBuffer *l); + void AddWriteBuf(const std::string &data); /** 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