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 "connection.h"
22 /** Channel status for a user
35 /** connect class types
44 /** RFC1459 channel modes
47 /** +s: Server notices */
48 UM_SERVERNOTICE = 's' - 65,
50 UM_WALLOPS = 'w' - 65,
52 UM_INVISIBLE = 'i' - 65,
54 UM_OPERATOR = 'o' - 65,
55 /** +n: Server notice mask */
59 /** Registration state of a user, e.g.
60 * have they sent USER, NICK, PASS yet?
62 enum RegistrationState {
64 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
65 REG_NONE = 0, /* Has sent nothing */
68 REG_USER = 1, /* Has sent USER */
69 REG_NICK = 2, /* Has sent NICK */
70 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
71 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
74 /* Required forward declaration */
78 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
80 class CoreExport ConnectClass : public classbase
83 /** Type of line, either CC_ALLOW or CC_DENY
86 /** Connect class name
89 /** Max time to register the connection in seconds
91 unsigned int registration_timeout;
92 /** Number of lines in buffer before excess flood is triggered
95 /** Host mask for this line
98 /** Number of seconds between pings for this line
100 unsigned int pingtime;
101 /** (Optional) Password for this line
105 /** (Optional) Hash Method for this line
109 /** Threshold value for flood disconnect
111 unsigned int threshold;
113 /** Maximum size of sendq for users in this class (bytes)
115 unsigned long sendqmax;
117 /** Maximum size of recvq for users in this class (bytes)
119 unsigned long recvqmax;
121 /** Local max when connecting by this connection class
123 unsigned long maxlocal;
125 /** Global max when connecting by this connection class
127 unsigned long maxglobal;
129 /** Max channels for this class
131 unsigned int maxchans;
133 /** Port number this connect class applies to
139 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
141 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
142 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
143 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
144 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
145 port(source->port), RefCount(0), disabled(false), limit(source->limit)
149 /** Create a new connect class with no settings.
151 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
152 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
156 /** Create a new connect class to ALLOW connections.
157 * @param thename Name of the connect class
158 * @param timeout The registration timeout
159 * @param fld The flood value
160 * @param hst The IP mask to allow
161 * @param ping The ping frequency
162 * @param pas The password to be used
163 * @param hsh The hash to be used
164 * @param thres The flooding threshold
165 * @param sendq The maximum sendq value
166 * @param recvq The maximum recvq value
167 * @param maxl The maximum local sessions
168 * @param maxg The maximum global sessions
170 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
171 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
172 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
173 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
174 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
176 /** Create a new connect class to DENY connections
177 * @param thename Name of the connect class
178 * @param hst The IP mask to deny
180 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
181 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)
185 /* Create a new connect class based on another class
186 * @param thename The name of the connect class
187 * @param source Another connect class to inherit all but the name from
189 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
190 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
191 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
192 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
193 port(source->port), RefCount(0), disabled(false), limit(source->limit)
197 void SetDisabled(bool t)
204 return this->disabled;
207 /* Update an existing entry with new values
209 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
210 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
211 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
214 registration_timeout = timeout;
238 this->limit = llimit;
241 void Update(const std::string &n, const std::string &hst)
247 /** Reference counter. Contains an int as to how many users are connected to this class. :)
248 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
249 * are 0 users on it - it will go away in RAM. :)
251 unsigned long RefCount;
253 /** 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
257 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
266 /** Returns the type, CC_ALLOW or CC_DENY
270 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
273 std::string& GetName()
278 /** Returns the registration timeout
280 time_t GetRegTimeout()
282 return (registration_timeout ? registration_timeout : 90);
285 /** Returns the flood limit
287 unsigned int GetFlood()
289 return (threshold ? flood : 999);
292 /** Returns the allowed or denied IP mask
294 const std::string& GetHost()
313 /** Returns the ping frequency
315 unsigned int GetPingTime()
317 return (pingtime ? pingtime : 120);
320 /** Returns the password or an empty string
322 const std::string& GetPass()
327 /** Returns the hash or an empty string
329 const std::string& GetHash()
334 /** Returns the flood threshold value
336 unsigned int GetThreshold()
338 return (threshold ? threshold : 1);
341 /** Returns the maximum sendq value
343 unsigned long GetSendqMax()
345 return (sendqmax ? sendqmax : 262114);
348 /** Returns the maximum recvq value
350 unsigned long GetRecvqMax()
352 return (recvqmax ? recvqmax : 4096);
355 /** Returusn the maximum number of local sessions
357 unsigned long GetMaxLocal()
362 /** Returns the maximum number of global sessions
364 unsigned long GetMaxGlobal()
370 /** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
372 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
374 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
376 typedef std::vector<ConnectClass*> ClassVector;
378 /** Typedef for the list of user-channel records for a user
380 typedef std::map<Channel*, char> UserChanList;
382 /** Shorthand for an iterator into a UserChanList
384 typedef UserChanList::iterator UCListIter;
386 /* Required forward declaration
390 /** Visibility data for a user.
391 * If a user has a non-null instance of this class in their User,
392 * then it is used to determine if this user is visible to other users
395 class CoreExport VisData
401 /** Destroy a visdata
404 /** Is this user visible to some other user?
405 * @param user The other user to compare to
406 * @return true True if the user is visible to the other user, false if not
408 virtual bool VisibleTo(User* user);
411 /** Holds all information about a user
412 * This class stores all information about a user connected to the irc server. Everything about a
413 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
414 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
415 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
416 * file descriptor value.
418 class CoreExport User : public connection
421 /** Pointer to creator.
422 * This is required to make use of core functions
423 * from within the User class.
425 InspIRCd* ServerInstance;
427 /** A list of channels the user has a pending invite to.
428 * Upon INVITE channels are added, and upon JOIN, the
429 * channels are removed from this list.
433 /** Cached nick!ident@host value using the real hostname
435 std::string cached_fullhost;
437 /** Cached nick!ident@ip value using the real IP address
439 std::string cached_hostip;
441 /** Cached nick!ident@host value using the masked hostname
443 std::string cached_makehost;
445 /** Cached nick!ident@realhost value using the real hostname
447 std::string cached_fullrealhost;
449 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
451 std::string cachedip;
453 /** When we erase the user (in the destructor),
454 * we call this method to subtract one from all
455 * mode characters this user is making use of.
457 void DecrementModes();
459 /** Max channels for this user
461 unsigned int MaxChans;
463 std::map<std::string, bool>* AllowedOperCommands;
465 /** Allowed user modes from oper classes. */
466 bool* AllowedUserModes;
468 /** Allowed channel modes from oper classes. */
469 bool* AllowedChanModes;
472 /** Module responsible for raw i/o
476 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
477 * The pointer is guarenteed to *always* be valid. :)
479 ConnectClass *MyClass;
481 /** Resolvers for looking up this users IP address
482 * This will occur if and when res_reverse completes.
483 * When this class completes its lookup, User::dns_done
484 * will be set from false to true.
486 UserResolver* res_forward;
488 /** Resolvers for looking up this users hostname
489 * This is instantiated by User::StartDNSLookup(),
490 * and on success, instantiates User::res_reverse.
492 UserResolver* res_reverse;
494 /** User visibility state, see definition of VisData.
498 /** Stored reverse lookup from res_forward
500 std::string stored_host;
502 /** Starts a DNS lookup of the user's IP.
503 * This will cause two UserResolver classes to be instantiated.
504 * When complete, these objects set User::dns_done to true.
506 void StartDNSLookup();
508 unsigned int GetMaxChans();
510 /** The users nickname.
511 * An invalid nickname indicates an unregistered connection prior to the NICK command.
512 * Use InspIRCd::IsNick() to validate nicknames.
516 /** The user's unique identifier.
517 * This is the unique identifier which the user has across the network.
521 /** The users ident reply.
522 * Two characters are added to the user-defined limit to compensate for the tilde etc.
526 /** The host displayed to non-opers (used for cloaking etc).
527 * This usually matches the value of User::host.
531 /** The users full name (GECOS).
533 std::string fullname;
535 /** The user's mode list.
536 * NOT a null terminated string.
538 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
539 * if (modes[modeletter-65]) is set, then the mode is
540 * set, for example, to work out if mode +s is set, we check the field
541 * User::modes['s'-65] != 0.
542 * The following RFC characters o, w, s, i have constants defined via an
543 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
545 std::bitset<64> modes;
547 /** What snomasks are set on this user.
548 * This functions the same as the above modes.
550 std::bitset<64> snomasks;
552 /** Channels this user is on, and the permissions they have there
556 /** The server the user is connected to.
560 /** The user's away message.
561 * If this string is empty, the user is not marked as away.
565 /** Time the user last went away.
566 * This is ONLY RELIABLE if user IS_AWAY()!
570 /** The oper type they logged in as, if they are an oper.
571 * This is used to check permissions in operclasses, so that
572 * we can say 'yay' or 'nay' to any commands they issue.
573 * The value of this is the value of a valid 'type name=' tag.
577 /** True when DNS lookups are completed.
578 * The UserResolver classes res_forward and res_reverse will
579 * set this value once they complete.
583 /** Password specified by the user when they registered.
584 * This is stored even if the <connect> block doesnt need a password, so that
585 * modules may check it.
587 std::string password;
589 /** User's receive queue.
590 * Lines from the IRCd awaiting processing are stored here.
591 * Upgraded april 2005, old system a bit hairy.
595 /** User's send queue.
596 * Lines waiting to be sent are stored here until their buffer is flushed.
600 /** Message user will quit with. Not to be set externally.
604 /** Quit message shown to opers - not to be set externally.
606 std::string operquitmsg;
608 /** Whether or not to send an snotice about this user's quitting
612 /** Flood counters - lines received
614 unsigned int lines_in;
616 /** Flood counters - time lines_in is due to be reset
620 /** If this is set to true, then all socket operations for the user
621 * are dropped into the bit-bucket.
622 * This value is set by QuitUser, and is not needed seperately from that call.
623 * Please note that setting this value alone will NOT cause the user to quit.
627 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
628 * GetIPString/GetPort to obtain its values.
632 /** Initialize the clients sockaddr
633 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
634 * @param ip A human-readable IP address for this user matching the protcol_family
635 * @param port The port number of this user or zero for a remote user
637 void SetSockAddr(int protocol_family, const char* ip, int port);
639 /** Get port number from sockaddr
640 * @return The port number of this user.
644 /** Get protocol family from sockaddr
645 * @return The protocol family of this user, either AF_INET or AF_INET6
647 int GetProtocolFamily();
649 /** Get IP string from sockaddr, using static internal buffer
650 * @return The IP string
652 const char* GetIPString(bool translate4in6 = true);
654 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
655 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
656 * This may be used for CIDR clone detection, etc.
658 * (XXX, brief note: when we do the sockets rewrite, this should move down a
659 * level so it may be used on more derived objects. -- w00t)
661 const char *GetCIDRMask(int range);
663 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
667 /** This value contains how far into the penalty threshold the user is. Once its over
668 * the penalty threshold then commands are held and processed on-timer.
672 /** True if we are flushing penalty lines
676 /** If this bool is set then penalty rules do not apply to this user
678 bool ExemptFromPenalty;
680 /** Default constructor
681 * @throw CoreException if the UID allocated to the user already exists
682 * @param Instance Creator instance
683 * @param uid User UUID, or empty to allocate one automatically
685 User(InspIRCd* Instance, const std::string &uid = "");
687 /** Check if the user matches a G or K line, and disconnect them if they do.
688 * Returns true if the user matched a ban, false else.
692 /** Returns the full displayed host of the user
693 * This member function returns the hostname of the user as seen by other users
694 * on the server, in nick!ident&at;host form.
695 * @return The full masked host of the user
697 virtual const std::string& GetFullHost();
699 /** Returns the full real host of the user
700 * This member function returns the hostname of the user as seen by other users
701 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
702 * e.g. through a module, then this method will ignore it and return the true hostname.
703 * @return The full real host of the user
705 virtual const std::string& GetFullRealHost();
707 /** This clears any cached results that are used for GetFullRealHost() etc.
708 * The results of these calls are cached as generating them can be generally expensive.
710 void InvalidateCache();
712 /** Create a displayable mode string for this users snomasks
713 * @return The notice mask character sequence
715 const char* FormatNoticeMasks();
717 /** Process a snomask modifier string, e.g. +abc-de
718 * @param sm A sequence of notice mask characters
719 * @return The cleaned mode sequence which can be output,
720 * e.g. in the above example if masks c and e are not
721 * valid, this function will return +ab-d
723 std::string ProcessNoticeMasks(const char *sm);
725 /** Returns true if a notice mask is set
726 * @param sm A notice mask character to check
727 * @return True if the notice mask is set
729 bool IsNoticeMaskSet(unsigned char sm);
731 /** Changed a specific notice mask value
732 * @param sm The server notice mask to change
733 * @param value An on/off value for this mask
735 void SetNoticeMask(unsigned char sm, bool value);
737 /** Create a displayable mode string for this users umodes
738 * @param The mode string
740 const char* FormatModes();
742 /** Returns true if a specific mode is set
743 * @param m The user mode
744 * @return True if the mode is set
746 bool IsModeSet(unsigned char m);
748 /** Set a specific usermode to on or off
749 * @param m The user mode
750 * @param value On or off setting of the mode
752 void SetMode(unsigned char m, bool value);
754 /** Returns true if a user is invited to a channel.
755 * @param channel A channel name to look up
756 * @return True if the user is invited to the given channel
758 virtual bool IsInvited(const irc::string &channel);
760 /** Adds a channel to a users invite list (invites them to a channel)
761 * @param channel A channel name to add
762 * @param timeout When the invite should expire (0 == never)
764 virtual void InviteTo(const irc::string &channel, time_t timeout);
766 /** Removes a channel from a users invite list.
767 * This member function is called on successfully joining an invite only channel
768 * to which the user has previously been invited, to clear the invitation.
769 * @param channel The channel to remove the invite to
771 virtual void RemoveInvite(const irc::string &channel);
773 /** Returns true or false for if a user can execute a privilaged oper command.
774 * This is done by looking up their oper type from User::oper, then referencing
775 * this to their oper classes and checking the commands they can execute.
776 * @param command A command (should be all CAPS)
777 * @return True if this user can execute the command
779 bool HasPermission(const std::string &command);
781 /** Returns true or false if a user can set a privileged user or channel mode.
782 * This is done by looking up their oper type from User::oper, then referencing
783 * this to their oper classes, and checking the modes they can set.
784 * @param mode The mode the check
785 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
786 * @return True if the user can set or unset this mode.
788 bool HasModePermission(unsigned char mode, ModeType type);
790 /** Calls read() to read some data for this user using their fd.
791 * @param buffer The buffer to read into
792 * @param size The size of data to read
793 * @return The number of bytes read, or -1 if an error occured.
795 int ReadData(void* buffer, size_t size);
797 /** This method adds data to the read buffer of the user.
798 * The buffer can grow to any size within limits of the available memory,
799 * managed by the size of a std::string, however if any individual line in
800 * the buffer grows over 600 bytes in length (which is 88 chars over the
801 * RFC-specified limit per line) then the method will return false and the
802 * text will not be inserted.
803 * @param a The string to add to the users read buffer
804 * @return True if the string was successfully added to the read buffer
806 bool AddBuffer(const std::string &a);
808 /** This method returns true if the buffer contains at least one carriage return
809 * character (e.g. one complete line may be read)
810 * @return True if there is at least one complete line in the users buffer
812 bool BufferIsReady();
814 /** This function clears the entire buffer by setting it to an empty string.
818 /** This method returns the first available string at the tail end of the buffer
819 * and advances the tail end of the buffer past the string. This means it is
820 * a one way operation in a similar way to strtok(), and multiple calls return
821 * multiple lines if they are available. The results of this function if there
822 * are no lines to be read are unknown, always use BufferIsReady() to check if
823 * it is ok to read the buffer before calling GetBuffer().
824 * @return The string at the tail end of this users buffer
826 std::string GetBuffer();
828 /** Adds to the user's write buffer.
829 * You may add any amount of text up to this users sendq value, if you exceed the
830 * sendq value, the user will be removed, and further buffer adds will be dropped.
831 * @param data The data to add to the write buffer
833 void AddWriteBuf(const std::string &data);
835 /** Flushes as much of the user's buffer to the file descriptor as possible.
836 * This function may not always flush the entire buffer, rather instead as much of it
837 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
838 * position is advanced forwards and the rest of the data sent at the next call to
841 void FlushWriteBuf();
843 /** Returns the list of channels this user has been invited to but has not yet joined.
844 * @return A list of channels the user is invited to
846 InvitedList* GetInviteList();
848 /** Creates a wildcard host.
849 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
850 * @return The wildcarded hostname in *!*@host form
852 char* MakeWildHost();
854 /** Creates a usermask with real host.
855 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
856 * @return the usermask in the format user@host
858 const std::string& MakeHost();
860 /** Creates a usermask with real ip.
861 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
862 * @return the usermask in the format user@ip
864 const std::string& MakeHostIP();
866 /** Shuts down and closes the user's socket
867 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
868 * which will call CloseSocket() for you.
872 /** Add the user to WHOWAS system
876 /** Oper up the user using the given opertype.
877 * This will also give the +o usermode.
878 * @param opertype The oper type to oper as
880 void Oper(const std::string &opertype, const std::string &opername);
882 /** Call this method to find the matching <connect> for a user, and to check them against it.
886 /** Use this method to fully connect a user.
887 * This will send the message of the day, check G/K/E lines, etc.
891 /** Change this users hash key to a new string.
892 * You should not call this function directly. It is used by the core
893 * to update the users hash entry on a nickchange.
894 * @param New new user_hash key
895 * @return Pointer to User in hash (usually 'this')
897 User* UpdateNickHash(const char* New);
899 /** Force a nickname change.
900 * If the nickname change fails (for example, because the nick in question
901 * already exists) this function will return false, and you must then either
902 * output an error message, or quit the user for nickname collision.
903 * @param newnick The nickname to change to
904 * @return True if the nickchange was successful.
906 bool ForceNickChange(const char* newnick);
909 * This will clear the +o usermode and unset the user's oper type
913 /** Write text to this user, appending CR/LF.
914 * @param text A std::string to send to the user
916 void Write(std::string text);
918 /** Write text to this user, appending CR/LF.
919 * @param text The format string for text to send to the user
920 * @param ... POD-type format arguments
922 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
924 /** Write text to this user, appending CR/LF and prepending :server.name
925 * @param text A std::string to send to the user
927 void WriteServ(const std::string& text);
929 /** Write text to this user, appending CR/LF and prepending :server.name
930 * @param text The format string for text to send to the user
931 * @param ... POD-type format arguments
933 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
935 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
937 void WriteNumeric(unsigned int numeric, const std::string &text);
939 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
940 * @param user The user to prepend the :nick!user@host of
941 * @param text A std::string to send to the user
943 void WriteFrom(User *user, const std::string &text);
945 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
946 * @param user The user to prepend the :nick!user@host of
947 * @param text The format string for text to send to the user
948 * @param ... POD-type format arguments
950 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
952 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
953 * @param dest The user to route the message to
954 * @param text A std::string to send to the user
956 void WriteTo(User *dest, const std::string &data);
958 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
959 * @param dest The user to route the message to
960 * @param text The format string for text to send to the user
961 * @param ... POD-type format arguments
963 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
965 /** Write to all users that can see this user (including this user in the list), appending CR/LF
966 * @param text A std::string to send to the users
968 void WriteCommon(const std::string &text);
970 /** Write to all users that can see this user (including this user in the list), appending CR/LF
971 * @param text The format string for text to send to the users
972 * @param ... POD-type format arguments
974 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
976 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
977 * @param text The format string for text to send to the users
978 * @param ... POD-type format arguments
980 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
982 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
983 * @param text A std::string to send to the users
985 void WriteCommonExcept(const std::string &text);
987 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
988 * quit message for opers only.
989 * @param normal_text Normal user quit message
990 * @param oper_text Oper only quit message
992 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
994 /** Write a WALLOPS message from this user to all local opers.
995 * If this user is not opered, the function will return without doing anything.
996 * @param text The format string to send in the WALLOPS message
997 * @param ... Format arguments
999 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
1001 /** Write a WALLOPS message from this user to all local opers.
1002 * If this user is not opered, the function will return without doing anything.
1003 * @param text The text to send in the WALLOPS message
1005 void WriteWallOps(const std::string &text);
1007 /** Return true if the user shares at least one channel with another user
1008 * @param other The other user to compare the channel list against
1009 * @return True if the given user shares at least one channel with this user
1011 bool SharesChannelWith(User *other);
1013 /** Change the displayed host of a user.
1014 * ALWAYS use this function, rather than writing User::dhost directly,
1015 * as this triggers module events allowing the change to be syncronized to
1016 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1017 * before setting their host field.
1018 * @param host The new hostname to set
1019 * @return True if the change succeeded, false if it didn't
1021 bool ChangeDisplayedHost(const char* host);
1023 /** Change the ident (username) of a user.
1024 * ALWAYS use this function, rather than writing User::ident directly,
1025 * as this correctly causes the user to seem to quit (where configured)
1026 * before setting their ident field.
1027 * @param host The new ident to set
1028 * @return True if the change succeeded, false if it didn't
1030 bool ChangeIdent(const char* newident);
1032 /** Change a users realname field.
1033 * ALWAYS use this function, rather than writing User::fullname directly,
1034 * as this triggers module events allowing the change to be syncronized to
1036 * @param gecos The user's new realname
1037 * @return True if the change succeeded, false if otherwise
1039 bool ChangeName(const char* gecos);
1041 /** Send a command to all local users from this user
1042 * The command given must be able to send text with the
1043 * first parameter as a servermask (e.g. $*), so basically
1044 * you should use PRIVMSG or NOTICE.
1045 * @param command the command to send
1046 * @param text The text format string to send
1047 * @param ... Format arguments
1049 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
1051 /** Compile a channel list for this user, and send it to the user 'source'
1052 * Used internally by WHOIS
1053 * @param The user to send the channel list to if it is not too long
1054 * @return This user's channel list
1056 std::string ChannelList(User* source);
1058 /** Split the channel list in cl which came from dest, and spool it to this user
1059 * Used internally by WHOIS
1060 * @param dest The user the original channel list came from
1061 * @param cl The channel list as a string obtained from User::ChannelList()
1063 void SplitChanList(User* dest, const std::string &cl);
1065 /** Remove this user from all channels they are on, and delete any that are now empty.
1066 * This is used by QUIT, and will not send part messages!
1068 void PurgeEmptyChannels();
1070 /** Get the connect class which this user belongs to.
1071 * @return A pointer to this user's connect class
1073 ConnectClass *GetClass();
1075 /** Set the connect class to which this user belongs to.
1076 * @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.
1077 * @return A reference to this user's current connect class.
1079 ConnectClass *SetClass(const std::string &explicit_name = "");
1081 /** Show the message of the day to this user
1085 /** Show the server RULES file to this user
1089 /** Set oper-specific quit message shown to opers only when the user quits
1090 * (overrides any sent by QuitUser)
1092 void SetOperQuit(const std::string &oquit);
1094 /** Get oper-specific quit message shown only to opers when the user quits.
1095 * (overrides any sent by QuitUser)
1097 const std::string& GetOperQuit();
1099 /** Increases a user's command penalty by a set amount.
1101 void IncreasePenalty(int increase);
1103 /** Decreases a user's command penalty by a set amount.
1105 void DecreasePenalty(int decrease);
1107 /** Handle socket event.
1108 * From EventHandler class.
1109 * @param et Event type
1110 * @param errornum Error number for EVENT_ERROR events
1112 void HandleEvent(EventType et, int errornum = 0);
1114 /** Default destructor
1119 /** Derived from Resolver, and performs user forward/reverse lookups.
1121 class CoreExport UserResolver : public Resolver
1124 /** User this class is 'attached' to.
1127 /** File descriptor teh lookup is bound to
1130 /** True if the lookup is forward, false if is a reverse lookup
1134 /** Create a resolver.
1135 * @param Instance The creating instance
1136 * @param user The user to begin lookup on
1137 * @param to_resolve The IP or host to resolve
1138 * @param qt The query type
1139 * @param cache Modified by the constructor if the result was cached
1141 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1143 /** Called on successful lookup
1144 * @param result Result string
1145 * @param ttl Time to live for result
1146 * @param cached True if the result was found in the cache
1147 * @param resultnum Result number, we are only interested in result 0
1149 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
1151 /** Called on failed lookup
1152 * @param e Error code
1153 * @param errormessage Error message string
1155 void OnError(ResolverError e, const std::string &errormessage);
1158 /* Configuration callbacks */
1159 //class ServerConfig;