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"
33 /** connect class types
40 /** named connect block (for opers, etc) */
44 /** RFC1459 channel modes
47 /** +s: Server notice mask */
48 UM_SNOMASK = 's' - 65,
50 UM_WALLOPS = 'w' - 65,
52 UM_INVISIBLE = 'i' - 65,
54 UM_OPERATOR = 'o' - 65
57 /** Registration state of a user, e.g.
58 * have they sent USER, NICK, PASS yet?
60 enum RegistrationState {
62 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
63 REG_NONE = 0, /* Has sent nothing */
66 REG_USER = 1, /* Has sent USER */
67 REG_NICK = 2, /* Has sent NICK */
68 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
69 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
78 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
80 struct CoreExport ConnectClass : public refcountbase
82 reference<ConfigTag> config;
83 /** Type of line, either CC_ALLOW or CC_DENY
87 /** True if this class uses fake lag to manage flood, false if it kills */
90 /** Connect class name
94 /** Max time to register the connection in seconds
96 unsigned int registration_timeout;
98 /** Host mask for this line
102 /** Number of seconds between pings for this line
104 unsigned int pingtime;
106 /** Maximum size of sendq for users in this class (bytes)
107 * Users cannot send commands if they go over this limit
109 unsigned long softsendqmax;
111 /** Maximum size of sendq for users in this class (bytes)
112 * Users are killed if they go over this limit
114 unsigned long hardsendqmax;
116 /** Maximum size of recvq for users in this class (bytes)
118 unsigned long recvqmax;
120 /** Seconds worth of penalty before penalty system activates
122 unsigned int penaltythreshold;
124 /** Maximum rate of commands (units: millicommands per second) */
125 unsigned int commandrate;
127 /** Local max when connecting by this connection class
129 unsigned long maxlocal;
131 /** Global max when connecting by this connection class
133 unsigned long maxglobal;
135 /** True if max connections for this class is hit and a warning is wanted
139 /** Max channels for this class
141 unsigned int maxchans;
143 /** How many users may be in this connect class before they are refused?
144 * (0 = no limit = default)
148 /** Create a new connect class with no settings.
150 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
151 /** Create a new connect class with inherited settings.
153 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
155 /** Update the settings in this block to match the given block */
156 void Update(const ConnectClass* newSettings);
158 const std::string& GetName() { return name; }
159 const std::string& GetHost() { return host; }
161 /** Returns the registration timeout
163 time_t GetRegTimeout()
165 return (registration_timeout ? registration_timeout : 90);
168 /** Returns the ping frequency
170 unsigned int GetPingTime()
172 return (pingtime ? pingtime : 120);
175 /** Returns the maximum sendq value (soft limit)
176 * Note that this is in addition to internal OS buffers
178 unsigned long GetSendqSoftMax()
180 return (softsendqmax ? softsendqmax : 4096);
183 /** Returns the maximum sendq value (hard limit)
185 unsigned long GetSendqHardMax()
187 return (hardsendqmax ? hardsendqmax : 0x100000);
190 /** Returns the maximum recvq value
192 unsigned long GetRecvqMax()
194 return (recvqmax ? recvqmax : 4096);
197 /** Returns the penalty threshold value
199 unsigned int GetPenaltyThreshold()
201 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
204 unsigned int GetCommandRate()
206 return commandrate ? commandrate : 1000;
209 /** Return the maximum number of local sessions
211 unsigned long GetMaxLocal()
216 /** Returns the maximum number of global sessions
218 unsigned long GetMaxGlobal()
224 /** Holds all information about a user
225 * This class stores all information about a user connected to the irc server. Everything about a
226 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
227 * user's nickname and hostname.
229 class CoreExport User : public Extensible
232 /** Cached nick!ident@dhost value using the displayed hostname
234 std::string cached_fullhost;
236 /** Cached ident@ip value using the real IP address
238 std::string cached_hostip;
240 /** Cached ident@realhost value using the real hostname
242 std::string cached_makehost;
244 /** Cached nick!ident@realhost value using the real hostname
246 std::string cached_fullrealhost;
248 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
250 std::string cachedip;
254 /** Hostname of connection.
255 * This should be valid as per RFC1035.
259 /** Time that the object was instantiated (used for TS calculation etc)
263 /** Time the connection was created, set in the constructor. This
264 * may be different from the time the user's classbase object was
269 /** Time that the connection last sent a message, used to calculate idle time
273 /** Client address that the user is connected from.
274 * Do not modify this value directly, use SetClientIP() to change it.
275 * Port is not valid for remote users.
277 irc::sockets::sockaddrs client_sa;
279 /** The users nickname.
280 * An invalid nickname indicates an unregistered connection prior to the NICK command.
281 * Use InspIRCd::IsNick() to validate nicknames.
285 /** The user's unique identifier.
286 * This is the unique identifier which the user has across the network.
288 const std::string uuid;
290 /** The users ident reply.
291 * Two characters are added to the user-defined limit to compensate for the tilde etc.
295 /** The host displayed to non-opers (used for cloaking etc).
296 * This usually matches the value of User::host.
300 /** The users full name (GECOS).
302 std::string fullname;
304 /** The user's mode list.
305 * NOT a null terminated string.
307 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
308 * if (modes[modeletter-65]) is set, then the mode is
309 * set, for example, to work out if mode +s is set, we check the field
310 * User::modes['s'-65] != 0.
311 * The following RFC characters o, w, s, i have constants defined via an
312 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
314 std::bitset<64> modes;
316 /** What snomasks are set on this user.
317 * This functions the same as the above modes.
319 std::bitset<64> snomasks;
321 /** Channels this user is on
325 /** The server the user is connected to.
327 const std::string server;
329 /** The user's away message.
330 * If this string is empty, the user is not marked as away.
334 /** Time the user last went away.
335 * This is ONLY RELIABLE if user IS_AWAY()!
339 /** The oper type they logged in as, if they are an oper.
341 reference<OperInfo> oper;
343 /** Used by User to indicate the registration status of the connection
344 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
345 * the connection state.
347 unsigned int registered:3;
349 /** True when DNS lookups are completed.
350 * The UserResolver classes res_forward and res_reverse will
351 * set this value once they complete.
353 unsigned int dns_done:1;
355 /** Whether or not to send an snotice about this user's quitting
357 unsigned int quietquit:1;
359 /** If this is set to true, then all socket operations for the user
360 * are dropped into the bit-bucket.
361 * This value is set by QuitUser, and is not needed seperately from that call.
362 * Please note that setting this value alone will NOT cause the user to quit.
364 unsigned int quitting:1;
366 /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
367 * This can't be handled normally because QuitUser itself calls Write on other
368 * users, which could trigger their SendQ to overrun.
370 unsigned int quitting_sendq:1;
372 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
374 unsigned int exempt:1;
376 /** has the user responded to their previous ping?
378 unsigned int lastping:1;
380 /** What type of user is this? */
381 const unsigned int usertype:2;
383 /** Get client IP string from sockaddr, using static internal buffer
384 * @return The IP string
386 const char* GetIPString();
388 /** Get CIDR mask, using default range, for this user
390 irc::sockets::cidr_mask GetCIDRMask();
392 /** Sets the client IP for this user
393 * @return true if the conversion was successful
395 bool SetClientIP(const char* sip);
398 * @throw CoreException if the UID allocated to the user already exists
400 User(const std::string &uid, const std::string& srv, int objtype);
402 /** Check if the user matches a G or K line, and disconnect them if they do.
403 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
404 * Returns true if the user matched a ban, false else.
406 bool CheckLines(bool doZline = false);
408 /** Returns the full displayed host of the user
409 * This member function returns the hostname of the user as seen by other users
410 * on the server, in nick!ident&at;host form.
411 * @return The full masked host of the user
413 virtual const std::string& GetFullHost();
415 /** Returns the full real host of the user
416 * This member function returns the hostname of the user as seen by other users
417 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
418 * e.g. through a module, then this method will ignore it and return the true hostname.
419 * @return The full real host of the user
421 virtual const std::string& GetFullRealHost();
423 /** This clears any cached results that are used for GetFullRealHost() etc.
424 * The results of these calls are cached as generating them can be generally expensive.
426 void InvalidateCache();
428 /** Create a displayable mode string for this users snomasks
429 * @return The notice mask character sequence
431 const char* FormatNoticeMasks();
433 /** Process a snomask modifier string, e.g. +abc-de
434 * @param sm A sequence of notice mask characters
435 * @return The cleaned mode sequence which can be output,
436 * e.g. in the above example if masks c and e are not
437 * valid, this function will return +ab-d
439 std::string ProcessNoticeMasks(const char *sm);
441 /** Returns true if a notice mask is set
442 * @param sm A notice mask character to check
443 * @return True if the notice mask is set
445 bool IsNoticeMaskSet(unsigned char sm);
447 /** Changed a specific notice mask value
448 * @param sm The server notice mask to change
449 * @param value An on/off value for this mask
451 void SetNoticeMask(unsigned char sm, bool value);
453 /** Create a displayable mode string for this users umodes
454 * @param The mode string
456 const char* FormatModes(bool showparameters = false);
458 /** Returns true if a specific mode is set
459 * @param m The user mode
460 * @return True if the mode is set
462 bool IsModeSet(unsigned char m);
464 /** Set a specific usermode to on or off
465 * @param m The user mode
466 * @param value On or off setting of the mode
468 void SetMode(unsigned char m, bool value);
470 /** Returns true or false for if a user can execute a privilaged oper command.
471 * This is done by looking up their oper type from User::oper, then referencing
472 * this to their oper classes and checking the commands they can execute.
473 * @param command A command (should be all CAPS)
474 * @return True if this user can execute the command
476 virtual bool HasPermission(const std::string &command);
478 /** Returns true if a user has a given permission.
479 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
480 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
482 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
483 * @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.
484 * @return True if this user has the permission in question.
486 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
488 /** Returns true or false if a user can set a privileged user or channel mode.
489 * This is done by looking up their oper type from User::oper, then referencing
490 * this to their oper classes, and checking the modes they can set.
491 * @param mode The mode the check
492 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
493 * @return True if the user can set or unset this mode.
495 virtual bool HasModePermission(unsigned char mode, ModeType type);
497 /** Creates a wildcard host.
498 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
499 * @return The wildcarded hostname in *!*@host form
501 char* MakeWildHost();
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 /** Add the user to WHOWAS system
519 /** Oper up the user using the given opertype.
520 * This will also give the +o usermode.
522 void Oper(OperInfo* info);
524 /** Force a nickname change.
525 * If the nickname change fails (for example, because the nick in question
526 * already exists) this function will return false, and you must then either
527 * output an error message, or quit the user for nickname collision.
528 * @param newnick The nickname to change to
529 * @return True if the nickchange was successful.
531 inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
534 * This will clear the +o usermode and unset the user's oper type
538 /** Write text to this user, appending CR/LF. Works on local users only.
539 * @param text A std::string to send to the user
541 virtual void Write(const std::string &text);
543 /** Write text to this user, appending CR/LF.
544 * Works on local users only.
545 * @param text The format string for text to send to the user
546 * @param ... POD-type format arguments
548 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
550 /** Write text to this user, appending CR/LF and prepending :server.name
551 * Works on local users only.
552 * @param text A std::string to send to the user
554 void WriteServ(const std::string& text);
556 /** Write text to this user, appending CR/LF and prepending :server.name
557 * Works on local users only.
558 * @param text The format string for text to send to the user
559 * @param ... POD-type format arguments
561 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
563 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
565 void WriteNumeric(unsigned int numeric, const std::string &text);
567 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
568 * @param user The user to prepend the :nick!user@host of
569 * @param text A std::string to send to the user
571 void WriteFrom(User *user, const std::string &text);
573 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
574 * @param user The user to prepend the :nick!user@host of
575 * @param text The format string for text to send to the user
576 * @param ... POD-type format arguments
578 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
580 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
581 * @param dest The user to route the message to
582 * @param text A std::string to send to the user
584 void WriteTo(User *dest, const std::string &data);
586 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
587 * @param dest The user to route the message to
588 * @param text The format string for text to send to the user
589 * @param ... POD-type format arguments
591 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
593 /** Write to all users that can see this user (including this user in the list), appending CR/LF
594 * @param text A std::string to send to the users
596 void WriteCommonRaw(const std::string &line, bool include_self = true);
598 /** Write to all users that can see this user (including this user in the list), appending CR/LF
599 * @param text The format string for text to send to the users
600 * @param ... POD-type format arguments
602 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
604 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
605 * @param text The format string for text to send to the users
606 * @param ... POD-type format arguments
608 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
610 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
611 * quit message for opers only.
612 * @param normal_text Normal user quit message
613 * @param oper_text Oper only quit message
615 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
617 /** Dump text to a user target, splitting it appropriately to fit
618 * @param LinePrefix text to prefix each complete line with
619 * @param TextStream the text to send to the user
621 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
623 /** Write to the user, routing the line if the user is remote.
625 virtual void SendText(const std::string& line) = 0;
627 /** Write to the user, routing the line if the user is remote.
629 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
631 /** Return true if the user shares at least one channel with another user
632 * @param other The other user to compare the channel list against
633 * @return True if the given user shares at least one channel with this user
635 bool SharesChannelWith(User *other);
637 /** Send fake quit/join messages for host or ident cycle.
638 * Run this after the item in question has changed.
639 * You should not need to use this function, call ChangeDisplayedHost instead
641 * @param The entire QUIT line, including the source using the old value
643 void DoHostCycle(const std::string &quitline);
645 /** Change the displayed host of a user.
646 * ALWAYS use this function, rather than writing User::dhost directly,
647 * as this triggers module events allowing the change to be syncronized to
648 * remote servers. This will also emulate a QUIT and rejoin (where configured)
649 * before setting their host field.
650 * @param host The new hostname to set
651 * @return True if the change succeeded, false if it didn't
653 bool ChangeDisplayedHost(const char* host);
655 /** Change the ident (username) of a user.
656 * ALWAYS use this function, rather than writing User::ident directly,
657 * as this correctly causes the user to seem to quit (where configured)
658 * before setting their ident field.
659 * @param host The new ident to set
660 * @return True if the change succeeded, false if it didn't
662 bool ChangeIdent(const char* newident);
664 /** Change a users realname field.
665 * ALWAYS use this function, rather than writing User::fullname directly,
666 * as this triggers module events allowing the change to be syncronized to
668 * @param gecos The user's new realname
669 * @return True if the change succeeded, false if otherwise
671 bool ChangeName(const char* gecos);
673 /** Change a user's nick
674 * @param newnick The new nick
675 * @param force True if the change is being forced (should not be blocked by modes like +N)
676 * @return True if the change succeeded
678 bool ChangeNick(const std::string& newnick, bool force = false);
680 /** Send a command to all local users from this user
681 * The command given must be able to send text with the
682 * first parameter as a servermask (e.g. $*), so basically
683 * you should use PRIVMSG or NOTICE.
684 * @param command the command to send
685 * @param text The text format string to send
686 * @param ... Format arguments
688 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
690 /** Compile a channel list for this user. Used internally by WHOIS
691 * @param source The user to prepare the channel list for
692 * @param spy Whether to return the spy channel list rather than the normal one
693 * @return This user's channel list
695 std::string ChannelList(User* source, bool spy);
697 /** Split the channel list in cl which came from dest, and spool it to this user
698 * Used internally by WHOIS
699 * @param dest The user the original channel list came from
700 * @param cl The channel list as a string obtained from User::ChannelList()
702 void SplitChanList(User* dest, const std::string &cl);
704 /** Remove this user from all channels they are on, and delete any that are now empty.
705 * This is used by QUIT, and will not send part messages!
707 void PurgeEmptyChannels();
709 /** Get the connect class which this user belongs to. NULL for remote users.
710 * @return A pointer to this user's connect class.
712 virtual ConnectClass* GetClass();
714 /** Default destructor
717 virtual CullResult cull();
720 class CoreExport UserIOHandler : public StreamSocket
723 LocalUser* const user;
724 UserIOHandler(LocalUser* me) : user(me) {}
726 void OnError(BufferedSocketError error);
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);
736 typedef unsigned int already_sent_t;
738 class CoreExport LocalUser : public User
740 /** A list of channels the user has a pending invite to.
741 * Upon INVITE channels are added, and upon JOIN, the
742 * channels are removed from this list.
747 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
752 /** Stats counter for bytes inbound
756 /** Stats counter for bytes outbound
760 /** Stats counter for commands inbound
764 /** Stats counter for commands outbound
768 /** Password specified by the user when they registered (if any).
769 * This is stored even if the <connect> block doesnt need a password, so that
770 * modules may check it.
772 std::string password;
774 /** Contains a pointer to the connect class a user is on from
776 reference<ConnectClass> MyClass;
778 ConnectClass* GetClass();
780 /** Call this method to find the matching <connect> for a user, and to check them against it.
784 /** Server address and port that this user is connected to.
786 irc::sockets::sockaddrs server_sa;
789 * @return The port number of this user.
793 /** Used by PING checking code
797 /** This value contains how far into the penalty threshold the user is.
798 * This is used either to enable fake lag or for excess flood quits
800 unsigned int CommandFloodPenalty;
802 static already_sent_t already_sent_id;
803 already_sent_t already_sent;
805 /** Stored reverse lookup from res_forward. Should not be used after resolution.
807 std::string stored_host;
809 /** Starts a DNS lookup of the user's IP.
810 * This will cause two UserResolver classes to be instantiated.
811 * When complete, these objects set User::dns_done to true.
813 void StartDNSLookup();
815 /** Use this method to fully connect a user.
816 * This will send the message of the day, check G/K/E lines, etc.
820 /** Set the connect class to which this user belongs to.
821 * @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.
822 * @return A reference to this user's current connect class.
824 void SetClass(const std::string &explicit_name = "");
826 void SendText(const std::string& line);
827 void Write(const std::string& text);
828 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
830 /** Returns the list of channels this user has been invited to but has not yet joined.
831 * @return A list of channels the user is invited to
833 InvitedList* GetInviteList();
835 /** Returns true if a user is invited to a channel.
836 * @param channel A channel name to look up
837 * @return True if the user is invited to the given channel
839 bool IsInvited(const irc::string &channel);
841 /** Adds a channel to a users invite list (invites them to a channel)
842 * @param channel A channel name to add
843 * @param timeout When the invite should expire (0 == never)
845 void InviteTo(const irc::string &channel, time_t timeout);
847 /** Removes a channel from a users invite list.
848 * This member function is called on successfully joining an invite only channel
849 * to which the user has previously been invited, to clear the invitation.
850 * @param channel The channel to remove the invite to
852 void RemoveInvite(const irc::string &channel);
854 /** Returns true or false for if a user can execute a privilaged oper command.
855 * This is done by looking up their oper type from User::oper, then referencing
856 * this to their oper classes and checking the commands they can execute.
857 * @param command A command (should be all CAPS)
858 * @return True if this user can execute the command
860 bool HasPermission(const std::string &command);
862 /** Returns true if a user has a given permission.
863 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
864 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
866 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
867 * @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.
868 * @return True if this user has the permission in question.
870 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
872 /** Returns true or false if a user can set a privileged user or channel mode.
873 * This is done by looking up their oper type from User::oper, then referencing
874 * this to their oper classes, and checking the modes they can set.
875 * @param mode The mode the check
876 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
877 * @return True if the user can set or unset this mode.
879 bool HasModePermission(unsigned char mode, ModeType type);
882 class CoreExport RemoteUser : public User
885 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
888 virtual void SendText(const std::string& line);
891 class CoreExport FakeUser : public User
894 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
899 virtual CullResult cull();
900 virtual void SendText(const std::string& line);
901 virtual const std::string& GetFullHost();
902 virtual const std::string& GetFullRealHost();
905 /* Faster than dynamic_cast */
906 /** Is a local user */
907 inline LocalUser* IS_LOCAL(User* u)
909 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
911 /** Is a remote user */
912 inline RemoteUser* IS_REMOTE(User* u)
914 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
916 /** Is a server fakeuser */
917 inline FakeUser* IS_SERVER(User* u)
919 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
922 #define IS_OPER(x) (x->oper)
924 #define IS_AWAY(x) (!x->awaymsg.empty())
926 /** Derived from Resolver, and performs user forward/reverse lookups.
928 class CoreExport UserResolver : public Resolver
931 /** UUID we are looking up */
933 /** True if the lookup is forward, false if is a reverse lookup
937 /** Create a resolver.
938 * @param Instance The creating instance
939 * @param user The user to begin lookup on
940 * @param to_resolve The IP or host to resolve
941 * @param qt The query type
942 * @param cache Modified by the constructor if the result was cached
944 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
946 /** Called on successful lookup
947 * @param result Result string
948 * @param ttl Time to live for result
949 * @param cached True if the result was found in the cache
951 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
953 /** Called on failed lookup
954 * @param e Error code
955 * @param errormessage Error message string
957 void OnError(ResolverError e, const std::string &errormessage);