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 * ---------------------------------------------------
21 /** Channel status for a user
34 /** connect class types
43 /** RFC1459 channel modes
46 /** +s: Server notice mask */
47 UM_SNOMASK = 's' - 65,
49 UM_WALLOPS = 'w' - 65,
51 UM_INVISIBLE = 'i' - 65,
53 UM_OPERATOR = 'o' - 65
56 /** Registration state of a user, e.g.
57 * have they sent USER, NICK, PASS yet?
59 enum RegistrationState {
61 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
62 REG_NONE = 0, /* Has sent nothing */
65 REG_USER = 1, /* Has sent USER */
66 REG_NICK = 2, /* Has sent NICK */
67 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
68 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
71 /* Required forward declaration */
75 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
77 class CoreExport ConnectClass : public classbase
80 /** Type of line, either CC_ALLOW or CC_DENY
83 /** Connect class name
86 /** Max time to register the connection in seconds
88 unsigned int registration_timeout;
89 /** Number of lines in buffer before excess flood is triggered
92 /** Host mask for this line
95 /** Number of seconds between pings for this line
97 unsigned int pingtime;
98 /** (Optional) Password for this line
102 /** (Optional) Hash Method for this line
106 /** Threshold value for flood disconnect
108 unsigned int threshold;
110 /** Maximum size of sendq for users in this class (bytes)
112 unsigned long sendqmax;
114 /** Maximum size of recvq for users in this class (bytes)
116 unsigned long recvqmax;
118 /** Local max when connecting by this connection class
120 unsigned long maxlocal;
122 /** Global max when connecting by this connection class
124 unsigned long maxglobal;
126 /** Max channels for this class
128 unsigned int maxchans;
130 /** Port number this connect class applies to
136 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
138 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
139 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
140 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
141 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
142 port(source->port), RefCount(0), disabled(false), limit(source->limit)
146 /** Create a new connect class with no settings.
148 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
149 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
153 /** Create a new connect class to ALLOW connections.
154 * @param thename Name of the connect class
155 * @param timeout The registration timeout
156 * @param fld The flood value
157 * @param hst The IP mask to allow
158 * @param ping The ping frequency
159 * @param pas The password to be used
160 * @param hsh The hash to be used
161 * @param thres The flooding threshold
162 * @param sendq The maximum sendq value
163 * @param recvq The maximum recvq value
164 * @param maxl The maximum local sessions
165 * @param maxg The maximum global sessions
167 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
168 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
169 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
170 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
171 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
173 /** Create a new connect class to DENY connections
174 * @param thename Name of the connect class
175 * @param hst The IP mask to deny
177 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
178 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)
182 /* Create a new connect class based on another class
183 * @param thename The name of the connect class
184 * @param source Another connect class to inherit all but the name from
186 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
187 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
188 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
189 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
190 port(source->port), RefCount(0), disabled(false), limit(source->limit)
194 void SetDisabled(bool t)
201 return this->disabled;
204 /* Update an existing entry with new values
206 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
207 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
208 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
211 registration_timeout = timeout;
235 this->limit = llimit;
238 void Update(const std::string &n, const std::string &hst)
244 /** Reference counter. Contains an int as to how many users are connected to this class. :)
245 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
246 * are 0 users on it - it will go away in RAM. :)
248 unsigned long RefCount;
250 /** 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
254 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
263 /** Returns the type, CC_ALLOW or CC_DENY
267 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
270 std::string& GetName()
275 /** Returns the registration timeout
277 time_t GetRegTimeout()
279 return (registration_timeout ? registration_timeout : 90);
282 /** Returns the flood limit
284 unsigned int GetFlood()
286 return (threshold ? flood : 999);
289 /** Returns the allowed or denied IP mask
291 const std::string& GetHost()
310 /** Returns the ping frequency
312 unsigned int GetPingTime()
314 return (pingtime ? pingtime : 120);
317 /** Returns the password or an empty string
319 const std::string& GetPass()
324 /** Returns the hash or an empty string
326 const std::string& GetHash()
331 /** Returns the flood threshold value
333 unsigned int GetThreshold()
335 return (threshold ? threshold : 1);
338 /** Returns the maximum sendq value
340 unsigned long GetSendqMax()
342 return (sendqmax ? sendqmax : 262114);
345 /** Returns the maximum recvq value
347 unsigned long GetRecvqMax()
349 return (recvqmax ? recvqmax : 4096);
352 /** Returusn the maximum number of local sessions
354 unsigned long GetMaxLocal()
359 /** Returns the maximum number of global sessions
361 unsigned long GetMaxGlobal()
367 /** 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.
369 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
371 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
373 typedef std::vector<ConnectClass*> ClassVector;
375 /** Typedef for the list of user-channel records for a user
377 typedef std::map<Channel*, char> UserChanList;
379 /** Shorthand for an iterator into a UserChanList
381 typedef UserChanList::iterator UCListIter;
383 /* Required forward declaration
387 /** Visibility data for a user.
388 * If a user has a non-null instance of this class in their User,
389 * then it is used to determine if this user is visible to other users
392 class CoreExport VisData
398 /** Destroy a visdata
401 /** Is this user visible to some other user?
402 * @param user The other user to compare to
403 * @return true True if the user is visible to the other user, false if not
405 virtual bool VisibleTo(User* user);
408 /** Holds all information about a user
409 * This class stores all information about a user connected to the irc server. Everything about a
410 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
411 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
412 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
413 * file descriptor value.
415 class CoreExport User : public EventHandler
418 /** Pointer to creator.
419 * This is required to make use of core functions
420 * from within the User class.
422 InspIRCd* ServerInstance;
424 /** A list of channels the user has a pending invite to.
425 * Upon INVITE channels are added, and upon JOIN, the
426 * channels are removed from this list.
430 /** Cached nick!ident@dhost value using the displayed hostname
432 std::string cached_fullhost;
434 /** Cached ident@ip value using the real IP address
436 std::string cached_hostip;
438 /** Cached ident@realhost value using the real hostname
440 std::string cached_makehost;
442 /** Cached nick!ident@realhost value using the real hostname
444 std::string cached_fullrealhost;
446 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
448 std::string cachedip;
450 /** When we erase the user (in the destructor),
451 * we call this method to subtract one from all
452 * mode characters this user is making use of.
454 void DecrementModes();
456 std::map<std::string, bool>* AllowedOperCommands;
458 /** Allowed user modes from oper classes. */
459 std::bitset<64> AllowedUserModes;
461 /** Allowed channel modes from oper classes. */
462 std::bitset<64> AllowedChanModes;
465 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
466 * The pointer is guarenteed to *always* be valid. :)
468 ConnectClass *MyClass;
470 /** User visibility state, see definition of VisData.
474 /** Hostname of connection.
475 * This should be valid as per RFC1035.
479 /** Stats counter for bytes inbound
483 /** Stats counter for bytes outbound
487 /** Stats counter for commands inbound
491 /** Stats counter for commands outbound
495 /** True if user has authenticated, false if otherwise
499 /** Used by User to indicate the registration status of the connection
500 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
501 * the connection state.
505 /** Time the connection was last pinged
509 /** Time the connection was created, set in the constructor. This
510 * may be different from the time the user's classbase object was
515 /** Time that the connection last sent a message, used to calculate idle time
519 /** Used by PING checking code
523 /** Stored reverse lookup from res_forward. Should not be used after resolution.
525 std::string stored_host;
527 /** Starts a DNS lookup of the user's IP.
528 * This will cause two UserResolver classes to be instantiated.
529 * When complete, these objects set User::dns_done to true.
531 void StartDNSLookup();
533 /** The users nickname.
534 * An invalid nickname indicates an unregistered connection prior to the NICK command.
535 * Use InspIRCd::IsNick() to validate nicknames.
539 /** The user's unique identifier.
540 * This is the unique identifier which the user has across the network.
544 /** The users ident reply.
545 * Two characters are added to the user-defined limit to compensate for the tilde etc.
549 /** The host displayed to non-opers (used for cloaking etc).
550 * This usually matches the value of User::host.
554 /** The users full name (GECOS).
556 std::string fullname;
558 /** The user's mode list.
559 * NOT a null terminated string.
561 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
562 * if (modes[modeletter-65]) is set, then the mode is
563 * set, for example, to work out if mode +s is set, we check the field
564 * User::modes['s'-65] != 0.
565 * The following RFC characters o, w, s, i have constants defined via an
566 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
568 std::bitset<64> modes;
570 /** What snomasks are set on this user.
571 * This functions the same as the above modes.
573 std::bitset<64> snomasks;
575 /** Channels this user is on, and the permissions they have there
579 /** The server the user is connected to.
583 /** The user's away message.
584 * If this string is empty, the user is not marked as away.
588 /** Time the user last went away.
589 * This is ONLY RELIABLE if user IS_AWAY()!
593 /** The oper type they logged in as, if they are an oper.
594 * This is used to check permissions in operclasses, so that
595 * we can say 'yay' or 'nay' to any commands they issue.
596 * The value of this is the value of a valid 'type name=' tag.
600 /** True when DNS lookups are completed.
601 * The UserResolver classes res_forward and res_reverse will
602 * set this value once they complete.
606 /** Password specified by the user when they registered.
607 * This is stored even if the <connect> block doesnt need a password, so that
608 * modules may check it.
610 std::string password;
612 /** User's receive queue.
613 * Lines from the IRCd awaiting processing are stored here.
614 * Upgraded april 2005, old system a bit hairy.
618 /** User's send queue.
619 * Lines waiting to be sent are stored here until their buffer is flushed.
623 /** Message user will quit with. Not to be set externally.
627 /** Quit message shown to opers - not to be set externally.
629 std::string operquitmsg;
631 /** Whether or not to send an snotice about this user's quitting
635 /** Flood counters - lines received
637 unsigned int lines_in;
639 /** Flood counters - time lines_in is due to be reset
643 /** If this is set to true, then all socket operations for the user
644 * are dropped into the bit-bucket.
645 * This value is set by QuitUser, and is not needed seperately from that call.
646 * Please note that setting this value alone will NOT cause the user to quit.
650 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
651 * GetIPString/GetPort to obtain its values.
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 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
678 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
679 * This may be used for CIDR clone detection, etc.
681 * (XXX, brief note: when we do the sockets rewrite, this should move down a
682 * level so it may be used on more derived objects. -- w00t)
684 const char *GetCIDRMask(int range);
686 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
690 /** This value contains how far into the penalty threshold the user is. Once its over
691 * the penalty threshold then commands are held and processed on-timer.
695 /** True if we are flushing penalty lines
699 /** If this bool is set then penalty rules do not apply to this user
701 bool ExemptFromPenalty;
703 /** Default constructor
704 * @throw CoreException if the UID allocated to the user already exists
705 * @param Instance Creator instance
706 * @param uid User UUID, or empty to allocate one automatically
708 User(InspIRCd* Instance, const std::string &uid = "");
710 /** Check if the user matches a G or K line, and disconnect them if they do.
711 * Returns true if the user matched a ban, false else.
715 /** Returns the full displayed host of the user
716 * This member function returns the hostname of the user as seen by other users
717 * on the server, in nick!ident&at;host form.
718 * @return The full masked host of the user
720 virtual const std::string& GetFullHost();
722 /** Returns the full real host of the user
723 * This member function returns the hostname of the user as seen by other users
724 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
725 * e.g. through a module, then this method will ignore it and return the true hostname.
726 * @return The full real host of the user
728 virtual const std::string& GetFullRealHost();
730 /** This clears any cached results that are used for GetFullRealHost() etc.
731 * The results of these calls are cached as generating them can be generally expensive.
733 void InvalidateCache();
735 /** Create a displayable mode string for this users snomasks
736 * @return The notice mask character sequence
738 const char* FormatNoticeMasks();
740 /** Process a snomask modifier string, e.g. +abc-de
741 * @param sm A sequence of notice mask characters
742 * @return The cleaned mode sequence which can be output,
743 * e.g. in the above example if masks c and e are not
744 * valid, this function will return +ab-d
746 std::string ProcessNoticeMasks(const char *sm);
748 /** Returns true if a notice mask is set
749 * @param sm A notice mask character to check
750 * @return True if the notice mask is set
752 bool IsNoticeMaskSet(unsigned char sm);
754 /** Changed a specific notice mask value
755 * @param sm The server notice mask to change
756 * @param value An on/off value for this mask
758 void SetNoticeMask(unsigned char sm, bool value);
760 /** Create a displayable mode string for this users umodes
761 * @param The mode string
763 const char* FormatModes(bool showparameters = false);
765 /** Returns true if a specific mode is set
766 * @param m The user mode
767 * @return True if the mode is set
769 bool IsModeSet(unsigned char m);
771 /** Set a specific usermode to on or off
772 * @param m The user mode
773 * @param value On or off setting of the mode
775 void SetMode(unsigned char m, bool value);
777 /** Returns true if a user is invited to a channel.
778 * @param channel A channel name to look up
779 * @return True if the user is invited to the given channel
781 virtual bool IsInvited(const irc::string &channel);
783 /** Adds a channel to a users invite list (invites them to a channel)
784 * @param channel A channel name to add
785 * @param timeout When the invite should expire (0 == never)
787 virtual void InviteTo(const irc::string &channel, time_t timeout);
789 /** Removes a channel from a users invite list.
790 * This member function is called on successfully joining an invite only channel
791 * to which the user has previously been invited, to clear the invitation.
792 * @param channel The channel to remove the invite to
794 virtual void RemoveInvite(const irc::string &channel);
796 /** Returns true or false for if a user can execute a privilaged oper command.
797 * This is done by looking up their oper type from User::oper, then referencing
798 * this to their oper classes and checking the commands they can execute.
799 * @param command A command (should be all CAPS)
800 * @return True if this user can execute the command
802 bool HasPermission(const std::string &command);
804 /** Returns true or false if a user can set a privileged user or channel mode.
805 * This is done by looking up their oper type from User::oper, then referencing
806 * this to their oper classes, and checking the modes they can set.
807 * @param mode The mode the check
808 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
809 * @return True if the user can set or unset this mode.
811 bool HasModePermission(unsigned char mode, ModeType type);
813 /** Calls read() to read some data for this user using their fd.
814 * @param buffer The buffer to read into
815 * @param size The size of data to read
816 * @return The number of bytes read, or -1 if an error occured.
818 int ReadData(void* buffer, size_t size);
820 /** This method adds data to the read buffer of the user.
821 * The buffer can grow to any size within limits of the available memory,
822 * managed by the size of a std::string, however if any individual line in
823 * the buffer grows over 600 bytes in length (which is 88 chars over the
824 * RFC-specified limit per line) then the method will return false and the
825 * text will not be inserted.
826 * @param a The string to add to the users read buffer
827 * @return True if the string was successfully added to the read buffer
829 bool AddBuffer(const std::string &a);
831 /** This method returns true if the buffer contains at least one carriage return
832 * character (e.g. one complete line may be read)
833 * @return True if there is at least one complete line in the users buffer
835 bool BufferIsReady();
837 /** This function clears the entire buffer by setting it to an empty string.
841 /** This method returns the first available string at the tail end of the buffer
842 * and advances the tail end of the buffer past the string. This means it is
843 * a one way operation in a similar way to strtok(), and multiple calls return
844 * multiple lines if they are available. The results of this function if there
845 * are no lines to be read are unknown, always use BufferIsReady() to check if
846 * it is ok to read the buffer before calling GetBuffer().
847 * @return The string at the tail end of this users buffer
849 std::string GetBuffer();
851 /** Adds to the user's write buffer.
852 * You may add any amount of text up to this users sendq value, if you exceed the
853 * sendq value, the user will be removed, and further buffer adds will be dropped.
854 * @param data The data to add to the write buffer
856 void AddWriteBuf(const std::string &data);
858 /** Flushes as much of the user's buffer to the file descriptor as possible.
859 * This function may not always flush the entire buffer, rather instead as much of it
860 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
861 * position is advanced forwards and the rest of the data sent at the next call to
864 void FlushWriteBuf();
866 /** Returns the list of channels this user has been invited to but has not yet joined.
867 * @return A list of channels the user is invited to
869 InvitedList* GetInviteList();
871 /** Creates a wildcard host.
872 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
873 * @return The wildcarded hostname in *!*@host form
875 char* MakeWildHost();
877 /** Creates a usermask with real host.
878 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
879 * @return the usermask in the format user@host
881 const std::string& MakeHost();
883 /** Creates a usermask with real ip.
884 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
885 * @return the usermask in the format user@ip
887 const std::string& MakeHostIP();
889 /** Shuts down and closes the user's socket
890 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
891 * which will call CloseSocket() for you.
895 /** Add the user to WHOWAS system
899 /** Oper up the user using the given opertype.
900 * This will also give the +o usermode.
901 * @param opertype The oper type to oper as
903 void Oper(const std::string &opertype, const std::string &opername);
905 /** Call this method to find the matching <connect> for a user, and to check them against it.
909 /** Use this method to fully connect a user.
910 * This will send the message of the day, check G/K/E lines, etc.
914 /** Change this users hash key to a new string.
915 * You should not call this function directly. It is used by the core
916 * to update the users hash entry on a nickchange.
917 * @param New new user_hash key
918 * @return Pointer to User in hash (usually 'this')
920 User* UpdateNickHash(const char* New);
922 /** Force a nickname change.
923 * If the nickname change fails (for example, because the nick in question
924 * already exists) this function will return false, and you must then either
925 * output an error message, or quit the user for nickname collision.
926 * @param newnick The nickname to change to
927 * @return True if the nickchange was successful.
929 bool ForceNickChange(const char* newnick);
932 * This will clear the +o usermode and unset the user's oper type
936 /** Write text to this user, appending CR/LF.
937 * @param text A std::string to send to the user
939 void Write(std::string text);
941 /** Write text to this user, appending CR/LF.
942 * @param text The format string for text to send to the user
943 * @param ... POD-type format arguments
945 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
947 /** Write text to this user, appending CR/LF and prepending :server.name
948 * @param text A std::string to send to the user
950 void WriteServ(const std::string& text);
952 /** Write text to this user, appending CR/LF and prepending :server.name
953 * @param text The format string for text to send to the user
954 * @param ... POD-type format arguments
956 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
958 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
960 void WriteNumeric(unsigned int numeric, const std::string &text);
962 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
963 * @param user The user to prepend the :nick!user@host of
964 * @param text A std::string to send to the user
966 void WriteFrom(User *user, const std::string &text);
968 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
969 * @param user The user to prepend the :nick!user@host of
970 * @param text The format string for text to send to the user
971 * @param ... POD-type format arguments
973 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
975 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
976 * @param dest The user to route the message to
977 * @param text A std::string to send to the user
979 void WriteTo(User *dest, const std::string &data);
981 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
982 * @param dest The user to route the message to
983 * @param text The format string for text to send to the user
984 * @param ... POD-type format arguments
986 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
988 /** Write to all users that can see this user (including this user in the list), appending CR/LF
989 * @param text A std::string to send to the users
991 void WriteCommon(const std::string &text);
993 /** Write to all users that can see this user (including this user in the list), appending CR/LF
994 * @param text The format string for text to send to the users
995 * @param ... POD-type format arguments
997 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
999 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1000 * @param text The format string for text to send to the users
1001 * @param ... POD-type format arguments
1003 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
1005 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1006 * @param text A std::string to send to the users
1008 void WriteCommonExcept(const std::string &text);
1010 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1011 * quit message for opers only.
1012 * @param normal_text Normal user quit message
1013 * @param oper_text Oper only quit message
1015 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1017 /** Write a WALLOPS message from this user to all local opers.
1018 * If this user is not opered, the function will return without doing anything.
1019 * @param text The format string to send in the WALLOPS message
1020 * @param ... Format arguments
1022 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
1024 /** Write a WALLOPS message from this user to all local opers.
1025 * If this user is not opered, the function will return without doing anything.
1026 * @param text The text to send in the WALLOPS message
1028 void WriteWallOps(const std::string &text);
1030 /** Return true if the user shares at least one channel with another user
1031 * @param other The other user to compare the channel list against
1032 * @return True if the given user shares at least one channel with this user
1034 bool SharesChannelWith(User *other);
1036 /** Change the displayed host of a user.
1037 * ALWAYS use this function, rather than writing User::dhost directly,
1038 * as this triggers module events allowing the change to be syncronized to
1039 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1040 * before setting their host field.
1041 * @param host The new hostname to set
1042 * @return True if the change succeeded, false if it didn't
1044 bool ChangeDisplayedHost(const char* host);
1046 /** Change the ident (username) of a user.
1047 * ALWAYS use this function, rather than writing User::ident directly,
1048 * as this correctly causes the user to seem to quit (where configured)
1049 * before setting their ident field.
1050 * @param host The new ident to set
1051 * @return True if the change succeeded, false if it didn't
1053 bool ChangeIdent(const char* newident);
1055 /** Change a users realname field.
1056 * ALWAYS use this function, rather than writing User::fullname directly,
1057 * as this triggers module events allowing the change to be syncronized to
1059 * @param gecos The user's new realname
1060 * @return True if the change succeeded, false if otherwise
1062 bool ChangeName(const char* gecos);
1064 /** Send a command to all local users from this user
1065 * The command given must be able to send text with the
1066 * first parameter as a servermask (e.g. $*), so basically
1067 * you should use PRIVMSG or NOTICE.
1068 * @param command the command to send
1069 * @param text The text format string to send
1070 * @param ... Format arguments
1072 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
1074 /** Compile a channel list for this user, and send it to the user 'source'
1075 * Used internally by WHOIS
1076 * @param The user to send the channel list to if it is not too long
1077 * @return This user's channel list
1079 std::string ChannelList(User* source);
1081 /** Split the channel list in cl which came from dest, and spool it to this user
1082 * Used internally by WHOIS
1083 * @param dest The user the original channel list came from
1084 * @param cl The channel list as a string obtained from User::ChannelList()
1086 void SplitChanList(User* dest, const std::string &cl);
1088 /** Remove this user from all channels they are on, and delete any that are now empty.
1089 * This is used by QUIT, and will not send part messages!
1091 void PurgeEmptyChannels();
1093 /** Get the connect class which this user belongs to.
1094 * @return A pointer to this user's connect class
1096 ConnectClass *GetClass();
1098 /** Set the connect class to which this user belongs to.
1099 * @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.
1100 * @return A reference to this user's current connect class.
1102 ConnectClass *SetClass(const std::string &explicit_name = "");
1104 /** Show the message of the day to this user
1108 /** Show the server RULES file to this user
1112 /** Set oper-specific quit message shown to opers only when the user quits
1113 * (overrides any sent by QuitUser)
1115 void SetOperQuit(const std::string &oquit);
1117 /** Get oper-specific quit message shown only to opers when the user quits.
1118 * (overrides any sent by QuitUser)
1120 const std::string& GetOperQuit();
1122 /** Increases a user's command penalty by a set amount.
1124 void IncreasePenalty(int increase);
1126 /** Decreases a user's command penalty by a set amount.
1128 void DecreasePenalty(int decrease);
1130 /** Handle socket event.
1131 * From EventHandler class.
1132 * @param et Event type
1133 * @param errornum Error number for EVENT_ERROR events
1135 void HandleEvent(EventType et, int errornum = 0);
1137 /** Default destructor
1142 /** Derived from Resolver, and performs user forward/reverse lookups.
1144 class CoreExport UserResolver : public Resolver
1147 /** User this class is 'attached' to.
1150 /** File descriptor teh lookup is bound to
1153 /** True if the lookup is forward, false if is a reverse lookup
1157 /** Create a resolver.
1158 * @param Instance The creating instance
1159 * @param user The user to begin lookup on
1160 * @param to_resolve The IP or host to resolve
1161 * @param qt The query type
1162 * @param cache Modified by the constructor if the result was cached
1164 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1166 /** Called on successful lookup
1167 * @param result Result string
1168 * @param ttl Time to live for result
1169 * @param cached True if the result was found in the cache
1170 * @param resultnum Result number, we are only interested in result 0
1172 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
1174 /** Called on failed lookup
1175 * @param e Error code
1176 * @param errormessage Error message string
1178 void OnError(ResolverError e, const std::string &errormessage);
1181 /* Configuration callbacks */
1182 //class ServerConfig;