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"
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 /** Threshold value for flood disconnect
150 unsigned int threshold;
152 /** Maximum size of sendq for users in this class (bytes)
154 unsigned long sendqmax;
156 /** Maximum size of recvq for users in this class (bytes)
158 unsigned long recvqmax;
160 /** Local max when connecting by this connection class
162 unsigned long maxlocal;
164 /** Global max when connecting by this connection class
166 unsigned long maxglobal;
168 /** Max channels for this class
170 unsigned int maxchans;
172 /** Port number this connect class applies to
178 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
180 ConnectClass(const ConnectClass& source) : classbase(), type(source.type), name(source.name),
181 registration_timeout(source.registration_timeout), flood(source.flood), host(source.host),
182 pingtime(source.pingtime), pass(source.pass), threshold(source.threshold), sendqmax(source.sendqmax),
183 recvqmax(source.recvqmax), maxlocal(source.maxlocal), maxglobal(source.maxglobal), maxchans(source.maxchans),
189 /** Create a new connect class with no settings.
191 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
192 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0)
197 /** Create a new connect class to ALLOW connections.
198 * @param thename Name of the connect class
199 * @param timeout The registration timeout
200 * @param fld The flood value
201 * @param hst The IP mask to allow
202 * @param ping The ping frequency
203 * @param pas The password to be used
204 * @param thres The flooding threshold
205 * @param sendq The maximum sendq value
206 * @param recvq The maximum recvq value
207 * @param maxl The maximum local sessions
208 * @param maxg The maximum global sessions
210 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
211 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
212 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
213 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
214 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p) { }
216 /** Create a new connect class to DENY connections
217 * @param thename Name of the connect class
218 * @param hst The IP mask to deny
220 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
221 flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0)
226 /* Create a new connect class based on another class
227 * @param thename The name of the connect class
228 * @param source Another connect class to inherit all but the name from
230 ConnectClass(const std::string &thename, const ConnectClass &source) : type(source.type), name(thename),
231 registration_timeout(source.registration_timeout), flood(source.flood), host(source.host),
232 pingtime(source.pingtime), pass(source.pass), threshold(source.threshold), sendqmax(source.sendqmax),
233 recvqmax(source.recvqmax), maxlocal(source.maxlocal), maxglobal(source.maxglobal), maxchans(source.maxchans),
239 /* Update an existing entry with new values
241 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
242 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
243 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p)
246 registration_timeout = timeout;
271 /** Reference counter. Contains an int as to how many users are connected to this class. :)
272 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
273 * are 0 users on it - it will go away in RAM. :)
275 unsigned long RefCount;
282 /** Returns the type, CC_ALLOW or CC_DENY
286 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
289 std::string& GetName()
294 /** Returns the registration timeout
296 unsigned int GetRegTimeout()
298 return (registration_timeout ? registration_timeout : 90);
301 /** Returns the flood limit
303 unsigned int GetFlood()
305 return (threshold ? flood : 999);
308 /** Returns the allowed or denied IP mask
310 const std::string& GetHost()
329 /** Returns the ping frequency
331 unsigned int GetPingTime()
333 return (pingtime ? pingtime : 120);
336 /** Returns the password or an empty string
338 const std::string& GetPass()
343 /** Returns the flood threshold value
345 unsigned int GetThreshold()
347 return (threshold ? threshold : 1);
350 /** Returns the maximum sendq value
352 unsigned long GetSendqMax()
354 return (sendqmax ? sendqmax : 262114);
357 /** Returns the maximum recvq value
359 unsigned long GetRecvqMax()
361 return (recvqmax ? recvqmax : 4096);
364 /** Returusn the maximum number of local sessions
366 unsigned long GetMaxLocal()
371 /** Returns the maximum number of global sessions
373 unsigned long GetMaxGlobal()
378 bool operator== (ConnectClass &other)
380 return (other.GetName() == name);
383 void operator=(const ConnectClass & other)
387 registration_timeout = other.registration_timeout;
390 pingtime = other.pingtime;
392 threshold = other.threshold;
393 sendqmax = other.sendqmax;
394 recvqmax = other.recvqmax;
395 maxlocal = other.maxlocal;
396 maxglobal = other.maxglobal;
397 maxchans = other.maxchans;
402 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
404 typedef std::vector<irc::string> InvitedList;
406 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
408 typedef std::vector<ConnectClass> ClassVector;
410 /** Typedef for the list of user-channel records for a user
412 typedef std::map<Channel*, char> UserChanList;
414 /** Shorthand for an iterator into a UserChanList
416 typedef UserChanList::iterator UCListIter;
418 /* Required forward declaration
422 /** Visibility data for a user.
423 * If a user has a non-null instance of this class in their User,
424 * then it is used to determine if this user is visible to other users
427 class CoreExport VisData
433 /** Destroy a visdata
436 /** Is this user visible to some other user?
437 * @param user The other user to compare to
438 * @return true True if the user is visible to the other user, false if not
440 virtual bool VisibleTo(User* user);
443 /** Holds all information about a user
444 * This class stores all information about a user connected to the irc server. Everything about a
445 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
446 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
447 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
448 * file descriptor value.
450 class CoreExport User : public connection
453 /** Pointer to creator.
454 * This is required to make use of core functions
455 * from within the User class.
457 InspIRCd* ServerInstance;
459 /** A list of channels the user has a pending invite to.
460 * Upon INVITE channels are added, and upon JOIN, the
461 * channels are removed from this list.
465 /** Number of channels this user is currently on
467 unsigned int ChannelCount;
469 /** Cached nick!ident@host value using the real hostname
471 char* cached_fullhost;
473 /** Cached nick!ident@ip value using the real IP address
477 /** Cached nick!ident@host value using the masked hostname
479 char* cached_makehost;
481 /** Cached nick!ident@realhost value using the real hostname
483 char* cached_fullrealhost;
485 /** When we erase the user (in the destructor),
486 * we call this method to subtract one from all
487 * mode characters this user is making use of.
489 void DecrementModes();
491 /** Oper-only quit message for this user if non-null
495 /** Max channels for this user
497 unsigned int MaxChans;
500 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
501 * The pointer is guarenteed to *always* be valid. :)
503 ConnectClass *MyClass;
505 /** Resolvers for looking up this users IP address
506 * This will occur if and when res_reverse completes.
507 * When this class completes its lookup, User::dns_done
508 * will be set from false to true.
510 UserResolver* res_forward;
512 /** Resolvers for looking up this users hostname
513 * This is instantiated by User::StartDNSLookup(),
514 * and on success, instantiates User::res_reverse.
516 UserResolver* res_reverse;
518 /** User visibility state, see definition of VisData.
522 /** Stored reverse lookup from res_forward
524 std::string stored_host;
526 /** Starts a DNS lookup of the user's IP.
527 * This will cause two UserResolver classes to be instantiated.
528 * When complete, these objects set User::dns_done to true.
530 void StartDNSLookup();
532 unsigned int GetMaxChans();
534 /** The users nickname.
535 * An invalid nickname indicates an unregistered connection prior to the NICK command.
536 * Use InspIRCd::IsNick() to validate nicknames.
540 /** The user's unique identifier.
541 * This is the unique identifier which the user has across the network.
543 char uuid[UUID_LENGTH];
545 /** The users ident reply.
546 * Two characters are added to the user-defined limit to compensate for the tilde etc.
548 char ident[IDENTMAX+2];
550 /** The host displayed to non-opers (used for cloaking etc).
551 * This usually matches the value of User::host.
555 /** The users full name (GECOS).
557 char fullname[MAXGECOS+1];
559 /** The user's mode list.
560 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
561 * this is an array of values in a similar way to channel modes.
562 * A value of 1 in field (modeletter-65) indicates that the mode is
563 * set, for example, to work out if mode +s is set, we check the field
564 * User::modes['s'-65] != 0.
565 * The following RFC characters o, w, s, i have constants defined via an
566 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
570 /** What snomasks are set on this user.
571 * This functions the same as the above modes.
575 /** Channels this user is on, and the permissions they have there
579 /** The server the user is connected to.
583 /** The user's away message.
584 * If this string is empty, the user is not marked as away.
586 char awaymsg[MAXAWAY+1];
588 /** Number of lines the user can place into the buffer
589 * (up to the global NetBufferSize bytes) before they
590 * are disconnected for excess flood
594 /** Timestamp of current time + connection class timeout.
595 * This user must send USER/NICK before this timestamp is
596 * reached or they will be disconnected.
600 /** The oper type they logged in as, if they are an oper.
601 * This is used to check permissions in operclasses, so that
602 * we can say 'yay' or 'nay' to any commands they issue.
603 * The value of this is the value of a valid 'type name=' tag.
607 /** True when DNS lookups are completed.
608 * The UserResolver classes res_forward and res_reverse will
609 * set this value once they complete.
613 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
615 unsigned int pingmax;
617 /** Password specified by the user when they registered.
618 * This is stored even if the <connect> block doesnt need a password, so that
619 * modules may check it.
623 /** User's receive queue.
624 * Lines from the IRCd awaiting processing are stored here.
625 * Upgraded april 2005, old system a bit hairy.
629 /** User's send queue.
630 * Lines waiting to be sent are stored here until their buffer is flushed.
634 /** Flood counters - lines received
638 /** Flood counters - time lines_in is due to be reset
642 /** Flood counters - Highest value lines_in may reach before the user gets disconnected
646 /** If this is set to true, then all read operations for the user
647 * are dropped into the bit-bucket.
648 * This is used by the global CullList, but please note that setting this value
649 * alone will NOT cause the user to quit. This means it can be used seperately,
650 * for example by shun modules etc.
654 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
655 * GetIPString/GetPort to obtain its values.
659 /** Initialize the clients sockaddr
660 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
661 * @param ip A human-readable IP address for this user matching the protcol_family
662 * @param port The port number of this user or zero for a remote user
664 void SetSockAddr(int protocol_family, const char* ip, int port);
666 /** Get port number from sockaddr
667 * @return The port number of this user.
671 /** Get protocol family from sockaddr
672 * @return The protocol family of this user, either AF_INET or AF_INET6
674 int GetProtocolFamily();
676 /** Get IP string from sockaddr, using static internal buffer
677 * @return The IP string
679 const char* GetIPString();
681 /* Write error string
683 std::string WriteError;
685 /** Maximum size this user's sendq can become.
686 * Copied from the connect class on connect.
690 /** Maximum size this user's recvq can become.
691 * Copied from the connect class on connect.
695 /** This is true if the user matched an exception when they connected to the ircd.
696 * It isnt valid after this point, and you should not attempt to do anything with it
697 * after this point, because the eline might be removed at a later time, and/or no
698 * longer be applicable to this user. It is only used to save doing the eline lookup
699 * twice (instead we do it once and set this value).
703 /** This value contains how far into the penalty threshold the user is. Once its over
704 * the penalty threshold then commands are held and processed on-timer.
708 /** True if we are flushing penalty lines
712 /** If this bool is set then penalty rules do not apply to this user
714 bool ExemptFromPenalty;
716 /** Default constructor
717 * @throw CoreException if the UID allocated to the user already exists
718 * @param Instance Creator instance
719 * @param uid User UUID, or empty to allocate one automatically
721 User(InspIRCd* Instance, const std::string &uid = "");
723 /** Returns the full displayed host of the user
724 * This member function returns the hostname of the user as seen by other users
725 * on the server, in nick!ident&at;host form.
726 * @return The full masked host of the user
728 virtual char* GetFullHost();
730 /** Returns the full real host of the user
731 * This member function returns the hostname of the user as seen by other users
732 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
733 * e.g. through a module, then this method will ignore it and return the true hostname.
734 * @return The full real host of the user
736 virtual char* GetFullRealHost();
738 /** This clears any cached results that are used for GetFullRealHost() etc.
739 * The results of these calls are cached as generating them can be generally expensive.
741 void InvalidateCache();
743 /** Create a displayable mode string for this users snomasks
744 * @return The notice mask character sequence
746 const char* FormatNoticeMasks();
748 /** Process a snomask modifier string, e.g. +abc-de
749 * @param sm A sequence of notice mask characters
750 * @return The cleaned mode sequence which can be output,
751 * e.g. in the above example if masks c and e are not
752 * valid, this function will return +ab-d
754 std::string ProcessNoticeMasks(const char *sm);
756 /** Returns true if a notice mask is set
757 * @param sm A notice mask character to check
758 * @return True if the notice mask is set
760 bool IsNoticeMaskSet(unsigned char sm);
762 /** Changed a specific notice mask value
763 * @param sm The server notice mask to change
764 * @param value An on/off value for this mask
766 void SetNoticeMask(unsigned char sm, bool value);
768 /** Create a displayable mode string for this users umodes
769 * @param The mode string
771 const char* FormatModes();
773 /** Returns true if a specific mode is set
774 * @param m The user mode
775 * @return True if the mode is set
777 bool IsModeSet(unsigned char m);
779 /** Set a specific usermode to on or off
780 * @param m The user mode
781 * @param value On or off setting of the mode
783 void SetMode(unsigned char m, bool value);
785 /** Returns true if a user is invited to a channel.
786 * @param channel A channel name to look up
787 * @return True if the user is invited to the given channel
789 virtual bool IsInvited(const irc::string &channel);
791 /** Adds a channel to a users invite list (invites them to a channel)
792 * @param channel A channel name to add
794 virtual void InviteTo(const irc::string &channel);
796 /** Removes a channel from a users invite list.
797 * This member function is called on successfully joining an invite only channel
798 * to which the user has previously been invited, to clear the invitation.
799 * @param channel The channel to remove the invite to
801 virtual void RemoveInvite(const irc::string &channel);
803 /** Returns true or false for if a user can execute a privilaged oper command.
804 * This is done by looking up their oper type from User::oper, then referencing
805 * this to their oper classes and checking the commands they can execute.
806 * @param command A command (should be all CAPS)
807 * @return True if this user can execute the command
809 bool HasPermission(const std::string &command);
811 /** Calls read() to read some data for this user using their fd.
812 * @param buffer The buffer to read into
813 * @param size The size of data to read
814 * @return The number of bytes read, or -1 if an error occured.
816 int ReadData(void* buffer, size_t size);
818 /** This method adds data to the read buffer of the user.
819 * The buffer can grow to any size within limits of the available memory,
820 * managed by the size of a std::string, however if any individual line in
821 * the buffer grows over 600 bytes in length (which is 88 chars over the
822 * RFC-specified limit per line) then the method will return false and the
823 * text will not be inserted.
824 * @param a The string to add to the users read buffer
825 * @return True if the string was successfully added to the read buffer
827 bool AddBuffer(std::string a);
829 /** This method returns true if the buffer contains at least one carriage return
830 * character (e.g. one complete line may be read)
831 * @return True if there is at least one complete line in the users buffer
833 bool BufferIsReady();
835 /** This function clears the entire buffer by setting it to an empty string.
839 /** This method returns the first available string at the tail end of the buffer
840 * and advances the tail end of the buffer past the string. This means it is
841 * a one way operation in a similar way to strtok(), and multiple calls return
842 * multiple lines if they are available. The results of this function if there
843 * are no lines to be read are unknown, always use BufferIsReady() to check if
844 * it is ok to read the buffer before calling GetBuffer().
845 * @return The string at the tail end of this users buffer
847 std::string GetBuffer();
849 /** Sets the write error for a connection. This is done because the actual disconnect
850 * of a client may occur at an inopportune time such as half way through /LIST output.
851 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
852 * errored clients purged.
853 * @param error The error string to set.
855 void SetWriteError(const std::string &error);
857 /** Returns the write error which last occured on this connection or an empty string
859 * @return The error string which has occured for this user
861 const char* GetWriteError();
863 /** Adds to the user's write buffer.
864 * You may add any amount of text up to this users sendq value, if you exceed the
865 * sendq value, SetWriteError() will be called to set the users error string to
866 * "SendQ exceeded", and further buffer adds will be dropped.
867 * @param data The data to add to the write buffer
869 void AddWriteBuf(const std::string &data);
871 /** Flushes as much of the user's buffer to the file descriptor as possible.
872 * This function may not always flush the entire buffer, rather instead as much of it
873 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
874 * position is advanced forwards and the rest of the data sent at the next call to
877 void FlushWriteBuf();
879 /** Returns the list of channels this user has been invited to but has not yet joined.
880 * @return A list of channels the user is invited to
882 InvitedList* GetInviteList();
884 /** Creates a wildcard host.
885 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
886 * @return The wildcarded hostname in *!*@host form
888 char* MakeWildHost();
890 /** Creates a usermask with real host.
891 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
892 * @return the usermask in the format user@host
896 /** Creates a usermask with real ip.
897 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
898 * @return the usermask in the format user@ip
902 /** Shuts down and closes the user's socket
903 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
904 * which will call CloseSocket() for you.
908 /** Disconnect a user gracefully
909 * @param user The user to remove
910 * @param r The quit reason to show to normal users
911 * @param oreason The quit reason to show to opers
912 * @return Although this function has no return type, on exit the user provided will no longer exist.
914 static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
916 /** Add the user to WHOWAS system
920 /** Oper up the user using the given opertype.
921 * This will also give the +o usermode.
922 * @param opertype The oper type to oper as
924 void Oper(const std::string &opertype);
926 /** Call this method to find the matching <connect> for a user, and to check them against it.
930 /** Use this method to fully connect a user.
931 * This will send the message of the day, check G/K/E lines, etc.
935 /** Change this users hash key to a new string.
936 * You should not call this function directly. It is used by the core
937 * to update the users hash entry on a nickchange.
938 * @param New new user_hash key
939 * @return Pointer to User in hash (usually 'this')
941 User* UpdateNickHash(const char* New);
943 /** Force a nickname change.
944 * If the nickname change fails (for example, because the nick in question
945 * already exists) this function will return false, and you must then either
946 * output an error message, or quit the user for nickname collision.
947 * @param newnick The nickname to change to
948 * @return True if the nickchange was successful.
950 bool ForceNickChange(const char* newnick);
952 /** Add a client to the system.
953 * This will create a new User, insert it into the user_hash,
954 * initialize it as not yet registered, and add it to the socket engine.
955 * @param Instance a pointer to the server instance
956 * @param socket The socket id (file descriptor) this user is on
957 * @param port The port number this user connected on
958 * @param iscached This variable is reserved for future use
959 * @param ip The IP address of the user
960 * @return This function has no return value, but a call to AddClient may remove the user.
962 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
965 * This will clear the +o usermode and unset the user's oper type
969 /** Return the number of global clones of this user
970 * @return The global clone count of this user
972 unsigned long GlobalCloneCount();
974 /** Return the number of local clones of this user
975 * @return The local clone count of this user
977 unsigned long LocalCloneCount();
979 /** Remove all clone counts from the user, you should
980 * use this if you change the user's IP address in
981 * User::ip after they have registered.
983 void RemoveCloneCounts();
985 /** Write text to this user, appending CR/LF.
986 * @param text A std::string to send to the user
988 void Write(std::string text);
990 /** Write text to this user, appending CR/LF.
991 * @param text The format string for text to send to the user
992 * @param ... POD-type format arguments
994 void Write(const char *text, ...);
996 /** Write text to this user, appending CR/LF and prepending :server.name
997 * @param text A std::string to send to the user
999 void WriteServ(const std::string& text);
1001 /** Write text to this user, appending CR/LF and prepending :server.name
1002 * @param text The format string for text to send to the user
1003 * @param ... POD-type format arguments
1005 void WriteServ(const char* text, ...);
1007 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
1008 * @param user The user to prepend the :nick!user@host of
1009 * @param text A std::string to send to the user
1011 void WriteFrom(User *user, const std::string &text);
1013 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
1014 * @param user The user to prepend the :nick!user@host of
1015 * @param text The format string for text to send to the user
1016 * @param ... POD-type format arguments
1018 void WriteFrom(User *user, const char* text, ...);
1020 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
1021 * @param dest The user to route the message to
1022 * @param text A std::string to send to the user
1024 void WriteTo(User *dest, const std::string &data);
1026 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
1027 * @param dest The user to route the message to
1028 * @param text The format string for text to send to the user
1029 * @param ... POD-type format arguments
1031 void WriteTo(User *dest, const char *data, ...);
1033 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1034 * @param text A std::string to send to the users
1036 void WriteCommon(const std::string &text);
1038 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1039 * @param text The format string for text to send to the users
1040 * @param ... POD-type format arguments
1042 void WriteCommon(const char* text, ...);
1044 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1045 * @param text The format string for text to send to the users
1046 * @param ... POD-type format arguments
1048 void WriteCommonExcept(const char* text, ...);
1050 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1051 * @param text A std::string to send to the users
1053 void WriteCommonExcept(const std::string &text);
1055 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1056 * quit message for opers only.
1057 * @param normal_text Normal user quit message
1058 * @param oper_text Oper only quit message
1060 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1062 /** Write a WALLOPS message from this user to all local opers.
1063 * If this user is not opered, the function will return without doing anything.
1064 * @param text The format string to send in the WALLOPS message
1065 * @param ... Format arguments
1067 void WriteWallOps(const char* text, ...);
1069 /** Write a WALLOPS message from this user to all local opers.
1070 * If this user is not opered, the function will return without doing anything.
1071 * @param text The text to send in the WALLOPS message
1073 void WriteWallOps(const std::string &text);
1075 /** Return true if the user shares at least one channel with another user
1076 * @param other The other user to compare the channel list against
1077 * @return True if the given user shares at least one channel with this user
1079 bool SharesChannelWith(User *other);
1081 /** Change the displayed host of a user.
1082 * ALWAYS use this function, rather than writing User::dhost directly,
1083 * as this triggers module events allowing the change to be syncronized to
1084 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1085 * before setting their host field.
1086 * @param host The new hostname to set
1087 * @return True if the change succeeded, false if it didn't
1089 bool ChangeDisplayedHost(const char* host);
1091 /** Change the ident (username) of a user.
1092 * ALWAYS use this function, rather than writing User::ident directly,
1093 * as this correctly causes the user to seem to quit (where configured)
1094 * before setting their ident field.
1095 * @param host The new ident to set
1096 * @return True if the change succeeded, false if it didn't
1098 bool ChangeIdent(const char* newident);
1100 /** Change a users realname field.
1101 * ALWAYS use this function, rather than writing User::fullname directly,
1102 * as this triggers module events allowing the change to be syncronized to
1104 * @param gecos The user's new realname
1105 * @return True if the change succeeded, false if otherwise
1107 bool ChangeName(const char* gecos);
1109 /** Send a command to all local users from this user
1110 * The command given must be able to send text with the
1111 * first parameter as a servermask (e.g. $*), so basically
1112 * you should use PRIVMSG or NOTICE.
1113 * @param command the command to send
1114 * @param text The text format string to send
1115 * @param ... Format arguments
1117 void SendAll(const char* command, char* text, ...);
1119 /** Compile a channel list for this user, and send it to the user 'source'
1120 * Used internally by WHOIS
1121 * @param The user to send the channel list to if it is not too long
1122 * @return This user's channel list
1124 std::string ChannelList(User* source);
1126 /** Split the channel list in cl which came from dest, and spool it to this user
1127 * Used internally by WHOIS
1128 * @param dest The user the original channel list came from
1129 * @param cl The channel list as a string obtained from User::ChannelList()
1131 void SplitChanList(User* dest, const std::string &cl);
1133 /** Remove this user from all channels they are on, and delete any that are now empty.
1134 * This is used by QUIT, and will not send part messages!
1136 void PurgeEmptyChannels();
1138 /** Get the connect class which this user belongs to.
1139 * @return A pointer to this user's connect class
1141 ConnectClass *GetClass();
1143 /** Set the connect class to which this user belongs to.
1144 * @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.
1145 * @return A reference to this user's current connect class.
1147 ConnectClass *SetClass(const std::string &explicit_name = "");
1149 /** Show the message of the day to this user
1153 /** Show the server RULES file to this user
1157 /** Set oper-specific quit message shown to opers only when the user quits
1158 * (overrides any sent by QuitUser)
1160 void SetOperQuit(const std::string &oquit);
1162 /** Get oper-specific quit message shown only to opers when the user quits.
1163 * (overrides any sent by QuitUser)
1165 const char* GetOperQuit();
1167 /** Increases a user's command penalty by a set amount.
1169 void IncreasePenalty(int increase);
1171 /** Decreases a user's command penalty by a set amount.
1173 void DecreasePenalty(int decrease);
1175 /** Handle socket event.
1176 * From EventHandler class.
1177 * @param et Event type
1178 * @param errornum Error number for EVENT_ERROR events
1180 void HandleEvent(EventType et, int errornum = 0);
1182 /** Default destructor
1187 /* Configuration callbacks */