* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2010 InspIRCd Development Team
* See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* ---------------------------------------------------
*/
-#ifndef __USERS_H__
-#define __USERS_H__
+#ifndef USERS_H
+#define USERS_H
#include "socket.h"
+#include "inspsocket.h"
#include "dns.h"
#include "mode.h"
-/** Channel status for a user
- */
-enum ChanStatus {
- /** Op */
- STATUS_OP = 4,
- /** Halfop */
- STATUS_HOP = 2,
- /** Voice */
- STATUS_VOICE = 1,
- /** None */
- STATUS_NORMAL = 0
-};
-
/** connect class types
*/
enum ClassTypes {
/** connect:allow */
CC_ALLOW = 0,
/** connect:deny */
- CC_DENY = 1
+ CC_DENY = 1,
+ /** named connect block (for opers, etc) */
+ CC_NAMED = 2
};
/** RFC1459 channel modes
REG_ALL = 7 /* REG_NICKUSER plus next bit along */
};
-/* Required forward declaration */
-class Channel;
-class UserResolver;
+enum UserType {
+ USERTYPE_LOCAL = 1,
+ USERTYPE_REMOTE = 2,
+ USERTYPE_SERVER = 3
+};
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class CoreExport ConnectClass : public classbase
+struct CoreExport ConnectClass : public refcountbase
{
- private:
+ 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;
*/
unsigned int pingtime;
- /** (Optional) Password for this line
- */
- std::string pass;
-
- /** (Optional) Hash Method for this line
+ /** Maximum size of sendq for users in this class (bytes)
+ * Users cannot send commands if they go over this limit
*/
- std::string hash;
+ unsigned long softsendqmax;
/** Maximum size of sendq for users in this class (bytes)
+ * Users are killed if they go over this limit
*/
- unsigned long sendqmax;
+ 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;
*/
unsigned long maxglobal;
- /** Max channels for this class
+ /** True if max connections for this class is hit and a warning is wanted
*/
- unsigned int maxchans;
+ bool maxconnwarn;
- /** Port number this connect class applies to
+ /** Max channels for this class
*/
- int port;
-
-public:
+ unsigned int maxchans;
- /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
+ /** How many users may be in this connect class before they are refused?
+ * (0 = no limit = default)
*/
- ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
- registration_timeout(source->registration_timeout), host(source->host),
- pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
- recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
- port(source->port), RefCount(0), disabled(false), limit(source->limit)
- {
- }
+ unsigned long limit;
/** Create a new connect class with no settings.
*/
- ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), host(""), pingtime(0), pass(""), hash(""),
- 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 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 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,const std::string &hst, unsigned int ping,
- const std::string &pas, const std::string &hsh, 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), host(hst), pingtime(ping), pass(pas), hash(hsh),
- 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),
- host(hst), pingtime(0), pass(""), hash(""), 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), host(source->host),
- pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
- recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
- port(source->port), RefCount(0), disabled(false), limit(source->limit)
- {
- }
-
- void SetDisabled(bool t)
- {
- this->disabled = t;
- }
-
- bool GetDisabled()
- {
- return this->disabled;
- }
-
- /* Update an existing entry with new values
- */
- void Update(unsigned int timeout, const std::string &hst, unsigned int ping,
- const std::string &pas, unsigned long sendq, unsigned long recvq,
- unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
- {
- if (timeout)
- registration_timeout = timeout;
- if (!hst.empty())
- host = hst;
- if (ping)
- pingtime = ping;
- if (!pas.empty())
- pass = pas;
- 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 = 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 <connect> is removed from the config, and there
- * are 0 users on it - it will go away in RAM. :)
+ ConnectClass(ConfigTag* tag, char type, const std::string& mask);
+ /** Create a new connect class with inherited settings.
*/
- unsigned long RefCount;
+ ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
- /** 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;
+ /** Update the settings in this block to match the given block */
+ void Update(const ConnectClass* newSettings);
- size_t GetMaxChans()
- {
- return maxchans;
- }
-
- /** Returns the type, CC_ALLOW or CC_DENY
- */
- char GetType()
- {
- return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
- }
-
- std::string& GetName()
- {
- return name;
- }
+ const std::string& GetName() { return name; }
+ const std::string& GetHost() { return host; }
/** Returns the registration timeout
*/
return (registration_timeout ? registration_timeout : 90);
}
- /** 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()
return (pingtime ? pingtime : 120);
}
- /** Returns the password or an empty string
+ /** Returns the maximum sendq value (soft limit)
+ * Note that this is in addition to internal OS buffers
*/
- const std::string& GetPass()
+ unsigned long GetSendqSoftMax()
{
- return pass;
+ return (softsendqmax ? softsendqmax : 4096);
}
- /** Returns the hash or an empty string
+ /** Returns the maximum sendq value (hard limit)
*/
- const std::string& GetHash()
+ unsigned long GetSendqHardMax()
{
- return hash;
+ return (hardsendqmax ? hardsendqmax : 0x100000);
}
- /** Returns the maximum sendq value
+ /** Returns the maximum recvq value
*/
- unsigned long GetSendqMax()
+ unsigned long GetRecvqMax()
{
- return (sendqmax ? sendqmax : 262114);
+ return (recvqmax ? recvqmax : 4096);
}
- /** Returns the maximum recvq value
+ /** Returns the penalty threshold value
*/
- unsigned long GetRecvqMax()
+ unsigned int GetPenaltyThreshold()
{
- return (recvqmax ? recvqmax : 4096);
+ return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
+ }
+
+ unsigned int GetCommandRate()
+ {
+ return commandrate ? commandrate : 1000;
}
- /** Returusn the maximum number of local sessions
+ /** Return the maximum number of local sessions
*/
unsigned long GetMaxLocal()
{
}
};
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
- */
-typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
-
-/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
- */
-typedef std::vector<ConnectClass*> ClassVector;
-
-/** Typedef for the list of user-channel records for a user
- */
-typedef std::map<Channel*, char> UserChanList;
-
-/** Shorthand for an iterator into a UserChanList
- */
-typedef UserChanList::iterator UCListIter;
-
-/* Required forward declaration
- */
-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 EventHandler
+class CoreExport User : public Extensible
{
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;
-
/** Cached nick!ident@dhost value using the displayed hostname
*/
std::string cached_fullhost;
*/
std::string cachedip;
- /** When we erase the user (in the destructor),
- * we call this method to subtract one from all
- * mode characters this user is making use of.
- */
- void DecrementModes();
-
- std::set<std::string> *AllowedOperCommands;
- std::set<std::string> *AllowedPrivs;
-
- /** Allowed user modes from oper classes. */
- std::bitset<64> AllowedUserModes;
-
- /** Allowed channel modes from oper classes. */
- std::bitset<64> AllowedChanModes;
-
public:
- /** 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;
-
- /** User visibility state, see definition of VisData.
- */
- VisData* Visibility;
/** Hostname of connection.
* This should be valid as per RFC1035.
*/
std::string host;
- /** Stats counter for bytes inbound
- */
- int bytes_in;
-
- /** Stats counter for bytes outbound
- */
- int bytes_out;
-
- /** Stats counter for commands inbound
- */
- int cmds_in;
-
- /** Stats counter for commands outbound
- */
- int cmds_out;
-
- /** True if user has authenticated, false if otherwise
- */
- bool haspassed;
-
- /** Used by User to indicate the registration status of the connection
- * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
- * the connection state.
- */
- char registered;
-
- /** Time the connection was last pinged
- */
- time_t lastping;
+ /** Time that the object was instantiated (used for TS calculation etc)
+ */
+ time_t age;
/** Time the connection was created, set in the constructor. This
* may be different from the time the user's classbase object was
*/
time_t idle_lastmsg;
- /** Used by PING checking code
- */
- time_t nping;
-
- /** Stored reverse lookup from res_forward. Should not be used after resolution.
- */
- std::string stored_host;
-
- /** Starts a DNS lookup of the user's IP.
- * This will cause two UserResolver classes to be instantiated.
- * When complete, these objects set User::dns_done to true.
+ /** Client address that the user is connected from.
+ * Do not modify this value directly, use SetClientIP() to change it.
+ * Port is not valid for remote users.
*/
- void StartDNSLookup();
+ irc::sockets::sockaddrs client_sa;
/** The users nickname.
* An invalid nickname indicates an unregistered connection prior to the NICK command.
/** The user's unique identifier.
* This is the unique identifier which the user has across the network.
*/
- std::string uuid;
+ const std::string uuid;
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
std::bitset<64> snomasks;
- /** Channels this user is on, and the permissions they have there
+ /** Channels this user is on
*/
UserChanList chans;
/** The server the user is connected to.
*/
- const char* server;
+ const std::string server;
/** The user's away message.
* If this string is empty, the user is not marked as away.
time_t awaytime;
/** The oper type they logged in as, if they are an oper.
- * This is used to check permissions in operclasses, so that
- * we can say 'yay' or 'nay' to any commands they issue.
- * The value of this is the value of a valid 'type name=' tag.
*/
- std::string oper;
+ reference<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;
/** True when DNS lookups are completed.
* The UserResolver classes res_forward and res_reverse will
* set this value once they complete.
*/
- bool dns_done;
-
- /** Password specified by the user when they registered.
- * This is stored even if the <connect> block doesnt need a password, so that
- * modules may check it.
- */
- std::string password;
-
- /** User's receive queue.
- * Lines from the IRCd awaiting processing are stored here.
- * Upgraded april 2005, old system a bit hairy.
- */
- std::string recvq;
-
- /** User's send queue.
- * Lines waiting to be sent are stored here until their buffer is flushed.
- */
- 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;
+ unsigned int dns_done:1;
/** Whether or not to send an snotice about this user's quitting
*/
- bool quietquit;
+ unsigned int quietquit:1;
/** If this is set to true, then all socket operations for the user
* are dropped into the bit-bucket.
* This value is set by QuitUser, and is not needed seperately from that call.
* Please note that setting this value alone will NOT cause the user to quit.
*/
- bool quitting;
+ unsigned int quitting:1;
- /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
- * GetIPString/GetPort to obtain its values.
+ /** 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.
*/
- sockaddr* ip;
+ unsigned int quitting_sendq:1;
- /** 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
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
- void SetSockAddr(int protocol_family, const char* ip, int port);
+ unsigned int exempt:1;
- /** Get port number from sockaddr
- * @return The port number of this user.
+ /** has the user responded to their previous ping?
*/
- int GetPort();
+ unsigned int lastping:1;
- /** Get protocol family from sockaddr
- * @return The protocol family of this user, either AF_INET or AF_INET6
- */
- int GetProtocolFamily();
+ /** What type of user is this? */
+ const unsigned int usertype:2;
- /** 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();
- /** 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)
- */
- 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.
+ /** Get CIDR mask, using default range, for this user
*/
- bool exempt;
+ irc::sockets::cidr_mask GetCIDRMask();
- /** This value contains how far into the penalty threshold the user is. Once its over
- * the penalty threshold then commands are held and processed on-timer.
+ /** Sets the client IP for this user
+ * @return true if the conversion was successful
*/
- int Penalty;
+ bool SetClientIP(const char* sip);
- /** Default constructor
+ /** Constructor
* @throw CoreException if the UID allocated to the user already exists
- * @param Instance Creator instance
- * @param uid User UUID, or empty to allocate one automatically
*/
- User(InspIRCd* Instance, const std::string &uid = "");
+ User(const std::string &uid, const std::string& srv, int objtype);
/** Check if the user matches a G or K line, and disconnect them if they do.
* @param doZline True if ZLines should be checked (if IP has changed since initial connect)
*/
void SetMode(unsigned char m, bool value);
- /** Returns true if a user is invited to a channel.
- * @param channel A channel name to look up
- * @return True if the user is invited to the given channel
- */
- virtual bool IsInvited(const irc::string &channel);
-
- /** Adds a channel to a users invite list (invites them to a channel)
- * @param channel A channel name to add
- * @param timeout When the invite should expire (0 == never)
- */
- virtual void InviteTo(const irc::string &channel, time_t timeout);
-
- /** Removes a channel from a users invite list.
- * This member function is called on successfully joining an invite only channel
- * to which the user has previously been invited, to clear the invitation.
- * @param channel The channel to remove the invite to
- */
- virtual void RemoveInvite(const irc::string &channel);
-
/** Returns true or false for if a user can execute a privilaged oper command.
* This is done by looking up their oper type from User::oper, then referencing
* this to their oper classes and checking the commands they can execute.
* @param command A command (should be all CAPS)
* @return True if this user can execute the command
*/
- bool HasPermission(const std::string &command);
+ virtual bool HasPermission(const std::string &command);
/** Returns true if a user has a given permission.
* This is used to check whether or not users may perform certain actions which admins may not wish to give to
* @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
* @return True if this user has the permission in question.
*/
- bool HasPrivPermission(const std::string &privstr, bool noisy = false);
+ virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
/** Returns true or false if a user can set a privileged user or channel mode.
* This is done by looking up their oper type from User::oper, then referencing
* @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
- * @return The number of bytes read, or -1 if an error occured.
- */
- int ReadData(void* buffer, size_t size);
-
- /** 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(const 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();
-
- /** 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);
-
- /** 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
- */
- InvitedList* GetInviteList();
+ virtual bool HasModePermission(unsigned char mode, ModeType type);
/** Creates a wildcard host.
* Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
*/
const std::string& 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();
-
/** Add the user to WHOWAS system
*/
void AddToWhoWas();
/** Oper up the user using the given opertype.
* This will also give the +o usermode.
- * @param opertype The oper type to oper as
- */
- void Oper(const std::string &opertype, const std::string &opername);
-
- /** Call this method to find the matching <connect> for a user, and to check them against it.
- */
- void CheckClass();
-
- /** Use this method to fully connect a user.
- * This will send the message of the day, check G/K/E lines, etc.
- */
- void FullConnect();
-
- /** Change this users hash key to a new string.
- * You should not call this function directly. It is used by the core
- * to update the users hash entry on a nickchange.
- * @param New new user_hash key
- * @return Pointer to User in hash (usually 'this')
*/
- User* UpdateNickHash(const char* New);
+ void Oper(OperInfo* info);
/** Force a nickname change.
* If the nickname change fails (for example, because the nick in question
* @param newnick The nickname to change to
* @return True if the nickchange was successful.
*/
- bool ForceNickChange(const char* newnick);
+ inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
/** 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.
+ /** Write text to this user, appending CR/LF. Works on local users only.
* @param text A std::string to send to the user
*/
- void Write(std::string text);
+ virtual void Write(const std::string &text);
/** Write text to this user, appending CR/LF.
+ * Works on local users only.
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
+ virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
/** Write text to this user, appending CR/LF and prepending :server.name
+ * Works on local users only.
* @param text A std::string to send to the user
*/
void WriteServ(const std::string& text);
/** Write text to this user, appending CR/LF and prepending :server.name
+ * Works on local users only.
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
/** Write to all users that can see this user (including this user in the list), appending CR/LF
* @param text A std::string to send to the users
*/
- void WriteCommon(const std::string &text);
+ void WriteCommonRaw(const std::string &line, bool include_self = true);
/** Write to all users that can see this user (including this user in the list), appending CR/LF
* @param text The format string for text to send to the users
*/
void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
- /** Write to all users that can see this user (not including this user in the list), appending CR/LF
- * @param text A std::string to send to the users
- */
- void WriteCommonExcept(const std::string &text);
-
/** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
* quit message for opers only.
* @param normal_text Normal user quit message
*/
void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
- /** Write a WALLOPS message from this user to all local opers.
- * If this user is not opered, the function will return without doing anything.
- * @param text The format string to send in the WALLOPS message
- * @param ... Format arguments
+ /** Dump text to a user target, splitting it appropriately to fit
+ * @param LinePrefix text to prefix each complete line with
+ * @param TextStream the text to send to the user
*/
- void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
+ void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
- /** Write a WALLOPS message from this user to all local opers.
- * If this user is not opered, the function will return without doing anything.
- * @param text The text to send in the WALLOPS message
+ /** Write to the user, routing the line if the user is remote.
*/
- void WriteWallOps(const std::string &text);
+ 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
*/
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
*/
bool ChangeName(const char* gecos);
+ /** Change a user's nick
+ * @param newnick The new nick
+ * @param force True if the change is being forced (should not be blocked by modes like +N)
+ * @return True if the change succeeded
+ */
+ bool ChangeNick(const std::string& newnick, bool force = false);
+
/** Send a command to all local users from this user
* The command given must be able to send text with the
* first parameter as a servermask (e.g. $*), so basically
*/
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
*/
void PurgeEmptyChannels();
- /** Get the connect class which this user belongs to.
- * @return A pointer to this user's connect class
+ /** Get the connect class which this user belongs to. NULL for remote users.
+ * @return A pointer to this user's connect class.
+ */
+ virtual ConnectClass* GetClass();
+
+ /** 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
+{
+ /** 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;
+
+ public:
+ LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+ CullResult cull();
+
+ UserIOHandler eh;
+
+ /** Stats counter for bytes inbound
+ */
+ int bytes_in;
+
+ /** Stats counter for bytes outbound
+ */
+ int bytes_out;
+
+ /** Stats counter for commands inbound
+ */
+ int cmds_in;
+
+ /** Stats counter for commands outbound
+ */
+ int cmds_out;
+
+ /** 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;
+
+ ConnectClass* GetClass();
+
+ /** Call this method to find the matching <connect> for a user, and to check them against it.
+ */
+ void CheckClass();
+
+ /** Server address and port that this user is connected to.
+ */
+ irc::sockets::sockaddrs server_sa;
+
+ /**
+ * @return The port number of this user.
+ */
+ int GetServerPort();
+
+ /** Used by PING checking code
+ */
+ time_t nping;
+
+ /** This value contains how far into the penalty threshold the user is.
+ * This is used either to enable fake lag or for excess flood quits
+ */
+ unsigned int CommandFloodPenalty;
+
+ static already_sent_t already_sent_id;
+ already_sent_t already_sent;
+
+ /** Stored reverse lookup from res_forward. Should not be used after resolution.
+ */
+ std::string stored_host;
+
+ /** Starts a DNS lookup of the user's IP.
+ * This will cause two UserResolver classes to be instantiated.
+ * When complete, these objects set User::dns_done to true.
+ */
+ void StartDNSLookup();
+
+ /** Use this method to fully connect a user.
+ * This will send the message of the day, check G/K/E lines, etc.
*/
- ConnectClass *GetClass();
+ 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.
*/
- ConnectClass *SetClass(const std::string &explicit_name = "");
+ void SetClass(const std::string &explicit_name = "");
- /** Show the message of the day to this user
- */
- void ShowMOTD();
+ void SendText(const std::string& line);
+ void Write(const std::string& text);
+ void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
- /** Show the server RULES file to this user
+ /** 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
*/
- void ShowRULES();
+ InvitedList* GetInviteList();
- /** Set oper-specific quit message shown to opers only when the user quits
- * (overrides any sent by QuitUser)
+ /** Returns true if a user is invited to a channel.
+ * @param channel A channel name to look up
+ * @return True if the user is invited to the given channel
*/
- void SetOperQuit(const std::string &oquit);
+ bool IsInvited(const irc::string &channel);
- /** Get oper-specific quit message shown only to opers when the user quits.
- * (overrides any sent by QuitUser)
+ /** 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)
*/
- const std::string& GetOperQuit();
+ void InviteTo(const irc::string &channel, time_t timeout);
- /** Increases a user's command penalty by a set amount.
+ /** Removes a channel from a users invite list.
+ * This member function is called on successfully joining an invite only channel
+ * to which the user has previously been invited, to clear the invitation.
+ * @param channel The channel to remove the invite to
*/
- void IncreasePenalty(int increase);
+ void RemoveInvite(const irc::string &channel);
- /** Decreases a user's command penalty by a set amount.
+ /** 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
*/
- void DecreasePenalty(int decrease);
+ bool HasPermission(const std::string &command);
- /** Handle socket event.
- * From EventHandler class.
- * @param et Event type
- * @param errornum Error number for EVENT_ERROR events
+ /** 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.
*/
- void HandleEvent(EventType et, int errornum = 0);
+ bool HasPrivPermission(const std::string &privstr, bool noisy = false);
- /** Default destructor
+ /** 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 ~User();
+ bool HasModePermission(unsigned char mode, ModeType type);
+};
+
+class CoreExport RemoteUser : public User
+{
+ public:
+ RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
+ {
+ }
+ virtual void SendText(const std::string& line);
+};
+
+class CoreExport FakeUser : public User
+{
+ public:
+ FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
+ {
+ nick = srv;
+ }
+
+ virtual CullResult cull();
+ virtual void SendText(const std::string& line);
+ virtual const std::string& GetFullHost();
+ virtual const std::string& GetFullRealHost();
};
+/* Faster than dynamic_cast */
+/** Is a local user */
+inline LocalUser* IS_LOCAL(User* u)
+{
+ return u->usertype == USERTYPE_LOCAL ? static_cast<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;
+}
+/** Is an oper */
+#define IS_OPER(x) (x->oper)
+/** Is away */
+#define IS_AWAY(x) (!x->awaymsg.empty())
+
/** Derived from Resolver, and performs user forward/reverse lookups.
*/
class CoreExport UserResolver : public Resolver
{
private:
- /** User this class is 'attached' to.
- */
- User* bound_user;
- /** File descriptor teh lookup is bound to
- */
- int bound_fd;
+ /** UUID we are looking up */
+ std::string uuid;
/** True if the lookup is forward, false if is a reverse lookup
*/
bool fwd;
* @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);
+ UserResolver(LocalUser* 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);
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
/** Called on failed lookup
* @param e Error code
void OnError(ResolverError e, const std::string &errormessage);
};
-/* Configuration callbacks */
-//class ServerConfig;
-
#endif
projects / user / henk / code / inspircd.git / blobdiff