X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fusers.h;h=19d78ec23c37314d2b24f0cddbc98edb7c93c396;hb=b31f343eacdf248aebd6869f2190a3464fd5d555;hp=d8a9b3e64176df256eebdd4c2109addc4a870eb5;hpb=0d3ecb964292600ec1ce6ee1cef83f72185a8bcc;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index d8a9b3e64..19d78ec23 100644 --- a/include/users.h +++ b/include/users.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2008 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -74,27 +74,28 @@ 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 classbase { - private: /** Type of line, either CC_ALLOW or CC_DENY */ char type; + /** 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; @@ -103,10 +104,6 @@ class CoreExport ConnectClass : public classbase */ std::string hash; - /** Threshold value for flood disconnect - */ - unsigned int threshold; - /** Maximum size of sendq for users in this class (bytes) */ unsigned long sendqmax; @@ -131,133 +128,33 @@ 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). - */ - 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), limit(source->limit) - { - } - - /** Create a new connect class with no settings. - */ - 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), limit(0) - { - } - - /** 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), 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), 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 + /** How many users may be in this connect class before they are refused? + * (0 = no limit = default) */ - 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), limit(source->limit) - { - } - - /* 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; - } - - void Update(const std::string &n, const std::string &hst) - { - name = n; - host = hst; - } + unsigned long limit; - /** 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. :) + /** Reference counter. + * This will be 1 if no users are connected, as long as it is a valid connect block + * When it reaches 0, the object should be deleted */ unsigned long RefCount; - /** How many users may be in this connect class before they are refused? (0 = disabled = default) + /** Create a new connect class with no settings. */ - unsigned long limit; - - size_t GetMaxChans() - { - return maxchans; - } - - /** Returns the type, CC_ALLOW or CC_DENY + ConnectClass(char type, const std::string& mask); + /** Create a new connect class with inherited settings. */ - char GetType() - { - return (type == CC_ALLOW ? CC_ALLOW : CC_DENY); - } + 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); - 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() @@ -265,34 +162,6 @@ public: 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() @@ -300,27 +169,6 @@ 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 - */ - const std::string& GetHash() - { - return hash; - } - - /** Returns the flood threshold value - */ - unsigned int GetThreshold() - { - return (threshold ? threshold : 1); - } - /** Returns the maximum sendq value */ unsigned long GetSendqMax() @@ -394,19 +242,11 @@ class CoreExport VisData /** 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 { 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. @@ -449,6 +289,12 @@ class CoreExport User : public EventHandler std::bitset<64> AllowedChanModes; public: + /** Pointer to creator. + * This is required to make use of core functions + * from within the User class. + */ + InspIRCd* ServerInstance; + /** 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. :) */ @@ -493,6 +339,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. @@ -522,26 +372,26 @@ class CoreExport User : public EventHandler * Use InspIRCd::IsNick() to validate nicknames. */ std::string nick; - + /** The user's unique identifier. * This is the unique identifier which the user has across the network. */ std::string uuid; - + /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. */ std::string ident; - + /** The host displayed to non-opers (used for cloaking etc). * This usually matches the value of User::host. */ std::string dhost; - + /** The users full name (GECOS). */ std::string fullname; - + /** The user's mode list. * NOT a null terminated string. * Also NOT an array. @@ -571,7 +421,7 @@ class CoreExport User : public EventHandler * If this string is empty, the user is not marked as away. */ std::string awaymsg; - + /** Time the user last went away. * This is ONLY RELIABLE if user IS_AWAY()! */ @@ -583,7 +433,7 @@ class CoreExport User : public EventHandler * The value of this is the value of a valid 'type name=' tag. */ std::string oper; - + /** True when DNS lookups are completed. * The UserResolver classes res_forward and res_reverse will * set this value once they complete. @@ -595,7 +445,7 @@ class CoreExport User : public EventHandler * modules may check it. */ std::string password; - + /** User's receive queue. * Lines from the IRCd awaiting processing are stored here. * Upgraded april 2005, old system a bit hairy. @@ -619,14 +469,6 @@ class CoreExport User : public EventHandler */ bool quietquit; - /** Flood counters - lines received - */ - unsigned int lines_in; - - /** Flood counters - time lines_in is due to be reset - */ - time_t reset_due; - /** 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. @@ -634,32 +476,35 @@ 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 + */ + 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 */ - sockaddr* ip; + irc::sockets::sockaddrs client_sa; - /** 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 + /** Sets the client IP for this user + * @return true if the conversion was successful */ - void SetSockAddr(int protocol_family, const char* ip, int port); + bool SetClientIP(const char* sip); - /** Get port number from sockaddr + /** * @return The port number of this user. */ - int GetPort(); - - /** Get protocol family from sockaddr - * @return The protocol family of this user, either AF_INET or AF_INET6 + int GetServerPort(); + /** + * @return The server IP address */ - int GetProtocolFamily(); + std::string GetServerIP(); - /** 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(bool translate4in6 = true); + const char* GetIPString(); /** 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 @@ -679,14 +524,6 @@ class CoreExport User : public EventHandler */ int Penalty; - /** True if we are flushing penalty lines - */ - bool OverPenalty; - - /** If this bool is set then penalty rules do not apply to this user - */ - bool ExemptFromPenalty; - /** Default constructor * @throw CoreException if the UID allocated to the user already exists * @param Instance Creator instance @@ -705,7 +542,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 @@ -713,7 +550,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. @@ -796,7 +633,8 @@ class CoreExport User : public EventHandler * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file. * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent. * @return True if this user has the permission in question. - */ bool HasPrivPermission(const std::string &privstr, bool noisy = true); + */ + bool HasPrivPermission(const std::string &privstr, bool noisy = false); /** 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 @@ -933,7 +771,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 @@ -1030,6 +868,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 @@ -1164,9 +1010,8 @@ class CoreExport UserResolver : public Resolver * @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 @@ -1179,4 +1024,3 @@ class CoreExport UserResolver : public Resolver //class ServerConfig; #endif -