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"
21 #include "linebuffer.h"
23 #include <list> // XXX XXX XXX this should probably be moved to globals.h, and globals.h should probably be merged in with inspircd.h sometime. -- w00t
24 #define _GLIBCXX_FORCE_NEW 1
27 /** Channel status for a user
41 /** connect class types
51 /** RFC1459 channel modes
55 /** +s: Server notices */
56 UM_SERVERNOTICE = 's' - 65,
58 UM_WALLOPS = 'w' - 65,
60 UM_INVISIBLE = 'i' - 65,
62 UM_OPERATOR = 'o' - 65,
63 /** +n: Server notice mask */
67 /** Registration state of a user, e.g.
68 * have they sent USER, NICK, PASS yet?
70 enum RegistrationState
72 #ifndef REG_NONE /* This is already defined in win32, luckily it is still 0. -- Burlex
73 XXX perhaps we should undef it just in case.. Relying on magic numbers... -- w00t */
74 REG_NONE = 0, /* Has sent nothing */
77 REG_USER = 1, /* Has sent USER */
78 REG_NICK = 2, /* Has sent NICK */
79 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
80 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
83 /* Required forward declaration */
87 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
89 class CoreExport ConnectClass : public classbase
92 /** Type of line, either CC_ALLOW or CC_DENY
95 /** Connect class name
98 /** Max time to register the connection in seconds
100 unsigned int registration_timeout;
101 /** Number of lines in buffer before excess flood is triggered
104 /** Host mask for this line
107 /** Number of seconds between pings for this line
109 unsigned int pingtime;
110 /** (Optional) Password for this line
114 /** (Optional) Hash Method for this line
118 /** Threshold value for flood disconnect
120 unsigned int threshold;
122 /** Maximum size of sendq for users in this class (bytes)
124 unsigned long sendqmax;
126 /** Maximum size of recvq for users in this class (bytes)
128 unsigned long recvqmax;
130 /** Local max when connecting by this connection class
132 unsigned long maxlocal;
134 /** Global max when connecting by this connection class
136 unsigned long maxglobal;
138 /** Max channels for this class
140 unsigned int maxchans;
142 /** Port number this connect class applies to
148 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
150 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
151 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
152 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
153 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
154 port(source->port), RefCount(0), disabled(false), limit(source->limit)
158 /** Create a new connect class with no settings.
160 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
161 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
165 /** Create a new connect class to ALLOW connections.
166 * @param thename Name of the connect class
167 * @param timeout The registration timeout
168 * @param fld The flood value
169 * @param hst The IP mask to allow
170 * @param ping The ping frequency
171 * @param pas The password to be used
172 * @param hsh The hash to be used
173 * @param thres The flooding threshold
174 * @param sendq The maximum sendq value
175 * @param recvq The maximum recvq value
176 * @param maxl The maximum local sessions
177 * @param maxg The maximum global sessions
179 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
180 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
181 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
182 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
183 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
185 /** Create a new connect class to DENY connections
186 * @param thename Name of the connect class
187 * @param hst The IP mask to deny
189 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
190 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)
194 /* Create a new connect class based on another class
195 * @param thename The name of the connect class
196 * @param source Another connect class to inherit all but the name from
198 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
199 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
200 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
201 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
202 port(source->port), RefCount(0), disabled(false), limit(source->limit)
206 void SetDisabled(bool t)
213 return this->disabled;
216 /* Update an existing entry with new values
218 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
219 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
220 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
223 registration_timeout = timeout;
247 this->limit = llimit;
250 void Update(const std::string &n, const std::string &hst)
256 /** Reference counter. Contains an int as to how many users are connected to this class. :)
257 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
258 * are 0 users on it - it will go away in RAM. :)
260 unsigned long RefCount;
262 /** 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
266 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
275 /** Returns the type, CC_ALLOW or CC_DENY
279 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
282 std::string& GetName()
287 /** Returns the registration timeout
289 unsigned int GetRegTimeout()
291 return (registration_timeout ? registration_timeout : 90);
294 /** Returns the flood limit
296 unsigned int GetFlood()
298 return (threshold ? flood : 999);
301 /** Returns the allowed or denied IP mask
303 const std::string& GetHost()
322 /** Returns the ping frequency
324 unsigned int GetPingTime()
326 return (pingtime ? pingtime : 120);
329 /** Returns the password or an empty string
331 const std::string& GetPass()
336 /** Returns the hash or an empty string
338 const std::string& GetHash()
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()
379 /** 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.
381 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
383 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
385 typedef std::vector<ConnectClass*> ClassVector;
387 /** Typedef for the list of user-channel records for a user
389 typedef std::map<Channel*, char> UserChanList;
391 /** Shorthand for an iterator into a UserChanList
393 typedef UserChanList::iterator UCListIter;
395 /* Required forward declaration
399 /** Visibility data for a user.
400 * If a user has a non-null instance of this class in their User,
401 * then it is used to determine if this user is visible to other users
404 class CoreExport VisData
410 /** Destroy a visdata
413 /** Is this user visible to some other user?
414 * @param user The other user to compare to
415 * @return true True if the user is visible to the other user, false if not
417 virtual bool VisibleTo(User* user);
420 /** Holds all information about a user
421 * This class stores all information about a user connected to the irc server. Everything about a
422 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
423 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
424 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
425 * file descriptor value.
427 class CoreExport User : public connection
430 /** Pointer to creator.
431 * This is required to make use of core functions
432 * from within the User class.
434 InspIRCd* ServerInstance;
436 /** A list of channels the user has a pending invite to.
437 * Upon INVITE channels are added, and upon JOIN, the
438 * channels are removed from this list.
442 /** Number of channels this user is currently on
444 unsigned int ChannelCount;
446 /** Cached nick!ident@host value using the real hostname
448 std::string cached_fullhost;
450 /** Cached nick!ident@ip value using the real IP address
452 std::string cached_hostip;
454 /** Cached nick!ident@host value using the masked hostname
456 std::string cached_makehost;
458 /** Cached nick!ident@realhost value using the real hostname
460 std::string cached_fullrealhost;
462 /** When we erase the user (in the destructor),
463 * we call this method to subtract one from all
464 * mode characters this user is making use of.
466 void DecrementModes();
468 /** Max channels for this user
470 unsigned int MaxChans;
472 std::map<std::string, bool>* AllowedOperCommands;
474 /** Allowed user modes from oper classes. */
475 bool* AllowedUserModes;
477 /** Allowed channel modes from oper classes. */
478 bool* AllowedChanModes;
481 /** Module responsible for raw i/o
485 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
486 * The pointer is guarenteed to *always* be valid. :)
488 ConnectClass *MyClass;
490 /** Resolvers for looking up this users IP address
491 * This will occur if and when res_reverse completes.
492 * When this class completes its lookup, User::dns_done
493 * will be set from false to true.
495 UserResolver* res_forward;
497 /** Resolvers for looking up this users hostname
498 * This is instantiated by User::StartDNSLookup(),
499 * and on success, instantiates User::res_reverse.
501 UserResolver* res_reverse;
503 /** User visibility state, see definition of VisData.
507 /** Stored reverse lookup from res_forward
509 std::string stored_host;
511 /** Starts a DNS lookup of the user's IP.
512 * This will cause two UserResolver classes to be instantiated.
513 * When complete, these objects set User::dns_done to true.
515 void StartDNSLookup();
517 unsigned int GetMaxChans();
519 /** The users nickname.
520 * An invalid nickname indicates an unregistered connection prior to the NICK command.
521 * Use InspIRCd::IsNick() to validate nicknames.
525 /** The user's unique identifier.
526 * This is the unique identifier which the user has across the network.
530 /** The users ident reply.
531 * Two characters are added to the user-defined limit to compensate for the tilde etc.
535 /** The host displayed to non-opers (used for cloaking etc).
536 * This usually matches the value of User::host.
540 /** The users full name (GECOS).
542 std::string fullname;
544 /** The user's mode list.
545 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
546 * this is an array of values in a similar way to channel modes.
547 * A value of 1 in field (modeletter-65) indicates that the mode is
548 * set, for example, to work out if mode +s is set, we check the field
549 * User::modes['s'-65] != 0.
550 * The following RFC characters o, w, s, i have constants defined via an
551 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
553 unsigned char modes[64];
555 /** What snomasks are set on this user.
556 * This functions the same as the above modes.
558 unsigned char snomasks[64];
560 /** Channels this user is on, and the permissions they have there
564 /** The server the user is connected to.
568 /** The user's away message.
569 * If this string is empty, the user is not marked as away.
573 /** Time the user last went away.
574 * This is ONLY RELIABLE if user IS_AWAY()!
578 /** Timestamp of current time + connection class timeout.
579 * This user must send USER/NICK before this timestamp is
580 * reached or they will be disconnected.
584 /** The oper type they logged in as, if they are an oper.
585 * This is used to check permissions in operclasses, so that
586 * we can say 'yay' or 'nay' to any commands they issue.
587 * The value of this is the value of a valid 'type name=' tag.
591 /** True when DNS lookups are completed.
592 * The UserResolver classes res_forward and res_reverse will
593 * set this value once they complete.
597 /** Password specified by the user when they registered.
598 * This is stored even if the <connect> block doesnt need a password, so that
599 * modules may check it.
601 std::string password;
603 /** User's receive queue.
604 * Lines from the IRCd awaiting processing are stored here.
605 * Upgraded april 2005, old system a bit hairy.
609 /** How many bytes are currently in the user's sendq.
611 unsigned long sendqlength;
612 /** List of pointers to buffer objects, this is the actual user's sendq.
614 std::list<LineBuffer*, __gnu_cxx::new_allocator<LineBuffer*> > sendq;
615 /** How far into the current sendq line is the user?
617 unsigned long sendqpos;
619 /** Message user will quit with. Not to be set externally.
623 /** Quit message shown to opers - not to be set externally.
625 std::string operquitmsg;
627 /** Whether or not to send an snotice about this user's quitting
631 /** Flood counters - lines received
633 unsigned int lines_in;
635 /** Flood counters - time lines_in is due to be reset
639 /** If this is set to true, then all socket operations for the user
640 * are dropped into the bit-bucket.
641 * This value is set by QuitUser, and is not needed seperately from that call.
642 * Please note that setting this value alone will NOT cause the user to quit.
646 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
647 * GetIPString/GetPort to obtain its values.
651 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
653 std::string cachedip;
655 /** Initialize the clients sockaddr
656 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
657 * @param ip A human-readable IP address for this user matching the protcol_family
658 * @param port The port number of this user or zero for a remote user
660 void SetSockAddr(int protocol_family, const char* ip, int port);
662 /** Get port number from sockaddr
663 * @return The port number of this user.
667 /** Get protocol family from sockaddr
668 * @return The protocol family of this user, either AF_INET or AF_INET6
670 int GetProtocolFamily();
672 /** Get IP string from sockaddr, using static internal buffer
673 * @return The IP string
675 const char* GetIPString(bool translate4in6 = true);
677 /* Write error string
679 std::string WriteError;
681 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
685 /** This value contains how far into the penalty threshold the user is. Once its over
686 * the penalty threshold then commands are held and processed on-timer.
690 /** True if we are flushing penalty lines
694 /** If this bool is set then penalty rules do not apply to this user
696 bool ExemptFromPenalty;
698 /** Default constructor
699 * @throw CoreException if the UID allocated to the user already exists
700 * @param Instance Creator instance
701 * @param uid User UUID, or empty to allocate one automatically
703 User(InspIRCd* Instance, const std::string &uid = "");
705 /** Check if the user matches a G or K line, and disconnect them if they do
709 /** Returns the full displayed host of the user
710 * This member function returns the hostname of the user as seen by other users
711 * on the server, in nick!ident&at;host form.
712 * @return The full masked host of the user
714 virtual const std::string& GetFullHost();
716 /** Returns the full real host of the user
717 * This member function returns the hostname of the user as seen by other users
718 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
719 * e.g. through a module, then this method will ignore it and return the true hostname.
720 * @return The full real host of the user
722 virtual const std::string& GetFullRealHost();
724 /** This clears any cached results that are used for GetFullRealHost() etc.
725 * The results of these calls are cached as generating them can be generally expensive.
727 void InvalidateCache();
729 /** Create a displayable mode string for this users snomasks
730 * @return The notice mask character sequence
732 const char* FormatNoticeMasks();
734 /** Process a snomask modifier string, e.g. +abc-de
735 * @param sm A sequence of notice mask characters
736 * @return The cleaned mode sequence which can be output,
737 * e.g. in the above example if masks c and e are not
738 * valid, this function will return +ab-d
740 std::string ProcessNoticeMasks(const char *sm);
742 /** Returns true if a notice mask is set
743 * @param sm A notice mask character to check
744 * @return True if the notice mask is set
746 bool IsNoticeMaskSet(unsigned char sm);
748 /** Changed a specific notice mask value
749 * @param sm The server notice mask to change
750 * @param value An on/off value for this mask
752 void SetNoticeMask(unsigned char sm, bool value);
754 /** Create a displayable mode string for this users umodes
755 * @param The mode string
757 const char* FormatModes();
759 /** Returns true if a specific mode is set
760 * @param m The user mode
761 * @return True if the mode is set
763 bool IsModeSet(unsigned char m);
765 /** Set a specific usermode to on or off
766 * @param m The user mode
767 * @param value On or off setting of the mode
769 void SetMode(unsigned char m, bool value);
771 /** Returns true if a user is invited to a channel.
772 * @param channel A channel name to look up
773 * @return True if the user is invited to the given channel
775 virtual bool IsInvited(const irc::string &channel);
777 /** Adds a channel to a users invite list (invites them to a channel)
778 * @param channel A channel name to add
779 * @param timeout When the invite should expire (0 == never)
781 virtual void InviteTo(const irc::string &channel, time_t timeout);
783 /** Removes a channel from a users invite list.
784 * This member function is called on successfully joining an invite only channel
785 * to which the user has previously been invited, to clear the invitation.
786 * @param channel The channel to remove the invite to
788 virtual void RemoveInvite(const irc::string &channel);
790 /** Returns true or false for if a user can execute a privilaged oper command.
791 * This is done by looking up their oper type from User::oper, then referencing
792 * this to their oper classes and checking the commands they can execute.
793 * @param command A command (should be all CAPS)
794 * @return True if this user can execute the command
796 bool HasPermission(const std::string &command);
798 /** Returns true or false if a user can set a privileged user or channel mode.
799 * This is done by looking up their oper type from User::oper, then referencing
800 * this to their oper classes, and checking the modes they can set.
801 * @param mode The mode the check
802 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
803 * @return True if the user can set or unset this mode.
805 bool HasModePermission(unsigned char mode, ModeType type);
807 /** Calls read() to read some data for this user using their fd.
808 * @param buffer The buffer to read into
809 * @param size The size of data to read
810 * @return The number of bytes read, or -1 if an error occured.
812 int ReadData(void* buffer, size_t size);
814 /** This method adds data to the read buffer of the user.
815 * The buffer can grow to any size within limits of the available memory,
816 * managed by the size of a std::string, however if any individual line in
817 * the buffer grows over 600 bytes in length (which is 88 chars over the
818 * RFC-specified limit per line) then the method will return false and the
819 * text will not be inserted.
820 * @param a The string to add to the users read buffer
821 * @return True if the string was successfully added to the read buffer
823 bool AddBuffer(const std::string &a);
825 /** This method returns true if the buffer contains at least one carriage return
826 * character (e.g. one complete line may be read)
827 * @return True if there is at least one complete line in the users buffer
829 bool BufferIsReady();
831 /** This function clears the entire buffer by setting it to an empty string.
835 /** This method returns the first available string at the tail end of the buffer
836 * and advances the tail end of the buffer past the string. This means it is
837 * a one way operation in a similar way to strtok(), and multiple calls return
838 * multiple lines if they are available. The results of this function if there
839 * are no lines to be read are unknown, always use BufferIsReady() to check if
840 * it is ok to read the buffer before calling GetBuffer().
841 * @return The string at the tail end of this users buffer
843 std::string GetBuffer();
845 /** Sets the write error for a connection. This is done because the actual disconnect
846 * of a client may occur at an inopportune time such as half way through /LIST output.
847 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
848 * errored clients purged.
849 * @param error The error string to set.
851 void SetWriteError(const std::string &error);
853 /** Returns the write error which last occured on this connection or an empty string
855 * @return The error string which has occured for this user
857 const char* GetWriteError();
859 /** Adds a line buffer to the user's sendq.
860 * You may add any amount of text up to this users sendq value, if you exceed the
861 * sendq value, SetWriteError() will be called to set the users error string to
862 * "SendQ exceeded", and further buffer adds will be dropped.
863 * @param data The data to add to the write buffer
865 void AddWriteBuf(LineBuffer *l);
867 /** Flushes as much of the user's buffer to the file descriptor as possible.
868 * This function may not always flush the entire buffer, rather instead as much of it
869 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
870 * position is advanced forwards and the rest of the data sent at the next call to
873 void FlushWriteBuf();
875 /** Returns the list of channels this user has been invited to but has not yet joined.
876 * @return A list of channels the user is invited to
878 InvitedList* GetInviteList();
880 /** Creates a wildcard host.
881 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
882 * @return The wildcarded hostname in *!*@host form
884 char* MakeWildHost();
886 /** Creates a usermask with real host.
887 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
888 * @return the usermask in the format user@host
890 const std::string& MakeHost();
892 /** Creates a usermask with real ip.
893 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
894 * @return the usermask in the format user@ip
896 const std::string& MakeHostIP();
898 /** Shuts down and closes the user's socket
899 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
900 * which will call CloseSocket() for you.
904 /** Add the user to WHOWAS system
908 /** Oper up the user using the given opertype.
909 * This will also give the +o usermode.
910 * @param opertype The oper type to oper as
912 void Oper(const std::string &opertype, const std::string &opername);
914 /** Call this method to find the matching <connect> for a user, and to check them against it.
918 /** Use this method to fully connect a user.
919 * This will send the message of the day, check G/K/E lines, etc.
923 /** Change this users hash key to a new string.
924 * You should not call this function directly. It is used by the core
925 * to update the users hash entry on a nickchange.
926 * @param New new user_hash key
927 * @return Pointer to User in hash (usually 'this')
929 User* UpdateNickHash(const char* New);
931 /** Force a nickname change.
932 * If the nickname change fails (for example, because the nick in question
933 * already exists) this function will return false, and you must then either
934 * output an error message, or quit the user for nickname collision.
935 * @param newnick The nickname to change to
936 * @return True if the nickchange was successful.
938 bool ForceNickChange(const char* newnick);
941 * This will clear the +o usermode and unset the user's oper type
945 /** Write text to this user, appending CR/LF.
946 * @param text A std::string to send to the user
948 void Write(std::string text);
950 /** Write text to this user, appending CR/LF.
951 * @param text The format string for text to send to the user
952 * @param ... POD-type format arguments
954 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
956 /** Write text to this user, appending CR/LF and prepending :server.name
957 * @param text A std::string to send to the user
959 void WriteServ(const std::string& text);
961 /** Write text to this user, appending CR/LF and prepending :server.name
962 * @param text The format string for text to send to the user
963 * @param ... POD-type format arguments
965 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
967 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
969 void WriteNumeric(unsigned int numeric, const std::string &text);
971 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
972 * @param user The user to prepend the :nick!user@host of
973 * @param text A std::string to send to the user
975 void WriteFrom(User *user, const std::string &text);
977 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
978 * @param user The user to prepend the :nick!user@host of
979 * @param text The format string for text to send to the user
980 * @param ... POD-type format arguments
982 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
984 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
985 * @param dest The user to route the message to
986 * @param text A std::string to send to the user
988 void WriteTo(User *dest, const std::string &data);
990 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
991 * @param dest The user to route the message to
992 * @param text The format string for text to send to the user
993 * @param ... POD-type format arguments
995 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
997 /** Write to all users that can see this user (including this user in the list), appending CR/LF
998 * @param text A std::string to send to the users
1000 void WriteCommon(const std::string &text);
1002 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1003 * @param text The format string for text to send to the users
1004 * @param ... POD-type format arguments
1006 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
1008 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1009 * @param text The format string for text to send to the users
1010 * @param ... POD-type format arguments
1012 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
1014 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1015 * @param text A std::string to send to the users
1017 void WriteCommonExcept(const std::string &text);
1019 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1020 * quit message for opers only.
1021 * @param normal_text Normal user quit message
1022 * @param oper_text Oper only quit message
1024 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1026 /** Write a WALLOPS message from this user to all local opers.
1027 * If this user is not opered, the function will return without doing anything.
1028 * @param text The format string to send in the WALLOPS message
1029 * @param ... Format arguments
1031 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
1033 /** Write a WALLOPS message from this user to all local opers.
1034 * If this user is not opered, the function will return without doing anything.
1035 * @param text The text to send in the WALLOPS message
1037 void WriteWallOps(const std::string &text);
1039 /** Return true if the user shares at least one channel with another user
1040 * @param other The other user to compare the channel list against
1041 * @return True if the given user shares at least one channel with this user
1043 bool SharesChannelWith(User *other);
1045 /** Change the displayed host of a user.
1046 * ALWAYS use this function, rather than writing User::dhost directly,
1047 * as this triggers module events allowing the change to be syncronized to
1048 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1049 * before setting their host field.
1050 * @param host The new hostname to set
1051 * @return True if the change succeeded, false if it didn't
1053 bool ChangeDisplayedHost(const char* host);
1055 /** Change the ident (username) of a user.
1056 * ALWAYS use this function, rather than writing User::ident directly,
1057 * as this correctly causes the user to seem to quit (where configured)
1058 * before setting their ident field.
1059 * @param host The new ident to set
1060 * @return True if the change succeeded, false if it didn't
1062 bool ChangeIdent(const char* newident);
1064 /** Change a users realname field.
1065 * ALWAYS use this function, rather than writing User::fullname directly,
1066 * as this triggers module events allowing the change to be syncronized to
1068 * @param gecos The user's new realname
1069 * @return True if the change succeeded, false if otherwise
1071 bool ChangeName(const char* gecos);
1073 /** Send a command to all local users from this user
1074 * The command given must be able to send text with the
1075 * first parameter as a servermask (e.g. $*), so basically
1076 * you should use PRIVMSG or NOTICE.
1077 * @param command the command to send
1078 * @param text The text format string to send
1079 * @param ... Format arguments
1081 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
1083 /** Compile a channel list for this user, and send it to the user 'source'
1084 * Used internally by WHOIS
1085 * @param The user to send the channel list to if it is not too long
1086 * @return This user's channel list
1088 std::string ChannelList(User* source);
1090 /** Split the channel list in cl which came from dest, and spool it to this user
1091 * Used internally by WHOIS
1092 * @param dest The user the original channel list came from
1093 * @param cl The channel list as a string obtained from User::ChannelList()
1095 void SplitChanList(User* dest, const std::string &cl);
1097 /** Remove this user from all channels they are on, and delete any that are now empty.
1098 * This is used by QUIT, and will not send part messages!
1100 void PurgeEmptyChannels();
1102 /** Get the connect class which this user belongs to.
1103 * @return A pointer to this user's connect class
1105 ConnectClass *GetClass();
1107 /** Set the connect class to which this user belongs to.
1108 * @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.
1109 * @return A reference to this user's current connect class.
1111 ConnectClass *SetClass(const std::string &explicit_name = "");
1113 /** Show the message of the day to this user
1117 /** Show the server RULES file to this user
1121 /** Set oper-specific quit message shown to opers only when the user quits
1122 * (overrides any sent by QuitUser)
1124 void SetOperQuit(const std::string &oquit);
1126 /** Get oper-specific quit message shown only to opers when the user quits.
1127 * (overrides any sent by QuitUser)
1129 const std::string& GetOperQuit();
1131 /** Increases a user's command penalty by a set amount.
1133 void IncreasePenalty(int increase);
1135 /** Decreases a user's command penalty by a set amount.
1137 void DecreasePenalty(int decrease);
1139 /** Handle socket event.
1140 * From EventHandler class.
1141 * @param et Event type
1142 * @param errornum Error number for EVENT_ERROR events
1144 void HandleEvent(EventType et, int errornum = 0);
1146 /** Default destructor
1151 /** Derived from Resolver, and performs user forward/reverse lookups.
1153 class CoreExport UserResolver : public Resolver
1156 /** User this class is 'attached' to.
1159 /** File descriptor teh lookup is bound to
1162 /** True if the lookup is forward, false if is a reverse lookup
1166 /** Create a resolver.
1167 * @param Instance The creating instance
1168 * @param user The user to begin lookup on
1169 * @param to_resolve The IP or host to resolve
1170 * @param qt The query type
1171 * @param cache Modified by the constructor if the result was cached
1173 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1175 /** Called on successful lookup
1176 * @param result Result string
1177 * @param ttl Time to live for result
1178 * @param cached True if the result was found in the cache
1179 * @param resultnum Result number, we are only interested in result 0
1181 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
1183 /** Called on failed lookup
1184 * @param e Error code
1185 * @param errormessage Error message string
1187 void OnError(ResolverError e, const std::string &errormessage);
1190 /* Configuration callbacks */
1191 //class ServerConfig;