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 /** Visibility data for a user.
222 * If a user has a non-null instance of this class in their User,
223 * then it is used to determine if this user is visible to other users
226 class CoreExport VisData
232 /** Destroy a visdata
235 /** Is this user visible to some other user?
236 * @param user The other user to compare to
237 * @return true True if the user is visible to the other user, false if not
239 virtual bool VisibleTo(User* user);
242 /** Holds all information about a user
243 * This class stores all information about a user connected to the irc server. Everything about a
244 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
245 * user's nickname and hostname.
247 class CoreExport User : public EventHandler
250 /** A list of channels the user has a pending invite to.
251 * Upon INVITE channels are added, and upon JOIN, the
252 * channels are removed from this list.
256 /** Cached nick!ident@dhost value using the displayed hostname
258 std::string cached_fullhost;
260 /** Cached ident@ip value using the real IP address
262 std::string cached_hostip;
264 /** Cached ident@realhost value using the real hostname
266 std::string cached_makehost;
268 /** Cached nick!ident@realhost value using the real hostname
270 std::string cached_fullrealhost;
272 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
274 std::string cachedip;
276 /** When we erase the user (in the destructor),
277 * we call this method to subtract one from all
278 * mode characters this user is making use of.
280 void DecrementModes();
282 std::set<std::string> *AllowedOperCommands;
283 std::set<std::string> *AllowedPrivs;
285 /** Allowed user modes from oper classes. */
286 std::bitset<64> AllowedUserModes;
288 /** Allowed channel modes from oper classes. */
289 std::bitset<64> AllowedChanModes;
292 /** Pointer to creator.
293 * This is required to make use of core functions
294 * from within the User class.
296 InspIRCd* ServerInstance;
298 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
299 * The pointer is guarenteed to *always* be valid. :)
301 ConnectClass *MyClass;
303 /** User visibility state, see definition of VisData.
307 /** Hostname of connection.
308 * This should be valid as per RFC1035.
312 /** Stats counter for bytes inbound
316 /** Stats counter for bytes outbound
320 /** Stats counter for commands inbound
324 /** Stats counter for commands outbound
328 /** True if user has authenticated, false if otherwise
332 /** Used by User to indicate the registration status of the connection
333 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
334 * the connection state.
338 /** Time the connection was last pinged
342 /** Time the connection was created, set in the constructor. This
343 * may be different from the time the user's classbase object was
348 /** Time that the connection last sent a message, used to calculate idle time
352 /** Used by PING checking code
356 /** Stored reverse lookup from res_forward. Should not be used after resolution.
358 std::string stored_host;
360 /** Starts a DNS lookup of the user's IP.
361 * This will cause two UserResolver classes to be instantiated.
362 * When complete, these objects set User::dns_done to true.
364 void StartDNSLookup();
366 /** The users nickname.
367 * An invalid nickname indicates an unregistered connection prior to the NICK command.
368 * Use InspIRCd::IsNick() to validate nicknames.
372 /** The user's unique identifier.
373 * This is the unique identifier which the user has across the network.
377 /** The users ident reply.
378 * Two characters are added to the user-defined limit to compensate for the tilde etc.
382 /** The host displayed to non-opers (used for cloaking etc).
383 * This usually matches the value of User::host.
387 /** The users full name (GECOS).
389 std::string fullname;
391 /** The user's mode list.
392 * NOT a null terminated string.
394 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
395 * if (modes[modeletter-65]) is set, then the mode is
396 * set, for example, to work out if mode +s is set, we check the field
397 * User::modes['s'-65] != 0.
398 * The following RFC characters o, w, s, i have constants defined via an
399 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
401 std::bitset<64> modes;
403 /** What snomasks are set on this user.
404 * This functions the same as the above modes.
406 std::bitset<64> snomasks;
408 /** Channels this user is on, and the permissions they have there
412 /** The server the user is connected to.
416 /** The user's away message.
417 * If this string is empty, the user is not marked as away.
421 /** Time the user last went away.
422 * This is ONLY RELIABLE if user IS_AWAY()!
426 /** The oper type they logged in as, if they are an oper.
427 * This is used to check permissions in operclasses, so that
428 * we can say 'yay' or 'nay' to any commands they issue.
429 * The value of this is the value of a valid 'type name=' tag.
433 /** True when DNS lookups are completed.
434 * The UserResolver classes res_forward and res_reverse will
435 * set this value once they complete.
439 /** Password specified by the user when they registered.
440 * This is stored even if the <connect> block doesnt need a password, so that
441 * modules may check it.
443 std::string password;
445 /** User's receive queue.
446 * Lines from the IRCd awaiting processing are stored here.
447 * Upgraded april 2005, old system a bit hairy.
451 /** User's send queue.
452 * Lines waiting to be sent are stored here until their buffer is flushed.
456 /** Message user will quit with. Not to be set externally.
460 /** Quit message shown to opers - not to be set externally.
462 std::string operquitmsg;
464 /** Whether or not to send an snotice about this user's quitting
468 /** If this is set to true, then all socket operations for the user
469 * are dropped into the bit-bucket.
470 * This value is set by QuitUser, and is not needed seperately from that call.
471 * Please note that setting this value alone will NOT cause the user to quit.
475 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
476 * GetIPString/GetPort to obtain its values.
480 /** Initialize the clients sockaddr
481 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
482 * @param ip A human-readable IP address for this user matching the protcol_family
483 * @param port The port number of this user or zero for a remote user
485 void SetSockAddr(int protocol_family, const char* ip, int port);
487 /** Get port number from sockaddr
488 * @return The port number of this user.
492 /** Get protocol family from sockaddr
493 * @return The protocol family of this user, either AF_INET or AF_INET6
495 int GetProtocolFamily();
497 /** Get IP string from sockaddr, using static internal buffer
498 * @return The IP string
500 const char* GetIPString();
502 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
503 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
504 * This may be used for CIDR clone detection, etc.
506 * (XXX, brief note: when we do the sockets rewrite, this should move down a
507 * level so it may be used on more derived objects. -- w00t)
509 const char *GetCIDRMask(int range);
511 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
515 /** This value contains how far into the penalty threshold the user is. Once its over
516 * the penalty threshold then commands are held and processed on-timer.
520 /** Default constructor
521 * @throw CoreException if the UID allocated to the user already exists
522 * @param Instance Creator instance
523 * @param uid User UUID, or empty to allocate one automatically
525 User(InspIRCd* Instance, const std::string &uid = "");
527 /** Check if the user matches a G or K line, and disconnect them if they do.
528 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
529 * Returns true if the user matched a ban, false else.
531 bool CheckLines(bool doZline = false);
533 /** Returns the full displayed host of the user
534 * This member function returns the hostname of the user as seen by other users
535 * on the server, in nick!ident&at;host form.
536 * @return The full masked host of the user
538 virtual const std::string GetFullHost();
540 /** Returns the full real host of the user
541 * This member function returns the hostname of the user as seen by other users
542 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
543 * e.g. through a module, then this method will ignore it and return the true hostname.
544 * @return The full real host of the user
546 virtual const std::string GetFullRealHost();
548 /** This clears any cached results that are used for GetFullRealHost() etc.
549 * The results of these calls are cached as generating them can be generally expensive.
551 void InvalidateCache();
553 /** Create a displayable mode string for this users snomasks
554 * @return The notice mask character sequence
556 const char* FormatNoticeMasks();
558 /** Process a snomask modifier string, e.g. +abc-de
559 * @param sm A sequence of notice mask characters
560 * @return The cleaned mode sequence which can be output,
561 * e.g. in the above example if masks c and e are not
562 * valid, this function will return +ab-d
564 std::string ProcessNoticeMasks(const char *sm);
566 /** Returns true if a notice mask is set
567 * @param sm A notice mask character to check
568 * @return True if the notice mask is set
570 bool IsNoticeMaskSet(unsigned char sm);
572 /** Changed a specific notice mask value
573 * @param sm The server notice mask to change
574 * @param value An on/off value for this mask
576 void SetNoticeMask(unsigned char sm, bool value);
578 /** Create a displayable mode string for this users umodes
579 * @param The mode string
581 const char* FormatModes(bool showparameters = false);
583 /** Returns true if a specific mode is set
584 * @param m The user mode
585 * @return True if the mode is set
587 bool IsModeSet(unsigned char m);
589 /** Set a specific usermode to on or off
590 * @param m The user mode
591 * @param value On or off setting of the mode
593 void SetMode(unsigned char m, bool value);
595 /** Returns true if a user is invited to a channel.
596 * @param channel A channel name to look up
597 * @return True if the user is invited to the given channel
599 virtual bool IsInvited(const irc::string &channel);
601 /** Adds a channel to a users invite list (invites them to a channel)
602 * @param channel A channel name to add
603 * @param timeout When the invite should expire (0 == never)
605 virtual void InviteTo(const irc::string &channel, time_t timeout);
607 /** Removes a channel from a users invite list.
608 * This member function is called on successfully joining an invite only channel
609 * to which the user has previously been invited, to clear the invitation.
610 * @param channel The channel to remove the invite to
612 virtual void RemoveInvite(const irc::string &channel);
614 /** Returns true or false for if a user can execute a privilaged oper command.
615 * This is done by looking up their oper type from User::oper, then referencing
616 * this to their oper classes and checking the commands they can execute.
617 * @param command A command (should be all CAPS)
618 * @return True if this user can execute the command
620 bool HasPermission(const std::string &command);
622 /** Returns true if a user has a given permission.
623 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
624 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
626 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
627 * @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.
628 * @return True if this user has the permission in question.
630 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
632 /** Returns true or false if a user can set a privileged user or channel mode.
633 * This is done by looking up their oper type from User::oper, then referencing
634 * this to their oper classes, and checking the modes they can set.
635 * @param mode The mode the check
636 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
637 * @return True if the user can set or unset this mode.
639 bool HasModePermission(unsigned char mode, ModeType type);
641 /** Calls read() to read some data for this user using their fd.
642 * @param buffer The buffer to read into
643 * @param size The size of data to read
644 * @return The number of bytes read, or -1 if an error occured.
646 int ReadData(void* buffer, size_t size);
648 /** This method adds data to the read buffer of the user.
649 * The buffer can grow to any size within limits of the available memory,
650 * managed by the size of a std::string, however if any individual line in
651 * the buffer grows over 600 bytes in length (which is 88 chars over the
652 * RFC-specified limit per line) then the method will return false and the
653 * text will not be inserted.
654 * @param a The string to add to the users read buffer
655 * @return True if the string was successfully added to the read buffer
657 bool AddBuffer(const std::string &a);
659 /** This method returns true if the buffer contains at least one carriage return
660 * character (e.g. one complete line may be read)
661 * @return True if there is at least one complete line in the users buffer
663 bool BufferIsReady();
665 /** This function clears the entire buffer by setting it to an empty string.
669 /** This method returns the first available string at the tail end of the buffer
670 * and advances the tail end of the buffer past the string. This means it is
671 * a one way operation in a similar way to strtok(), and multiple calls return
672 * multiple lines if they are available. The results of this function if there
673 * are no lines to be read are unknown, always use BufferIsReady() to check if
674 * it is ok to read the buffer before calling GetBuffer().
675 * @return The string at the tail end of this users buffer
677 std::string GetBuffer();
679 /** Adds to the user's write buffer.
680 * You may add any amount of text up to this users sendq value, if you exceed the
681 * sendq value, the user will be removed, and further buffer adds will be dropped.
682 * @param data The data to add to the write buffer
684 void AddWriteBuf(const std::string &data);
686 /** Flushes as much of the user's buffer to the file descriptor as possible.
687 * This function may not always flush the entire buffer, rather instead as much of it
688 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
689 * position is advanced forwards and the rest of the data sent at the next call to
692 void FlushWriteBuf();
694 /** Returns the list of channels this user has been invited to but has not yet joined.
695 * @return A list of channels the user is invited to
697 InvitedList* GetInviteList();
699 /** Creates a wildcard host.
700 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
701 * @return The wildcarded hostname in *!*@host form
703 char* MakeWildHost();
705 /** Creates a usermask with real host.
706 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
707 * @return the usermask in the format user@host
709 const std::string& MakeHost();
711 /** Creates a usermask with real ip.
712 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
713 * @return the usermask in the format user@ip
715 const std::string& MakeHostIP();
717 /** Shuts down and closes the user's socket
718 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
719 * which will call CloseSocket() for you.
723 /** Add the user to WHOWAS system
727 /** Oper up the user using the given opertype.
728 * This will also give the +o usermode.
729 * @param opertype The oper type to oper as
731 void Oper(const std::string &opertype, const std::string &opername);
733 /** Call this method to find the matching <connect> for a user, and to check them against it.
737 /** Use this method to fully connect a user.
738 * This will send the message of the day, check G/K/E lines, etc.
742 /** Change this users hash key to a new string.
743 * You should not call this function directly. It is used by the core
744 * to update the users hash entry on a nickchange.
745 * @param New new user_hash key
746 * @return Pointer to User in hash (usually 'this')
748 User* UpdateNickHash(const char* New);
750 /** Force a nickname change.
751 * If the nickname change fails (for example, because the nick in question
752 * already exists) this function will return false, and you must then either
753 * output an error message, or quit the user for nickname collision.
754 * @param newnick The nickname to change to
755 * @return True if the nickchange was successful.
757 bool ForceNickChange(const char* newnick);
760 * This will clear the +o usermode and unset the user's oper type
764 /** Write text to this user, appending CR/LF.
765 * @param text A std::string to send to the user
767 void Write(std::string text);
769 /** Write text to this user, appending CR/LF.
770 * @param text The format string for text to send to the user
771 * @param ... POD-type format arguments
773 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
775 /** Write text to this user, appending CR/LF and prepending :server.name
776 * @param text A std::string to send to the user
778 void WriteServ(const std::string& text);
780 /** Write text to this user, appending CR/LF and prepending :server.name
781 * @param text The format string for text to send to the user
782 * @param ... POD-type format arguments
784 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
786 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
788 void WriteNumeric(unsigned int numeric, const std::string &text);
790 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
791 * @param user The user to prepend the :nick!user@host of
792 * @param text A std::string to send to the user
794 void WriteFrom(User *user, const std::string &text);
796 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
797 * @param user The user to prepend the :nick!user@host of
798 * @param text The format string for text to send to the user
799 * @param ... POD-type format arguments
801 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
803 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
804 * @param dest The user to route the message to
805 * @param text A std::string to send to the user
807 void WriteTo(User *dest, const std::string &data);
809 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
810 * @param dest The user to route the message to
811 * @param text The format string for text to send to the user
812 * @param ... POD-type format arguments
814 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
816 /** Write to all users that can see this user (including this user in the list), appending CR/LF
817 * @param text A std::string to send to the users
819 void WriteCommon(const std::string &text);
821 /** Write to all users that can see this user (including this user in the list), appending CR/LF
822 * @param text The format string for text to send to the users
823 * @param ... POD-type format arguments
825 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
827 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
828 * @param text The format string for text to send to the users
829 * @param ... POD-type format arguments
831 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
833 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
834 * @param text A std::string to send to the users
836 void WriteCommonExcept(const std::string &text);
838 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
839 * quit message for opers only.
840 * @param normal_text Normal user quit message
841 * @param oper_text Oper only quit message
843 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
845 /** Write a WALLOPS message from this user to all local opers.
846 * If this user is not opered, the function will return without doing anything.
847 * @param text The format string to send in the WALLOPS message
848 * @param ... Format arguments
850 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
852 /** Write a WALLOPS message from this user to all local opers.
853 * If this user is not opered, the function will return without doing anything.
854 * @param text The text to send in the WALLOPS message
856 void WriteWallOps(const std::string &text);
858 /** Return true if the user shares at least one channel with another user
859 * @param other The other user to compare the channel list against
860 * @return True if the given user shares at least one channel with this user
862 bool SharesChannelWith(User *other);
864 /** Change the displayed host of a user.
865 * ALWAYS use this function, rather than writing User::dhost directly,
866 * as this triggers module events allowing the change to be syncronized to
867 * remote servers. This will also emulate a QUIT and rejoin (where configured)
868 * before setting their host field.
869 * @param host The new hostname to set
870 * @return True if the change succeeded, false if it didn't
872 bool ChangeDisplayedHost(const char* host);
874 /** Change the ident (username) of a user.
875 * ALWAYS use this function, rather than writing User::ident directly,
876 * as this correctly causes the user to seem to quit (where configured)
877 * before setting their ident field.
878 * @param host The new ident to set
879 * @return True if the change succeeded, false if it didn't
881 bool ChangeIdent(const char* newident);
883 /** Change a users realname field.
884 * ALWAYS use this function, rather than writing User::fullname directly,
885 * as this triggers module events allowing the change to be syncronized to
887 * @param gecos The user's new realname
888 * @return True if the change succeeded, false if otherwise
890 bool ChangeName(const char* gecos);
892 /** Send a command to all local users from this user
893 * The command given must be able to send text with the
894 * first parameter as a servermask (e.g. $*), so basically
895 * you should use PRIVMSG or NOTICE.
896 * @param command the command to send
897 * @param text The text format string to send
898 * @param ... Format arguments
900 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
902 /** Compile a channel list for this user, and send it to the user 'source'
903 * Used internally by WHOIS
904 * @param The user to send the channel list to if it is not too long
905 * @return This user's channel list
907 std::string ChannelList(User* source);
909 /** Split the channel list in cl which came from dest, and spool it to this user
910 * Used internally by WHOIS
911 * @param dest The user the original channel list came from
912 * @param cl The channel list as a string obtained from User::ChannelList()
914 void SplitChanList(User* dest, const std::string &cl);
916 /** Remove this user from all channels they are on, and delete any that are now empty.
917 * This is used by QUIT, and will not send part messages!
919 void PurgeEmptyChannels();
921 /** Get the connect class which this user belongs to.
922 * @return A pointer to this user's connect class
924 ConnectClass *GetClass();
926 /** Set the connect class to which this user belongs to.
927 * @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.
928 * @return A reference to this user's current connect class.
930 ConnectClass *SetClass(const std::string &explicit_name = "");
932 /** Show the message of the day to this user
936 /** Show the server RULES file to this user
940 /** Set oper-specific quit message shown to opers only when the user quits
941 * (overrides any sent by QuitUser)
943 void SetOperQuit(const std::string &oquit);
945 /** Get oper-specific quit message shown only to opers when the user quits.
946 * (overrides any sent by QuitUser)
948 const std::string& GetOperQuit();
950 /** Increases a user's command penalty by a set amount.
952 void IncreasePenalty(int increase);
954 /** Decreases a user's command penalty by a set amount.
956 void DecreasePenalty(int decrease);
958 /** Handle socket event.
959 * From EventHandler class.
960 * @param et Event type
961 * @param errornum Error number for EVENT_ERROR events
963 void HandleEvent(EventType et, int errornum = 0);
965 /** Default destructor
970 /** Derived from Resolver, and performs user forward/reverse lookups.
972 class CoreExport UserResolver : public Resolver
975 /** User this class is 'attached' to.
978 /** File descriptor teh lookup is bound to
981 /** True if the lookup is forward, false if is a reverse lookup
985 /** Create a resolver.
986 * @param Instance The creating instance
987 * @param user The user to begin lookup on
988 * @param to_resolve The IP or host to resolve
989 * @param qt The query type
990 * @param cache Modified by the constructor if the result was cached
992 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
994 /** Called on successful lookup
995 * @param result Result string
996 * @param ttl Time to live for result
997 * @param cached True if the result was found in the cache
999 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
1001 /** Called on failed lookup
1002 * @param e Error code
1003 * @param errormessage Error message string
1005 void OnError(ResolverError e, const std::string &errormessage);
1008 /* Configuration callbacks */
1009 //class ServerConfig;