X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=229edcfa2564aea295979c9f8c966d3fbbc24bc7;hb=8c2d96013084de950e3a63be4ae6ed626c4093ab;hp=f516a80384771b5452d8ca4584dd73e136d609ae;hpb=3c9686f9f790e1a53e60f7da966b2415617a388f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index f516a8038..229edcfa2 100644 --- a/include/users.h +++ b/include/users.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * InspIRCd: (C) 2002-2008 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see @@ -14,15 +14,12 @@ #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 "dns.h" +#include "mode.h" + /** Channel status for a user */ enum ChanStatus { @@ -76,47 +73,8 @@ 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. */ @@ -145,6 +103,10 @@ class CoreExport ConnectClass : public classbase */ std::string pass; + /** (Optional) Hash Method for this line + */ + std::string hash; + /** Threshold value for flood disconnect */ unsigned int threshold; @@ -177,18 +139,20 @@ 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) : 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) + 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), hash(source->hash), 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) { } + ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""), + 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 @@ -197,6 +161,7 @@ public: * @param hst The IP mask to allow * @param ping The ping frequency * @param pas The password to be used + * @param hsh The hash to be used * @param thres The flooding threshold * @param sendq The maximum sendq value * @param recvq The maximum recvq value @@ -204,35 +169,47 @@ public: * @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, + const std::string &pas, const std::string &hsh, 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) { } + type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh), + 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) { } + flood(0), host(hst), pingtime(0), pass(""), hash(""), 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 */ - 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) + 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), hash(source->hash), 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 maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit) { if (timeout) registration_timeout = timeout; @@ -258,8 +235,30 @@ public: maxchans = maxc; if (p) port = p; + + this->limit = llimit; + } + + void Update(const std::string &n, const std::string &hst) + { + name = n; + host = hst; } + /** 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. :) + */ + 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) + */ + unsigned long limit; + int GetMaxChans() { return maxchans; @@ -326,6 +325,13 @@ public: return pass; } + /** Returns the hash or an empty string + */ + const std::string& GetHash() + { + return hash; + } + /** Returns the flood threshold value */ unsigned int GetThreshold() @@ -360,38 +366,15 @@ public: { return maxglobal; } - - bool operator== (ConnectClass &other) - { - return (other.GetName() == name); - } - - void operator=(const ConnectClass & other) - { - type = other.type; - name = other.name; - registration_timeout = other.registration_timeout; - flood = other.flood; - host = other.host; - pingtime = other.pingtime; - pass = other.pass; - threshold = other.threshold; - sendqmax = other.sendqmax; - recvqmax = other.recvqmax; - maxlocal = other.maxlocal; - maxglobal = other.maxglobal; - maxchans = other.maxchans; - port = other.port; - } }; -/** 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) */ -typedef std::vector ClassVector; +typedef std::vector ClassVector; /** Typedef for the list of user-channel records for a user */ @@ -474,15 +457,28 @@ class CoreExport User : public connection */ void DecrementModes(); - /** Oper-only quit message for this user if non-null - */ - char* operquit; - /** Max channels for this user */ unsigned int MaxChans; + std::map* AllowedOperCommands; + + /** Allowed user modes from oper classes. */ + bool* AllowedUserModes; + + /** Allowed channel modes from oper classes. */ + bool* AllowedChanModes; + public: + /** Module responsible for raw i/o + */ + Module* io; + + /** 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 @@ -566,11 +562,10 @@ class CoreExport User : public connection */ 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 + /** Time the user last went away. + * This is ONLY RELIABLE if user IS_AWAY()! */ - int flood; + time_t awaytime; /** Timestamp of current time + connection class timeout. * This user must send USER/NICK before this timestamp is @@ -591,10 +586,6 @@ class CoreExport User : public connection */ bool dns_done; - /** Number of seconds between PINGs for this user (set from <connect:allow> tag - */ - unsigned int pingmax; - /** 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. @@ -612,30 +603,41 @@ class CoreExport User : public connection */ std::string sendq; + /** Message user will quit with. Not to be set externally. + */ + std::string quitmsg; + + /** Quit message shown to opers - not to be set externally. + */ + std::string operquitmsg; + + /** Whether or not to send an snotice about this user's quitting + */ + bool quietquit; + /** Flood counters - lines received */ - int lines_in; + unsigned int lines_in; /** Flood counters - time lines_in is due to be reset */ time_t reset_due; - /** Flood counters - Highest value lines_in may reach before the user gets disconnected - */ - long threshold; - - /** 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. */ sockaddr* ip; + + /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo. + */ + std::string cachedip; /** Initialize the clients sockaddr * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6 @@ -657,36 +659,28 @@ class CoreExport User : public connection /** Get IP string from sockaddr, using static internal buffer * @return The IP string */ - const char* GetIPString(); + const char* GetIPString(bool translate4in6 = true); /* Write error string */ std::string WriteError; - /** Maximum size this user's sendq can become. - * Copied from the connect class on connect. + /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. */ - long sendqmax; + bool exempt; - /** Maximum size this user's recvq can become. - * Copied from the connect class on connect. + /** 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. */ - long recvqmax; + int Penalty; - /** 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). + /** True if we are flushing penalty lines */ - bool exempt; + bool OverPenalty; - /** If this bool is set for a user, then the user is under penalty, in short they - * are waiting for some held commands to be executed. If this is the case, then - * any commands they have in their sendq are executed on a timer tick rather than in - * their event handler. + /** If this bool is set then penalty rules do not apply to this user */ - bool UnderPenalty; + bool ExemptFromPenalty; /** Default constructor * @throw CoreException if the UID allocated to the user already exists @@ -695,6 +689,10 @@ class CoreExport User : public connection */ User(InspIRCd* Instance, const std::string &uid = ""); + /** Check if the user matches a G or K line, and disconnect them if they do + */ + void CheckLines(); + /** 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. @@ -765,8 +763,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 @@ -783,6 +782,15 @@ class CoreExport User : public connection */ bool HasPermission(const std::string &command); + /** 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); + /** 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 @@ -880,14 +888,6 @@ class CoreExport User : public connection */ 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 = ""); - /** Add the user to WHOWAS system */ void AddToWhoWas(); @@ -896,11 +896,11 @@ class CoreExport User : public connection * This will also give the +o usermode. * @param opertype The oper type to oper as */ - void Oper(const std::string &opertype); + 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(const std::string &explicit_class = ""); + void CheckClass(); /** Use this method to fully connect a user. * This will send the message of the day, check G/K/E lines, etc. @@ -924,39 +924,11 @@ 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 */ @@ -966,7 +938,7 @@ class CoreExport User : public connection * @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 @@ -977,7 +949,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 @@ -990,7 +966,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 @@ -1003,7 +979,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 @@ -1014,13 +990,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 @@ -1039,7 +1015,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. @@ -1089,7 +1065,7 @@ 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 @@ -1110,11 +1086,16 @@ class CoreExport User : public connection */ void PurgeEmptyChannels(); - /** Get the connect class which matches this user's host or IP address - * @param explicit_name Set this string to tie the user to a specific class name - * @return A reference to this user's connect class + /** Get the connect class which this user belongs to. + * @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* GetClass(const std::string &explicit_name = ""); + ConnectClass *SetClass(const std::string &explicit_name = ""); /** Show the message of the day to this user */ @@ -1134,6 +1115,14 @@ class CoreExport User : public connection */ const char* GetOperQuit(); + /** Increases a user's command penalty by a set amount. + */ + void IncreasePenalty(int increase); + + /** Decreases a user's command penalty by a set amount. + */ + void DecreasePenalty(int decrease); + /** Handle socket event. * From EventHandler class. * @param et Event type @@ -1146,8 +1135,47 @@ class CoreExport User : public connection virtual ~User(); }; +/** 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); +}; + /* Configuration callbacks */ -class ServerConfig; +//class ServerConfig; #endif