-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __USERS_H__\r#define __USERS_H__\r\r#include <string>\r#include "inspircd_config.h"\r#include "socket.h"\r#include "channels.h"\r#include "inspstring.h"\r#include "connection.h"\r#include "hashcomp.h"\r#include "dns.h"\r\r/** Channel status for a user\r */\renum ChanStatus {\r /** Op */\r STATUS_OP = 4,\r /** Halfop */\r STATUS_HOP = 2,\r /** Voice */\r STATUS_VOICE = 1,\r /** None */\r STATUS_NORMAL = 0\r};\r\r/** connect class types\r */\renum ClassTypes {\r /** connect:allow */\r CC_ALLOW = 0,\r /** connect:deny */\r CC_DENY = 1\r};\r\r/** RFC1459 channel modes\r */\renum UserModes {\r /** +s: Server notices */\r UM_SERVERNOTICE = 's' - 65,\r /** +w: WALLOPS */\r UM_WALLOPS = 'w' - 65,\r /** +i: Invisible */\r UM_INVISIBLE = 'i' - 65,\r /** +o: Operator */\r UM_OPERATOR = 'o' - 65,\r /** +n: Server notice mask */\r UM_SNOMASK = 'n' - 65\r};\r\r/** Registration state of a user, e.g.\r * have they sent USER, NICK, PASS yet?\r */\renum RegistrationState {\r\r#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.\r REG_NONE = 0, /* Has sent nothing */\r#endif\r\r REG_USER = 1, /* Has sent USER */\r REG_NICK = 2, /* Has sent NICK */\r REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */\r REG_ALL = 7 /* REG_NICKUSER plus next bit along */\r};\r\r/* Required forward declaration */\rclass InspIRCd;\r\r/** Derived from Resolver, and performs user forward/reverse lookups.\r */\rclass CoreExport UserResolver : public Resolver\r{\r private:\r /** User this class is 'attached' to.\r */\r userrec* bound_user;\r /** File descriptor teh lookup is bound to\r */\r int bound_fd;\r /** True if the lookup is forward, false if is a reverse lookup\r */\r bool fwd;\r public:\r /** Create a resolver.\r * @param Instance The creating instance\r * @param user The user to begin lookup on\r * @param to_resolve The IP or host to resolve\r * @param qt The query type\r * @param cache Modified by the constructor if the result was cached\r */\r UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);\r\r /** Called on successful lookup\r * @param result Result string\r * @param ttl Time to live for result\r * @param cached True if the result was found in the cache\r */\r void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);\r\r /** Called on failed lookup\r * @param e Error code\r * @param errormessage Error message string\r */\r void OnError(ResolverError e, const std::string &errormessage);\r};\r\r\r/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.\r */\rclass CoreExport ConnectClass : public classbase\r{\r private:\r /** Type of line, either CC_ALLOW or CC_DENY\r */\r char type;\r /** Max time to register the connection in seconds\r */\r unsigned int registration_timeout;\r /** Number of lines in buffer before excess flood is triggered\r */\r unsigned int flood;\r /** Host mask for this line\r */\r std::string host;\r /** Number of seconds between pings for this line\r */\r unsigned int pingtime;\r /** (Optional) Password for this line\r */\r std::string pass;\r\r /** Threshold value for flood disconnect\r */\r unsigned int threshold;\r\r /** Maximum size of sendq for users in this class (bytes)\r */\r unsigned long sendqmax;\r\r /** Maximum size of recvq for users in this class (bytes)\r */\r unsigned long recvqmax;\r\r /** Local max when connecting by this connection class\r */\r unsigned long maxlocal;\r\r /** Global max when connecting by this connection class\r */\r unsigned long maxglobal;\r /** Port number this connect class applies to\r */\r int port;\r\rpublic:\r\r /** Create a new connect class with no settings.\r */\r ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),\r threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }\r\r /** Create a new connect class to ALLOW connections.\r * @param timeout The registration timeout\r * @param fld The flood value\r * @param hst The IP mask to allow\r * @param ping The ping frequency\r * @param pas The password to be used\r * @param thres The flooding threshold\r * @param sendq The maximum sendq value\r * @param recvq The maximum recvq value\r * @param maxl The maximum local sessions\r * @param maxg The maximum global sessions\r */\r ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,\r const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,\r unsigned long maxl, unsigned long maxg, int p = 0) :\r type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),\r threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }\r\r /** Create a new connect class to DENY connections\r * @param hst The IP mask to deny\r */\r ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),\r pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }\r\r /** Returns the type, CC_ALLOW or CC_DENY\r */\r char GetType()\r {\r return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);\r }\r\r /** Returns the registration timeout\r */\r unsigned int GetRegTimeout()\r {\r return (registration_timeout ? registration_timeout : 90);\r }\r\r /** Returns the flood limit\r */\r unsigned int GetFlood()\r {\r return (threshold ? flood : 999);\r }\r\r /** Returns the allowed or denied IP mask\r */\r const std::string& GetHost()\r {\r return host;\r }\r\r int GetPort()\r {\r return port;\r }\r\r /** Returns the ping frequency\r */\r unsigned int GetPingTime()\r {\r return (pingtime ? pingtime : 120);\r }\r\r /** Returns the password or an empty string\r */\r const std::string& GetPass()\r {\r return pass;\r }\r\r /** Returns the flood threshold value\r */\r unsigned int GetThreshold()\r {\r return (threshold ? threshold : 1);\r }\r\r /** Returns the maximum sendq value\r */\r unsigned long GetSendqMax()\r {\r return (sendqmax ? sendqmax : 262114);\r }\r\r /** Returns the maximum recvq value\r */\r unsigned long GetRecvqMax()\r {\r return (recvqmax ? recvqmax : 4096);\r }\r\r /** Returusn the maximum number of local sessions\r */\r unsigned long GetMaxLocal()\r {\r return maxlocal;\r }\r\r /** Returns the maximum number of global sessions\r */\r unsigned long GetMaxGlobal()\r {\r return maxglobal;\r }\r};\r\r/** Holds a complete list of all channels to which a user has been invited and has not yet joined.\r */\rtypedef std::vector<irc::string> InvitedList;\r\r/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)\r */\rtypedef std::vector<ConnectClass> ClassVector;\r\r/** Typedef for the list of user-channel records for a user\r */\rtypedef std::map<chanrec*, char> UserChanList;\r\r/** Shorthand for an iterator into a UserChanList\r */\rtypedef UserChanList::iterator UCListIter;\r\r/* Required forward declaration\r */\rclass userrec;\r\r/** Visibility data for a user.\r * If a user has a non-null instance of this class in their userrec,\r * then it is used to determine if this user is visible to other users\r * or not.\r */\rclass CoreExport VisData\r{\r public:\r /** Create a visdata\r */\r VisData();\r /** Destroy a visdata\r */\r virtual ~VisData();\r /** Is this user visible to some other user?\r * @param user The other user to compare to\r * @return true True if the user is visible to the other user, false if not\r */\r virtual bool VisibleTo(userrec* user);\r};\r\r/** Holds all information about a user\r * This class stores all information about a user connected to the irc server. Everything about a\r * connection is stored here primarily, from the user's socket ID (file descriptor) through to the\r * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user\r * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their\r * file descriptor value.\r */\rclass CoreExport userrec : public connection\r{\r private:\r /** Pointer to creator.\r * This is required to make use of core functions\r * from within the userrec class.\r */\r InspIRCd* ServerInstance;\r\r /** A list of channels the user has a pending invite to.\r * Upon INVITE channels are added, and upon JOIN, the\r * channels are removed from this list.\r */\r InvitedList invites;\r\r /** Number of channels this user is currently on\r */\r unsigned int ChannelCount;\r\r /** Cached nick!ident@host value using the real hostname\r */\r char* cached_fullhost;\r\r /** Cached nick!ident@ip value using the real IP address\r */\r char* cached_hostip;\r\r /** Cached nick!ident@host value using the masked hostname\r */\r char* cached_makehost;\r\r /** Cached nick!ident@realhost value using the real hostname\r */\r char* cached_fullrealhost;\r\r /** When we erase the user (in the destructor),\r * we call this method to subtract one from all\r * mode characters this user is making use of.\r */\r void DecrementModes();\r\r /** Oper-only quit message for this user if non-null\r */\r char* operquit;\r\r public:\r /** Resolvers for looking up this users IP address\r * This will occur if and when res_reverse completes.\r * When this class completes its lookup, userrec::dns_done\r * will be set from false to true.\r */\r UserResolver* res_forward;\r\r /** Resolvers for looking up this users hostname\r * This is instantiated by userrec::StartDNSLookup(),\r * and on success, instantiates userrec::res_reverse.\r */\r UserResolver* res_reverse;\r\r /** User visibility state, see definition of VisData.\r */\r VisData* Visibility;\r\r /** Stored reverse lookup from res_forward\r */\r std::string stored_host;\r\r /** Starts a DNS lookup of the user's IP.\r * This will cause two UserResolver classes to be instantiated.\r * When complete, these objects set userrec::dns_done to true.\r */\r void StartDNSLookup();\r\r /** The users nickname.\r * An invalid nickname indicates an unregistered connection prior to the NICK command.\r * Use InspIRCd::IsNick() to validate nicknames.\r */\r char nick[NICKMAX];\r\r /** The users ident reply.\r * Two characters are added to the user-defined limit to compensate for the tilde etc.\r */\r char ident[IDENTMAX+2];\r\r /** The host displayed to non-opers (used for cloaking etc).\r * This usually matches the value of userrec::host.\r */\r char dhost[65];\r\r /** The users full name (GECOS).\r */\r char fullname[MAXGECOS+1];\r\r /** The user's mode list.\r * This is NOT a null terminated string! In the 1.1 version of InspIRCd\r * this is an array of values in a similar way to channel modes.\r * A value of 1 in field (modeletter-65) indicates that the mode is\r * set, for example, to work out if mode +s is set, we check the field\r * userrec::modes['s'-65] != 0.\r * The following RFC characters o, w, s, i have constants defined via an\r * enum, such as UM_SERVERNOTICE and UM_OPETATOR.\r */\r char modes[64];\r\r /** What snomasks are set on this user.\r * This functions the same as the above modes.\r */\r char snomasks[64];\r\r /** Channels this user is on, and the permissions they have there\r */\r UserChanList chans;\r\r /** The server the user is connected to.\r */\r const char* server;\r\r /** The user's away message.\r * If this string is empty, the user is not marked as away.\r */\r char awaymsg[MAXAWAY+1];\r\r /** Number of lines the user can place into the buffer\r * (up to the global NetBufferSize bytes) before they\r * are disconnected for excess flood\r */\r int flood;\r\r /** Timestamp of current time + connection class timeout.\r * This user must send USER/NICK before this timestamp is\r * reached or they will be disconnected.\r */\r time_t timeout;\r\r /** The oper type they logged in as, if they are an oper.\r * This is used to check permissions in operclasses, so that\r * we can say 'yay' or 'nay' to any commands they issue.\r * The value of this is the value of a valid 'type name=' tag.\r */\r char oper[NICKMAX];\r\r /** True when DNS lookups are completed.\r * The UserResolver classes res_forward and res_reverse will\r * set this value once they complete.\r */\r bool dns_done;\r\r /** Number of seconds between PINGs for this user (set from <connect:allow> tag\r */\r unsigned int pingmax;\r\r /** Password specified by the user when they registered.\r * This is stored even if the <connect> block doesnt need a password, so that\r * modules may check it.\r */\r char password[64];\r\r /** User's receive queue.\r * Lines from the IRCd awaiting processing are stored here.\r * Upgraded april 2005, old system a bit hairy.\r */\r std::string recvq;\r\r /** User's send queue.\r * Lines waiting to be sent are stored here until their buffer is flushed.\r */\r std::string sendq;\r\r /** Flood counters - lines received\r */\r int lines_in;\r\r /** Flood counters - time lines_in is due to be reset\r */\r time_t reset_due;\r\r /** Flood counters - Highest value lines_in may reach before the user gets disconnected\r */\r long threshold;\r\r /** If this is set to true, then all read operations for the user\r * are dropped into the bit-bucket.\r * This is used by the global CullList, but please note that setting this value\r * alone will NOT cause the user to quit. This means it can be used seperately,\r * for example by shun modules etc.\r */\r bool muted;\r\r /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/\r * GetIPString/GetPort to obtain its values.\r */\r sockaddr* ip;\r\r /** Initialize the clients sockaddr\r * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6\r * @param ip A human-readable IP address for this user matching the protcol_family\r * @param port The port number of this user or zero for a remote user\r */\r void SetSockAddr(int protocol_family, const char* ip, int port);\r\r /** Get port number from sockaddr\r * @return The port number of this user.\r */\r int GetPort();\r\r /** Get protocol family from sockaddr\r * @return The protocol family of this user, either AF_INET or AF_INET6\r */\r int GetProtocolFamily();\r\r /** Get IP string from sockaddr, using static internal buffer\r * @return The IP string\r */\r const char* GetIPString();\r\r /** Get IP string from sockaddr, using caller-specified buffer\r * @param buf A buffer to use\r * @return The IP string\r */\r const char* GetIPString(char* buf);\r\r /* Write error string\r */\r std::string WriteError;\r\r /** Maximum size this user's sendq can become.\r * Copied from the connect class on connect.\r */\r long sendqmax;\r\r /** Maximum size this user's recvq can become.\r * Copied from the connect class on connect.\r */\r long recvqmax;\r\r /** This is true if the user matched an exception when they connected to the ircd.\r * It isnt valid after this point, and you should not attempt to do anything with it\r * after this point, because the eline might be removed at a later time, and/or no\r * longer be applicable to this user. It is only used to save doing the eline lookup\r * twice (instead we do it once and set this value).\r */\r bool exempt;\r\r /** Default constructor\r * @throw Nothing at present\r */\r userrec(InspIRCd* Instance);\r\r /** Returns the full displayed host of the user\r * This member function returns the hostname of the user as seen by other users\r * on the server, in nick!ident&at;host form.\r * @return The full masked host of the user\r */\r virtual char* GetFullHost();\r\r /** Returns the full real host of the user\r * This member function returns the hostname of the user as seen by other users\r * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,\r * e.g. through a module, then this method will ignore it and return the true hostname.\r * @return The full real host of the user\r */\r virtual char* GetFullRealHost();\r\r /** This clears any cached results that are used for GetFullRealHost() etc.\r * The results of these calls are cached as generating them can be generally expensive.\r */\r void InvalidateCache();\r\r /** Create a displayable mode string for this users snomasks\r * @return The notice mask character sequence\r */\r const char* FormatNoticeMasks();\r\r /** Process a snomask modifier string, e.g. +abc-de\r * @param sm A sequence of notice mask characters\r * @return The cleaned mode sequence which can be output,\r * e.g. in the above example if masks c and e are not\r * valid, this function will return +ab-d\r */\r std::string ProcessNoticeMasks(const char *sm);\r\r /** Returns true if a notice mask is set\r * @param sm A notice mask character to check\r * @return True if the notice mask is set\r */\r bool IsNoticeMaskSet(unsigned char sm);\r\r /** Changed a specific notice mask value\r * @param sm The server notice mask to change\r * @param value An on/off value for this mask\r */\r void SetNoticeMask(unsigned char sm, bool value);\r\r /** Create a displayable mode string for this users umodes\r * @param The mode string\r */\r const char* FormatModes();\r\r /** Returns true if a specific mode is set\r * @param m The user mode\r * @return True if the mode is set\r */\r bool IsModeSet(unsigned char m);\r\r /** Set a specific usermode to on or off\r * @param m The user mode\r * @param value On or off setting of the mode\r */\r void SetMode(unsigned char m, bool value);\r\r /** Returns true if a user is invited to a channel.\r * @param channel A channel name to look up\r * @return True if the user is invited to the given channel\r */\r virtual bool IsInvited(const irc::string &channel);\r\r /** Adds a channel to a users invite list (invites them to a channel)\r * @param channel A channel name to add\r */\r virtual void InviteTo(const irc::string &channel);\r\r /** Removes a channel from a users invite list.\r * This member function is called on successfully joining an invite only channel\r * to which the user has previously been invited, to clear the invitation.\r * @param channel The channel to remove the invite to\r */\r virtual void RemoveInvite(const irc::string &channel);\r\r /** Returns true or false for if a user can execute a privilaged oper command.\r * This is done by looking up their oper type from userrec::oper, then referencing\r * this to their oper classes and checking the commands they can execute.\r * @param command A command (should be all CAPS)\r * @return True if this user can execute the command\r */\r bool HasPermission(const std::string &command);\r\r /** Calls read() to read some data for this user using their fd.\r * @param buffer The buffer to read into\r * @param size The size of data to read\r * @return The number of bytes read, or -1 if an error occured.\r */\r int ReadData(void* buffer, size_t size);\r\r /** This method adds data to the read buffer of the user.\r * The buffer can grow to any size within limits of the available memory,\r * managed by the size of a std::string, however if any individual line in\r * the buffer grows over 600 bytes in length (which is 88 chars over the\r * RFC-specified limit per line) then the method will return false and the\r * text will not be inserted.\r * @param a The string to add to the users read buffer\r * @return True if the string was successfully added to the read buffer\r */\r bool AddBuffer(std::string a);\r\r /** This method returns true if the buffer contains at least one carriage return\r * character (e.g. one complete line may be read)\r * @return True if there is at least one complete line in the users buffer\r */\r bool BufferIsReady();\r\r /** This function clears the entire buffer by setting it to an empty string.\r */\r void ClearBuffer();\r\r /** This method returns the first available string at the tail end of the buffer\r * and advances the tail end of the buffer past the string. This means it is\r * a one way operation in a similar way to strtok(), and multiple calls return\r * multiple lines if they are available. The results of this function if there\r * are no lines to be read are unknown, always use BufferIsReady() to check if\r * it is ok to read the buffer before calling GetBuffer().\r * @return The string at the tail end of this users buffer\r */\r std::string GetBuffer();\r\r /** Sets the write error for a connection. This is done because the actual disconnect\r * of a client may occur at an inopportune time such as half way through /LIST output.\r * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and\r * errored clients purged.\r * @param error The error string to set.\r */\r void SetWriteError(const std::string &error);\r\r /** Returns the write error which last occured on this connection or an empty string\r * if none occured.\r * @return The error string which has occured for this user\r */\r const char* GetWriteError();\r\r /** Adds to the user's write buffer.\r * You may add any amount of text up to this users sendq value, if you exceed the\r * sendq value, SetWriteError() will be called to set the users error string to\r * "SendQ exceeded", and further buffer adds will be dropped.\r * @param data The data to add to the write buffer\r */\r void AddWriteBuf(const std::string &data);\r\r /** Flushes as much of the user's buffer to the file descriptor as possible.\r * This function may not always flush the entire buffer, rather instead as much of it\r * as it possibly can. If the send() call fails to send the entire buffer, the buffer\r * position is advanced forwards and the rest of the data sent at the next call to\r * this method.\r */\r void FlushWriteBuf();\r\r /** Returns the list of channels this user has been invited to but has not yet joined.\r * @return A list of channels the user is invited to\r */\r InvitedList* GetInviteList();\r\r /** Creates a wildcard host.\r * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname\r * @return The wildcarded hostname in *!*@host form\r */\r char* MakeWildHost();\r\r /** Creates a usermask with real host.\r * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host\r * @return the usermask in the format user@host\r */\r char* MakeHost();\r\r /** Creates a usermask with real ip.\r * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip\r * @return the usermask in the format user@ip\r */\r char* MakeHostIP();\r\r /** Shuts down and closes the user's socket\r * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,\r * which will call CloseSocket() for you.\r */\r void CloseSocket();\r\r /** Disconnect a user gracefully\r * @param user The user to remove\r * @param r The quit reason to show to normal users\r * @param oreason The quit reason to show to opers\r * @return Although this function has no return type, on exit the user provided will no longer exist.\r */\r static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");\r\r /** Add the user to WHOWAS system\r */\r void AddToWhoWas();\r\r /** Oper up the user using the given opertype.\r * This will also give the +o usermode.\r * @param opertype The oper type to oper as\r */\r void Oper(const std::string &opertype);\r\r /** Call this method to find the matching <connect> for a user, and to check them against it.\r */\r void CheckClass();\r\r /** Use this method to fully connect a user.\r * This will send the message of the day, check G/K/E lines, etc.\r */\r void FullConnect();\r\r /** Change this users hash key to a new string.\r * You should not call this function directly. It is used by the core\r * to update the users hash entry on a nickchange.\r * @param New new user_hash key\r * @return Pointer to userrec in hash (usually 'this')\r */\r userrec* UpdateNickHash(const char* New);\r\r /** Force a nickname change.\r * If the nickname change fails (for example, because the nick in question\r * already exists) this function will return false, and you must then either\r * output an error message, or quit the user for nickname collision.\r * @param newnick The nickname to change to\r * @return True if the nickchange was successful.\r */\r bool ForceNickChange(const char* newnick);\r\r /** Add a client to the system.\r * This will create a new userrec, insert it into the user_hash,\r * initialize it as not yet registered, and add it to the socket engine.\r * @param Instance a pointer to the server instance\r * @param socket The socket id (file descriptor) this user is on\r * @param port The port number this user connected on\r * @param iscached This variable is reserved for future use\r * @param ip The IP address of the user\r * @return This function has no return value, but a call to AddClient may remove the user.\r */\r static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);\r\r /** Oper down.\r * This will clear the +o usermode and unset the user's oper type\r */\r void UnOper();\r\r /** Return the number of global clones of this user\r * @return The global clone count of this user\r */\r unsigned long GlobalCloneCount();\r\r /** Return the number of local clones of this user\r * @return The local clone count of this user\r */\r unsigned long LocalCloneCount();\r\r /** Remove all clone counts from the user, you should\r * use this if you change the user's IP address in\r * userrec::ip after they have registered.\r */\r void RemoveCloneCounts();\r\r /** Write text to this user, appending CR/LF.\r * @param text A std::string to send to the user\r */\r void Write(std::string text);\r\r /** Write text to this user, appending CR/LF.\r * @param text The format string for text to send to the user\r * @param ... POD-type format arguments\r */\r void Write(const char *text, ...);\r\r /** Write text to this user, appending CR/LF and prepending :server.name\r * @param text A std::string to send to the user\r */\r void WriteServ(const std::string& text);\r\r /** Write text to this user, appending CR/LF and prepending :server.name\r * @param text The format string for text to send to the user\r * @param ... POD-type format arguments\r */\r void WriteServ(const char* text, ...);\r\r /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.\r * @param user The user to prepend the :nick!user@host of\r * @param text A std::string to send to the user\r */\r void WriteFrom(userrec *user, const std::string &text);\r\r /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.\r * @param user The user to prepend the :nick!user@host of\r * @param text The format string for text to send to the user\r * @param ... POD-type format arguments\r */\r void WriteFrom(userrec *user, const char* text, ...);\r\r /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.\r * @param dest The user to route the message to\r * @param text A std::string to send to the user\r */\r void WriteTo(userrec *dest, const std::string &data);\r\r /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.\r * @param dest The user to route the message to\r * @param text The format string for text to send to the user\r * @param ... POD-type format arguments\r */\r void WriteTo(userrec *dest, const char *data, ...);\r\r /** Write to all users that can see this user (including this user in the list), appending CR/LF\r * @param text A std::string to send to the users\r */\r void WriteCommon(const std::string &text);\r\r /** Write to all users that can see this user (including this user in the list), appending CR/LF\r * @param text The format string for text to send to the users\r * @param ... POD-type format arguments\r */\r void WriteCommon(const char* text, ...);\r\r /** Write to all users that can see this user (not including this user in the list), appending CR/LF\r * @param text The format string for text to send to the users\r * @param ... POD-type format arguments\r */\r void WriteCommonExcept(const char* text, ...);\r\r /** Write to all users that can see this user (not including this user in the list), appending CR/LF\r * @param text A std::string to send to the users\r */\r void WriteCommonExcept(const std::string &text);\r\r /** Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific\r * quit message for opers only.\r * @param normal_text Normal user quit message\r * @param oper_text Oper only quit message\r */\r void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);\r\r /** Write a WALLOPS message from this user to all local opers.\r * If this user is not opered, the function will return without doing anything.\r * @param text The format string to send in the WALLOPS message\r * @param ... Format arguments\r */\r void WriteWallOps(const char* text, ...);\r\r /** Write a WALLOPS message from this user to all local opers.\r * If this user is not opered, the function will return without doing anything.\r * @param text The text to send in the WALLOPS message\r */\r void WriteWallOps(const std::string &text);\r\r /** Return true if the user shares at least one channel with another user\r * @param other The other user to compare the channel list against\r * @return True if the given user shares at least one channel with this user\r */\r bool SharesChannelWith(userrec *other);\r\r /** Change the displayed host of a user.\r * ALWAYS use this function, rather than writing userrec::dhost directly,\r * as this triggers module events allowing the change to be syncronized to\r * remote servers. This will also emulate a QUIT and rejoin (where configured)\r * before setting their host field.\r * @param host The new hostname to set\r * @return True if the change succeeded, false if it didn't\r */\r bool ChangeDisplayedHost(const char* host);\r\r /** Change the ident (username) of a user.\r * ALWAYS use this function, rather than writing userrec::ident directly,\r * as this correctly causes the user to seem to quit (where configured)\r * before setting their ident field.\r * @param host The new ident to set\r * @return True if the change succeeded, false if it didn't\r */\r bool ChangeIdent(const char* newident);\r\r /** Change a users realname field.\r * ALWAYS use this function, rather than writing userrec::fullname directly,\r * as this triggers module events allowing the change to be syncronized to\r * remote servers.\r * @param gecos The user's new realname\r * @return True if the change succeeded, false if otherwise\r */\r bool ChangeName(const char* gecos);\r\r /** Send a command to all local users from this user\r * The command given must be able to send text with the\r * first parameter as a servermask (e.g. $*), so basically\r * you should use PRIVMSG or NOTICE.\r * @param command the command to send\r * @param text The text format string to send\r * @param ... Format arguments\r */\r void SendAll(const char* command, char* text, ...);\r\r /** Compile a channel list for this user, and send it to the user 'source'\r * Used internally by WHOIS\r * @param The user to send the channel list to if it is not too long\r * @return This user's channel list\r */\r std::string ChannelList(userrec* source);\r\r /** Split the channel list in cl which came from dest, and spool it to this user\r * Used internally by WHOIS\r * @param dest The user the original channel list came from\r * @param cl The channel list as a string obtained from userrec::ChannelList()\r */\r void SplitChanList(userrec* dest, const std::string &cl);\r\r /** Remove this user from all channels they are on, and delete any that are now empty.\r * This is used by QUIT, and will not send part messages!\r */\r void PurgeEmptyChannels();\r\r /** Get the connect class which matches this user's host or IP address\r * @return A reference to this user's connect class\r */\r ConnectClass* GetClass();\r\r /** Show the message of the day to this user\r */\r void ShowMOTD();\r\r /** Show the server RULES file to this user\r */\r void ShowRULES();\r\r /** Set oper-specific quit message shown to opers only when the user quits\r * (overrides any sent by QuitUser)\r */\r void SetOperQuit(const std::string &oquit);\r\r /** Get oper-specific quit message shown only to opers when the user quits.\r * (overrides any sent by QuitUser)\r */\r const char* GetOperQuit();\r\r /** Handle socket event.\r * From EventHandler class.\r * @param et Event type\r * @param errornum Error number for EVENT_ERROR events\r */\r void HandleEvent(EventType et, int errornum = 0);\r\r /** Default destructor\r */\r virtual ~userrec();\r};\r\r/* Configuration callbacks */\rclass ServerConfig;\r\r#endif\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Burlex <???@???>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
+
+#include "socket.h"
+#include "inspsocket.h"
+#include "mode.h"
+#include "membership.h"
+
+/** connect class types
+ */
+enum ClassTypes {
+ /** connect:allow */
+ CC_ALLOW = 0,
+ /** connect:deny */
+ CC_DENY = 1,
+ /** named connect block (for opers, etc) */
+ CC_NAMED = 2
+};
+
+/** 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 */
+};
+
+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 refcountbase
+{
+ reference<ConfigTag> config;
+ /** Type of line, either CC_ALLOW or CC_DENY
+ */
+ char type;
+
+ /** True if this class uses fake lag to manage flood, false if it kills */
+ bool fakelag;
+
+ /** Connect class name
+ */
+ std::string name;
+
+ /** Max time to register the connection in seconds
+ */
+ unsigned int registration_timeout;
+
+ /** Host mask for this line
+ */
+ std::string host;
+
+ /** Number of seconds between pings for this line
+ */
+ unsigned int pingtime;
+
+ /** Maximum size of sendq for users in this class (bytes)
+ * Users cannot send commands if they go over this limit
+ */
+ unsigned long softsendqmax;
+
+ /** Maximum size of sendq for users in this class (bytes)
+ * Users are killed if they go over this limit
+ */
+ unsigned long hardsendqmax;
+
+ /** Maximum size of recvq for users in this class (bytes)
+ */
+ unsigned long recvqmax;
+
+ /** Seconds worth of penalty before penalty system activates
+ */
+ unsigned int penaltythreshold;
+
+ /** Maximum rate of commands (units: millicommands per second) */
+ unsigned int commandrate;
+
+ /** Local max when connecting by this connection class
+ */
+ unsigned long maxlocal;
+
+ /** Global max when connecting by this connection class
+ */
+ unsigned long maxglobal;
+
+ /** True if max connections for this class is hit and a warning is wanted
+ */
+ bool maxconnwarn;
+
+ /** Max channels for this class
+ */
+ unsigned int maxchans;
+
+ /** How many users may be in this connect class before they are refused?
+ * (0 = no limit = default)
+ */
+ unsigned long limit;
+
+ /** If set to true, no user DNS lookups are to be performed
+ */
+ bool resolvehostnames;
+
+ /** Create a new connect class with no settings.
+ */
+ ConnectClass(ConfigTag* tag, char type, const std::string& mask);
+ /** Create a new connect class with inherited settings.
+ */
+ 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);
+
+ const std::string& GetName() { return name; }
+ const std::string& GetHost() { return host; }
+
+ /** Returns the registration timeout
+ */
+ time_t GetRegTimeout()
+ {
+ return (registration_timeout ? registration_timeout : 90);
+ }
+
+ /** Returns the ping frequency
+ */
+ unsigned int GetPingTime()
+ {
+ return (pingtime ? pingtime : 120);
+ }
+
+ /** Returns the maximum sendq value (soft limit)
+ * Note that this is in addition to internal OS buffers
+ */
+ unsigned long GetSendqSoftMax()
+ {
+ return (softsendqmax ? softsendqmax : 4096);
+ }
+
+ /** Returns the maximum sendq value (hard limit)
+ */
+ unsigned long GetSendqHardMax()
+ {
+ return (hardsendqmax ? hardsendqmax : 0x100000);
+ }
+
+ /** Returns the maximum recvq value
+ */
+ unsigned long GetRecvqMax()
+ {
+ return (recvqmax ? recvqmax : 4096);
+ }
+
+ /** Returns the penalty threshold value
+ */
+ unsigned int GetPenaltyThreshold()
+ {
+ return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
+ }
+
+ unsigned int GetCommandRate()
+ {
+ return commandrate ? commandrate : 1000;
+ }
+
+ /** Return the maximum number of local sessions
+ */
+ unsigned long GetMaxLocal()
+ {
+ return maxlocal;
+ }
+
+ /** Returns the maximum number of global sessions
+ */
+ unsigned long GetMaxGlobal()
+ {
+ return maxglobal;
+ }
+};
+
+/** 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.
+ */
+class CoreExport User : public Extensible
+{
+ private:
+ /** Cached nick!ident@dhost value using the displayed hostname
+ */
+ std::string cached_fullhost;
+
+ /** Cached ident@ip value using the real IP address
+ */
+ std::string cached_hostip;
+
+ /** Cached ident@realhost value using the real hostname
+ */
+ std::string cached_makehost;
+
+ /** Cached nick!ident@realhost value using the real hostname
+ */
+ std::string cached_fullrealhost;
+
+ /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
+ */
+ std::string cachedip;
+
+ /** The user's mode list.
+ * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+ * if (modes[modeid]) is set, then the mode is set.
+ * For example, to work out if mode +i is set, we check the field
+ * User::modes[invisiblemode->modeid] == true.
+ */
+ std::bitset<ModeParser::MODEID_MAX> modes;
+
+ public:
+ /** To execute a function for each local neighbor of a user, inherit from this class and
+ * pass an instance of it to User::ForEachNeighbor().
+ */
+ class ForEachNeighborHandler
+ {
+ public:
+ /** Method to execute for each local neighbor of a user.
+ * Derived classes must implement this.
+ * @param user Current neighbor
+ */
+ virtual void Execute(LocalUser* user) = 0;
+ };
+
+ /** List of Memberships for this user
+ */
+ typedef insp::intrusive_list<Membership> ChanList;
+
+ /** Hostname of connection.
+ * This should be valid as per RFC1035.
+ */
+ std::string host;
+
+ /** 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;
+
+ /** 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.
+ */
+ irc::sockets::sockaddrs client_sa;
+
+ /** The users nickname.
+ * An invalid nickname indicates an unregistered connection prior to the NICK command.
+ * Use InspIRCd::IsNick() to validate nicknames.
+ */
+ std::string nick;
+
+ /** The user's unique identifier.
+ * This is the unique identifier which the user has across the network.
+ */
+ const std::string uuid;
+
+ /** The users ident reply.
+ * Two characters are added to the user-defined limit to compensate for the tilde etc.
+ */
+ std::string ident;
+
+ /** The host displayed to non-opers (used for cloaking etc).
+ * This usually matches the value of User::host.
+ */
+ std::string dhost;
+
+ /** The users full name (GECOS).
+ */
+ std::string fullname;
+
+ /** What snomasks are set on this user.
+ * This functions the same as the above modes.
+ */
+ std::bitset<64> snomasks;
+
+ /** Channels this user is on
+ */
+ ChanList chans;
+
+ /** The server the user is connected to.
+ */
+ Server* server;
+
+ /** The user's away message.
+ * If this string is empty, the user is not marked as away.
+ */
+ std::string awaymsg;
+
+ /** Time the user last went away.
+ * This is ONLY RELIABLE if user IsAway()!
+ */
+ time_t awaytime;
+
+ /** The oper type they logged in as, if they are an oper.
+ */
+ reference<OperInfo> 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;
+
+ /** 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.
+ */
+ unsigned int quitting:1;
+
+ /** 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 std::string& GetIPString();
+
+ /** Get CIDR mask, using default range, for this user
+ */
+ irc::sockets::cidr_mask GetCIDRMask();
+
+ /** Sets the client IP for this user
+ * @return true if the conversion was successful
+ */
+ virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
+
+ virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
+
+ /** Constructor
+ * @throw CoreException if the UID allocated to the user already exists
+ */
+ User(const std::string& uid, Server* srv, int objtype);
+
+ /** 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\@host form.
+ * @return The full masked host of the user
+ */
+ 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
+ * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
+ * 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();
+
+ /** 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();
+
+ /** Returns whether this user is currently away or not. If true,
+ * further information can be found in User::awaymsg and User::awaytime
+ * @return True if the user is away, false otherwise
+ */
+ bool IsAway() const { return (!awaymsg.empty()); }
+
+ /** Returns whether this user is an oper or not. If true,
+ * oper information can be obtained from User::oper
+ * @return True if the user is an oper, false otherwise
+ */
+ bool IsOper() const { return oper; }
+
+ /** Returns true if a notice mask is set
+ * @param sm A notice mask character to check
+ * @return True if the notice mask is set
+ */
+ bool IsNoticeMaskSet(unsigned char sm);
+
+ /** Create a displayable mode string for this users umodes
+ * @param showparameters The mode string
+ */
+ const char* FormatModes(bool showparameters = false);
+
+ /** Returns true if a specific mode is set
+ * @param m The user mode
+ * @return True if the mode is set
+ */
+ bool IsModeSet(unsigned char m);
+ bool IsModeSet(ModeHandler* mh);
+ bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
+ bool IsModeSet(UserModeReference& moderef);
+
+ /** Set a specific usermode to on or off
+ * @param m The user mode
+ * @param value On or off setting of the mode
+ */
+ void SetMode(ModeHandler* mh, bool value);
+ void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
+
+ /** 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
+ */
+ 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
+ * 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.
+ */
+ 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
+ * 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.
+ */
+ virtual bool HasModePermission(unsigned char mode, ModeType type);
+
+ /** 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
+ */
+ 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
+ */
+ const std::string& MakeHostIP();
+
+ /** Oper up the user using the given opertype.
+ * This will also give the +o usermode.
+ */
+ void Oper(OperInfo* info);
+
+ /** Oper down.
+ * This will clear the +o usermode and unset the user's oper type
+ */
+ void UnOper();
+
+ /** Write text to this user, appending CR/LF. Works on local users only.
+ * @param text A std::string to send to the user
+ */
+ 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
+ */
+ 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
+ */
+ void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Sends a command to this user.
+ * @param command The command to be sent.
+ * @param text The message to send.
+ */
+ void WriteCommand(const char* command, const std::string& text);
+
+ /** Sends a server notice to this user.
+ * @param text The contents of the message to send.
+ */
+ void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
+
+ /** Send a NOTICE message from the local server to the user.
+ * @param text Text to send
+ */
+ virtual void WriteRemoteNotice(const std::string& text);
+
+ virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
+
+ template <typename T1>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4, typename T5>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ n.push(p5);
+ WriteRemoteNumeric(n);
+ }
+
+ void WriteNumeric(const Numeric::Numeric& numeric);
+
+ template <typename T1>
+ void WriteNumeric(unsigned int numeric, T1 p1)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4, typename T5>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ n.push(p5);
+ WriteNumeric(n);
+ }
+
+ /** 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
+ * @param text A std::string to send to the user
+ */
+ void WriteFrom(User *user, 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
+ * @param text The format string for text to send to the user
+ * @param ... POD-type format arguments
+ */
+ void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
+ * @param line A std::string to send to the users
+ * @param include_self Should the message be sent back to the author?
+ */
+ 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
+ * @param ... POD-type format arguments
+ */
+ void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
+ * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
+ * This function is used for example to send something conditionally to neighbors, or to send different messages
+ * to different users depending on their oper status.
+ * @param handler Function object to call, inherited from ForEachNeighborHandler.
+ * @param include_self True to include this user in the set of neighbors, false otherwise.
+ * Modules may override this. Has no effect if this user is not local.
+ */
+ void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
+
+ /** Write to the user, routing the line if the user is remote.
+ */
+ virtual void SendText(const std::string& line) = 0;
+
+ /** Write to the user, routing the line if the user is remote.
+ */
+ 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
+ * @return True if the given user shares at least one channel with this user
+ */
+ bool SharesChannelWith(User *other);
+
+ /** 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
+ * remote servers.
+ * @param host The new hostname to set
+ * @return True if the change succeeded, false if it didn't
+ * (a module vetoed the change).
+ */
+ bool ChangeDisplayedHost(const std::string& host);
+
+ /** Change the ident (username) of a user.
+ * ALWAYS use this function, rather than writing User::ident directly,
+ * as this triggers module events allowing the change to be syncronized to
+ * remote servers.
+ * @param newident The new ident to set
+ * @return True if the change succeeded, false if it didn't
+ */
+ bool ChangeIdent(const std::string& newident);
+
+ /** Change a users realname field.
+ * ALWAYS use this function, rather than writing User::fullname directly,
+ * as this triggers module events allowing the change to be syncronized to
+ * remote servers.
+ * @param gecos The user's new realname
+ * @return True if the change succeeded, false if otherwise
+ */
+ bool ChangeName(const std::string& gecos);
+
+ /** Change a user's nick
+ * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
+ * @return True if the change succeeded
+ */
+ bool ChangeNick(const std::string& newnick, time_t newts = 0);
+
+ /** Remove this user from all channels they are on, and delete any that are now empty.
+ * This is used by QUIT, and will not send part messages!
+ */
+ void PurgeEmptyChannels();
+
+ /** Default destructor
+ */
+ virtual ~User();
+ virtual CullResult cull();
+};
+
+class CoreExport UserIOHandler : public StreamSocket
+{
+ public:
+ LocalUser* const user;
+ UserIOHandler(LocalUser* me) : user(me) {}
+ void OnDataReady();
+ void OnError(BufferedSocketError error);
+
+ /** 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);
+};
+
+typedef unsigned int already_sent_t;
+
+class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
+{
+ public:
+ LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+ CullResult cull();
+
+ UserIOHandler eh;
+
+ /** Stats counter for bytes inbound
+ */
+ unsigned int bytes_in;
+
+ /** Stats counter for bytes outbound
+ */
+ unsigned int bytes_out;
+
+ /** Stats counter for commands inbound
+ */
+ unsigned int cmds_in;
+
+ /** Stats counter for commands outbound
+ */
+ unsigned int cmds_out;
+
+ /** Password specified by the user when they registered (if any).
+ * This is stored even if the \<connect> 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<ConnectClass> MyClass;
+
+ /** Get the connect class which this user belongs to.
+ * @return A pointer to this user's connect class.
+ */
+ ConnectClass* GetClass() const { return MyClass; }
+
+ /** Call this method to find the matching \<connect> for a user, and to check them against it.
+ */
+ void CheckClass(bool clone_count = true);
+
+ /** Server address and port that this user is connected to.
+ */
+ irc::sockets::sockaddrs server_sa;
+
+ /**
+ * @return The port number of this user.
+ */
+ int GetServerPort();
+
+ /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
+ * This can't be handled normally because QuitUser itself calls Write on other
+ * users, which could trigger their SendQ to overrun.
+ */
+ unsigned int quitting_sendq:1;
+
+ /** has the user responded to their previous ping?
+ */
+ unsigned int lastping:1;
+
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
+ */
+ unsigned int exempt:1;
+
+ /** Used by PING checking code
+ */
+ time_t nping;
+
+ /** Time that the connection last sent a message, used to calculate idle time
+ */
+ time_t idle_lastmsg;
+
+ /** This value contains how far into the penalty threshold the user is.
+ * This is used either to enable fake lag or for excess flood quits
+ */
+ unsigned int CommandFloodPenalty;
+
+ already_sent_t already_sent;
+
+ /** 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);
+
+ /** 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 \<connect> tags from the configuration file.
+ * @return A reference to this user's current connect class.
+ */
+ void SetClass(const std::string &explicit_name = "");
+
+ bool SetClientIP(const char* sip, bool recheck_eline = true);
+
+ void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
+
+ void SendText(const std::string& line);
+ void Write(const std::string& text);
+ void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Send a NOTICE message from the local server to the user.
+ * The message will be sent even if the user is connected to a remote server.
+ * @param text Text to send
+ */
+ void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE;
+
+ /** 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, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
+ {
+ }
+ virtual void SendText(const std::string& line);
+};
+
+class CoreExport FakeUser : public User
+{
+ public:
+ FakeUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_SERVER)
+ {
+ nick = srv->GetName();
+ }
+
+ FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
+ : User(uid, new Server(sname, sdesc), USERTYPE_SERVER)
+ {
+ nick = sname;
+ }
+
+ 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<LocalUser*>(u) : NULL;
+}
+/** Is a remote user */
+inline RemoteUser* IS_REMOTE(User* u)
+{
+ return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
+}
+/** Is a server fakeuser */
+inline FakeUser* IS_SERVER(User* u)
+{
+ return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
+}
+
+inline bool User::IsModeSet(ModeHandler* mh)
+{
+ return (modes[mh->GetId()]);
+}
+
+inline bool User::IsModeSet(UserModeReference& moderef)
+{
+ if (!moderef)
+ return false;
+ return IsModeSet(*moderef);
+}
+
+inline void User::SetMode(ModeHandler* mh, bool value)
+{
+ modes[mh->GetId()] = value;
+}
projects / user / henk / code / inspircd.git / blobdiff