X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=a898d58130d18b7f58c752473d51e319c09afc8c;hb=80c09792394a213f19d1384e61fdf8dfc3fce49a;hp=8f11d3404d70e61b5cbc9076310956041fedccf8;hpb=b6dbd6caab62bc2c0d11ce5a45d511611eb9c2ef;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 8f11d3404..a898d5813 100644 --- a/include/users.h +++ b/include/users.h @@ -15,22 +15,10 @@ #define __USERS_H__ #include "socket.h" +#include "inspsocket.h" #include "dns.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 -}; - /** connect class types */ enum ClassTypes { @@ -74,9 +62,8 @@ class UserResolver; /** 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: /** Type of line, either CC_ALLOW or CC_DENY */ char type; @@ -106,8 +93,14 @@ class CoreExport ConnectClass : public classbase std::string hash; /** Maximum size of sendq for users in this class (bytes) + * Users cannot send commands if they go over this limit */ - unsigned long sendqmax; + unsigned long softsendqmax; + + /** Maximum size of sendq for users in this class (bytes) + * Users are killed if they go over this limit + */ + unsigned long hardsendqmax; /** Maximum size of recvq for users in this class (bytes) */ @@ -129,141 +122,27 @@ class CoreExport ConnectClass : public classbase */ int port; -public: - - /** 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), host(source->host), - pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(source->limit) - { - } + unsigned long limit; /** Create a new connect class with no settings. */ - ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), host(""), pingtime(0), pass(""), hash(""), - sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0) - { - } - - /** Create a new connect class to ALLOW connections. - * @param thename Name of the connect class - * @param timeout The registration timeout - * @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 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,const std::string &hst, unsigned int ping, - const std::string &pas, const std::string &hsh, 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), host(hst), pingtime(ping), pass(pas), hash(hsh), - 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), - host(hst), pingtime(0), pass(""), hash(""), 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 + ConnectClass(char type, const std::string& mask); + /** Create a new connect class with inherited settings. */ - ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename), - registration_timeout(source->registration_timeout), host(source->host), - pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(source->limit) - { - } + ConnectClass(char type, const std::string& mask, const ConnectClass& parent); + + /** Update the settings in this block to match the given block */ + void Update(const ConnectClass* newSettings); - void SetDisabled(bool t) - { - this->disabled = t; - } - - bool GetDisabled() - { - return this->disabled; - } - - /* Update an existing entry with new values - */ - void Update(unsigned int timeout, const std::string &hst, unsigned int ping, - const std::string &pas, 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 (!hst.empty()) - host = hst; - if (ping) - pingtime = ping; - if (!pas.empty()) - pass = pas; - 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; - } - - void Update(const std::string &n, const std::string &hst) - { - name = n; - host = hst; - } - - /** 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 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 - */ - bool disabled; - - /** How many users may be in this connect class before they are refused? (0 = disabled = default) - */ - unsigned long limit; - - size_t GetMaxChans() - { - return maxchans; - } - - /** Returns the type, CC_ALLOW or CC_DENY - */ - char GetType() - { - return (type == CC_ALLOW ? CC_ALLOW : CC_DENY); - } - - std::string& GetName() - { - return name; - } + const std::string& GetName() { return name; } + const std::string& GetPass() { return pass; } + const std::string& GetHost() { return host; } + const int GetPort() { return port; } + /** Returns the registration timeout */ time_t GetRegTimeout() @@ -271,27 +150,6 @@ public: return (registration_timeout ? registration_timeout : 90); } - /** 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() @@ -299,25 +157,19 @@ public: return (pingtime ? pingtime : 120); } - /** Returns the password or an empty string - */ - const std::string& GetPass() - { - return pass; - } - - /** Returns the hash or an empty string + /** Returns the maximum sendq value (soft limit) + * Note that this is in addition to internal OS buffers */ - const std::string& GetHash() + unsigned long GetSendqSoftMax() { - return hash; + return (softsendqmax ? softsendqmax : 4096); } - /** Returns the maximum sendq value + /** Returns the maximum sendq value (hard limit) */ - unsigned long GetSendqMax() + unsigned long GetSendqHardMax() { - return (sendqmax ? sendqmax : 262114); + return (hardsendqmax ? hardsendqmax : 0x100000); } /** Returns the maximum recvq value @@ -344,61 +196,32 @@ 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; +CoreExport 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; +CoreExport typedef std::vector > ClassVector; /** Typedef for the list of user-channel records for a user */ -typedef std::map UserChanList; +CoreExport typedef std::set UserChanList; /** Shorthand for an iterator into a UserChanList */ -typedef UserChanList::iterator UCListIter; +CoreExport 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 EventHandler +class CoreExport User : public StreamSocket { 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. @@ -442,13 +265,8 @@ class CoreExport User : public EventHandler public: /** 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; - - /** User visibility state, see definition of VisData. - */ - VisData* Visibility; + reference MyClass; /** Hostname of connection. * This should be valid as per RFC1035. @@ -485,6 +303,10 @@ class CoreExport User : public EventHandler */ time_t lastping; + /** Time that the object was instantiated (used for TS calculation etc) + */ + time_t age; + /** Time the connection was created, set in the constructor. This * may be different from the time the user's classbase object was * created. @@ -557,7 +379,7 @@ class CoreExport User : public EventHandler /** The server the user is connected to. */ - const char* server; + std::string server; /** The user's away message. * If this string is empty, the user is not marked as away. @@ -588,25 +410,6 @@ class CoreExport User : public EventHandler */ std::string password; - /** 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; - - /** Quit message shown to opers - not to be set externally. - */ - std::string operquitmsg; - /** Whether or not to send an snotice about this user's quitting */ bool quietquit; @@ -618,29 +421,28 @@ class CoreExport User : public EventHandler */ bool quitting; - /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/ - * GetIPString/GetPort to obtain its values. + /** Server address and port that this user is connected to. + * If unknown, address family is AF_UNKNOWN */ - sockaddr* ip; - - /** 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 + irc::sockets::sockaddrs server_sa; + /** Client address that the user is connected from. + * Port number is only valid if local. + * + * Do not modify this value directly, use SetClientIP() to change it */ - void SetSockAddr(int protocol_family, const char* ip, int port); + irc::sockets::sockaddrs client_sa; - /** Get port number from sockaddr - * @return The port number of this user. + /** Sets the client IP for this user + * @return true if the conversion was successful */ - int GetPort(); + bool SetClientIP(const char* sip); - /** Get protocol family from sockaddr - * @return The protocol family of this user, either AF_INET or AF_INET6 + /** + * @return The port number of this user. */ - int GetProtocolFamily(); + int GetServerPort(); - /** Get IP string from sockaddr, using static internal buffer + /** Get client IP string from sockaddr, using static internal buffer * @return The IP string */ const char* GetIPString(); @@ -668,7 +470,7 @@ class CoreExport User : public EventHandler * @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 = ""); /** Check if the user matches a G or K line, and disconnect them if they do. * @param doZline True if ZLines should be checked (if IP has changed since initial connect) @@ -681,7 +483,7 @@ class CoreExport User : public EventHandler * on the server, in nick!ident&at;host form. * @return The full masked host of the user */ - virtual const std::string& 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 @@ -689,7 +491,7 @@ class CoreExport User : public EventHandler * 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 const std::string& 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. @@ -784,44 +586,6 @@ class CoreExport User : public EventHandler */ bool HasModePermission(unsigned char mode, ModeType type); - /** 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. - */ - int ReadData(void* buffer, size_t size); - - /** 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 - */ - 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) - * @return True if there is at least one complete line in the users buffer - */ - bool BufferIsReady(); - - /** This function clears the entire buffer by setting it to an empty string. - */ - void ClearBuffer(); - - /** 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 - */ - std::string GetBuffer(); - /** 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. @@ -829,14 +593,6 @@ class CoreExport User : public EventHandler */ 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 - * 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(); - /** 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 */ @@ -860,12 +616,6 @@ class CoreExport User : public EventHandler */ 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, - * which will call CloseSocket() for you. - */ - void CloseSocket(); - /** Add the user to WHOWAS system */ void AddToWhoWas(); @@ -910,7 +660,7 @@ class CoreExport User : public EventHandler /** Write text to this user, appending CR/LF. * @param text A std::string to send to the user */ - void Write(std::string text); + void Write(const std::string &text); /** Write text to this user, appending CR/LF. * @param text The format string for text to send to the user @@ -962,7 +712,7 @@ class CoreExport User : public EventHandler /** 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 */ - void WriteCommon(const std::string &text); + void WriteCommonRaw(const std::string &line, bool include_self = true); /** 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 @@ -976,11 +726,6 @@ class CoreExport User : public EventHandler */ void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3); - /** 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 - */ - void WriteCommonExcept(const std::string &text); - /** 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 @@ -1007,6 +752,14 @@ class CoreExport User : public EventHandler */ bool SharesChannelWith(User *other); + /** Send fake quit/join messages for host or ident cycle. + * Run this after the item in question has changed. + * You should not need to use this function, call ChangeDisplayedHost instead + * + * @param The entire QUIT line, including the source using the old value + */ + void DoHostCycle(const std::string &quitline); + /** 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 @@ -1045,12 +798,12 @@ class CoreExport User : public EventHandler */ void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4); - /** 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 + /** Compile a channel list for this user. Used internally by WHOIS + * @param source The user to prepare the channel list for + * @param spy Whether to return the spy channel list rather than the normal one * @return This user's channel list */ - std::string ChannelList(User* source); + std::string ChannelList(User* source, bool spy); /** Split the channel list in cl which came from dest, and spool it to this user * Used internally by WHOIS @@ -1083,16 +836,6 @@ class CoreExport User : public EventHandler */ void ShowRULES(); - /** Set oper-specific quit message shown to opers only when the user quits - * (overrides any sent by QuitUser) - */ - void SetOperQuit(const std::string &oquit); - - /** Get oper-specific quit message shown only to opers when the user quits. - * (overrides any sent by QuitUser) - */ - const std::string& GetOperQuit(); - /** Increases a user's command penalty by a set amount. */ void IncreasePenalty(int increase); @@ -1101,16 +844,13 @@ class CoreExport User : public EventHandler */ void DecreasePenalty(int decrease); - /** Handle socket event. - * From EventHandler class. - * @param et Event type - * @param errornum Error number for EVENT_ERROR events - */ - void HandleEvent(EventType et, int errornum = 0); + void OnDataReady(); + void OnError(BufferedSocketError error); /** Default destructor */ virtual ~User(); + virtual bool cull(); }; /** Derived from Resolver, and performs user forward/reverse lookups. @@ -1135,15 +875,14 @@ class CoreExport UserResolver : public Resolver * @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); + UserResolver(User* user, std::string to_resolve, QueryType qt, bool &cache); /** 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); + void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached); /** Called on failed lookup * @param e Error code @@ -1152,7 +891,4 @@ class CoreExport UserResolver : public Resolver void OnError(ResolverError e, const std::string &errormessage); }; -/* Configuration callbacks */ -//class ServerConfig; - #endif