1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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"
26 /** Channel status for a user
39 /** connect class types
48 /** RFC1459 channel modes
51 /** +s: Server notices */
52 UM_SERVERNOTICE = 's' - 65,
54 UM_WALLOPS = 'w' - 65,
56 UM_INVISIBLE = 'i' - 65,
58 UM_OPERATOR = 'o' - 65,
59 /** +n: Server notice mask */
63 /** Registration state of a user, e.g.
64 * have they sent USER, NICK, PASS yet?
66 enum RegistrationState {
68 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
69 REG_NONE = 0, /* Has sent nothing */
72 REG_USER = 1, /* Has sent USER */
73 REG_NICK = 2, /* Has sent NICK */
74 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
75 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
78 /* Required forward declaration */
81 /** Derived from Resolver, and performs user forward/reverse lookups.
83 class CoreExport UserResolver : public Resolver
86 /** User this class is 'attached' to.
89 /** File descriptor teh lookup is bound to
92 /** True if the lookup is forward, false if is a reverse lookup
96 /** Create a resolver.
97 * @param Instance The creating instance
98 * @param user The user to begin lookup on
99 * @param to_resolve The IP or host to resolve
100 * @param qt The query type
101 * @param cache Modified by the constructor if the result was cached
103 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
105 /** Called on successful lookup
106 * @param result Result string
107 * @param ttl Time to live for result
108 * @param cached True if the result was found in the cache
109 * @param resultnum Result number, we are only interested in result 0
111 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
113 /** Called on failed lookup
114 * @param e Error code
115 * @param errormessage Error message string
117 void OnError(ResolverError e, const std::string &errormessage);
121 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
123 class CoreExport ConnectClass : public classbase
126 /** Type of line, either CC_ALLOW or CC_DENY
129 /** Connect class name
132 /** Max time to register the connection in seconds
134 unsigned int registration_timeout;
135 /** Number of lines in buffer before excess flood is triggered
138 /** Host mask for this line
141 /** Number of seconds between pings for this line
143 unsigned int pingtime;
144 /** (Optional) Password for this line
148 /** (Optional) Hash Method for this line
152 /** Threshold value for flood disconnect
154 unsigned int threshold;
156 /** Maximum size of sendq for users in this class (bytes)
158 unsigned long sendqmax;
160 /** Maximum size of recvq for users in this class (bytes)
162 unsigned long recvqmax;
164 /** Local max when connecting by this connection class
166 unsigned long maxlocal;
168 /** Global max when connecting by this connection class
170 unsigned long maxglobal;
172 /** Max channels for this class
174 unsigned int maxchans;
176 /** Port number this connect class applies to
182 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
184 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
185 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
186 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
187 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
188 port(source->port), RefCount(0), disabled(false), limit(0)
192 /** Create a new connect class with no settings.
194 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
195 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
199 /** Create a new connect class to ALLOW connections.
200 * @param thename Name of the connect class
201 * @param timeout The registration timeout
202 * @param fld The flood value
203 * @param hst The IP mask to allow
204 * @param ping The ping frequency
205 * @param pas The password to be used
206 * @param hsh The hash to be used
207 * @param thres The flooding threshold
208 * @param sendq The maximum sendq value
209 * @param recvq The maximum recvq value
210 * @param maxl The maximum local sessions
211 * @param maxg The maximum global sessions
213 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
214 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
215 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
216 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
217 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
219 /** Create a new connect class to DENY connections
220 * @param thename Name of the connect class
221 * @param hst The IP mask to deny
223 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
224 flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
228 /* Create a new connect class based on another class
229 * @param thename The name of the connect class
230 * @param source Another connect class to inherit all but the name from
232 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
233 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
234 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
235 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
236 port(source->port), RefCount(0), disabled(false), limit(0)
240 void SetDisabled(bool t)
247 return this->disabled;
250 /* Update an existing entry with new values
252 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
253 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
254 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
257 registration_timeout = timeout;
284 /** Reference counter. Contains an int as to how many users are connected to this class. :)
285 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
286 * are 0 users on it - it will go away in RAM. :)
288 unsigned long RefCount;
290 /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written
294 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
303 /** Returns the type, CC_ALLOW or CC_DENY
307 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
310 std::string& GetName()
315 /** Returns the registration timeout
317 unsigned int GetRegTimeout()
319 return (registration_timeout ? registration_timeout : 90);
322 /** Returns the flood limit
324 unsigned int GetFlood()
326 return (threshold ? flood : 999);
329 /** Returns the allowed or denied IP mask
331 const std::string& GetHost()
350 /** Returns the ping frequency
352 unsigned int GetPingTime()
354 return (pingtime ? pingtime : 120);
357 /** Returns the password or an empty string
359 const std::string& GetPass()
364 /** Returns the hash or an empty string
366 const std::string& GetHash()
371 /** Returns the flood threshold value
373 unsigned int GetThreshold()
375 return (threshold ? threshold : 1);
378 /** Returns the maximum sendq value
380 unsigned long GetSendqMax()
382 return (sendqmax ? sendqmax : 262114);
385 /** Returns the maximum recvq value
387 unsigned long GetRecvqMax()
389 return (recvqmax ? recvqmax : 4096);
392 /** Returusn the maximum number of local sessions
394 unsigned long GetMaxLocal()
399 /** Returns the maximum number of global sessions
401 unsigned long GetMaxGlobal()
407 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
409 typedef std::vector<irc::string> InvitedList;
411 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
413 typedef std::vector<ConnectClass*> ClassVector;
415 /** Typedef for the list of user-channel records for a user
417 typedef std::map<Channel*, char> UserChanList;
419 /** Shorthand for an iterator into a UserChanList
421 typedef UserChanList::iterator UCListIter;
423 /* Required forward declaration
427 /** Visibility data for a user.
428 * If a user has a non-null instance of this class in their User,
429 * then it is used to determine if this user is visible to other users
432 class CoreExport VisData
438 /** Destroy a visdata
441 /** Is this user visible to some other user?
442 * @param user The other user to compare to
443 * @return true True if the user is visible to the other user, false if not
445 virtual bool VisibleTo(User* user);
448 /** Holds all information about a user
449 * This class stores all information about a user connected to the irc server. Everything about a
450 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
451 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
452 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
453 * file descriptor value.
455 class CoreExport User : public connection
458 /** Pointer to creator.
459 * This is required to make use of core functions
460 * from within the User class.
462 InspIRCd* ServerInstance;
464 /** A list of channels the user has a pending invite to.
465 * Upon INVITE channels are added, and upon JOIN, the
466 * channels are removed from this list.
470 /** Number of channels this user is currently on
472 unsigned int ChannelCount;
474 /** Cached nick!ident@host value using the real hostname
476 char* cached_fullhost;
478 /** Cached nick!ident@ip value using the real IP address
482 /** Cached nick!ident@host value using the masked hostname
484 char* cached_makehost;
486 /** Cached nick!ident@realhost value using the real hostname
488 char* cached_fullrealhost;
490 /** When we erase the user (in the destructor),
491 * we call this method to subtract one from all
492 * mode characters this user is making use of.
494 void DecrementModes();
496 /** Max channels for this user
498 unsigned int MaxChans;
500 std::map<std::string, bool>* AllowedOperCommands;
503 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
504 * The pointer is guarenteed to *always* be valid. :)
506 ConnectClass *MyClass;
508 /** Resolvers for looking up this users IP address
509 * This will occur if and when res_reverse completes.
510 * When this class completes its lookup, User::dns_done
511 * will be set from false to true.
513 UserResolver* res_forward;
515 /** Resolvers for looking up this users hostname
516 * This is instantiated by User::StartDNSLookup(),
517 * and on success, instantiates User::res_reverse.
519 UserResolver* res_reverse;
521 /** User visibility state, see definition of VisData.
525 /** Stored reverse lookup from res_forward
527 std::string stored_host;
529 /** Starts a DNS lookup of the user's IP.
530 * This will cause two UserResolver classes to be instantiated.
531 * When complete, these objects set User::dns_done to true.
533 void StartDNSLookup();
535 unsigned int GetMaxChans();
537 /** The users nickname.
538 * An invalid nickname indicates an unregistered connection prior to the NICK command.
539 * Use InspIRCd::IsNick() to validate nicknames.
543 /** The user's unique identifier.
544 * This is the unique identifier which the user has across the network.
546 char uuid[UUID_LENGTH];
548 /** The users ident reply.
549 * Two characters are added to the user-defined limit to compensate for the tilde etc.
551 char ident[IDENTMAX+2];
553 /** The host displayed to non-opers (used for cloaking etc).
554 * This usually matches the value of User::host.
558 /** The users full name (GECOS).
560 char fullname[MAXGECOS+1];
562 /** The user's mode list.
563 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
564 * this is an array of values in a similar way to channel modes.
565 * A value of 1 in field (modeletter-65) indicates that the mode is
566 * set, for example, to work out if mode +s is set, we check the field
567 * User::modes['s'-65] != 0.
568 * The following RFC characters o, w, s, i have constants defined via an
569 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
573 /** What snomasks are set on this user.
574 * This functions the same as the above modes.
578 /** Channels this user is on, and the permissions they have there
582 /** The server the user is connected to.
586 /** The user's away message.
587 * If this string is empty, the user is not marked as away.
589 char awaymsg[MAXAWAY+1];
591 /** Timestamp of current time + connection class timeout.
592 * This user must send USER/NICK before this timestamp is
593 * reached or they will be disconnected.
597 /** The oper type they logged in as, if they are an oper.
598 * This is used to check permissions in operclasses, so that
599 * we can say 'yay' or 'nay' to any commands they issue.
600 * The value of this is the value of a valid 'type name=' tag.
604 /** True when DNS lookups are completed.
605 * The UserResolver classes res_forward and res_reverse will
606 * set this value once they complete.
610 /** Password specified by the user when they registered.
611 * This is stored even if the <connect> block doesnt need a password, so that
612 * modules may check it.
616 /** User's receive queue.
617 * Lines from the IRCd awaiting processing are stored here.
618 * Upgraded april 2005, old system a bit hairy.
622 /** User's send queue.
623 * Lines waiting to be sent are stored here until their buffer is flushed.
627 /** Message user will quit with. Not to be set externally.
631 /** Quit message shown to opers - not to be set externally.
633 std::string operquitmsg;
635 /** Whether or not to send an snotice about this user's quitting
639 /** Flood counters - lines received
641 unsigned int lines_in;
643 /** Flood counters - time lines_in is due to be reset
647 /** If this is set to true, then all socket operations for the user
648 * are dropped into the bit-bucket.
649 * This value is set by QuitUser, and is not needed seperately from that call.
650 * Please note that setting this value alone will NOT cause the user to quit.
654 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
655 * GetIPString/GetPort to obtain its values.
659 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
661 std::string cachedip;
663 /** Initialize the clients sockaddr
664 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
665 * @param ip A human-readable IP address for this user matching the protcol_family
666 * @param port The port number of this user or zero for a remote user
668 void SetSockAddr(int protocol_family, const char* ip, int port);
670 /** Get port number from sockaddr
671 * @return The port number of this user.
675 /** Get protocol family from sockaddr
676 * @return The protocol family of this user, either AF_INET or AF_INET6
678 int GetProtocolFamily();
680 /** Get IP string from sockaddr, using static internal buffer
681 * @return The IP string
683 const char* GetIPString();
685 /* Write error string
687 std::string WriteError;
689 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
693 /** This value contains how far into the penalty threshold the user is. Once its over
694 * the penalty threshold then commands are held and processed on-timer.
698 /** True if we are flushing penalty lines
702 /** If this bool is set then penalty rules do not apply to this user
704 bool ExemptFromPenalty;
706 /** Default constructor
707 * @throw CoreException if the UID allocated to the user already exists
708 * @param Instance Creator instance
709 * @param uid User UUID, or empty to allocate one automatically
711 User(InspIRCd* Instance, const std::string &uid = "");
713 /** Returns the full displayed host of the user
714 * This member function returns the hostname of the user as seen by other users
715 * on the server, in nick!ident&at;host form.
716 * @return The full masked host of the user
718 virtual char* GetFullHost();
720 /** Returns the full real host of the user
721 * This member function returns the hostname of the user as seen by other users
722 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
723 * e.g. through a module, then this method will ignore it and return the true hostname.
724 * @return The full real host of the user
726 virtual char* GetFullRealHost();
728 /** This clears any cached results that are used for GetFullRealHost() etc.
729 * The results of these calls are cached as generating them can be generally expensive.
731 void InvalidateCache();
733 /** Create a displayable mode string for this users snomasks
734 * @return The notice mask character sequence
736 const char* FormatNoticeMasks();
738 /** Process a snomask modifier string, e.g. +abc-de
739 * @param sm A sequence of notice mask characters
740 * @return The cleaned mode sequence which can be output,
741 * e.g. in the above example if masks c and e are not
742 * valid, this function will return +ab-d
744 std::string ProcessNoticeMasks(const char *sm);
746 /** Returns true if a notice mask is set
747 * @param sm A notice mask character to check
748 * @return True if the notice mask is set
750 bool IsNoticeMaskSet(unsigned char sm);
752 /** Changed a specific notice mask value
753 * @param sm The server notice mask to change
754 * @param value An on/off value for this mask
756 void SetNoticeMask(unsigned char sm, bool value);
758 /** Create a displayable mode string for this users umodes
759 * @param The mode string
761 const char* FormatModes();
763 /** Returns true if a specific mode is set
764 * @param m The user mode
765 * @return True if the mode is set
767 bool IsModeSet(unsigned char m);
769 /** Set a specific usermode to on or off
770 * @param m The user mode
771 * @param value On or off setting of the mode
773 void SetMode(unsigned char m, bool value);
775 /** Returns true if a user is invited to a channel.
776 * @param channel A channel name to look up
777 * @return True if the user is invited to the given channel
779 virtual bool IsInvited(const irc::string &channel);
781 /** Adds a channel to a users invite list (invites them to a channel)
782 * @param channel A channel name to add
784 virtual void InviteTo(const irc::string &channel);
786 /** Removes a channel from a users invite list.
787 * This member function is called on successfully joining an invite only channel
788 * to which the user has previously been invited, to clear the invitation.
789 * @param channel The channel to remove the invite to
791 virtual void RemoveInvite(const irc::string &channel);
793 /** Returns true or false for if a user can execute a privilaged oper command.
794 * This is done by looking up their oper type from User::oper, then referencing
795 * this to their oper classes and checking the commands they can execute.
796 * @param command A command (should be all CAPS)
797 * @return True if this user can execute the command
799 bool HasPermission(const std::string &command);
801 /** Calls read() to read some data for this user using their fd.
802 * @param buffer The buffer to read into
803 * @param size The size of data to read
804 * @return The number of bytes read, or -1 if an error occured.
806 int ReadData(void* buffer, size_t size);
808 /** This method adds data to the read buffer of the user.
809 * The buffer can grow to any size within limits of the available memory,
810 * managed by the size of a std::string, however if any individual line in
811 * the buffer grows over 600 bytes in length (which is 88 chars over the
812 * RFC-specified limit per line) then the method will return false and the
813 * text will not be inserted.
814 * @param a The string to add to the users read buffer
815 * @return True if the string was successfully added to the read buffer
817 bool AddBuffer(std::string a);
819 /** This method returns true if the buffer contains at least one carriage return
820 * character (e.g. one complete line may be read)
821 * @return True if there is at least one complete line in the users buffer
823 bool BufferIsReady();
825 /** This function clears the entire buffer by setting it to an empty string.
829 /** This method returns the first available string at the tail end of the buffer
830 * and advances the tail end of the buffer past the string. This means it is
831 * a one way operation in a similar way to strtok(), and multiple calls return
832 * multiple lines if they are available. The results of this function if there
833 * are no lines to be read are unknown, always use BufferIsReady() to check if
834 * it is ok to read the buffer before calling GetBuffer().
835 * @return The string at the tail end of this users buffer
837 std::string GetBuffer();
839 /** Sets the write error for a connection. This is done because the actual disconnect
840 * of a client may occur at an inopportune time such as half way through /LIST output.
841 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
842 * errored clients purged.
843 * @param error The error string to set.
845 void SetWriteError(const std::string &error);
847 /** Returns the write error which last occured on this connection or an empty string
849 * @return The error string which has occured for this user
851 const char* GetWriteError();
853 /** Adds to the user's write buffer.
854 * You may add any amount of text up to this users sendq value, if you exceed the
855 * sendq value, SetWriteError() will be called to set the users error string to
856 * "SendQ exceeded", and further buffer adds will be dropped.
857 * @param data The data to add to the write buffer
859 void AddWriteBuf(const std::string &data);
861 /** Flushes as much of the user's buffer to the file descriptor as possible.
862 * This function may not always flush the entire buffer, rather instead as much of it
863 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
864 * position is advanced forwards and the rest of the data sent at the next call to
867 void FlushWriteBuf();
869 /** Returns the list of channels this user has been invited to but has not yet joined.
870 * @return A list of channels the user is invited to
872 InvitedList* GetInviteList();
874 /** Creates a wildcard host.
875 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
876 * @return The wildcarded hostname in *!*@host form
878 char* MakeWildHost();
880 /** Creates a usermask with real host.
881 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
882 * @return the usermask in the format user@host
886 /** Creates a usermask with real ip.
887 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
888 * @return the usermask in the format user@ip
892 /** Shuts down and closes the user's socket
893 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
894 * which will call CloseSocket() for you.
898 /** Disconnect a user gracefully
899 * @param user The user to remove
900 * @param r The quit reason to show to normal users
901 * @param oreason The quit reason to show to opers
902 * @return Although this function has no return type, on exit the user provided will no longer exist.
904 static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
906 /** Add the user to WHOWAS system
910 /** Oper up the user using the given opertype.
911 * This will also give the +o usermode.
912 * @param opertype The oper type to oper as
914 void Oper(const std::string &opertype, const std::string &opername);
916 /** Call this method to find the matching <connect> for a user, and to check them against it.
920 /** Use this method to fully connect a user.
921 * This will send the message of the day, check G/K/E lines, etc.
925 /** Change this users hash key to a new string.
926 * You should not call this function directly. It is used by the core
927 * to update the users hash entry on a nickchange.
928 * @param New new user_hash key
929 * @return Pointer to User in hash (usually 'this')
931 User* UpdateNickHash(const char* New);
933 /** Force a nickname change.
934 * If the nickname change fails (for example, because the nick in question
935 * already exists) this function will return false, and you must then either
936 * output an error message, or quit the user for nickname collision.
937 * @param newnick The nickname to change to
938 * @return True if the nickchange was successful.
940 bool ForceNickChange(const char* newnick);
943 * This will clear the +o usermode and unset the user's oper type
947 /** Write text to this user, appending CR/LF.
948 * @param text A std::string to send to the user
950 void Write(std::string text);
952 /** Write text to this user, appending CR/LF.
953 * @param text The format string for text to send to the user
954 * @param ... POD-type format arguments
956 void Write(const char *text, ...);
958 /** Write text to this user, appending CR/LF and prepending :server.name
959 * @param text A std::string to send to the user
961 void WriteServ(const std::string& text);
963 /** Write text to this user, appending CR/LF and prepending :server.name
964 * @param text The format string for text to send to the user
965 * @param ... POD-type format arguments
967 void WriteServ(const char* text, ...);
969 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
970 * @param user The user to prepend the :nick!user@host of
971 * @param text A std::string to send to the user
973 void WriteFrom(User *user, const std::string &text);
975 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
976 * @param user The user to prepend the :nick!user@host of
977 * @param text The format string for text to send to the user
978 * @param ... POD-type format arguments
980 void WriteFrom(User *user, const char* text, ...);
982 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
983 * @param dest The user to route the message to
984 * @param text A std::string to send to the user
986 void WriteTo(User *dest, const std::string &data);
988 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
989 * @param dest The user to route the message to
990 * @param text The format string for text to send to the user
991 * @param ... POD-type format arguments
993 void WriteTo(User *dest, const char *data, ...);
995 /** Write to all users that can see this user (including this user in the list), appending CR/LF
996 * @param text A std::string to send to the users
998 void WriteCommon(const std::string &text);
1000 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1001 * @param text The format string for text to send to the users
1002 * @param ... POD-type format arguments
1004 void WriteCommon(const char* text, ...);
1006 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1007 * @param text The format string for text to send to the users
1008 * @param ... POD-type format arguments
1010 void WriteCommonExcept(const char* text, ...);
1012 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1013 * @param text A std::string to send to the users
1015 void WriteCommonExcept(const std::string &text);
1017 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1018 * quit message for opers only.
1019 * @param normal_text Normal user quit message
1020 * @param oper_text Oper only quit message
1022 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1024 /** Write a WALLOPS message from this user to all local opers.
1025 * If this user is not opered, the function will return without doing anything.
1026 * @param text The format string to send in the WALLOPS message
1027 * @param ... Format arguments
1029 void WriteWallOps(const char* text, ...);
1031 /** Write a WALLOPS message from this user to all local opers.
1032 * If this user is not opered, the function will return without doing anything.
1033 * @param text The text to send in the WALLOPS message
1035 void WriteWallOps(const std::string &text);
1037 /** Return true if the user shares at least one channel with another user
1038 * @param other The other user to compare the channel list against
1039 * @return True if the given user shares at least one channel with this user
1041 bool SharesChannelWith(User *other);
1043 /** Change the displayed host of a user.
1044 * ALWAYS use this function, rather than writing User::dhost directly,
1045 * as this triggers module events allowing the change to be syncronized to
1046 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1047 * before setting their host field.
1048 * @param host The new hostname to set
1049 * @return True if the change succeeded, false if it didn't
1051 bool ChangeDisplayedHost(const char* host);
1053 /** Change the ident (username) of a user.
1054 * ALWAYS use this function, rather than writing User::ident directly,
1055 * as this correctly causes the user to seem to quit (where configured)
1056 * before setting their ident field.
1057 * @param host The new ident to set
1058 * @return True if the change succeeded, false if it didn't
1060 bool ChangeIdent(const char* newident);
1062 /** Change a users realname field.
1063 * ALWAYS use this function, rather than writing User::fullname directly,
1064 * as this triggers module events allowing the change to be syncronized to
1066 * @param gecos The user's new realname
1067 * @return True if the change succeeded, false if otherwise
1069 bool ChangeName(const char* gecos);
1071 /** Send a command to all local users from this user
1072 * The command given must be able to send text with the
1073 * first parameter as a servermask (e.g. $*), so basically
1074 * you should use PRIVMSG or NOTICE.
1075 * @param command the command to send
1076 * @param text The text format string to send
1077 * @param ... Format arguments
1079 void SendAll(const char* command, char* text, ...);
1081 /** Compile a channel list for this user, and send it to the user 'source'
1082 * Used internally by WHOIS
1083 * @param The user to send the channel list to if it is not too long
1084 * @return This user's channel list
1086 std::string ChannelList(User* source);
1088 /** Split the channel list in cl which came from dest, and spool it to this user
1089 * Used internally by WHOIS
1090 * @param dest The user the original channel list came from
1091 * @param cl The channel list as a string obtained from User::ChannelList()
1093 void SplitChanList(User* dest, const std::string &cl);
1095 /** Remove this user from all channels they are on, and delete any that are now empty.
1096 * This is used by QUIT, and will not send part messages!
1098 void PurgeEmptyChannels();
1100 /** Get the connect class which this user belongs to.
1101 * @return A pointer to this user's connect class
1103 ConnectClass *GetClass();
1105 /** Set the connect class to which this user belongs to.
1106 * @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.
1107 * @return A reference to this user's current connect class.
1109 ConnectClass *SetClass(const std::string &explicit_name = "");
1111 /** Show the message of the day to this user
1115 /** Show the server RULES file to this user
1119 /** Set oper-specific quit message shown to opers only when the user quits
1120 * (overrides any sent by QuitUser)
1122 void SetOperQuit(const std::string &oquit);
1124 /** Get oper-specific quit message shown only to opers when the user quits.
1125 * (overrides any sent by QuitUser)
1127 const char* GetOperQuit();
1129 /** Increases a user's command penalty by a set amount.
1131 void IncreasePenalty(int increase);
1133 /** Decreases a user's command penalty by a set amount.
1135 void DecreasePenalty(int decrease);
1137 /** Handle socket event.
1138 * From EventHandler class.
1139 * @param et Event type
1140 * @param errornum Error number for EVENT_ERROR events
1142 void HandleEvent(EventType et, int errornum = 0);
1144 /** Default destructor
1149 /* Configuration callbacks */