* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
#include "hashcomp.h"
#include "dns.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
};
/** RFC1459 channel modes
- * */
+ */
enum UserModes {
- UM_SERVERNOTICE = 's'-65,
- UM_WALLOPS = 'w'-65,
- UM_INVISIBLE = 'i'-65,
- UM_OPERATOR = 'o'-65,
- UM_SNOMASK = 'n'-65,
+ /** +s: Server notices */
+ UM_SERVERNOTICE = '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
};
+/** Registration state of a user, e.g.
+ * have they sent USER, NICK, PASS yet?
+ */
enum RegistrationState {
+
+#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
REG_NONE = 0, /* Has sent nothing */
+#endif
+
REG_USER = 1, /* Has sent USER */
REG_NICK = 2, /* Has sent NICK */
REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
REG_ALL = 7 /* REG_NICKUSER plus next bit along */
};
+/* Required forward declaration */
class InspIRCd;
/** Derived from Resolver, and performs user forward/reverse lookups.
*/
-class UserResolver : public Resolver
+class CoreExport UserResolver : public Resolver
{
private:
/** User this class is 'attached' to.
*/
- userrec* bound_user;
+ 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:
- UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
+ /** 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);
- void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
+ /** 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);
};
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class ConnectClass : public classbase
+class 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;
/** Global max when connecting by this connection class
*/
unsigned long maxglobal;
+
+ /** Max channels for this class
+ */
+ unsigned int maxchans;
+
/** Port number this connect class applies to
*/
int port;
public:
+ /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
+ */
+ ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
+ registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
+ pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
+ recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
+ port(source->port), RefCount(0), disabled(false), limit(0)
+ {
+ }
+
/** Create a new connect class with no settings.
*/
- ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
- threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+ ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
+ threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
+ {
+ }
/** Create a new connect class to ALLOW connections.
+ * @param thename Name of the connect class
* @param timeout The registration timeout
* @param fld The flood value
* @param hst The IP mask to allow
* @param maxl The maximum local sessions
* @param maxg The maximum global sessions
*/
- ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
+ 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), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
- threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
+ unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
+ type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
+ threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
- /** Create a new connect class to DENY connections
+ /** 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 &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
- pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
+ ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
+ flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
+ {
+ }
+
+ /* Create a new connect class based on another class
+ * @param thename The name of the connect class
+ * @param source Another connect class to inherit all but the name from
+ */
+ ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
+ registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
+ pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
+ recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
+ port(source->port), RefCount(0), disabled(false), limit(0)
+ {
+ }
+
+ void SetDisabled(bool t)
+ {
+ this->disabled = t;
+ }
+
+ bool GetDisabled()
+ {
+ return this->disabled;
+ }
+
+ /* Update an existing entry with new values
+ */
+ void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
+ const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
+ unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
+ {
+ 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 (maxc)
+ maxchans = maxc;
+ if (p)
+ port = p;
+
+ this->limit = limit;
+ }
+
+ /** 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 RefCount;
+
+ /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written
+ */
+ bool disabled;
+
+ /** How many users may be in this connect class before they are refused? (0 = disabled = default)
+ */
+ unsigned long limit;
+
+ int GetMaxChans()
+ {
+ return maxchans;
+ }
/** Returns the type, CC_ALLOW or CC_DENY
*/
return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
}
+ std::string& GetName()
+ {
+ return name;
+ }
+
/** Returns the registration timeout
*/
unsigned int GetRegTimeout()
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()
*/
unsigned long GetMaxLocal()
{
- return (maxlocal ? maxlocal : 1);
+ return maxlocal;
}
/** Returns the maximum number of global sessions
*/
unsigned long GetMaxGlobal()
{
- return (maxglobal ? maxglobal : 1);
+ return maxglobal;
}
};
/** 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
+ */
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
* by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
* file descriptor value.
*/
-class userrec : public connection
+class CoreExport User : public connection
{
private:
/** Pointer to creator.
* This is required to make use of core functions
- * from within the userrec class.
+ * from within the User class.
*/
InspIRCd* ServerInstance;
/** Cached nick!ident@host value using the masked hostname
*/
char* cached_makehost;
+
+ /** Cached nick!ident@realhost value using the real hostname
+ */
char* cached_fullrealhost;
/** When we erase the user (in the destructor),
*/
void DecrementModes();
+ /** Oper-only quit message for this user if non-null
+ */
char* operquit;
+ /** Max channels for this user
+ */
+ unsigned int MaxChans;
+
+ std::map<std::string, bool>* AllowedOperCommands;
+
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;
+
/** 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
+ * When this class completes its lookup, User::dns_done
* will be set from false to true.
*/
UserResolver* res_forward;
/** Resolvers for looking up this users hostname
- * This is instantiated by userrec::StartDNSLookup(),
- * and on success, instantiates userrec::res_reverse.
+ * This is instantiated by User::StartDNSLookup(),
+ * and on success, instantiates User::res_reverse.
*/
UserResolver* res_reverse;
+ /** User visibility state, see definition of VisData.
+ */
+ VisData* Visibility;
+
/** Stored reverse lookup from res_forward
*/
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();
+ 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];
+ /** The user's unique identifier.
+ * This is the unique identifier which the user has across the network.
+ */
+ char uuid[UUID_LENGTH];
+
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
char ident[IDENTMAX+2];
/** 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];
* 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
* 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 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;
-
/** Timestamp of current time + connection class timeout.
* This user must send USER/NICK before this timestamp is
* reached or they will be disconnected.
*/
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.
/** Flood counters - lines received
*/
- int lines_in;
+ unsigned int lines_in;
/** Flood counters - time lines_in is due to be reset
*/
time_t reset_due;
- /** Flood counters - Highest value lines_in may reach before the user gets disconnected
- */
- long threshold;
-
/** If this is set to true, then all read operations for the user
* are dropped into the bit-bucket.
* This is used by the global CullList, but please note that setting this value
*/
const char* GetIPString();
- /** Get IP string from sockaddr, using caller-specified buffer
- * @param buf A buffer to use
- * @return The IP string
- */
- const char* GetIPString(char* buf);
-
/* Write error string
*/
std::string WriteError;
- /** Maximum size this user's sendq can become.
- * Copied from the connect class on connect.
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
- long sendqmax;
+ bool exempt;
- /** Maximum size this user's recvq can become.
- * Copied from the connect class on connect.
+ /** This value contains how far into the penalty threshold the user is. Once its over
+ * the penalty threshold then commands are held and processed on-timer.
*/
- long recvqmax;
+ int Penalty;
- /** This is true if the user matched an exception when they connected to the ircd.
- * It isnt valid after this point, and you should not attempt to do anything with it
- * after this point, because the eline might be removed at a later time, and/or no
- * longer be applicable to this user. It is only used to save doing the eline lookup
- * twice (instead we do it once and set this value).
+ /** True if we are flushing penalty lines
*/
- bool exempt;
+ bool OverPenalty;
+
+ /** If this bool is set then penalty rules do not apply to this user
+ */
+ bool ExemptFromPenalty;
/** Default constructor
- * @throw Nothing at present
+ * @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
*/
- userrec(InspIRCd* Instance);
+ User(InspIRCd* Instance, const std::string &uid = "");
/** Returns the full displayed host of the user
* This member function returns the hostname of the user as seen by other users
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
* @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 = "");
+ static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
/** Add the user to WHOWAS system
*/
* 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();
/** 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,
+ * This will create a new User, insert it into the user_hash,
* initialize it as not yet registered, and add it to the socket engine.
* @param Instance a pointer to the server instance
* @param socket The socket id (file descriptor) this user is on
*/
unsigned long LocalCloneCount();
+ /** Remove all clone counts from the user, you should
+ * use this if you change the user's IP address in
+ * User::ip after they have registered.
+ */
+ void RemoveCloneCounts();
+
/** Write text to this user, appending CR/LF.
* @param text A std::string to send to the user
*/
* @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, ...);
/** 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, ...);
/** 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 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
+ * @param oper_text Oper only 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.
* @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);
/** 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 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
- * @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();
+ 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 SetOperQuit(const std::string &oquit);
+ /** Get oper-specific quit message shown only to opers when the user quits.
+ * (overrides any sent by QuitUser)
+ */
const char* GetOperQuit();
+ /** Increases a user's command penalty by a set amount.
+ */
+ void IncreasePenalty(int increase);
+
+ /** Decreases a user's command penalty by a set amount.
+ */
+ void DecreasePenalty(int decrease);
+
/** Handle socket event.
* From EventHandler class.
* @param et Event type
/** Default destructor
*/
- virtual ~userrec();
+ virtual ~User();
};
/* Configuration callbacks */
class ServerConfig;
#endif
+
projects / user / henk / code / inspircd.git / blobdiff