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 {
50 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
51 REG_NONE = 0, /* Has sent nothing */
54 REG_USER = 1, /* Has sent USER */
55 REG_NICK = 2, /* Has sent NICK */
56 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
57 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
62 /** Derived from Resolver, and performs user forward/reverse lookups.
64 class CoreExport UserResolver : public Resolver
67 /** User this class is 'attached' to.
73 UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
75 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
76 void OnError(ResolverError e, const std::string &errormessage);
80 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
82 class CoreExport ConnectClass : public classbase
85 /** Type of line, either CC_ALLOW or CC_DENY
88 /** Max time to register the connection in seconds
90 unsigned int registration_timeout;
91 /** Number of lines in buffer before excess flood is triggered
94 /** Host mask for this line
97 /** Number of seconds between pings for this line
99 unsigned int pingtime;
100 /** (Optional) Password for this line
104 /** Threshold value for flood disconnect
106 unsigned int threshold;
108 /** Maximum size of sendq for users in this class (bytes)
110 unsigned long sendqmax;
112 /** Maximum size of recvq for users in this class (bytes)
114 unsigned long recvqmax;
116 /** Local max when connecting by this connection class
118 unsigned long maxlocal;
120 /** Global max when connecting by this connection class
122 unsigned long maxglobal;
123 /** Port number this connect class applies to
129 /** Create a new connect class with no settings.
131 ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
132 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
134 /** Create a new connect class to ALLOW connections.
135 * @param timeout The registration timeout
136 * @param fld The flood value
137 * @param hst The IP mask to allow
138 * @param ping The ping frequency
139 * @param pas The password to be used
140 * @param thres The flooding threshold
141 * @param sendq The maximum sendq value
142 * @param recvq The maximum recvq value
143 * @param maxl The maximum local sessions
144 * @param maxg The maximum global sessions
146 ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
147 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
148 unsigned long maxl, unsigned long maxg, int p = 0) :
149 type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
150 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
152 /** Create a new connect class to DENY connections
153 * @param hst The IP mask to deny
155 ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
156 pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
158 /** Returns the type, CC_ALLOW or CC_DENY
162 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
165 /** Returns the registration timeout
167 unsigned int GetRegTimeout()
169 return (registration_timeout ? registration_timeout : 90);
172 /** Returns the flood limit
174 unsigned int GetFlood()
176 return (threshold ? flood : 999);
179 /** Returns the allowed or denied IP mask
181 const std::string& GetHost()
191 /** Returns the ping frequency
193 unsigned int GetPingTime()
195 return (pingtime ? pingtime : 120);
198 /** Returns the password or an empty string
200 const std::string& GetPass()
205 /** Returns the flood threshold value
207 unsigned int GetThreshold()
209 return (threshold ? threshold : 1);
212 /** Returns the maximum sendq value
214 unsigned long GetSendqMax()
216 return (sendqmax ? sendqmax : 262114);
219 /** Returns the maximum recvq value
221 unsigned long GetRecvqMax()
223 return (recvqmax ? recvqmax : 4096);
226 /** Returusn the maximum number of local sessions
228 unsigned long GetMaxLocal()
233 /** Returns the maximum number of global sessions
235 unsigned long GetMaxGlobal()
241 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
243 typedef std::vector<irc::string> InvitedList;
245 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
247 typedef std::vector<ConnectClass> ClassVector;
249 /** Typedef for the list of user-channel records for a user
251 typedef std::map<chanrec*, char> UserChanList;
252 typedef UserChanList::iterator UCListIter;
256 class CoreExport VisData
261 virtual bool VisibleTo(userrec* user);
264 /** Holds all information about a user
265 * This class stores all information about a user connected to the irc server. Everything about a
266 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
267 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
268 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
269 * file descriptor value.
271 class CoreExport userrec : public connection
274 /** Pointer to creator.
275 * This is required to make use of core functions
276 * from within the userrec class.
278 InspIRCd* ServerInstance;
280 /** A list of channels the user has a pending invite to.
281 * Upon INVITE channels are added, and upon JOIN, the
282 * channels are removed from this list.
286 /** Number of channels this user is currently on
288 unsigned int ChannelCount;
290 /** Cached nick!ident@host value using the real hostname
292 char* cached_fullhost;
294 /** Cached nick!ident@ip value using the real IP address
298 /** Cached nick!ident@host value using the masked hostname
300 char* cached_makehost;
301 char* cached_fullrealhost;
303 /** When we erase the user (in the destructor),
304 * we call this method to subtract one from all
305 * mode characters this user is making use of.
307 void DecrementModes();
312 /** Resolvers for looking up this users IP address
313 * This will occur if and when res_reverse completes.
314 * When this class completes its lookup, userrec::dns_done
315 * will be set from false to true.
317 UserResolver* res_forward;
319 /** Resolvers for looking up this users hostname
320 * This is instantiated by userrec::StartDNSLookup(),
321 * and on success, instantiates userrec::res_reverse.
323 UserResolver* res_reverse;
327 /** Stored reverse lookup from res_forward
329 std::string stored_host;
331 /** Starts a DNS lookup of the user's IP.
332 * This will cause two UserResolver classes to be instantiated.
333 * When complete, these objects set userrec::dns_done to true.
335 void StartDNSLookup();
337 /** The users nickname.
338 * An invalid nickname indicates an unregistered connection prior to the NICK command.
339 * Use InspIRCd::IsNick() to validate nicknames.
343 /** The users ident reply.
344 * Two characters are added to the user-defined limit to compensate for the tilde etc.
346 char ident[IDENTMAX+2];
348 /** The host displayed to non-opers (used for cloaking etc).
349 * This usually matches the value of userrec::host.
353 /** The users full name (GECOS).
355 char fullname[MAXGECOS+1];
357 /** The user's mode list.
358 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
359 * this is an array of values in a similar way to channel modes.
360 * A value of 1 in field (modeletter-65) indicates that the mode is
361 * set, for example, to work out if mode +s is set, we check the field
362 * userrec::modes['s'-65] != 0.
363 * The following RFC characters o, w, s, i have constants defined via an
364 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
368 /** What snomasks are set on this user.
369 * This functions the same as the above modes.
373 /** Channels this user is on, and the permissions they have there
377 /** The server the user is connected to.
381 /** The user's away message.
382 * If this string is empty, the user is not marked as away.
384 char awaymsg[MAXAWAY+1];
386 /** Number of lines the user can place into the buffer
387 * (up to the global NetBufferSize bytes) before they
388 * are disconnected for excess flood
392 /** Timestamp of current time + connection class timeout.
393 * This user must send USER/NICK before this timestamp is
394 * reached or they will be disconnected.
398 /** The oper type they logged in as, if they are an oper.
399 * This is used to check permissions in operclasses, so that
400 * we can say 'yay' or 'nay' to any commands they issue.
401 * The value of this is the value of a valid 'type name=' tag.
405 /** True when DNS lookups are completed.
406 * The UserResolver classes res_forward and res_reverse will
407 * set this value once they complete.
411 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
413 unsigned int pingmax;
415 /** Password specified by the user when they registered.
416 * This is stored even if the <connect> block doesnt need a password, so that
417 * modules may check it.
421 /** User's receive queue.
422 * Lines from the IRCd awaiting processing are stored here.
423 * Upgraded april 2005, old system a bit hairy.
427 /** User's send queue.
428 * Lines waiting to be sent are stored here until their buffer is flushed.
432 /** Flood counters - lines received
436 /** Flood counters - time lines_in is due to be reset
440 /** Flood counters - Highest value lines_in may reach before the user gets disconnected
444 /** If this is set to true, then all read operations for the user
445 * are dropped into the bit-bucket.
446 * This is used by the global CullList, but please note that setting this value
447 * alone will NOT cause the user to quit. This means it can be used seperately,
448 * for example by shun modules etc.
452 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
453 * GetIPString/GetPort to obtain its values.
457 /** Initialize the clients sockaddr
458 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
459 * @param ip A human-readable IP address for this user matching the protcol_family
460 * @param port The port number of this user or zero for a remote user
462 void SetSockAddr(int protocol_family, const char* ip, int port);
464 /** Get port number from sockaddr
465 * @return The port number of this user.
469 /** Get protocol family from sockaddr
470 * @return The protocol family of this user, either AF_INET or AF_INET6
472 int GetProtocolFamily();
474 /** Get IP string from sockaddr, using static internal buffer
475 * @return The IP string
477 const char* GetIPString();
479 /** Get IP string from sockaddr, using caller-specified buffer
480 * @param buf A buffer to use
481 * @return The IP string
483 const char* GetIPString(char* buf);
485 /* Write error string
487 std::string WriteError;
489 /** Maximum size this user's sendq can become.
490 * Copied from the connect class on connect.
494 /** Maximum size this user's recvq can become.
495 * Copied from the connect class on connect.
499 /** This is true if the user matched an exception when they connected to the ircd.
500 * It isnt valid after this point, and you should not attempt to do anything with it
501 * after this point, because the eline might be removed at a later time, and/or no
502 * longer be applicable to this user. It is only used to save doing the eline lookup
503 * twice (instead we do it once and set this value).
507 /** Default constructor
508 * @throw Nothing at present
510 userrec(InspIRCd* Instance);
512 /** Returns the full displayed host of the user
513 * This member function returns the hostname of the user as seen by other users
514 * on the server, in nick!ident&at;host form.
515 * @return The full masked host of the user
517 virtual char* GetFullHost();
519 /** Returns the full real host of the user
520 * This member function returns the hostname of the user as seen by other users
521 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
522 * e.g. through a module, then this method will ignore it and return the true hostname.
523 * @return The full real host of the user
525 virtual char* GetFullRealHost();
527 /** This clears any cached results that are used for GetFullRealHost() etc.
528 * The results of these calls are cached as generating them can be generally expensive.
530 void InvalidateCache();
532 /** Create a displayable mode string for this users snomasks
533 * @return The notice mask character sequence
535 const char* FormatNoticeMasks();
537 /** Process a snomask modifier string, e.g. +abc-de
538 * @param sm A sequence of notice mask characters
539 * @return The cleaned mode sequence which can be output,
540 * e.g. in the above example if masks c and e are not
541 * valid, this function will return +ab-d
543 std::string ProcessNoticeMasks(const char *sm);
545 /** Returns true if a notice mask is set
546 * @param sm A notice mask character to check
547 * @return True if the notice mask is set
549 bool IsNoticeMaskSet(unsigned char sm);
551 /** Changed a specific notice mask value
552 * @param sm The server notice mask to change
553 * @param value An on/off value for this mask
555 void SetNoticeMask(unsigned char sm, bool value);
557 /** Create a displayable mode string for this users umodes
558 * @param The mode string
560 const char* FormatModes();
562 /** Returns true if a specific mode is set
563 * @param m The user mode
564 * @return True if the mode is set
566 bool IsModeSet(unsigned char m);
568 /** Set a specific usermode to on or off
569 * @param m The user mode
570 * @param value On or off setting of the mode
572 void SetMode(unsigned char m, bool value);
574 /** Returns true if a user is invited to a channel.
575 * @param channel A channel name to look up
576 * @return True if the user is invited to the given channel
578 virtual bool IsInvited(const irc::string &channel);
580 /** Adds a channel to a users invite list (invites them to a channel)
581 * @param channel A channel name to add
583 virtual void InviteTo(const irc::string &channel);
585 /** Removes a channel from a users invite list.
586 * This member function is called on successfully joining an invite only channel
587 * to which the user has previously been invited, to clear the invitation.
588 * @param channel The channel to remove the invite to
590 virtual void RemoveInvite(const irc::string &channel);
592 /** Returns true or false for if a user can execute a privilaged oper command.
593 * This is done by looking up their oper type from userrec::oper, then referencing
594 * this to their oper classes and checking the commands they can execute.
595 * @param command A command (should be all CAPS)
596 * @return True if this user can execute the command
598 bool HasPermission(const std::string &command);
600 /** Calls read() to read some data for this user using their fd.
601 * @param buffer The buffer to read into
602 * @param size The size of data to read
603 * @return The number of bytes read, or -1 if an error occured.
605 int ReadData(void* buffer, size_t size);
607 /** This method adds data to the read buffer of the user.
608 * The buffer can grow to any size within limits of the available memory,
609 * managed by the size of a std::string, however if any individual line in
610 * the buffer grows over 600 bytes in length (which is 88 chars over the
611 * RFC-specified limit per line) then the method will return false and the
612 * text will not be inserted.
613 * @param a The string to add to the users read buffer
614 * @return True if the string was successfully added to the read buffer
616 bool AddBuffer(std::string a);
618 /** This method returns true if the buffer contains at least one carriage return
619 * character (e.g. one complete line may be read)
620 * @return True if there is at least one complete line in the users buffer
622 bool BufferIsReady();
624 /** This function clears the entire buffer by setting it to an empty string.
628 /** This method returns the first available string at the tail end of the buffer
629 * and advances the tail end of the buffer past the string. This means it is
630 * a one way operation in a similar way to strtok(), and multiple calls return
631 * multiple lines if they are available. The results of this function if there
632 * are no lines to be read are unknown, always use BufferIsReady() to check if
633 * it is ok to read the buffer before calling GetBuffer().
634 * @return The string at the tail end of this users buffer
636 std::string GetBuffer();
638 /** Sets the write error for a connection. This is done because the actual disconnect
639 * of a client may occur at an inopportune time such as half way through /LIST output.
640 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
641 * errored clients purged.
642 * @param error The error string to set.
644 void SetWriteError(const std::string &error);
646 /** Returns the write error which last occured on this connection or an empty string
648 * @return The error string which has occured for this user
650 const char* GetWriteError();
652 /** Adds to the user's write buffer.
653 * You may add any amount of text up to this users sendq value, if you exceed the
654 * sendq value, SetWriteError() will be called to set the users error string to
655 * "SendQ exceeded", 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
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
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 /** Disconnect a user gracefully
698 * @param user The user to remove
699 * @param r The quit reason to show to normal users
700 * @param oreason The quit reason to show to opers
701 * @return Although this function has no return type, on exit the user provided will no longer exist.
703 static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
705 /** Add the user to WHOWAS system
709 /** Oper up the user using the given opertype.
710 * This will also give the +o usermode.
711 * @param opertype The oper type to oper as
713 void Oper(const std::string &opertype);
715 /** Call this method to find the matching <connect> for a user, and to check them against it.
719 /** Use this method to fully connect a user.
720 * This will send the message of the day, check G/K/E lines, etc.
724 /** Change this users hash key to a new string.
725 * You should not call this function directly. It is used by the core
726 * to update the users hash entry on a nickchange.
727 * @param New new user_hash key
728 * @return Pointer to userrec in hash (usually 'this')
730 userrec* UpdateNickHash(const char* New);
732 /** Force a nickname change.
733 * If the nickname change fails (for example, because the nick in question
734 * already exists) this function will return false, and you must then either
735 * output an error message, or quit the user for nickname collision.
736 * @param newnick The nickname to change to
737 * @return True if the nickchange was successful.
739 bool ForceNickChange(const char* newnick);
741 /** Add a client to the system.
742 * This will create a new userrec, insert it into the user_hash,
743 * initialize it as not yet registered, and add it to the socket engine.
744 * @param Instance a pointer to the server instance
745 * @param socket The socket id (file descriptor) this user is on
746 * @param port The port number this user connected on
747 * @param iscached This variable is reserved for future use
748 * @param ip The IP address of the user
749 * @return This function has no return value, but a call to AddClient may remove the user.
751 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
754 * This will clear the +o usermode and unset the user's oper type
758 /** Return the number of global clones of this user
759 * @return The global clone count of this user
761 unsigned long GlobalCloneCount();
763 /** Return the number of local clones of this user
764 * @return The local clone count of this user
766 unsigned long LocalCloneCount();
768 /** Write text to this user, appending CR/LF.
769 * @param text A std::string to send to the user
771 void Write(std::string text);
773 /** Write text to this user, appending CR/LF.
774 * @param text The format string for text to send to the user
775 * @param ... POD-type format arguments
777 void Write(const char *text, ...);
779 /** Write text to this user, appending CR/LF and prepending :server.name
780 * @param text A std::string to send to the user
782 void WriteServ(const std::string& text);
784 /** Write text to this user, appending CR/LF and prepending :server.name
785 * @param text The format string for text to send to the user
786 * @param ... POD-type format arguments
788 void WriteServ(const char* 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(userrec *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(userrec *user, const char* text, ...);
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(userrec *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(userrec *dest, const char *data, ...);
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, ...);
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, ...);
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 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
840 /** Write a WALLOPS message from this user to all local opers.
841 * If this user is not opered, the function will return without doing anything.
842 * @param text The format string to send in the WALLOPS message
843 * @param ... Format arguments
845 void WriteWallOps(const char* text, ...);
847 /** Write a WALLOPS message from this user to all local opers.
848 * If this user is not opered, the function will return without doing anything.
849 * @param text The text to send in the WALLOPS message
851 void WriteWallOps(const std::string &text);
853 /** Return true if the user shares at least one channel with another user
854 * @param other The other user to compare the channel list against
855 * @return True if the given user shares at least one channel with this user
857 bool SharesChannelWith(userrec *other);
859 /** Change the displayed host of a user.
860 * ALWAYS use this function, rather than writing userrec::dhost directly,
861 * as this triggers module events allowing the change to be syncronized to
862 * remote servers. This will also emulate a QUIT and rejoin (where configured)
863 * before setting their host field.
864 * @param host The new hostname to set
865 * @return True if the change succeeded, false if it didn't
867 bool ChangeDisplayedHost(const char* host);
869 /** Change the ident (username) of a user.
870 * ALWAYS use this function, rather than writing userrec::ident directly,
871 * as this correctly causes the user to seem to quit (where configured)
872 * before setting their ident field.
873 * @param host The new ident to set
874 * @return True if the change succeeded, false if it didn't
876 bool ChangeIdent(const char* newident);
878 /** Change a users realname field.
879 * ALWAYS use this function, rather than writing userrec::fullname directly,
880 * as this triggers module events allowing the change to be syncronized to
882 * @param gecos The user's new realname
883 * @return True if the change succeeded, false if otherwise
885 bool ChangeName(const char* gecos);
887 /** Send a command to all local users from this user
888 * The command given must be able to send text with the
889 * first parameter as a servermask (e.g. $*), so basically
890 * you should use PRIVMSG or NOTICE.
891 * @param command the command to send
892 * @param text The text format string to send
893 * @param ... Format arguments
895 void SendAll(const char* command, char* text, ...);
897 /** Compile a channel list for this user, and send it to the user 'source'
898 * Used internally by WHOIS
899 * @param The user to send the channel list to if it is not too long
900 * @return This user's channel list
902 std::string ChannelList(userrec* source);
904 /** Split the channel list in cl which came from dest, and spool it to this user
905 * Used internally by WHOIS
906 * @param dest The user the original channel list came from
907 * @param cl The channel list as a string obtained from userrec::ChannelList()
909 void SplitChanList(userrec* dest, const std::string &cl);
911 /** Remove this user from all channels they are on, and delete any that are now empty.
912 * This is used by QUIT, and will not send part messages!
914 void PurgeEmptyChannels();
916 /** Get the connect class which matches this user's host or IP address
917 * @return A reference to this user's connect class
919 ConnectClass* GetClass();
921 /** Show the message of the day to this user
925 /** Show the server RULES file to this user
929 /** Set oper-specific quit message shown to opers only when the user quits
930 * (overrides any sent by QuitUser)
932 void SetOperQuit(const std::string &oquit);
934 const char* GetOperQuit();
936 /** Handle socket event.
937 * From EventHandler class.
938 * @param et Event type
939 * @param errornum Error number for EVENT_ERROR events
941 void HandleEvent(EventType et, int errornum = 0);
943 /** Default destructor
948 /* Configuration callbacks */