2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019-2020 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
6 * Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
7 * Copyright (C) 2012-2016, 2018 Attila Molnar <attilamolnar@hush.com>
8 * Copyright (C) 2012-2013, 2016-2021 Sadie Powell <sadie@witchery.services>
9 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
10 * Copyright (C) 2012 DjSlash <djslash@djslash.org>
11 * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
12 * Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
13 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
14 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
15 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
16 * Copyright (C) 2008 John Brooks <special@inspircd.org>
17 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
18 * Copyright (C) 2006-2009 Robin Burchell <robin+git@viroteck.net>
19 * Copyright (C) 2003-2008 Craig Edwards <brain@inspircd.org>
21 * This file is part of InspIRCd. InspIRCd is free software: you can
22 * redistribute it and/or modify it under the terms of the GNU General Public
23 * License as published by the Free Software Foundation, version 2.
25 * This program is distributed in the hope that it will be useful, but WITHOUT
26 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
27 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 #include "inspsocket.h"
40 #include "membership.h"
42 /** connect class types
49 /** named connect block (for opers, etc) */
53 /** Registration state of a user, e.g.
54 * have they sent USER, NICK, PASS yet?
56 enum RegistrationState {
58 #ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
59 REG_NONE = 0, /* Has sent nothing */
62 REG_USER = 1, /* Has sent USER */
63 REG_NICK = 2, /* Has sent NICK */
64 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
65 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
74 /** Holds information relevant to <connect allow> and <connect deny> tags in the config file.
76 struct CoreExport ConnectClass : public refcountbase
78 reference<ConfigTag> config;
79 /** Type of line, either CC_ALLOW or CC_DENY
83 /** True if this class uses fake lag to manage flood, false if it kills */
86 /** Connect class name
90 /** Max time to register the connection in seconds
92 unsigned int registration_timeout;
94 /** Hosts that this user can connect from as a string. */
97 /** Hosts that this user can connect from as a vector. */
98 std::vector<std::string> hosts;
100 /** Number of seconds between pings for this line
102 unsigned int pingtime;
104 /** Maximum size of sendq for users in this class (bytes)
105 * Users cannot send commands if they go over this limit
107 unsigned long softsendqmax;
109 /** Maximum size of sendq for users in this class (bytes)
110 * Users are killed if they go over this limit
112 unsigned long hardsendqmax;
114 /** Maximum size of recvq for users in this class (bytes)
116 unsigned long recvqmax;
118 /** Seconds worth of penalty before penalty system activates
120 unsigned int penaltythreshold;
122 /** Maximum rate of commands (units: millicommands per second) */
123 unsigned int commandrate;
125 /** Local max when connecting by this connection class
127 unsigned long maxlocal;
129 /** Global max when connecting by this connection class
131 unsigned long maxglobal;
133 /** True if max connections for this class is hit and a warning is wanted
137 /** Max channels for this class
139 unsigned int maxchans;
141 /** How many users may be in this connect class before they are refused?
142 * (0 = no limit = default)
146 /** If set to true, no user DNS lookups are to be performed
148 bool resolvehostnames;
151 * If non-empty the server ports which this user has to be using
153 insp::flat_set<int> ports;
155 /** If non-empty then the password a user must specify in PASS to be assigned to this class. */
156 std::string password;
158 /** If non-empty then the hash algorithm that the password field is hashed with. */
159 std::string passwordhash;
161 /** Create a new connect class with no settings.
163 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
164 /** Create a new connect class with inherited settings.
166 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
168 /** Update the settings in this block to match the given block */
169 void Update(const ConnectClass* newSettings);
171 const std::string& GetName() const { return name; }
172 const std::string& GetHost() const { return host; }
173 const std::vector<std::string>& GetHosts() const { return hosts; }
175 /** Returns the registration timeout
177 time_t GetRegTimeout()
179 return (registration_timeout ? registration_timeout : 90);
182 /** Returns the ping frequency
184 unsigned int GetPingTime()
186 return (pingtime ? pingtime : 120);
189 /** Returns the maximum sendq value (soft limit)
190 * Note that this is in addition to internal OS buffers
192 unsigned long GetSendqSoftMax()
194 return (softsendqmax ? softsendqmax : 4096);
197 /** Returns the maximum sendq value (hard limit)
199 unsigned long GetSendqHardMax()
201 return (hardsendqmax ? hardsendqmax : 0x100000);
204 /** Returns the maximum recvq value
206 unsigned long GetRecvqMax()
208 return (recvqmax ? recvqmax : 4096);
211 /** Returns the penalty threshold value
213 unsigned int GetPenaltyThreshold()
215 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
218 unsigned int GetCommandRate()
220 return commandrate ? commandrate : 1000;
223 /** Return the maximum number of local sessions
225 unsigned long GetMaxLocal()
230 /** Returns the maximum number of global sessions
232 unsigned long GetMaxGlobal()
238 /** Holds all information about a user
239 * This class stores all information about a user connected to the irc server. Everything about a
240 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
241 * user's nickname and hostname.
243 class CoreExport User : public Extensible
246 /** Cached nick!ident\@dhost value using the displayed hostname
248 std::string cached_fullhost;
250 /** Cached ident\@ip value using the real IP address
252 std::string cached_hostip;
254 /** Cached ident\@realhost value using the real hostname
256 std::string cached_makehost;
258 /** Cached nick!ident\@realhost value using the real hostname
260 std::string cached_fullrealhost;
262 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
264 std::string cachedip;
266 /** If set then the hostname which is displayed to users. */
267 std::string displayhost;
269 /** The real hostname of this user. */
270 std::string realhost;
272 /** The real name of this user. */
273 std::string realname;
275 /** The user's mode list.
276 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
277 * if (modes[modeid]) is set, then the mode is set.
278 * For example, to work out if mode +i is set, we check the field
279 * User::modes[invisiblemode->modeid] == true.
281 std::bitset<ModeParser::MODEID_MAX> modes;
284 /** To execute a function for each local neighbor of a user, inherit from this class and
285 * pass an instance of it to User::ForEachNeighbor().
287 class ForEachNeighborHandler
290 /** Method to execute for each local neighbor of a user.
291 * Derived classes must implement this.
292 * @param user Current neighbor
294 virtual void Execute(LocalUser* user) = 0;
297 /** List of Memberships for this user
299 typedef insp::intrusive_list<Membership> ChanList;
301 /** Time that the object was instantiated (used for TS calculation etc)
305 /** Time the connection was created, set in the constructor. This
306 * may be different from the time the user's classbase object was
311 /** Client address that the user is connected from.
312 * Do not modify this value directly, use SetClientIP() to change it.
313 * Port is not valid for remote users.
315 irc::sockets::sockaddrs client_sa;
317 /** The users nickname.
318 * An invalid nickname indicates an unregistered connection prior to the NICK command.
319 * Use InspIRCd::IsNick() to validate nicknames.
323 /** The user's unique identifier.
324 * This is the unique identifier which the user has across the network.
326 const std::string uuid;
328 /** The users ident reply.
329 * Two characters are added to the user-defined limit to compensate for the tilde etc.
333 /** What snomasks are set on this user.
334 * This functions the same as the above modes.
336 std::bitset<64> snomasks;
338 /** Channels this user is on
342 /** The server the user is connected to.
346 /** The user's away message.
347 * If this string is empty, the user is not marked as away.
351 /** Time the user last went away.
352 * This is ONLY RELIABLE if user IsAway()!
356 /** The oper type they logged in as, if they are an oper.
358 reference<OperInfo> oper;
360 /** Used by User to indicate the registration status of the connection
361 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
362 * the connection state.
364 unsigned int registered:3;
366 /** If this is set to true, then all socket operations for the user
367 * are dropped into the bit-bucket.
368 * This value is set by QuitUser, and is not needed separately from that call.
369 * Please note that setting this value alone will NOT cause the user to quit.
371 unsigned int quitting:1;
373 /** What type of user is this? */
374 const unsigned int usertype:2;
376 /** Get client IP string from sockaddr, using static internal buffer
377 * @return The IP string
379 const std::string& GetIPString();
381 /** Retrieves this user's hostname.
382 * @param uncloak If true then return the real host; otherwise, the display host.
384 const std::string& GetHost(bool uncloak) const;
386 /** Retrieves this user's displayed hostname. */
387 const std::string& GetDisplayedHost() const;
389 /** Retrieves this user's real hostname. */
390 const std::string& GetRealHost() const;
392 /** Retrieves this user's real name. */
393 const std::string& GetRealName() const;
395 /** Get CIDR mask, using default range, for this user
397 irc::sockets::cidr_mask GetCIDRMask();
399 /** Sets the client IP for this user
400 * @return true if the conversion was successful
402 virtual bool SetClientIP(const std::string& address);
404 virtual void SetClientIP(const irc::sockets::sockaddrs& sa);
407 * @throw CoreException if the UID allocated to the user already exists
409 User(const std::string& uid, Server* srv, UserType objtype);
411 /** Returns the full displayed host of the user
412 * This member function returns the hostname of the user as seen by other users
413 * on the server, in nick!ident\@host form.
414 * @return The full masked host of the user
416 virtual const std::string& GetFullHost();
418 /** Returns the full real host of the user
419 * This member function returns the hostname of the user as seen by other users
420 * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
421 * e.g. through a module, then this method will ignore it and return the true hostname.
422 * @return The full real host of the user
424 virtual const std::string& GetFullRealHost();
426 /** This clears any cached results that are used for GetFullRealHost() etc.
427 * The results of these calls are cached as generating them can be generally expensive.
429 void InvalidateCache();
431 /** Returns whether this user is currently away or not. If true,
432 * further information can be found in User::awaymsg and User::awaytime
433 * @return True if the user is away, false otherwise
435 bool IsAway() const { return (!awaymsg.empty()); }
437 /** Returns whether this user is an oper or not. If true,
438 * oper information can be obtained from User::oper
439 * @return True if the user is an oper, false otherwise
441 bool IsOper() const { return oper; }
443 /** Returns true if a notice mask is set
444 * @param sm A notice mask character to check
445 * @return True if the notice mask is set
447 bool IsNoticeMaskSet(unsigned char sm);
449 /** Get the mode letters of modes set on the user as a string.
450 * @param includeparams True to get the parameters of the modes as well. Defaults to false.
451 * @return Mode letters of modes set on the user and optionally the parameters of those modes, if any.
452 * The returned string always begins with a '+' character. If the user has no modes set, "+" is returned.
454 std::string GetModeLetters(bool includeparams = false) const;
456 /** Returns true if a specific mode is set
457 * @param m The user mode
458 * @return True if the mode is set
460 bool IsModeSet(unsigned char m) const;
461 bool IsModeSet(const ModeHandler* mh) const;
462 bool IsModeSet(const ModeHandler& mh) const { return IsModeSet(&mh); }
463 bool IsModeSet(UserModeReference& moderef) const;
465 /** Set a specific usermode to on or off
466 * @param mh The user mode
467 * @param value On or off setting of the mode
469 void SetMode(ModeHandler* mh, bool value);
470 void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
472 /** Returns true or false for if a user can execute a privilaged oper command.
473 * This is done by looking up their oper type from User::oper, then referencing
474 * this to their oper classes and checking the commands they can execute.
475 * @param command A command (should be all CAPS)
476 * @return True if this user can execute the command
478 virtual bool HasCommandPermission(const std::string& command);
480 /** Returns true if a user has a given permission.
481 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
482 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
484 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
485 * @return True if this user has the permission in question.
487 virtual bool HasPrivPermission(const std::string& privstr);
489 /** Returns true or false if a user can set a privileged user or channel mode.
490 * This is done by looking up their oper type from User::oper, then referencing
491 * this to their oper classes, and checking the modes they can set.
492 * @param mh Mode to check
493 * @return True if the user can set or unset this mode.
495 virtual bool HasModePermission(const ModeHandler* mh) const;
497 /** Determines whether this user can set the specified snomask.
498 * @param chr The server notice mask character to look up.
499 * @return True if the user can set the specified snomask; otherwise, false.
501 virtual bool HasSnomaskPermission(char chr) const;
503 /** Creates a usermask with real host.
504 * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
505 * @return the usermask in the format user\@host
507 const std::string& MakeHost();
509 /** Creates a usermask with real ip.
510 * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
511 * @return the usermask in the format user\@ip
513 const std::string& MakeHostIP();
515 /** Oper up the user using the given opertype.
516 * This will also give the +o usermode.
518 void Oper(OperInfo* info);
521 * This will clear the +o usermode and unset the user's oper type
525 /** Sends a server notice to this user.
526 * @param text The contents of the message to send.
528 void WriteNotice(const std::string& text);
530 /** Send a NOTICE message from the local server to the user.
531 * @param text Text to send
533 virtual void WriteRemoteNotice(const std::string& text);
535 virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
537 template <typename T1>
538 void WriteRemoteNumeric(unsigned int numeric, T1 p1)
540 Numeric::Numeric n(numeric);
542 WriteRemoteNumeric(n);
545 template <typename T1, typename T2>
546 void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2)
548 Numeric::Numeric n(numeric);
551 WriteRemoteNumeric(n);
554 template <typename T1, typename T2, typename T3>
555 void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
557 Numeric::Numeric n(numeric);
561 WriteRemoteNumeric(n);
564 template <typename T1, typename T2, typename T3, typename T4>
565 void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
567 Numeric::Numeric n(numeric);
572 WriteRemoteNumeric(n);
575 template <typename T1, typename T2, typename T3, typename T4, typename T5>
576 void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
578 Numeric::Numeric n(numeric);
584 WriteRemoteNumeric(n);
587 void WriteNumeric(const Numeric::Numeric& numeric);
589 template <typename T1>
590 void WriteNumeric(unsigned int numeric, T1 p1)
592 Numeric::Numeric n(numeric);
597 template <typename T1, typename T2>
598 void WriteNumeric(unsigned int numeric, T1 p1, T2 p2)
600 Numeric::Numeric n(numeric);
606 template <typename T1, typename T2, typename T3>
607 void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
609 Numeric::Numeric n(numeric);
616 template <typename T1, typename T2, typename T3, typename T4>
617 void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
619 Numeric::Numeric n(numeric);
627 template <typename T1, typename T2, typename T3, typename T4, typename T5>
628 void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
630 Numeric::Numeric n(numeric);
639 /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
640 * @param protoev Protocol event to send, may contain any number of messages.
641 * @param include_self Should the message be sent back to the author?
643 void WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self = true);
645 /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
646 * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
647 * This function is used for example to send something conditionally to neighbors, or to send different messages
648 * to different users depending on their oper status.
649 * @param handler Function object to call, inherited from ForEachNeighborHandler.
650 * @param include_self True to include this user in the set of neighbors, false otherwise.
651 * Modules may override this. Has no effect if this user is not local.
653 void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
655 /** Return true if the user shares at least one channel with another user
656 * @param other The other user to compare the channel list against
657 * @return True if the given user shares at least one channel with this user
659 bool SharesChannelWith(User *other);
661 /** Change the displayed hostname of this user.
662 * @param host The new displayed hostname of this user.
663 * @return True if the hostname was changed successfully; otherwise, false.
665 bool ChangeDisplayedHost(const std::string& host);
667 /** Change the real hostname of this user.
668 * @param host The new real hostname of this user.
669 * @param resetdisplay Whether to reset the display host to this value.
671 void ChangeRealHost(const std::string& host, bool resetdisplay);
673 /** Change the ident (username) of a user.
674 * ALWAYS use this function, rather than writing User::ident directly,
675 * as this triggers module events allowing the change to be syncronized to
677 * @param newident The new ident to set
678 * @return True if the change succeeded, false if it didn't
680 bool ChangeIdent(const std::string& newident);
682 /** Change a users realname field.
683 * @param real The user's new real name
684 * @return True if the change succeeded, false if otherwise
686 bool ChangeRealName(const std::string& real);
688 /** Change a user's nick
689 * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
690 * @param newts The time at which this nick change happened.
691 * @return True if the change succeeded
693 bool ChangeNick(const std::string& newnick, time_t newts = 0);
695 /** Remove this user from all channels they are on, and delete any that are now empty.
696 * This is used by QUIT, and will not send part messages!
698 void PurgeEmptyChannels();
700 /** Default destructor
703 CullResult cull() CXX11_OVERRIDE;
705 /** @copydoc Serializable::Deserialize */
706 bool Deserialize(Data& data) CXX11_OVERRIDE;
708 /** @copydoc Serializable::Deserialize */
709 bool Serialize(Serializable::Data& data) CXX11_OVERRIDE;
712 class CoreExport UserIOHandler : public StreamSocket
715 size_t checked_until;
717 LocalUser* const user;
718 UserIOHandler(LocalUser* me)
719 : StreamSocket(StreamSocket::SS_USER)
724 void OnDataReady() CXX11_OVERRIDE;
725 bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) CXX11_OVERRIDE;
726 void OnError(BufferedSocketError error) CXX11_OVERRIDE;
728 /** Adds to the user's write buffer.
729 * You may add any amount of text up to this users sendq value, if you exceed the
730 * sendq value, the user will be removed, and further buffer adds will be dropped.
731 * @param data The data to add to the write buffer
733 void AddWriteBuf(const std::string &data);
735 /** Swaps the internals of this UserIOHandler with another one.
736 * @param other A UserIOHandler to swap internals with.
738 void SwapInternals(UserIOHandler& other);
741 typedef unsigned int already_sent_t;
743 class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
745 /** Add a serialized message to the send queue of the user.
746 * @param serialized Bytes to add.
748 void Write(const ClientProtocol::SerializedMessage& serialized);
750 /** Send a protocol event to the user, consisting of one or more messages.
751 * @param protoev Event to send, may contain any number of messages.
752 * @param msglist Message list used temporarily internally to pass to hooks and store messages
755 void Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist);
757 /** Message list, can be passed to the two parameter Send().
759 static ClientProtocol::MessageList sendmsglist;
762 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
763 LocalUser(int fd, const std::string& uuid, Serializable::Data& data);
765 CullResult cull() CXX11_OVERRIDE;
769 /** Serializer to use when communicating with the user
771 ClientProtocol::Serializer* serializer;
773 /** Stats counter for bytes inbound
775 unsigned int bytes_in;
777 /** Stats counter for bytes outbound
779 unsigned int bytes_out;
781 /** Stats counter for commands inbound
783 unsigned int cmds_in;
785 /** Stats counter for commands outbound
787 unsigned int cmds_out;
789 /** Password specified by the user when they registered (if any).
790 * This is stored even if the \<connect> block doesnt need a password, so that
791 * modules may check it.
793 std::string password;
795 /** Contains a pointer to the connect class a user is on from
797 reference<ConnectClass> MyClass;
799 /** Get the connect class which this user belongs to.
800 * @return A pointer to this user's connect class.
802 ConnectClass* GetClass() const { return MyClass; }
804 /** Call this method to find the matching \<connect> for a user, and to check them against it.
806 void CheckClass(bool clone_count = true);
808 /** Server address and port that this user is connected to.
810 irc::sockets::sockaddrs server_sa;
812 /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
813 * This can't be handled normally because QuitUser itself calls Write on other
814 * users, which could trigger their SendQ to overrun.
816 unsigned int quitting_sendq:1;
818 /** has the user responded to their previous ping?
820 unsigned int lastping:1;
822 /** This is true if the user matched an exception (E-line). It is used to save time on ban checks.
824 unsigned int exempt:1;
826 /** The time at which this user should be pinged next. */
829 /** Time that the connection last sent a message, used to calculate idle time
833 /** This value contains how far into the penalty threshold the user is.
834 * This is used either to enable fake lag or for excess flood quits
836 unsigned int CommandFloodPenalty;
838 already_sent_t already_sent;
840 /** Check if the user matches a G- or K-line, and disconnect them if they do.
841 * @param doZline True if Z-lines should be checked (if IP has changed since initial connect)
842 * Returns true if the user matched a ban, false else.
844 bool CheckLines(bool doZline = false);
846 /** Use this method to fully connect a user.
847 * This will send the message of the day, check G/K/E-lines, etc.
851 /** Set the connect class to which this user belongs to.
852 * @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.
854 void SetClass(const std::string &explicit_name = "");
856 bool SetClientIP(const std::string& address) CXX11_OVERRIDE;
858 void SetClientIP(const irc::sockets::sockaddrs& sa) CXX11_OVERRIDE;
860 /** Send a NOTICE message from the local server to the user.
861 * The message will be sent even if the user is connected to a remote server.
862 * @param text Text to send
864 void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE;
866 /** Returns true or false for if a user can execute a privilaged oper command.
867 * This is done by looking up their oper type from User::oper, then referencing
868 * this to their oper classes and checking the commands they can execute.
869 * @param command A command (should be all CAPS)
870 * @return True if this user can execute the command
872 bool HasCommandPermission(const std::string& command) CXX11_OVERRIDE;
874 /** Returns true if a user has a given permission.
875 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
876 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
878 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
879 * @return True if this user has the permission in question.
881 bool HasPrivPermission(const std::string& privstr) CXX11_OVERRIDE;
883 /** Returns true or false if a user can set a privileged user or channel mode.
884 * This is done by looking up their oper type from User::oper, then referencing
885 * this to their oper classes, and checking the modes they can set.
886 * @param mh Mode to check
887 * @return True if the user can set or unset this mode.
889 bool HasModePermission(const ModeHandler* mh) const CXX11_OVERRIDE;
891 /** @copydoc User::HasSnomaskPermission */
892 bool HasSnomaskPermission(char chr) const CXX11_OVERRIDE;
894 /** Change nick to uuid, unset REG_NICK and send a nickname overruled numeric.
895 * This is called when another user (either local or remote) needs the nick of this user and this user
900 /** Send a protocol event to the user, consisting of one or more messages.
901 * @param protoev Event to send, may contain any number of messages.
903 void Send(ClientProtocol::Event& protoev);
905 /** Send a single message to the user.
906 * @param protoevprov Protocol event provider.
907 * @param msg Message to send.
909 void Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg);
911 /** @copydoc Serializable::Deserialize */
912 bool Deserialize(Data& data) CXX11_OVERRIDE;
914 /** @copydoc Serializable::Deserialize */
915 bool Serialize(Serializable::Data& data) CXX11_OVERRIDE;
918 class RemoteUser : public User
921 RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
926 class CoreExport FakeUser : public User
929 FakeUser(const std::string& uid, Server* srv)
930 : User(uid, srv, USERTYPE_SERVER)
932 nick = srv->GetName();
935 FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
936 : User(uid, new Server(uid, sname, sdesc), USERTYPE_SERVER)
941 CullResult cull() CXX11_OVERRIDE;
942 const std::string& GetFullHost() CXX11_OVERRIDE;
943 const std::string& GetFullRealHost() CXX11_OVERRIDE;
946 /* Faster than dynamic_cast */
947 /** Is a local user */
948 inline LocalUser* IS_LOCAL(User* u)
950 return (u != NULL && u->usertype == USERTYPE_LOCAL) ? static_cast<LocalUser*>(u) : NULL;
952 /** Is a remote user */
953 inline RemoteUser* IS_REMOTE(User* u)
955 return (u != NULL && u->usertype == USERTYPE_REMOTE) ? static_cast<RemoteUser*>(u) : NULL;
957 /** Is a server fakeuser */
958 inline FakeUser* IS_SERVER(User* u)
960 return (u != NULL && u->usertype == USERTYPE_SERVER) ? static_cast<FakeUser*>(u) : NULL;
963 inline bool User::IsModeSet(const ModeHandler* mh) const
965 return ((mh->GetId() != ModeParser::MODEID_MAX) && (modes[mh->GetId()]));
968 inline bool User::IsModeSet(UserModeReference& moderef) const
972 return IsModeSet(*moderef);
975 inline void User::SetMode(ModeHandler* mh, bool value)
977 if (mh && mh->GetId() != ModeParser::MODEID_MAX)
978 modes[mh->GetId()] = value;