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/>.
28 #include "inspsocket.h"
30 #include "membership.h"
32 /** connect class types
39 /** named connect block (for opers, etc) */
43 /** RFC1459 channel modes
46 /** +s: Server notice mask */
47 UM_SNOMASK = 's' - 65,
49 UM_WALLOPS = 'w' - 65,
51 UM_INVISIBLE = 'i' - 65,
53 UM_OPERATOR = 'o' - 65
56 /** Registration state of a user, e.g.
57 * have they sent USER, NICK, PASS yet?
59 enum RegistrationState {
61 #ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
62 REG_NONE = 0, /* Has sent nothing */
65 REG_USER = 1, /* Has sent USER */
66 REG_NICK = 2, /* Has sent NICK */
67 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
68 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
77 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
79 struct CoreExport ConnectClass : public refcountbase
81 reference<ConfigTag> config;
82 /** Type of line, either CC_ALLOW or CC_DENY
86 /** True if this class uses fake lag to manage flood, false if it kills */
89 /** Connect class name
93 /** Max time to register the connection in seconds
95 unsigned int registration_timeout;
97 /** Host mask for this line
101 /** Number of seconds between pings for this line
103 unsigned int pingtime;
105 /** Maximum size of sendq for users in this class (bytes)
106 * Users cannot send commands if they go over this limit
108 unsigned long softsendqmax;
110 /** Maximum size of sendq for users in this class (bytes)
111 * Users are killed if they go over this limit
113 unsigned long hardsendqmax;
115 /** Maximum size of recvq for users in this class (bytes)
117 unsigned long recvqmax;
119 /** Seconds worth of penalty before penalty system activates
121 unsigned int penaltythreshold;
123 /** Maximum rate of commands (units: millicommands per second) */
124 unsigned int commandrate;
126 /** Local max when connecting by this connection class
128 unsigned long maxlocal;
130 /** Global max when connecting by this connection class
132 unsigned long maxglobal;
134 /** True if max connections for this class is hit and a warning is wanted
138 /** Max channels for this class
140 unsigned int maxchans;
142 /** How many users may be in this connect class before they are refused?
143 * (0 = no limit = default)
147 /** If set to true, no user DNS lookups are to be performed
151 /** Create a new connect class with no settings.
153 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
154 /** Create a new connect class with inherited settings.
156 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
158 /** Update the settings in this block to match the given block */
159 void Update(const ConnectClass* newSettings);
161 const std::string& GetName() { return name; }
162 const std::string& GetHost() { return host; }
164 /** Returns the registration timeout
166 time_t GetRegTimeout()
168 return (registration_timeout ? registration_timeout : 90);
171 /** Returns the ping frequency
173 unsigned int GetPingTime()
175 return (pingtime ? pingtime : 120);
178 /** Returns the maximum sendq value (soft limit)
179 * Note that this is in addition to internal OS buffers
181 unsigned long GetSendqSoftMax()
183 return (softsendqmax ? softsendqmax : 4096);
186 /** Returns the maximum sendq value (hard limit)
188 unsigned long GetSendqHardMax()
190 return (hardsendqmax ? hardsendqmax : 0x100000);
193 /** Returns the maximum recvq value
195 unsigned long GetRecvqMax()
197 return (recvqmax ? recvqmax : 4096);
200 /** Returns the penalty threshold value
202 unsigned int GetPenaltyThreshold()
204 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
207 unsigned int GetCommandRate()
209 return commandrate ? commandrate : 1000;
212 /** Return the maximum number of local sessions
214 unsigned long GetMaxLocal()
219 /** Returns the maximum number of global sessions
221 unsigned long GetMaxGlobal()
227 /** Holds all information about a user
228 * This class stores all information about a user connected to the irc server. Everything about a
229 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
230 * user's nickname and hostname.
232 class CoreExport User : public Extensible
235 /** Cached nick!ident@dhost value using the displayed hostname
237 std::string cached_fullhost;
239 /** Cached ident@ip value using the real IP address
241 std::string cached_hostip;
243 /** Cached ident@realhost value using the real hostname
245 std::string cached_makehost;
247 /** Cached nick!ident@realhost value using the real hostname
249 std::string cached_fullrealhost;
251 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
253 std::string cachedip;
257 /** Hostname of connection.
258 * This should be valid as per RFC1035.
262 /** Time that the object was instantiated (used for TS calculation etc)
266 /** Time the connection was created, set in the constructor. This
267 * may be different from the time the user's classbase object was
272 /** Client address that the user is connected from.
273 * Do not modify this value directly, use SetClientIP() to change it.
274 * Port is not valid for remote users.
276 irc::sockets::sockaddrs client_sa;
278 /** The users nickname.
279 * An invalid nickname indicates an unregistered connection prior to the NICK command.
280 * Use InspIRCd::IsNick() to validate nicknames.
284 /** The user's unique identifier.
285 * This is the unique identifier which the user has across the network.
287 const std::string uuid;
289 /** The users ident reply.
290 * Two characters are added to the user-defined limit to compensate for the tilde etc.
294 /** The host displayed to non-opers (used for cloaking etc).
295 * This usually matches the value of User::host.
299 /** The users full name (GECOS).
301 std::string fullname;
303 /** The user's mode list.
304 * NOT a null terminated string.
306 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
307 * if (modes[modeletter-65]) is set, then the mode is
308 * set, for example, to work out if mode +s is set, we check the field
309 * User::modes['s'-65] != 0.
310 * The following RFC characters o, w, s, i have constants defined via an
311 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
313 std::bitset<64> modes;
315 /** What snomasks are set on this user.
316 * This functions the same as the above modes.
318 std::bitset<64> snomasks;
320 /** Channels this user is on
324 /** The server the user is connected to.
326 const std::string server;
328 /** The user's away message.
329 * If this string is empty, the user is not marked as away.
333 /** Time the user last went away.
334 * This is ONLY RELIABLE if user IsAway()!
338 /** The oper type they logged in as, if they are an oper.
340 reference<OperInfo> oper;
342 /** Used by User to indicate the registration status of the connection
343 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
344 * the connection state.
346 unsigned int registered:3;
348 /** Whether or not to send an snotice about this user's quitting
350 unsigned int quietquit:1;
352 /** If this is set to true, then all socket operations for the user
353 * are dropped into the bit-bucket.
354 * This value is set by QuitUser, and is not needed seperately from that call.
355 * Please note that setting this value alone will NOT cause the user to quit.
357 unsigned int quitting:1;
359 /** What type of user is this? */
360 const unsigned int usertype:2;
362 /** Get client IP string from sockaddr, using static internal buffer
363 * @return The IP string
365 const std::string& GetIPString();
367 /** Get CIDR mask, using default range, for this user
369 irc::sockets::cidr_mask GetCIDRMask();
371 /** Sets the client IP for this user
372 * @return true if the conversion was successful
374 virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
376 virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
379 * @throw CoreException if the UID allocated to the user already exists
381 User(const std::string &uid, const std::string& srv, int objtype);
383 /** Returns the full displayed host of the user
384 * This member function returns the hostname of the user as seen by other users
385 * on the server, in nick!ident\@host form.
386 * @return The full masked host of the user
388 virtual const std::string& GetFullHost();
390 /** Returns the full real host of the user
391 * This member function returns the hostname of the user as seen by other users
392 * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
393 * e.g. through a module, then this method will ignore it and return the true hostname.
394 * @return The full real host of the user
396 virtual const std::string& GetFullRealHost();
398 /** This clears any cached results that are used for GetFullRealHost() etc.
399 * The results of these calls are cached as generating them can be generally expensive.
401 void InvalidateCache();
403 /** Create a displayable mode string for this users snomasks
404 * @return The notice mask character sequence
406 std::string FormatNoticeMasks();
408 /** Process a snomask modifier string, e.g. +abc-de
409 * @param sm A sequence of notice mask characters
410 * @return The cleaned mode sequence which can be output,
411 * e.g. in the above example if masks c and e are not
412 * valid, this function will return +ab-d
414 std::string ProcessNoticeMasks(const char *sm);
416 /** Returns whether this user is currently away or not. If true,
417 * further information can be found in User::awaymsg and User::awaytime
418 * @return True if the user is away, false otherwise
420 bool IsAway() const { return (!awaymsg.empty()); }
422 /** Returns whether this user is an oper or not. If true,
423 * oper information can be obtained from User::oper
424 * @return True if the user is an oper, false otherwise
426 bool IsOper() const { return oper; }
428 /** Returns true if a notice mask is set
429 * @param sm A notice mask character to check
430 * @return True if the notice mask is set
432 bool IsNoticeMaskSet(unsigned char sm);
434 /** Changed a specific notice mask value
435 * @param sm The server notice mask to change
436 * @param value An on/off value for this mask
438 void SetNoticeMask(unsigned char sm, bool value);
440 /** Create a displayable mode string for this users umodes
441 * @param showparameters The mode string
443 const char* FormatModes(bool showparameters = false);
445 /** Returns true if a specific mode is set
446 * @param m The user mode
447 * @return True if the mode is set
449 bool IsModeSet(unsigned char m);
450 bool IsModeSet(ModeHandler* mh);
451 bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
453 /** Set a specific usermode to on or off
454 * @param m The user mode
455 * @param value On or off setting of the mode
457 void SetMode(unsigned char m, bool value);
458 void SetMode(ModeHandler* mh, bool value);
459 void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
461 /** Returns true or false for if a user can execute a privilaged oper command.
462 * This is done by looking up their oper type from User::oper, then referencing
463 * this to their oper classes and checking the commands they can execute.
464 * @param command A command (should be all CAPS)
465 * @return True if this user can execute the command
467 virtual bool HasPermission(const std::string &command);
469 /** Returns true if a user has a given permission.
470 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
471 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
473 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
474 * @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.
475 * @return True if this user has the permission in question.
477 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
479 /** Returns true or false if a user can set a privileged user or channel mode.
480 * This is done by looking up their oper type from User::oper, then referencing
481 * this to their oper classes, and checking the modes they can set.
482 * @param mode The mode the check
483 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
484 * @return True if the user can set or unset this mode.
486 virtual bool HasModePermission(unsigned char mode, ModeType type);
488 /** Creates a usermask with real host.
489 * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
490 * @return the usermask in the format user\@host
492 const std::string& MakeHost();
494 /** Creates a usermask with real ip.
495 * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
496 * @return the usermask in the format user\@ip
498 const std::string& MakeHostIP();
500 /** Oper up the user using the given opertype.
501 * This will also give the +o usermode.
503 void Oper(OperInfo* info);
505 /** Force a nickname change.
506 * If the nickname change fails (for example, because the nick in question
507 * already exists) this function will return false, and you must then either
508 * output an error message, or quit the user for nickname collision.
509 * @param newnick The nickname to change to
510 * @return True if the nickchange was successful.
512 bool ForceNickChange(const std::string& newnick) { return ChangeNick(newnick, true); }
515 * This will clear the +o usermode and unset the user's oper type
519 /** Write text to this user, appending CR/LF. Works on local users only.
520 * @param text A std::string to send to the user
522 virtual void Write(const std::string &text);
524 /** Write text to this user, appending CR/LF.
525 * Works on local users only.
526 * @param text The format string for text to send to the user
527 * @param ... POD-type format arguments
529 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
531 /** Write text to this user, appending CR/LF and prepending :server.name
532 * Works on local users only.
533 * @param text A std::string to send to the user
535 void WriteServ(const std::string& text);
537 /** Write text to this user, appending CR/LF and prepending :server.name
538 * Works on local users only.
539 * @param text The format string for text to send to the user
540 * @param ... POD-type format arguments
542 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
544 /** Sends a server notice to this user.
545 * @param text The contents of the message to send.
547 void WriteNotice(const std::string& text);
549 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
551 void WriteNumeric(unsigned int numeric, const std::string &text);
553 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
554 * @param user The user to prepend the :nick!user\@host of
555 * @param text A std::string to send to the user
557 void WriteFrom(User *user, const std::string &text);
559 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
560 * @param user The user to prepend the :nick!user\@host of
561 * @param text The format string for text to send to the user
562 * @param ... POD-type format arguments
564 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
566 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
567 * @param dest The user to route the message to
568 * @param data A std::string to send to the user
570 void WriteTo(User *dest, const std::string &data);
572 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user\@host.
573 * @param dest The user to route the message to
574 * @param data The format string for text to send to the user
575 * @param ... POD-type format arguments
577 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
579 /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
580 * @param line A std::string to send to the users
581 * @param include_self Should the message be sent back to the author?
583 void WriteCommonRaw(const std::string &line, bool include_self = true);
585 /** Write to all users that can see this user (including this user in the list), appending CR/LF
586 * @param text The format string for text to send to the users
587 * @param ... POD-type format arguments
589 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
591 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
592 * @param text The format string for text to send to the users
593 * @param ... POD-type format arguments
595 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
597 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
598 * quit message for opers only.
599 * @param normal_text Normal user quit message
600 * @param oper_text Oper only quit message
602 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
604 /** Dump text to a user target, splitting it appropriately to fit
605 * @param linePrefix text to prefix each complete line with
606 * @param textStream the text to send to the user
608 void SendText(const std::string& linePrefix, std::stringstream& textStream);
610 /** Write to the user, routing the line if the user is remote.
612 virtual void SendText(const std::string& line) = 0;
614 /** Write to the user, routing the line if the user is remote.
616 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
618 /** Return true if the user shares at least one channel with another user
619 * @param other The other user to compare the channel list against
620 * @return True if the given user shares at least one channel with this user
622 bool SharesChannelWith(User *other);
624 /** Send fake quit/join messages for host or ident cycle.
625 * Run this after the item in question has changed.
626 * You should not need to use this function, call ChangeDisplayedHost instead
628 * @param quitline The entire QUIT line, including the source using the old value
630 void DoHostCycle(const std::string &quitline);
632 /** Change the displayed host of a user.
633 * ALWAYS use this function, rather than writing User::dhost directly,
634 * as this triggers module events allowing the change to be syncronized to
635 * remote servers. This will also emulate a QUIT and rejoin (where configured)
636 * before setting their host field.
637 * @param host The new hostname to set
638 * @return True if the change succeeded, false if it didn't
640 bool ChangeDisplayedHost(const char* host);
642 /** Change the ident (username) of a user.
643 * ALWAYS use this function, rather than writing User::ident directly,
644 * as this correctly causes the user to seem to quit (where configured)
645 * before setting their ident field.
646 * @param newident The new ident to set
647 * @return True if the change succeeded, false if it didn't
649 bool ChangeIdent(const char* newident);
651 /** Change a users realname field.
652 * ALWAYS use this function, rather than writing User::fullname directly,
653 * as this triggers module events allowing the change to be syncronized to
655 * @param gecos The user's new realname
656 * @return True if the change succeeded, false if otherwise
658 bool ChangeName(const char* gecos);
660 /** Change a user's nick
661 * @param newnick The new nick
662 * @param force True if the change is being forced (should not be blocked by modes like +N)
663 * @return True if the change succeeded
665 bool ChangeNick(const std::string& newnick, bool force = false);
667 /** Send a command to all local users from this user
668 * The command given must be able to send text with the
669 * first parameter as a servermask (e.g. $*), so basically
670 * you should use PRIVMSG or NOTICE.
671 * @param command the command to send
672 * @param text The text format string to send
673 * @param ... Format arguments
675 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
677 /** Remove this user from all channels they are on, and delete any that are now empty.
678 * This is used by QUIT, and will not send part messages!
680 void PurgeEmptyChannels();
682 /** Get the connect class which this user belongs to. NULL for remote users.
683 * @return A pointer to this user's connect class.
685 virtual ConnectClass* GetClass();
687 /** Default destructor
690 virtual CullResult cull();
693 class CoreExport UserIOHandler : public StreamSocket
696 LocalUser* const user;
697 UserIOHandler(LocalUser* me) : user(me) {}
699 void OnError(BufferedSocketError error);
701 /** Adds to the user's write buffer.
702 * You may add any amount of text up to this users sendq value, if you exceed the
703 * sendq value, the user will be removed, and further buffer adds will be dropped.
704 * @param data The data to add to the write buffer
706 void AddWriteBuf(const std::string &data);
709 typedef unsigned int already_sent_t;
711 class CoreExport LocalUser : public User, public InviteBase
714 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
719 /** Position in UserManager::local_users
721 LocalUserList::iterator localuseriter;
723 /** Stats counter for bytes inbound
725 unsigned int bytes_in;
727 /** Stats counter for bytes outbound
729 unsigned int bytes_out;
731 /** Stats counter for commands inbound
733 unsigned int cmds_in;
735 /** Stats counter for commands outbound
737 unsigned int cmds_out;
739 /** Password specified by the user when they registered (if any).
740 * This is stored even if the \<connect> block doesnt need a password, so that
741 * modules may check it.
743 std::string password;
745 /** Contains a pointer to the connect class a user is on from
747 reference<ConnectClass> MyClass;
749 ConnectClass* GetClass();
751 /** Call this method to find the matching \<connect> for a user, and to check them against it.
755 /** Server address and port that this user is connected to.
757 irc::sockets::sockaddrs server_sa;
760 * @return The port number of this user.
764 /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
765 * This can't be handled normally because QuitUser itself calls Write on other
766 * users, which could trigger their SendQ to overrun.
768 unsigned int quitting_sendq:1;
770 /** has the user responded to their previous ping?
772 unsigned int lastping:1;
774 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
776 unsigned int exempt:1;
778 /** Used by PING checking code
782 /** Time that the connection last sent a message, used to calculate idle time
786 /** This value contains how far into the penalty threshold the user is.
787 * This is used either to enable fake lag or for excess flood quits
789 unsigned int CommandFloodPenalty;
791 static already_sent_t already_sent_id;
792 already_sent_t already_sent;
794 /** Check if the user matches a G or K line, and disconnect them if they do.
795 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
796 * Returns true if the user matched a ban, false else.
798 bool CheckLines(bool doZline = false);
800 /** Use this method to fully connect a user.
801 * This will send the message of the day, check G/K/E lines, etc.
805 /** Set the connect class to which this user belongs to.
806 * @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.
807 * @return A reference to this user's current connect class.
809 void SetClass(const std::string &explicit_name = "");
811 bool SetClientIP(const char* sip, bool recheck_eline = true);
813 void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
815 void SendText(const std::string& line);
816 void Write(const std::string& text);
817 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
819 /** Returns the list of channels this user has been invited to but has not yet joined.
820 * @return A list of channels the user is invited to
822 InviteList& GetInviteList();
824 /** Returns true if a user is invited to a channel.
825 * @param chan A channel to look up
826 * @return True if the user is invited to the given channel
828 bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
830 /** Removes a channel from a users invite list.
831 * This member function is called on successfully joining an invite only channel
832 * to which the user has previously been invited, to clear the invitation.
833 * @param chan The channel to remove the invite to
834 * @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
836 bool RemoveInvite(Channel* chan);
838 void RemoveExpiredInvites();
840 /** Returns true or false for if a user can execute a privilaged oper command.
841 * This is done by looking up their oper type from User::oper, then referencing
842 * this to their oper classes and checking the commands they can execute.
843 * @param command A command (should be all CAPS)
844 * @return True if this user can execute the command
846 bool HasPermission(const std::string &command);
848 /** Returns true if a user has a given permission.
849 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
850 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
852 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
853 * @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.
854 * @return True if this user has the permission in question.
856 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
858 /** Returns true or false if a user can set a privileged user or channel mode.
859 * This is done by looking up their oper type from User::oper, then referencing
860 * this to their oper classes, and checking the modes they can set.
861 * @param mode The mode the check
862 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
863 * @return True if the user can set or unset this mode.
865 bool HasModePermission(unsigned char mode, ModeType type);
868 class CoreExport RemoteUser : public User
871 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
874 virtual void SendText(const std::string& line);
877 class CoreExport FakeUser : public User
880 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
885 virtual CullResult cull();
886 virtual void SendText(const std::string& line);
887 virtual const std::string& GetFullHost();
888 virtual const std::string& GetFullRealHost();
891 /* Faster than dynamic_cast */
892 /** Is a local user */
893 inline LocalUser* IS_LOCAL(User* u)
895 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
897 /** Is a remote user */
898 inline RemoteUser* IS_REMOTE(User* u)
900 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
902 /** Is a server fakeuser */
903 inline FakeUser* IS_SERVER(User* u)
905 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
908 inline bool User::IsModeSet(ModeHandler* mh)
910 char m = mh->GetModeChar();
911 return (modes[m-65]);
914 inline void User::SetMode(ModeHandler* mh, bool value)
916 char m = mh->GetModeChar();