X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fusers.h;h=0443b24d23493a9e6cef827fe5aa278042956ec7;hb=8683e1c80d9d37ee7ffae54c0d888195a5e8d1a7;hp=84bde46b972a7ff0de0c439e564738eecf428aef;hpb=3759fe0ba2420bd564abb4b034582ea0866907aa;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 84bde46b9..0443b24d2 100644 --- a/include/users.h +++ b/include/users.h @@ -23,59 +23,103 @@ #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); + /** 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 + */ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached); + + /** 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 @@ -245,15 +289,33 @@ 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; -class VisData +/** 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); }; @@ -264,7 +326,7 @@ class VisData * 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. @@ -294,6 +356,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), @@ -302,6 +367,8 @@ class userrec : public connection */ void DecrementModes(); + /** Oper-only quit message for this user if non-null + */ char* operquit; public: @@ -318,6 +385,8 @@ class userrec : public connection */ UserResolver* res_reverse; + /** User visibility state, see definition of VisData. + */ VisData* Visibility; /** Stored reverse lookup from res_forward @@ -708,6 +777,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(); + /** Use this method to fully connect a user. * This will send the message of the day, check G/K/E lines, etc. */ @@ -757,6 +830,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 */ @@ -827,6 +906,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. @@ -923,6 +1007,9 @@ class userrec : public connection */ 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. @@ -941,3 +1028,4 @@ class userrec : public connection class ServerConfig; #endif +