* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-#ifndef __USERS_H__
-#define __USERS_H__
+#ifndef __USERS_H__
+#define __USERS_H__
#include <string>
-#include "inspircd_config.h"
+#include "inspircd_config.h"
#include "socket.h"
#include "channels.h"
#include "inspstring.h"
#include "connection.h"
#include "hashcomp.h"
#include "dns.h"
-#include "cull_list.h"
enum ChanStatus {
STATUS_OP = 4,
UM_WALLOPS = 'w'-65,
UM_INVISIBLE = 'i'-65,
UM_OPERATOR = 'o'-65,
+ UM_SNOMASK = 'n'-65,
};
enum RegistrationState {
REG_ALL = 7 /* REG_NICKUSER plus next bit along */
};
-/** Holds a channel name to which a user has been invited.
- */
-class Invited : public classbase
-{
- public:
- irc::string channel;
-};
-
-
-
class InspIRCd;
/** Derived from Resolver, and performs user forward/reverse lookups.
userrec* bound_user;
int bound_fd;
bool fwd;
- InspIRCd* ServerInstance;
public:
- UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, bool forward);
+ UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
- void OnLookupComplete(const std::string &result);
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
void OnError(ResolverError e, const std::string &errormessage);
};
*/
class ConnectClass : public classbase
{
- public:
+ private:
/** Type of line, either CC_ALLOW or CC_DENY
*/
char type;
/** Max time to register the connection in seconds
*/
- int registration_timeout;
+ unsigned int registration_timeout;
/** Number of lines in buffer before excess flood is triggered
*/
- int flood;
+ unsigned int flood;
/** Host mask for this line
*/
std::string host;
/** Number of seconds between pings for this line
*/
- int pingtime;
+ unsigned int pingtime;
/** (Optional) Password for this line
*/
std::string pass;
/** Threshold value for flood disconnect
*/
- int threshold;
+ unsigned int threshold;
/** Maximum size of sendq for users in this class (bytes)
*/
- long sendqmax;
+ unsigned long sendqmax;
/** Maximum size of recvq for users in this class (bytes)
*/
- long recvqmax;
+ unsigned long recvqmax;
/** Local max when connecting by this connection class
*/
- long maxlocal;
+ unsigned long maxlocal;
/** Global max when connecting by this connection class
*/
- long maxglobal;
-
- ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
+ unsigned long maxglobal;
+
+public:
+
+ /** 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) { }
+
+ /** Create a new connect class to ALLOW connections.
+ * @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(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) :
+ type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
+ threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
+
+ /** Create a new connect class to DENY connections
+ * @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) { }
+
+ /** Returns the type, CC_ALLOW or CC_DENY
+ */
+ char GetType()
+ {
+ return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
+ }
+
+ /** Returns the registration timeout
+ */
+ unsigned int 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 host;
+ }
+
+ /** Returns the ping frequency
+ */
+ unsigned int GetPingTime()
+ {
+ 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 (sendqmax ? sendqmax : 262114);
+ }
+
+ /** Returns the maximum recvq value
+ */
+ unsigned long GetRecvqMax()
+ {
+ return (recvqmax ? recvqmax : 4096);
+ }
+
+ /** Returusn the maximum number of local sessions
+ */
+ unsigned long GetMaxLocal()
+ {
+ return (maxlocal ? maxlocal : 1);
+ }
+
+ /** Returns the maximum number of global sessions
+ */
+ unsigned long GetMaxGlobal()
+ {
+ return (maxglobal ? maxglobal : 1);
}
};
/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
*/
-typedef std::vector<Invited> InvitedList;
-
-
+typedef std::vector<irc::string> InvitedList;
/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
*/
/** Typedef for the list of user-channel records for a user
*/
-typedef std::vector<ucrec*> UserChanList;
+typedef std::map<chanrec*, char> UserChanList;
+typedef UserChanList::iterator UCListIter;
/** 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 Find method of the server class to locate a specific user
- * by nickname.
+ * 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.
*/
class userrec : public connection
{
private:
- /** Pointer to creator
+ /** 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
+ */
+ unsigned int ChannelCount;
+
+ /** Cached nick!ident@host value using the real hostname
+ */
+ char* cached_fullhost;
+
+ /** Cached nick!ident@ip value using the real IP address
+ */
+ char* cached_hostip;
+
+ /** Cached nick!ident@host value using the masked hostname
+ */
+ char* cached_makehost;
+ char* cached_fullrealhost;
+
+ /** 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();
public:
- /** Resolvers for looking up this users hostname
+ /** 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.
*/
UserResolver* res_forward;
/** Resolvers for looking up this users hostname
+ * This is instantiated by userrec::StartDNSLookup(),
+ * and on success, instantiates userrec::res_reverse.
*/
UserResolver* res_reverse;
std::string stored_host;
/** Starts a DNS lookup of the user's IP.
- * When complete, sets userrec::dns_done to true.
+ * This will cause two UserResolver classes to be instantiated.
+ * When complete, these objects set userrec::dns_done to true.
*/
void StartDNSLookup();
-
+
/** 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 users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
* This usually matches the value of userrec::host.
*/
char dhost[65];
-
- /** The users full name.
+
+ /** The users full name (GECOS).
*/
char fullname[MAXGECOS+1];
-
+
/** 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.
/** Channels this user is on, and the permissions they have there
*/
UserChanList chans;
-
+
/** The server the user is connected to.
*/
const char* server;
-
+
/** 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;
-
- /** Number of seconds this user is given to send USER/NICK
- * If they do not send their details in this time limit they
- * will be disconnected
+
+ /** Timestamp of current time + connection class timeout.
+ * This user must send USER/NICK before this timestamp is
+ * reached or they will be disconnected.
*/
- unsigned int timeout;
-
+ 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.
*/
char oper[NICKMAX];
- /** True when DNS lookups are completed.
- */
- bool dns_done;
+ /** True when DNS lookups are completed.
+ * The UserResolver classes res_forward and res_reverse will
+ * set this value once they complete.
+ */
+ bool dns_done;
/** Number of seconds between PINGs for this user (set from <connect:allow> tag
*/
*/
std::string sendq;
- /** Flood counters
+ /** Flood counters - lines received
*/
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;
- /** IPV4 ip address
+ /** 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
+ * alone will NOT cause the user to quit. This means it can be used seperately,
+ * for example by shun modules etc.
+ */
+ bool muted;
+
+ /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
+ * GetIPString/GetPort to obtain its values.
*/
sockaddr* ip;
*/
std::string WriteError;
- /** Maximum size this user's sendq can become
+ /** Maximum size this user's sendq can become.
+ * Copied from the connect class on connect.
*/
long sendqmax;
- /** Maximum size this user's recvq can become
+ /** Maximum size this user's recvq can become.
+ * Copied from the connect class on connect.
*/
long recvqmax;
+ /** 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).
+ */
+ bool exempt;
+
/** Default constructor
* @throw Nothing at present
*/
userrec(InspIRCd* Instance);
-
+
/** 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();
-
+
/** Returns the full real host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
*/
virtual char* GetFullRealHost();
+ /** This clears any cached results that are used for GetFullRealHost() etc.
+ * The results of these calls are cached as generating them can be generally expensive.
+ */
+ void InvalidateCache();
+
/** Create a displayable mode string for this users snomasks
* @return The notice mask character sequence
*/
/** Process a snomask modifier string, e.g. +abc-de
* @param sm A sequence of notice mask characters
- * @return True if the notice masks were successfully applied
+ * @return The cleaned mode sequence which can be output,
+ * e.g. in the above example if masks c and e are not
+ * valid, this function will return +ab-d
*/
- bool userrec::ProcessNoticeMasks(const char *sm);
+ std::string ProcessNoticeMasks(const char *sm);
/** Returns true if a notice mask is set
* @param sm A notice mask character to check
* @param value On or off setting of the mode
*/
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(irc::string &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
*/
- virtual void InviteTo(irc::string &channel);
-
+ virtual void InviteTo(const irc::string &channel);
+
/** 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(irc::string &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 to their oper classes and checking the commands they can execute.
* @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);
+ bool AddBuffer(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)
*/
char* MakeWildHost();
- /** Creates a host.
- * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
- * @param Buffer to fill with host information
+ /** Creates a usermask with real host.
+ * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
+ * @return the usermask in the format user@host
+ */
+ char* 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
*/
- void MakeHost(char* nhost);
+ char* 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();
/** Disconnect a user gracefully
* @param user The user to remove
- * @param r The quit reason
+ * @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);
+ static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
/** Add the user to WHOWAS system
*/
/** Use this method to fully connect a user.
* This will send the message of the day, check G/K/E lines, etc.
- * @param Goners If the user is disconnected by this method call, the
- * value of 'this' will be pushed onto this CullList. This is used by
- * the core to connect many users in rapid succession without invalidating
- * iterators.
*/
- void FullConnect(CullList* Goners);
+ void FullConnect();
/** Change this users hash key to a new string.
* You should not call this function directly. It is used by the core
/** 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, insp_inaddr ip);
+ 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
*/
- long GlobalCloneCount();
+ unsigned long GlobalCloneCount();
/** Return the number of local clones of this user
+ * @return The local clone count of this user
*/
- long LocalCloneCount();
+ unsigned long LocalCloneCount();
/** Write text to this user, appending CR/LF.
* @param text A std::string to send to the user
*/
- void Write(const std::string &text);
+ void Write(std::string text);
/** Write text to this user, appending CR/LF.
* @param text The format string for text to send to the user
*/
void WriteCommonExcept(const std::string &text);
+ 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
+ */
void WriteWallOps(const char* 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 text to send in the WALLOPS message
+ */
void WriteWallOps(const std::string &text);
+ /** Return true if the user shares at least one channel with another user
+ * @param other The other user to compare the channel list against
+ * @return True if the given user shares at least one channel with this user
+ */
bool SharesChannelWith(userrec *other);
+ /** Change the displayed host of a user.
+ * ALWAYS use this function, rather than writing userrec::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.
+ * @param host The new hostname to set
+ * @return True if the change succeeded, false if it didn't
+ */
bool ChangeDisplayedHost(const char* host);
+ /** Change the ident (username) of a user.
+ * ALWAYS use this function, rather than writing userrec::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
+ * @return True if the change succeeded, false if it didn't
+ */
+ bool ChangeIdent(const char* newident);
+
+ /** Change a users realname field.
+ * ALWAYS use this function, rather than writing userrec::fullname directly,
+ * as this triggers module events allowing the change to be syncronized to
+ * remote servers.
+ * @param gecos The user's new realname
+ * @return True if the change succeeded, false if otherwise
+ */
bool ChangeName(const char* gecos);
- int CountChannels();
+ /** 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
+ * you should use PRIVMSG or NOTICE.
+ * @param command the command to send
+ * @param text The text format string to send
+ * @param ... Format arguments
+ */
+ void SendAll(const char* command, char* text, ...);
+
+ /** 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);
- void NoticeAll(char* text, ...);
+ /** 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()
+ */
+ void SplitChanList(userrec* dest, const std::string &cl);
- /** Default destructor
+ /** 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!
*/
- virtual ~userrec();
-};
+ void PurgeEmptyChannels();
+ /** Get the connect class which matches this user's host or IP address
+ * @return A reference to this user's connect class
+ */
+ ConnectClass* GetClass();
-namespace irc
-{
- /** Holds whowas related functions and classes
+ /** Show the message of the day to this user
*/
- namespace whowas
- {
+ void ShowMOTD();
+
+ /** Show the server RULES file to this user
+ */
+ void ShowRULES();
+
+ /** Handle socket event.
+ * From EventHandler class.
+ * @param et Event type
+ * @param errornum Error number for EVENT_ERROR events
+ */
+ void HandleEvent(EventType et, int errornum = 0);
- /** Used to hold WHOWAS information
- */
- class WhoWasGroup : public classbase
- {
- public:
- /** Real host
- */
- char* host;
- /** Displayed host
- */
- char* dhost;
- /** Ident
- */
- char* ident;
- /** Server name
- */
- const char* server;
- /** Fullname (GECOS)
- */
- char* gecos;
- /** Signon time
- */
- time_t signon;
-
- /** Initialize this WhoQasFroup with a user
- */
- WhoWasGroup(userrec* user);
- /** Destructor
- */
- ~WhoWasGroup();
- };
-
- /** A group of users related by nickname
- */
- typedef std::deque<WhoWasGroup*> whowas_set;
-
- /** Sets of users in the whowas system
- */
- typedef std::map<irc::string,whowas_set*> whowas_users;
-
- /** Called every hour by the core to remove expired entries
- */
- void MaintainWhoWas(time_t TIME);
- };
+ /** Default destructor
+ */
+ virtual ~userrec();
};
/* Configuration callbacks */
class ServerConfig;
-bool InitTypes(ServerConfig* conf, const char* tag);
-bool InitClasses(ServerConfig* conf, const char* tag);
-bool DoType(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
#endif
projects / user / henk / code / inspircd.git / blobdiff