X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=0443b24d23493a9e6cef827fe5aa278042956ec7;hb=8683e1c80d9d37ee7ffae54c0d888195a5e8d1a7;hp=536f37a8073990975211228787ebe34ad7729621;hpb=193b540aa750446bf67dcad132773541214c296d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 536f37a80..0443b24d2 100644 --- a/include/users.h +++ b/include/users.h @@ -2,143 +2,285 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * Written by Craig Edwards, Craig McLure, and others. + * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * See: http://www.inspircd.org/wiki/index.php/Credits + * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ -#ifndef __USERS_H__ -#define __USERS_H__ +#ifndef __USERS_H__ +#define __USERS_H__ #include -#include "inspircd_config.h" +#include "inspircd_config.h" #include "socket.h" #include "channels.h" #include "inspstring.h" #include "connection.h" #include "hashcomp.h" #include "dns.h" -#include "cull_list.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 */ }; -/** Holds a channel name to which a user has been invited. - */ -class Invited : public classbase -{ - public: - irc::string channel; -}; - +/* 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: - UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, bool forward); + /** 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); - void OnLookupComplete(const std::string &result); + /** 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 { - public: + private: /** Type of line, either CC_ALLOW or CC_DENY */ char type; /** Max time to register the connection in seconds */ - int registration_timeout; + unsigned int registration_timeout; /** Number of lines in buffer before excess flood is triggered */ - int flood; + unsigned int flood; /** Host mask for this line */ std::string host; /** Number of seconds between pings for this line */ - int pingtime; + unsigned int pingtime; /** (Optional) Password for this line */ std::string pass; /** Threshold value for flood disconnect */ - int threshold; + unsigned int threshold; /** Maximum size of sendq for users in this class (bytes) */ - long sendqmax; + unsigned long sendqmax; /** Maximum size of recvq for users in this class (bytes) */ - long recvqmax; + unsigned long recvqmax; /** Local max when connecting by this connection class */ - long maxlocal; + unsigned long maxlocal; /** Global max when connecting by this connection class */ - long maxglobal; - - ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0) + unsigned long maxglobal; + /** 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(""), + threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { } + + /** Create a new connect class to ALLOW connections. + * @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 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(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, int p = 0) : + type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), + threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { } + + /** Create a new connect class to DENY connections + * @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), port(0) { } + + /** Returns the type, CC_ALLOW or CC_DENY + */ + char GetType() + { + return (type == CC_ALLOW ? CC_ALLOW : CC_DENY); + } + + /** Returns the registration timeout + */ + unsigned int GetRegTimeout() { + 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; + } + + int GetPort() + { + return port; + } + + /** Returns the ping frequency + */ + unsigned int GetPingTime() + { + return (pingtime ? pingtime : 120); + } + + /** Returns the password or an empty string + */ + const std::string& GetPass() + { + return pass; + } + + /** Returns the flood threshold value + */ + unsigned int GetThreshold() + { + return (threshold ? threshold : 1); + } + + /** Returns the maximum sendq value + */ + unsigned long GetSendqMax() + { + return (sendqmax ? sendqmax : 262114); + } + + /** Returns the maximum recvq value + */ + unsigned long GetRecvqMax() + { + return (recvqmax ? recvqmax : 4096); + } + + /** Returusn the maximum number of local sessions + */ + unsigned long GetMaxLocal() + { + return maxlocal; + } + + /** Returns the maximum number of global sessions + */ + unsigned long GetMaxGlobal() + { + return maxglobal; } }; /** Holds a complete list of all channels to which a user has been invited and has not yet joined. */ -typedef std::vector InvitedList; - - +typedef std::vector InvitedList; /** Holds a complete list of all allow and deny tags from the configuration file (connection classes) */ @@ -146,7 +288,36 @@ typedef std::vector ClassVector; /** Typedef for the list of user-channel records for a user */ -typedef std::vector UserChanList; +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 @@ -155,7 +326,7 @@ typedef std::vector UserChanList; * 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. @@ -173,6 +344,33 @@ class userrec : public connection /** Number of channels this user is currently on */ unsigned int ChannelCount; + + /** Cached nick!ident@host value using the real hostname + */ + char* cached_fullhost; + + /** Cached nick!ident@ip value using the real IP address + */ + char* cached_hostip; + + /** 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), + * we call this method to subtract one from all + * mode characters this user is making use of. + */ + void DecrementModes(); + + /** Oper-only quit message for this user if non-null + */ + char* operquit; + public: /** Resolvers for looking up this users IP address * This will occur if and when res_reverse completes. @@ -187,6 +385,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; @@ -196,13 +398,13 @@ class userrec : public connection * When complete, these objects set userrec::dns_done to true. */ void StartDNSLookup(); - + /** The users nickname. * An invalid nickname indicates an unregistered connection prior to the NICK command. * Use InspIRCd::IsNick() to validate nicknames. */ char nick[NICKMAX]; - + /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. */ @@ -212,11 +414,11 @@ class userrec : public connection * This usually matches the value of userrec::host. */ char dhost[65]; - + /** The users full name (GECOS). */ char fullname[MAXGECOS+1]; - + /** 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. @@ -236,28 +438,28 @@ class userrec : public connection /** Channels this user is on, and the permissions they have there */ UserChanList chans; - + /** The server the user is connected to. */ const char* server; - + /** The user's away message. * If this string is empty, the user is not marked as away. */ char awaymsg[MAXAWAY+1]; - + /** Number of lines the user can place into the buffer * (up to the global NetBufferSize bytes) before they * are disconnected for excess flood */ int flood; - - /** Number of seconds this user is given to send USER/NICK - * If they do not send their details in this time limit they - * will be disconnected + + /** Timestamp of current time + connection class timeout. + * This user must send USER/NICK before this timestamp is + * reached or they will be disconnected. */ - unsigned int timeout; - + 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. @@ -304,7 +506,16 @@ class userrec : public connection */ long threshold; - /** IPV4 or IPV6 ip address + /** If this is set to true, then all read operations for the user + * are dropped into the bit-bucket. + * This is used by the global CullList, but please note that setting this value + * alone will NOT cause the user to quit. This means it can be used seperately, + * for example by shun modules etc. + */ + bool muted; + + /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/ + * GetIPString/GetPort to obtain its values. */ sockaddr* ip; @@ -340,26 +551,36 @@ class userrec : public connection */ std::string WriteError; - /** Maximum size this user's sendq can become + /** Maximum size this user's sendq can become. + * Copied from the connect class on connect. */ long sendqmax; - /** Maximum size this user's recvq can become + /** Maximum size this user's recvq can become. + * Copied from the connect class on connect. */ long recvqmax; + /** This is true if the user matched an exception when they connected to the ircd. + * It isnt valid after this point, and you should not attempt to do anything with it + * after this point, because the eline might be removed at a later time, and/or no + * longer be applicable to this user. It is only used to save doing the eline lookup + * twice (instead we do it once and set this value). + */ + bool exempt; + /** Default constructor * @throw Nothing at present */ userrec(InspIRCd* Instance); - + /** Returns the full displayed host of the user * This member function returns the hostname of the user as seen by other users * on the server, in nick!ident&at;host form. * @return The full masked host of the user */ virtual char* GetFullHost(); - + /** Returns the full real host of the user * This member function returns the hostname of the user as seen by other users * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation, @@ -368,6 +589,11 @@ class userrec : public connection */ virtual char* 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. + */ + void InvalidateCache(); + /** Create a displayable mode string for this users snomasks * @return The notice mask character sequence */ @@ -409,25 +635,25 @@ class userrec : public connection * @param value On or off setting of the mode */ void SetMode(unsigned char m, bool value); - + /** Returns true if a user is invited to a channel. * @param channel A channel name to look up * @return True if the user is invited to the given channel */ - virtual bool IsInvited(irc::string &channel); - + virtual bool IsInvited(const irc::string &channel); + /** Adds a channel to a users invite list (invites them to a channel) * @param channel A channel name to add */ - virtual void InviteTo(irc::string &channel); - + virtual void InviteTo(const irc::string &channel); + /** Removes a channel from a users invite list. * This member function is called on successfully joining an invite only channel * to which the user has previously been invited, to clear the invitation. * @param channel The channel to remove the invite to */ - virtual void RemoveInvite(irc::string &channel); - + virtual void RemoveInvite(const irc::string &channel); + /** Returns true or false for if a user can execute a privilaged oper command. * This is done by looking up their oper type from userrec::oper, then referencing * this to their oper classes and checking the commands they can execute. @@ -515,11 +741,17 @@ class userrec : public connection */ char* MakeWildHost(); - /** Creates a host. - * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host - * @param Buffer to fill with host information + /** Creates a usermask with real host. + * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host + * @return the usermask in the format user@host + */ + char* MakeHost(); + + /** Creates a usermask with real ip. + * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip + * @return the usermask in the format user@ip */ - void MakeHost(char* nhost); + char* MakeHostIP(); /** Shuts down and closes the user's socket * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this, @@ -529,10 +761,11 @@ class userrec : public connection /** Disconnect a user gracefully * @param user The user to remove - * @param r The quit reason + * @param r The quit reason to show to normal users + * @param oreason The quit reason to show to opers * @return Although this function has no return type, on exit the user provided will no longer exist. */ - static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r); + static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = ""); /** Add the user to WHOWAS system */ @@ -544,15 +777,14 @@ 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. - * @param Goners If the user is disconnected by this method call, the - * value of 'this' will be pushed onto this CullList. This is used by - * the core to connect many users in rapid succession without invalidating - * iterators. - * @param Goners a CullList to use for failed connections */ - void FullConnect(CullList* Goners); + void FullConnect(); /** Change this users hash key to a new string. * You should not call this function directly. It is used by the core @@ -581,7 +813,7 @@ class userrec : public connection * @param ip The IP address of the user * @return This function has no return value, but a call to AddClient may remove the user. */ - static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, insp_inaddr ip); + static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip); /** Oper down. * This will clear the +o usermode and unset the user's oper type @@ -591,12 +823,18 @@ class userrec : public connection /** Return the number of global clones of this user * @return The global clone count of this user */ - long GlobalCloneCount(); + unsigned long GlobalCloneCount(); /** Return the number of local clones of this user * @return The local clone count of this user */ - long LocalCloneCount(); + 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 @@ -668,6 +906,13 @@ 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. * If this user is not opered, the function will return without doing anything. * @param text The format string to send in the WALLOPS message @@ -715,22 +960,15 @@ class userrec : public connection */ bool ChangeName(const char* gecos); - /** Return the total number of channels this user is on. - * @return The number of channels the user is on - */ - int CountChannels(); - - /** Modify the number of channels this user is on (used by CountChannels). - * Pass a positive number to increment the counter, or a negative number - * to decrement it. - */ - void ModChannelCount(int n); - - /** Send a notice to all local users from this user + /** Send a command to all local users from this user + * The command given must be able to send text with the + * first parameter as a servermask (e.g. $*), so basically + * you should use PRIVMSG or NOTICE. + * @param command the command to send * @param text The text format string to send * @param ... Format arguments */ - void NoticeAll(char* text, ...); + void SendAll(const char* command, char* text, ...); /** Compile a channel list for this user, and send it to the user 'source' * Used internally by WHOIS @@ -754,7 +992,7 @@ class userrec : public connection /** Get the connect class which matches this user's host or IP address * @return A reference to this user's connect class */ - ConnectClass& GetClass(); + ConnectClass* GetClass(); /** Show the message of the day to this user */ @@ -764,8 +1002,20 @@ 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 + * @param errornum Error number for EVENT_ERROR events */ void HandleEvent(EventType et, int errornum = 0); @@ -774,66 +1024,8 @@ class userrec : public connection virtual ~userrec(); }; - -namespace irc -{ - /** Holds whowas related functions and classes - */ - namespace whowas - { - - /** Used to hold WHOWAS information - */ - class WhoWasGroup : public classbase - { - public: - /** Real host - */ - char* host; - /** Displayed host - */ - char* dhost; - /** Ident - */ - char* ident; - /** Server name - */ - const char* server; - /** Fullname (GECOS) - */ - char* gecos; - /** Signon time - */ - time_t signon; - - /** Initialize this WhoQasFroup with a user - */ - WhoWasGroup(userrec* user); - /** Destructor - */ - ~WhoWasGroup(); - }; - - /** A group of users related by nickname - */ - typedef std::deque whowas_set; - - /** Sets of users in the whowas system - */ - typedef std::map whowas_users; - - /** Called every hour by the core to remove expired entries - */ - void MaintainWhoWas(InspIRCd* ServerInstance, time_t TIME); - }; -}; - /* Configuration callbacks */ class ServerConfig; -bool InitTypes(ServerConfig* conf, const char* tag); -bool InitClasses(ServerConfig* conf, const char* tag); -bool DoType(ServerConfig* conf, const char* tag, char** entries, void** values, int* types); -bool DoClass(ServerConfig* conf, const char* tag, char** entries, void** values, int* types); -bool DoneClassesAndTypes(ServerConfig* conf, const char* tag); #endif +