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 notice mask */
48 UM_SNOMASK = 's' - 65,
50 UM_WALLOPS = 'w' - 65,
52 UM_INVISIBLE = 'i' - 65,
54 UM_OPERATOR = 'o' - 65
57 /** Registration state of a user, e.g.
58 * have they sent USER, NICK, PASS yet?
60 enum RegistrationState {
62 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
63 REG_NONE = 0, /* Has sent nothing */
66 REG_USER = 1, /* Has sent USER */
67 REG_NICK = 2, /* Has sent NICK */
68 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
69 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
72 /* Required forward declaration */
76 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
78 class CoreExport ConnectClass : public classbase
81 /** Type of line, either CC_ALLOW or CC_DENY
84 /** Connect class name
87 /** Max time to register the connection in seconds
89 unsigned int registration_timeout;
90 /** Number of lines in buffer before excess flood is triggered
93 /** Host mask for this line
96 /** Number of seconds between pings for this line
98 unsigned int pingtime;
99 /** (Optional) Password for this line
103 /** (Optional) Hash Method for this line
107 /** Threshold value for flood disconnect
109 unsigned int threshold;
111 /** Maximum size of sendq for users in this class (bytes)
113 unsigned long sendqmax;
115 /** Maximum size of recvq for users in this class (bytes)
117 unsigned long recvqmax;
119 /** Local max when connecting by this connection class
121 unsigned long maxlocal;
123 /** Global max when connecting by this connection class
125 unsigned long maxglobal;
127 /** Max channels for this class
129 unsigned int maxchans;
131 /** Port number this connect class applies to
137 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
139 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
140 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
141 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
142 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
143 port(source->port), RefCount(0), disabled(false), limit(source->limit)
147 /** Create a new connect class with no settings.
149 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
150 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
154 /** Create a new connect class to ALLOW connections.
155 * @param thename Name of the connect class
156 * @param timeout The registration timeout
157 * @param fld The flood value
158 * @param hst The IP mask to allow
159 * @param ping The ping frequency
160 * @param pas The password to be used
161 * @param hsh The hash to be used
162 * @param thres The flooding threshold
163 * @param sendq The maximum sendq value
164 * @param recvq The maximum recvq value
165 * @param maxl The maximum local sessions
166 * @param maxg The maximum global sessions
168 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
169 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
170 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
171 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
172 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
174 /** Create a new connect class to DENY connections
175 * @param thename Name of the connect class
176 * @param hst The IP mask to deny
178 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
179 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)
183 /* Create a new connect class based on another class
184 * @param thename The name of the connect class
185 * @param source Another connect class to inherit all but the name from
187 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
188 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
189 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
190 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
191 port(source->port), RefCount(0), disabled(false), limit(source->limit)
195 void SetDisabled(bool t)
202 return this->disabled;
205 /* Update an existing entry with new values
207 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
208 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
209 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
212 registration_timeout = timeout;
236 this->limit = llimit;
239 void Update(const std::string &n, const std::string &hst)
245 /** Reference counter. Contains an int as to how many users are connected to this class. :)
246 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
247 * are 0 users on it - it will go away in RAM. :)
249 unsigned long RefCount;
251 /** 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
255 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
264 /** Returns the type, CC_ALLOW or CC_DENY
268 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
271 std::string& GetName()
276 /** Returns the registration timeout
278 time_t GetRegTimeout()
280 return (registration_timeout ? registration_timeout : 90);
283 /** Returns the flood limit
285 unsigned int GetFlood()
287 return (threshold ? flood : 999);
290 /** Returns the allowed or denied IP mask
292 const std::string& GetHost()
311 /** Returns the ping frequency
313 unsigned int GetPingTime()
315 return (pingtime ? pingtime : 120);
318 /** Returns the password or an empty string
320 const std::string& GetPass()
325 /** Returns the hash or an empty string
327 const std::string& GetHash()
332 /** Returns the flood threshold value
334 unsigned int GetThreshold()
336 return (threshold ? threshold : 1);
339 /** Returns the maximum sendq value
341 unsigned long GetSendqMax()
343 return (sendqmax ? sendqmax : 262114);
346 /** Returns the maximum recvq value
348 unsigned long GetRecvqMax()
350 return (recvqmax ? recvqmax : 4096);
353 /** Returusn the maximum number of local sessions
355 unsigned long GetMaxLocal()
360 /** Returns the maximum number of global sessions
362 unsigned long GetMaxGlobal()
368 /** 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.
370 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
372 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
374 typedef std::vector<ConnectClass*> ClassVector;
376 /** Typedef for the list of user-channel records for a user
378 typedef std::map<Channel*, char> UserChanList;
380 /** Shorthand for an iterator into a UserChanList
382 typedef UserChanList::iterator UCListIter;
384 /* Required forward declaration
388 /** Visibility data for a user.
389 * If a user has a non-null instance of this class in their User,
390 * then it is used to determine if this user is visible to other users
393 class CoreExport VisData
399 /** Destroy a visdata
402 /** Is this user visible to some other user?
403 * @param user The other user to compare to
404 * @return true True if the user is visible to the other user, false if not
406 virtual bool VisibleTo(User* user);
409 /** Holds all information about a user
410 * This class stores all information about a user connected to the irc server. Everything about a
411 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
412 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
413 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
414 * file descriptor value.
416 class CoreExport User : public connection
419 /** Pointer to creator.
420 * This is required to make use of core functions
421 * from within the User class.
423 InspIRCd* ServerInstance;
425 /** A list of channels the user has a pending invite to.
426 * Upon INVITE channels are added, and upon JOIN, the
427 * channels are removed from this list.
431 /** Cached nick!ident@host value using the real hostname
433 std::string cached_fullhost;
435 /** Cached nick!ident@ip value using the real IP address
437 std::string cached_hostip;
439 /** Cached nick!ident@host value using the masked hostname
441 std::string cached_makehost;
443 /** Cached nick!ident@realhost value using the real hostname
445 std::string cached_fullrealhost;
447 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
449 std::string cachedip;
451 /** When we erase the user (in the destructor),
452 * we call this method to subtract one from all
453 * mode characters this user is making use of.
455 void DecrementModes();
457 std::map<std::string, bool>* AllowedOperCommands;
459 /** Allowed user modes from oper classes. */
460 bool* AllowedUserModes;
462 /** Allowed channel modes from oper classes. */
463 bool* AllowedChanModes;
466 /** Module responsible for raw i/o
470 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
471 * The pointer is guarenteed to *always* be valid. :)
473 ConnectClass *MyClass;
475 /** User visibility state, see definition of VisData.
479 /** Stored reverse lookup from res_forward
481 std::string stored_host;
483 /** Starts a DNS lookup of the user's IP.
484 * This will cause two UserResolver classes to be instantiated.
485 * When complete, these objects set User::dns_done to true.
487 void StartDNSLookup();
489 /** The users nickname.
490 * An invalid nickname indicates an unregistered connection prior to the NICK command.
491 * Use InspIRCd::IsNick() to validate nicknames.
495 /** The user's unique identifier.
496 * This is the unique identifier which the user has across the network.
500 /** The users ident reply.
501 * Two characters are added to the user-defined limit to compensate for the tilde etc.
505 /** The host displayed to non-opers (used for cloaking etc).
506 * This usually matches the value of User::host.
510 /** The users full name (GECOS).
512 std::string fullname;
514 /** The user's mode list.
515 * NOT a null terminated string.
517 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
518 * if (modes[modeletter-65]) is set, then the mode is
519 * set, for example, to work out if mode +s is set, we check the field
520 * User::modes['s'-65] != 0.
521 * The following RFC characters o, w, s, i have constants defined via an
522 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
524 std::bitset<64> modes;
526 /** What snomasks are set on this user.
527 * This functions the same as the above modes.
529 std::bitset<64> snomasks;
531 /** Channels this user is on, and the permissions they have there
535 /** The server the user is connected to.
539 /** The user's away message.
540 * If this string is empty, the user is not marked as away.
544 /** Time the user last went away.
545 * This is ONLY RELIABLE if user IS_AWAY()!
549 /** The oper type they logged in as, if they are an oper.
550 * This is used to check permissions in operclasses, so that
551 * we can say 'yay' or 'nay' to any commands they issue.
552 * The value of this is the value of a valid 'type name=' tag.
556 /** True when DNS lookups are completed.
557 * The UserResolver classes res_forward and res_reverse will
558 * set this value once they complete.
562 /** Password specified by the user when they registered.
563 * This is stored even if the <connect> block doesnt need a password, so that
564 * modules may check it.
566 std::string password;
568 /** User's receive queue.
569 * Lines from the IRCd awaiting processing are stored here.
570 * Upgraded april 2005, old system a bit hairy.
574 /** User's send queue.
575 * Lines waiting to be sent are stored here until their buffer is flushed.
579 /** Message user will quit with. Not to be set externally.
583 /** Quit message shown to opers - not to be set externally.
585 std::string operquitmsg;
587 /** Whether or not to send an snotice about this user's quitting
591 /** Flood counters - lines received
593 unsigned int lines_in;
595 /** Flood counters - time lines_in is due to be reset
599 /** If this is set to true, then all socket operations for the user
600 * are dropped into the bit-bucket.
601 * This value is set by QuitUser, and is not needed seperately from that call.
602 * Please note that setting this value alone will NOT cause the user to quit.
606 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
607 * GetIPString/GetPort to obtain its values.
611 /** Initialize the clients sockaddr
612 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
613 * @param ip A human-readable IP address for this user matching the protcol_family
614 * @param port The port number of this user or zero for a remote user
616 void SetSockAddr(int protocol_family, const char* ip, int port);
618 /** Get port number from sockaddr
619 * @return The port number of this user.
623 /** Get protocol family from sockaddr
624 * @return The protocol family of this user, either AF_INET or AF_INET6
626 int GetProtocolFamily();
628 /** Get IP string from sockaddr, using static internal buffer
629 * @return The IP string
631 const char* GetIPString(bool translate4in6 = true);
633 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
634 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
635 * This may be used for CIDR clone detection, etc.
637 * (XXX, brief note: when we do the sockets rewrite, this should move down a
638 * level so it may be used on more derived objects. -- w00t)
640 const char *GetCIDRMask(int range);
642 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
646 /** This value contains how far into the penalty threshold the user is. Once its over
647 * the penalty threshold then commands are held and processed on-timer.
651 /** True if we are flushing penalty lines
655 /** If this bool is set then penalty rules do not apply to this user
657 bool ExemptFromPenalty;
659 /** Default constructor
660 * @throw CoreException if the UID allocated to the user already exists
661 * @param Instance Creator instance
662 * @param uid User UUID, or empty to allocate one automatically
664 User(InspIRCd* Instance, const std::string &uid = "");
666 /** Check if the user matches a G or K line, and disconnect them if they do.
667 * Returns true if the user matched a ban, false else.
671 /** Returns the full displayed host of the user
672 * This member function returns the hostname of the user as seen by other users
673 * on the server, in nick!ident&at;host form.
674 * @return The full masked host of the user
676 virtual const std::string& GetFullHost();
678 /** Returns the full real host of the user
679 * This member function returns the hostname of the user as seen by other users
680 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
681 * e.g. through a module, then this method will ignore it and return the true hostname.
682 * @return The full real host of the user
684 virtual const std::string& GetFullRealHost();
686 /** This clears any cached results that are used for GetFullRealHost() etc.
687 * The results of these calls are cached as generating them can be generally expensive.
689 void InvalidateCache();
691 /** Create a displayable mode string for this users snomasks
692 * @return The notice mask character sequence
694 const char* FormatNoticeMasks();
696 /** Process a snomask modifier string, e.g. +abc-de
697 * @param sm A sequence of notice mask characters
698 * @return The cleaned mode sequence which can be output,
699 * e.g. in the above example if masks c and e are not
700 * valid, this function will return +ab-d
702 std::string ProcessNoticeMasks(const char *sm);
704 /** Returns true if a notice mask is set
705 * @param sm A notice mask character to check
706 * @return True if the notice mask is set
708 bool IsNoticeMaskSet(unsigned char sm);
710 /** Changed a specific notice mask value
711 * @param sm The server notice mask to change
712 * @param value An on/off value for this mask
714 void SetNoticeMask(unsigned char sm, bool value);
716 /** Create a displayable mode string for this users umodes
717 * @param The mode string
719 const char* FormatModes(bool showparameters = false);
721 /** Returns true if a specific mode is set
722 * @param m The user mode
723 * @return True if the mode is set
725 bool IsModeSet(unsigned char m);
727 /** Set a specific usermode to on or off
728 * @param m The user mode
729 * @param value On or off setting of the mode
731 void SetMode(unsigned char m, bool value);
733 /** Returns true if a user is invited to a channel.
734 * @param channel A channel name to look up
735 * @return True if the user is invited to the given channel
737 virtual bool IsInvited(const irc::string &channel);
739 /** Adds a channel to a users invite list (invites them to a channel)
740 * @param channel A channel name to add
741 * @param timeout When the invite should expire (0 == never)
743 virtual void InviteTo(const irc::string &channel, time_t timeout);
745 /** Removes a channel from a users invite list.
746 * This member function is called on successfully joining an invite only channel
747 * to which the user has previously been invited, to clear the invitation.
748 * @param channel The channel to remove the invite to
750 virtual void RemoveInvite(const irc::string &channel);
752 /** Returns true or false for if a user can execute a privilaged oper command.
753 * This is done by looking up their oper type from User::oper, then referencing
754 * this to their oper classes and checking the commands they can execute.
755 * @param command A command (should be all CAPS)
756 * @return True if this user can execute the command
758 bool HasPermission(const std::string &command);
760 /** Returns true or false if a user can set a privileged user or channel mode.
761 * This is done by looking up their oper type from User::oper, then referencing
762 * this to their oper classes, and checking the modes they can set.
763 * @param mode The mode the check
764 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
765 * @return True if the user can set or unset this mode.
767 bool HasModePermission(unsigned char mode, ModeType type);
769 /** Calls read() to read some data for this user using their fd.
770 * @param buffer The buffer to read into
771 * @param size The size of data to read
772 * @return The number of bytes read, or -1 if an error occured.
774 int ReadData(void* buffer, size_t size);
776 /** This method adds data to the read buffer of the user.
777 * The buffer can grow to any size within limits of the available memory,
778 * managed by the size of a std::string, however if any individual line in
779 * the buffer grows over 600 bytes in length (which is 88 chars over the
780 * RFC-specified limit per line) then the method will return false and the
781 * text will not be inserted.
782 * @param a The string to add to the users read buffer
783 * @return True if the string was successfully added to the read buffer
785 bool AddBuffer(const std::string &a);
787 /** This method returns true if the buffer contains at least one carriage return
788 * character (e.g. one complete line may be read)
789 * @return True if there is at least one complete line in the users buffer
791 bool BufferIsReady();
793 /** This function clears the entire buffer by setting it to an empty string.
797 /** This method returns the first available string at the tail end of the buffer
798 * and advances the tail end of the buffer past the string. This means it is
799 * a one way operation in a similar way to strtok(), and multiple calls return
800 * multiple lines if they are available. The results of this function if there
801 * are no lines to be read are unknown, always use BufferIsReady() to check if
802 * it is ok to read the buffer before calling GetBuffer().
803 * @return The string at the tail end of this users buffer
805 std::string GetBuffer();
807 /** Adds to the user's write buffer.
808 * You may add any amount of text up to this users sendq value, if you exceed the
809 * sendq value, the user will be removed, and further buffer adds will be dropped.
810 * @param data The data to add to the write buffer
812 void AddWriteBuf(const std::string &data);
814 /** Flushes as much of the user's buffer to the file descriptor as possible.
815 * This function may not always flush the entire buffer, rather instead as much of it
816 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
817 * position is advanced forwards and the rest of the data sent at the next call to
820 void FlushWriteBuf();
822 /** Returns the list of channels this user has been invited to but has not yet joined.
823 * @return A list of channels the user is invited to
825 InvitedList* GetInviteList();
827 /** Creates a wildcard host.
828 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
829 * @return The wildcarded hostname in *!*@host form
831 char* MakeWildHost();
833 /** Creates a usermask with real host.
834 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
835 * @return the usermask in the format user@host
837 const std::string& MakeHost();
839 /** Creates a usermask with real ip.
840 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
841 * @return the usermask in the format user@ip
843 const std::string& MakeHostIP();
845 /** Shuts down and closes the user's socket
846 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
847 * which will call CloseSocket() for you.
851 /** Add the user to WHOWAS system
855 /** Oper up the user using the given opertype.
856 * This will also give the +o usermode.
857 * @param opertype The oper type to oper as
859 void Oper(const std::string &opertype, const std::string &opername);
861 /** Call this method to find the matching <connect> for a user, and to check them against it.
865 /** Use this method to fully connect a user.
866 * This will send the message of the day, check G/K/E lines, etc.
870 /** Change this users hash key to a new string.
871 * You should not call this function directly. It is used by the core
872 * to update the users hash entry on a nickchange.
873 * @param New new user_hash key
874 * @return Pointer to User in hash (usually 'this')
876 User* UpdateNickHash(const char* New);
878 /** Force a nickname change.
879 * If the nickname change fails (for example, because the nick in question
880 * already exists) this function will return false, and you must then either
881 * output an error message, or quit the user for nickname collision.
882 * @param newnick The nickname to change to
883 * @return True if the nickchange was successful.
885 bool ForceNickChange(const char* newnick);
888 * This will clear the +o usermode and unset the user's oper type
892 /** Write text to this user, appending CR/LF.
893 * @param text A std::string to send to the user
895 void Write(std::string text);
897 /** Write text to this user, appending CR/LF.
898 * @param text The format string for text to send to the user
899 * @param ... POD-type format arguments
901 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
903 /** Write text to this user, appending CR/LF and prepending :server.name
904 * @param text A std::string to send to the user
906 void WriteServ(const std::string& text);
908 /** Write text to this user, appending CR/LF and prepending :server.name
909 * @param text The format string for text to send to the user
910 * @param ... POD-type format arguments
912 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
914 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
916 void WriteNumeric(unsigned int numeric, const std::string &text);
918 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
919 * @param user The user to prepend the :nick!user@host of
920 * @param text A std::string to send to the user
922 void WriteFrom(User *user, const std::string &text);
924 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
925 * @param user The user to prepend the :nick!user@host of
926 * @param text The format string for text to send to the user
927 * @param ... POD-type format arguments
929 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
931 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
932 * @param dest The user to route the message to
933 * @param text A std::string to send to the user
935 void WriteTo(User *dest, const std::string &data);
937 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
938 * @param dest The user to route the message to
939 * @param text The format string for text to send to the user
940 * @param ... POD-type format arguments
942 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
944 /** Write to all users that can see this user (including this user in the list), appending CR/LF
945 * @param text A std::string to send to the users
947 void WriteCommon(const std::string &text);
949 /** Write to all users that can see this user (including this user in the list), appending CR/LF
950 * @param text The format string for text to send to the users
951 * @param ... POD-type format arguments
953 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
955 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
956 * @param text The format string for text to send to the users
957 * @param ... POD-type format arguments
959 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
961 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
962 * @param text A std::string to send to the users
964 void WriteCommonExcept(const std::string &text);
966 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
967 * quit message for opers only.
968 * @param normal_text Normal user quit message
969 * @param oper_text Oper only quit message
971 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
973 /** Write a WALLOPS message from this user to all local opers.
974 * If this user is not opered, the function will return without doing anything.
975 * @param text The format string to send in the WALLOPS message
976 * @param ... Format arguments
978 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
980 /** Write a WALLOPS message from this user to all local opers.
981 * If this user is not opered, the function will return without doing anything.
982 * @param text The text to send in the WALLOPS message
984 void WriteWallOps(const std::string &text);
986 /** Return true if the user shares at least one channel with another user
987 * @param other The other user to compare the channel list against
988 * @return True if the given user shares at least one channel with this user
990 bool SharesChannelWith(User *other);
992 /** Change the displayed host of a user.
993 * ALWAYS use this function, rather than writing User::dhost directly,
994 * as this triggers module events allowing the change to be syncronized to
995 * remote servers. This will also emulate a QUIT and rejoin (where configured)
996 * before setting their host field.
997 * @param host The new hostname to set
998 * @return True if the change succeeded, false if it didn't
1000 bool ChangeDisplayedHost(const char* host);
1002 /** Change the ident (username) of a user.
1003 * ALWAYS use this function, rather than writing User::ident directly,
1004 * as this correctly causes the user to seem to quit (where configured)
1005 * before setting their ident field.
1006 * @param host The new ident to set
1007 * @return True if the change succeeded, false if it didn't
1009 bool ChangeIdent(const char* newident);
1011 /** Change a users realname field.
1012 * ALWAYS use this function, rather than writing User::fullname directly,
1013 * as this triggers module events allowing the change to be syncronized to
1015 * @param gecos The user's new realname
1016 * @return True if the change succeeded, false if otherwise
1018 bool ChangeName(const char* gecos);
1020 /** Send a command to all local users from this user
1021 * The command given must be able to send text with the
1022 * first parameter as a servermask (e.g. $*), so basically
1023 * you should use PRIVMSG or NOTICE.
1024 * @param command the command to send
1025 * @param text The text format string to send
1026 * @param ... Format arguments
1028 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
1030 /** Compile a channel list for this user, and send it to the user 'source'
1031 * Used internally by WHOIS
1032 * @param The user to send the channel list to if it is not too long
1033 * @return This user's channel list
1035 std::string ChannelList(User* source);
1037 /** Split the channel list in cl which came from dest, and spool it to this user
1038 * Used internally by WHOIS
1039 * @param dest The user the original channel list came from
1040 * @param cl The channel list as a string obtained from User::ChannelList()
1042 void SplitChanList(User* dest, const std::string &cl);
1044 /** Remove this user from all channels they are on, and delete any that are now empty.
1045 * This is used by QUIT, and will not send part messages!
1047 void PurgeEmptyChannels();
1049 /** Get the connect class which this user belongs to.
1050 * @return A pointer to this user's connect class
1052 ConnectClass *GetClass();
1054 /** Set the connect class to which this user belongs to.
1055 * @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.
1056 * @return A reference to this user's current connect class.
1058 ConnectClass *SetClass(const std::string &explicit_name = "");
1060 /** Show the message of the day to this user
1064 /** Show the server RULES file to this user
1068 /** Set oper-specific quit message shown to opers only when the user quits
1069 * (overrides any sent by QuitUser)
1071 void SetOperQuit(const std::string &oquit);
1073 /** Get oper-specific quit message shown only to opers when the user quits.
1074 * (overrides any sent by QuitUser)
1076 const std::string& GetOperQuit();
1078 /** Increases a user's command penalty by a set amount.
1080 void IncreasePenalty(int increase);
1082 /** Decreases a user's command penalty by a set amount.
1084 void DecreasePenalty(int decrease);
1086 /** Handle socket event.
1087 * From EventHandler class.
1088 * @param et Event type
1089 * @param errornum Error number for EVENT_ERROR events
1091 void HandleEvent(EventType et, int errornum = 0);
1093 /** Default destructor
1098 /** Derived from Resolver, and performs user forward/reverse lookups.
1100 class CoreExport UserResolver : public Resolver
1103 /** User this class is 'attached' to.
1106 /** File descriptor teh lookup is bound to
1109 /** True if the lookup is forward, false if is a reverse lookup
1113 /** Create a resolver.
1114 * @param Instance The creating instance
1115 * @param user The user to begin lookup on
1116 * @param to_resolve The IP or host to resolve
1117 * @param qt The query type
1118 * @param cache Modified by the constructor if the result was cached
1120 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1122 /** Called on successful lookup
1123 * @param result Result string
1124 * @param ttl Time to live for result
1125 * @param cached True if the result was found in the cache
1126 * @param resultnum Result number, we are only interested in result 0
1128 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
1130 /** Called on failed lookup
1131 * @param e Error code
1132 * @param errormessage Error message string
1134 void OnError(ResolverError e, const std::string &errormessage);
1137 /* Configuration callbacks */
1138 //class ServerConfig;