X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fusers.h;h=def7a146d9dd5907493cfa2510428fab2e207fd3;hb=09c5439c02f31e9875083e51966dad535af005a9;hp=76337b2c337edfec83f3c7a5e0ea27b5db7b69c6;hpb=7107ec12d8640d35cfe3d5002db1bc1deb33625d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/users.h b/include/users.h index 76337b2c3..88858b160 100644 --- a/include/users.h +++ b/include/users.h @@ -1,23 +1,33 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2008 Thomas Stagner + * Copyright (C) 2003-2007 Craig Edwards + * Copyright (C) 2007 Burlex + * Copyright (C) 2007 Dennis Friis * - * 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 . */ -#ifndef __USERS_H__ -#define __USERS_H__ + +#pragma once #include "socket.h" #include "inspsocket.h" -#include "dns.h" #include "mode.h" +#include "membership.h" /** connect class types */ @@ -25,20 +35,9 @@ enum ClassTypes { /** connect:allow */ CC_ALLOW = 0, /** connect:deny */ - CC_DENY = 1 -}; - -/** RFC1459 channel modes - */ -enum UserModes { - /** +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 + CC_DENY = 1, + /** named connect block (for opers, etc) */ + CC_NAMED = 2 }; /** Registration state of a user, e.g. @@ -46,7 +45,7 @@ enum UserModes { */ enum RegistrationState { -#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0. +#ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0. REG_NONE = 0, /* Has sent nothing */ #endif @@ -56,18 +55,24 @@ enum RegistrationState { REG_ALL = 7 /* REG_NICKUSER plus next bit along */ }; -/* Required forward declaration */ -class Channel; -class UserResolver; +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. */ -struct CoreExport ConnectClass : public classbase +struct CoreExport ConnectClass : public refcountbase { + reference 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; @@ -84,14 +89,6 @@ struct CoreExport ConnectClass : public classbase */ unsigned int pingtime; - /** (Optional) Password for this line - */ - std::string pass; - - /** (Optional) Hash Method for this line - */ - std::string hash; - /** Maximum size of sendq for users in this class (bytes) * Users cannot send commands if they go over this limit */ @@ -106,6 +103,13 @@ struct CoreExport ConnectClass : public classbase */ 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; @@ -114,41 +118,41 @@ struct CoreExport ConnectClass : public classbase */ unsigned long maxglobal; - /** Max channels for this class + /** True if max connections for this class is hit and a warning is wanted */ - unsigned int maxchans; + bool maxconnwarn; - /** Port number this connect class applies to + /** Max channels for this class */ - int port; + unsigned int maxchans; /** How many users may be in this connect class before they are refused? * (0 = no limit = default) */ unsigned long limit; - /** Reference counter. - * This will be 1 if no users are connected, as long as it is a valid connect block - * When it reaches 0, the object should be deleted + /** If set to true, no user DNS lookups are to be performed */ - unsigned long RefCount; + bool resolvehostnames; + + /** + * If non-empty the server ports which this user has to be using + */ + insp::flat_set ports; /** Create a new connect class with no settings. */ - ConnectClass(char type, const std::string& mask); + ConnectClass(ConfigTag* tag, 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(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent); + /** 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() @@ -185,7 +189,19 @@ struct CoreExport ConnectClass : public classbase return (recvqmax ? recvqmax : 4096); } - /** Returusn the maximum number of local sessions + /** Returns the penalty threshold value + */ + unsigned int GetPenaltyThreshold() + { + return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20); + } + + unsigned int GetCommandRate() + { + return commandrate ? commandrate : 1000; + } + + /** Return the maximum number of local sessions */ unsigned long GetMaxLocal() { @@ -200,40 +216,14 @@ struct CoreExport ConnectClass : public classbase } }; -/** 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. - */ -typedef std::vector< std::pair > InvitedList; - -/** Holds a complete list of all allow and deny tags from the configuration file (connection classes) - */ -typedef std::vector ClassVector; - -/** Typedef for the list of user-channel records for a user - */ -typedef std::set UserChanList; - -/** Shorthand for an iterator into a UserChanList - */ -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. */ -class CoreExport User : public StreamSocket +class CoreExport User : public Extensible { 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; @@ -254,64 +244,37 @@ class CoreExport User : public StreamSocket */ 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(); + /** If set then the hostname which is displayed to users. */ + std::string displayhost; - std::set *AllowedOperCommands; - std::set *AllowedPrivs; + /** The real hostname of this user. */ + std::string realhost; - /** Allowed user modes from oper classes. */ - std::bitset<64> AllowedUserModes; - - /** Allowed channel modes from oper classes. */ - std::bitset<64> AllowedChanModes; - - public: - static LocalIntExt NICKForced; - static LocalStringExt OperQuit; - - /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections. - * The pointer is guarenteed to *always* be valid. :) - */ - ConnectClass *MyClass; - - /** 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 + /** 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. */ - bool haspassed; + std::bitset modes; - /** 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. + 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 registered; + 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; + }; - /** Time the connection was last pinged + /** List of Memberships for this user */ - time_t lastping; + typedef insp::intrusive_list ChanList; /** Time that the object was instantiated (used for TS calculation etc) */ @@ -323,23 +286,11 @@ class CoreExport User : public StreamSocket */ 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. - */ - 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. + /** 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. */ - void StartDNSLookup(); + irc::sockets::sockaddrs client_sa; /** The users nickname. * An invalid nickname indicates an unregistered connection prior to the NICK command. @@ -350,46 +301,29 @@ class CoreExport User : public StreamSocket /** The user's unique identifier. * This is the unique identifier which the user has across the network. */ - std::string uuid; + const std::string uuid; /** The users ident reply. * Two characters are added to the user-defined limit to compensate for the tilde etc. */ std::string ident; - /** The host displayed to non-opers (used for cloaking etc). - * This usually matches the value of User::host. - */ - std::string dhost; - /** The users full name (GECOS). */ std::string fullname; - /** The user's mode list. - * 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 - * 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. - */ - std::bitset<64> modes; - /** What snomasks are set on this user. * This functions the same as the above modes. */ std::bitset<64> snomasks; - /** Channels this user is on, and the permissions they have there + /** Channels this user is on */ - UserChanList chans; + ChanList chans; /** The server the user is connected to. */ - const char* server; + Server* server; /** The user's away message. * If this string is empty, the user is not marked as away. @@ -397,133 +331,93 @@ class CoreExport User : public StreamSocket std::string awaymsg; /** Time the user last went away. - * This is ONLY RELIABLE if user IS_AWAY()! + * This is ONLY RELIABLE if user IsAway()! */ 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. */ - std::string oper; + reference oper; - /** True when DNS lookups are completed. - * The UserResolver classes res_forward and res_reverse will - * set this value once they complete. - */ - bool dns_done; - - /** Password specified by the user when they registered. - * This is stored even if the block doesnt need a password, so that - * modules may check it. - */ - std::string password; - - /** Whether or not to send an snotice about this user's quitting + /** 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. */ - bool quietquit; + unsigned int registered:3; /** 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. */ - bool quitting; - - /** Server address and port that this user is connected to. - * If unknown, address family is AF_UNKNOWN - */ - 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 - */ - irc::sockets::sockaddrs client_sa; - - /** Sets the client IP for this user - * @return true if the conversion was successful - */ - bool SetClientIP(const char* sip); + unsigned int quitting:1; - /** - * @return The port number of this user. - */ - int GetServerPort(); - /** - * @return The server IP address - */ - std::string GetServerIP(); + /** What type of user is this? */ + const UserType usertype:2; /** Get client IP string from sockaddr, using static internal buffer * @return The IP string */ - const char* GetIPString(); + const std::string& GetIPString(); - /** 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) + /** Retrieves this user's hostname. + * @param uncloak If true then return the real host; otherwise, the display host. */ - const char *GetCIDRMask(int range); + const std::string& GetHost(bool uncloak) const; - /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. - */ - bool exempt; + /** Retrieves this user's displayed hostname. */ + const std::string& GetDisplayedHost() const; - /** 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. + /** Retrieves this user's real hostname. */ + const std::string& GetRealHost() const; + + /** Get CIDR mask, using default range, for this user */ - int Penalty; + irc::sockets::cidr_mask GetCIDRMask(); - /** 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 + /** Sets the client IP for this user + * @return true if the conversion was successful */ - User(const std::string &uid = ""); + virtual bool SetClientIP(const std::string& address, bool recheck_eline = true); - /** 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. + virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true); + + /** Constructor + * @throw CoreException if the UID allocated to the user already exists */ - bool CheckLines(bool doZline = false); + User(const std::string& uid, Server* srv, UserType objtype); /** 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 const std::string 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 const std::string 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 @@ -531,47 +425,28 @@ class CoreExport User : public StreamSocket */ 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 + /** Get the mode letters of modes set on the user as a string. + * @param includeparams True to get the parameters of the modes as well. Defaults to false. + * @return Mode letters of modes set on the user and optionally the parameters of those modes, if any. + * The returned string always begins with a '+' character. If the user has no modes set, "+" is returned. */ - void SetNoticeMask(unsigned char sm, bool value); - - /** Create a displayable mode string for this users umodes - * @param The mode string - */ - const char* FormatModes(bool showparameters = false); + std::string GetModeLetters(bool includeparams = false) const; /** 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(unsigned char m) const; + bool IsModeSet(const ModeHandler* mh) const; + bool IsModeSet(const ModeHandler& mh) const { return IsModeSet(&mh); } + bool IsModeSet(UserModeReference& moderef) const; /** Set a specific usermode to on or off - * @param m The user mode + * @param mh 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 - * @param timeout When the invite should expire (0 == never) - */ - 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(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 User::oper, then referencing @@ -579,7 +454,7 @@ class CoreExport User : public StreamSocket * @param command A command (should be all CAPS) * @return True if this user can execute the command */ - bool HasPermission(const std::string &command); + virtual 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 @@ -589,144 +464,201 @@ class CoreExport User : public StreamSocket * @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); + virtual 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). + * @param mh Mode to check * @return True if the user can set or unset this mode. */ - bool HasModePermission(unsigned char mode, ModeType type); - - /** 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 AddWriteBuf(const std::string &data); - - /** 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(const ModeHandler* mh) const; /** 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 */ 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 */ const std::string& MakeHostIP(); - /** Add the user to WHOWAS system - */ - void AddToWhoWas(); - /** 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, const std::string &opername); - - /** Call this method to find the matching for a user, and to check them against it. - */ - void CheckClass(); - - /** Use this method to fully connect a user. - * This will send the message of the day, check G/K/E lines, etc. - */ - void FullConnect(); - - /** 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') - */ - User* 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); + void Oper(OperInfo* info); /** Oper down. * This will clear the +o usermode and unset the user's oper type */ void UnOper(); - /** 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(const 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, ...) CUSTOM_PRINTF(2, 3); + 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, ...) 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); + /** Sends a command to this user. + * @param command The command to be sent. + * @param text The message to send. + */ + 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 A std::string to send to the user + /** Sends a server notice to this user. + * @param text The contents of the message to send. */ - void WriteFrom(User *user, const std::string &text); + void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + 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 + /** Send a NOTICE message from the local server to the user. + * @param text Text to send */ - void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4); + virtual void WriteRemoteNotice(const std::string& text); + + virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric); + + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1) + { + Numeric::Numeric n(numeric); + n.push(p1); + WriteRemoteNumeric(n); + } + + template + void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + WriteRemoteNumeric(n); + } + + template + 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 + 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 + 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 + void WriteNumeric(unsigned int numeric, T1 p1) + { + Numeric::Numeric n(numeric); + n.push(p1); + WriteNumeric(n); + } + + template + void WriteNumeric(unsigned int numeric, T1 p1, T2 p2) + { + Numeric::Numeric n(numeric); + n.push(p1); + n.push(p2); + WriteNumeric(n); + } + + template + 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); + } + + template + 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); + } - /** 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 + 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(User *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(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4); + 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 @@ -734,36 +666,15 @@ class CoreExport User : public StreamSocket */ 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 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 + /** 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 std::string &text); - - /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific - * quit message for opers only. - * @param normal_text Normal user quit message - * @param oper_text Oper only quit message - */ - void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text); - - /** Write a WALLOPS message from this user to all local opers. - * 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); + void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true); /** Return true if the user shares at least one channel with another user * @param other The other user to compare the channel list against @@ -771,32 +682,26 @@ class CoreExport User : public StreamSocket */ 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 + /** Change the displayed hostname of this user. + * @param host The new displayed hostname of this user. + * @return True if the hostname was changed successfully; otherwise, false. */ - void DoHostCycle(const std::string &quitline); + bool ChangeDisplayedHost(const std::string& host); - /** 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 + /** Change the real hostname of this user. + * @param host The new real hostname of this user. + * @param resetdisplay Whether to reset the display host to this value. */ - bool ChangeDisplayedHost(const char* host); + void ChangeRealHost(const std::string& host, bool resetdisplay); /** 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 + * 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 User::fullname directly, @@ -805,109 +710,246 @@ class CoreExport User : public StreamSocket * @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 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 + /** Change a user's nick + * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds. + * @param newts The time at which this nick change happened. + * @return True if the change succeeded */ - void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4); + bool ChangeNick(const std::string& newnick, time_t newts = 0); - /** 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 + /** 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(User* source, bool spy); + 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 User::ChannelList() + /** Default destructor */ - void SplitChanList(User* dest, const std::string &cl); + virtual ~User(); + CullResult cull() CXX11_OVERRIDE; +}; - /** 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() CXX11_OVERRIDE; + void OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) CXX11_OVERRIDE; + void OnError(BufferedSocketError error) CXX11_OVERRIDE; + + /** 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; + +class CoreExport LocalUser : public User, public insp::intrusive_list_node +{ + public: + LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server); + CullResult cull() CXX11_OVERRIDE; + + UserIOHandler eh; + + /** Stats counter for bytes inbound + */ + unsigned int bytes_in; + + /** Stats counter for bytes outbound + */ + unsigned int bytes_out; + + /** Stats counter for commands inbound + */ + unsigned int cmds_in; + + /** Stats counter for commands outbound + */ + unsigned int cmds_out; + + /** Password specified by the user when they registered (if any). + * This is stored even if the \ block doesnt need a password, so that + * modules may check it. + */ + std::string password; + + /** Contains a pointer to the connect class a user is on from + */ + reference MyClass; /** Get the connect class which this user belongs to. - * @return A pointer to this user's connect class + * @return A pointer to this user's connect class. */ - ConnectClass *GetClass(); + ConnectClass* GetClass() const { return MyClass; } - /** 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 tags from the configuration file. - * @return A reference to this user's current connect class. + /** Call this method to find the matching \ for a user, and to check them against it. */ - ConnectClass *SetClass(const std::string &explicit_name = ""); + void CheckClass(bool clone_count = true); - /** Show the message of the day to this user + /** Server address and port that this user is connected to. */ - void ShowMOTD(); + irc::sockets::sockaddrs server_sa; - /** Show the server RULES file to this user + /** + * @return The port number of this user. */ - void ShowRULES(); + int GetServerPort(); - /** Increases a user's command penalty by a set amount. + /** 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. */ - void IncreasePenalty(int increase); + unsigned int quitting_sendq:1; - /** Decreases a user's command penalty by a set amount. + /** has the user responded to their previous ping? */ - void DecreasePenalty(int decrease); + unsigned int lastping:1; - void OnDataReady(); - void OnError(BufferedSocketError error); + /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks. + */ + unsigned int exempt:1; - /** Default destructor + /** Used by PING checking code */ - virtual ~User(); - virtual void cull(); -}; + time_t nping; -/** Derived from Resolver, and performs user forward/reverse lookups. - */ -class CoreExport UserResolver : public Resolver -{ - private: - /** User this class is 'attached' to. + /** 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 */ - User* bound_user; - /** File descriptor teh lookup is bound to + 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. */ - int bound_fd; - /** True if the lookup is forward, false if is a reverse lookup + 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. */ - bool fwd; - public: - /** 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 + 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 \ tags from the configuration file. + * @return A reference to this user's current connect class. */ - UserResolver(User* user, std::string to_resolve, QueryType qt, bool &cache); + void SetClass(const std::string &explicit_name = ""); + + bool SetClientIP(const std::string& address, bool recheck_eline = true) CXX11_OVERRIDE; + + void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true) CXX11_OVERRIDE; + + void Write(const std::string& text) CXX11_OVERRIDE; + void Write(const char*, ...) CXX11_OVERRIDE CUSTOM_PRINTF(2, 3); - /** 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 + /** 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 OnLookupComplete(const std::string &result, unsigned int ttl, bool cached); + void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE; - /** Called on failed lookup - * @param e Error code - * @param errormessage Error message string + /** 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 */ - void OnError(ResolverError e, const std::string &errormessage); + bool HasPermission(const std::string &command) CXX11_OVERRIDE; + + /** 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) CXX11_OVERRIDE; + + /** 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 mh Mode to check + * @return True if the user can set or unset this mode. + */ + bool HasModePermission(const ModeHandler* mh) const CXX11_OVERRIDE; + + /** Change nick to uuid, unset REG_NICK and send a nickname overruled numeric. + * This is called when another user (either local or remote) needs the nick of this user and this user + * isn't registered. + */ + void OverruleNick(); }; -#endif +class RemoteUser : public User +{ + public: + RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE) + { + } +}; + +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; + } + + CullResult cull() CXX11_OVERRIDE; + const std::string& GetFullHost() CXX11_OVERRIDE; + const std::string& GetFullRealHost() CXX11_OVERRIDE; +}; + +/* Faster than dynamic_cast */ +/** Is a local user */ +inline LocalUser* IS_LOCAL(User* u) +{ + return u->usertype == USERTYPE_LOCAL ? static_cast(u) : NULL; +} +/** Is a remote user */ +inline RemoteUser* IS_REMOTE(User* u) +{ + return u->usertype == USERTYPE_REMOTE ? static_cast(u) : NULL; +} +/** Is a server fakeuser */ +inline FakeUser* IS_SERVER(User* u) +{ + return u->usertype == USERTYPE_SERVER ? static_cast(u) : NULL; +} + +inline bool User::IsModeSet(const ModeHandler* mh) const +{ + return (modes[mh->GetId()]); +} + +inline bool User::IsModeSet(UserModeReference& moderef) const +{ + if (!moderef) + return false; + return IsModeSet(*moderef); +} + +inline void User::SetMode(ModeHandler* mh, bool value) +{ + modes[mh->GetId()] = value; +}