* | 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-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-#ifndef __USERS_H__
-#define __USERS_H__
+#ifndef __USERS_H__
+#define __USERS_H__
-#include <string>
-#include "inspircd_config.h"
#include "socket.h"
-#include "channels.h"
-#include "inspstring.h"
-#include "connection.h"
-#include "hashcomp.h"
+#include "inspsocket.h"
#include "dns.h"
-#include "cull_list.h"
-
-enum ChanStatus {
- STATUS_OP = 4,
- STATUS_HOP = 2,
- STATUS_VOICE = 1,
- STATUS_NORMAL = 0
-};
+#include "mode.h"
+/** 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,
+ /** +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
};
+/** 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 */
};
-/** Holds a channel name to which a user has been invited.
- */
-class Invited : public classbase
-{
- public:
- irc::string channel;
-};
-
-
-
-/** Derived from Resolver, and performs user forward/reverse lookups.
- */
-class UserResolver : public Resolver
-{
- private:
- /** User this class is 'attached' to.
- */
- userrec* bound_user;
- int bound_fd;
- bool fwd;
- public:
- UserResolver(userrec* user, std::string to_resolve, bool forward);
-
- void OnLookupComplete(const std::string &result);
- void OnError(ResolverError e, const std::string &errormessage);
-};
-
+/* Required forward declaration */
+class Channel;
+class UserResolver;
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class ConnectClass : public classbase
+struct CoreExport ConnectClass : public refcountbase
{
- public:
/** Type of line, either CC_ALLOW or CC_DENY
*/
char type;
- /** Max time to register the connection in seconds
+
+ /** Connect class name
*/
- int registration_timeout;
- /** Number of lines in buffer before excess flood is triggered
+ std::string name;
+
+ /** Max time to register the connection in seconds
*/
- int flood;
+ unsigned int registration_timeout;
+
/** 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
+ /** (Optional) Hash Method for this line
*/
- int threshold;
+ std::string hash;
/** Maximum size of sendq for users in this class (bytes)
+ * Users cannot send commands if they go over this limit
*/
- long sendqmax;
+ unsigned long softsendqmax;
+
+ /** Maximum size of sendq for users in this class (bytes)
+ * Users are killed if they go over this limit
+ */
+ unsigned long hardsendqmax;
/** 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;
+ unsigned long maxglobal;
+
+ /** Max channels for this class
+ */
+ unsigned int maxchans;
+
+ /** Port number this connect class applies to
+ */
+ int port;
+
+ /** How many users may be in this connect class before they are refused?
+ * (0 = no limit = default)
+ */
+ unsigned long limit;
+
+ /** Create a new connect class with no settings.
+ */
+ ConnectClass(char type, const std::string& mask);
+ /** Create a new connect class with inherited settings.
+ */
+ ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
- ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
+ /** Update the settings in this block to match the given block */
+ void Update(const ConnectClass* newSettings);
+
+
+ const std::string& GetName() { return name; }
+ const std::string& GetPass() { return pass; }
+ const std::string& GetHost() { return host; }
+ const int GetPort() { return port; }
+
+ /** Returns the registration timeout
+ */
+ time_t GetRegTimeout()
{
+ return (registration_timeout ? registration_timeout : 90);
}
-};
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
- */
-typedef std::vector<Invited> InvitedList;
+ /** Returns the ping frequency
+ */
+ unsigned int GetPingTime()
+ {
+ return (pingtime ? pingtime : 120);
+ }
+
+ /** Returns the maximum sendq value (soft limit)
+ * Note that this is in addition to internal OS buffers
+ */
+ unsigned long GetSendqSoftMax()
+ {
+ return (softsendqmax ? softsendqmax : 4096);
+ }
+
+ /** Returns the maximum sendq value (hard limit)
+ */
+ unsigned long GetSendqHardMax()
+ {
+ return (hardsendqmax ? hardsendqmax : 0x100000);
+ }
+
+ /** Returns the maximum recvq value
+ */
+ unsigned long GetRecvqMax()
+ {
+ return (recvqmax ? recvqmax : 4096);
+ }
+ /** Returusn the maximum number of local sessions
+ */
+ unsigned long GetMaxLocal()
+ {
+ return maxlocal;
+ }
+ /** Returns the maximum number of global sessions
+ */
+ unsigned long GetMaxGlobal()
+ {
+ return maxglobal;
+ }
+};
+
+/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
+ */
+CoreExport typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
*/
-typedef std::vector<ConnectClass> ClassVector;
+CoreExport typedef std::vector<reference<ConnectClass> > ClassVector;
/** Typedef for the list of user-channel records for a user
*/
-typedef std::vector<ucrec*> UserChanList;
+CoreExport typedef std::set<Channel*> UserChanList;
+
+/** Shorthand for an iterator into a UserChanList
+ */
+CoreExport typedef UserChanList::iterator UCListIter;
+
+/* Required forward declaration
+ */
+class User;
/** Holds all information about a user
* This class stores all information about a user connected to the irc server. Everything about a
* connection is stored here primarily, from the user's socket ID (file descriptor) through to the
- * user's nickname and hostname. Use the Find method of the server class to locate a specific user
- * by nickname.
+ * user's nickname and hostname.
*/
-class userrec : public connection
+class CoreExport User : public StreamSocket
{
private:
-
/** 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;
+
+ /** Cached nick!ident@dhost value using the displayed hostname
+ */
+ std::string cached_fullhost;
+
+ /** Cached ident@ip value using the real IP address
+ */
+ std::string cached_hostip;
+
+ /** Cached ident@realhost value using the real hostname
+ */
+ std::string cached_makehost;
+
+ /** Cached nick!ident@realhost value using the real hostname
+ */
+ std::string cached_fullrealhost;
+
+ /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
+ */
+ std::string cachedip;
+
+ /** 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();
+
+ std::set<std::string> *AllowedOperCommands;
+ std::set<std::string> *AllowedPrivs;
+
+ /** Allowed user modes from oper classes. */
+ std::bitset<64> AllowedUserModes;
+
+ /** Allowed channel modes from oper classes. */
+ std::bitset<64> AllowedChanModes;
+
public:
- /** Resolvers for looking up this users hostname
+ /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
+ */
+ reference<ConnectClass> MyClass;
+
+ /** Hostname of connection.
+ * This should be valid as per RFC1035.
+ */
+ std::string host;
+
+ /** Stats counter for bytes inbound
+ */
+ int bytes_in;
+
+ /** Stats counter for bytes outbound
+ */
+ int bytes_out;
+
+ /** Stats counter for commands inbound
+ */
+ int cmds_in;
+
+ /** Stats counter for commands outbound
+ */
+ int cmds_out;
+
+ /** True if user has authenticated, false if otherwise
+ */
+ bool haspassed;
+
+ /** Used by User to indicate the registration status of the connection
+ * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
+ * the connection state.
+ */
+ char registered;
+
+ /** Time the connection was last pinged
+ */
+ time_t lastping;
+
+ /** Time that the object was instantiated (used for TS calculation etc)
+ */
+ time_t age;
+
+ /** Time the connection was created, set in the constructor. This
+ * may be different from the time the user's classbase object was
+ * created.
+ */
+ time_t signon;
+
+ /** Time that the connection last sent a message, used to calculate idle time
+ */
+ time_t idle_lastmsg;
+
+ /** Used by PING checking code
+ */
+ time_t nping;
+
+ /** Stored reverse lookup from res_forward. Should not be used after resolution.
*/
- UserResolver* res_forward;
- UserResolver* res_reverse;
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 User::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];
-
+ std::string nick;
+
+ /** The user's unique identifier.
+ * This is the unique identifier which the user has across the network.
+ */
+ std::string uuid;
+
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
- char ident[IDENTMAX+2];
+ std::string ident;
/** The host displayed to non-opers (used for cloaking etc).
- * This usually matches the value of userrec::host.
+ * This usually matches the value of User::host.
*/
- char dhost[65];
-
- /** The users full name.
+ std::string dhost;
+
+ /** The users full name (GECOS).
*/
- char fullname[MAXGECOS+1];
-
+ std::string fullname;
+
/** The user's mode list.
- * This is NOT a null terminated string! In the 1.1 version of InspIRCd
- * this is an array of values in a similar way to channel modes.
- * A value of 1 in field (modeletter-65) indicates that the mode is
+ * NOT a null terminated string.
+ * Also NOT an array.
+ * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+ * if (modes[modeletter-65]) is set, then the mode is
* set, for example, to work out if mode +s is set, we check the field
- * userrec::modes['s'-65] != 0.
+ * User::modes['s'-65] != 0.
* The following RFC characters o, w, s, i have constants defined via an
* enum, such as UM_SERVERNOTICE and UM_OPETATOR.
*/
- char modes[64];
+ std::bitset<64> modes;
/** What snomasks are set on this user.
* This functions the same as the above modes.
*/
- char snomasks[64];
+ std::bitset<64> snomasks;
+ /** Channels this user is on, and the permissions they have there
+ */
UserChanList chans;
-
+
/** The server the user is connected to.
*/
- const char* server;
-
+ std::string 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
+ std::string awaymsg;
+
+ /** Time the user last went away.
+ * This is ONLY RELIABLE if user IS_AWAY()!
*/
- unsigned int timeout;
-
+ time_t awaytime;
+
/** The oper type they logged in as, if they are an oper.
* This is used to check permissions in operclasses, so that
* we can say 'yay' or 'nay' to any commands they issue.
* The value of this is the value of a valid 'type name=' tag.
*/
- char oper[NICKMAX];
-
- /** True when DNS lookups are completed.
- */
- bool dns_done;
+ std::string oper;
- /** Number of seconds between PINGs for this user (set from <connect:allow> tag
+ /** True when DNS lookups are completed.
+ * The UserResolver classes res_forward and res_reverse will
+ * set this value once they complete.
*/
- unsigned int pingmax;
+ bool dns_done;
/** Password specified by the user when they registered.
* This is stored even if the <connect> block doesnt need a password, so that
* modules may check it.
*/
- char password[64];
+ std::string password;
- /** User's receive queue.
- * Lines from the IRCd awaiting processing are stored here.
- * Upgraded april 2005, old system a bit hairy.
+ /** Whether or not to send an snotice about this user's quitting
*/
- std::string recvq;
+ bool quietquit;
- /** User's send queue.
- * Lines waiting to be sent are stored here until their buffer is flushed.
+ /** 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.
+ * Please note that setting this value alone will NOT cause the user to quit.
*/
- std::string sendq;
+ bool quitting;
- /** Flood counters
+ /** Server address and port that this user is connected to.
+ * If unknown, address family is AF_UNKNOWN
*/
- int lines_in;
- time_t reset_due;
- long threshold;
-
- /** IPV4 ip address
- */
- sockaddr* ip;
-
- /** Initialize the clients sockaddr
+ irc::sockets::sockaddrs server_sa;
+ /** Client address that the user is connected from.
+ * Port number is only valid if local.
+ *
+ * Do not modify this value directly, use SetClientIP() to change it
*/
- void SetSockAddr(int protocol_family, const char* ip, int port);
+ irc::sockets::sockaddrs client_sa;
- /** Get port number from sockaddr
+ /** Sets the client IP for this user
+ * @return true if the conversion was successful
*/
- int GetPort();
+ bool SetClientIP(const char* sip);
- /** Get protocol family from sockaddr
+ /**
+ * @return The port number of this user.
*/
- int GetProtocolFamily();
+ int GetServerPort();
- /** Get IP string from sockaddr, using static internal buffer
+ /** Get client IP string from sockaddr, using static internal buffer
+ * @return The IP string
*/
const char* GetIPString();
- /** Get IP string from sockaddr, using caller-specified buffer
+ /** Get a CIDR mask from the IP of this user, using a static internal buffer.
+ * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
+ * This may be used for CIDR clone detection, etc.
+ *
+ * (XXX, brief note: when we do the sockets rewrite, this should move down a
+ * level so it may be used on more derived objects. -- w00t)
*/
- const char* GetIPString(char* buf);
+ const char *GetCIDRMask(int range);
- /* Write error string
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
- std::string WriteError;
+ bool exempt;
- /** Maximum size this user's sendq can become
+ /** This value contains how far into the penalty threshold the user is. Once its over
+ * the penalty threshold then commands are held and processed on-timer.
*/
- long sendqmax;
+ int Penalty;
- /** Maximum size this user's recvq can become
+ /** Default constructor
+ * @throw CoreException if the UID allocated to the user already exists
+ * @param Instance Creator instance
+ * @param uid User UUID, or empty to allocate one automatically
*/
- long recvqmax;
+ User(const std::string &uid = "");
- /** Default constructor
+ /** 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.
*/
- userrec();
-
+ 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
* on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
* 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();
- /*
- * Create a displayable mode string for this users umodes
+ /** 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
*/
const char* FormatNoticeMasks();
- bool userrec::ProcessNoticeMasks(const char *sm);
+ /** Process a snomask modifier string, e.g. +abc-de
+ * @param sm A sequence of notice mask characters
+ * @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
+ */
+ std::string ProcessNoticeMasks(const char *sm);
+ /** Returns true if a notice mask is set
+ * @param sm A notice mask character to check
+ * @return True if the notice mask is set
+ */
bool IsNoticeMaskSet(unsigned char sm);
+ /** Changed a specific notice mask value
+ * @param sm The server notice mask to change
+ * @param value An on/off value for this mask
+ */
void SetNoticeMask(unsigned char sm, bool value);
- /*
- * Create a displayable mode string for this users umodes
+ /** 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
+ * @return True if the mode is set
+ */
bool IsModeSet(unsigned char m);
+ /** Set a specific usermode to on or off
+ * @param m The user mode
+ * @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
+ * @param timeout When the invite should expire (0 == never)
*/
- virtual void InviteTo(irc::string &channel);
-
+ virtual void InviteTo(const irc::string &channel, time_t timeout);
+
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
* 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 is done by looking up their oper type from User::oper, then referencing
* this to their oper classes and checking the commands they can execute.
+ * @param command A command (should be all CAPS)
+ * @return True if this user can execute the command
*/
bool HasPermission(const std::string &command);
- /** Calls read() to read some data for this user using their fd.
+ /** 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.
*/
- int ReadData(void* buffer, size_t size);
+ bool HasPrivPermission(const std::string &privstr, bool noisy = false);
- /** This method adds data to the buffer of the user.
- * The buffer can grow to any size within limits of the available memory,
- * managed by the size of a std::string, however if any individual line in
- * the buffer grows over 600 bytes in length (which is 88 chars over the
- * RFC-specified limit per line) then the method will return false and the
- * text will not be inserted.
+ /** Returns true or false if a user can set a privileged user or channel mode.
+ * This is done by looking up their oper type from User::oper, then referencing
+ * this to their oper classes, and checking the modes they can set.
+ * @param mode The mode the check
+ * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
+ * @return True if the user can set or unset this mode.
*/
- bool AddBuffer(const std::string &a);
+ bool HasModePermission(unsigned char mode, ModeType type);
- /** This method returns true if the buffer contains at least one carriage return
- * character (e.g. one complete line may be read)
+ /** 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, the user will be removed, and further buffer adds will be dropped.
+ * @param data The data to add to the write buffer
*/
- bool BufferIsReady();
+ void AddWriteBuf(const std::string &data);
- /** This function clears the entire buffer by setting it to an empty string.
+ /** Returns the list of channels this user has been invited to but has not yet joined.
+ * @return A list of channels the user is invited to
*/
- void ClearBuffer();
+ InvitedList* GetInviteList();
- /** This method returns the first available string at the tail end of the buffer
- * and advances the tail end of the buffer past the string. This means it is
- * a one way operation in a similar way to strtok(), and multiple calls return
- * multiple lines if they are available. The results of this function if there
- * are no lines to be read are unknown, always use BufferIsReady() to check if
- * it is ok to read the buffer before calling GetBuffer().
+ /** Creates a wildcard host.
+ * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
+ * @return The wildcarded hostname in *!*@host form
*/
- std::string GetBuffer();
+ char* MakeWildHost();
- /** 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.
+ /** 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
*/
- void SetWriteError(const std::string &error);
+ const std::string& MakeHost();
- /** Returns the write error which last occured on this connection or an empty string
- * if none occured.
+ /** 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
*/
- const char* GetWriteError();
+ const std::string& MakeHostIP();
- /** 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.
+ /** Add the user to WHOWAS system
*/
- void AddWriteBuf(const std::string &data);
+ void AddToWhoWas();
- /** Flushes as much of the user's buffer to the file descriptor as possible.
- * This function may not always flush the entire buffer, rather instead as much of it
- * as it possibly can. If the send() call fails to send the entire buffer, the buffer
- * position is advanced forwards and the rest of the data sent at the next call to
- * this method.
+ /** Oper up the user using the given opertype.
+ * This will also give the +o usermode.
+ * @param opertype The oper type to oper as
*/
- void FlushWriteBuf();
+ void Oper(const std::string &opertype, const std::string &opername);
- /** Returns the list of channels this user has been invited to but has not yet joined.
+ /** Call this method to find the matching <connect> for a user, and to check them against it.
*/
- InvitedList* GetInviteList();
+ void CheckClass();
- /** Creates a wildcard host.
- * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
+ /** Use this method to fully connect a user.
+ * This will send the message of the day, check G/K/E lines, etc.
*/
- char* MakeWildHost();
+ void FullConnect();
- /** Creates a host.
- * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
+ /** Change this users hash key to a new string.
+ * 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 User in hash (usually 'this')
*/
- void MakeHost(char* nhost);
+ User* UpdateNickHash(const char* New);
- /** Shuts down and closes the user's socket
+ /** Force a nickname change.
+ * If the nickname change fails (for example, because the nick in question
+ * already exists) this function will return false, and you must then either
+ * output an error message, or quit the user for nickname collision.
+ * @param newnick The nickname to change to
+ * @return True if the nickchange was successful.
*/
- void CloseSocket();
+ bool ForceNickChange(const char* newnick);
- /** Disconnect a user gracefully
+ /** Oper down.
+ * This will clear the +o usermode and unset the user's oper type
*/
- static void QuitUser(userrec *user, const std::string &r);
+ void UnOper();
- void AddToWhoWas();
+ /** Write text to this user, appending CR/LF.
+ * @param text A std::string to send to the user
+ */
+ void Write(const std::string &text);
+
+ /** Write text to this user, appending CR/LF.
+ * @param text The format string for text to send to the user
+ * @param ... POD-type format arguments
+ */
+ void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Write text to this user, appending CR/LF and prepending :server.name
+ * @param text A std::string to send to the user
+ */
+ void WriteServ(const std::string& text);
+
+ /** Write text to this user, appending CR/LF and prepending :server.name
+ * @param text The format string for text to send to the user
+ * @param ... POD-type format arguments
+ */
+ void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ void WriteNumeric(unsigned int numeric, const std::string &text);
+
+ /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
+ * @param user The user to prepend the :nick!user@host of
+ * @param text A std::string to send to the user
+ */
+ void WriteFrom(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(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
+ * @param dest The user to route the message to
+ * @param text A std::string to send to the user
+ */
+ void WriteTo(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(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
+
+ /** Write to all users that can see this user (including this user in the list), appending CR/LF
+ * @param text A std::string to send to the users
+ */
+ void WriteCommonRaw(const std::string &line, bool include_self = true);
+
+ /** Write to all users that can see this user (including this user in the list), appending CR/LF
+ * @param text The format string for text to send to the users
+ * @param ... POD-type format arguments
+ */
+ void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Write to all users that can see this user (not including this user in the list), appending CR/LF
+ * @param text The format string for text to send to the users
+ * @param ... POD-type format arguments
+ */
+ void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ /** 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.
+ * 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, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Write a WALLOPS message from this user to all local opers.
+ * If this user is not opered, the function will return without doing anything.
+ * @param 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(User *other);
+
+ /** Send fake quit/join messages for host or ident cycle.
+ * Run this after the item in question has changed.
+ * You should not need to use this function, call ChangeDisplayedHost instead
+ *
+ * @param The entire QUIT line, including the source using the old value
+ */
+ void DoHostCycle(const std::string &quitline);
+
+ /** Change the displayed host of a user.
+ * ALWAYS use this function, rather than writing 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.
+ * @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 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
+ * @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 User::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);
+
+ /** 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, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ /** Compile a channel list for this user. Used internally by WHOIS
+ * @param source The user to prepare the channel list for
+ * @param spy Whether to return the spy channel list rather than the normal one
+ * @return This user's channel list
+ */
+ std::string ChannelList(User* source, bool spy);
+
+ /** 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 User::ChannelList()
+ */
+ 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 this user belongs to.
+ * @return A pointer to this user's connect class
+ */
+ 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 ShowMOTD();
+
+ /** Show the server RULES file to this user
+ */
+ void ShowRULES();
+
+ /** 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);
+
+ void OnDataReady();
+ void OnError(BufferedSocketError error);
/** Default destructor
*/
- virtual ~userrec();
+ virtual ~User();
+ virtual bool cull();
};
-/** Used to hold WHOWAS information
+/** Derived from Resolver, and performs user forward/reverse lookups.
*/
-class WhoWasGroup : public classbase
+class CoreExport UserResolver : public Resolver
{
+ private:
+ /** User this class is 'attached' to.
+ */
+ User* bound_user;
+ /** File descriptor teh lookup is bound to
+ */
+ int bound_fd;
+ /** True if the lookup is forward, false if is a reverse lookup
+ */
+ bool fwd;
public:
- char* host;
- char* dhost;
- char* ident;
- const char* server;
- char* gecos;
- time_t signon;
+ /** 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(User* user, std::string to_resolve, QueryType qt, bool &cache);
- WhoWasGroup(userrec* user);
- ~WhoWasGroup();
-};
+ /** Called on successful lookup
+ * @param result Result string
+ * @param ttl Time to live for result
+ * @param cached True if the result was found in the cache
+ */
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
-typedef std::deque<WhoWasGroup*> whowas_set;
-typedef std::map<irc::string,whowas_set*> whowas_users;
-
-void AddOper(userrec* user);
-void DeleteOper(userrec* user);
-//void kill_link(userrec *user,const char* r);
-void MaintainWhoWas(time_t TIME);
-void AddClient(int socket, int port, bool iscached, insp_inaddr ip4);
-void FullConnectUser(userrec* user, CullList* Goners);
-userrec* ReHashNick(const char* Old, const char* New);
-void force_nickchange(userrec* user,const char* newnick);
-
-/* Configuration callbacks */
-bool InitTypes(const char* tag);
-bool InitClasses(const char* tag);
-bool DoType(const char* tag, char** entries, void** values, int* types);
-bool DoClass(const char* tag, char** entries, void** values, int* types);
-bool DoneClassesAndTypes(const char* tag);
-
-long FindMatchingGlobal(userrec* user);
-long FindMatchingLocal(userrec* user);
+ /** Called on failed lookup
+ * @param e Error code
+ * @param errormessage Error message string
+ */
+ void OnError(ResolverError e, const std::string &errormessage);
+};
#endif
projects / user / henk / code / inspircd.git / blobdiff