1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 #include "inspsocket.h"
22 /** connect class types
31 /** RFC1459 channel modes
34 /** +s: Server notice mask */
35 UM_SNOMASK = 's' - 65,
37 UM_WALLOPS = 'w' - 65,
39 UM_INVISIBLE = 'i' - 65,
41 UM_OPERATOR = 'o' - 65
44 /** Registration state of a user, e.g.
45 * have they sent USER, NICK, PASS yet?
47 enum RegistrationState {
49 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
50 REG_NONE = 0, /* Has sent nothing */
53 REG_USER = 1, /* Has sent USER */
54 REG_NICK = 2, /* Has sent NICK */
55 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
56 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
59 /* Required forward declaration */
64 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
66 struct CoreExport ConnectClass : public refcountbase
68 reference<ConfigTag> config;
69 /** Type of line, either CC_ALLOW or CC_DENY
73 /** Connect class name
77 /** Max time to register the connection in seconds
79 unsigned int registration_timeout;
81 /** Host mask for this line
85 /** Number of seconds between pings for this line
87 unsigned int pingtime;
89 /** (Optional) Password for this line
93 /** (Optional) Hash Method for this line
97 /** Maximum size of sendq for users in this class (bytes)
98 * Users cannot send commands if they go over this limit
100 unsigned long softsendqmax;
102 /** Maximum size of sendq for users in this class (bytes)
103 * Users are killed if they go over this limit
105 unsigned long hardsendqmax;
107 /** Maximum size of recvq for users in this class (bytes)
109 unsigned long recvqmax;
111 /** Seconds worth of penalty before penalty system activates
113 unsigned long penaltythreshold;
115 /** Local max when connecting by this connection class
117 unsigned long maxlocal;
119 /** Global max when connecting by this connection class
121 unsigned long maxglobal;
123 /** Max channels for this class
125 unsigned int maxchans;
127 /** Port number this connect class applies to
131 /** How many users may be in this connect class before they are refused?
132 * (0 = no limit = default)
136 /** Create a new connect class with no settings.
138 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
139 /** Create a new connect class with inherited settings.
141 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
143 /** Update the settings in this block to match the given block */
144 void Update(const ConnectClass* newSettings);
147 const std::string& GetName() { return name; }
148 const std::string& GetPass() { return pass; }
149 const std::string& GetHost() { return host; }
150 const int GetPort() { return port; }
152 /** Returns the registration timeout
154 time_t GetRegTimeout()
156 return (registration_timeout ? registration_timeout : 90);
159 /** Returns the ping frequency
161 unsigned int GetPingTime()
163 return (pingtime ? pingtime : 120);
166 /** Returns the maximum sendq value (soft limit)
167 * Note that this is in addition to internal OS buffers
169 unsigned long GetSendqSoftMax()
171 return (softsendqmax ? softsendqmax : 4096);
174 /** Returns the maximum sendq value (hard limit)
176 unsigned long GetSendqHardMax()
178 return (hardsendqmax ? hardsendqmax : 0x100000);
181 /** Returns the maximum recvq value
183 unsigned long GetRecvqMax()
185 return (recvqmax ? recvqmax : 4096);
188 /** Returns the penalty threshold value
190 unsigned long GetPenaltyThreshold()
192 return penaltythreshold;
195 /** Returusn the maximum number of local sessions
197 unsigned long GetMaxLocal()
202 /** Returns the maximum number of global sessions
204 unsigned long GetMaxGlobal()
210 /** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
212 CoreExport typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
214 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
216 CoreExport typedef std::vector<reference<ConnectClass> > ClassVector;
218 /** Typedef for the list of user-channel records for a user
220 CoreExport typedef std::set<Channel*> UserChanList;
222 /** Shorthand for an iterator into a UserChanList
224 CoreExport typedef UserChanList::iterator UCListIter;
226 /* Required forward declaration
230 /** Holds all information about a user
231 * This class stores all information about a user connected to the irc server. Everything about a
232 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
233 * user's nickname and hostname.
235 class CoreExport User : public StreamSocket
238 /** Cached nick!ident@dhost value using the displayed hostname
240 std::string cached_fullhost;
242 /** Cached ident@ip value using the real IP address
244 std::string cached_hostip;
246 /** Cached ident@realhost value using the real hostname
248 std::string cached_makehost;
250 /** Cached nick!ident@realhost value using the real hostname
252 std::string cached_fullrealhost;
254 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
256 std::string cachedip;
258 /** When we erase the user (in the destructor),
259 * we call this method to subtract one from all
260 * mode characters this user is making use of.
262 void DecrementModes();
265 /** Hostname of connection.
266 * This should be valid as per RFC1035.
270 /** Time that the object was instantiated (used for TS calculation etc)
274 /** Time the connection was created, set in the constructor. This
275 * may be different from the time the user's classbase object was
280 /** Time that the connection last sent a message, used to calculate idle time
284 /** Client address that the user is connected from.
285 * Do not modify this value directly, use SetClientIP() to change it
286 * Port is not valid for remote users.
288 irc::sockets::sockaddrs client_sa;
290 /** The users nickname.
291 * An invalid nickname indicates an unregistered connection prior to the NICK command.
292 * Use InspIRCd::IsNick() to validate nicknames.
296 /** The user's unique identifier.
297 * This is the unique identifier which the user has across the network.
301 /** The users ident reply.
302 * Two characters are added to the user-defined limit to compensate for the tilde etc.
306 /** The host displayed to non-opers (used for cloaking etc).
307 * This usually matches the value of User::host.
311 /** The users full name (GECOS).
313 std::string fullname;
315 /** The user's mode list.
316 * NOT a null terminated string.
318 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
319 * if (modes[modeletter-65]) is set, then the mode is
320 * set, for example, to work out if mode +s is set, we check the field
321 * User::modes['s'-65] != 0.
322 * The following RFC characters o, w, s, i have constants defined via an
323 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
325 std::bitset<64> modes;
327 /** What snomasks are set on this user.
328 * This functions the same as the above modes.
330 std::bitset<64> snomasks;
332 /** Channels this user is on
336 /** The server the user is connected to.
340 /** The user's away message.
341 * If this string is empty, the user is not marked as away.
345 /** Time the user last went away.
346 * This is ONLY RELIABLE if user IS_AWAY()!
350 /** The oper type they logged in as, if they are an oper.
351 * This is used to check permissions in operclasses, so that
352 * we can say 'yea' or 'nay' to any commands they issue.
353 * The value of this was the value of a valid 'type name=' tag
357 /** Used by User to indicate the registration status of the connection
358 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
359 * the connection state.
361 unsigned int registered:3;
363 /** True when DNS lookups are completed.
364 * The UserResolver classes res_forward and res_reverse will
365 * set this value once they complete.
367 unsigned int dns_done:1;
369 /** Whether or not to send an snotice about this user's quitting
371 unsigned int quietquit:1;
373 /** If this is set to true, then all socket operations for the user
374 * are dropped into the bit-bucket.
375 * This value is set by QuitUser, and is not needed seperately from that call.
376 * Please note that setting this value alone will NOT cause the user to quit.
378 unsigned int quitting:1;
380 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
382 unsigned int exempt:1;
384 /** has the user responded to their previous ping?
386 unsigned int lastping:1;
388 /** Get client IP string from sockaddr, using static internal buffer
389 * @return The IP string
391 const char* GetIPString();
393 /** Sets the client IP for this user
394 * @return true if the conversion was successful
396 bool SetClientIP(const char* sip);
398 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
399 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
400 * This may be used for CIDR clone detection, etc.
402 * (XXX, brief note: when we do the sockets rewrite, this should move down a
403 * level so it may be used on more derived objects. -- w00t)
405 const char *GetCIDRMask(int range);
407 /** Default constructor
408 * @throw CoreException if the UID allocated to the user already exists
409 * @param Instance Creator instance
410 * @param uid User UUID, or empty to allocate one automatically
412 User(const std::string &uid);
414 /** Check if the user matches a G or K line, and disconnect them if they do.
415 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
416 * Returns true if the user matched a ban, false else.
418 bool CheckLines(bool doZline = false);
420 /** Returns the full displayed host of the user
421 * This member function returns the hostname of the user as seen by other users
422 * on the server, in nick!ident&at;host form.
423 * @return The full masked host of the user
425 virtual const std::string GetFullHost();
427 /** Returns the full real host of the user
428 * This member function returns the hostname of the user as seen by other users
429 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
430 * e.g. through a module, then this method will ignore it and return the true hostname.
431 * @return The full real host of the user
433 virtual const std::string GetFullRealHost();
435 /** This clears any cached results that are used for GetFullRealHost() etc.
436 * The results of these calls are cached as generating them can be generally expensive.
438 void InvalidateCache();
440 /** Create a displayable mode string for this users snomasks
441 * @return The notice mask character sequence
443 const char* FormatNoticeMasks();
445 /** Process a snomask modifier string, e.g. +abc-de
446 * @param sm A sequence of notice mask characters
447 * @return The cleaned mode sequence which can be output,
448 * e.g. in the above example if masks c and e are not
449 * valid, this function will return +ab-d
451 std::string ProcessNoticeMasks(const char *sm);
453 /** Returns true if a notice mask is set
454 * @param sm A notice mask character to check
455 * @return True if the notice mask is set
457 bool IsNoticeMaskSet(unsigned char sm);
459 /** Changed a specific notice mask value
460 * @param sm The server notice mask to change
461 * @param value An on/off value for this mask
463 void SetNoticeMask(unsigned char sm, bool value);
465 /** Create a displayable mode string for this users umodes
466 * @param The mode string
468 const char* FormatModes(bool showparameters = false);
470 /** Returns true if a specific mode is set
471 * @param m The user mode
472 * @return True if the mode is set
474 bool IsModeSet(unsigned char m);
476 /** Set a specific usermode to on or off
477 * @param m The user mode
478 * @param value On or off setting of the mode
480 void SetMode(unsigned char m, bool value);
482 /** Returns true or false for if a user can execute a privilaged oper command.
483 * This is done by looking up their oper type from User::oper, then referencing
484 * this to their oper classes and checking the commands they can execute.
485 * @param command A command (should be all CAPS)
486 * @return True if this user can execute the command
488 virtual bool HasPermission(const std::string &command);
490 /** Returns true if a user has a given permission.
491 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
492 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
494 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
495 * @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.
496 * @return True if this user has the permission in question.
498 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
500 /** Returns true or false if a user can set a privileged user or channel mode.
501 * This is done by looking up their oper type from User::oper, then referencing
502 * this to their oper classes, and checking the modes they can set.
503 * @param mode The mode the check
504 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
505 * @return True if the user can set or unset this mode.
507 virtual bool HasModePermission(unsigned char mode, ModeType type);
509 /** Creates a wildcard host.
510 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
511 * @return The wildcarded hostname in *!*@host form
513 char* MakeWildHost();
515 /** Creates a usermask with real host.
516 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
517 * @return the usermask in the format user@host
519 const std::string& MakeHost();
521 /** Creates a usermask with real ip.
522 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
523 * @return the usermask in the format user@ip
525 const std::string& MakeHostIP();
527 /** Add the user to WHOWAS system
531 /** Oper up the user using the given opertype.
532 * This will also give the +o usermode.
533 * @param opertype The oper type to oper as
535 void Oper(const std::string &opertype, const std::string &opername);
537 /** Change this users hash key to a new string.
538 * You should not call this function directly. It is used by the core
539 * to update the users hash entry on a nickchange.
540 * @param New new user_hash key
541 * @return Pointer to User in hash (usually 'this')
543 User* UpdateNickHash(const char* New);
545 /** Force a nickname change.
546 * If the nickname change fails (for example, because the nick in question
547 * already exists) this function will return false, and you must then either
548 * output an error message, or quit the user for nickname collision.
549 * @param newnick The nickname to change to
550 * @return True if the nickchange was successful.
552 bool ForceNickChange(const char* newnick);
555 * This will clear the +o usermode and unset the user's oper type
559 /** Write text to this user, appending CR/LF. Works on local users only.
560 * @param text A std::string to send to the user
562 virtual void Write(const std::string &text);
564 /** Write text to this user, appending CR/LF.
565 * Works on local users only.
566 * @param text The format string for text to send to the user
567 * @param ... POD-type format arguments
569 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
571 /** Write text to this user, appending CR/LF and prepending :server.name
572 * Works on local users only.
573 * @param text A std::string to send to the user
575 void WriteServ(const std::string& text);
577 /** Write text to this user, appending CR/LF and prepending :server.name
578 * Works on local users only.
579 * @param text The format string for text to send to the user
580 * @param ... POD-type format arguments
582 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
584 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
586 void WriteNumeric(unsigned int numeric, const std::string &text);
588 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
589 * @param user The user to prepend the :nick!user@host of
590 * @param text A std::string to send to the user
592 void WriteFrom(User *user, const std::string &text);
594 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
595 * @param user The user to prepend the :nick!user@host of
596 * @param text The format string for text to send to the user
597 * @param ... POD-type format arguments
599 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
601 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
602 * @param dest The user to route the message to
603 * @param text A std::string to send to the user
605 void WriteTo(User *dest, const std::string &data);
607 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
608 * @param dest The user to route the message to
609 * @param text The format string for text to send to the user
610 * @param ... POD-type format arguments
612 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
614 /** Write to all users that can see this user (including this user in the list), appending CR/LF
615 * @param text A std::string to send to the users
617 void WriteCommonRaw(const std::string &line, bool include_self = true);
619 /** Write to all users that can see this user (including this user in the list), appending CR/LF
620 * @param text The format string for text to send to the users
621 * @param ... POD-type format arguments
623 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
625 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
626 * @param text The format string for text to send to the users
627 * @param ... POD-type format arguments
629 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
631 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
632 * quit message for opers only.
633 * @param normal_text Normal user quit message
634 * @param oper_text Oper only quit message
636 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
638 /** Dump text to a user target, splitting it appropriately to fit
639 * @param LinePrefix text to prefix each complete line with
640 * @param TextStream the text to send to the user
642 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
644 /** Write to the user, routing the line if the user is remote.
646 virtual void SendText(const std::string& line) = 0;
648 /** Write to the user, routing the line if the user is remote.
650 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
652 /** Return true if the user shares at least one channel with another user
653 * @param other The other user to compare the channel list against
654 * @return True if the given user shares at least one channel with this user
656 bool SharesChannelWith(User *other);
658 /** Send fake quit/join messages for host or ident cycle.
659 * Run this after the item in question has changed.
660 * You should not need to use this function, call ChangeDisplayedHost instead
662 * @param The entire QUIT line, including the source using the old value
664 void DoHostCycle(const std::string &quitline);
666 /** Change the displayed host of a user.
667 * ALWAYS use this function, rather than writing User::dhost directly,
668 * as this triggers module events allowing the change to be syncronized to
669 * remote servers. This will also emulate a QUIT and rejoin (where configured)
670 * before setting their host field.
671 * @param host The new hostname to set
672 * @return True if the change succeeded, false if it didn't
674 bool ChangeDisplayedHost(const char* host);
676 /** Change the ident (username) of a user.
677 * ALWAYS use this function, rather than writing User::ident directly,
678 * as this correctly causes the user to seem to quit (where configured)
679 * before setting their ident field.
680 * @param host The new ident to set
681 * @return True if the change succeeded, false if it didn't
683 bool ChangeIdent(const char* newident);
685 /** Change a users realname field.
686 * ALWAYS use this function, rather than writing User::fullname directly,
687 * as this triggers module events allowing the change to be syncronized to
689 * @param gecos The user's new realname
690 * @return True if the change succeeded, false if otherwise
692 bool ChangeName(const char* gecos);
694 /** Send a command to all local users from this user
695 * The command given must be able to send text with the
696 * first parameter as a servermask (e.g. $*), so basically
697 * you should use PRIVMSG or NOTICE.
698 * @param command the command to send
699 * @param text The text format string to send
700 * @param ... Format arguments
702 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
704 /** Compile a channel list for this user. Used internally by WHOIS
705 * @param source The user to prepare the channel list for
706 * @param spy Whether to return the spy channel list rather than the normal one
707 * @return This user's channel list
709 std::string ChannelList(User* source, bool spy);
711 /** Split the channel list in cl which came from dest, and spool it to this user
712 * Used internally by WHOIS
713 * @param dest The user the original channel list came from
714 * @param cl The channel list as a string obtained from User::ChannelList()
716 void SplitChanList(User* dest, const std::string &cl);
718 /** Remove this user from all channels they are on, and delete any that are now empty.
719 * This is used by QUIT, and will not send part messages!
721 void PurgeEmptyChannels();
723 /** Get the connect class which this user belongs to. NULL for remote users.
724 * @return A pointer to this user's connect class.
726 virtual ConnectClass* GetClass();
728 /** Show the message of the day to this user
732 /** Show the server RULES file to this user
736 virtual void OnDataReady();
737 virtual void OnError(BufferedSocketError error);
738 /** Default destructor
741 virtual CullResult cull();
744 /** Represents a non-local user.
745 * (in fact, any FD less than -1 does)
747 #define FD_MAGIC_NUMBER -42
748 /** Represents a fake user (i.e. a server)
750 #define FD_FAKEUSER_NUMBER -7
752 class CoreExport LocalUser : public User
754 /** A list of channels the user has a pending invite to.
755 * Upon INVITE channels are added, and upon JOIN, the
756 * channels are removed from this list.
760 std::set<std::string> *AllowedOperCommands;
761 std::set<std::string> *AllowedPrivs;
763 /** Allowed user modes from oper classes. */
764 std::bitset<64> AllowedUserModes;
766 /** Allowed channel modes from oper classes. */
767 std::bitset<64> AllowedChanModes;
773 /** Stats counter for bytes inbound
777 /** Stats counter for bytes outbound
781 /** Stats counter for commands inbound
785 /** Stats counter for commands outbound
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 ConnectClass* GetClass();
801 /** Call this method to find the matching <connect> for a user, and to check them against it.
805 /** Server address and port that this user is connected to.
807 irc::sockets::sockaddrs server_sa;
810 * @return The port number of this user.
814 /** Used by PING checking code
818 /** This value contains how far into the penalty threshold the user is. Once its over
819 * the penalty threshold then commands are held and processed on-timer.
823 /** Stored reverse lookup from res_forward. Should not be used after resolution.
825 std::string stored_host;
827 /** Starts a DNS lookup of the user's IP.
828 * This will cause two UserResolver classes to be instantiated.
829 * When complete, these objects set User::dns_done to true.
831 void StartDNSLookup();
833 /** Use this method to fully connect a user.
834 * This will send the message of the day, check G/K/E lines, etc.
838 /** Set the connect class to which this user belongs to.
839 * @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.
840 * @return A reference to this user's current connect class.
842 void SetClass(const std::string &explicit_name = "");
845 void SendText(const std::string& line);
846 void Write(const std::string& text);
847 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
849 /** Adds to the user's write buffer.
850 * You may add any amount of text up to this users sendq value, if you exceed the
851 * sendq value, the user will be removed, and further buffer adds will be dropped.
852 * @param data The data to add to the write buffer
854 void AddWriteBuf(const std::string &data);
856 /** Returns the list of channels this user has been invited to but has not yet joined.
857 * @return A list of channels the user is invited to
859 InvitedList* GetInviteList();
861 /** Returns true if a user is invited to a channel.
862 * @param channel A channel name to look up
863 * @return True if the user is invited to the given channel
865 bool IsInvited(const irc::string &channel);
867 /** Adds a channel to a users invite list (invites them to a channel)
868 * @param channel A channel name to add
869 * @param timeout When the invite should expire (0 == never)
871 void InviteTo(const irc::string &channel, time_t timeout);
873 /** Removes a channel from a users invite list.
874 * This member function is called on successfully joining an invite only channel
875 * to which the user has previously been invited, to clear the invitation.
876 * @param channel The channel to remove the invite to
878 void RemoveInvite(const irc::string &channel);
880 /** Returns true or false for if a user can execute a privilaged oper command.
881 * This is done by looking up their oper type from User::oper, then referencing
882 * this to their oper classes and checking the commands they can execute.
883 * @param command A command (should be all CAPS)
884 * @return True if this user can execute the command
886 bool HasPermission(const std::string &command);
888 /** Returns true if a user has a given permission.
889 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
890 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
892 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
893 * @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.
894 * @return True if this user has the permission in question.
896 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
898 /** Returns true or false if a user can set a privileged user or channel mode.
899 * This is done by looking up their oper type from User::oper, then referencing
900 * this to their oper classes, and checking the modes they can set.
901 * @param mode The mode the check
902 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
903 * @return True if the user can set or unset this mode.
905 bool HasModePermission(unsigned char mode, ModeType type);
908 void UnOperInternal();
911 class CoreExport RemoteUser : public User
914 RemoteUser(const std::string& uid) : User(uid)
916 SetFd(FD_MAGIC_NUMBER);
918 virtual void SendText(const std::string& line);
921 class CoreExport FakeUser : public User
924 FakeUser(const std::string &uid) : User(uid)
926 SetFd(FD_FAKEUSER_NUMBER);
929 virtual void SendText(const std::string& line);
930 virtual const std::string GetFullHost();
931 virtual const std::string GetFullRealHost();
932 void SetFakeServer(std::string name);
935 /* Faster than dynamic_cast */
936 /** Is a local user */
937 inline LocalUser* IS_LOCAL(User* u)
939 return u->GetFd() > -1 ? static_cast<LocalUser*>(u) : NULL;
941 /** Is a remote user */
942 inline RemoteUser* IS_REMOTE(User* u)
944 return u->GetFd() == FD_MAGIC_NUMBER ? static_cast<RemoteUser*>(u) : NULL;
946 /** Is a server fakeuser */
947 inline FakeUser* IS_SERVER(User* u)
949 return u->GetFd() == FD_FAKEUSER_NUMBER ? static_cast<FakeUser*>(u) : NULL;
952 #define IS_OPER(x) (!x->oper.empty())
954 #define IS_AWAY(x) (!x->awaymsg.empty())
956 /** Derived from Resolver, and performs user forward/reverse lookups.
958 class CoreExport UserResolver : public Resolver
961 /** User this class is 'attached' to.
963 LocalUser* bound_user;
964 /** File descriptor teh lookup is bound to
967 /** True if the lookup is forward, false if is a reverse lookup
971 /** Create a resolver.
972 * @param Instance The creating instance
973 * @param user The user to begin lookup on
974 * @param to_resolve The IP or host to resolve
975 * @param qt The query type
976 * @param cache Modified by the constructor if the result was cached
978 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
980 /** Called on successful lookup
981 * @param result Result string
982 * @param ttl Time to live for result
983 * @param cached True if the result was found in the cache
985 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
987 /** Called on failed lookup
988 * @param e Error code
989 * @param errormessage Error message string
991 void OnError(ResolverError e, const std::string &errormessage);