* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 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.
#define __USERS_H__
#include "socket.h"
-#include "connection.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.
/** 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;
*/
std::string hash;
- /** Threshold value for flood disconnect
- */
- unsigned int threshold;
-
/** Maximum size of sendq for users in this class (bytes)
*/
unsigned long sendqmax;
/** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
*/
ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
- registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
- pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
+ 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(0)
+ port(source->port), RefCount(0), disabled(false), limit(source->limit)
{
}
/** Create a new connect class with no settings.
*/
- ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
- threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
+ 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 fld The flood value
* @param hst The IP mask to allow
* @param ping The ping frequency
* @param pas The password to be used
* @param hsh The hash to be used
- * @param thres The flooding threshold
* @param sendq The maximum sendq value
* @param recvq The maximum recvq value
* @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, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
+ 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), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
- threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
+ 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),
- flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
+ host(hst), pingtime(0), pass(""), hash(""), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
{
}
* @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), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
+ 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(0)
+ port(source->port), RefCount(0), disabled(false), limit(source->limit)
{
}
/* Update an existing entry with new values
*/
- void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
- const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
+ 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 (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)
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. :)
*/
unsigned long limit;
- int GetMaxChans()
+ size_t GetMaxChans()
{
return maxchans;
}
/** Returns the registration timeout
*/
- unsigned int GetRegTimeout()
+ time_t GetRegTimeout()
{
return (registration_timeout ? registration_timeout : 90);
}
- /** Returns the flood limit
- */
- unsigned int GetFlood()
- {
- return (threshold ? flood : 999);
- }
-
/** Returns the allowed or denied IP mask
*/
const std::string& GetHost()
return hash;
}
- /** Returns the flood threshold value
- */
- unsigned int GetThreshold()
- {
- return (threshold ? threshold : 1);
- }
-
/** Returns the maximum sendq value
*/
unsigned long GetSendqMax()
* by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
* file descriptor value.
*/
-class CoreExport User : public connection
+class CoreExport User : public EventHandler
{
private:
/** Pointer to creator.
*/
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();
- /** Max channels for this user
- */
- unsigned int MaxChans;
-
- std::map<std::string, bool>* AllowedOperCommands;
+ std::set<std::string> *AllowedOperCommands;
+ std::set<std::string> *AllowedPrivs;
/** Allowed user modes from oper classes. */
- bool* AllowedUserModes;
+ std::bitset<64> AllowedUserModes;
/** Allowed channel modes from oper classes. */
- bool* AllowedChanModes;
+ std::bitset<64> AllowedChanModes;
public:
- /** Module responsible for raw i/o
- */
- Module* io;
-
/** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
* The pointer is guarenteed to *always* be valid. :)
*/
ConnectClass *MyClass;
- /** Resolvers for looking up this users IP address
- * This will occur if and when res_reverse completes.
- * When this class completes its lookup, User::dns_done
- * will be set from false to true.
+ /** User visibility state, see definition of VisData.
*/
- UserResolver* res_forward;
+ VisData* Visibility;
- /** Resolvers for looking up this users hostname
- * This is instantiated by User::StartDNSLookup(),
- * and on success, instantiates User::res_reverse.
+ /** Hostname of connection.
+ * This should be valid as per RFC1035.
*/
- UserResolver* res_reverse;
+ std::string host;
- /** User visibility state, see definition of VisData.
+ /** Stats counter for bytes inbound
*/
- VisData* Visibility;
+ int bytes_in;
+
+ /** Stats counter for bytes outbound
+ */
+ int bytes_out;
+
+ /** Stats counter for commands inbound
+ */
+ int cmds_in;
- /** Stored reverse lookup from res_forward
+ /** 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 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;
*/
void StartDNSLookup();
- unsigned int GetMaxChans();
-
/** The users nickname.
* An invalid nickname indicates an unregistered connection prior to the NICK command.
* Use InspIRCd::IsNick() to validate nicknames.
*/
- char nick[NICKMAX];
+ std::string nick;
/** The user's unique identifier.
* This is the unique identifier which the user has across the network.
*/
- char uuid[UUID_LENGTH];
+ std::string uuid;
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
- char ident[IDENTMAX+2];
+ std::string ident;
/** The host displayed to non-opers (used for cloaking etc).
* This usually matches the value of User::host.
*/
- char dhost[65];
+ std::string dhost;
/** The users full name (GECOS).
*/
- char fullname[MAXGECOS+1];
+ std::string fullname;
/** The user's mode list.
- * This is NOT a null terminated string! In the 1.1 version of InspIRCd
- * this is an array of values in a similar way to channel modes.
- * A value of 1 in field (modeletter-65) indicates that the mode is
+ * NOT a null terminated string.
+ * Also NOT an array.
+ * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+ * if (modes[modeletter-65]) is set, then the mode is
* set, for example, to work out if mode +s is set, we check the field
* User::modes['s'-65] != 0.
* The following RFC characters o, w, s, i have constants defined via an
* enum, such as UM_SERVERNOTICE and UM_OPETATOR.
*/
- char modes[64];
+ std::bitset<64> modes;
/** What snomasks are set on this user.
* This functions the same as the above modes.
*/
- char snomasks[64];
+ std::bitset<64> snomasks;
/** Channels this user is on, and the permissions they have there
*/
/** The user's away message.
* If this string is empty, the user is not marked as away.
*/
- char awaymsg[MAXAWAY+1];
+ std::string awaymsg;
/** Time the user last went away.
* This is ONLY RELIABLE if user IS_AWAY()!
*/
time_t awaytime;
- /** Timestamp of current time + connection class timeout.
- * This user must send USER/NICK before this timestamp is
- * reached or they will be disconnected.
- */
- time_t timeout;
-
/** 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
* 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.
*/
bool quietquit;
- /** Flood counters - lines received
- */
- unsigned int lines_in;
-
- /** Flood counters - time lines_in is due to be reset
- */
- time_t reset_due;
-
/** If this is set to true, then all 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.
* GetIPString/GetPort to obtain its values.
*/
sockaddr* ip;
-
- /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
- */
- std::string cachedip;
/** Initialize the clients sockaddr
* @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
/** Get IP string from sockaddr, using static internal buffer
* @return The IP string
*/
- const char* GetIPString(bool translate4in6 = true);
+ const char* GetIPString();
- /* Write error string
+ /** Get a CIDR mask from the IP of this user, using a static internal buffer.
+ * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
+ * This may be used for CIDR clone detection, etc.
+ *
+ * (XXX, brief note: when we do the sockets rewrite, this should move down a
+ * level so it may be used on more derived objects. -- w00t)
*/
- std::string WriteError;
+ const char *GetCIDRMask(int range);
/** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
*/
int Penalty;
- /** True if we are flushing penalty lines
- */
- bool OverPenalty;
-
- /** If this bool is set then penalty rules do not apply to this user
- */
- bool ExemptFromPenalty;
-
/** Default constructor
* @throw CoreException if the UID allocated to the user already exists
* @param Instance Creator instance
*/
User(InspIRCd* Instance, const std::string &uid = "");
+ /** Check if the user matches a G or K line, and disconnect them if they do.
+ * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
+ * Returns true if the user matched a ban, false else.
+ */
+ bool CheckLines(bool doZline = false);
+
/** Returns the full displayed host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form.
* @return The full masked host of the user
*/
- virtual char* GetFullHost();
+ virtual const std::string& GetFullHost();
/** Returns the full real host of the user
* This member function returns the hostname of the user as seen by other users
* 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
*/
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 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,
/** Get oper-specific quit message shown only to opers when the user quits.
* (overrides any sent by QuitUser)
*/
- const char* GetOperQuit();
+ const std::string& GetOperQuit();
/** Increases a user's command penalty by a set amount.
*/
//class ServerConfig;
#endif
-