X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=66ca2b9ccd9239b95da35da504e31826af07b9f2;hb=cf4439ac5c5e5f57aba2c998ee63b9b27ec17d69;hp=8da80d62f2d28f2bc35f99db69d68fec979ce066;hpb=b790abb1545fc22d0f6799f48d4b7df22711db8a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 8da80d62f..66ca2b9cc 100644 --- a/include/users.h +++ b/include/users.h @@ -23,64 +23,112 @@ #include "hashcomp.h" #include "dns.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 { + /** connect:allow */ CC_ALLOW = 0, + /** connect:deny */ CC_DENY = 1 }; /** RFC1459 channel modes - * */ + */ enum UserModes { - UM_SERVERNOTICE = 's'-65, - UM_WALLOPS = 'w'-65, - UM_INVISIBLE = 'i'-65, - UM_OPERATOR = 'o'-65, - UM_SNOMASK = 'n'-65, + /** +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 }; +/** Registration state of a user, e.g. + * have they sent USER, NICK, PASS yet? + */ 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 */ }; +/* Required forward declaration */ class InspIRCd; /** Derived from Resolver, and performs user forward/reverse lookups. */ -class UserResolver : public Resolver +class CoreExport UserResolver : public Resolver { private: /** User this class is 'attached' to. */ userrec* 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, userrec* user, std::string to_resolve, QueryType qt, bool &cache); - void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached); + /** 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); + + /** Called on failed lookup + * @param e Error code + * @param errormessage Error message string + */ void OnError(ResolverError e, const std::string &errormessage); }; /** Holds information relevent to <connect allow> and <connect deny> tags in the config file. */ -class ConnectClass : public classbase +class 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; @@ -117,14 +165,23 @@ class ConnectClass : public classbase */ unsigned long maxglobal; + /** Max channels for this class + */ + unsigned int maxchans; + + /** Port number this connect class applies to + */ + int port; + public: /** Create a new connect class with no settings. */ - ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), + ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(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 @@ -136,17 +193,67 @@ public: * @param maxl The maximum local sessions * @param maxg The maximum global sessions */ - ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping, + ConnectClass(const std::string &thename, 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) : - type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), - threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { } + 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), + threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p) { } - /** Create a new connect class to DENY connections + /** 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 &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0), - pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { } + ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0), + flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(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(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), threshold(source.threshold), sendqmax(source.sendqmax), + recvqmax(source.recvqmax), maxlocal(source.maxlocal), maxglobal(source.maxglobal), maxchans(source.maxchans), + port(source.port) + { + } + + /* 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) + { + 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; + } + + int GetMaxChans() + { + return maxchans; + } /** Returns the type, CC_ALLOW or CC_DENY */ @@ -155,6 +262,11 @@ public: return (type == CC_ALLOW ? CC_ALLOW : CC_DENY); } + std::string& GetName() + { + return name; + } + /** Returns the registration timeout */ unsigned int GetRegTimeout() @@ -176,6 +288,20 @@ public: 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() @@ -215,14 +341,19 @@ public: */ unsigned long GetMaxLocal() { - return (maxlocal ? maxlocal : 1); + return maxlocal; } /** Returns the maximum number of global sessions */ unsigned long GetMaxGlobal() { - return (maxglobal ? maxglobal : 1); + return maxglobal; + } + + bool operator= (ConnectClass &other) + { + return (other.GetName() == name); } }; @@ -237,8 +368,36 @@ 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 userrec; + +/** Visibility data for a user. + * If a user has a non-null instance of this class in their userrec, + * 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(userrec* 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 @@ -246,7 +405,7 @@ typedef UserChanList::iterator UCListIter; * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their * file descriptor value. */ -class userrec : public connection +class CoreExport userrec : public connection { private: /** Pointer to creator. @@ -276,6 +435,9 @@ class userrec : public connection /** Cached nick!ident@host value using the masked hostname */ char* cached_makehost; + + /** Cached nick!ident@realhost value using the real hostname + */ char* cached_fullrealhost; /** When we erase the user (in the destructor), @@ -283,6 +445,15 @@ class userrec : public connection * mode characters this user is making use of. */ void DecrementModes(); + + /** Oper-only quit message for this user if non-null + */ + char* operquit; + + /** Max channels for this user + */ + unsigned int MaxChans; + public: /** Resolvers for looking up this users IP address * This will occur if and when res_reverse completes. @@ -297,6 +468,10 @@ class userrec : public connection */ UserResolver* res_reverse; + /** User visibility state, see definition of VisData. + */ + VisData* Visibility; + /** Stored reverse lookup from res_forward */ std::string stored_host; @@ -307,6 +482,8 @@ class userrec : 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. @@ -685,6 +862,10 @@ class userrec : public connection */ void Oper(const std::string &opertype); + /** Call this method to find the matching for a user, and to check them against it. + */ + void CheckClass(const std::string &explicit_class = ""); + /** Use this method to fully connect a user. * This will send the message of the day, check G/K/E lines, etc. */ @@ -734,6 +915,12 @@ class userrec : public connection */ unsigned long LocalCloneCount(); + /** Remove all clone counts from the user, you should + * use this if you change the user's IP address in + * userrec::ip after they have registered. + */ + void RemoveCloneCounts(); + /** Write text to this user, appending CR/LF. * @param text A std::string to send to the user */ @@ -804,6 +991,11 @@ class userrec : public connection */ void WriteCommonExcept(const std::string &text); + /** Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific + * quit message for opers only. + * @param normal_text Normal user quit message + * @param oper_text Oper only quit message + */ void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text); /** Write a WALLOPS message from this user to all local opers. @@ -883,9 +1075,10 @@ class userrec : public connection void PurgeEmptyChannels(); /** Get the connect class which matches this user's host or IP address + * @param explicit_name Set this string to tie the user to a specific class name * @return A reference to this user's connect class */ - ConnectClass* GetClass(); + ConnectClass* GetClass(const std::string &explicit_name = ""); /** Show the message of the day to this user */ @@ -895,6 +1088,16 @@ class userrec : public connection */ 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 char* GetOperQuit(); + /** Handle socket event. * From EventHandler class. * @param et Event type @@ -911,3 +1114,4 @@ class userrec : public connection class ServerConfig; #endif +