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 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
278 * The pointer is guarenteed to *always* be valid. :)
280 ConnectClass *MyClass;
282 /** Hostname of connection.
283 * This should be valid as per RFC1035.
287 /** Stats counter for bytes inbound
291 /** Stats counter for bytes outbound
295 /** Stats counter for commands inbound
299 /** Stats counter for commands outbound
303 /** True if user has authenticated, false if otherwise
307 /** Used by User to indicate the registration status of the connection
308 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
309 * the connection state.
313 /** Time the connection was last pinged
317 /** Time that the object was instantiated (used for TS calculation etc)
321 /** Time the connection was created, set in the constructor. This
322 * may be different from the time the user's classbase object was
327 /** Time that the connection last sent a message, used to calculate idle time
331 /** Used by PING checking code
335 /** Stored reverse lookup from res_forward. Should not be used after resolution.
337 std::string stored_host;
339 /** Starts a DNS lookup of the user's IP.
340 * This will cause two UserResolver classes to be instantiated.
341 * When complete, these objects set User::dns_done to true.
343 void StartDNSLookup();
345 /** The users nickname.
346 * An invalid nickname indicates an unregistered connection prior to the NICK command.
347 * Use InspIRCd::IsNick() to validate nicknames.
351 /** The user's unique identifier.
352 * This is the unique identifier which the user has across the network.
356 /** The users ident reply.
357 * Two characters are added to the user-defined limit to compensate for the tilde etc.
361 /** The host displayed to non-opers (used for cloaking etc).
362 * This usually matches the value of User::host.
366 /** The users full name (GECOS).
368 std::string fullname;
370 /** The user's mode list.
371 * NOT a null terminated string.
373 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
374 * if (modes[modeletter-65]) is set, then the mode is
375 * set, for example, to work out if mode +s is set, we check the field
376 * User::modes['s'-65] != 0.
377 * The following RFC characters o, w, s, i have constants defined via an
378 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
380 std::bitset<64> modes;
382 /** What snomasks are set on this user.
383 * This functions the same as the above modes.
385 std::bitset<64> snomasks;
387 /** Channels this user is on, and the permissions they have there
391 /** The server the user is connected to.
395 /** The user's away message.
396 * If this string is empty, the user is not marked as away.
400 /** Time the user last went away.
401 * This is ONLY RELIABLE if user IS_AWAY()!
405 /** The oper type they logged in as, if they are an oper.
406 * This is used to check permissions in operclasses, so that
407 * we can say 'yay' or 'nay' to any commands they issue.
408 * The value of this is the value of a valid 'type name=' tag.
412 /** True when DNS lookups are completed.
413 * The UserResolver classes res_forward and res_reverse will
414 * set this value once they complete.
418 /** Password specified by the user when they registered.
419 * This is stored even if the <connect> block doesnt need a password, so that
420 * modules may check it.
422 std::string password;
424 /** User's receive queue.
425 * Lines from the IRCd awaiting processing are stored here.
426 * Upgraded april 2005, old system a bit hairy.
430 /** User's send queue.
431 * Lines waiting to be sent are stored here until their buffer is flushed.
435 /** Whether or not to send an snotice about this user's quitting
439 /** If this is set to true, then all socket operations for the user
440 * are dropped into the bit-bucket.
441 * This value is set by QuitUser, and is not needed seperately from that call.
442 * Please note that setting this value alone will NOT cause the user to quit.
446 /** Server address and port that this user is connected to.
447 * If unknown, address family is AF_UNKNOWN
449 irc::sockets::sockaddrs server_sa;
450 /** Client address that the user is connected from.
451 * Port number is only valid if local.
453 * Do not modify this value directly, use SetClientIP() to change it
455 irc::sockets::sockaddrs client_sa;
457 /** Sets the client IP for this user
458 * @return true if the conversion was successful
460 bool SetClientIP(const char* sip);
463 * @return The port number of this user.
467 * @return The server IP address
469 std::string GetServerIP();
471 /** Get client IP string from sockaddr, using static internal buffer
472 * @return The IP string
474 const char* GetIPString();
476 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
477 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
478 * This may be used for CIDR clone detection, etc.
480 * (XXX, brief note: when we do the sockets rewrite, this should move down a
481 * level so it may be used on more derived objects. -- w00t)
483 const char *GetCIDRMask(int range);
485 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
489 /** This value contains how far into the penalty threshold the user is. Once its over
490 * the penalty threshold then commands are held and processed on-timer.
494 /** Default constructor
495 * @throw CoreException if the UID allocated to the user already exists
496 * @param Instance Creator instance
497 * @param uid User UUID, or empty to allocate one automatically
499 User(InspIRCd* Instance, const std::string &uid = "");
501 /** Check if the user matches a G or K line, and disconnect them if they do.
502 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
503 * Returns true if the user matched a ban, false else.
505 bool CheckLines(bool doZline = false);
507 /** Returns the full displayed host of the user
508 * This member function returns the hostname of the user as seen by other users
509 * on the server, in nick!ident&at;host form.
510 * @return The full masked host of the user
512 virtual const std::string GetFullHost();
514 /** Returns the full real host of the user
515 * This member function returns the hostname of the user as seen by other users
516 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
517 * e.g. through a module, then this method will ignore it and return the true hostname.
518 * @return The full real host of the user
520 virtual const std::string GetFullRealHost();
522 /** This clears any cached results that are used for GetFullRealHost() etc.
523 * The results of these calls are cached as generating them can be generally expensive.
525 void InvalidateCache();
527 /** Create a displayable mode string for this users snomasks
528 * @return The notice mask character sequence
530 const char* FormatNoticeMasks();
532 /** Process a snomask modifier string, e.g. +abc-de
533 * @param sm A sequence of notice mask characters
534 * @return The cleaned mode sequence which can be output,
535 * e.g. in the above example if masks c and e are not
536 * valid, this function will return +ab-d
538 std::string ProcessNoticeMasks(const char *sm);
540 /** Returns true if a notice mask is set
541 * @param sm A notice mask character to check
542 * @return True if the notice mask is set
544 bool IsNoticeMaskSet(unsigned char sm);
546 /** Changed a specific notice mask value
547 * @param sm The server notice mask to change
548 * @param value An on/off value for this mask
550 void SetNoticeMask(unsigned char sm, bool value);
552 /** Create a displayable mode string for this users umodes
553 * @param The mode string
555 const char* FormatModes(bool showparameters = false);
557 /** Returns true if a specific mode is set
558 * @param m The user mode
559 * @return True if the mode is set
561 bool IsModeSet(unsigned char m);
563 /** Set a specific usermode to on or off
564 * @param m The user mode
565 * @param value On or off setting of the mode
567 void SetMode(unsigned char m, bool value);
569 /** Returns true if a user is invited to a channel.
570 * @param channel A channel name to look up
571 * @return True if the user is invited to the given channel
573 virtual bool IsInvited(const irc::string &channel);
575 /** Adds a channel to a users invite list (invites them to a channel)
576 * @param channel A channel name to add
577 * @param timeout When the invite should expire (0 == never)
579 virtual void InviteTo(const irc::string &channel, time_t timeout);
581 /** Removes a channel from a users invite list.
582 * This member function is called on successfully joining an invite only channel
583 * to which the user has previously been invited, to clear the invitation.
584 * @param channel The channel to remove the invite to
586 virtual void RemoveInvite(const irc::string &channel);
588 /** Returns true or false for if a user can execute a privilaged oper command.
589 * This is done by looking up their oper type from User::oper, then referencing
590 * this to their oper classes and checking the commands they can execute.
591 * @param command A command (should be all CAPS)
592 * @return True if this user can execute the command
594 bool HasPermission(const std::string &command);
596 /** Returns true if a user has a given permission.
597 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
598 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
600 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
601 * @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.
602 * @return True if this user has the permission in question.
604 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
606 /** Returns true or false if a user can set a privileged user or channel mode.
607 * This is done by looking up their oper type from User::oper, then referencing
608 * this to their oper classes, and checking the modes they can set.
609 * @param mode The mode the check
610 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
611 * @return True if the user can set or unset this mode.
613 bool HasModePermission(unsigned char mode, ModeType type);
615 /** Calls read() to read some data for this user using their fd.
616 * @param buffer The buffer to read into
617 * @param size The size of data to read
618 * @return The number of bytes read, or -1 if an error occured.
620 int ReadData(void* buffer, size_t size);
622 /** This method adds data to the read buffer of the user.
623 * The buffer can grow to any size within limits of the available memory,
624 * managed by the size of a std::string, however if any individual line in
625 * the buffer grows over 600 bytes in length (which is 88 chars over the
626 * RFC-specified limit per line) then the method will return false and the
627 * text will not be inserted.
628 * @param a The string to add to the users read buffer
629 * @return True if the string was successfully added to the read buffer
631 bool AddBuffer(const std::string &a);
633 /** This method returns true if the buffer contains at least one carriage return
634 * character (e.g. one complete line may be read)
635 * @return True if there is at least one complete line in the users buffer
637 bool BufferIsReady();
639 /** This function clears the entire buffer by setting it to an empty string.
643 /** This method returns the first available string at the tail end of the buffer
644 * and advances the tail end of the buffer past the string. This means it is
645 * a one way operation in a similar way to strtok(), and multiple calls return
646 * multiple lines if they are available. The results of this function if there
647 * are no lines to be read are unknown, always use BufferIsReady() to check if
648 * it is ok to read the buffer before calling GetBuffer().
649 * @return The string at the tail end of this users buffer
651 std::string GetBuffer();
653 /** Adds to the user's write buffer.
654 * You may add any amount of text up to this users sendq value, if you exceed the
655 * sendq value, the user will be removed, and further buffer adds will be dropped.
656 * @param data The data to add to the write buffer
658 void AddWriteBuf(const std::string &data);
660 /** Flushes as much of the user's buffer to the file descriptor as possible.
661 * This function may not always flush the entire buffer, rather instead as much of it
662 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
663 * position is advanced forwards and the rest of the data sent at the next call to
666 void FlushWriteBuf();
668 /** Returns the list of channels this user has been invited to but has not yet joined.
669 * @return A list of channels the user is invited to
671 InvitedList* GetInviteList();
673 /** Creates a wildcard host.
674 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
675 * @return The wildcarded hostname in *!*@host form
677 char* MakeWildHost();
679 /** Creates a usermask with real host.
680 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
681 * @return the usermask in the format user@host
683 const std::string& MakeHost();
685 /** Creates a usermask with real ip.
686 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
687 * @return the usermask in the format user@ip
689 const std::string& MakeHostIP();
691 /** Shuts down and closes the user's socket
692 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
693 * which will call CloseSocket() for you.
697 /** Add the user to WHOWAS system
701 /** Oper up the user using the given opertype.
702 * This will also give the +o usermode.
703 * @param opertype The oper type to oper as
705 void Oper(const std::string &opertype, const std::string &opername);
707 /** Call this method to find the matching <connect> for a user, and to check them against it.
711 /** Use this method to fully connect a user.
712 * This will send the message of the day, check G/K/E lines, etc.
716 /** Change this users hash key to a new string.
717 * You should not call this function directly. It is used by the core
718 * to update the users hash entry on a nickchange.
719 * @param New new user_hash key
720 * @return Pointer to User in hash (usually 'this')
722 User* UpdateNickHash(const char* New);
724 /** Force a nickname change.
725 * If the nickname change fails (for example, because the nick in question
726 * already exists) this function will return false, and you must then either
727 * output an error message, or quit the user for nickname collision.
728 * @param newnick The nickname to change to
729 * @return True if the nickchange was successful.
731 bool ForceNickChange(const char* newnick);
734 * This will clear the +o usermode and unset the user's oper type
738 /** Write text to this user, appending CR/LF.
739 * @param text A std::string to send to the user
741 void Write(const std::string &text);
743 /** Write text to this user, appending CR/LF.
744 * @param text The format string for text to send to the user
745 * @param ... POD-type format arguments
747 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
749 /** Write text to this user, appending CR/LF and prepending :server.name
750 * @param text A std::string to send to the user
752 void WriteServ(const std::string& text);
754 /** Write text to this user, appending CR/LF and prepending :server.name
755 * @param text The format string for text to send to the user
756 * @param ... POD-type format arguments
758 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
760 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
762 void WriteNumeric(unsigned int numeric, const std::string &text);
764 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
765 * @param user The user to prepend the :nick!user@host of
766 * @param text A std::string to send to the user
768 void WriteFrom(User *user, const std::string &text);
770 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
771 * @param user The user to prepend the :nick!user@host of
772 * @param text The format string for text to send to the user
773 * @param ... POD-type format arguments
775 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
777 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
778 * @param dest The user to route the message to
779 * @param text A std::string to send to the user
781 void WriteTo(User *dest, const std::string &data);
783 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
784 * @param dest The user to route the message to
785 * @param text The format string for text to send to the user
786 * @param ... POD-type format arguments
788 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
790 /** Write to all users that can see this user (including this user in the list), appending CR/LF
791 * @param text A std::string to send to the users
793 void WriteCommon(const std::string &text);
795 /** Write to all users that can see this user (including this user in the list), appending CR/LF
796 * @param text The format string for text to send to the users
797 * @param ... POD-type format arguments
799 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
801 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
802 * @param text The format string for text to send to the users
803 * @param ... POD-type format arguments
805 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
807 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
808 * @param text A std::string to send to the users
810 void WriteCommonExcept(const std::string &text);
812 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
813 * quit message for opers only.
814 * @param normal_text Normal user quit message
815 * @param oper_text Oper only quit message
817 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
819 /** Write a WALLOPS message from this user to all local opers.
820 * If this user is not opered, the function will return without doing anything.
821 * @param text The format string to send in the WALLOPS message
822 * @param ... Format arguments
824 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
826 /** Write a WALLOPS message from this user to all local opers.
827 * If this user is not opered, the function will return without doing anything.
828 * @param text The text to send in the WALLOPS message
830 void WriteWallOps(const std::string &text);
832 /** Return true if the user shares at least one channel with another user
833 * @param other The other user to compare the channel list against
834 * @return True if the given user shares at least one channel with this user
836 bool SharesChannelWith(User *other);
838 /** Send fake quit/join messages for host or ident cycle.
839 * Run this after the item in question has changed.
840 * You should not need to use this function, call ChangeDisplayedHost instead
842 * @param The entire QUIT line, including the source using the old value
844 void DoHostCycle(const std::string &quitline);
846 /** Change the displayed host of a user.
847 * ALWAYS use this function, rather than writing User::dhost directly,
848 * as this triggers module events allowing the change to be syncronized to
849 * remote servers. This will also emulate a QUIT and rejoin (where configured)
850 * before setting their host field.
851 * @param host The new hostname to set
852 * @return True if the change succeeded, false if it didn't
854 bool ChangeDisplayedHost(const char* host);
856 /** Change the ident (username) of a user.
857 * ALWAYS use this function, rather than writing User::ident directly,
858 * as this correctly causes the user to seem to quit (where configured)
859 * before setting their ident field.
860 * @param host The new ident to set
861 * @return True if the change succeeded, false if it didn't
863 bool ChangeIdent(const char* newident);
865 /** Change a users realname field.
866 * ALWAYS use this function, rather than writing User::fullname directly,
867 * as this triggers module events allowing the change to be syncronized to
869 * @param gecos The user's new realname
870 * @return True if the change succeeded, false if otherwise
872 bool ChangeName(const char* gecos);
874 /** Send a command to all local users from this user
875 * The command given must be able to send text with the
876 * first parameter as a servermask (e.g. $*), so basically
877 * you should use PRIVMSG or NOTICE.
878 * @param command the command to send
879 * @param text The text format string to send
880 * @param ... Format arguments
882 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
884 /** Compile a channel list for this user, and send it to the user 'source'
885 * Used internally by WHOIS
886 * @param The user to send the channel list to if it is not too long
887 * @return This user's channel list
889 std::string ChannelList(User* source);
891 /** Split the channel list in cl which came from dest, and spool it to this user
892 * Used internally by WHOIS
893 * @param dest The user the original channel list came from
894 * @param cl The channel list as a string obtained from User::ChannelList()
896 void SplitChanList(User* dest, const std::string &cl);
898 /** Remove this user from all channels they are on, and delete any that are now empty.
899 * This is used by QUIT, and will not send part messages!
901 void PurgeEmptyChannels();
903 /** Get the connect class which this user belongs to.
904 * @return A pointer to this user's connect class
906 ConnectClass *GetClass();
908 /** Set the connect class to which this user belongs to.
909 * @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.
910 * @return A reference to this user's current connect class.
912 ConnectClass *SetClass(const std::string &explicit_name = "");
914 /** Show the message of the day to this user
918 /** Show the server RULES file to this user
922 /** Increases a user's command penalty by a set amount.
924 void IncreasePenalty(int increase);
926 /** Decreases a user's command penalty by a set amount.
928 void DecreasePenalty(int decrease);
930 /** Handle socket event.
931 * From EventHandler class.
932 * @param et Event type
933 * @param errornum Error number for EVENT_ERROR events
935 void HandleEvent(EventType et, int errornum = 0);
937 /** Default destructor
942 /** Derived from Resolver, and performs user forward/reverse lookups.
944 class CoreExport UserResolver : public Resolver
947 /** User this class is 'attached' to.
950 /** File descriptor teh lookup is bound to
953 /** True if the lookup is forward, false if is a reverse lookup
957 /** Create a resolver.
958 * @param Instance The creating instance
959 * @param user The user to begin lookup on
960 * @param to_resolve The IP or host to resolve
961 * @param qt The query type
962 * @param cache Modified by the constructor if the result was cached
964 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
966 /** Called on successful lookup
967 * @param result Result string
968 * @param ttl Time to live for result
969 * @param cached True if the result was found in the cache
971 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
973 /** Called on failed lookup
974 * @param e Error code
975 * @param errormessage Error message string
977 void OnError(ResolverError e, const std::string &errormessage);
980 /* Configuration callbacks */
981 //class ServerConfig;