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 /** Channel status for a user
34 /** connect class types
43 /** RFC1459 channel modes
46 /** +s: Server notices */
47 UM_SERVERNOTICE = 's' - 65,
49 UM_WALLOPS = 'w' - 65,
51 UM_INVISIBLE = 'i' - 65,
53 UM_OPERATOR = 'o' - 65,
54 /** +n: Server notice mask */
58 /** Registration state of a user, e.g.
59 * have they sent USER, NICK, PASS yet?
61 enum RegistrationState {
63 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
64 REG_NONE = 0, /* Has sent nothing */
67 REG_USER = 1, /* Has sent USER */
68 REG_NICK = 2, /* Has sent NICK */
69 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
70 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
73 /* Required forward declaration */
77 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
79 class CoreExport ConnectClass : public classbase
82 /** Type of line, either CC_ALLOW or CC_DENY
85 /** Connect class name
88 /** Max time to register the connection in seconds
90 unsigned int registration_timeout;
91 /** Number of lines in buffer before excess flood is triggered
94 /** Host mask for this line
97 /** Number of seconds between pings for this line
99 unsigned int pingtime;
100 /** (Optional) Password for this line
104 /** (Optional) Hash Method for this line
108 /** Threshold value for flood disconnect
110 unsigned int threshold;
112 /** Maximum size of sendq for users in this class (bytes)
114 unsigned long sendqmax;
116 /** Maximum size of recvq for users in this class (bytes)
118 unsigned long recvqmax;
120 /** Local max when connecting by this connection class
122 unsigned long maxlocal;
124 /** Global max when connecting by this connection class
126 unsigned long maxglobal;
128 /** Max channels for this class
130 unsigned int maxchans;
132 /** Port number this connect class applies to
138 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
140 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
141 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
142 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
143 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
144 port(source->port), RefCount(0), disabled(false), limit(0)
148 /** Create a new connect class with no settings.
150 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
151 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
155 /** Create a new connect class to ALLOW connections.
156 * @param thename Name of the connect class
157 * @param timeout The registration timeout
158 * @param fld The flood value
159 * @param hst The IP mask to allow
160 * @param ping The ping frequency
161 * @param pas The password to be used
162 * @param hsh The hash to be used
163 * @param thres The flooding threshold
164 * @param sendq The maximum sendq value
165 * @param recvq The maximum recvq value
166 * @param maxl The maximum local sessions
167 * @param maxg The maximum global sessions
169 ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
170 const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
171 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
172 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
173 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
175 /** Create a new connect class to DENY connections
176 * @param thename Name of the connect class
177 * @param hst The IP mask to deny
179 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
180 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)
184 /* Create a new connect class based on another class
185 * @param thename The name of the connect class
186 * @param source Another connect class to inherit all but the name from
188 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
189 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
190 pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
191 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
192 port(source->port), RefCount(0), disabled(false), limit(0)
196 void SetDisabled(bool t)
203 return this->disabled;
206 /* Update an existing entry with new values
208 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
209 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
210 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
213 registration_timeout = timeout;
237 this->limit = llimit;
240 /** Reference counter. Contains an int as to how many users are connected to this class. :)
241 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
242 * are 0 users on it - it will go away in RAM. :)
244 unsigned long RefCount;
246 /** 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
250 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
259 /** Returns the type, CC_ALLOW or CC_DENY
263 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
266 std::string& GetName()
271 /** Returns the registration timeout
273 unsigned int GetRegTimeout()
275 return (registration_timeout ? registration_timeout : 90);
278 /** Returns the flood limit
280 unsigned int GetFlood()
282 return (threshold ? flood : 999);
285 /** Returns the allowed or denied IP mask
287 const std::string& GetHost()
306 /** Returns the ping frequency
308 unsigned int GetPingTime()
310 return (pingtime ? pingtime : 120);
313 /** Returns the password or an empty string
315 const std::string& GetPass()
320 /** Returns the hash or an empty string
322 const std::string& GetHash()
327 /** Returns the flood threshold value
329 unsigned int GetThreshold()
331 return (threshold ? threshold : 1);
334 /** Returns the maximum sendq value
336 unsigned long GetSendqMax()
338 return (sendqmax ? sendqmax : 262114);
341 /** Returns the maximum recvq value
343 unsigned long GetRecvqMax()
345 return (recvqmax ? recvqmax : 4096);
348 /** Returusn the maximum number of local sessions
350 unsigned long GetMaxLocal()
355 /** Returns the maximum number of global sessions
357 unsigned long GetMaxGlobal()
363 /** 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.
365 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
367 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
369 typedef std::vector<ConnectClass*> ClassVector;
371 /** Typedef for the list of user-channel records for a user
373 typedef std::map<Channel*, char> UserChanList;
375 /** Shorthand for an iterator into a UserChanList
377 typedef UserChanList::iterator UCListIter;
379 /* Required forward declaration
383 /** Visibility data for a user.
384 * If a user has a non-null instance of this class in their User,
385 * then it is used to determine if this user is visible to other users
388 class CoreExport VisData
394 /** Destroy a visdata
397 /** Is this user visible to some other user?
398 * @param user The other user to compare to
399 * @return true True if the user is visible to the other user, false if not
401 virtual bool VisibleTo(User* user);
404 /** Holds all information about a user
405 * This class stores all information about a user connected to the irc server. Everything about a
406 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
407 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
408 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
409 * file descriptor value.
411 class CoreExport User : public connection
414 /** Pointer to creator.
415 * This is required to make use of core functions
416 * from within the User class.
418 InspIRCd* ServerInstance;
420 /** A list of channels the user has a pending invite to.
421 * Upon INVITE channels are added, and upon JOIN, the
422 * channels are removed from this list.
426 /** Number of channels this user is currently on
428 unsigned int ChannelCount;
430 /** Cached nick!ident@host value using the real hostname
432 char* cached_fullhost;
434 /** Cached nick!ident@ip value using the real IP address
438 /** Cached nick!ident@host value using the masked hostname
440 char* cached_makehost;
442 /** Cached nick!ident@realhost value using the real hostname
444 char* cached_fullrealhost;
446 /** When we erase the user (in the destructor),
447 * we call this method to subtract one from all
448 * mode characters this user is making use of.
450 void DecrementModes();
452 /** Max channels for this user
454 unsigned int MaxChans;
456 std::map<std::string, bool>* AllowedOperCommands;
459 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
460 * The pointer is guarenteed to *always* be valid. :)
462 ConnectClass *MyClass;
464 /** Resolvers for looking up this users IP address
465 * This will occur if and when res_reverse completes.
466 * When this class completes its lookup, User::dns_done
467 * will be set from false to true.
469 UserResolver* res_forward;
471 /** Resolvers for looking up this users hostname
472 * This is instantiated by User::StartDNSLookup(),
473 * and on success, instantiates User::res_reverse.
475 UserResolver* res_reverse;
477 /** User visibility state, see definition of VisData.
481 /** Stored reverse lookup from res_forward
483 std::string stored_host;
485 /** Starts a DNS lookup of the user's IP.
486 * This will cause two UserResolver classes to be instantiated.
487 * When complete, these objects set User::dns_done to true.
489 void StartDNSLookup();
491 unsigned int GetMaxChans();
493 /** The users nickname.
494 * An invalid nickname indicates an unregistered connection prior to the NICK command.
495 * Use InspIRCd::IsNick() to validate nicknames.
499 /** The user's unique identifier.
500 * This is the unique identifier which the user has across the network.
502 char uuid[UUID_LENGTH];
504 /** The users ident reply.
505 * Two characters are added to the user-defined limit to compensate for the tilde etc.
507 char ident[IDENTMAX+2];
509 /** The host displayed to non-opers (used for cloaking etc).
510 * This usually matches the value of User::host.
514 /** The users full name (GECOS).
516 char fullname[MAXGECOS+1];
518 /** The user's mode list.
519 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
520 * this is an array of values in a similar way to channel modes.
521 * A value of 1 in field (modeletter-65) indicates that the mode is
522 * set, for example, to work out if mode +s is set, we check the field
523 * User::modes['s'-65] != 0.
524 * The following RFC characters o, w, s, i have constants defined via an
525 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
529 /** What snomasks are set on this user.
530 * This functions the same as the above modes.
534 /** Channels this user is on, and the permissions they have there
538 /** The server the user is connected to.
542 /** The user's away message.
543 * If this string is empty, the user is not marked as away.
545 char awaymsg[MAXAWAY+1];
547 /** Timestamp of current time + connection class timeout.
548 * This user must send USER/NICK before this timestamp is
549 * reached or they will be disconnected.
553 /** The oper type they logged in as, if they are an oper.
554 * This is used to check permissions in operclasses, so that
555 * we can say 'yay' or 'nay' to any commands they issue.
556 * The value of this is the value of a valid 'type name=' tag.
560 /** True when DNS lookups are completed.
561 * The UserResolver classes res_forward and res_reverse will
562 * set this value once they complete.
566 /** Password specified by the user when they registered.
567 * This is stored even if the <connect> block doesnt need a password, so that
568 * modules may check it.
572 /** User's receive queue.
573 * Lines from the IRCd awaiting processing are stored here.
574 * Upgraded april 2005, old system a bit hairy.
578 /** User's send queue.
579 * Lines waiting to be sent are stored here until their buffer is flushed.
583 /** Message user will quit with. Not to be set externally.
587 /** Quit message shown to opers - not to be set externally.
589 std::string operquitmsg;
591 /** Whether or not to send an snotice about this user's quitting
595 /** Flood counters - lines received
597 unsigned int lines_in;
599 /** Flood counters - time lines_in is due to be reset
603 /** If this is set to true, then all socket operations for the user
604 * are dropped into the bit-bucket.
605 * This value is set by QuitUser, and is not needed seperately from that call.
606 * Please note that setting this value alone will NOT cause the user to quit.
610 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
611 * GetIPString/GetPort to obtain its values.
615 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
617 std::string cachedip;
619 /** Initialize the clients sockaddr
620 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
621 * @param ip A human-readable IP address for this user matching the protcol_family
622 * @param port The port number of this user or zero for a remote user
624 void SetSockAddr(int protocol_family, const char* ip, int port);
626 /** Get port number from sockaddr
627 * @return The port number of this user.
631 /** Get protocol family from sockaddr
632 * @return The protocol family of this user, either AF_INET or AF_INET6
634 int GetProtocolFamily();
636 /** Get IP string from sockaddr, using static internal buffer
637 * @return The IP string
639 const char* GetIPString();
641 /* Write error string
643 std::string WriteError;
645 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
649 /** This value contains how far into the penalty threshold the user is. Once its over
650 * the penalty threshold then commands are held and processed on-timer.
654 /** True if we are flushing penalty lines
658 /** If this bool is set then penalty rules do not apply to this user
660 bool ExemptFromPenalty;
662 /** Default constructor
663 * @throw CoreException if the UID allocated to the user already exists
664 * @param Instance Creator instance
665 * @param uid User UUID, or empty to allocate one automatically
667 User(InspIRCd* Instance, const std::string &uid = "");
669 /** Returns the full displayed host of the user
670 * This member function returns the hostname of the user as seen by other users
671 * on the server, in nick!ident&at;host form.
672 * @return The full masked host of the user
674 virtual char* GetFullHost();
676 /** Returns the full real host of the user
677 * This member function returns the hostname of the user as seen by other users
678 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
679 * e.g. through a module, then this method will ignore it and return the true hostname.
680 * @return The full real host of the user
682 virtual char* GetFullRealHost();
684 /** This clears any cached results that are used for GetFullRealHost() etc.
685 * The results of these calls are cached as generating them can be generally expensive.
687 void InvalidateCache();
689 /** Create a displayable mode string for this users snomasks
690 * @return The notice mask character sequence
692 const char* FormatNoticeMasks();
694 /** Process a snomask modifier string, e.g. +abc-de
695 * @param sm A sequence of notice mask characters
696 * @return The cleaned mode sequence which can be output,
697 * e.g. in the above example if masks c and e are not
698 * valid, this function will return +ab-d
700 std::string ProcessNoticeMasks(const char *sm);
702 /** Returns true if a notice mask is set
703 * @param sm A notice mask character to check
704 * @return True if the notice mask is set
706 bool IsNoticeMaskSet(unsigned char sm);
708 /** Changed a specific notice mask value
709 * @param sm The server notice mask to change
710 * @param value An on/off value for this mask
712 void SetNoticeMask(unsigned char sm, bool value);
714 /** Create a displayable mode string for this users umodes
715 * @param The mode string
717 const char* FormatModes();
719 /** Returns true if a specific mode is set
720 * @param m The user mode
721 * @return True if the mode is set
723 bool IsModeSet(unsigned char m);
725 /** Set a specific usermode to on or off
726 * @param m The user mode
727 * @param value On or off setting of the mode
729 void SetMode(unsigned char m, bool value);
731 /** Returns true if a user is invited to a channel.
732 * @param channel A channel name to look up
733 * @return True if the user is invited to the given channel
735 virtual bool IsInvited(const irc::string &channel);
737 /** Adds a channel to a users invite list (invites them to a channel)
738 * @param channel A channel name to add
739 * @param timeout When the invite should expire (0 == never)
741 virtual void InviteTo(const irc::string &channel, time_t timeout);
743 /** Removes a channel from a users invite list.
744 * This member function is called on successfully joining an invite only channel
745 * to which the user has previously been invited, to clear the invitation.
746 * @param channel The channel to remove the invite to
748 virtual void RemoveInvite(const irc::string &channel);
750 /** Returns true or false for if a user can execute a privilaged oper command.
751 * This is done by looking up their oper type from User::oper, then referencing
752 * this to their oper classes and checking the commands they can execute.
753 * @param command A command (should be all CAPS)
754 * @return True if this user can execute the command
756 bool HasPermission(const std::string &command);
758 /** Calls read() to read some data for this user using their fd.
759 * @param buffer The buffer to read into
760 * @param size The size of data to read
761 * @return The number of bytes read, or -1 if an error occured.
763 int ReadData(void* buffer, size_t size);
765 /** This method adds data to the read buffer of the user.
766 * The buffer can grow to any size within limits of the available memory,
767 * managed by the size of a std::string, however if any individual line in
768 * the buffer grows over 600 bytes in length (which is 88 chars over the
769 * RFC-specified limit per line) then the method will return false and the
770 * text will not be inserted.
771 * @param a The string to add to the users read buffer
772 * @return True if the string was successfully added to the read buffer
774 bool AddBuffer(std::string a);
776 /** This method returns true if the buffer contains at least one carriage return
777 * character (e.g. one complete line may be read)
778 * @return True if there is at least one complete line in the users buffer
780 bool BufferIsReady();
782 /** This function clears the entire buffer by setting it to an empty string.
786 /** This method returns the first available string at the tail end of the buffer
787 * and advances the tail end of the buffer past the string. This means it is
788 * a one way operation in a similar way to strtok(), and multiple calls return
789 * multiple lines if they are available. The results of this function if there
790 * are no lines to be read are unknown, always use BufferIsReady() to check if
791 * it is ok to read the buffer before calling GetBuffer().
792 * @return The string at the tail end of this users buffer
794 std::string GetBuffer();
796 /** Sets the write error for a connection. This is done because the actual disconnect
797 * of a client may occur at an inopportune time such as half way through /LIST output.
798 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
799 * errored clients purged.
800 * @param error The error string to set.
802 void SetWriteError(const std::string &error);
804 /** Returns the write error which last occured on this connection or an empty string
806 * @return The error string which has occured for this user
808 const char* GetWriteError();
810 /** Adds to the user's write buffer.
811 * You may add any amount of text up to this users sendq value, if you exceed the
812 * sendq value, SetWriteError() will be called to set the users error string to
813 * "SendQ exceeded", and further buffer adds will be dropped.
814 * @param data The data to add to the write buffer
816 void AddWriteBuf(const std::string &data);
818 /** Flushes as much of the user's buffer to the file descriptor as possible.
819 * This function may not always flush the entire buffer, rather instead as much of it
820 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
821 * position is advanced forwards and the rest of the data sent at the next call to
824 void FlushWriteBuf();
826 /** Returns the list of channels this user has been invited to but has not yet joined.
827 * @return A list of channels the user is invited to
829 InvitedList* GetInviteList();
831 /** Creates a wildcard host.
832 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
833 * @return The wildcarded hostname in *!*@host form
835 char* MakeWildHost();
837 /** Creates a usermask with real host.
838 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
839 * @return the usermask in the format user@host
843 /** Creates a usermask with real ip.
844 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
845 * @return the usermask in the format user@ip
849 /** Shuts down and closes the user's socket
850 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
851 * which will call CloseSocket() for you.
855 /** Disconnect a user gracefully
856 * @param user The user to remove
857 * @param r The quit reason to show to normal users
858 * @param oreason The quit reason to show to opers
859 * @return Although this function has no return type, on exit the user provided will no longer exist.
861 static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
863 /** Add the user to WHOWAS system
867 /** Oper up the user using the given opertype.
868 * This will also give the +o usermode.
869 * @param opertype The oper type to oper as
871 void Oper(const std::string &opertype, const std::string &opername);
873 /** Call this method to find the matching <connect> for a user, and to check them against it.
877 /** Use this method to fully connect a user.
878 * This will send the message of the day, check G/K/E lines, etc.
882 /** Change this users hash key to a new string.
883 * You should not call this function directly. It is used by the core
884 * to update the users hash entry on a nickchange.
885 * @param New new user_hash key
886 * @return Pointer to User in hash (usually 'this')
888 User* UpdateNickHash(const char* New);
890 /** Force a nickname change.
891 * If the nickname change fails (for example, because the nick in question
892 * already exists) this function will return false, and you must then either
893 * output an error message, or quit the user for nickname collision.
894 * @param newnick The nickname to change to
895 * @return True if the nickchange was successful.
897 bool ForceNickChange(const char* newnick);
900 * This will clear the +o usermode and unset the user's oper type
904 /** Write text to this user, appending CR/LF.
905 * @param text A std::string to send to the user
907 void Write(std::string text);
909 /** Write text to this user, appending CR/LF.
910 * @param text The format string for text to send to the user
911 * @param ... POD-type format arguments
913 void Write(const char *text, ...);
915 /** Write text to this user, appending CR/LF and prepending :server.name
916 * @param text A std::string to send to the user
918 void WriteServ(const std::string& text);
920 /** Write text to this user, appending CR/LF and prepending :server.name
921 * @param text The format string for text to send to the user
922 * @param ... POD-type format arguments
924 void WriteServ(const char* text, ...);
926 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
927 * @param user The user to prepend the :nick!user@host of
928 * @param text A std::string to send to the user
930 void WriteFrom(User *user, const std::string &text);
932 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
933 * @param user The user to prepend the :nick!user@host of
934 * @param text The format string for text to send to the user
935 * @param ... POD-type format arguments
937 void WriteFrom(User *user, const char* text, ...);
939 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
940 * @param dest The user to route the message to
941 * @param text A std::string to send to the user
943 void WriteTo(User *dest, const std::string &data);
945 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
946 * @param dest The user to route the message to
947 * @param text The format string for text to send to the user
948 * @param ... POD-type format arguments
950 void WriteTo(User *dest, const char *data, ...);
952 /** Write to all users that can see this user (including this user in the list), appending CR/LF
953 * @param text A std::string to send to the users
955 void WriteCommon(const std::string &text);
957 /** Write to all users that can see this user (including this user in the list), appending CR/LF
958 * @param text The format string for text to send to the users
959 * @param ... POD-type format arguments
961 void WriteCommon(const char* text, ...);
963 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
964 * @param text The format string for text to send to the users
965 * @param ... POD-type format arguments
967 void WriteCommonExcept(const char* text, ...);
969 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
970 * @param text A std::string to send to the users
972 void WriteCommonExcept(const std::string &text);
974 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
975 * quit message for opers only.
976 * @param normal_text Normal user quit message
977 * @param oper_text Oper only quit message
979 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
981 /** Write a WALLOPS message from this user to all local opers.
982 * If this user is not opered, the function will return without doing anything.
983 * @param text The format string to send in the WALLOPS message
984 * @param ... Format arguments
986 void WriteWallOps(const char* text, ...);
988 /** Write a WALLOPS message from this user to all local opers.
989 * If this user is not opered, the function will return without doing anything.
990 * @param text The text to send in the WALLOPS message
992 void WriteWallOps(const std::string &text);
994 /** Return true if the user shares at least one channel with another user
995 * @param other The other user to compare the channel list against
996 * @return True if the given user shares at least one channel with this user
998 bool SharesChannelWith(User *other);
1000 /** Change the displayed host of a user.
1001 * ALWAYS use this function, rather than writing User::dhost directly,
1002 * as this triggers module events allowing the change to be syncronized to
1003 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1004 * before setting their host field.
1005 * @param host The new hostname to set
1006 * @return True if the change succeeded, false if it didn't
1008 bool ChangeDisplayedHost(const char* host);
1010 /** Change the ident (username) of a user.
1011 * ALWAYS use this function, rather than writing User::ident directly,
1012 * as this correctly causes the user to seem to quit (where configured)
1013 * before setting their ident field.
1014 * @param host The new ident to set
1015 * @return True if the change succeeded, false if it didn't
1017 bool ChangeIdent(const char* newident);
1019 /** Change a users realname field.
1020 * ALWAYS use this function, rather than writing User::fullname directly,
1021 * as this triggers module events allowing the change to be syncronized to
1023 * @param gecos The user's new realname
1024 * @return True if the change succeeded, false if otherwise
1026 bool ChangeName(const char* gecos);
1028 /** Send a command to all local users from this user
1029 * The command given must be able to send text with the
1030 * first parameter as a servermask (e.g. $*), so basically
1031 * you should use PRIVMSG or NOTICE.
1032 * @param command the command to send
1033 * @param text The text format string to send
1034 * @param ... Format arguments
1036 void SendAll(const char* command, const char* text, ...);
1038 /** Compile a channel list for this user, and send it to the user 'source'
1039 * Used internally by WHOIS
1040 * @param The user to send the channel list to if it is not too long
1041 * @return This user's channel list
1043 std::string ChannelList(User* source);
1045 /** Split the channel list in cl which came from dest, and spool it to this user
1046 * Used internally by WHOIS
1047 * @param dest The user the original channel list came from
1048 * @param cl The channel list as a string obtained from User::ChannelList()
1050 void SplitChanList(User* dest, const std::string &cl);
1052 /** Remove this user from all channels they are on, and delete any that are now empty.
1053 * This is used by QUIT, and will not send part messages!
1055 void PurgeEmptyChannels();
1057 /** Get the connect class which this user belongs to.
1058 * @return A pointer to this user's connect class
1060 ConnectClass *GetClass();
1062 /** Set the connect class to which this user belongs to.
1063 * @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.
1064 * @return A reference to this user's current connect class.
1066 ConnectClass *SetClass(const std::string &explicit_name = "");
1068 /** Show the message of the day to this user
1072 /** Show the server RULES file to this user
1076 /** Set oper-specific quit message shown to opers only when the user quits
1077 * (overrides any sent by QuitUser)
1079 void SetOperQuit(const std::string &oquit);
1081 /** Get oper-specific quit message shown only to opers when the user quits.
1082 * (overrides any sent by QuitUser)
1084 const char* GetOperQuit();
1086 /** Increases a user's command penalty by a set amount.
1088 void IncreasePenalty(int increase);
1090 /** Decreases a user's command penalty by a set amount.
1092 void DecreasePenalty(int decrease);
1094 /** Handle socket event.
1095 * From EventHandler class.
1096 * @param et Event type
1097 * @param errornum Error number for EVENT_ERROR events
1099 void HandleEvent(EventType et, int errornum = 0);
1101 /** Default destructor
1106 /** Derived from Resolver, and performs user forward/reverse lookups.
1108 class CoreExport UserResolver : public Resolver
1111 /** User this class is 'attached' to.
1114 /** File descriptor teh lookup is bound to
1117 /** True if the lookup is forward, false if is a reverse lookup
1121 /** Create a resolver.
1122 * @param Instance The creating instance
1123 * @param user The user to begin lookup on
1124 * @param to_resolve The IP or host to resolve
1125 * @param qt The query type
1126 * @param cache Modified by the constructor if the result was cached
1128 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1130 /** Called on successful lookup
1131 * @param result Result string
1132 * @param ttl Time to live for result
1133 * @param cached True if the result was found in the cache
1134 * @param resultnum Result number, we are only interested in result 0
1136 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
1138 /** Called on failed lookup
1139 * @param e Error code
1140 * @param errormessage Error message string
1142 void OnError(ResolverError e, const std::string &errormessage);
1145 /* Configuration callbacks */
1146 //class ServerConfig;