1 /* +------------------------------------+
\r * | Inspire Internet Relay Chat Daemon |
\r * +------------------------------------+
\r *
\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team
\r * See: http://www.inspircd.org/wiki/index.php/Credits
\r *
\r * This program is free but copyrighted software; see
\r * the file COPYING for details.
\r *
\r * ---------------------------------------------------
\r */
\r\r#ifndef __USERS_H__
\r#define __USERS_H__
\r\r#include <string>
\r#include "inspircd_config.h"
\r#include "socket.h"
\r#include "channels.h"
\r#include "inspstring.h"
\r#include "connection.h"
\r#include "hashcomp.h"
\r#include "dns.h"
\r\r/** Channel status for a user
\r */
\renum ChanStatus {
\r /** Op */
\r STATUS_OP = 4,
\r /** Halfop */
\r STATUS_HOP = 2,
\r /** Voice */
\r STATUS_VOICE = 1,
\r /** None */
\r STATUS_NORMAL = 0
\r};
\r\r/** connect class types
\r */
\renum ClassTypes {
\r /** connect:allow */
\r CC_ALLOW = 0,
\r /** connect:deny */
\r CC_DENY = 1
\r};
\r\r/** RFC1459 channel modes
\r */
\renum UserModes {
\r /** +s: Server notices */
\r UM_SERVERNOTICE = 's' - 65,
\r /** +w: WALLOPS */
\r UM_WALLOPS = 'w' - 65,
\r /** +i: Invisible */
\r UM_INVISIBLE = 'i' - 65,
\r /** +o: Operator */
\r UM_OPERATOR = 'o' - 65,
\r /** +n: Server notice mask */
\r UM_SNOMASK = 'n' - 65
\r};
\r\r/** Registration state of a user, e.g.
\r * have they sent USER, NICK, PASS yet?
\r */
\renum RegistrationState {
\r\r#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
\r REG_NONE = 0, /* Has sent nothing */
\r#endif
\r\r REG_USER = 1, /* Has sent USER */
\r REG_NICK = 2, /* Has sent NICK */
\r REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
\r REG_ALL = 7 /* REG_NICKUSER plus next bit along */
\r};
\r\r/* Required forward declaration */
\rclass InspIRCd;
\r\r/** Derived from Resolver, and performs user forward/reverse lookups.
\r */
\rclass CoreExport UserResolver : public Resolver
\r{
\r private:
\r /** User this class is 'attached' to.
\r */
\r userrec* bound_user;
\r /** File descriptor teh lookup is bound to
\r */
\r int bound_fd;
\r /** True if the lookup is forward, false if is a reverse lookup
\r */
\r bool fwd;
\r public:
\r /** Create a resolver.
\r * @param Instance The creating instance
\r * @param user The user to begin lookup on
\r * @param to_resolve The IP or host to resolve
\r * @param qt The query type
\r * @param cache Modified by the constructor if the result was cached
\r */
\r UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
\r\r /** Called on successful lookup
\r * @param result Result string
\r * @param ttl Time to live for result
\r * @param cached True if the result was found in the cache
\r */
\r void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
\r\r /** Called on failed lookup
\r * @param e Error code
\r * @param errormessage Error message string
\r */
\r void OnError(ResolverError e, const std::string &errormessage);
\r};
\r\r\r/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
\r */
\rclass CoreExport ConnectClass : public classbase
\r{
\r private:
\r /** Type of line, either CC_ALLOW or CC_DENY
\r */
\r char type;
\r /** Max time to register the connection in seconds
\r */
\r unsigned int registration_timeout;
\r /** Number of lines in buffer before excess flood is triggered
\r */
\r unsigned int flood;
\r /** Host mask for this line
\r */
\r std::string host;
\r /** Number of seconds between pings for this line
\r */
\r unsigned int pingtime;
\r /** (Optional) Password for this line
\r */
\r std::string pass;
\r\r /** Threshold value for flood disconnect
\r */
\r unsigned int threshold;
\r\r /** Maximum size of sendq for users in this class (bytes)
\r */
\r unsigned long sendqmax;
\r\r /** Maximum size of recvq for users in this class (bytes)
\r */
\r unsigned long recvqmax;
\r\r /** Local max when connecting by this connection class
\r */
\r unsigned long maxlocal;
\r\r /** Global max when connecting by this connection class
\r */
\r unsigned long maxglobal;
\r /** Port number this connect class applies to
\r */
\r int port;
\r\rpublic:
\r\r /** Create a new connect class with no settings.
\r */
\r ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
\r threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
\r\r /** Create a new connect class to ALLOW connections.
\r * @param timeout The registration timeout
\r * @param fld The flood value
\r * @param hst The IP mask to allow
\r * @param ping The ping frequency
\r * @param pas The password to be used
\r * @param thres The flooding threshold
\r * @param sendq The maximum sendq value
\r * @param recvq The maximum recvq value
\r * @param maxl The maximum local sessions
\r * @param maxg The maximum global sessions
\r */
\r ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
\r const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
\r unsigned long maxl, unsigned long maxg, int p = 0) :
\r type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
\r threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
\r\r /** Create a new connect class to DENY connections
\r * @param hst The IP mask to deny
\r */
\r ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
\r pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
\r\r /** Returns the type, CC_ALLOW or CC_DENY
\r */
\r char GetType()
\r {
\r return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
\r }
\r\r /** Returns the registration timeout
\r */
\r unsigned int GetRegTimeout()
\r {
\r return (registration_timeout ? registration_timeout : 90);
\r }
\r\r /** Returns the flood limit
\r */
\r unsigned int GetFlood()
\r {
\r return (threshold ? flood : 999);
\r }
\r\r /** Returns the allowed or denied IP mask
\r */
\r const std::string& GetHost()
\r {
\r return host;
\r }
\r\r int GetPort()
\r {
\r return port;
\r }
\r\r /** Returns the ping frequency
\r */
\r unsigned int GetPingTime()
\r {
\r return (pingtime ? pingtime : 120);
\r }
\r\r /** Returns the password or an empty string
\r */
\r const std::string& GetPass()
\r {
\r return pass;
\r }
\r\r /** Returns the flood threshold value
\r */
\r unsigned int GetThreshold()
\r {
\r return (threshold ? threshold : 1);
\r }
\r\r /** Returns the maximum sendq value
\r */
\r unsigned long GetSendqMax()
\r {
\r return (sendqmax ? sendqmax : 262114);
\r }
\r\r /** Returns the maximum recvq value
\r */
\r unsigned long GetRecvqMax()
\r {
\r return (recvqmax ? recvqmax : 4096);
\r }
\r\r /** Returusn the maximum number of local sessions
\r */
\r unsigned long GetMaxLocal()
\r {
\r return maxlocal;
\r }
\r\r /** Returns the maximum number of global sessions
\r */
\r unsigned long GetMaxGlobal()
\r {
\r return maxglobal;
\r }
\r};
\r\r/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
\r */
\rtypedef std::vector<irc::string> InvitedList;
\r\r/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
\r */
\rtypedef std::vector<ConnectClass> ClassVector;
\r\r/** Typedef for the list of user-channel records for a user
\r */
\rtypedef std::map<chanrec*, char> UserChanList;
\r\r/** Shorthand for an iterator into a UserChanList
\r */
\rtypedef UserChanList::iterator UCListIter;
\r\r/* Required forward declaration
\r */
\rclass userrec;
\r\r/** Visibility data for a user.
\r * If a user has a non-null instance of this class in their userrec,
\r * then it is used to determine if this user is visible to other users
\r * or not.
\r */
\rclass CoreExport VisData
\r{
\r public:
\r /** Create a visdata
\r */
\r VisData();
\r /** Destroy a visdata
\r */
\r virtual ~VisData();
\r /** Is this user visible to some other user?
\r * @param user The other user to compare to
\r * @return true True if the user is visible to the other user, false if not
\r */
\r virtual bool VisibleTo(userrec* user);
\r};
\r\r/** Holds all information about a user
\r * This class stores all information about a user connected to the irc server. Everything about a
\r * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
\r * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
\r * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
\r * file descriptor value.
\r */
\rclass CoreExport userrec : public connection
\r{
\r private:
\r /** Pointer to creator.
\r * This is required to make use of core functions
\r * from within the userrec class.
\r */
\r InspIRCd* ServerInstance;
\r\r /** A list of channels the user has a pending invite to.
\r * Upon INVITE channels are added, and upon JOIN, the
\r * channels are removed from this list.
\r */
\r InvitedList invites;
\r\r /** Number of channels this user is currently on
\r */
\r unsigned int ChannelCount;
\r\r /** Cached nick!ident@host value using the real hostname
\r */
\r char* cached_fullhost;
\r\r /** Cached nick!ident@ip value using the real IP address
\r */
\r char* cached_hostip;
\r\r /** Cached nick!ident@host value using the masked hostname
\r */
\r char* cached_makehost;
\r\r /** Cached nick!ident@realhost value using the real hostname
\r */
\r char* cached_fullrealhost;
\r\r /** When we erase the user (in the destructor),
\r * we call this method to subtract one from all
\r * mode characters this user is making use of.
\r */
\r void DecrementModes();
\r\r /** Oper-only quit message for this user if non-null
\r */
\r char* operquit;
\r\r public:
\r /** Resolvers for looking up this users IP address
\r * This will occur if and when res_reverse completes.
\r * When this class completes its lookup, userrec::dns_done
\r * will be set from false to true.
\r */
\r UserResolver* res_forward;
\r\r /** Resolvers for looking up this users hostname
\r * This is instantiated by userrec::StartDNSLookup(),
\r * and on success, instantiates userrec::res_reverse.
\r */
\r UserResolver* res_reverse;
\r\r /** User visibility state, see definition of VisData.
\r */
\r VisData* Visibility;
\r\r /** Stored reverse lookup from res_forward
\r */
\r std::string stored_host;
\r\r /** Starts a DNS lookup of the user's IP.
\r * This will cause two UserResolver classes to be instantiated.
\r * When complete, these objects set userrec::dns_done to true.
\r */
\r void StartDNSLookup();
\r\r /** The users nickname.
\r * An invalid nickname indicates an unregistered connection prior to the NICK command.
\r * Use InspIRCd::IsNick() to validate nicknames.
\r */
\r char nick[NICKMAX];
\r\r /** The users ident reply.
\r * Two characters are added to the user-defined limit to compensate for the tilde etc.
\r */
\r char ident[IDENTMAX+2];
\r\r /** The host displayed to non-opers (used for cloaking etc).
\r * This usually matches the value of userrec::host.
\r */
\r char dhost[65];
\r\r /** The users full name (GECOS).
\r */
\r char fullname[MAXGECOS+1];
\r\r /** The user's mode list.
\r * This is NOT a null terminated string! In the 1.1 version of InspIRCd
\r * this is an array of values in a similar way to channel modes.
\r * A value of 1 in field (modeletter-65) indicates that the mode is
\r * set, for example, to work out if mode +s is set, we check the field
\r * userrec::modes['s'-65] != 0.
\r * The following RFC characters o, w, s, i have constants defined via an
\r * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
\r */
\r char modes[64];
\r\r /** What snomasks are set on this user.
\r * This functions the same as the above modes.
\r */
\r char snomasks[64];
\r\r /** Channels this user is on, and the permissions they have there
\r */
\r UserChanList chans;
\r\r /** The server the user is connected to.
\r */
\r const char* server;
\r\r /** The user's away message.
\r * If this string is empty, the user is not marked as away.
\r */
\r char awaymsg[MAXAWAY+1];
\r\r /** Number of lines the user can place into the buffer
\r * (up to the global NetBufferSize bytes) before they
\r * are disconnected for excess flood
\r */
\r int flood;
\r\r /** Timestamp of current time + connection class timeout.
\r * This user must send USER/NICK before this timestamp is
\r * reached or they will be disconnected.
\r */
\r time_t timeout;
\r\r /** The oper type they logged in as, if they are an oper.
\r * This is used to check permissions in operclasses, so that
\r * we can say 'yay' or 'nay' to any commands they issue.
\r * The value of this is the value of a valid 'type name=' tag.
\r */
\r char oper[NICKMAX];
\r\r /** True when DNS lookups are completed.
\r * The UserResolver classes res_forward and res_reverse will
\r * set this value once they complete.
\r */
\r bool dns_done;
\r\r /** Number of seconds between PINGs for this user (set from <connect:allow> tag
\r */
\r unsigned int pingmax;
\r\r /** Password specified by the user when they registered.
\r * This is stored even if the <connect> block doesnt need a password, so that
\r * modules may check it.
\r */
\r char password[64];
\r\r /** User's receive queue.
\r * Lines from the IRCd awaiting processing are stored here.
\r * Upgraded april 2005, old system a bit hairy.
\r */
\r std::string recvq;
\r\r /** User's send queue.
\r * Lines waiting to be sent are stored here until their buffer is flushed.
\r */
\r std::string sendq;
\r\r /** Flood counters - lines received
\r */
\r int lines_in;
\r\r /** Flood counters - time lines_in is due to be reset
\r */
\r time_t reset_due;
\r\r /** Flood counters - Highest value lines_in may reach before the user gets disconnected
\r */
\r long threshold;
\r\r /** If this is set to true, then all read operations for the user
\r * are dropped into the bit-bucket.
\r * This is used by the global CullList, but please note that setting this value
\r * alone will NOT cause the user to quit. This means it can be used seperately,
\r * for example by shun modules etc.
\r */
\r bool muted;
\r\r /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
\r * GetIPString/GetPort to obtain its values.
\r */
\r sockaddr* ip;
\r\r /** Initialize the clients sockaddr
\r * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
\r * @param ip A human-readable IP address for this user matching the protcol_family
\r * @param port The port number of this user or zero for a remote user
\r */
\r void SetSockAddr(int protocol_family, const char* ip, int port);
\r\r /** Get port number from sockaddr
\r * @return The port number of this user.
\r */
\r int GetPort();
\r\r /** Get protocol family from sockaddr
\r * @return The protocol family of this user, either AF_INET or AF_INET6
\r */
\r int GetProtocolFamily();
\r\r /** Get IP string from sockaddr, using static internal buffer
\r * @return The IP string
\r */
\r const char* GetIPString();
\r\r /** Get IP string from sockaddr, using caller-specified buffer
\r * @param buf A buffer to use
\r * @return The IP string
\r */
\r const char* GetIPString(char* buf);
\r\r /* Write error string
\r */
\r std::string WriteError;
\r\r /** Maximum size this user's sendq can become.
\r * Copied from the connect class on connect.
\r */
\r long sendqmax;
\r\r /** Maximum size this user's recvq can become.
\r * Copied from the connect class on connect.
\r */
\r long recvqmax;
\r\r /** This is true if the user matched an exception when they connected to the ircd.
\r * It isnt valid after this point, and you should not attempt to do anything with it
\r * after this point, because the eline might be removed at a later time, and/or no
\r * longer be applicable to this user. It is only used to save doing the eline lookup
\r * twice (instead we do it once and set this value).
\r */
\r bool exempt;
\r\r /** Default constructor
\r * @throw Nothing at present
\r */
\r userrec(InspIRCd* Instance);
\r\r /** Returns the full displayed host of the user
\r * This member function returns the hostname of the user as seen by other users
\r * on the server, in nick!ident&at;host form.
\r * @return The full masked host of the user
\r */
\r virtual char* GetFullHost();
\r\r /** Returns the full real host of the user
\r * This member function returns the hostname of the user as seen by other users
\r * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
\r * e.g. through a module, then this method will ignore it and return the true hostname.
\r * @return The full real host of the user
\r */
\r virtual char* GetFullRealHost();
\r\r /** This clears any cached results that are used for GetFullRealHost() etc.
\r * The results of these calls are cached as generating them can be generally expensive.
\r */
\r void InvalidateCache();
\r\r /** Create a displayable mode string for this users snomasks
\r * @return The notice mask character sequence
\r */
\r const char* FormatNoticeMasks();
\r\r /** Process a snomask modifier string, e.g. +abc-de
\r * @param sm A sequence of notice mask characters
\r * @return The cleaned mode sequence which can be output,
\r * e.g. in the above example if masks c and e are not
\r * valid, this function will return +ab-d
\r */
\r std::string ProcessNoticeMasks(const char *sm);
\r\r /** Returns true if a notice mask is set
\r * @param sm A notice mask character to check
\r * @return True if the notice mask is set
\r */
\r bool IsNoticeMaskSet(unsigned char sm);
\r\r /** Changed a specific notice mask value
\r * @param sm The server notice mask to change
\r * @param value An on/off value for this mask
\r */
\r void SetNoticeMask(unsigned char sm, bool value);
\r\r /** Create a displayable mode string for this users umodes
\r * @param The mode string
\r */
\r const char* FormatModes();
\r\r /** Returns true if a specific mode is set
\r * @param m The user mode
\r * @return True if the mode is set
\r */
\r bool IsModeSet(unsigned char m);
\r\r /** Set a specific usermode to on or off
\r * @param m The user mode
\r * @param value On or off setting of the mode
\r */
\r void SetMode(unsigned char m, bool value);
\r\r /** Returns true if a user is invited to a channel.
\r * @param channel A channel name to look up
\r * @return True if the user is invited to the given channel
\r */
\r virtual bool IsInvited(const irc::string &channel);
\r\r /** Adds a channel to a users invite list (invites them to a channel)
\r * @param channel A channel name to add
\r */
\r virtual void InviteTo(const irc::string &channel);
\r\r /** Removes a channel from a users invite list.
\r * This member function is called on successfully joining an invite only channel
\r * to which the user has previously been invited, to clear the invitation.
\r * @param channel The channel to remove the invite to
\r */
\r virtual void RemoveInvite(const irc::string &channel);
\r\r /** Returns true or false for if a user can execute a privilaged oper command.
\r * This is done by looking up their oper type from userrec::oper, then referencing
\r * this to their oper classes and checking the commands they can execute.
\r * @param command A command (should be all CAPS)
\r * @return True if this user can execute the command
\r */
\r bool HasPermission(const std::string &command);
\r\r /** Calls read() to read some data for this user using their fd.
\r * @param buffer The buffer to read into
\r * @param size The size of data to read
\r * @return The number of bytes read, or -1 if an error occured.
\r */
\r int ReadData(void* buffer, size_t size);
\r\r /** This method adds data to the read buffer of the user.
\r * The buffer can grow to any size within limits of the available memory,
\r * managed by the size of a std::string, however if any individual line in
\r * the buffer grows over 600 bytes in length (which is 88 chars over the
\r * RFC-specified limit per line) then the method will return false and the
\r * text will not be inserted.
\r * @param a The string to add to the users read buffer
\r * @return True if the string was successfully added to the read buffer
\r */
\r bool AddBuffer(std::string a);
\r\r /** This method returns true if the buffer contains at least one carriage return
\r * character (e.g. one complete line may be read)
\r * @return True if there is at least one complete line in the users buffer
\r */
\r bool BufferIsReady();
\r\r /** This function clears the entire buffer by setting it to an empty string.
\r */
\r void ClearBuffer();
\r\r /** This method returns the first available string at the tail end of the buffer
\r * and advances the tail end of the buffer past the string. This means it is
\r * a one way operation in a similar way to strtok(), and multiple calls return
\r * multiple lines if they are available. The results of this function if there
\r * are no lines to be read are unknown, always use BufferIsReady() to check if
\r * it is ok to read the buffer before calling GetBuffer().
\r * @return The string at the tail end of this users buffer
\r */
\r std::string GetBuffer();
\r\r /** Sets the write error for a connection. This is done because the actual disconnect
\r * of a client may occur at an inopportune time such as half way through /LIST output.
\r * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
\r * errored clients purged.
\r * @param error The error string to set.
\r */
\r void SetWriteError(const std::string &error);
\r\r /** Returns the write error which last occured on this connection or an empty string
\r * if none occured.
\r * @return The error string which has occured for this user
\r */
\r const char* GetWriteError();
\r\r /** Adds to the user's write buffer.
\r * You may add any amount of text up to this users sendq value, if you exceed the
\r * sendq value, SetWriteError() will be called to set the users error string to
\r * "SendQ exceeded", and further buffer adds will be dropped.
\r * @param data The data to add to the write buffer
\r */
\r void AddWriteBuf(const std::string &data);
\r\r /** Flushes as much of the user's buffer to the file descriptor as possible.
\r * This function may not always flush the entire buffer, rather instead as much of it
\r * as it possibly can. If the send() call fails to send the entire buffer, the buffer
\r * position is advanced forwards and the rest of the data sent at the next call to
\r * this method.
\r */
\r void FlushWriteBuf();
\r\r /** Returns the list of channels this user has been invited to but has not yet joined.
\r * @return A list of channels the user is invited to
\r */
\r InvitedList* GetInviteList();
\r\r /** Creates a wildcard host.
\r * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
\r * @return The wildcarded hostname in *!*@host form
\r */
\r char* MakeWildHost();
\r\r /** Creates a usermask with real host.
\r * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
\r * @return the usermask in the format user@host
\r */
\r char* MakeHost();
\r\r /** Creates a usermask with real ip.
\r * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
\r * @return the usermask in the format user@ip
\r */
\r char* MakeHostIP();
\r\r /** Shuts down and closes the user's socket
\r * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
\r * which will call CloseSocket() for you.
\r */
\r void CloseSocket();
\r\r /** Disconnect a user gracefully
\r * @param user The user to remove
\r * @param r The quit reason to show to normal users
\r * @param oreason The quit reason to show to opers
\r * @return Although this function has no return type, on exit the user provided will no longer exist.
\r */
\r static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
\r\r /** Add the user to WHOWAS system
\r */
\r void AddToWhoWas();
\r\r /** Oper up the user using the given opertype.
\r * This will also give the +o usermode.
\r * @param opertype The oper type to oper as
\r */
\r void Oper(const std::string &opertype);
\r\r /** Call this method to find the matching <connect> for a user, and to check them against it.
\r */
\r void CheckClass();
\r\r /** Use this method to fully connect a user.
\r * This will send the message of the day, check G/K/E lines, etc.
\r */
\r void FullConnect();
\r\r /** Change this users hash key to a new string.
\r * You should not call this function directly. It is used by the core
\r * to update the users hash entry on a nickchange.
\r * @param New new user_hash key
\r * @return Pointer to userrec in hash (usually 'this')
\r */
\r userrec* UpdateNickHash(const char* New);
\r\r /** Force a nickname change.
\r * If the nickname change fails (for example, because the nick in question
\r * already exists) this function will return false, and you must then either
\r * output an error message, or quit the user for nickname collision.
\r * @param newnick The nickname to change to
\r * @return True if the nickchange was successful.
\r */
\r bool ForceNickChange(const char* newnick);
\r\r /** Add a client to the system.
\r * This will create a new userrec, insert it into the user_hash,
\r * initialize it as not yet registered, and add it to the socket engine.
\r * @param Instance a pointer to the server instance
\r * @param socket The socket id (file descriptor) this user is on
\r * @param port The port number this user connected on
\r * @param iscached This variable is reserved for future use
\r * @param ip The IP address of the user
\r * @return This function has no return value, but a call to AddClient may remove the user.
\r */
\r static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
\r\r /** Oper down.
\r * This will clear the +o usermode and unset the user's oper type
\r */
\r void UnOper();
\r\r /** Return the number of global clones of this user
\r * @return The global clone count of this user
\r */
\r unsigned long GlobalCloneCount();
\r\r /** Return the number of local clones of this user
\r * @return The local clone count of this user
\r */
\r unsigned long LocalCloneCount();
\r\r /** Remove all clone counts from the user, you should
\r * use this if you change the user's IP address in
\r * userrec::ip after they have registered.
\r */
\r void RemoveCloneCounts();
\r\r /** Write text to this user, appending CR/LF.
\r * @param text A std::string to send to the user
\r */
\r void Write(std::string text);
\r\r /** Write text to this user, appending CR/LF.
\r * @param text The format string for text to send to the user
\r * @param ... POD-type format arguments
\r */
\r void Write(const char *text, ...);
\r\r /** Write text to this user, appending CR/LF and prepending :server.name
\r * @param text A std::string to send to the user
\r */
\r void WriteServ(const std::string& text);
\r\r /** Write text to this user, appending CR/LF and prepending :server.name
\r * @param text The format string for text to send to the user
\r * @param ... POD-type format arguments
\r */
\r void WriteServ(const char* text, ...);
\r\r /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
\r * @param user The user to prepend the :nick!user@host of
\r * @param text A std::string to send to the user
\r */
\r void WriteFrom(userrec *user, const std::string &text);
\r\r /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
\r * @param user The user to prepend the :nick!user@host of
\r * @param text The format string for text to send to the user
\r * @param ... POD-type format arguments
\r */
\r void WriteFrom(userrec *user, const char* text, ...);
\r\r /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
\r * @param dest The user to route the message to
\r * @param text A std::string to send to the user
\r */
\r void WriteTo(userrec *dest, const std::string &data);
\r\r /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
\r * @param dest The user to route the message to
\r * @param text The format string for text to send to the user
\r * @param ... POD-type format arguments
\r */
\r void WriteTo(userrec *dest, const char *data, ...);
\r\r /** Write to all users that can see this user (including this user in the list), appending CR/LF
\r * @param text A std::string to send to the users
\r */
\r void WriteCommon(const std::string &text);
\r\r /** Write to all users that can see this user (including this user in the list), appending CR/LF
\r * @param text The format string for text to send to the users
\r * @param ... POD-type format arguments
\r */
\r void WriteCommon(const char* text, ...);
\r\r /** Write to all users that can see this user (not including this user in the list), appending CR/LF
\r * @param text The format string for text to send to the users
\r * @param ... POD-type format arguments
\r */
\r void WriteCommonExcept(const char* text, ...);
\r\r /** Write to all users that can see this user (not including this user in the list), appending CR/LF
\r * @param text A std::string to send to the users
\r */
\r void WriteCommonExcept(const std::string &text);
\r\r /** Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific
\r * quit message for opers only.
\r * @param normal_text Normal user quit message
\r * @param oper_text Oper only quit message
\r */
\r void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
\r\r /** Write a WALLOPS message from this user to all local opers.
\r * If this user is not opered, the function will return without doing anything.
\r * @param text The format string to send in the WALLOPS message
\r * @param ... Format arguments
\r */
\r void WriteWallOps(const char* text, ...);
\r\r /** Write a WALLOPS message from this user to all local opers.
\r * If this user is not opered, the function will return without doing anything.
\r * @param text The text to send in the WALLOPS message
\r */
\r void WriteWallOps(const std::string &text);
\r\r /** Return true if the user shares at least one channel with another user
\r * @param other The other user to compare the channel list against
\r * @return True if the given user shares at least one channel with this user
\r */
\r bool SharesChannelWith(userrec *other);
\r\r /** Change the displayed host of a user.
\r * ALWAYS use this function, rather than writing userrec::dhost directly,
\r * as this triggers module events allowing the change to be syncronized to
\r * remote servers. This will also emulate a QUIT and rejoin (where configured)
\r * before setting their host field.
\r * @param host The new hostname to set
\r * @return True if the change succeeded, false if it didn't
\r */
\r bool ChangeDisplayedHost(const char* host);
\r\r /** Change the ident (username) of a user.
\r * ALWAYS use this function, rather than writing userrec::ident directly,
\r * as this correctly causes the user to seem to quit (where configured)
\r * before setting their ident field.
\r * @param host The new ident to set
\r * @return True if the change succeeded, false if it didn't
\r */
\r bool ChangeIdent(const char* newident);
\r\r /** Change a users realname field.
\r * ALWAYS use this function, rather than writing userrec::fullname directly,
\r * as this triggers module events allowing the change to be syncronized to
\r * remote servers.
\r * @param gecos The user's new realname
\r * @return True if the change succeeded, false if otherwise
\r */
\r bool ChangeName(const char* gecos);
\r\r /** Send a command to all local users from this user
\r * The command given must be able to send text with the
\r * first parameter as a servermask (e.g. $*), so basically
\r * you should use PRIVMSG or NOTICE.
\r * @param command the command to send
\r * @param text The text format string to send
\r * @param ... Format arguments
\r */
\r void SendAll(const char* command, char* text, ...);
\r\r /** Compile a channel list for this user, and send it to the user 'source'
\r * Used internally by WHOIS
\r * @param The user to send the channel list to if it is not too long
\r * @return This user's channel list
\r */
\r std::string ChannelList(userrec* source);
\r\r /** Split the channel list in cl which came from dest, and spool it to this user
\r * Used internally by WHOIS
\r * @param dest The user the original channel list came from
\r * @param cl The channel list as a string obtained from userrec::ChannelList()
\r */
\r void SplitChanList(userrec* dest, const std::string &cl);
\r\r /** Remove this user from all channels they are on, and delete any that are now empty.
\r * This is used by QUIT, and will not send part messages!
\r */
\r void PurgeEmptyChannels();
\r\r /** Get the connect class which matches this user's host or IP address
\r * @return A reference to this user's connect class
\r */
\r ConnectClass* GetClass();
\r\r /** Show the message of the day to this user
\r */
\r void ShowMOTD();
\r\r /** Show the server RULES file to this user
\r */
\r void ShowRULES();
\r\r /** Set oper-specific quit message shown to opers only when the user quits
\r * (overrides any sent by QuitUser)
\r */
\r void SetOperQuit(const std::string &oquit);
\r\r /** Get oper-specific quit message shown only to opers when the user quits.
\r * (overrides any sent by QuitUser)
\r */
\r const char* GetOperQuit();
\r\r /** Handle socket event.
\r * From EventHandler class.
\r * @param et Event type
\r * @param errornum Error number for EVENT_ERROR events
\r */
\r void HandleEvent(EventType et, int errornum = 0);
\r\r /** Default destructor
\r */
\r virtual ~userrec();
\r};
\r\r/* Configuration callbacks */
\rclass ServerConfig;
\r\r#endif
\r\r
projects / user / henk / code / inspircd.git / blob