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 /** connect class types
30 /** RFC1459 channel modes
33 /** +s: Server notice mask */
34 UM_SNOMASK = 's' - 65,
36 UM_WALLOPS = 'w' - 65,
38 UM_INVISIBLE = 'i' - 65,
40 UM_OPERATOR = 'o' - 65
43 /** Registration state of a user, e.g.
44 * have they sent USER, NICK, PASS yet?
46 enum RegistrationState {
48 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
49 REG_NONE = 0, /* Has sent nothing */
52 REG_USER = 1, /* Has sent USER */
53 REG_NICK = 2, /* Has sent NICK */
54 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
55 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
58 /* Required forward declaration */
62 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
64 struct CoreExport ConnectClass : public classbase
66 /** Type of line, either CC_ALLOW or CC_DENY
70 /** Connect class name
74 /** Max time to register the connection in seconds
76 unsigned int registration_timeout;
78 /** Host mask for this line
82 /** Number of seconds between pings for this line
84 unsigned int pingtime;
86 /** (Optional) Password for this line
90 /** (Optional) Hash Method for this line
94 /** Maximum size of sendq for users in this class (bytes)
96 unsigned long sendqmax;
98 /** Maximum size of recvq for users in this class (bytes)
100 unsigned long recvqmax;
102 /** Local max when connecting by this connection class
104 unsigned long maxlocal;
106 /** Global max when connecting by this connection class
108 unsigned long maxglobal;
110 /** Max channels for this class
112 unsigned int maxchans;
114 /** Port number this connect class applies to
118 /** How many users may be in this connect class before they are refused?
119 * (0 = no limit = default)
123 /** Reference counter.
124 * This will be 1 if no users are connected, as long as it is a valid connect block
125 * When it reaches 0, the object should be deleted
127 unsigned long RefCount;
129 /** Create a new connect class with no settings.
131 ConnectClass(char type, const std::string& mask);
132 /** Create a new connect class with inherited settings.
134 ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
136 /** Update the settings in this block to match the given block */
137 void Update(const ConnectClass* newSettings);
140 const std::string& GetName() { return name; }
141 const std::string& GetPass() { return pass; }
142 const std::string& GetHost() { return host; }
143 const int GetPort() { return port; }
145 /** Returns the registration timeout
147 time_t GetRegTimeout()
149 return (registration_timeout ? registration_timeout : 90);
152 /** Returns the ping frequency
154 unsigned int GetPingTime()
156 return (pingtime ? pingtime : 120);
159 /** Returns the maximum sendq value
161 unsigned long GetSendqMax()
163 return (sendqmax ? sendqmax : 262114);
166 /** Returns the maximum recvq value
168 unsigned long GetRecvqMax()
170 return (recvqmax ? recvqmax : 4096);
173 /** Returusn the maximum number of local sessions
175 unsigned long GetMaxLocal()
180 /** Returns the maximum number of global sessions
182 unsigned long GetMaxGlobal()
188 /** 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.
190 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
192 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
194 typedef std::vector<ConnectClass*> ClassVector;
196 /** Typedef for the list of user-channel records for a user
198 typedef std::set<Channel*> UserChanList;
200 /** Shorthand for an iterator into a UserChanList
202 typedef UserChanList::iterator UCListIter;
204 /* Required forward declaration
208 /** Holds all information about a user
209 * This class stores all information about a user connected to the irc server. Everything about a
210 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
211 * user's nickname and hostname.
213 class CoreExport User : public EventHandler
216 /** A list of channels the user has a pending invite to.
217 * Upon INVITE channels are added, and upon JOIN, the
218 * channels are removed from this list.
222 /** Cached nick!ident@dhost value using the displayed hostname
224 std::string cached_fullhost;
226 /** Cached ident@ip value using the real IP address
228 std::string cached_hostip;
230 /** Cached ident@realhost value using the real hostname
232 std::string cached_makehost;
234 /** Cached nick!ident@realhost value using the real hostname
236 std::string cached_fullrealhost;
238 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
240 std::string cachedip;
242 /** When we erase the user (in the destructor),
243 * we call this method to subtract one from all
244 * mode characters this user is making use of.
246 void DecrementModes();
248 std::set<std::string> *AllowedOperCommands;
249 std::set<std::string> *AllowedPrivs;
251 /** Allowed user modes from oper classes. */
252 std::bitset<64> AllowedUserModes;
254 /** Allowed channel modes from oper classes. */
255 std::bitset<64> AllowedChanModes;
258 /** Pointer to creator.
259 * This is required to make use of core functions
260 * from within the User class.
262 InspIRCd* ServerInstance;
264 static LocalIntExt NICKForced;
265 static LocalStringExt OperQuit;
267 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
268 * The pointer is guarenteed to *always* be valid. :)
270 ConnectClass *MyClass;
272 /** Hostname of connection.
273 * This should be valid as per RFC1035.
277 /** Stats counter for bytes inbound
281 /** Stats counter for bytes outbound
285 /** Stats counter for commands inbound
289 /** Stats counter for commands outbound
293 /** True if user has authenticated, false if otherwise
297 /** Used by User to indicate the registration status of the connection
298 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
299 * the connection state.
303 /** Time the connection was last pinged
307 /** Time that the object was instantiated (used for TS calculation etc)
311 /** Time the connection was created, set in the constructor. This
312 * may be different from the time the user's classbase object was
317 /** Time that the connection last sent a message, used to calculate idle time
321 /** Used by PING checking code
325 /** Stored reverse lookup from res_forward. Should not be used after resolution.
327 std::string stored_host;
329 /** Starts a DNS lookup of the user's IP.
330 * This will cause two UserResolver classes to be instantiated.
331 * When complete, these objects set User::dns_done to true.
333 void StartDNSLookup();
335 /** The users nickname.
336 * An invalid nickname indicates an unregistered connection prior to the NICK command.
337 * Use InspIRCd::IsNick() to validate nicknames.
341 /** The user's unique identifier.
342 * This is the unique identifier which the user has across the network.
346 /** The users ident reply.
347 * Two characters are added to the user-defined limit to compensate for the tilde etc.
351 /** The host displayed to non-opers (used for cloaking etc).
352 * This usually matches the value of User::host.
356 /** The users full name (GECOS).
358 std::string fullname;
360 /** The user's mode list.
361 * NOT a null terminated string.
363 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
364 * if (modes[modeletter-65]) is set, then the mode is
365 * set, for example, to work out if mode +s is set, we check the field
366 * User::modes['s'-65] != 0.
367 * The following RFC characters o, w, s, i have constants defined via an
368 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
370 std::bitset<64> modes;
372 /** What snomasks are set on this user.
373 * This functions the same as the above modes.
375 std::bitset<64> snomasks;
377 /** Channels this user is on, and the permissions they have there
381 /** The server the user is connected to.
385 /** The user's away message.
386 * If this string is empty, the user is not marked as away.
390 /** Time the user last went away.
391 * This is ONLY RELIABLE if user IS_AWAY()!
395 /** The oper type they logged in as, if they are an oper.
396 * This is used to check permissions in operclasses, so that
397 * we can say 'yay' or 'nay' to any commands they issue.
398 * The value of this is the value of a valid 'type name=' tag.
402 /** True when DNS lookups are completed.
403 * The UserResolver classes res_forward and res_reverse will
404 * set this value once they complete.
408 /** Password specified by the user when they registered.
409 * This is stored even if the <connect> block doesnt need a password, so that
410 * modules may check it.
412 std::string password;
414 /** User's receive queue.
415 * Lines from the IRCd awaiting processing are stored here.
416 * Upgraded april 2005, old system a bit hairy.
420 /** User's send queue.
421 * Lines waiting to be sent are stored here until their buffer is flushed.
425 /** Whether or not to send an snotice about this user's quitting
429 /** If this is set to true, then all socket operations for the user
430 * are dropped into the bit-bucket.
431 * This value is set by QuitUser, and is not needed seperately from that call.
432 * Please note that setting this value alone will NOT cause the user to quit.
436 /** Server address and port that this user is connected to.
437 * If unknown, address family is AF_UNKNOWN
439 irc::sockets::sockaddrs server_sa;
440 /** Client address that the user is connected from.
441 * Port number is only valid if local.
443 * Do not modify this value directly, use SetClientIP() to change it
445 irc::sockets::sockaddrs client_sa;
447 /** Sets the client IP for this user
448 * @return true if the conversion was successful
450 bool SetClientIP(const char* sip);
453 * @return The port number of this user.
457 * @return The server IP address
459 std::string GetServerIP();
461 /** Get client IP string from sockaddr, using static internal buffer
462 * @return The IP string
464 const char* GetIPString();
466 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
467 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
468 * This may be used for CIDR clone detection, etc.
470 * (XXX, brief note: when we do the sockets rewrite, this should move down a
471 * level so it may be used on more derived objects. -- w00t)
473 const char *GetCIDRMask(int range);
475 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
479 /** This value contains how far into the penalty threshold the user is. Once its over
480 * the penalty threshold then commands are held and processed on-timer.
484 /** Default constructor
485 * @throw CoreException if the UID allocated to the user already exists
486 * @param Instance Creator instance
487 * @param uid User UUID, or empty to allocate one automatically
489 User(InspIRCd* Instance, const std::string &uid = "");
491 /** Check if the user matches a G or K line, and disconnect them if they do.
492 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
493 * Returns true if the user matched a ban, false else.
495 bool CheckLines(bool doZline = false);
497 /** Returns the full displayed host of the user
498 * This member function returns the hostname of the user as seen by other users
499 * on the server, in nick!ident&at;host form.
500 * @return The full masked host of the user
502 virtual const std::string GetFullHost();
504 /** Returns the full real host of the user
505 * This member function returns the hostname of the user as seen by other users
506 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
507 * e.g. through a module, then this method will ignore it and return the true hostname.
508 * @return The full real host of the user
510 virtual const std::string GetFullRealHost();
512 /** This clears any cached results that are used for GetFullRealHost() etc.
513 * The results of these calls are cached as generating them can be generally expensive.
515 void InvalidateCache();
517 /** Create a displayable mode string for this users snomasks
518 * @return The notice mask character sequence
520 const char* FormatNoticeMasks();
522 /** Process a snomask modifier string, e.g. +abc-de
523 * @param sm A sequence of notice mask characters
524 * @return The cleaned mode sequence which can be output,
525 * e.g. in the above example if masks c and e are not
526 * valid, this function will return +ab-d
528 std::string ProcessNoticeMasks(const char *sm);
530 /** Returns true if a notice mask is set
531 * @param sm A notice mask character to check
532 * @return True if the notice mask is set
534 bool IsNoticeMaskSet(unsigned char sm);
536 /** Changed a specific notice mask value
537 * @param sm The server notice mask to change
538 * @param value An on/off value for this mask
540 void SetNoticeMask(unsigned char sm, bool value);
542 /** Create a displayable mode string for this users umodes
543 * @param The mode string
545 const char* FormatModes(bool showparameters = false);
547 /** Returns true if a specific mode is set
548 * @param m The user mode
549 * @return True if the mode is set
551 bool IsModeSet(unsigned char m);
553 /** Set a specific usermode to on or off
554 * @param m The user mode
555 * @param value On or off setting of the mode
557 void SetMode(unsigned char m, bool value);
559 /** Returns true if a user is invited to a channel.
560 * @param channel A channel name to look up
561 * @return True if the user is invited to the given channel
563 virtual bool IsInvited(const irc::string &channel);
565 /** Adds a channel to a users invite list (invites them to a channel)
566 * @param channel A channel name to add
567 * @param timeout When the invite should expire (0 == never)
569 virtual void InviteTo(const irc::string &channel, time_t timeout);
571 /** Removes a channel from a users invite list.
572 * This member function is called on successfully joining an invite only channel
573 * to which the user has previously been invited, to clear the invitation.
574 * @param channel The channel to remove the invite to
576 virtual void RemoveInvite(const irc::string &channel);
578 /** Returns true or false for if a user can execute a privilaged oper command.
579 * This is done by looking up their oper type from User::oper, then referencing
580 * this to their oper classes and checking the commands they can execute.
581 * @param command A command (should be all CAPS)
582 * @return True if this user can execute the command
584 bool HasPermission(const std::string &command);
586 /** Returns true if a user has a given permission.
587 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
588 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
590 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
591 * @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.
592 * @return True if this user has the permission in question.
594 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
596 /** Returns true or false if a user can set a privileged user or channel mode.
597 * This is done by looking up their oper type from User::oper, then referencing
598 * this to their oper classes, and checking the modes they can set.
599 * @param mode The mode the check
600 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
601 * @return True if the user can set or unset this mode.
603 bool HasModePermission(unsigned char mode, ModeType type);
605 /** Calls read() to read some data for this user using their fd.
606 * @param buffer The buffer to read into
607 * @param size The size of data to read
608 * @return The number of bytes read, or -1 if an error occured.
610 int ReadData(void* buffer, size_t size);
612 /** This method adds data to the read buffer of the user.
613 * The buffer can grow to any size within limits of the available memory,
614 * managed by the size of a std::string, however if any individual line in
615 * the buffer grows over 600 bytes in length (which is 88 chars over the
616 * RFC-specified limit per line) then the method will return false and the
617 * text will not be inserted.
618 * @param a The string to add to the users read buffer
619 * @return True if the string was successfully added to the read buffer
621 bool AddBuffer(const std::string &a);
623 /** This method returns true if the buffer contains at least one carriage return
624 * character (e.g. one complete line may be read)
625 * @return True if there is at least one complete line in the users buffer
627 bool BufferIsReady();
629 /** This function clears the entire buffer by setting it to an empty string.
633 /** This method returns the first available string at the tail end of the buffer
634 * and advances the tail end of the buffer past the string. This means it is
635 * a one way operation in a similar way to strtok(), and multiple calls return
636 * multiple lines if they are available. The results of this function if there
637 * are no lines to be read are unknown, always use BufferIsReady() to check if
638 * it is ok to read the buffer before calling GetBuffer().
639 * @return The string at the tail end of this users buffer
641 std::string GetBuffer();
643 /** Adds to the user's write buffer.
644 * You may add any amount of text up to this users sendq value, if you exceed the
645 * sendq value, the user will be removed, and further buffer adds will be dropped.
646 * @param data The data to add to the write buffer
648 void AddWriteBuf(const std::string &data);
650 /** Flushes as much of the user's buffer to the file descriptor as possible.
651 * This function may not always flush the entire buffer, rather instead as much of it
652 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
653 * position is advanced forwards and the rest of the data sent at the next call to
656 void FlushWriteBuf();
658 /** Returns the list of channels this user has been invited to but has not yet joined.
659 * @return A list of channels the user is invited to
661 InvitedList* GetInviteList();
663 /** Creates a wildcard host.
664 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
665 * @return The wildcarded hostname in *!*@host form
667 char* MakeWildHost();
669 /** Creates a usermask with real host.
670 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
671 * @return the usermask in the format user@host
673 const std::string& MakeHost();
675 /** Creates a usermask with real ip.
676 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
677 * @return the usermask in the format user@ip
679 const std::string& MakeHostIP();
681 /** Shuts down and closes the user's socket
682 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
683 * which will call CloseSocket() for you.
687 /** Add the user to WHOWAS system
691 /** Oper up the user using the given opertype.
692 * This will also give the +o usermode.
693 * @param opertype The oper type to oper as
695 void Oper(const std::string &opertype, const std::string &opername);
697 /** Call this method to find the matching <connect> for a user, and to check them against it.
701 /** Use this method to fully connect a user.
702 * This will send the message of the day, check G/K/E lines, etc.
706 /** Change this users hash key to a new string.
707 * You should not call this function directly. It is used by the core
708 * to update the users hash entry on a nickchange.
709 * @param New new user_hash key
710 * @return Pointer to User in hash (usually 'this')
712 User* UpdateNickHash(const char* New);
714 /** Force a nickname change.
715 * If the nickname change fails (for example, because the nick in question
716 * already exists) this function will return false, and you must then either
717 * output an error message, or quit the user for nickname collision.
718 * @param newnick The nickname to change to
719 * @return True if the nickchange was successful.
721 bool ForceNickChange(const char* newnick);
724 * This will clear the +o usermode and unset the user's oper type
728 /** Write text to this user, appending CR/LF.
729 * @param text A std::string to send to the user
731 void Write(const std::string &text);
733 /** Write text to this user, appending CR/LF.
734 * @param text The format string for text to send to the user
735 * @param ... POD-type format arguments
737 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
739 /** Write text to this user, appending CR/LF and prepending :server.name
740 * @param text A std::string to send to the user
742 void WriteServ(const std::string& text);
744 /** Write text to this user, appending CR/LF and prepending :server.name
745 * @param text The format string for text to send to the user
746 * @param ... POD-type format arguments
748 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
750 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
752 void WriteNumeric(unsigned int numeric, const std::string &text);
754 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
755 * @param user The user to prepend the :nick!user@host of
756 * @param text A std::string to send to the user
758 void WriteFrom(User *user, const std::string &text);
760 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
761 * @param user The user to prepend the :nick!user@host of
762 * @param text The format string for text to send to the user
763 * @param ... POD-type format arguments
765 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
767 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
768 * @param dest The user to route the message to
769 * @param text A std::string to send to the user
771 void WriteTo(User *dest, const std::string &data);
773 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
774 * @param dest The user to route the message to
775 * @param text The format string for text to send to the user
776 * @param ... POD-type format arguments
778 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
780 /** Write to all users that can see this user (including this user in the list), appending CR/LF
781 * @param text A std::string to send to the users
783 void WriteCommon(const std::string &text);
785 /** Write to all users that can see this user (including this user in the list), appending CR/LF
786 * @param text The format string for text to send to the users
787 * @param ... POD-type format arguments
789 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
791 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
792 * @param text The format string for text to send to the users
793 * @param ... POD-type format arguments
795 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
797 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
798 * @param text A std::string to send to the users
800 void WriteCommonExcept(const std::string &text);
802 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
803 * quit message for opers only.
804 * @param normal_text Normal user quit message
805 * @param oper_text Oper only quit message
807 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
809 /** Write a WALLOPS message from this user to all local opers.
810 * If this user is not opered, the function will return without doing anything.
811 * @param text The format string to send in the WALLOPS message
812 * @param ... Format arguments
814 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
816 /** Write a WALLOPS message from this user to all local opers.
817 * If this user is not opered, the function will return without doing anything.
818 * @param text The text to send in the WALLOPS message
820 void WriteWallOps(const std::string &text);
822 /** Return true if the user shares at least one channel with another user
823 * @param other The other user to compare the channel list against
824 * @return True if the given user shares at least one channel with this user
826 bool SharesChannelWith(User *other);
828 /** Send fake quit/join messages for host or ident cycle.
829 * Run this after the item in question has changed.
830 * You should not need to use this function, call ChangeDisplayedHost instead
832 * @param The entire QUIT line, including the source using the old value
834 void DoHostCycle(const std::string &quitline);
836 /** Change the displayed host of a user.
837 * ALWAYS use this function, rather than writing User::dhost directly,
838 * as this triggers module events allowing the change to be syncronized to
839 * remote servers. This will also emulate a QUIT and rejoin (where configured)
840 * before setting their host field.
841 * @param host The new hostname to set
842 * @return True if the change succeeded, false if it didn't
844 bool ChangeDisplayedHost(const char* host);
846 /** Change the ident (username) of a user.
847 * ALWAYS use this function, rather than writing User::ident directly,
848 * as this correctly causes the user to seem to quit (where configured)
849 * before setting their ident field.
850 * @param host The new ident to set
851 * @return True if the change succeeded, false if it didn't
853 bool ChangeIdent(const char* newident);
855 /** Change a users realname field.
856 * ALWAYS use this function, rather than writing User::fullname directly,
857 * as this triggers module events allowing the change to be syncronized to
859 * @param gecos The user's new realname
860 * @return True if the change succeeded, false if otherwise
862 bool ChangeName(const char* gecos);
864 /** Send a command to all local users from this user
865 * The command given must be able to send text with the
866 * first parameter as a servermask (e.g. $*), so basically
867 * you should use PRIVMSG or NOTICE.
868 * @param command the command to send
869 * @param text The text format string to send
870 * @param ... Format arguments
872 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
874 /** Compile a channel list for this user, and send it to the user 'source'
875 * Used internally by WHOIS
876 * @param The user to send the channel list to if it is not too long
877 * @return This user's channel list
879 std::string ChannelList(User* source);
881 /** Split the channel list in cl which came from dest, and spool it to this user
882 * Used internally by WHOIS
883 * @param dest The user the original channel list came from
884 * @param cl The channel list as a string obtained from User::ChannelList()
886 void SplitChanList(User* dest, const std::string &cl);
888 /** Remove this user from all channels they are on, and delete any that are now empty.
889 * This is used by QUIT, and will not send part messages!
891 void PurgeEmptyChannels();
893 /** Get the connect class which this user belongs to.
894 * @return A pointer to this user's connect class
896 ConnectClass *GetClass();
898 /** Set the connect class to which this user belongs to.
899 * @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.
900 * @return A reference to this user's current connect class.
902 ConnectClass *SetClass(const std::string &explicit_name = "");
904 /** Show the message of the day to this user
908 /** Show the server RULES file to this user
912 /** Increases a user's command penalty by a set amount.
914 void IncreasePenalty(int increase);
916 /** Decreases a user's command penalty by a set amount.
918 void DecreasePenalty(int decrease);
920 /** Handle socket event.
921 * From EventHandler class.
922 * @param et Event type
923 * @param errornum Error number for EVENT_ERROR events
925 void HandleEvent(EventType et, int errornum = 0);
927 /** Default destructor
932 /** Derived from Resolver, and performs user forward/reverse lookups.
934 class CoreExport UserResolver : public Resolver
937 /** User this class is 'attached' to.
940 /** File descriptor teh lookup is bound to
943 /** True if the lookup is forward, false if is a reverse lookup
947 /** Create a resolver.
948 * @param Instance The creating instance
949 * @param user The user to begin lookup on
950 * @param to_resolve The IP or host to resolve
951 * @param qt The query type
952 * @param cache Modified by the constructor if the result was cached
954 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
956 /** Called on successful lookup
957 * @param result Result string
958 * @param ttl Time to live for result
959 * @param cached True if the result was found in the cache
961 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
963 /** Called on failed lookup
964 * @param e Error code
965 * @param errormessage Error message string
967 void OnError(ResolverError e, const std::string &errormessage);