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 * ---------------------------------------------------
21 /** Channel status for a user
34 /** connect class types
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 */
71 /* Required forward declaration */
75 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
77 struct CoreExport ConnectClass : public classbase
79 /** Type of line, either CC_ALLOW or CC_DENY
83 /** Connect class name
87 /** Max time to register the connection in seconds
89 unsigned int registration_timeout;
91 /** Host mask for this line
95 /** Number of seconds between pings for this line
97 unsigned int pingtime;
99 /** (Optional) Password for this line
103 /** (Optional) Hash Method for this line
107 /** Maximum size of sendq for users in this class (bytes)
109 unsigned long sendqmax;
111 /** Maximum size of recvq for users in this class (bytes)
113 unsigned long recvqmax;
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 /** Reference counter.
137 * This will be 1 if no users are connected, as long as it is a valid connect block
138 * When it reaches 0, the object should be deleted
140 unsigned long RefCount;
142 /** Create a new connect class with no settings.
144 ConnectClass(char type, const std::string& mask);
145 /** Create a new connect class with inherited settings.
147 ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
149 /** Update the settings in this block to match the given block */
150 void Update(const ConnectClass* newSettings);
153 const std::string& GetName() { return name; }
154 const std::string& GetPass() { return pass; }
155 const std::string& GetHost() { return host; }
156 const int GetPort() { return port; }
158 /** Returns the registration timeout
160 time_t GetRegTimeout()
162 return (registration_timeout ? registration_timeout : 90);
165 /** Returns the ping frequency
167 unsigned int GetPingTime()
169 return (pingtime ? pingtime : 120);
172 /** Returns the maximum sendq value
174 unsigned long GetSendqMax()
176 return (sendqmax ? sendqmax : 262114);
179 /** Returns the maximum recvq value
181 unsigned long GetRecvqMax()
183 return (recvqmax ? recvqmax : 4096);
186 /** Returusn the maximum number of local sessions
188 unsigned long GetMaxLocal()
193 /** Returns the maximum number of global sessions
195 unsigned long GetMaxGlobal()
201 /** 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.
203 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
205 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
207 typedef std::vector<ConnectClass*> ClassVector;
209 /** Typedef for the list of user-channel records for a user
211 typedef std::map<Channel*, char> UserChanList;
213 /** Shorthand for an iterator into a UserChanList
215 typedef UserChanList::iterator UCListIter;
217 /* Required forward declaration
221 /** Holds all information about a user
222 * This class stores all information about a user connected to the irc server. Everything about a
223 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
224 * user's nickname and hostname.
226 class CoreExport User : public EventHandler
229 /** A list of channels the user has a pending invite to.
230 * Upon INVITE channels are added, and upon JOIN, the
231 * channels are removed from this list.
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;
255 /** When we erase the user (in the destructor),
256 * we call this method to subtract one from all
257 * mode characters this user is making use of.
259 void DecrementModes();
261 std::set<std::string> *AllowedOperCommands;
262 std::set<std::string> *AllowedPrivs;
264 /** Allowed user modes from oper classes. */
265 std::bitset<64> AllowedUserModes;
267 /** Allowed channel modes from oper classes. */
268 std::bitset<64> AllowedChanModes;
271 /** Pointer to creator.
272 * This is required to make use of core functions
273 * from within the User class.
275 InspIRCd* ServerInstance;
277 static LocalIntExt NICKForced;
278 static LocalStringExt OperQuit;
280 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
281 * The pointer is guarenteed to *always* be valid. :)
283 ConnectClass *MyClass;
285 /** Hostname of connection.
286 * This should be valid as per RFC1035.
290 /** Stats counter for bytes inbound
294 /** Stats counter for bytes outbound
298 /** Stats counter for commands inbound
302 /** Stats counter for commands outbound
306 /** True if user has authenticated, false if otherwise
310 /** Used by User to indicate the registration status of the connection
311 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
312 * the connection state.
316 /** Time the connection was last pinged
320 /** Time that the object was instantiated (used for TS calculation etc)
324 /** Time the connection was created, set in the constructor. This
325 * may be different from the time the user's classbase object was
330 /** Time that the connection last sent a message, used to calculate idle time
334 /** Used by PING checking code
338 /** Stored reverse lookup from res_forward. Should not be used after resolution.
340 std::string stored_host;
342 /** Starts a DNS lookup of the user's IP.
343 * This will cause two UserResolver classes to be instantiated.
344 * When complete, these objects set User::dns_done to true.
346 void StartDNSLookup();
348 /** The users nickname.
349 * An invalid nickname indicates an unregistered connection prior to the NICK command.
350 * Use InspIRCd::IsNick() to validate nicknames.
354 /** The user's unique identifier.
355 * This is the unique identifier which the user has across the network.
359 /** The users ident reply.
360 * Two characters are added to the user-defined limit to compensate for the tilde etc.
364 /** The host displayed to non-opers (used for cloaking etc).
365 * This usually matches the value of User::host.
369 /** The users full name (GECOS).
371 std::string fullname;
373 /** The user's mode list.
374 * NOT a null terminated string.
376 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
377 * if (modes[modeletter-65]) is set, then the mode is
378 * set, for example, to work out if mode +s is set, we check the field
379 * User::modes['s'-65] != 0.
380 * The following RFC characters o, w, s, i have constants defined via an
381 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
383 std::bitset<64> modes;
385 /** What snomasks are set on this user.
386 * This functions the same as the above modes.
388 std::bitset<64> snomasks;
390 /** Channels this user is on, and the permissions they have there
394 /** The server the user is connected to.
398 /** The user's away message.
399 * If this string is empty, the user is not marked as away.
403 /** Time the user last went away.
404 * This is ONLY RELIABLE if user IS_AWAY()!
408 /** The oper type they logged in as, if they are an oper.
409 * This is used to check permissions in operclasses, so that
410 * we can say 'yay' or 'nay' to any commands they issue.
411 * The value of this is the value of a valid 'type name=' tag.
415 /** True when DNS lookups are completed.
416 * The UserResolver classes res_forward and res_reverse will
417 * set this value once they complete.
421 /** Password specified by the user when they registered.
422 * This is stored even if the <connect> block doesnt need a password, so that
423 * modules may check it.
425 std::string password;
427 /** User's receive queue.
428 * Lines from the IRCd awaiting processing are stored here.
429 * Upgraded april 2005, old system a bit hairy.
433 /** User's send queue.
434 * Lines waiting to be sent are stored here until their buffer is flushed.
438 /** Whether or not to send an snotice about this user's quitting
442 /** If this is set to true, then all socket operations for the user
443 * are dropped into the bit-bucket.
444 * This value is set by QuitUser, and is not needed seperately from that call.
445 * Please note that setting this value alone will NOT cause the user to quit.
449 /** Server address and port that this user is connected to.
450 * If unknown, address family is AF_UNKNOWN
452 irc::sockets::sockaddrs server_sa;
453 /** Client address that the user is connected from.
454 * Port number is only valid if local.
456 * Do not modify this value directly, use SetClientIP() to change it
458 irc::sockets::sockaddrs client_sa;
460 /** Sets the client IP for this user
461 * @return true if the conversion was successful
463 bool SetClientIP(const char* sip);
466 * @return The port number of this user.
470 * @return The server IP address
472 std::string GetServerIP();
474 /** Get client IP string from sockaddr, using static internal buffer
475 * @return The IP string
477 const char* GetIPString();
479 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
480 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
481 * This may be used for CIDR clone detection, etc.
483 * (XXX, brief note: when we do the sockets rewrite, this should move down a
484 * level so it may be used on more derived objects. -- w00t)
486 const char *GetCIDRMask(int range);
488 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
492 /** This value contains how far into the penalty threshold the user is. Once its over
493 * the penalty threshold then commands are held and processed on-timer.
497 /** Default constructor
498 * @throw CoreException if the UID allocated to the user already exists
499 * @param Instance Creator instance
500 * @param uid User UUID, or empty to allocate one automatically
502 User(InspIRCd* Instance, const std::string &uid = "");
504 /** Check if the user matches a G or K line, and disconnect them if they do.
505 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
506 * Returns true if the user matched a ban, false else.
508 bool CheckLines(bool doZline = false);
510 /** Returns the full displayed host of the user
511 * This member function returns the hostname of the user as seen by other users
512 * on the server, in nick!ident&at;host form.
513 * @return The full masked host of the user
515 virtual const std::string GetFullHost();
517 /** Returns the full real host of the user
518 * This member function returns the hostname of the user as seen by other users
519 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
520 * e.g. through a module, then this method will ignore it and return the true hostname.
521 * @return The full real host of the user
523 virtual const std::string GetFullRealHost();
525 /** This clears any cached results that are used for GetFullRealHost() etc.
526 * The results of these calls are cached as generating them can be generally expensive.
528 void InvalidateCache();
530 /** Create a displayable mode string for this users snomasks
531 * @return The notice mask character sequence
533 const char* FormatNoticeMasks();
535 /** Process a snomask modifier string, e.g. +abc-de
536 * @param sm A sequence of notice mask characters
537 * @return The cleaned mode sequence which can be output,
538 * e.g. in the above example if masks c and e are not
539 * valid, this function will return +ab-d
541 std::string ProcessNoticeMasks(const char *sm);
543 /** Returns true if a notice mask is set
544 * @param sm A notice mask character to check
545 * @return True if the notice mask is set
547 bool IsNoticeMaskSet(unsigned char sm);
549 /** Changed a specific notice mask value
550 * @param sm The server notice mask to change
551 * @param value An on/off value for this mask
553 void SetNoticeMask(unsigned char sm, bool value);
555 /** Create a displayable mode string for this users umodes
556 * @param The mode string
558 const char* FormatModes(bool showparameters = false);
560 /** Returns true if a specific mode is set
561 * @param m The user mode
562 * @return True if the mode is set
564 bool IsModeSet(unsigned char m);
566 /** Set a specific usermode to on or off
567 * @param m The user mode
568 * @param value On or off setting of the mode
570 void SetMode(unsigned char m, bool value);
572 /** Returns true if a user is invited to a channel.
573 * @param channel A channel name to look up
574 * @return True if the user is invited to the given channel
576 virtual bool IsInvited(const irc::string &channel);
578 /** Adds a channel to a users invite list (invites them to a channel)
579 * @param channel A channel name to add
580 * @param timeout When the invite should expire (0 == never)
582 virtual void InviteTo(const irc::string &channel, time_t timeout);
584 /** Removes a channel from a users invite list.
585 * This member function is called on successfully joining an invite only channel
586 * to which the user has previously been invited, to clear the invitation.
587 * @param channel The channel to remove the invite to
589 virtual void RemoveInvite(const irc::string &channel);
591 /** Returns true or false for if a user can execute a privilaged oper command.
592 * This is done by looking up their oper type from User::oper, then referencing
593 * this to their oper classes and checking the commands they can execute.
594 * @param command A command (should be all CAPS)
595 * @return True if this user can execute the command
597 bool HasPermission(const std::string &command);
599 /** Returns true if a user has a given permission.
600 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
601 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
603 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
604 * @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.
605 * @return True if this user has the permission in question.
607 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
609 /** Returns true or false if a user can set a privileged user or channel mode.
610 * This is done by looking up their oper type from User::oper, then referencing
611 * this to their oper classes, and checking the modes they can set.
612 * @param mode The mode the check
613 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
614 * @return True if the user can set or unset this mode.
616 bool HasModePermission(unsigned char mode, ModeType type);
618 /** Calls read() to read some data for this user using their fd.
619 * @param buffer The buffer to read into
620 * @param size The size of data to read
621 * @return The number of bytes read, or -1 if an error occured.
623 int ReadData(void* buffer, size_t size);
625 /** This method adds data to the read buffer of the user.
626 * The buffer can grow to any size within limits of the available memory,
627 * managed by the size of a std::string, however if any individual line in
628 * the buffer grows over 600 bytes in length (which is 88 chars over the
629 * RFC-specified limit per line) then the method will return false and the
630 * text will not be inserted.
631 * @param a The string to add to the users read buffer
632 * @return True if the string was successfully added to the read buffer
634 bool AddBuffer(const std::string &a);
636 /** This method returns true if the buffer contains at least one carriage return
637 * character (e.g. one complete line may be read)
638 * @return True if there is at least one complete line in the users buffer
640 bool BufferIsReady();
642 /** This function clears the entire buffer by setting it to an empty string.
646 /** This method returns the first available string at the tail end of the buffer
647 * and advances the tail end of the buffer past the string. This means it is
648 * a one way operation in a similar way to strtok(), and multiple calls return
649 * multiple lines if they are available. The results of this function if there
650 * are no lines to be read are unknown, always use BufferIsReady() to check if
651 * it is ok to read the buffer before calling GetBuffer().
652 * @return The string at the tail end of this users buffer
654 std::string GetBuffer();
656 /** Adds to the user's write buffer.
657 * You may add any amount of text up to this users sendq value, if you exceed the
658 * sendq value, the user will be removed, and further buffer adds will be dropped.
659 * @param data The data to add to the write buffer
661 void AddWriteBuf(const std::string &data);
663 /** Flushes as much of the user's buffer to the file descriptor as possible.
664 * This function may not always flush the entire buffer, rather instead as much of it
665 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
666 * position is advanced forwards and the rest of the data sent at the next call to
669 void FlushWriteBuf();
671 /** Returns the list of channels this user has been invited to but has not yet joined.
672 * @return A list of channels the user is invited to
674 InvitedList* GetInviteList();
676 /** Creates a wildcard host.
677 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
678 * @return The wildcarded hostname in *!*@host form
680 char* MakeWildHost();
682 /** Creates a usermask with real host.
683 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
684 * @return the usermask in the format user@host
686 const std::string& MakeHost();
688 /** Creates a usermask with real ip.
689 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
690 * @return the usermask in the format user@ip
692 const std::string& MakeHostIP();
694 /** Shuts down and closes the user's socket
695 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
696 * which will call CloseSocket() for you.
700 /** Add the user to WHOWAS system
704 /** Oper up the user using the given opertype.
705 * This will also give the +o usermode.
706 * @param opertype The oper type to oper as
708 void Oper(const std::string &opertype, const std::string &opername);
710 /** Call this method to find the matching <connect> for a user, and to check them against it.
714 /** Use this method to fully connect a user.
715 * This will send the message of the day, check G/K/E lines, etc.
719 /** Change this users hash key to a new string.
720 * You should not call this function directly. It is used by the core
721 * to update the users hash entry on a nickchange.
722 * @param New new user_hash key
723 * @return Pointer to User in hash (usually 'this')
725 User* UpdateNickHash(const char* New);
727 /** Force a nickname change.
728 * If the nickname change fails (for example, because the nick in question
729 * already exists) this function will return false, and you must then either
730 * output an error message, or quit the user for nickname collision.
731 * @param newnick The nickname to change to
732 * @return True if the nickchange was successful.
734 bool ForceNickChange(const char* newnick);
737 * This will clear the +o usermode and unset the user's oper type
741 /** Write text to this user, appending CR/LF.
742 * @param text A std::string to send to the user
744 void Write(const std::string &text);
746 /** Write text to this user, appending CR/LF.
747 * @param text The format string for text to send to the user
748 * @param ... POD-type format arguments
750 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
752 /** Write text to this user, appending CR/LF and prepending :server.name
753 * @param text A std::string to send to the user
755 void WriteServ(const std::string& text);
757 /** Write text to this user, appending CR/LF and prepending :server.name
758 * @param text The format string for text to send to the user
759 * @param ... POD-type format arguments
761 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
763 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
765 void WriteNumeric(unsigned int numeric, const std::string &text);
767 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
768 * @param user The user to prepend the :nick!user@host of
769 * @param text A std::string to send to the user
771 void WriteFrom(User *user, const std::string &text);
773 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
774 * @param user The user to prepend the :nick!user@host of
775 * @param text The format string for text to send to the user
776 * @param ... POD-type format arguments
778 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
780 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
781 * @param dest The user to route the message to
782 * @param text A std::string to send to the user
784 void WriteTo(User *dest, const std::string &data);
786 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
787 * @param dest The user to route the message to
788 * @param text The format string for text to send to the user
789 * @param ... POD-type format arguments
791 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
793 /** Write to all users that can see this user (including this user in the list), appending CR/LF
794 * @param text A std::string to send to the users
796 void WriteCommon(const std::string &text);
798 /** Write to all users that can see this user (including this user in the list), appending CR/LF
799 * @param text The format string for text to send to the users
800 * @param ... POD-type format arguments
802 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
804 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
805 * @param text The format string for text to send to the users
806 * @param ... POD-type format arguments
808 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
810 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
811 * @param text A std::string to send to the users
813 void WriteCommonExcept(const std::string &text);
815 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
816 * quit message for opers only.
817 * @param normal_text Normal user quit message
818 * @param oper_text Oper only quit message
820 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
822 /** Write a WALLOPS message from this user to all local opers.
823 * If this user is not opered, the function will return without doing anything.
824 * @param text The format string to send in the WALLOPS message
825 * @param ... Format arguments
827 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
829 /** Write a WALLOPS message from this user to all local opers.
830 * If this user is not opered, the function will return without doing anything.
831 * @param text The text to send in the WALLOPS message
833 void WriteWallOps(const std::string &text);
835 /** Return true if the user shares at least one channel with another user
836 * @param other The other user to compare the channel list against
837 * @return True if the given user shares at least one channel with this user
839 bool SharesChannelWith(User *other);
841 /** Send fake quit/join messages for host or ident cycle.
842 * Run this after the item in question has changed.
843 * You should not need to use this function, call ChangeDisplayedHost instead
845 * @param The entire QUIT line, including the source using the old value
847 void DoHostCycle(const std::string &quitline);
849 /** Change the displayed host of a user.
850 * ALWAYS use this function, rather than writing User::dhost directly,
851 * as this triggers module events allowing the change to be syncronized to
852 * remote servers. This will also emulate a QUIT and rejoin (where configured)
853 * before setting their host field.
854 * @param host The new hostname to set
855 * @return True if the change succeeded, false if it didn't
857 bool ChangeDisplayedHost(const char* host);
859 /** Change the ident (username) of a user.
860 * ALWAYS use this function, rather than writing User::ident directly,
861 * as this correctly causes the user to seem to quit (where configured)
862 * before setting their ident field.
863 * @param host The new ident to set
864 * @return True if the change succeeded, false if it didn't
866 bool ChangeIdent(const char* newident);
868 /** Change a users realname field.
869 * ALWAYS use this function, rather than writing User::fullname directly,
870 * as this triggers module events allowing the change to be syncronized to
872 * @param gecos The user's new realname
873 * @return True if the change succeeded, false if otherwise
875 bool ChangeName(const char* gecos);
877 /** Send a command to all local users from this user
878 * The command given must be able to send text with the
879 * first parameter as a servermask (e.g. $*), so basically
880 * you should use PRIVMSG or NOTICE.
881 * @param command the command to send
882 * @param text The text format string to send
883 * @param ... Format arguments
885 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
887 /** Compile a channel list for this user, and send it to the user 'source'
888 * Used internally by WHOIS
889 * @param The user to send the channel list to if it is not too long
890 * @return This user's channel list
892 std::string ChannelList(User* source);
894 /** Split the channel list in cl which came from dest, and spool it to this user
895 * Used internally by WHOIS
896 * @param dest The user the original channel list came from
897 * @param cl The channel list as a string obtained from User::ChannelList()
899 void SplitChanList(User* dest, const std::string &cl);
901 /** Remove this user from all channels they are on, and delete any that are now empty.
902 * This is used by QUIT, and will not send part messages!
904 void PurgeEmptyChannels();
906 /** Get the connect class which this user belongs to.
907 * @return A pointer to this user's connect class
909 ConnectClass *GetClass();
911 /** Set the connect class to which this user belongs to.
912 * @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.
913 * @return A reference to this user's current connect class.
915 ConnectClass *SetClass(const std::string &explicit_name = "");
917 /** Show the message of the day to this user
921 /** Show the server RULES file to this user
925 /** Increases a user's command penalty by a set amount.
927 void IncreasePenalty(int increase);
929 /** Decreases a user's command penalty by a set amount.
931 void DecreasePenalty(int decrease);
933 /** Handle socket event.
934 * From EventHandler class.
935 * @param et Event type
936 * @param errornum Error number for EVENT_ERROR events
938 void HandleEvent(EventType et, int errornum = 0);
940 /** Default destructor
945 /** Derived from Resolver, and performs user forward/reverse lookups.
947 class CoreExport UserResolver : public Resolver
950 /** User this class is 'attached' to.
953 /** File descriptor teh lookup is bound to
956 /** True if the lookup is forward, false if is a reverse lookup
960 /** Create a resolver.
961 * @param Instance The creating instance
962 * @param user The user to begin lookup on
963 * @param to_resolve The IP or host to resolve
964 * @param qt The query type
965 * @param cache Modified by the constructor if the result was cached
967 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
969 /** Called on successful lookup
970 * @param result Result string
971 * @param ttl Time to live for result
972 * @param cached True if the result was found in the cache
974 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
976 /** Called on failed lookup
977 * @param e Error code
978 * @param errormessage Error message string
980 void OnError(ResolverError e, const std::string &errormessage);