2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
7 * Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007 Burlex <???@???>
9 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "inspsocket.h"
32 #include "membership.h"
34 /** connect class types
41 /** named connect block (for opers, etc) */
45 /** RFC1459 channel modes
48 /** +s: Server notice mask */
49 UM_SNOMASK = 's' - 65,
51 UM_WALLOPS = 'w' - 65,
53 UM_INVISIBLE = 'i' - 65,
55 UM_OPERATOR = 'o' - 65
58 /** Registration state of a user, e.g.
59 * have they sent USER, NICK, PASS yet?
61 enum RegistrationState {
63 #ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
64 REG_NONE = 0, /* Has sent nothing */
67 REG_USER = 1, /* Has sent USER */
68 REG_NICK = 2, /* Has sent NICK */
69 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
70 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
79 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
81 struct CoreExport ConnectClass : public refcountbase
83 reference<ConfigTag> config;
84 /** Type of line, either CC_ALLOW or CC_DENY
88 /** True if this class uses fake lag to manage flood, false if it kills */
91 /** Connect class name
95 /** Max time to register the connection in seconds
97 unsigned int registration_timeout;
99 /** Host mask for this line
103 /** Number of seconds between pings for this line
105 unsigned int pingtime;
107 /** Maximum size of sendq for users in this class (bytes)
108 * Users cannot send commands if they go over this limit
110 unsigned long softsendqmax;
112 /** Maximum size of sendq for users in this class (bytes)
113 * Users are killed if they go over this limit
115 unsigned long hardsendqmax;
117 /** Maximum size of recvq for users in this class (bytes)
119 unsigned long recvqmax;
121 /** Seconds worth of penalty before penalty system activates
123 unsigned int penaltythreshold;
125 /** Maximum rate of commands (units: millicommands per second) */
126 unsigned int commandrate;
128 /** Local max when connecting by this connection class
130 unsigned long maxlocal;
132 /** Global max when connecting by this connection class
134 unsigned long maxglobal;
136 /** True if max connections for this class is hit and a warning is wanted
140 /** Max channels for this class
142 unsigned int maxchans;
144 /** How many users may be in this connect class before they are refused?
145 * (0 = no limit = default)
149 /** Create a new connect class with no settings.
151 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
152 /** Create a new connect class with inherited settings.
154 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
156 /** Update the settings in this block to match the given block */
157 void Update(const ConnectClass* newSettings);
159 const std::string& GetName() { return name; }
160 const std::string& GetHost() { return host; }
162 /** Returns the registration timeout
164 time_t GetRegTimeout()
166 return (registration_timeout ? registration_timeout : 90);
169 /** Returns the ping frequency
171 unsigned int GetPingTime()
173 return (pingtime ? pingtime : 120);
176 /** Returns the maximum sendq value (soft limit)
177 * Note that this is in addition to internal OS buffers
179 unsigned long GetSendqSoftMax()
181 return (softsendqmax ? softsendqmax : 4096);
184 /** Returns the maximum sendq value (hard limit)
186 unsigned long GetSendqHardMax()
188 return (hardsendqmax ? hardsendqmax : 0x100000);
191 /** Returns the maximum recvq value
193 unsigned long GetRecvqMax()
195 return (recvqmax ? recvqmax : 4096);
198 /** Returns the penalty threshold value
200 unsigned int GetPenaltyThreshold()
202 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
205 unsigned int GetCommandRate()
207 return commandrate ? commandrate : 1000;
210 /** Return the maximum number of local sessions
212 unsigned long GetMaxLocal()
217 /** Returns the maximum number of global sessions
219 unsigned long GetMaxGlobal()
225 /** Holds all information about a user
226 * This class stores all information about a user connected to the irc server. Everything about a
227 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
228 * user's nickname and hostname.
230 class CoreExport User : public Extensible
233 /** Cached nick!ident@dhost value using the displayed hostname
235 std::string cached_fullhost;
237 /** Cached ident@ip value using the real IP address
239 std::string cached_hostip;
241 /** Cached ident@realhost value using the real hostname
243 std::string cached_makehost;
245 /** Cached nick!ident@realhost value using the real hostname
247 std::string cached_fullrealhost;
249 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
251 std::string cachedip;
255 /** Hostname of connection.
256 * This should be valid as per RFC1035.
260 /** Time that the object was instantiated (used for TS calculation etc)
264 /** Time the connection was created, set in the constructor. This
265 * may be different from the time the user's classbase object was
270 /** Client address that the user is connected from.
271 * Do not modify this value directly, use SetClientIP() to change it.
272 * Port is not valid for remote users.
274 irc::sockets::sockaddrs client_sa;
276 /** The users nickname.
277 * An invalid nickname indicates an unregistered connection prior to the NICK command.
278 * Use InspIRCd::IsNick() to validate nicknames.
282 /** The user's unique identifier.
283 * This is the unique identifier which the user has across the network.
285 const std::string uuid;
287 /** The users ident reply.
288 * Two characters are added to the user-defined limit to compensate for the tilde etc.
292 /** The host displayed to non-opers (used for cloaking etc).
293 * This usually matches the value of User::host.
297 /** The users full name (GECOS).
299 std::string fullname;
301 /** The user's mode list.
302 * NOT a null terminated string.
304 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
305 * if (modes[modeletter-65]) is set, then the mode is
306 * set, for example, to work out if mode +s is set, we check the field
307 * User::modes['s'-65] != 0.
308 * The following RFC characters o, w, s, i have constants defined via an
309 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
311 std::bitset<64> modes;
313 /** What snomasks are set on this user.
314 * This functions the same as the above modes.
316 std::bitset<64> snomasks;
318 /** Channels this user is on
322 /** The server the user is connected to.
324 const std::string server;
326 /** The user's away message.
327 * If this string is empty, the user is not marked as away.
331 /** Time the user last went away.
332 * This is ONLY RELIABLE if user IS_AWAY()!
336 /** The oper type they logged in as, if they are an oper.
338 reference<OperInfo> oper;
340 /** Used by User to indicate the registration status of the connection
341 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
342 * the connection state.
344 unsigned int registered:3;
346 /** Whether or not to send an snotice about this user's quitting
348 unsigned int quietquit:1;
350 /** If this is set to true, then all socket operations for the user
351 * are dropped into the bit-bucket.
352 * This value is set by QuitUser, and is not needed seperately from that call.
353 * Please note that setting this value alone will NOT cause the user to quit.
355 unsigned int quitting:1;
357 /** What type of user is this? */
358 const unsigned int usertype:2;
360 /** Get client IP string from sockaddr, using static internal buffer
361 * @return The IP string
363 const std::string& GetIPString();
365 /** Get CIDR mask, using default range, for this user
367 irc::sockets::cidr_mask GetCIDRMask();
369 /** Sets the client IP for this user
370 * @return true if the conversion was successful
372 virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
374 virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
377 * @throw CoreException if the UID allocated to the user already exists
379 User(const std::string &uid, const std::string& srv, int objtype);
381 /** Returns the full displayed host of the user
382 * This member function returns the hostname of the user as seen by other users
383 * on the server, in nick!ident\@host form.
384 * @return The full masked host of the user
386 virtual const std::string& GetFullHost();
388 /** Returns the full real host of the user
389 * This member function returns the hostname of the user as seen by other users
390 * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
391 * e.g. through a module, then this method will ignore it and return the true hostname.
392 * @return The full real host of the user
394 virtual const std::string& GetFullRealHost();
396 /** This clears any cached results that are used for GetFullRealHost() etc.
397 * The results of these calls are cached as generating them can be generally expensive.
399 void InvalidateCache();
401 /** Create a displayable mode string for this users snomasks
402 * @return The notice mask character sequence
404 const char* FormatNoticeMasks();
406 /** Process a snomask modifier string, e.g. +abc-de
407 * @param sm A sequence of notice mask characters
408 * @return The cleaned mode sequence which can be output,
409 * e.g. in the above example if masks c and e are not
410 * valid, this function will return +ab-d
412 std::string ProcessNoticeMasks(const char *sm);
414 /** Returns true if a notice mask is set
415 * @param sm A notice mask character to check
416 * @return True if the notice mask is set
418 bool IsNoticeMaskSet(unsigned char sm);
420 /** Changed a specific notice mask value
421 * @param sm The server notice mask to change
422 * @param value An on/off value for this mask
424 void SetNoticeMask(unsigned char sm, bool value);
426 /** Create a displayable mode string for this users umodes
427 * @param showparameters The mode string
429 const char* FormatModes(bool showparameters = false);
431 /** Returns true if a specific mode is set
432 * @param m The user mode
433 * @return True if the mode is set
435 bool IsModeSet(unsigned char m);
437 /** Set a specific usermode to on or off
438 * @param m The user mode
439 * @param value On or off setting of the mode
441 void SetMode(unsigned char m, bool value);
443 /** Returns true or false for if a user can execute a privilaged oper command.
444 * This is done by looking up their oper type from User::oper, then referencing
445 * this to their oper classes and checking the commands they can execute.
446 * @param command A command (should be all CAPS)
447 * @return True if this user can execute the command
449 virtual bool HasPermission(const std::string &command);
451 /** Returns true if a user has a given permission.
452 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
453 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
455 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
456 * @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.
457 * @return True if this user has the permission in question.
459 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
461 /** Returns true or false if a user can set a privileged user or channel mode.
462 * This is done by looking up their oper type from User::oper, then referencing
463 * this to their oper classes, and checking the modes they can set.
464 * @param mode The mode the check
465 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
466 * @return True if the user can set or unset this mode.
468 virtual bool HasModePermission(unsigned char mode, ModeType type);
470 /** Creates a wildcard host.
471 * Takes a buffer to use and fills the given buffer with the host in the format *!*\@hostname
472 * @return The wildcarded hostname in *!*\@host form
474 char* MakeWildHost();
476 /** Creates a usermask with real host.
477 * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
478 * @return the usermask in the format user\@host
480 const std::string& MakeHost();
482 /** Creates a usermask with real ip.
483 * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
484 * @return the usermask in the format user\@ip
486 const std::string& MakeHostIP();
488 /** Add the user to WHOWAS system
492 /** Oper up the user using the given opertype.
493 * This will also give the +o usermode.
495 void Oper(OperInfo* info);
497 /** Force a nickname change.
498 * If the nickname change fails (for example, because the nick in question
499 * already exists) this function will return false, and you must then either
500 * output an error message, or quit the user for nickname collision.
501 * @param newnick The nickname to change to
502 * @return True if the nickchange was successful.
504 inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
507 * This will clear the +o usermode and unset the user's oper type
511 /** Write text to this user, appending CR/LF. Works on local users only.
512 * @param text A std::string to send to the user
514 virtual void Write(const std::string &text);
516 /** Write text to this user, appending CR/LF.
517 * Works on local users only.
518 * @param text The format string for text to send to the user
519 * @param ... POD-type format arguments
521 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
523 /** Write text to this user, appending CR/LF and prepending :server.name
524 * Works on local users only.
525 * @param text A std::string to send to the user
527 void WriteServ(const std::string& text);
529 /** Write text to this user, appending CR/LF and prepending :server.name
530 * Works on local users only.
531 * @param text The format string for text to send to the user
532 * @param ... POD-type format arguments
534 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
536 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
538 void WriteNumeric(unsigned int numeric, const std::string &text);
540 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
541 * @param user The user to prepend the :nick!user\@host of
542 * @param text A std::string to send to the user
544 void WriteFrom(User *user, const std::string &text);
546 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
547 * @param user The user to prepend the :nick!user\@host of
548 * @param text The format string for text to send to the user
549 * @param ... POD-type format arguments
551 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
553 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
554 * @param dest The user to route the message to
555 * @param data A std::string to send to the user
557 void WriteTo(User *dest, const std::string &data);
559 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
560 * @param dest The user to route the message to
561 * @param data The format string for text to send to the user
562 * @param ... POD-type format arguments
564 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
566 /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
567 * @param line A std::string to send to the users
568 * @param include_self Should the message be sent back to the author?
570 void WriteCommonRaw(const std::string &line, bool include_self = true);
572 /** Write to all users that can see this user (including this user in the list), appending CR/LF
573 * @param text The format string for text to send to the users
574 * @param ... POD-type format arguments
576 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
578 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
579 * @param text The format string for text to send to the users
580 * @param ... POD-type format arguments
582 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
584 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
585 * quit message for opers only.
586 * @param normal_text Normal user quit message
587 * @param oper_text Oper only quit message
589 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
591 /** Dump text to a user target, splitting it appropriately to fit
592 * @param LinePrefix text to prefix each complete line with
593 * @param TextStream the text to send to the user
595 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
597 /** Write to the user, routing the line if the user is remote.
599 virtual void SendText(const std::string& line) = 0;
601 /** Write to the user, routing the line if the user is remote.
603 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
605 /** Return true if the user shares at least one channel with another user
606 * @param other The other user to compare the channel list against
607 * @return True if the given user shares at least one channel with this user
609 bool SharesChannelWith(User *other);
611 /** Send fake quit/join messages for host or ident cycle.
612 * Run this after the item in question has changed.
613 * You should not need to use this function, call ChangeDisplayedHost instead
615 * @param quitline The entire QUIT line, including the source using the old value
617 void DoHostCycle(const std::string &quitline);
619 /** Change the displayed host of a user.
620 * ALWAYS use this function, rather than writing User::dhost directly,
621 * as this triggers module events allowing the change to be syncronized to
622 * remote servers. This will also emulate a QUIT and rejoin (where configured)
623 * before setting their host field.
624 * @param host The new hostname to set
625 * @return True if the change succeeded, false if it didn't
627 bool ChangeDisplayedHost(const char* host);
629 /** Change the ident (username) of a user.
630 * ALWAYS use this function, rather than writing User::ident directly,
631 * as this correctly causes the user to seem to quit (where configured)
632 * before setting their ident field.
633 * @param newident The new ident to set
634 * @return True if the change succeeded, false if it didn't
636 bool ChangeIdent(const char* newident);
638 /** Change a users realname field.
639 * ALWAYS use this function, rather than writing User::fullname directly,
640 * as this triggers module events allowing the change to be syncronized to
642 * @param gecos The user's new realname
643 * @return True if the change succeeded, false if otherwise
645 bool ChangeName(const char* gecos);
647 /** Change a user's nick
648 * @param newnick The new nick
649 * @param force True if the change is being forced (should not be blocked by modes like +N)
650 * @return True if the change succeeded
652 bool ChangeNick(const std::string& newnick, bool force = false);
654 /** Send a command to all local users from this user
655 * The command given must be able to send text with the
656 * first parameter as a servermask (e.g. $*), so basically
657 * you should use PRIVMSG or NOTICE.
658 * @param command the command to send
659 * @param text The text format string to send
660 * @param ... Format arguments
662 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
664 /** Compile a channel list for this user. Used internally by WHOIS
665 * @param source The user to prepare the channel list for
666 * @param spy Whether to return the spy channel list rather than the normal one
667 * @return This user's channel list
669 std::string ChannelList(User* source, bool spy);
671 /** Split the channel list in cl which came from dest, and spool it to this user
672 * Used internally by WHOIS
673 * @param dest The user the original channel list came from
674 * @param cl The channel list as a string obtained from User::ChannelList()
676 void SplitChanList(User* dest, const std::string &cl);
678 /** Remove this user from all channels they are on, and delete any that are now empty.
679 * This is used by QUIT, and will not send part messages!
681 void PurgeEmptyChannels();
683 /** Get the connect class which this user belongs to. NULL for remote users.
684 * @return A pointer to this user's connect class.
686 virtual ConnectClass* GetClass();
688 /** Default destructor
691 virtual CullResult cull();
694 class CoreExport UserIOHandler : public StreamSocket
697 LocalUser* const user;
698 UserIOHandler(LocalUser* me) : user(me) {}
700 void OnError(BufferedSocketError error);
702 /** Adds to the user's write buffer.
703 * You may add any amount of text up to this users sendq value, if you exceed the
704 * sendq value, the user will be removed, and further buffer adds will be dropped.
705 * @param data The data to add to the write buffer
707 void AddWriteBuf(const std::string &data);
710 typedef unsigned int already_sent_t;
712 class CoreExport LocalUser : public User, public InviteBase
715 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
720 /** Position in UserManager::local_users
722 LocalUserList::iterator localuseriter;
724 /** Stats counter for bytes inbound
726 unsigned int bytes_in;
728 /** Stats counter for bytes outbound
730 unsigned int bytes_out;
732 /** Stats counter for commands inbound
734 unsigned int cmds_in;
736 /** Stats counter for commands outbound
738 unsigned int cmds_out;
740 /** Password specified by the user when they registered (if any).
741 * This is stored even if the \<connect> block doesnt need a password, so that
742 * modules may check it.
744 std::string password;
746 /** Contains a pointer to the connect class a user is on from
748 reference<ConnectClass> MyClass;
750 ConnectClass* GetClass();
752 /** Call this method to find the matching \<connect> for a user, and to check them against it.
756 /** Server address and port that this user is connected to.
758 irc::sockets::sockaddrs server_sa;
761 * @return The port number of this user.
765 /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
766 * This can't be handled normally because QuitUser itself calls Write on other
767 * users, which could trigger their SendQ to overrun.
769 unsigned int quitting_sendq:1;
771 /** True when DNS lookups are completed.
772 * The UserResolver classes res_forward and res_reverse will
773 * set this value once they complete.
775 unsigned int dns_done:1;
777 /** has the user responded to their previous ping?
779 unsigned int lastping:1;
781 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
783 unsigned int exempt:1;
785 /** Used by PING checking code
789 /** Time that the connection last sent a message, used to calculate idle time
793 /** This value contains how far into the penalty threshold the user is.
794 * This is used either to enable fake lag or for excess flood quits
796 unsigned int CommandFloodPenalty;
798 static already_sent_t already_sent_id;
799 already_sent_t already_sent;
801 /** Stored reverse lookup from res_forward. Should not be used after resolution.
803 std::string stored_host;
805 /** Starts a DNS lookup of the user's IP.
806 * This will cause two UserResolver classes to be instantiated.
807 * When complete, these objects set User::dns_done to true.
809 void StartDNSLookup();
811 /** Check if the user matches a G or K line, and disconnect them if they do.
812 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
813 * Returns true if the user matched a ban, false else.
815 bool CheckLines(bool doZline = false);
817 /** Use this method to fully connect a user.
818 * This will send the message of the day, check G/K/E lines, etc.
822 /** Set the connect class to which this user belongs to.
823 * @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.
824 * @return A reference to this user's current connect class.
826 void SetClass(const std::string &explicit_name = "");
828 bool SetClientIP(const char* sip, bool recheck_eline = true);
830 void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
832 void SendText(const std::string& line);
833 void Write(const std::string& text);
834 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
836 /** Returns the list of channels this user has been invited to but has not yet joined.
837 * @return A list of channels the user is invited to
839 InviteList& GetInviteList();
841 /** Returns true if a user is invited to a channel.
842 * @param channel A channel name to look up
843 * @return True if the user is invited to the given channel
845 bool IsInvited(const irc::string &channel);
847 /** Adds a channel to a users invite list (invites them to a channel)
848 * @param channel A channel name to add
849 * @param timeout When the invite should expire (0 == never)
851 void InviteTo(const irc::string &channel, time_t timeout);
853 /** Removes a channel from a users invite list.
854 * This member function is called on successfully joining an invite only channel
855 * to which the user has previously been invited, to clear the invitation.
856 * @param channel The channel to remove the invite to
858 void RemoveInvite(const irc::string &channel);
860 void RemoveExpiredInvites();
862 /** Returns true or false for if a user can execute a privilaged oper command.
863 * This is done by looking up their oper type from User::oper, then referencing
864 * this to their oper classes and checking the commands they can execute.
865 * @param command A command (should be all CAPS)
866 * @return True if this user can execute the command
868 bool HasPermission(const std::string &command);
870 /** Returns true if a user has a given permission.
871 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
872 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
874 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
875 * @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.
876 * @return True if this user has the permission in question.
878 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
880 /** Returns true or false if a user can set a privileged user or channel mode.
881 * This is done by looking up their oper type from User::oper, then referencing
882 * this to their oper classes, and checking the modes they can set.
883 * @param mode The mode the check
884 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
885 * @return True if the user can set or unset this mode.
887 bool HasModePermission(unsigned char mode, ModeType type);
890 class CoreExport RemoteUser : public User
893 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
896 virtual void SendText(const std::string& line);
899 class CoreExport FakeUser : public User
902 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
907 virtual CullResult cull();
908 virtual void SendText(const std::string& line);
909 virtual const std::string& GetFullHost();
910 virtual const std::string& GetFullRealHost();
913 /* Faster than dynamic_cast */
914 /** Is a local user */
915 inline LocalUser* IS_LOCAL(User* u)
917 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
919 /** Is a remote user */
920 inline RemoteUser* IS_REMOTE(User* u)
922 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
924 /** Is a server fakeuser */
925 inline FakeUser* IS_SERVER(User* u)
927 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
930 #define IS_OPER(x) (x->oper)
932 #define IS_AWAY(x) (!x->awaymsg.empty())
934 /** Derived from Resolver, and performs user forward/reverse lookups.
936 class CoreExport UserResolver : public Resolver
939 /** UUID we are looking up */
941 /** True if the lookup is forward, false if is a reverse lookup
945 /** Create a resolver.
946 * @param user The user to begin lookup on
947 * @param to_resolve The IP or host to resolve
948 * @param qt The query type
949 * @param cache Modified by the constructor if the result was cached
951 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
953 /** Called on successful lookup
954 * @param result Result string
955 * @param ttl Time to live for result
956 * @param cached True if the result was found in the cache
958 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
960 /** Called on failed lookup
961 * @param e Error code
962 * @param errormessage Error message string
964 void OnError(ResolverError e, const std::string &errormessage);