X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=763d45c57d3ce2105a597184054e76bb559faef9;hb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;hp=cd2e98bd49332dc6af10c0d608cc9a2828a56811;hpb=f5c3e3782bfeb3ffb634f86eadb8ffecbc36f176;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index cd2e98bd4..763d45c57 100644 --- a/include/users.h +++ b/include/users.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 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. @@ -14,27 +14,10 @@ #ifndef __USERS_H__ #define __USERS_H__ -#include -#include "inspircd_config.h" #include "socket.h" -#include "channels.h" -#include "inspstring.h" -#include "connection.h" -#include "hashcomp.h" +#include "inspsocket.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 -}; +#include "mode.h" /** connect class types */ @@ -48,16 +31,14 @@ enum ClassTypes { /** RFC1459 channel modes */ enum UserModes { - /** +s: Server notices */ - UM_SERVERNOTICE = 's' - 65, + /** +s: Server notice mask */ + UM_SNOMASK = '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 + UM_OPERATOR = 'o' - 65 }; /** Registration state of a user, e.g. @@ -76,78 +57,40 @@ enum RegistrationState { }; /* Required forward declaration */ -class InspIRCd; - -/** Derived from Resolver, and performs user forward/reverse lookups. - */ -class CoreExport UserResolver : public Resolver -{ - private: - /** User this class is 'attached' to. - */ - User* 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, User* 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 - * @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); -}; - +class Channel; +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; - /** Threshold value for flood disconnect + /** (Optional) Hash Method for this line */ - unsigned int threshold; + std::string hash; /** Maximum size of sendq for users in this class (bytes) */ @@ -173,175 +116,40 @@ 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), threshold(source->threshold), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(0) - { - } - - /** Create a new connect class with no settings. - */ - 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), RefCount(0), disabled(false), 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 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, 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), - threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), 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(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), 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), threshold(source->threshold), sendqmax(source->sendqmax), - recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans), - port(source->port), RefCount(0), disabled(false), limit(0) - { - } - - void SetDisabled(bool t) - { - this->disabled = t; - } - - bool GetDisabled() - { - return this->disabled; - } - - /* 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 limit) - { - 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 = limit; - } + 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; - /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written - */ - bool disabled; - - /** 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; - - int 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 */ - unsigned int GetRegTimeout() + time_t 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; - } - - /** Get port number - */ - int GetPort() - { - return port; - } - - /** Set port number - */ - void SetPort(int p) - { - port = p; - } - /** Returns the ping frequency */ unsigned int GetPingTime() @@ -349,20 +157,6 @@ public: 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() @@ -392,9 +186,9 @@ public: } }; -/** Holds a complete list of all channels to which a user has been invited and has not yet joined. +/** 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 InvitedList; +typedef std::vector< std::pair > InvitedList; /** Holds a complete list of all allow and deny tags from the configuration file (connection classes) */ @@ -402,7 +196,7 @@ typedef std::vector ClassVector; /** Typedef for the list of user-channel records for a user */ -typedef std::map UserChanList; +typedef std::set UserChanList; /** Shorthand for an iterator into a UserChanList */ @@ -412,68 +206,39 @@ typedef UserChanList::iterator UCListIter; */ class User; -/** Visibility data for a user. - * If a user has a non-null instance of this class in their User, - * 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(User* 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 - * 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 connection +class CoreExport User : public StreamSocket { 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. */ InvitedList invites; - /** Number of channels this user is currently on + /** Cached nick!ident@dhost value using the displayed hostname */ - unsigned int ChannelCount; + std::string cached_fullhost; - /** Cached nick!ident@host value using the real hostname + /** Cached ident@ip value using the real IP address */ - char* cached_fullhost; + std::string cached_hostip; - /** Cached nick!ident@ip value using the real IP address + /** Cached ident@realhost value using the real hostname */ - char* cached_hostip; + std::string cached_makehost; - /** Cached nick!ident@host value using the masked hostname + /** Cached nick!ident@realhost value using the real hostname */ - char* cached_makehost; + std::string cached_fullrealhost; - /** Cached nick!ident@realhost value using the real hostname + /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. */ - char* cached_fullrealhost; + std::string cachedip; /** When we erase the user (in the destructor), * we call this method to subtract one from all @@ -481,40 +246,78 @@ class CoreExport User : public connection */ void DecrementModes(); - /** Oper-only quit message for this user if non-null - */ - char* operquit; + std::set *AllowedOperCommands; + std::set *AllowedPrivs; - /** Max channels for this user - */ - unsigned int MaxChans; + /** Allowed user modes from oper classes. */ + std::bitset<64> AllowedUserModes; - std::map* AllowedOperCommands; + /** 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; - /** Resolvers for looking up this users IP address - * This will occur if and when res_reverse completes. - * When this class completes its lookup, User::dns_done - * will be set from false to true. + /** 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 */ - UserResolver* res_forward; + int bytes_out; - /** Resolvers for looking up this users hostname - * This is instantiated by User::StartDNSLookup(), - * and on success, instantiates User::res_reverse. + /** Stats counter for commands inbound */ - UserResolver* res_reverse; + int cmds_in; - /** User visibility state, see definition of VisData. + /** Stats counter for commands outbound */ - VisData* Visibility; + int cmds_out; - /** Stored reverse lookup from res_forward + /** 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; + + /** Time the connection was created, set in the constructor. This + * may be different from the time the user's classbase object was + * created. + */ + time_t signon; + + /** Time that the connection last sent a message, used to calculate idle time + */ + 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; @@ -524,48 +327,47 @@ class CoreExport User : 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. */ - char nick[NICKMAX]; + std::string nick; /** The user's unique identifier. * This is the unique identifier which the user has across the network. */ - char uuid[UUID_LENGTH]; + std::string uuid; /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. */ - char ident[IDENTMAX+2]; + std::string ident; /** The host displayed to non-opers (used for cloaking etc). * This usually matches the value of User::host. */ - char dhost[65]; + std::string dhost; /** The users full name (GECOS). */ - char fullname[MAXGECOS+1]; + std::string fullname; /** 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. - * A value of 1 in field (modeletter-65) indicates that the mode is + * NOT a null terminated string. + * Also NOT an array. + * Much love to the STL for giving us an easy to use bitset, saving us RAM. + * if (modes[modeletter-65]) is set, then the mode is * set, for example, to work out if mode +s is set, we check the field * User::modes['s'-65] != 0. * The following RFC characters o, w, s, i have constants defined via an * enum, such as UM_SERVERNOTICE and UM_OPETATOR. */ - char modes[64]; + std::bitset<64> modes; /** What snomasks are set on this user. * This functions the same as the above modes. */ - char snomasks[64]; + std::bitset<64> snomasks; /** Channels this user is on, and the permissions they have there */ @@ -578,20 +380,19 @@ class CoreExport User : public connection /** The user's away message. * If this string is empty, the user is not marked as away. */ - char awaymsg[MAXAWAY+1]; + std::string awaymsg; - /** Timestamp of current time + connection class timeout. - * This user must send USER/NICK before this timestamp is - * reached or they will be disconnected. + /** Time the user last went away. + * This is ONLY RELIABLE if user IS_AWAY()! */ - time_t timeout; + 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. */ - char oper[NICKMAX]; + std::string oper; /** True when DNS lookups are completed. * The UserResolver classes res_forward and res_reverse will @@ -603,65 +404,57 @@ class CoreExport User : public connection * This is stored even if the block doesnt need a password, so that * modules may check it. */ - char password[64]; + std::string password; - /** User's receive queue. - * Lines from the IRCd awaiting processing are stored here. - * Upgraded april 2005, old system a bit hairy. + /** Whether or not to send an snotice about this user's quitting */ - std::string recvq; + bool quietquit; - /** User's send queue. - * Lines waiting to be sent are stored here until their buffer is flushed. - */ - std::string sendq; - - /** 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 read operations for the user + /** If this is set to true, then all socket 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. + * 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 muted; + 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(); - /* Write error string + /** 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) */ - std::string WriteError; + const char *GetCIDRMask(int range); /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. */ @@ -672,27 +465,25 @@ class CoreExport User : public connection */ 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 * @param uid User UUID, or empty to allocate one automatically */ - User(InspIRCd* Instance, const std::string &uid = ""); + User(const std::string &uid = ""); + + /** 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) + * Returns true if the user matched a ban, false else. + */ + bool CheckLines(bool doZline = false); /** 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(); + 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 @@ -700,7 +491,7 @@ class CoreExport User : public connection * 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 char* 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. @@ -735,7 +526,7 @@ class CoreExport User : public connection /** Create a displayable mode string for this users umodes * @param The mode string */ - const char* FormatModes(); + const char* FormatModes(bool showparameters = false); /** Returns true if a specific mode is set * @param m The user mode @@ -757,8 +548,9 @@ class CoreExport User : public connection /** 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); + 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 @@ -775,74 +567,32 @@ class CoreExport User : public connection */ bool HasPermission(const std::string &command); - /** Calls read() to read some data for this user using their fd. - * @param buffer The buffer to read into - * @param size The size of data to read - * @return The number of bytes read, or -1 if an error occured. + /** 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. */ - int ReadData(void* buffer, size_t size); + bool HasPrivPermission(const std::string &privstr, bool noisy = false); - /** This method adds data to the read buffer of the user. - * The buffer can grow to any size within limits of the available memory, - * managed by the size of a std::string, however if any individual line in - * the buffer grows over 600 bytes in length (which is 88 chars over the - * RFC-specified limit per line) then the method will return false and the - * text will not be inserted. - * @param a The string to add to the users read buffer - * @return True if the string was successfully added to the read buffer - */ - bool AddBuffer(std::string a); - - /** This method returns true if the buffer contains at least one carriage return - * character (e.g. one complete line may be read) - * @return True if there is at least one complete line in the users buffer - */ - bool BufferIsReady(); - - /** This function clears the entire buffer by setting it to an empty string. - */ - void ClearBuffer(); - - /** This method returns the first available string at the tail end of the buffer - * and advances the tail end of the buffer past the string. This means it is - * a one way operation in a similar way to strtok(), and multiple calls return - * multiple lines if they are available. The results of this function if there - * are no lines to be read are unknown, always use BufferIsReady() to check if - * it is ok to read the buffer before calling GetBuffer(). - * @return The string at the tail end of this users buffer - */ - std::string GetBuffer(); - - /** Sets the write error for a connection. This is done because the actual disconnect - * of a client may occur at an inopportune time such as half way through /LIST output. - * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and - * errored clients purged. - * @param error The error string to set. - */ - void SetWriteError(const std::string &error); - - /** Returns the write error which last occured on this connection or an empty string - * if none occured. - * @return The error string which has occured for this user + /** 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. */ - const char* GetWriteError(); + 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, SetWriteError() will be called to set the users error string to - * "SendQ exceeded", and further buffer adds will be dropped. + * 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); - /** Flushes as much of the user's buffer to the file descriptor as possible. - * This function may not always flush the entire buffer, rather instead as much of it - * as it possibly can. If the send() call fails to send the entire buffer, the buffer - * position is advanced forwards and the rest of the data sent at the next call to - * this method. - */ - void FlushWriteBuf(); - /** 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 */ @@ -858,27 +608,13 @@ class CoreExport User : public connection * 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(); + const std::string& 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 */ - char* MakeHostIP(); - - /** Shuts down and closes the user's socket - * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this, - * which will call CloseSocket() for you. - */ - void CloseSocket(); - - /** Disconnect a user gracefully - * @param user The user to remove - * @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, User *user, const std::string &r, const char* oreason = ""); + const std::string& MakeHostIP(); /** Add the user to WHOWAS system */ @@ -916,49 +652,21 @@ class CoreExport User : public connection */ bool ForceNickChange(const char* newnick); - /** Add a client to the system. - * This will create a new User, insert it into the user_hash, - * initialize it as not yet registered, and add it to the socket engine. - * @param Instance a pointer to the server instance - * @param socket The socket id (file descriptor) this user is on - * @param port The port number this user connected on - * @param iscached This variable is reserved for future use - * @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, int socketfamily, sockaddr* ip); - /** Oper down. * This will clear the +o usermode and unset the user's oper type */ void UnOper(); - /** Return the number of global clones of this user - * @return The global clone count of this user - */ - unsigned long GlobalCloneCount(); - - /** Return the number of local clones of this user - * @return The local clone count of this user - */ - unsigned long LocalCloneCount(); - - /** Remove all clone counts from the user, you should - * use this if you change the user's IP address in - * User::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 */ - 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 * @param ... POD-type format arguments */ - void Write(const char *text, ...); + void Write(const char *text, ...) CUSTOM_PRINTF(2, 3); /** Write text to this user, appending CR/LF and prepending :server.name * @param text A std::string to send to the user @@ -969,7 +677,11 @@ class CoreExport User : public connection * @param text The format string for text to send to the user * @param ... POD-type format arguments */ - void WriteServ(const char* text, ...); + void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3); + + void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4); + + void WriteNumeric(unsigned int numeric, const std::string &text); /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter. * @param user The user to prepend the :nick!user@host of @@ -982,7 +694,7 @@ class CoreExport User : public connection * @param text The format string for text to send to the user * @param ... POD-type format arguments */ - void WriteFrom(User *user, const char* text, ...); + void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4); /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host. * @param dest The user to route the message to @@ -995,7 +707,7 @@ class CoreExport User : public connection * @param text The format string for text to send to the user * @param ... POD-type format arguments */ - void WriteTo(User *dest, const char *data, ...); + void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4); /** 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 @@ -1006,13 +718,13 @@ class CoreExport User : public connection * @param text The format string for text to send to the users * @param ... POD-type format arguments */ - void WriteCommon(const char* text, ...); + void WriteCommon(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 The format string for text to send to the users * @param ... POD-type format arguments */ - void WriteCommonExcept(const char* text, ...); + 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 @@ -1031,7 +743,7 @@ class CoreExport User : public connection * @param text The format string to send in the WALLOPS message * @param ... Format arguments */ - void WriteWallOps(const char* text, ...); + void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3); /** Write a WALLOPS message from this user to all local opers. * If this user is not opered, the function will return without doing anything. @@ -1045,6 +757,14 @@ class CoreExport User : public connection */ 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 @@ -1081,14 +801,14 @@ class CoreExport User : public connection * @param text The text format string to send * @param ... Format arguments */ - void SendAll(const char* command, char* text, ...); + void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4); - /** Compile a channel list for this user, and send it to the user 'source' - * Used internally by WHOIS - * @param The user to send the channel list to if it is not too long + /** Compile a channel list for this user. Used internally by WHOIS + * @param source The user to prepare the channel list for + * @param spy Whether to return the spy channel list rather than the normal one * @return This user's channel list */ - std::string ChannelList(User* source); + std::string ChannelList(User* source, bool spy); /** Split the channel list in cl which came from dest, and spool it to this user * Used internally by WHOIS @@ -1121,16 +841,6 @@ class CoreExport User : 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(); - /** Increases a user's command penalty by a set amount. */ void IncreasePenalty(int increase); @@ -1139,20 +849,51 @@ class CoreExport User : public connection */ void DecreasePenalty(int decrease); - /** 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); + void OnDataReady(); + void OnError(BufferedSocketError error); /** Default destructor */ virtual ~User(); + virtual void cull(); }; -/* Configuration callbacks */ -class ServerConfig; +/** Derived from Resolver, and performs user forward/reverse lookups. + */ +class CoreExport UserResolver : public Resolver +{ + private: + /** User this class is 'attached' to. + */ + User* 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(User* user, std::string to_resolve, QueryType qt, bool &cache); -#endif + /** 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); +}; +#endif