-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Burlex <???@???>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef __USERS_H__
-#define __USERS_H__
-#include <string>
-#include "inspircd_config.h"
+#pragma once
+
#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,
- STATUS_HOP = 2,
- STATUS_VOICE = 1,
- STATUS_NORMAL = 0
-};
+#include "inspsocket.h"
+#include "mode.h"
+#include "membership.h"
+/** connect class types
+ */
enum ClassTypes {
+ /** connect:allow */
CC_ALLOW = 0,
- CC_DENY = 1
-};
-
-/** RFC1459 channel modes
- * */
-enum UserModes {
- UM_SERVERNOTICE = 's'-65,
- UM_WALLOPS = 'w'-65,
- UM_INVISIBLE = 'i'-65,
- UM_OPERATOR = 'o'-65,
- UM_SNOMASK = 'n'-65,
+ /** connect:deny */
+ CC_DENY = 1,
+ /** named connect block (for opers, etc) */
+ CC_NAMED = 2
};
+/** 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 */
};
-class InspIRCd;
-
-/** 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(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt);
-
- void OnLookupComplete(const std::string &result);
- void OnError(ResolverError e, const std::string &errormessage);
+enum UserType {
+ USERTYPE_LOCAL = 1,
+ USERTYPE_REMOTE = 2,
+ USERTYPE_SERVER = 3
};
-
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class ConnectClass : public classbase
+struct CoreExport ConnectClass : public refcountbase
{
- private:
+ reference<ConfigTag> config;
/** Type of line, either CC_ALLOW or CC_DENY
*/
char type;
+
+ /** True if this class uses fake lag to manage flood, false if it kills */
+ bool fakelag;
+
+ /** Connect class name
+ */
+ std::string name;
+
/** Max time to register the connection in seconds
*/
unsigned int registration_timeout;
- /** Number of lines in buffer before excess flood is triggered
- */
- unsigned int flood;
+
/** Host mask for this line
*/
std::string host;
+
/** Number of seconds between pings for this line
*/
unsigned int pingtime;
- /** (Optional) Password for this line
- */
- std::string pass;
- /** Threshold value for flood disconnect
+ /** Maximum size of sendq for users in this class (bytes)
+ * Users cannot send commands if they go over this limit
*/
- unsigned int threshold;
+ unsigned long softsendqmax;
/** Maximum size of sendq for users in this class (bytes)
+ * Users are killed if they go over this limit
*/
- unsigned long sendqmax;
+ unsigned long hardsendqmax;
/** Maximum size of recvq for users in this class (bytes)
*/
unsigned long recvqmax;
+ /** Seconds worth of penalty before penalty system activates
+ */
+ unsigned int penaltythreshold;
+
+ /** Maximum rate of commands (units: millicommands per second) */
+ unsigned int commandrate;
+
/** Local max when connecting by this connection class
*/
unsigned long maxlocal;
*/
unsigned long maxglobal;
-public:
+ /** True if max connections for this class is hit and a warning is wanted
+ */
+ bool maxconnwarn;
- ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
- threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+ /** Max channels for this class
+ */
+ unsigned int maxchans;
- 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) { }
+ /** How many users may be in this connect class before they are refused?
+ * (0 = no limit = default)
+ */
+ unsigned long limit;
- 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) { }
+ /** If set to true, no user DNS lookups are to be performed
+ */
+ bool resolvehostnames;
- char GetType()
- {
- return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
- }
+ /** Create a new connect class with no settings.
+ */
+ ConnectClass(ConfigTag* tag, char type, const std::string& mask);
+ /** Create a new connect class with inherited settings.
+ */
+ ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
- unsigned int GetRegTimeout()
- {
- return (registration_timeout ? registration_timeout : 90);
- }
+ /** Update the settings in this block to match the given block */
+ void Update(const ConnectClass* newSettings);
- unsigned int GetFlood()
- {
- return (threshold ? flood : 999);
- }
+ const std::string& GetName() { return name; }
+ const std::string& GetHost() { return host; }
- const std::string& GetHost()
+ /** Returns the registration timeout
+ */
+ time_t GetRegTimeout()
{
- return host;
+ return (registration_timeout ? registration_timeout : 90);
}
+ /** Returns the ping frequency
+ */
unsigned int GetPingTime()
{
return (pingtime ? pingtime : 120);
}
- const std::string& GetPass()
+ /** Returns the maximum sendq value (soft limit)
+ * Note that this is in addition to internal OS buffers
+ */
+ unsigned long GetSendqSoftMax()
{
- return pass;
+ return (softsendqmax ? softsendqmax : 4096);
}
- unsigned int GetThreshold()
+ /** Returns the maximum sendq value (hard limit)
+ */
+ unsigned long GetSendqHardMax()
{
- return (threshold ? threshold : 1);
+ return (hardsendqmax ? hardsendqmax : 0x100000);
}
- unsigned long GetSendqMax()
+ /** Returns the maximum recvq value
+ */
+ unsigned long GetRecvqMax()
{
- return (sendqmax ? sendqmax : 262114);
+ return (recvqmax ? recvqmax : 4096);
}
- unsigned long GetRecvqMax()
+ /** Returns the penalty threshold value
+ */
+ unsigned int GetPenaltyThreshold()
{
- return (recvqmax ? recvqmax : 4096);
+ return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
}
+ unsigned int GetCommandRate()
+ {
+ return commandrate ? commandrate : 1000;
+ }
+
+ /** Return the maximum number of local sessions
+ */
unsigned long GetMaxLocal()
{
- return (maxlocal ? maxlocal : 1);
+ return maxlocal;
}
+ /** Returns the maximum number of global sessions
+ */
unsigned long GetMaxGlobal()
{
- return (maxglobal ? maxglobal : 1);
+ return maxglobal;
}
};
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
- */
-typedef std::vector<irc::string> InvitedList;
-
-/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
- */
-typedef std::vector<ConnectClass> ClassVector;
-
-/** Typedef for the list of user-channel records for a user
- */
-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 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.
+ * user's nickname and hostname.
*/
-class userrec : public connection
+class CoreExport User : public Extensible
{
private:
- /** Pointer to creator.
- * This is required to make use of core functions
- * from within the userrec class.
+ /** Cached nick!ident@dhost value using the displayed hostname
*/
- InspIRCd* ServerInstance;
+ std::string cached_fullhost;
- /** 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.
+ /** Cached ident@ip value using the real IP address
*/
- InvitedList invites;
+ std::string cached_hostip;
- /** Number of channels this user is currently on
+ /** Cached ident@realhost value using the real hostname
*/
- unsigned int ChannelCount;
+ std::string cached_makehost;
- char* cached_fullhost;
- char* cached_hostip;
- char* cached_makehost;
- char* cached_fullrealhost;
- public:
- /** 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.
+ /** Cached nick!ident@realhost value using the real hostname
*/
- UserResolver* res_forward;
+ std::string cached_fullrealhost;
- /** Resolvers for looking up this users hostname
- * This is instantiated by userrec::StartDNSLookup(),
- * and on success, instantiates userrec::res_reverse.
+ /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
*/
- UserResolver* res_reverse;
+ std::string cachedip;
- /** Stored reverse lookup from res_forward
+ /** The user's mode list.
+ * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+ * if (modes[modeid]) is set, then the mode is set.
+ * For example, to work out if mode +i is set, we check the field
+ * User::modes[invisiblemode->modeid] == true.
*/
- std::string stored_host;
+ std::bitset<ModeParser::MODEID_MAX> modes;
- /** Starts a DNS lookup of the user's IP.
- * This will cause two UserResolver classes to be instantiated.
- * When complete, these objects set userrec::dns_done to true.
- */
- 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.
+ public:
+ /** To execute a function for each local neighbor of a user, inherit from this class and
+ * pass an instance of it to User::ForEachNeighbor().
*/
- char ident[IDENTMAX+2];
+ class ForEachNeighborHandler
+ {
+ public:
+ /** Method to execute for each local neighbor of a user.
+ * Derived classes must implement this.
+ * @param user Current neighbor
+ */
+ virtual void Execute(LocalUser* user) = 0;
+ };
- /** The host displayed to non-opers (used for cloaking etc).
- * This usually matches the value of userrec::host.
+ /** List of Memberships for this user
*/
- char dhost[65];
-
- /** 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.
- * A value of 1 in field (modeletter-65) indicates that the mode is
- * set, for example, to work out if mode +s is set, we check the field
- * userrec::modes['s'-65] != 0.
- * The following RFC characters o, w, s, i have constants defined via an
- * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
- */
- char modes[64];
+ typedef insp::intrusive_list<Membership> ChanList;
- /** What snomasks are set on this user.
- * This functions the same as the above modes.
+ /** Hostname of connection.
+ * This should be valid as per RFC1035.
*/
- char snomasks[64];
+ std::string host;
- /** 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;
-
- /** Timestamp of current time + connection class timeout.
- * This user must send USER/NICK before this timestamp is
- * reached or they will be disconnected.
+ /** 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 timeout;
-
- /** The oper type they logged in as, if they are an oper.
- * This is used to check permissions in operclasses, so that
- * we can say 'yay' or 'nay' to any commands they issue.
- * The value of this is the value of a valid 'type name=' tag.
+ time_t signon;
+
+ /** Client address that the user is connected from.
+ * Do not modify this value directly, use SetClientIP() to change it.
+ * Port is not valid for remote users.
*/
- char oper[NICKMAX];
+ irc::sockets::sockaddrs client_sa;
- /** True when DNS lookups are completed.
- * The UserResolver classes res_forward and res_reverse will
- * set this value once they complete.
+ /** The users nickname.
+ * An invalid nickname indicates an unregistered connection prior to the NICK command.
+ * Use InspIRCd::IsNick() to validate nicknames.
*/
- bool dns_done;
+ std::string nick;
- /** Number of seconds between PINGs for this user (set from <connect:allow> tag
+ /** The user's unique identifier.
+ * This is the unique identifier which the user has across the network.
*/
- unsigned int pingmax;
+ const std::string uuid;
- /** 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.
+ /** The users ident reply.
+ * Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
- char password[64];
+ std::string ident;
- /** User's receive queue.
- * Lines from the IRCd awaiting processing are stored here.
- * Upgraded april 2005, old system a bit hairy.
+ /** The host displayed to non-opers (used for cloaking etc).
+ * This usually matches the value of User::host.
*/
- std::string recvq;
+ std::string dhost;
- /** User's send queue.
- * Lines waiting to be sent are stored here until their buffer is flushed.
+ /** The users full name (GECOS).
*/
- std::string sendq;
+ std::string fullname;
- /** Flood counters - lines received
+ /** What snomasks are set on this user.
+ * This functions the same as the above modes.
*/
- int lines_in;
+ std::bitset<64> snomasks;
- /** Flood counters - time lines_in is due to be reset
+ /** Channels this user is on
*/
- time_t reset_due;
+ ChanList chans;
- /** Flood counters - Highest value lines_in may reach before the user gets disconnected
+ /** The server the user is connected to.
*/
- long threshold;
+ Server* server;
- /** IPV4 or IPV6 ip address
+ /** The user's away message.
+ * If this string is empty, the user is not marked as away.
*/
- sockaddr* ip;
+ std::string awaymsg;
- /** Initialize the clients sockaddr
- * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
- * @param ip A human-readable IP address for this user matching the protcol_family
- * @param port The port number of this user or zero for a remote user
+ /** Time the user last went away.
+ * This is ONLY RELIABLE if user IsAway()!
*/
- void SetSockAddr(int protocol_family, const char* ip, int port);
+ time_t awaytime;
- /** Get port number from sockaddr
- * @return The port number of this user.
+ /** The oper type they logged in as, if they are an oper.
*/
- int GetPort();
+ reference<OperInfo> oper;
- /** Get protocol family from sockaddr
- * @return The protocol family of this user, either AF_INET or AF_INET6
+ /** 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.
*/
- int GetProtocolFamily();
+ unsigned int registered:3;
- /** Get IP string from sockaddr, using static internal buffer
- * @return The IP string
+ /** 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.
*/
- const char* GetIPString();
+ unsigned int quitting:1;
- /** Get IP string from sockaddr, using caller-specified buffer
- * @param buf A buffer to use
+ /** What type of user is this? */
+ const unsigned int usertype:2;
+
+ /** Get client IP string from sockaddr, using static internal buffer
* @return The IP string
*/
- const char* GetIPString(char* buf);
+ const std::string& GetIPString();
- /* Write error string
+ /** Get CIDR mask, using default range, for this user
*/
- std::string WriteError;
+ irc::sockets::cidr_mask GetCIDRMask();
- /** Maximum size this user's sendq can become
+ /** Sets the client IP for this user
+ * @return true if the conversion was successful
*/
- long sendqmax;
+ virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
- /** Maximum size this user's recvq can become
- */
- long recvqmax;
+ virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
- /** 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).
+ /** Constructor
+ * @throw CoreException if the UID allocated to the user already exists
*/
- bool exempt;
+ User(const std::string& uid, Server* srv, int objtype);
- /** 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.
+ * on the server, in nick!ident\@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,
+ * on the server, in nick!ident\@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();
/** 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
+ /** Returns whether this user is currently away or not. If true,
+ * further information can be found in User::awaymsg and User::awaytime
+ * @return True if the user is away, false otherwise
*/
- const char* FormatNoticeMasks();
+ bool IsAway() const { return (!awaymsg.empty()); }
- /** 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
+ /** Returns whether this user is an oper or not. If true,
+ * oper information can be obtained from User::oper
+ * @return True if the user is an oper, false otherwise
*/
- std::string ProcessNoticeMasks(const char *sm);
+ bool IsOper() const { return oper; }
/** Returns true if a notice mask is set
* @param sm A notice mask character to check
*/
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
- * @param The mode string
+ * @param showparameters 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);
+ bool IsModeSet(ModeHandler* mh);
+ bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
+ bool IsModeSet(UserModeReference& moderef);
/** 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(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(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(const irc::string &channel);
-
+ void SetMode(ModeHandler* mh, bool value);
+ void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
+
/** 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.
- * @param buffer The buffer to read into
- * @param size The size of data to read
- * @return The number of bytes read, or -1 if an error occured.
- */
- int ReadData(void* buffer, size_t size);
+ virtual bool HasPermission(const std::string &command);
- /** This method adds data to the read 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.
- * @param a The string to add to the users read buffer
- * @return True if the string was successfully added to the read buffer
+ /** Returns true if a user has a given permission.
+ * This is used to check whether or not users may perform certain actions which admins may not wish to give to
+ * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
+ *
+ * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
+ * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
+ * @return True if this user has the permission in question.
*/
- bool AddBuffer(std::string a);
+ virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
- /** This method returns true if the buffer contains at least one carriage return
- * character (e.g. one complete line may be read)
- * @return True if there is at least one complete line in the users buffer
+ /** 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 BufferIsReady();
-
- /** This function clears the entire buffer by setting it to an empty string.
- */
- void ClearBuffer();
-
- /** 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().
- * @return The string at the tail end of this users buffer
- */
- std::string GetBuffer();
-
- /** Sets the write error for a connection. This is done because the actual disconnect
- * of a client may occur at an inopportune time such as half way through /LIST output.
- * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
- * errored clients purged.
- * @param error The error string to set.
- */
- void SetWriteError(const std::string &error);
-
- /** Returns the write error which last occured on this connection or an empty string
- * if none occured.
- * @return The error string which has occured for this user
- */
- const char* GetWriteError();
-
- /** Adds to the user's write buffer.
- * You may add any amount of text up to this users sendq value, if you exceed the
- * sendq value, SetWriteError() will be called to set the users error string to
- * "SendQ exceeded", and further buffer adds will be dropped.
- * @param data The data to add to the write buffer
- */
- void AddWriteBuf(const std::string &data);
-
- /** 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.
- */
- void FlushWriteBuf();
-
- /** 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
- */
- InvitedList* GetInviteList();
-
- /** 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
- */
- char* MakeWildHost();
+ virtual bool HasModePermission(unsigned char mode, ModeType type);
/** 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
+ * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
+ * @return the usermask in the format user\@host
*/
- char* MakeHost();
+ const std::string& MakeHost();
/** Creates a usermask with real ip.
- * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
- * @return the usermask in the format user@ip
+ * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
+ * @return the usermask in the format user\@ip
*/
- char* MakeHostIP();
-
- /** 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
- * @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);
-
- /** Add the user to WHOWAS system
- */
- void AddToWhoWas();
+ const std::string& MakeHostIP();
/** Oper up the user using the given opertype.
* This will also give the +o usermode.
- * @param opertype The oper type to oper as
*/
- void Oper(const std::string &opertype);
-
- /** 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.
- * @param Goners a CullList to use for failed connections
- */
- void FullConnect(CullList* Goners);
-
- /** 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 userrec in hash (usually 'this')
- */
- userrec* UpdateNickHash(const char* New);
-
- /** 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.
- */
- bool ForceNickChange(const char* newnick);
-
- /** 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);
+ void Oper(OperInfo* info);
/** 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
- */
- unsigned long GlobalCloneCount();
-
- /** Return the number of local clones of this user
- * @return The local clone count of this user
- */
- unsigned long LocalCloneCount();
-
- /** Write text to this user, appending CR/LF.
+ /** Write text to this user, appending CR/LF. Works on local users only.
* @param text A std::string to send to the user
*/
- void Write(std::string text);
+ virtual void Write(const std::string &text);
/** Write text to this user, appending CR/LF.
+ * Works on local users only.
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void Write(const char *text, ...);
+ virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
/** Write text to this user, appending CR/LF and prepending :server.name
+ * Works on local users only.
* @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
+ * Works on local users only.
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteServ(const char* text, ...);
+ void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
- /** 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
+ /** Sends a command to this user.
+ * @param command The command to be sent.
+ * @param text The message to send.
*/
- void WriteFrom(userrec *user, const std::string &text);
+ void WriteCommand(const char* command, 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
+ /** Sends a server notice to this user.
+ * @param text The contents of the message to send.
*/
- void WriteFrom(userrec *user, const char* text, ...);
+ void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
+
+ /** Send a NOTICE message from the local server to the user.
+ * @param text Text to send
+ */
+ virtual void WriteRemoteNotice(const std::string& text);
+
+ virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
+
+ template <typename T1>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ WriteRemoteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4, typename T5>
+ void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ n.push(p5);
+ WriteRemoteNumeric(n);
+ }
+
+ void WriteNumeric(const Numeric::Numeric& numeric);
+
+ template <typename T1>
+ void WriteNumeric(unsigned int numeric, T1 p1)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ WriteNumeric(n);
+ }
- /** 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
+ template <typename T1, typename T2, typename T3, typename T4>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ WriteNumeric(n);
+ }
+
+ template <typename T1, typename T2, typename T3, typename T4, typename T5>
+ void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+ {
+ Numeric::Numeric n(numeric);
+ n.push(p1);
+ n.push(p2);
+ n.push(p3);
+ n.push(p4);
+ n.push(p5);
+ WriteNumeric(n);
+ }
+
+ /** 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 WriteTo(userrec *dest, const std::string &data);
+ void WriteFrom(User *user, const std::string &text);
- /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
- * @param dest The user to route the message to
+ /** 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 WriteTo(userrec *dest, const char *data, ...);
+ void WriteFrom(User *user, const char* text, ...) 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
+ /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
+ * @param line A std::string to send to the users
+ * @param include_self Should the message be sent back to the author?
*/
- void WriteCommon(const std::string &text);
+ 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, ...);
+ 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
+ /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
+ * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
+ * This function is used for example to send something conditionally to neighbors, or to send different messages
+ * to different users depending on their oper status.
+ * @param handler Function object to call, inherited from ForEachNeighborHandler.
+ * @param include_self True to include this user in the set of neighbors, false otherwise.
+ * Modules may override this. Has no effect if this user is not local.
*/
- void WriteCommonExcept(const char* text, ...);
+ void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
- /** Write to all users that can see this user (not including this user in the list), appending CR/LF
- * @param text A std::string to send to the users
+ /** Write to the user, routing the line if the user is remote.
*/
- void WriteCommonExcept(const std::string &text);
+ virtual void SendText(const std::string& line) = 0;
- /** 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
+ /** Write to the user, routing the line if the user is remote.
*/
- 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);
+ void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** 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);
+ bool SharesChannelWith(User *other);
/** Change the displayed host of a user.
- * ALWAYS use this function, rather than writing userrec::dhost directly,
+ * ALWAYS use this function, rather than writing User::dhost directly,
* as this triggers module events allowing the change to be syncronized to
- * remote servers. This will also emulate a QUIT and rejoin (where configured)
- * before setting their host field.
+ * remote servers.
* @param host The new hostname to set
* @return True if the change succeeded, false if it didn't
+ * (a module vetoed the change).
*/
- bool ChangeDisplayedHost(const char* host);
+ bool ChangeDisplayedHost(const std::string& 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
+ * ALWAYS use this function, rather than writing User::ident directly,
+ * as this triggers module events allowing the change to be syncronized to
+ * remote servers.
+ * @param newident The new ident to set
* @return True if the change succeeded, false if it didn't
*/
- bool ChangeIdent(const char* newident);
+ bool ChangeIdent(const std::string& newident);
/** Change a users realname field.
- * ALWAYS use this function, rather than writing userrec::fullname directly,
+ * ALWAYS use this function, rather than writing User::fullname directly,
* as this triggers module events allowing the change to be syncronized to
* remote servers.
* @param gecos The user's new realname
* @return True if the change succeeded, false if otherwise
*/
- bool ChangeName(const char* gecos);
+ bool ChangeName(const std::string& gecos);
- /** Send a notice to all local users from this user
- * @param text The text format string to send
- * @param ... Format arguments
+ /** Change a user's nick
+ * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
+ * @return True if the change succeeded
*/
- void NoticeAll(char* text, ...);
+ bool ChangeNick(const std::string& newnick, time_t newts = 0);
- /** 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
+ /** 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!
*/
- std::string ChannelList(userrec* source);
+ void PurgeEmptyChannels();
- /** 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()
+ /** Default destructor
*/
- void SplitChanList(userrec* dest, const std::string &cl);
+ virtual ~User();
+ virtual CullResult cull();
+};
- /** 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!
+class CoreExport UserIOHandler : public StreamSocket
+{
+ public:
+ LocalUser* const user;
+ UserIOHandler(LocalUser* me) : user(me) {}
+ void OnDataReady();
+ void OnError(BufferedSocketError error);
+
+ /** 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
*/
- void PurgeEmptyChannels();
+ void AddWriteBuf(const std::string &data);
+};
+
+typedef unsigned int already_sent_t;
- /** Get the connect class which matches this user's host or IP address
- * @return A reference to this user's connect class
+class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
+{
+ public:
+ LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+ CullResult cull();
+
+ UserIOHandler eh;
+
+ /** Stats counter for bytes inbound
*/
- ConnectClass* GetClass();
+ unsigned int bytes_in;
- /** Show the message of the day to this user
+ /** Stats counter for bytes outbound
*/
- void ShowMOTD();
+ unsigned int bytes_out;
- /** Show the server RULES file to this user
+ /** Stats counter for commands inbound
*/
- void ShowRULES();
+ unsigned int cmds_in;
- /** Handle socket event.
- * From EventHandler class.
+ /** Stats counter for commands outbound
*/
- void HandleEvent(EventType et, int errornum = 0);
+ unsigned int cmds_out;
- /** Default destructor
+ /** Password specified by the user when they registered (if any).
+ * This is stored even if the \<connect> block doesnt need a password, so that
+ * modules may check it.
*/
- virtual ~userrec();
-};
+ std::string password;
+ /** Contains a pointer to the connect class a user is on from
+ */
+ reference<ConnectClass> MyClass;
-namespace irc
-{
- /** Holds whowas related functions and classes
+ /** Get the connect class which this user belongs to.
+ * @return A pointer to this user's connect class.
*/
- namespace whowas
- {
+ ConnectClass* GetClass() const { return MyClass; }
- /** 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;
+ /** Call this method to find the matching \<connect> for a user, and to check them against it.
+ */
+ void CheckClass(bool clone_count = true);
- /** Sets of users in the whowas system
- */
- typedef std::map<irc::string,whowas_set*> whowas_users;
+ /** Server address and port that this user is connected to.
+ */
+ irc::sockets::sockaddrs server_sa;
- /** Sets of time and users in whowas list
- */
- typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
+ /**
+ * @return The port number of this user.
+ */
+ int GetServerPort();
- /** Called every hour by the core to remove expired entries
- */
- void MaintainWhoWas(InspIRCd* ServerInstance, time_t TIME);
+ /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
+ * This can't be handled normally because QuitUser itself calls Write on other
+ * users, which could trigger their SendQ to overrun.
+ */
+ unsigned int quitting_sendq:1;
- /** Prune for WhoWasGroupSize, WhoWasMaxGroups and
- * WhoWasMaxKeep on rehash
- */
- void PruneWhoWas(InspIRCd* ServerInstance, time_t TIME);
- };
+ /** has the user responded to their previous ping?
+ */
+ unsigned int lastping:1;
+
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
+ */
+ unsigned int exempt:1;
+
+ /** Used by PING checking code
+ */
+ time_t nping;
+
+ /** Time that the connection last sent a message, used to calculate idle time
+ */
+ time_t idle_lastmsg;
+
+ /** This value contains how far into the penalty threshold the user is.
+ * This is used either to enable fake lag or for excess flood quits
+ */
+ unsigned int CommandFloodPenalty;
+
+ already_sent_t already_sent;
+
+ /** Check if the user matches a G or K line, and disconnect them if they do.
+ * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
+ * Returns true if the user matched a ban, false else.
+ */
+ bool CheckLines(bool doZline = false);
+
+ /** Use this method to fully connect a user.
+ * This will send the message of the day, check G/K/E lines, etc.
+ */
+ void FullConnect();
+
+ /** 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.
+ */
+ void SetClass(const std::string &explicit_name = "");
+
+ bool SetClientIP(const char* sip, bool recheck_eline = true);
+
+ void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
+
+ void SendText(const std::string& line);
+ void Write(const std::string& text);
+ void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
+
+ /** Send a NOTICE message from the local server to the user.
+ * The message will be sent even if the user is connected to a remote server.
+ * @param text Text to send
+ */
+ void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE;
+
+ /** Returns true or false for if a user can execute a privilaged oper command.
+ * 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);
+
+ /** Returns true if a user has a given permission.
+ * This is used to check whether or not users may perform certain actions which admins may not wish to give to
+ * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
+ *
+ * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
+ * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
+ * @return True if this user has the permission in question.
+ */
+ bool HasPrivPermission(const std::string &privstr, bool noisy = false);
+
+ /** Returns true or false if a user can set a privileged user or channel mode.
+ * This is done by looking up their oper type from User::oper, then referencing
+ * this to their oper classes, and checking the modes they can set.
+ * @param 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 HasModePermission(unsigned char mode, ModeType type);
};
-/* Configuration callbacks */
-class ServerConfig;
+class CoreExport RemoteUser : public User
+{
+ public:
+ RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
+ {
+ }
+ virtual void SendText(const std::string& line);
+};
-#endif
+class CoreExport FakeUser : public User
+{
+ public:
+ FakeUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_SERVER)
+ {
+ nick = srv->GetName();
+ }
+
+ FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
+ : User(uid, new Server(sname, sdesc), USERTYPE_SERVER)
+ {
+ nick = sname;
+ }
+
+ virtual CullResult cull();
+ virtual void SendText(const std::string& line);
+ virtual const std::string& GetFullHost();
+ virtual const std::string& GetFullRealHost();
+};
+
+/* Faster than dynamic_cast */
+/** Is a local user */
+inline LocalUser* IS_LOCAL(User* u)
+{
+ return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
+}
+/** Is a remote user */
+inline RemoteUser* IS_REMOTE(User* u)
+{
+ return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
+}
+/** Is a server fakeuser */
+inline FakeUser* IS_SERVER(User* u)
+{
+ return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
+}
+
+inline bool User::IsModeSet(ModeHandler* mh)
+{
+ return (modes[mh->GetId()]);
+}
+
+inline bool User::IsModeSet(UserModeReference& moderef)
+{
+ if (!moderef)
+ return false;
+ return IsModeSet(*moderef);
+}
+
+inline void User::SetMode(ModeHandler* mh, bool value)
+{
+ modes[mh->GetId()] = value;
+}
projects / user / henk / code / inspircd.git / blobdiff