* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
#ifndef __USERS_H__
#define __USERS_H__
-#include <string>
-#include "inspircd_config.h"
#include "socket.h"
-#include "channels.h"
-#include "inspstring.h"
-#include "connection.h"
-#include "hashcomp.h"
#include "dns.h"
+#include "mode.h"
/** Channel status for a user
*/
/** RFC1459 channel modes
*/
enum UserModes {
- /** +s: Server notices */
- UM_SERVERNOTICE = 's' - 65,
+ /** +s: Server notice mask */
+ UM_SNOMASK = 's' - 65,
/** +w: WALLOPS */
UM_WALLOPS = 'w' - 65,
/** +i: Invisible */
UM_INVISIBLE = 'i' - 65,
/** +o: Operator */
- UM_OPERATOR = 'o' - 65,
- /** +n: Server notice mask */
- UM_SNOMASK = 'n' - 65
+ UM_OPERATOR = 'o' - 65
};
/** Registration state of a user, e.g.
};
/* Required forward declaration */
-class InspIRCd;
-
-/** Derived from Resolver, and performs user forward/reverse lookups.
- */
-class CoreExport UserResolver : public Resolver
-{
- private:
- /** User this class is 'attached' to.
- */
- userrec* bound_user;
- /** File descriptor teh lookup is bound to
- */
- int bound_fd;
- /** True if the lookup is forward, false if is a reverse lookup
- */
- bool fwd;
- public:
- /** Create a resolver.
- * @param Instance The creating instance
- * @param user The user to begin lookup on
- * @param to_resolve The IP or host to resolve
- * @param qt The query type
- * @param cache Modified by the constructor if the result was cached
- */
- UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
-
- /** Called on successful lookup
- * @param result Result string
- * @param ttl Time to live for result
- * @param cached True if the result was found in the cache
- * @param resultnum Result number, we are only interested in result 0
- */
- void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
-
- /** Called on failed lookup
- * @param e Error code
- * @param errormessage Error message string
- */
- void OnError(ResolverError e, const std::string &errormessage);
-};
-
+class Channel;
+class UserResolver;
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class CoreExport ConnectClass : public classbase
+struct CoreExport ConnectClass : public classbase
{
- private:
/** Type of line, either CC_ALLOW or CC_DENY
*/
char type;
+
/** Connect class name
*/
std::string name;
+
/** Max time to register the connection in seconds
*/
unsigned int registration_timeout;
- /** Number of lines in buffer before excess flood is triggered
- */
- unsigned int flood;
+
/** Host mask for this line
*/
std::string host;
+
/** Number of seconds between pings for this line
*/
unsigned int pingtime;
+
/** (Optional) Password for this line
*/
std::string pass;
- /** Threshold value for flood disconnect
+ /** (Optional) Hash Method for this line
*/
- unsigned int threshold;
+ std::string hash;
/** Maximum size of sendq for users in this class (bytes)
*/
/** Global max when connecting by this connection class
*/
unsigned long maxglobal;
- /** Port number this connect class applies to
- */
- int port;
-
-public:
- /** Create a new connect class with no settings.
+ /** Max channels for this class
*/
- ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
- threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
-
- /** Create a new connect class to ALLOW connections.
- * @param thename Name of the connect class
- * @param timeout The registration timeout
- * @param fld The flood value
- * @param hst The IP mask to allow
- * @param ping The ping frequency
- * @param pas The password to be used
- * @param thres The flooding threshold
- * @param sendq The maximum sendq value
- * @param recvq The maximum recvq value
- * @param maxl The maximum local sessions
- * @param maxg The maximum global sessions
- */
- ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
- const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
- unsigned long maxl, unsigned long maxg, int p = 0) :
- type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
- threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
-
- /** Create a new connect class to DENY connections
- * @param thename Name of the connect class
- * @param hst The IP mask to deny
- */
- ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
- flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
-
- /* Create a new connect class based on another class
- * @param thename The name of the connect class
- * @param source Another connect class to inherit all but the name from
- */
- ConnectClass(const std::string &thename, const ConnectClass &source) : type(source.type), name(thename),
- registration_timeout(source.registration_timeout), flood(source.flood), host(source.host),
- pingtime(source.pingtime), pass(source.pass), threshold(source.threshold), sendqmax(source.sendqmax),
- recvqmax(source.recvqmax), maxlocal(source.maxlocal), maxglobal(source.maxglobal), port(source.port)
- {
- }
+ unsigned int maxchans;
- /* Update an existing entry with new values
+ /** Port number this connect class applies to
*/
- void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
- const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
- unsigned long maxl, unsigned long maxg, int p)
- {
- if (timeout)
- registration_timeout = timeout;
- if (fld)
- flood = fld;
- if (!hst.empty())
- host = hst;
- if (ping)
- pingtime = ping;
- if (!pas.empty())
- pass = pas;
- if (thres)
- threshold = thres;
- if (sendq)
- sendqmax = sendq;
- if (recvq)
- recvqmax = recvq;
- if (maxl)
- maxlocal = maxl;
- if (maxg)
- maxglobal = maxg;
- if (p)
- port = p;
- }
+ int port;
- /** Returns the type, CC_ALLOW or CC_DENY
+ /** How many users may be in this connect class before they are refused?
+ * (0 = no limit = default)
*/
- char GetType()
- {
- return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
- }
+ unsigned long limit;
- std::string& GetName()
- {
- return name;
- }
-
- /** Returns the registration timeout
+ /** Reference counter.
+ * This will be 1 if no users are connected, as long as it is a valid connect block
+ * When it reaches 0, the object should be deleted
*/
- unsigned int GetRegTimeout()
- {
- return (registration_timeout ? registration_timeout : 90);
- }
+ unsigned long RefCount;
- /** Returns the flood limit
+ /** Create a new connect class with no settings.
*/
- unsigned int GetFlood()
- {
- return (threshold ? flood : 999);
- }
-
- /** Returns the allowed or denied IP mask
+ ConnectClass(char type, const std::string& mask);
+ /** Create a new connect class with inherited settings.
*/
- const std::string& GetHost()
- {
- return host;
- }
+ ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
+
+ /** Update the settings in this block to match the given block */
+ void Update(const ConnectClass* newSettings);
- /** Get port number
- */
- int GetPort()
- {
- return port;
- }
- /** Set port number
+ const std::string& GetName() { return name; }
+ const std::string& GetPass() { return pass; }
+ const std::string& GetHost() { return host; }
+ const int GetPort() { return port; }
+
+ /** Returns the registration timeout
*/
- void SetPort(int p)
+ time_t GetRegTimeout()
{
- port = p;
+ return (registration_timeout ? registration_timeout : 90);
}
/** Returns the ping frequency
return (pingtime ? pingtime : 120);
}
- /** Returns the password or an empty string
- */
- const std::string& GetPass()
- {
- return pass;
- }
-
- /** Returns the flood threshold value
- */
- unsigned int GetThreshold()
- {
- return (threshold ? threshold : 1);
- }
-
/** Returns the maximum sendq value
*/
unsigned long GetSendqMax()
{
return maxglobal;
}
-
- bool operator= (ConnectClass &other)
- {
- return (other.GetName() == name);
- }
};
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
+/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
*/
-typedef std::vector<irc::string> InvitedList;
+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 std::vector<ConnectClass*> ClassVector;
/** Typedef for the list of user-channel records for a user
*/
-typedef std::map<chanrec*, char> UserChanList;
+typedef std::map<Channel*, char> UserChanList;
/** Shorthand for an iterator into a UserChanList
*/
/* Required forward declaration
*/
-class userrec;
+class User;
/** Visibility data for a user.
- * If a user has a non-null instance of this class in their userrec,
+ * 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.
*/
* @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(userrec* user);
+ 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 userrec : public connection
+class CoreExport User : public EventHandler
{
private:
- /** Pointer to creator.
- * This is required to make use of core functions
- * from within the userrec class.
- */
- InspIRCd* ServerInstance;
-
/** A list of channels the user has a pending invite to.
* Upon INVITE channels are added, and upon JOIN, the
* channels are removed from this list.
*/
InvitedList invites;
- /** Number of channels this user is currently on
+ /** Cached nick!ident@dhost value using the displayed hostname
*/
- unsigned int ChannelCount;
+ std::string cached_fullhost;
- /** Cached nick!ident@host value using the real hostname
+ /** Cached ident@ip value using the real IP address
*/
- char* cached_fullhost;
+ std::string cached_hostip;
- /** Cached nick!ident@ip value using the real IP address
+ /** Cached ident@realhost value using the real hostname
*/
- char* cached_hostip;
+ std::string cached_makehost;
- /** Cached nick!ident@host value using the masked hostname
+ /** Cached nick!ident@realhost value using the real hostname
*/
- char* cached_makehost;
+ std::string cached_fullrealhost;
- /** Cached nick!ident@realhost value using the real hostname
+ /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
*/
- char* cached_fullrealhost;
+ std::string cachedip;
/** When we erase the user (in the destructor),
* we call this method to subtract one from all
*/
void DecrementModes();
- /** Oper-only quit message for this user if non-null
- */
- char* operquit;
+ 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:
- /** Resolvers for looking up this users IP address
- * This will occur if and when res_reverse completes.
- * When this class completes its lookup, userrec::dns_done
- * will be set from false to true.
+ /** Pointer to creator.
+ * This is required to make use of core functions
+ * from within the User class.
*/
- UserResolver* res_forward;
+ InspIRCd* ServerInstance;
- /** Resolvers for looking up this users hostname
- * This is instantiated by userrec::StartDNSLookup(),
- * and on success, instantiates userrec::res_reverse.
+ /** 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. :)
*/
- UserResolver* res_reverse;
+ ConnectClass *MyClass;
/** User visibility state, see definition of VisData.
*/
VisData* Visibility;
- /** Stored reverse lookup from res_forward
+ /** 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
+ * created.
+ */
+ time_t signon;
+
+ /** Time that the connection last sent a message, used to calculate idle time
+ */
+ time_t idle_lastmsg;
+
+ /** Used by PING checking code
+ */
+ time_t nping;
+
+ /** Stored reverse lookup from res_forward. Should not be used after resolution.
*/
std::string stored_host;
/** Starts a DNS lookup of the user's IP.
* This will cause two UserResolver classes to be instantiated.
- * When complete, these objects set userrec::dns_done to true.
+ * When complete, these objects set User::dns_done to true.
*/
void StartDNSLookup();
* An invalid nickname indicates an unregistered connection prior to the NICK command.
* Use InspIRCd::IsNick() to validate nicknames.
*/
- char nick[NICKMAX];
+ std::string nick;
+
+ /** The user's unique identifier.
+ * This is the unique identifier which the user has across the network.
+ */
+ std::string uuid;
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
- char ident[IDENTMAX+2];
+ std::string ident;
/** The host displayed to non-opers (used for cloaking etc).
- * This usually matches the value of userrec::host.
+ * This usually matches the value of User::host.
*/
- char dhost[65];
+ std::string dhost;
/** The users full name (GECOS).
*/
- char fullname[MAXGECOS+1];
+ std::string fullname;
/** The user's mode list.
- * This is NOT a null terminated string! In the 1.1 version of InspIRCd
- * this is an array of values in a similar way to channel modes.
- * A value of 1 in field (modeletter-65) indicates that the mode is
+ * NOT a null terminated string.
+ * Also NOT an array.
+ * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+ * if (modes[modeletter-65]) is set, then the mode is
* set, for example, to work out if mode +s is set, we check the field
- * userrec::modes['s'-65] != 0.
+ * User::modes['s'-65] != 0.
* The following RFC characters o, w, s, i have constants defined via an
* enum, such as UM_SERVERNOTICE and UM_OPETATOR.
*/
- char modes[64];
+ std::bitset<64> modes;
/** What snomasks are set on this user.
* This functions the same as the above modes.
*/
- char snomasks[64];
+ std::bitset<64> snomasks;
/** Channels this user is on, and the permissions they have there
*/
/** The user's away message.
* If this string is empty, the user is not marked as away.
*/
- char awaymsg[MAXAWAY+1];
-
- /** Number of lines the user can place into the buffer
- * (up to the global NetBufferSize bytes) before they
- * are disconnected for excess flood
- */
- int flood;
+ std::string awaymsg;
- /** Timestamp of current time + connection class timeout.
- * This user must send USER/NICK before this timestamp is
- * reached or they will be disconnected.
+ /** Time the user last went away.
+ * This is ONLY RELIABLE if user IS_AWAY()!
*/
- time_t timeout;
+ time_t awaytime;
/** The oper type they logged in as, if they are an oper.
* This is used to check permissions in operclasses, so that
* we can say 'yay' or 'nay' to any commands they issue.
* The value of this is the value of a valid 'type name=' tag.
*/
- char oper[NICKMAX];
+ std::string oper;
/** True when DNS lookups are completed.
* The UserResolver classes res_forward and res_reverse will
*/
bool dns_done;
- /** Number of seconds between PINGs for this user (set from <connect:allow> tag
- */
- unsigned int pingmax;
-
/** Password specified by the user when they registered.
* This is stored even if the <connect> block doesnt need a password, so that
* modules may check it.
*/
- char password[64];
+ std::string password;
/** User's receive queue.
* Lines from the IRCd awaiting processing are stored here.
*/
std::string sendq;
- /** Flood counters - lines received
- */
- int lines_in;
-
- /** Flood counters - time lines_in is due to be reset
+ /** Whether or not to send an snotice about this user's quitting
*/
- time_t reset_due;
+ bool quietquit;
- /** Flood counters - Highest value lines_in may reach before the user gets disconnected
- */
- long threshold;
-
- /** If this is set to true, then all read operations for the user
+ /** If this is set to true, then all socket operations for the user
* are dropped into the bit-bucket.
- * This is used by the global CullList, but please note that setting this value
- * alone will NOT cause the user to quit. This means it can be used seperately,
- * for example by shun modules etc.
+ * This value is set by QuitUser, and is not needed seperately from that call.
+ * Please note that setting this value alone will NOT cause the user to quit.
*/
- bool muted;
+ bool quitting;
- /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
- * GetIPString/GetPort to obtain its values.
+ /** Server address and port that this user is connected to.
+ * If unknown, address family is AF_UNKNOWN
+ */
+ irc::sockets::sockaddrs server_sa;
+ /** Client address that the user is connected from.
+ * Port number is only valid if local.
+ *
+ * Do not modify this value directly, use SetClientIP() to change it
*/
- sockaddr* ip;
+ irc::sockets::sockaddrs client_sa;
- /** Initialize the clients sockaddr
- * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
- * @param ip A human-readable IP address for this user matching the protcol_family
- * @param port The port number of this user or zero for a remote user
+ /** Sets the client IP for this user
+ * @return true if the conversion was successful
*/
- void SetSockAddr(int protocol_family, const char* ip, int port);
+ bool SetClientIP(const char* sip);
- /** Get port number from sockaddr
+ /**
* @return The port number of this user.
*/
- int GetPort();
-
- /** Get protocol family from sockaddr
- * @return The protocol family of this user, either AF_INET or AF_INET6
+ int GetServerPort();
+ /**
+ * @return The server IP address
*/
- int GetProtocolFamily();
+ std::string GetServerIP();
- /** Get IP string from sockaddr, using static internal buffer
+ /** Get client IP string from sockaddr, using static internal buffer
* @return The IP string
*/
const char* GetIPString();
- /** Get IP string from sockaddr, using caller-specified buffer
- * @param buf A buffer to use
- * @return The IP string
+ /** Get a CIDR mask from the IP of this user, using a static internal buffer.
+ * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
+ * This may be used for CIDR clone detection, etc.
+ *
+ * (XXX, brief note: when we do the sockets rewrite, this should move down a
+ * level so it may be used on more derived objects. -- w00t)
*/
- const char* GetIPString(char* buf);
+ const char *GetCIDRMask(int range);
- /* Write error string
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
- std::string WriteError;
+ bool exempt;
- /** Maximum size this user's sendq can become.
- * Copied from the connect class on connect.
+ /** This value contains how far into the penalty threshold the user is. Once its over
+ * the penalty threshold then commands are held and processed on-timer.
*/
- long sendqmax;
+ int Penalty;
- /** Maximum size this user's recvq can become.
- * Copied from the connect class on connect.
+ /** Default constructor
+ * @throw CoreException if the UID allocated to the user already exists
+ * @param Instance Creator instance
+ * @param uid User UUID, or empty to allocate one automatically
*/
- long recvqmax;
+ User(InspIRCd* Instance, const std::string &uid = "");
- /** This is true if the user matched an exception when they connected to the ircd.
- * It isnt valid after this point, and you should not attempt to do anything with it
- * after this point, because the eline might be removed at a later time, and/or no
- * longer be applicable to this user. It is only used to save doing the eline lookup
- * twice (instead we do it once and set this value).
+ /** 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 exempt;
-
- /** Default constructor
- * @throw Nothing at present
- */
- userrec(InspIRCd* Instance);
+ bool CheckLines(bool doZline = false);
/** Returns the full displayed host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form.
* @return The full masked host of the user
*/
- virtual char* GetFullHost();
+ virtual const std::string GetFullHost();
/** Returns the full real host of the user
* This member function returns the hostname of the user as seen by other users
* e.g. through a module, then this method will ignore it and return the true hostname.
* @return The full real host of the user
*/
- virtual char* GetFullRealHost();
+ virtual const std::string GetFullRealHost();
/** This clears any cached results that are used for GetFullRealHost() etc.
* The results of these calls are cached as generating them can be generally expensive.
/** Create a displayable mode string for this users umodes
* @param The mode string
*/
- const char* FormatModes();
+ const char* FormatModes(bool showparameters = false);
/** Returns true if a specific mode is set
* @param m The user mode
/** Adds a channel to a users invite list (invites them to a channel)
* @param channel A channel name to add
+ * @param timeout When the invite should expire (0 == never)
*/
- virtual void InviteTo(const irc::string &channel);
+ virtual void InviteTo(const irc::string &channel, time_t timeout);
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
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 userrec::oper, then referencing
+ * 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);
+
/** 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
* @param a The string to add to the users read buffer
* @return True if the string was successfully added to the read buffer
*/
- bool AddBuffer(std::string a);
+ 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)
*/
std::string GetBuffer();
- /** Sets the write error for a connection. This is done because the actual disconnect
- * of a client may occur at an inopportune time such as half way through /LIST output.
- * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
- * errored clients purged.
- * @param error The error string to set.
- */
- void SetWriteError(const std::string &error);
-
- /** Returns the write error which last occured on this connection or an empty string
- * if none occured.
- * @return The error string which has occured for this user
- */
- const char* GetWriteError();
-
/** Adds to the user's write buffer.
* You may add any amount of text up to this users sendq value, if you exceed the
- * sendq value, SetWriteError() will be called to set the users error string to
- * "SendQ exceeded", and further buffer adds will be dropped.
+ * sendq value, the user will be removed, and further buffer adds will be dropped.
* @param data The data to add to the write buffer
*/
void AddWriteBuf(const std::string &data);
* Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
* @return the usermask in the format user@host
*/
- char* MakeHost();
+ const std::string& MakeHost();
/** Creates a usermask with real ip.
* Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
* @return the usermask in the format user@ip
*/
- char* MakeHostIP();
+ 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,
*/
void CloseSocket();
- /** Disconnect a user gracefully
- * @param user The user to remove
- * @param r The quit reason to show to normal users
- * @param oreason The quit reason to show to opers
- * @return Although this function has no return type, on exit the user provided will no longer exist.
- */
- static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
-
/** Add the user to WHOWAS system
*/
void AddToWhoWas();
* This will also give the +o usermode.
* @param opertype The oper type to oper as
*/
- void Oper(const std::string &opertype);
+ void Oper(const std::string &opertype, const std::string &opername);
/** Call this method to find the matching <connect> for a user, and to check them against it.
*/
- void CheckClass(const std::string &explicit_class = "");
+ void CheckClass();
/** Use this method to fully connect a user.
* This will send the message of the day, check G/K/E lines, etc.
* 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 userrec in hash (usually 'this')
+ * @return Pointer to User in hash (usually 'this')
*/
- userrec* UpdateNickHash(const char* New);
+ User* UpdateNickHash(const char* New);
/** Force a nickname change.
* If the nickname change fails (for example, because the nick in question
*/
bool ForceNickChange(const char* newnick);
- /** Add a client to the system.
- * This will create a new userrec, insert it into the user_hash,
- * initialize it as not yet registered, and add it to the socket engine.
- * @param Instance a pointer to the server instance
- * @param socket The socket id (file descriptor) this user is on
- * @param port The port number this user connected on
- * @param iscached This variable is reserved for future use
- * @param ip The IP address of the user
- * @return This function has no return value, but a call to AddClient may remove the user.
- */
- static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
-
/** Oper down.
* This will clear the +o usermode and unset the user's oper type
*/
void UnOper();
- /** Return the number of global clones of this user
- * @return The global clone count of this user
- */
- unsigned long GlobalCloneCount();
-
- /** Return the number of local clones of this user
- * @return The local clone count of this user
- */
- unsigned long LocalCloneCount();
-
- /** Remove all clone counts from the user, you should
- * use this if you change the user's IP address in
- * userrec::ip after they have registered.
- */
- void RemoveCloneCounts();
-
/** Write text to this user, appending CR/LF.
* @param text A std::string to send to the user
*/
- void Write(std::string text);
+ void Write(const std::string &text);
/** Write text to this user, appending CR/LF.
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void Write(const char *text, ...);
+ void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
/** Write text to this user, appending CR/LF and prepending :server.name
* @param text A std::string to send to the user
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteServ(const char* text, ...);
+ void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ void WriteNumeric(unsigned int numeric, const std::string &text);
/** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
* @param user The user to prepend the :nick!user@host of
* @param text A std::string to send to the user
*/
- void WriteFrom(userrec *user, const std::string &text);
+ 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(userrec *user, const char* text, ...);
+ void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
* @param dest The user to route the message to
* @param text A std::string to send to the user
*/
- void WriteTo(userrec *dest, const std::string &data);
+ void WriteTo(User *dest, const std::string &data);
/** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
* @param dest The user to route the message to
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteTo(userrec *dest, const char *data, ...);
+ void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
/** Write to all users that can see this user (including this user in the list), appending CR/LF
* @param text A std::string to send to the users
* @param text The format string for text to send to the users
* @param ... POD-type format arguments
*/
- void WriteCommon(const char* text, ...);
+ void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write to all users that can see this user (not including this user in the list), appending CR/LF
* @param text The format string for text to send to the users
* @param ... POD-type format arguments
*/
- void WriteCommonExcept(const char* text, ...);
+ void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write to all users that can see this user (not including this user in the list), appending CR/LF
* @param text A std::string to send to the users
*/
void WriteCommonExcept(const std::string &text);
- /** Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific
+ /** 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
* @param oper_text Oper only quit message
* @param text The format string to send in the WALLOPS message
* @param ... Format arguments
*/
- void WriteWallOps(const char* text, ...);
+ void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write a WALLOPS message from this user to all local opers.
* If this user is not opered, the function will return without doing anything.
* @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(userrec *other);
+ 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 userrec::dhost directly,
+ * ALWAYS use this function, rather than writing User::dhost directly,
* as this triggers module events allowing the change to be syncronized to
* remote servers. This will also emulate a QUIT and rejoin (where configured)
* before setting their host field.
bool ChangeDisplayedHost(const char* host);
/** Change the ident (username) of a user.
- * ALWAYS use this function, rather than writing userrec::ident directly,
+ * ALWAYS use this function, rather than writing User::ident directly,
* as this correctly causes the user to seem to quit (where configured)
* before setting their ident field.
* @param host The new ident to set
bool ChangeIdent(const char* newident);
/** Change a users realname field.
- * ALWAYS use this function, rather than writing userrec::fullname directly,
+ * 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
* @param text The text format string to send
* @param ... Format arguments
*/
- void SendAll(const char* command, char* text, ...);
+ void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Compile a channel list for this user, and send it to the user 'source'
* Used internally by WHOIS
* @param The user to send the channel list to if it is not too long
* @return This user's channel list
*/
- std::string ChannelList(userrec* source);
+ std::string ChannelList(User* source);
/** Split the channel list in cl which came from dest, and spool it to this user
* Used internally by WHOIS
* @param dest The user the original channel list came from
- * @param cl The channel list as a string obtained from userrec::ChannelList()
+ * @param cl The channel list as a string obtained from User::ChannelList()
*/
- void SplitChanList(userrec* dest, const std::string &cl);
+ void SplitChanList(User* dest, const std::string &cl);
/** 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();
- /** Get the connect class which matches this user's host or IP address
- * @param explicit_name Set this string to tie the user to a specific class name
- * @return A reference to this user's connect class
+ /** Get the connect class which this user belongs to.
+ * @return A pointer to this user's connect class
*/
- ConnectClass* GetClass(const std::string &explicit_name = "");
+ ConnectClass *GetClass();
+
+ /** Set the connect class to which this user belongs to.
+ * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking <connect> tags from the configuration file.
+ * @return A reference to this user's current connect class.
+ */
+ ConnectClass *SetClass(const std::string &explicit_name = "");
/** Show the message of the day to this user
*/
*/
void ShowRULES();
- /** Set oper-specific quit message shown to opers only when the user quits
- * (overrides any sent by QuitUser)
+ /** Increases a user's command penalty by a set amount.
*/
- void SetOperQuit(const std::string &oquit);
+ void IncreasePenalty(int increase);
- /** Get oper-specific quit message shown only to opers when the user quits.
- * (overrides any sent by QuitUser)
+ /** Decreases a user's command penalty by a set amount.
*/
- const char* GetOperQuit();
+ void DecreasePenalty(int decrease);
/** Handle socket event.
* From EventHandler class.
/** Default destructor
*/
- virtual ~userrec();
+ virtual ~User();
+};
+
+/** Derived from Resolver, and performs user forward/reverse lookups.
+ */
+class CoreExport UserResolver : public Resolver
+{
+ private:
+ /** User this class is 'attached' to.
+ */
+ User* bound_user;
+ /** File descriptor teh lookup is bound to
+ */
+ int bound_fd;
+ /** True if the lookup is forward, false if is a reverse lookup
+ */
+ bool fwd;
+ public:
+ /** Create a resolver.
+ * @param Instance The creating instance
+ * @param user The user to begin lookup on
+ * @param to_resolve The IP or host to resolve
+ * @param qt The query type
+ * @param cache Modified by the constructor if the result was cached
+ */
+ UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
+
+ /** Called on successful lookup
+ * @param result Result string
+ * @param ttl Time to live for result
+ * @param cached True if the result was found in the cache
+ */
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
+
+ /** Called on failed lookup
+ * @param e Error code
+ * @param errormessage Error message string
+ */
+ void OnError(ResolverError e, const std::string &errormessage);
};
/* Configuration callbacks */
-class ServerConfig;
+//class ServerConfig;
#endif
-
projects / user / henk / code / inspircd.git / blobdiff