1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 #include "inspircd_config.h"
21 #include "inspstring.h"
22 #include "connection.h"
38 /** RFC1459 channel modes
41 UM_SERVERNOTICE = 's'-65,
43 UM_INVISIBLE = 'i'-65,
48 enum RegistrationState {
49 REG_NONE = 0, /* Has sent nothing */
50 REG_USER = 1, /* Has sent USER */
51 REG_NICK = 2, /* Has sent NICK */
52 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
53 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
58 /** Derived from Resolver, and performs user forward/reverse lookups.
60 class UserResolver : public Resolver
63 /** User this class is 'attached' to.
69 UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
71 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
72 void OnError(ResolverError e, const std::string &errormessage);
76 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
78 class ConnectClass : public classbase
81 /** Type of line, either CC_ALLOW or CC_DENY
84 /** Max time to register the connection in seconds
86 unsigned int registration_timeout;
87 /** Number of lines in buffer before excess flood is triggered
90 /** Host mask for this line
93 /** Number of seconds between pings for this line
95 unsigned int pingtime;
96 /** (Optional) Password for this line
100 /** Threshold value for flood disconnect
102 unsigned int threshold;
104 /** Maximum size of sendq for users in this class (bytes)
106 unsigned long sendqmax;
108 /** Maximum size of recvq for users in this class (bytes)
110 unsigned long recvqmax;
112 /** Local max when connecting by this connection class
114 unsigned long maxlocal;
116 /** Global max when connecting by this connection class
118 unsigned long maxglobal;
119 /** Port number this connect class applies to
125 /** Create a new connect class with no settings.
127 ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
128 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
130 /** Create a new connect class to ALLOW connections.
131 * @param timeout The registration timeout
132 * @param fld The flood value
133 * @param hst The IP mask to allow
134 * @param ping The ping frequency
135 * @param pas The password to be used
136 * @param thres The flooding threshold
137 * @param sendq The maximum sendq value
138 * @param recvq The maximum recvq value
139 * @param maxl The maximum local sessions
140 * @param maxg The maximum global sessions
142 ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
143 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
144 unsigned long maxl, unsigned long maxg, int p = 0) :
145 type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
146 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
148 /** Create a new connect class to DENY connections
149 * @param hst The IP mask to deny
151 ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
152 pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
154 /** Returns the type, CC_ALLOW or CC_DENY
158 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
161 /** Returns the registration timeout
163 unsigned int GetRegTimeout()
165 return (registration_timeout ? registration_timeout : 90);
168 /** Returns the flood limit
170 unsigned int GetFlood()
172 return (threshold ? flood : 999);
175 /** Returns the allowed or denied IP mask
177 const std::string& GetHost()
187 /** Returns the ping frequency
189 unsigned int GetPingTime()
191 return (pingtime ? pingtime : 120);
194 /** Returns the password or an empty string
196 const std::string& GetPass()
201 /** Returns the flood threshold value
203 unsigned int GetThreshold()
205 return (threshold ? threshold : 1);
208 /** Returns the maximum sendq value
210 unsigned long GetSendqMax()
212 return (sendqmax ? sendqmax : 262114);
215 /** Returns the maximum recvq value
217 unsigned long GetRecvqMax()
219 return (recvqmax ? recvqmax : 4096);
222 /** Returusn the maximum number of local sessions
224 unsigned long GetMaxLocal()
226 return (maxlocal ? maxlocal : 1);
229 /** Returns the maximum number of global sessions
231 unsigned long GetMaxGlobal()
233 return (maxglobal ? maxglobal : 1);
237 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
239 typedef std::vector<irc::string> InvitedList;
241 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
243 typedef std::vector<ConnectClass> ClassVector;
245 /** Typedef for the list of user-channel records for a user
247 typedef std::map<chanrec*, char> UserChanList;
248 typedef UserChanList::iterator UCListIter;
250 /** Holds all information about a user
251 * This class stores all information about a user connected to the irc server. Everything about a
252 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
253 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
254 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
255 * file descriptor value.
257 class userrec : public connection
260 /** Pointer to creator.
261 * This is required to make use of core functions
262 * from within the userrec class.
264 InspIRCd* ServerInstance;
266 /** A list of channels the user has a pending invite to.
267 * Upon INVITE channels are added, and upon JOIN, the
268 * channels are removed from this list.
272 /** Number of channels this user is currently on
274 unsigned int ChannelCount;
276 /** Cached nick!ident@host value using the real hostname
278 char* cached_fullhost;
280 /** Cached nick!ident@ip value using the real IP address
284 /** Cached nick!ident@host value using the masked hostname
286 char* cached_makehost;
287 char* cached_fullrealhost;
289 /** When we erase the user (in the destructor),
290 * we call this method to subtract one from all
291 * mode characters this user is making use of.
293 void DecrementModes();
298 /** Resolvers for looking up this users IP address
299 * This will occur if and when res_reverse completes.
300 * When this class completes its lookup, userrec::dns_done
301 * will be set from false to true.
303 UserResolver* res_forward;
305 /** Resolvers for looking up this users hostname
306 * This is instantiated by userrec::StartDNSLookup(),
307 * and on success, instantiates userrec::res_reverse.
309 UserResolver* res_reverse;
311 /** Stored reverse lookup from res_forward
313 std::string stored_host;
315 /** Starts a DNS lookup of the user's IP.
316 * This will cause two UserResolver classes to be instantiated.
317 * When complete, these objects set userrec::dns_done to true.
319 void StartDNSLookup();
321 /** The users nickname.
322 * An invalid nickname indicates an unregistered connection prior to the NICK command.
323 * Use InspIRCd::IsNick() to validate nicknames.
327 /** The users ident reply.
328 * Two characters are added to the user-defined limit to compensate for the tilde etc.
330 char ident[IDENTMAX+2];
332 /** The host displayed to non-opers (used for cloaking etc).
333 * This usually matches the value of userrec::host.
337 /** The users full name (GECOS).
339 char fullname[MAXGECOS+1];
341 /** The user's mode list.
342 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
343 * this is an array of values in a similar way to channel modes.
344 * A value of 1 in field (modeletter-65) indicates that the mode is
345 * set, for example, to work out if mode +s is set, we check the field
346 * userrec::modes['s'-65] != 0.
347 * The following RFC characters o, w, s, i have constants defined via an
348 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
352 /** What snomasks are set on this user.
353 * This functions the same as the above modes.
357 /** Channels this user is on, and the permissions they have there
361 /** The server the user is connected to.
365 /** The user's away message.
366 * If this string is empty, the user is not marked as away.
368 char awaymsg[MAXAWAY+1];
370 /** Number of lines the user can place into the buffer
371 * (up to the global NetBufferSize bytes) before they
372 * are disconnected for excess flood
376 /** Timestamp of current time + connection class timeout.
377 * This user must send USER/NICK before this timestamp is
378 * reached or they will be disconnected.
382 /** The oper type they logged in as, if they are an oper.
383 * This is used to check permissions in operclasses, so that
384 * we can say 'yay' or 'nay' to any commands they issue.
385 * The value of this is the value of a valid 'type name=' tag.
389 /** True when DNS lookups are completed.
390 * The UserResolver classes res_forward and res_reverse will
391 * set this value once they complete.
395 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
397 unsigned int pingmax;
399 /** Password specified by the user when they registered.
400 * This is stored even if the <connect> block doesnt need a password, so that
401 * modules may check it.
405 /** User's receive queue.
406 * Lines from the IRCd awaiting processing are stored here.
407 * Upgraded april 2005, old system a bit hairy.
411 /** User's send queue.
412 * Lines waiting to be sent are stored here until their buffer is flushed.
416 /** Flood counters - lines received
420 /** Flood counters - time lines_in is due to be reset
424 /** Flood counters - Highest value lines_in may reach before the user gets disconnected
428 /** If this is set to true, then all read operations for the user
429 * are dropped into the bit-bucket.
430 * This is used by the global CullList, but please note that setting this value
431 * alone will NOT cause the user to quit. This means it can be used seperately,
432 * for example by shun modules etc.
436 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
437 * GetIPString/GetPort to obtain its values.
441 /** Initialize the clients sockaddr
442 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
443 * @param ip A human-readable IP address for this user matching the protcol_family
444 * @param port The port number of this user or zero for a remote user
446 void SetSockAddr(int protocol_family, const char* ip, int port);
448 /** Get port number from sockaddr
449 * @return The port number of this user.
453 /** Get protocol family from sockaddr
454 * @return The protocol family of this user, either AF_INET or AF_INET6
456 int GetProtocolFamily();
458 /** Get IP string from sockaddr, using static internal buffer
459 * @return The IP string
461 const char* GetIPString();
463 /** Get IP string from sockaddr, using caller-specified buffer
464 * @param buf A buffer to use
465 * @return The IP string
467 const char* GetIPString(char* buf);
469 /* Write error string
471 std::string WriteError;
473 /** Maximum size this user's sendq can become.
474 * Copied from the connect class on connect.
478 /** Maximum size this user's recvq can become.
479 * Copied from the connect class on connect.
483 /** This is true if the user matched an exception when they connected to the ircd.
484 * It isnt valid after this point, and you should not attempt to do anything with it
485 * after this point, because the eline might be removed at a later time, and/or no
486 * longer be applicable to this user. It is only used to save doing the eline lookup
487 * twice (instead we do it once and set this value).
491 /** Default constructor
492 * @throw Nothing at present
494 userrec(InspIRCd* Instance);
496 /** Returns the full displayed host of the user
497 * This member function returns the hostname of the user as seen by other users
498 * on the server, in nick!ident&at;host form.
499 * @return The full masked host of the user
501 virtual char* GetFullHost();
503 /** Returns the full real host of the user
504 * This member function returns the hostname of the user as seen by other users
505 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
506 * e.g. through a module, then this method will ignore it and return the true hostname.
507 * @return The full real host of the user
509 virtual char* GetFullRealHost();
511 /** This clears any cached results that are used for GetFullRealHost() etc.
512 * The results of these calls are cached as generating them can be generally expensive.
514 void InvalidateCache();
516 /** Create a displayable mode string for this users snomasks
517 * @return The notice mask character sequence
519 const char* FormatNoticeMasks();
521 /** Process a snomask modifier string, e.g. +abc-de
522 * @param sm A sequence of notice mask characters
523 * @return The cleaned mode sequence which can be output,
524 * e.g. in the above example if masks c and e are not
525 * valid, this function will return +ab-d
527 std::string ProcessNoticeMasks(const char *sm);
529 /** Returns true if a notice mask is set
530 * @param sm A notice mask character to check
531 * @return True if the notice mask is set
533 bool IsNoticeMaskSet(unsigned char sm);
535 /** Changed a specific notice mask value
536 * @param sm The server notice mask to change
537 * @param value An on/off value for this mask
539 void SetNoticeMask(unsigned char sm, bool value);
541 /** Create a displayable mode string for this users umodes
542 * @param The mode string
544 const char* FormatModes();
546 /** Returns true if a specific mode is set
547 * @param m The user mode
548 * @return True if the mode is set
550 bool IsModeSet(unsigned char m);
552 /** Set a specific usermode to on or off
553 * @param m The user mode
554 * @param value On or off setting of the mode
556 void SetMode(unsigned char m, bool value);
558 /** Returns true if a user is invited to a channel.
559 * @param channel A channel name to look up
560 * @return True if the user is invited to the given channel
562 virtual bool IsInvited(const irc::string &channel);
564 /** Adds a channel to a users invite list (invites them to a channel)
565 * @param channel A channel name to add
567 virtual void InviteTo(const irc::string &channel);
569 /** Removes a channel from a users invite list.
570 * This member function is called on successfully joining an invite only channel
571 * to which the user has previously been invited, to clear the invitation.
572 * @param channel The channel to remove the invite to
574 virtual void RemoveInvite(const irc::string &channel);
576 /** Returns true or false for if a user can execute a privilaged oper command.
577 * This is done by looking up their oper type from userrec::oper, then referencing
578 * this to their oper classes and checking the commands they can execute.
579 * @param command A command (should be all CAPS)
580 * @return True if this user can execute the command
582 bool HasPermission(const std::string &command);
584 /** Calls read() to read some data for this user using their fd.
585 * @param buffer The buffer to read into
586 * @param size The size of data to read
587 * @return The number of bytes read, or -1 if an error occured.
589 int ReadData(void* buffer, size_t size);
591 /** This method adds data to the read buffer of the user.
592 * The buffer can grow to any size within limits of the available memory,
593 * managed by the size of a std::string, however if any individual line in
594 * the buffer grows over 600 bytes in length (which is 88 chars over the
595 * RFC-specified limit per line) then the method will return false and the
596 * text will not be inserted.
597 * @param a The string to add to the users read buffer
598 * @return True if the string was successfully added to the read buffer
600 bool AddBuffer(std::string a);
602 /** This method returns true if the buffer contains at least one carriage return
603 * character (e.g. one complete line may be read)
604 * @return True if there is at least one complete line in the users buffer
606 bool BufferIsReady();
608 /** This function clears the entire buffer by setting it to an empty string.
612 /** This method returns the first available string at the tail end of the buffer
613 * and advances the tail end of the buffer past the string. This means it is
614 * a one way operation in a similar way to strtok(), and multiple calls return
615 * multiple lines if they are available. The results of this function if there
616 * are no lines to be read are unknown, always use BufferIsReady() to check if
617 * it is ok to read the buffer before calling GetBuffer().
618 * @return The string at the tail end of this users buffer
620 std::string GetBuffer();
622 /** Sets the write error for a connection. This is done because the actual disconnect
623 * of a client may occur at an inopportune time such as half way through /LIST output.
624 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
625 * errored clients purged.
626 * @param error The error string to set.
628 void SetWriteError(const std::string &error);
630 /** Returns the write error which last occured on this connection or an empty string
632 * @return The error string which has occured for this user
634 const char* GetWriteError();
636 /** Adds to the user's write buffer.
637 * You may add any amount of text up to this users sendq value, if you exceed the
638 * sendq value, SetWriteError() will be called to set the users error string to
639 * "SendQ exceeded", and further buffer adds will be dropped.
640 * @param data The data to add to the write buffer
642 void AddWriteBuf(const std::string &data);
644 /** Flushes as much of the user's buffer to the file descriptor as possible.
645 * This function may not always flush the entire buffer, rather instead as much of it
646 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
647 * position is advanced forwards and the rest of the data sent at the next call to
650 void FlushWriteBuf();
652 /** Returns the list of channels this user has been invited to but has not yet joined.
653 * @return A list of channels the user is invited to
655 InvitedList* GetInviteList();
657 /** Creates a wildcard host.
658 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
659 * @return The wildcarded hostname in *!*@host form
661 char* MakeWildHost();
663 /** Creates a usermask with real host.
664 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
665 * @return the usermask in the format user@host
669 /** Creates a usermask with real ip.
670 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
671 * @return the usermask in the format user@ip
675 /** Shuts down and closes the user's socket
676 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
677 * which will call CloseSocket() for you.
681 /** Disconnect a user gracefully
682 * @param user The user to remove
683 * @param r The quit reason to show to normal users
684 * @param oreason The quit reason to show to opers
685 * @return Although this function has no return type, on exit the user provided will no longer exist.
687 static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
689 /** Add the user to WHOWAS system
693 /** Oper up the user using the given opertype.
694 * This will also give the +o usermode.
695 * @param opertype The oper type to oper as
697 void Oper(const std::string &opertype);
699 /** Use this method to fully connect a user.
700 * This will send the message of the day, check G/K/E lines, etc.
704 /** Change this users hash key to a new string.
705 * You should not call this function directly. It is used by the core
706 * to update the users hash entry on a nickchange.
707 * @param New new user_hash key
708 * @return Pointer to userrec in hash (usually 'this')
710 userrec* UpdateNickHash(const char* New);
712 /** Force a nickname change.
713 * If the nickname change fails (for example, because the nick in question
714 * already exists) this function will return false, and you must then either
715 * output an error message, or quit the user for nickname collision.
716 * @param newnick The nickname to change to
717 * @return True if the nickchange was successful.
719 bool ForceNickChange(const char* newnick);
721 /** Add a client to the system.
722 * This will create a new userrec, insert it into the user_hash,
723 * initialize it as not yet registered, and add it to the socket engine.
724 * @param Instance a pointer to the server instance
725 * @param socket The socket id (file descriptor) this user is on
726 * @param port The port number this user connected on
727 * @param iscached This variable is reserved for future use
728 * @param ip The IP address of the user
729 * @return This function has no return value, but a call to AddClient may remove the user.
731 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
734 * This will clear the +o usermode and unset the user's oper type
738 /** Return the number of global clones of this user
739 * @return The global clone count of this user
741 unsigned long GlobalCloneCount();
743 /** Return the number of local clones of this user
744 * @return The local clone count of this user
746 unsigned long LocalCloneCount();
748 /** Write text to this user, appending CR/LF.
749 * @param text A std::string to send to the user
751 void Write(std::string text);
753 /** Write text to this user, appending CR/LF.
754 * @param text The format string for text to send to the user
755 * @param ... POD-type format arguments
757 void Write(const char *text, ...);
759 /** Write text to this user, appending CR/LF and prepending :server.name
760 * @param text A std::string to send to the user
762 void WriteServ(const std::string& text);
764 /** Write text to this user, appending CR/LF and prepending :server.name
765 * @param text The format string for text to send to the user
766 * @param ... POD-type format arguments
768 void WriteServ(const char* 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 A std::string to send to the user
774 void WriteFrom(userrec *user, const std::string &text);
776 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
777 * @param user The user to prepend the :nick!user@host of
778 * @param text The format string for text to send to the user
779 * @param ... POD-type format arguments
781 void WriteFrom(userrec *user, const char* text, ...);
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 A std::string to send to the user
787 void WriteTo(userrec *dest, const std::string &data);
789 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
790 * @param dest The user to route the message to
791 * @param text The format string for text to send to the user
792 * @param ... POD-type format arguments
794 void WriteTo(userrec *dest, const char *data, ...);
796 /** Write to all users that can see this user (including this user in the list), appending CR/LF
797 * @param text A std::string to send to the users
799 void WriteCommon(const std::string &text);
801 /** Write to all users that can see this user (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 WriteCommon(const char* text, ...);
807 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
808 * @param text The format string for text to send to the users
809 * @param ... POD-type format arguments
811 void WriteCommonExcept(const char* text, ...);
813 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
814 * @param text A std::string to send to the users
816 void WriteCommonExcept(const std::string &text);
818 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
820 /** Write a WALLOPS message from this user to all local opers.
821 * If this user is not opered, the function will return without doing anything.
822 * @param text The format string to send in the WALLOPS message
823 * @param ... Format arguments
825 void WriteWallOps(const char* text, ...);
827 /** Write a WALLOPS message from this user to all local opers.
828 * If this user is not opered, the function will return without doing anything.
829 * @param text The text to send in the WALLOPS message
831 void WriteWallOps(const std::string &text);
833 /** Return true if the user shares at least one channel with another user
834 * @param other The other user to compare the channel list against
835 * @return True if the given user shares at least one channel with this user
837 bool SharesChannelWith(userrec *other);
839 /** Change the displayed host of a user.
840 * ALWAYS use this function, rather than writing userrec::dhost directly,
841 * as this triggers module events allowing the change to be syncronized to
842 * remote servers. This will also emulate a QUIT and rejoin (where configured)
843 * before setting their host field.
844 * @param host The new hostname to set
845 * @return True if the change succeeded, false if it didn't
847 bool ChangeDisplayedHost(const char* host);
849 /** Change the ident (username) of a user.
850 * ALWAYS use this function, rather than writing userrec::ident directly,
851 * as this correctly causes the user to seem to quit (where configured)
852 * before setting their ident field.
853 * @param host The new ident to set
854 * @return True if the change succeeded, false if it didn't
856 bool ChangeIdent(const char* newident);
858 /** Change a users realname field.
859 * ALWAYS use this function, rather than writing userrec::fullname directly,
860 * as this triggers module events allowing the change to be syncronized to
862 * @param gecos The user's new realname
863 * @return True if the change succeeded, false if otherwise
865 bool ChangeName(const char* gecos);
867 /** Send a command to all local users from this user
868 * The command given must be able to send text with the
869 * first parameter as a servermask (e.g. $*), so basically
870 * you should use PRIVMSG or NOTICE.
871 * @param command the command to send
872 * @param text The text format string to send
873 * @param ... Format arguments
875 void SendAll(const char* command, char* text, ...);
877 /** Compile a channel list for this user, and send it to the user 'source'
878 * Used internally by WHOIS
879 * @param The user to send the channel list to if it is not too long
880 * @return This user's channel list
882 std::string ChannelList(userrec* source);
884 /** Split the channel list in cl which came from dest, and spool it to this user
885 * Used internally by WHOIS
886 * @param dest The user the original channel list came from
887 * @param cl The channel list as a string obtained from userrec::ChannelList()
889 void SplitChanList(userrec* dest, const std::string &cl);
891 /** Remove this user from all channels they are on, and delete any that are now empty.
892 * This is used by QUIT, and will not send part messages!
894 void PurgeEmptyChannels();
896 /** Get the connect class which matches this user's host or IP address
897 * @return A reference to this user's connect class
899 ConnectClass* GetClass();
901 /** Show the message of the day to this user
905 /** Show the server RULES file to this user
909 /** Set oper-specific quit message shown to opers only when the user quits
910 * (overrides any sent by QuitUser)
912 void SetOperQuit(const std::string &oquit);
914 const char* GetOperQuit();
916 /** Handle socket event.
917 * From EventHandler class.
918 * @param et Event type
919 * @param errornum Error number for EVENT_ERROR events
921 void HandleEvent(EventType et, int errornum = 0);
923 /** Default destructor
928 /* Configuration callbacks */