X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=ed649f1b9758c7d5d6e166d34edc4b03b694e11d;hb=0f74e88f0996acff1580bcf5f2ea3dc986497339;hp=76337b2c337edfec83f3c7a5e0ea27b5db7b69c6;hpb=7107ec12d8640d35cfe3d5002db1bc1deb33625d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 76337b2c3..ed649f1b9 100644 --- a/include/users.h +++ b/include/users.h @@ -56,14 +56,17 @@ enum RegistrationState { REG_ALL = 7 /* REG_NICKUSER plus next bit along */ }; -/* Required forward declaration */ -class Channel; -class UserResolver; +enum UserType { + USERTYPE_LOCAL = 1, + USERTYPE_REMOTE = 2, + USERTYPE_SERVER = 3 +}; /** Holds information relevent to <connect allow> and <connect deny> tags in the config file. */ -struct CoreExport ConnectClass : public classbase +struct CoreExport ConnectClass : public refcountbase { + reference config; /** Type of line, either CC_ALLOW or CC_DENY */ char type; @@ -106,6 +109,10 @@ struct CoreExport ConnectClass : public classbase */ unsigned long recvqmax; + /** Seconds worth of penalty before penalty system activates + */ + unsigned long penaltythreshold; + /** Local max when connecting by this connection class */ unsigned long maxlocal; @@ -127,18 +134,12 @@ struct CoreExport ConnectClass : public classbase */ unsigned long limit; - /** 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; - /** Create a new connect class with no settings. */ - ConnectClass(char type, const std::string& mask); + ConnectClass(ConfigTag* tag, char type, const std::string& mask); /** Create a new connect class with inherited settings. */ - ConnectClass(char type, const std::string& mask, const ConnectClass& parent); + ConnectClass(ConfigTag* tag, 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); @@ -185,6 +186,13 @@ struct CoreExport ConnectClass : public classbase return (recvqmax ? recvqmax : 4096); } + /** Returns the penalty threshold value + */ + unsigned long GetPenaltyThreshold() + { + return penaltythreshold; + } + /** Returusn the maximum number of local sessions */ unsigned long GetMaxLocal() @@ -200,26 +208,6 @@ struct CoreExport ConnectClass : public classbase } }; -/** 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; - -/** Holds a complete list of all allow and deny tags from the configuration file (connection classes) - */ -typedef std::vector ClassVector; - -/** Typedef for the list of user-channel records for a user - */ -typedef std::set UserChanList; - -/** Shorthand for an iterator into a UserChanList - */ -typedef UserChanList::iterator UCListIter; - -/* Required forward declaration - */ -class 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 @@ -228,12 +216,6 @@ class User; class CoreExport User : public StreamSocket { private: - /** 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. - */ - InvitedList invites; - /** Cached nick!ident@dhost value using the displayed hostname */ std::string cached_fullhost; @@ -259,60 +241,13 @@ class CoreExport User : public StreamSocket * mode characters this user is making use of. */ void DecrementModes(); - - std::set *AllowedOperCommands; - std::set *AllowedPrivs; - - /** Allowed user modes from oper classes. */ - std::bitset<64> AllowedUserModes; - - /** Allowed channel modes from oper classes. */ - std::bitset<64> AllowedChanModes; - public: - static LocalIntExt NICKForced; - static LocalStringExt OperQuit; - - /** 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; /** Hostname of connection. * This should be valid as per RFC1035. */ std::string host; - /** Stats counter for bytes inbound - */ - int bytes_in; - - /** Stats counter for bytes outbound - */ - int bytes_out; - - /** Stats counter for commands inbound - */ - int cmds_in; - - /** Stats counter for commands outbound - */ - int cmds_out; - - /** True if user has authenticated, false if otherwise - */ - bool haspassed; - - /** Used by User to indicate the registration status of the connection - * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate - * the connection state. - */ - char registered; - - /** Time the connection was last pinged - */ - time_t lastping; - /** Time that the object was instantiated (used for TS calculation etc) */ time_t age; @@ -327,19 +262,11 @@ class CoreExport User : public StreamSocket */ time_t idle_lastmsg; - /** Used by PING checking code - */ - time_t nping; - - /** Stored reverse lookup from res_forward. Should not be used after resolution. - */ - std::string stored_host; - - /** Starts a DNS lookup of the user's IP. - * This will cause two UserResolver classes to be instantiated. - * When complete, these objects set User::dns_done to true. + /** Client address that the user is connected from. + * Do not modify this value directly, use SetClientIP() to change it. + * Port is not valid for remote users. */ - void StartDNSLookup(); + irc::sockets::sockaddrs client_sa; /** The users nickname. * An invalid nickname indicates an unregistered connection prior to the NICK command. @@ -350,7 +277,7 @@ class CoreExport User : public StreamSocket /** The user's unique identifier. * This is the unique identifier which the user has across the network. */ - std::string uuid; + const std::string uuid; /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. @@ -383,13 +310,13 @@ class CoreExport User : public StreamSocket */ std::bitset<64> snomasks; - /** Channels this user is on, and the permissions they have there + /** Channels this user is on */ UserChanList chans; /** The server the user is connected to. */ - const char* server; + const std::string server; /** The user's away message. * If this string is empty, the user is not marked as away. @@ -402,89 +329,61 @@ class CoreExport User : public StreamSocket time_t awaytime; /** 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. - * The value of this is the value of a valid 'type name=' tag. */ - std::string oper; + reference oper; + + /** Used by User to indicate the registration status of the connection + * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate + * the connection state. + */ + unsigned int registered:3; /** True when DNS lookups are completed. * The UserResolver classes res_forward and res_reverse will * set this value once they complete. */ - bool dns_done; - - /** Password specified by the user when they registered. - * This is stored even if the block doesnt need a password, so that - * modules may check it. - */ - std::string password; + unsigned int dns_done:1; /** Whether or not to send an snotice about this user's quitting */ - bool quietquit; + unsigned int quietquit:1; /** 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. * Please note that setting this value alone will NOT cause the user to quit. */ - bool quitting; + unsigned int quitting:1; - /** 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 + /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. */ - irc::sockets::sockaddrs client_sa; + unsigned int exempt:1; - /** Sets the client IP for this user - * @return true if the conversion was successful + /** has the user responded to their previous ping? */ - bool SetClientIP(const char* sip); + unsigned int lastping:1; - /** - * @return The port number of this user. - */ - int GetServerPort(); - /** - * @return The server IP address - */ - std::string GetServerIP(); + /** What type of user is this? */ + const unsigned int usertype:2; /** Get client IP string from sockaddr, using static internal buffer * @return The IP string */ 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 - * This may be used for CIDR clone detection, etc. - * - * (XXX, brief note: when we do the sockets rewrite, this should move down a - * level so it may be used on more derived objects. -- w00t) + /** Get CIDR mask, using default range, for this user */ - const char *GetCIDRMask(int range); + irc::sockets::cidr_mask GetCIDRMask(); - /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. - */ - bool exempt; - - /** This value contains how far into the penalty threshold the user is. Once its over - * the penalty threshold then commands are held and processed on-timer. + /** Sets the client IP for this user + * @return true if the conversion was successful */ - int Penalty; + bool SetClientIP(const char* sip); - /** Default constructor + /** Constructor * @throw CoreException if the UID allocated to the user already exists - * @param Instance Creator instance - * @param uid User UUID, or empty to allocate one automatically */ - User(const std::string &uid = ""); + User(const std::string &uid, const std::string& srv, int objtype); /** 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) @@ -497,7 +396,7 @@ class CoreExport User : public StreamSocket * 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 @@ -505,7 +404,7 @@ class CoreExport User : public StreamSocket * 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. @@ -554,32 +453,13 @@ class CoreExport User : public StreamSocket */ 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(const irc::string &channel); - - /** Adds a channel to a users invite list (invites them to a channel) - * @param channel A channel name to add - * @param timeout When the invite should expire (0 == never) - */ - virtual void InviteTo(const irc::string &channel, time_t timeout); - - /** 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(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 User::oper, then referencing * this to their oper classes and checking the commands they can execute. * @param command A command (should be all CAPS) * @return True if this user can execute the command */ - bool HasPermission(const std::string &command); + virtual bool HasPermission(const std::string &command); /** Returns true if a user has a given permission. * This is used to check whether or not users may perform certain actions which admins may not wish to give to @@ -589,7 +469,7 @@ class CoreExport User : public StreamSocket * @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 = false); + virtual 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 @@ -598,19 +478,7 @@ class CoreExport User : public StreamSocket * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER). * @return True if the user can set or unset this mode. */ - bool HasModePermission(unsigned char mode, ModeType type); - - /** 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. - * @param data The data to add to the write buffer - */ - void AddWriteBuf(const std::string &data); - - /** 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 - */ - InvitedList* GetInviteList(); + virtual bool HasModePermission(unsigned char mode, ModeType type); /** Creates a wildcard host. * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname @@ -636,18 +504,8 @@ class CoreExport User : public StreamSocket /** Oper up the user using the given opertype. * This will also give the +o usermode. - * @param opertype The oper type to oper as - */ - void Oper(const std::string &opertype, const std::string &opername); - - /** 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. - */ - void FullConnect(); + void Oper(OperInfo* info); /** Change this users hash key to a new string. * You should not call this function directly. It is used by the core @@ -671,23 +529,26 @@ class CoreExport User : public StreamSocket */ void UnOper(); - /** Write text to this user, appending CR/LF. + /** Write text to this user, appending CR/LF. Works on local users only. * @param text A std::string to send to the user */ - void Write(const std::string &text); + virtual void Write(const std::string &text); /** Write text to this user, appending CR/LF. + * Works on local users only. * @param text The format string for text to send to the user * @param ... POD-type format arguments */ - void Write(const char *text, ...) CUSTOM_PRINTF(2, 3); + virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3); /** Write text to this user, appending CR/LF and prepending :server.name + * Works on local users only. * @param text A std::string to send to the user */ void WriteServ(const std::string& text); /** Write text to this user, appending CR/LF and prepending :server.name + * Works on local users only. * @param text The format string for text to send to the user * @param ... POD-type format arguments */ @@ -726,7 +587,7 @@ class CoreExport User : public StreamSocket /** 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 @@ -740,11 +601,6 @@ class CoreExport User : public StreamSocket */ 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 @@ -752,18 +608,19 @@ class CoreExport User : public StreamSocket */ 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 - * @param ... Format arguments + /** Dump text to a user target, splitting it appropriately to fit + * @param LinePrefix text to prefix each complete line with + * @param TextStream the text to send to the user + */ + void SendText(const std::string &LinePrefix, std::stringstream &TextStream); + + /** Write to the user, routing the line if the user is remote. */ - void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3); + virtual void SendText(const std::string& line) = 0; - /** 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 text to send in the WALLOPS message + /** Write to the user, routing the line if the user is remote. */ - void WriteWallOps(const std::string &text); + void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3); /** Return true if the user shares at least one channel with another user * @param other The other user to compare the channel list against @@ -836,16 +693,10 @@ class CoreExport User : public StreamSocket */ void PurgeEmptyChannels(); - /** Get the connect class which this user belongs to. - * @return A pointer to this user's connect class + /** Get the connect class which this user belongs to. NULL for remote users. + * @return A pointer to this user's connect class. */ - ConnectClass *GetClass(); - - /** Set the connect class to which this user belongs to. - * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking tags from the configuration file. - * @return A reference to this user's current connect class. - */ - ConnectClass *SetClass(const std::string &explicit_name = ""); + virtual ConnectClass* GetClass(); /** Show the message of the day to this user */ @@ -855,23 +706,205 @@ class CoreExport User : public StreamSocket */ void ShowRULES(); - /** Increases a user's command penalty by a set amount. + virtual void OnDataReady(); + virtual void OnError(BufferedSocketError error); + /** Default destructor + */ + virtual ~User(); + virtual CullResult cull(); +}; + +class CoreExport LocalUser : public User +{ + /** 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. */ - void IncreasePenalty(int increase); + InvitedList invites; - /** Decreases a user's command penalty by a set amount. + public: + LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server); + CullResult cull(); + + /** Stats counter for bytes inbound */ - void DecreasePenalty(int decrease); + int bytes_in; + + /** Stats counter for bytes outbound + */ + int bytes_out; + + /** Stats counter for commands inbound + */ + int cmds_in; + + /** Stats counter for commands outbound + */ + int cmds_out; + + /** Password specified by the user when they registered (if any). + * This is stored even if the block doesnt need a password, so that + * modules may check it. + */ + std::string password; + + /** Contains a pointer to the connect class a user is on from + */ + reference MyClass; + + ConnectClass* GetClass(); + + /** Call this method to find the matching for a user, and to check them against it. + */ + void CheckClass(); + + /** Server address and port that this user is connected to. + */ + irc::sockets::sockaddrs server_sa; + + /** + * @return The port number of this user. + */ + int GetServerPort(); + + /** Used by PING checking code + */ + time_t nping; + + /** This value contains how far into the penalty threshold the user is. Once its over + * the penalty threshold then commands are held and processed on-timer. + */ + int Penalty; + + /** Stored reverse lookup from res_forward. Should not be used after resolution. + */ + std::string stored_host; + + /** Starts a DNS lookup of the user's IP. + * This will cause two UserResolver classes to be instantiated. + * When complete, these objects set User::dns_done to true. + */ + void StartDNSLookup(); + + /** Use this method to fully connect a user. + * This will send the message of the day, check G/K/E lines, etc. + */ + void FullConnect(); + + /** Set the connect class to which this user belongs to. + * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking tags from the configuration file. + * @return A reference to this user's current connect class. + */ + void SetClass(const std::string &explicit_name = ""); void OnDataReady(); - void OnError(BufferedSocketError error); + void SendText(const std::string& line); + void Write(const std::string& text); + void Write(const char*, ...) CUSTOM_PRINTF(2, 3); - /** Default destructor + /** 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. + * @param data The data to add to the write buffer */ - virtual ~User(); - virtual void cull(); + void AddWriteBuf(const std::string &data); + + /** 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 + */ + InvitedList* GetInviteList(); + + /** 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 + */ + 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 + * @param timeout When the invite should expire (0 == never) + */ + void InviteTo(const irc::string &channel, time_t timeout); + + /** 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 + */ + 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 User::oper, then referencing + * this to their oper classes and checking the commands they can execute. + * @param command A command (should be all CAPS) + * @return True if this user can execute the command + */ + bool HasPermission(const std::string &command); + + /** Returns true if a user has a given permission. + * This is used to check whether or not users may perform certain actions which admins may not wish to give to + * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc. + * + * @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 = 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 + * this to their oper classes, and checking the modes they can set. + * @param mode The mode the check + * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER). + * @return True if the user can set or unset this mode. + */ + bool HasModePermission(unsigned char mode, ModeType type); +}; + +class CoreExport RemoteUser : public User +{ + public: + RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE) + { + } + virtual void SendText(const std::string& line); }; +class CoreExport FakeUser : public User +{ + public: + FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER) + { + nick = srv; + } + + virtual CullResult cull(); + virtual void SendText(const std::string& line); + virtual const std::string& GetFullHost(); + virtual const std::string& GetFullRealHost(); +}; + +/* Faster than dynamic_cast */ +/** Is a local user */ +inline LocalUser* IS_LOCAL(User* u) +{ + return u->usertype == USERTYPE_LOCAL ? static_cast(u) : NULL; +} +/** Is a remote user */ +inline RemoteUser* IS_REMOTE(User* u) +{ + return u->usertype == USERTYPE_REMOTE ? static_cast(u) : NULL; +} +/** Is a server fakeuser */ +inline FakeUser* IS_SERVER(User* u) +{ + return u->usertype == USERTYPE_SERVER ? static_cast(u) : NULL; +} +/** Is an oper */ +#define IS_OPER(x) (x->oper) +/** Is away */ +#define IS_AWAY(x) (!x->awaymsg.empty()) + /** Derived from Resolver, and performs user forward/reverse lookups. */ class CoreExport UserResolver : public Resolver @@ -879,7 +912,7 @@ class CoreExport UserResolver : public Resolver private: /** User this class is 'attached' to. */ - User* bound_user; + LocalUser* bound_user; /** File descriptor teh lookup is bound to */ int bound_fd; @@ -894,7 +927,7 @@ class CoreExport UserResolver : public Resolver * @param qt The query type * @param cache Modified by the constructor if the result was cached */ - UserResolver(User* user, std::string to_resolve, QueryType qt, bool &cache); + UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache); /** Called on successful lookup * @param result Result string