1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/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
84 /** Connect class name
88 /** Max time to register the connection in seconds
90 unsigned int registration_timeout;
92 /** Host mask for this line
96 /** Number of seconds between pings for this line
98 unsigned int pingtime;
100 /** (Optional) Password for this line
104 /** (Optional) Hash Method for this line
108 /** Maximum size of sendq for users in this class (bytes)
110 unsigned long sendqmax;
112 /** Maximum size of recvq for users in this class (bytes)
114 unsigned long recvqmax;
116 /** Local max when connecting by this connection class
118 unsigned long maxlocal;
120 /** Global max when connecting by this connection class
122 unsigned long maxglobal;
124 /** Max channels for this class
126 unsigned int maxchans;
128 /** Port number this connect class applies to
134 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
136 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
137 registration_timeout(source->registration_timeout), host(source->host),
138 pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
139 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
140 port(source->port), RefCount(0), disabled(false), limit(source->limit)
144 /** Create a new connect class with no settings.
146 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), host(""), pingtime(0), pass(""), hash(""),
147 sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
151 /** Create a new connect class to ALLOW connections.
152 * @param thename Name of the connect class
153 * @param timeout The registration timeout
154 * @param hst The IP mask to allow
155 * @param ping The ping frequency
156 * @param pas The password to be used
157 * @param hsh The hash to be used
158 * @param sendq The maximum sendq value
159 * @param recvq The maximum recvq value
160 * @param maxl The maximum local sessions
161 * @param maxg The maximum global sessions
163 ConnectClass(const std::string &thename, unsigned int timeout,const std::string &hst, unsigned int ping,
164 const std::string &pas, const std::string &hsh, unsigned long sendq, unsigned long recvq,
165 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
166 type(CC_ALLOW), name(thename), registration_timeout(timeout), host(hst), pingtime(ping), pass(pas), hash(hsh),
167 sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
169 /** Create a new connect class to DENY connections
170 * @param thename Name of the connect class
171 * @param hst The IP mask to deny
173 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
174 host(hst), pingtime(0), pass(""), hash(""), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
178 /* Create a new connect class based on another class
179 * @param thename The name of the connect class
180 * @param source Another connect class to inherit all but the name from
182 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
183 registration_timeout(source->registration_timeout), host(source->host),
184 pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
185 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
186 port(source->port), RefCount(0), disabled(false), limit(source->limit)
190 void SetDisabled(bool t)
197 return this->disabled;
200 /* Update an existing entry with new values
202 void Update(unsigned int timeout, const std::string &hst, unsigned int ping,
203 const std::string &pas, unsigned long sendq, unsigned long recvq,
204 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
207 registration_timeout = timeout;
227 this->limit = llimit;
230 void Update(const std::string &n, const std::string &hst)
236 /** Reference counter. Contains an int as to how many users are connected to this class. :)
237 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
238 * are 0 users on it - it will go away in RAM. :)
240 unsigned long RefCount;
242 /** 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
246 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
255 /** Returns the type, CC_ALLOW or CC_DENY
259 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
262 std::string& GetName()
267 /** Returns the registration timeout
269 time_t GetRegTimeout()
271 return (registration_timeout ? registration_timeout : 90);
274 /** Returns the allowed or denied IP mask
276 const std::string& GetHost()
295 /** Returns the ping frequency
297 unsigned int GetPingTime()
299 return (pingtime ? pingtime : 120);
302 /** Returns the password or an empty string
304 const std::string& GetPass()
309 /** Returns the hash or an empty string
311 const std::string& GetHash()
316 /** Returns the maximum sendq value
318 unsigned long GetSendqMax()
320 return (sendqmax ? sendqmax : 262114);
323 /** Returns the maximum recvq value
325 unsigned long GetRecvqMax()
327 return (recvqmax ? recvqmax : 4096);
330 /** Returusn the maximum number of local sessions
332 unsigned long GetMaxLocal()
337 /** Returns the maximum number of global sessions
339 unsigned long GetMaxGlobal()
345 /** 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.
347 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
349 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
351 typedef std::vector<ConnectClass*> ClassVector;
353 /** Typedef for the list of user-channel records for a user
355 typedef std::map<Channel*, char> UserChanList;
357 /** Shorthand for an iterator into a UserChanList
359 typedef UserChanList::iterator UCListIter;
361 /* Required forward declaration
365 /** Visibility data for a user.
366 * If a user has a non-null instance of this class in their User,
367 * then it is used to determine if this user is visible to other users
370 class CoreExport VisData
376 /** Destroy a visdata
379 /** Is this user visible to some other user?
380 * @param user The other user to compare to
381 * @return true True if the user is visible to the other user, false if not
383 virtual bool VisibleTo(User* user);
386 /** Holds all information about a user
387 * This class stores all information about a user connected to the irc server. Everything about a
388 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
389 * user's nickname and hostname.
391 class CoreExport User : public EventHandler
394 /** A list of channels the user has a pending invite to.
395 * Upon INVITE channels are added, and upon JOIN, the
396 * channels are removed from this list.
400 /** Cached nick!ident@dhost value using the displayed hostname
402 std::string cached_fullhost;
404 /** Cached ident@ip value using the real IP address
406 std::string cached_hostip;
408 /** Cached ident@realhost value using the real hostname
410 std::string cached_makehost;
412 /** Cached nick!ident@realhost value using the real hostname
414 std::string cached_fullrealhost;
416 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
418 std::string cachedip;
420 /** When we erase the user (in the destructor),
421 * we call this method to subtract one from all
422 * mode characters this user is making use of.
424 void DecrementModes();
426 std::set<std::string> *AllowedOperCommands;
427 std::set<std::string> *AllowedPrivs;
429 /** Allowed user modes from oper classes. */
430 std::bitset<64> AllowedUserModes;
432 /** Allowed channel modes from oper classes. */
433 std::bitset<64> AllowedChanModes;
436 /** Pointer to creator.
437 * This is required to make use of core functions
438 * from within the User class.
440 InspIRCd* ServerInstance;
442 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
443 * The pointer is guarenteed to *always* be valid. :)
445 ConnectClass *MyClass;
447 /** User visibility state, see definition of VisData.
451 /** Hostname of connection.
452 * This should be valid as per RFC1035.
456 /** Stats counter for bytes inbound
460 /** Stats counter for bytes outbound
464 /** Stats counter for commands inbound
468 /** Stats counter for commands outbound
472 /** True if user has authenticated, false if otherwise
476 /** Used by User to indicate the registration status of the connection
477 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
478 * the connection state.
482 /** Time the connection was last pinged
486 /** Time the connection was created, set in the constructor. This
487 * may be different from the time the user's classbase object was
492 /** Time that the connection last sent a message, used to calculate idle time
496 /** Used by PING checking code
500 /** Stored reverse lookup from res_forward. Should not be used after resolution.
502 std::string stored_host;
504 /** Starts a DNS lookup of the user's IP.
505 * This will cause two UserResolver classes to be instantiated.
506 * When complete, these objects set User::dns_done to true.
508 void StartDNSLookup();
510 /** The users nickname.
511 * An invalid nickname indicates an unregistered connection prior to the NICK command.
512 * Use InspIRCd::IsNick() to validate nicknames.
516 /** The user's unique identifier.
517 * This is the unique identifier which the user has across the network.
521 /** The users ident reply.
522 * Two characters are added to the user-defined limit to compensate for the tilde etc.
526 /** The host displayed to non-opers (used for cloaking etc).
527 * This usually matches the value of User::host.
531 /** The users full name (GECOS).
533 std::string fullname;
535 /** The user's mode list.
536 * NOT a null terminated string.
538 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
539 * if (modes[modeletter-65]) is set, then the mode is
540 * set, for example, to work out if mode +s is set, we check the field
541 * User::modes['s'-65] != 0.
542 * The following RFC characters o, w, s, i have constants defined via an
543 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
545 std::bitset<64> modes;
547 /** What snomasks are set on this user.
548 * This functions the same as the above modes.
550 std::bitset<64> snomasks;
552 /** Channels this user is on, and the permissions they have there
556 /** The server the user is connected to.
560 /** The user's away message.
561 * If this string is empty, the user is not marked as away.
565 /** Time the user last went away.
566 * This is ONLY RELIABLE if user IS_AWAY()!
570 /** The oper type they logged in as, if they are an oper.
571 * This is used to check permissions in operclasses, so that
572 * we can say 'yay' or 'nay' to any commands they issue.
573 * The value of this is the value of a valid 'type name=' tag.
577 /** True when DNS lookups are completed.
578 * The UserResolver classes res_forward and res_reverse will
579 * set this value once they complete.
583 /** Password specified by the user when they registered.
584 * This is stored even if the <connect> block doesnt need a password, so that
585 * modules may check it.
587 std::string password;
589 /** User's receive queue.
590 * Lines from the IRCd awaiting processing are stored here.
591 * Upgraded april 2005, old system a bit hairy.
595 /** User's send queue.
596 * Lines waiting to be sent are stored here until their buffer is flushed.
600 /** Message user will quit with. Not to be set externally.
604 /** Quit message shown to opers - not to be set externally.
606 std::string operquitmsg;
608 /** Whether or not to send an snotice about this user's quitting
612 /** If this is set to true, then all socket operations for the user
613 * are dropped into the bit-bucket.
614 * This value is set by QuitUser, and is not needed seperately from that call.
615 * Please note that setting this value alone will NOT cause the user to quit.
619 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
620 * GetIPString/GetPort to obtain its values.
624 /** Initialize the clients sockaddr
625 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
626 * @param ip A human-readable IP address for this user matching the protcol_family
627 * @param port The port number of this user or zero for a remote user
629 void SetSockAddr(int protocol_family, const char* ip, int port);
631 /** Get port number from sockaddr
632 * @return The port number of this user.
636 /** Get protocol family from sockaddr
637 * @return The protocol family of this user, either AF_INET or AF_INET6
639 int GetProtocolFamily();
641 /** Get IP string from sockaddr, using static internal buffer
642 * @return The IP string
644 const char* GetIPString();
646 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
647 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
648 * This may be used for CIDR clone detection, etc.
650 * (XXX, brief note: when we do the sockets rewrite, this should move down a
651 * level so it may be used on more derived objects. -- w00t)
653 const char *GetCIDRMask(int range);
655 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
659 /** This value contains how far into the penalty threshold the user is. Once its over
660 * the penalty threshold then commands are held and processed on-timer.
664 /** Default constructor
665 * @throw CoreException if the UID allocated to the user already exists
666 * @param Instance Creator instance
667 * @param uid User UUID, or empty to allocate one automatically
669 User(InspIRCd* Instance, const std::string &uid = "");
671 /** Check if the user matches a G or K line, and disconnect them if they do.
672 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
673 * Returns true if the user matched a ban, false else.
675 bool CheckLines(bool doZline = false);
677 /** Returns the full displayed host of the user
678 * This member function returns the hostname of the user as seen by other users
679 * on the server, in nick!ident&at;host form.
680 * @return The full masked host of the user
682 virtual const std::string GetFullHost();
684 /** Returns the full real host of the user
685 * This member function returns the hostname of the user as seen by other users
686 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
687 * e.g. through a module, then this method will ignore it and return the true hostname.
688 * @return The full real host of the user
690 virtual const std::string GetFullRealHost();
692 /** This clears any cached results that are used for GetFullRealHost() etc.
693 * The results of these calls are cached as generating them can be generally expensive.
695 void InvalidateCache();
697 /** Create a displayable mode string for this users snomasks
698 * @return The notice mask character sequence
700 const char* FormatNoticeMasks();
702 /** Process a snomask modifier string, e.g. +abc-de
703 * @param sm A sequence of notice mask characters
704 * @return The cleaned mode sequence which can be output,
705 * e.g. in the above example if masks c and e are not
706 * valid, this function will return +ab-d
708 std::string ProcessNoticeMasks(const char *sm);
710 /** Returns true if a notice mask is set
711 * @param sm A notice mask character to check
712 * @return True if the notice mask is set
714 bool IsNoticeMaskSet(unsigned char sm);
716 /** Changed a specific notice mask value
717 * @param sm The server notice mask to change
718 * @param value An on/off value for this mask
720 void SetNoticeMask(unsigned char sm, bool value);
722 /** Create a displayable mode string for this users umodes
723 * @param The mode string
725 const char* FormatModes(bool showparameters = false);
727 /** Returns true if a specific mode is set
728 * @param m The user mode
729 * @return True if the mode is set
731 bool IsModeSet(unsigned char m);
733 /** Set a specific usermode to on or off
734 * @param m The user mode
735 * @param value On or off setting of the mode
737 void SetMode(unsigned char m, bool value);
739 /** Returns true if a user is invited to a channel.
740 * @param channel A channel name to look up
741 * @return True if the user is invited to the given channel
743 virtual bool IsInvited(const irc::string &channel);
745 /** Adds a channel to a users invite list (invites them to a channel)
746 * @param channel A channel name to add
747 * @param timeout When the invite should expire (0 == never)
749 virtual void InviteTo(const irc::string &channel, time_t timeout);
751 /** Removes a channel from a users invite list.
752 * This member function is called on successfully joining an invite only channel
753 * to which the user has previously been invited, to clear the invitation.
754 * @param channel The channel to remove the invite to
756 virtual void RemoveInvite(const irc::string &channel);
758 /** Returns true or false for if a user can execute a privilaged oper command.
759 * This is done by looking up their oper type from User::oper, then referencing
760 * this to their oper classes and checking the commands they can execute.
761 * @param command A command (should be all CAPS)
762 * @return True if this user can execute the command
764 bool HasPermission(const std::string &command);
766 /** Returns true if a user has a given permission.
767 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
768 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
770 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
771 * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
772 * @return True if this user has the permission in question.
774 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
776 /** Returns true or false if a user can set a privileged user or channel mode.
777 * This is done by looking up their oper type from User::oper, then referencing
778 * this to their oper classes, and checking the modes they can set.
779 * @param mode The mode the check
780 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
781 * @return True if the user can set or unset this mode.
783 bool HasModePermission(unsigned char mode, ModeType type);
785 /** Calls read() to read some data for this user using their fd.
786 * @param buffer The buffer to read into
787 * @param size The size of data to read
788 * @return The number of bytes read, or -1 if an error occured.
790 int ReadData(void* buffer, size_t size);
792 /** This method adds data to the read buffer of the user.
793 * The buffer can grow to any size within limits of the available memory,
794 * managed by the size of a std::string, however if any individual line in
795 * the buffer grows over 600 bytes in length (which is 88 chars over the
796 * RFC-specified limit per line) then the method will return false and the
797 * text will not be inserted.
798 * @param a The string to add to the users read buffer
799 * @return True if the string was successfully added to the read buffer
801 bool AddBuffer(const std::string &a);
803 /** This method returns true if the buffer contains at least one carriage return
804 * character (e.g. one complete line may be read)
805 * @return True if there is at least one complete line in the users buffer
807 bool BufferIsReady();
809 /** This function clears the entire buffer by setting it to an empty string.
813 /** This method returns the first available string at the tail end of the buffer
814 * and advances the tail end of the buffer past the string. This means it is
815 * a one way operation in a similar way to strtok(), and multiple calls return
816 * multiple lines if they are available. The results of this function if there
817 * are no lines to be read are unknown, always use BufferIsReady() to check if
818 * it is ok to read the buffer before calling GetBuffer().
819 * @return The string at the tail end of this users buffer
821 std::string GetBuffer();
823 /** Adds to the user's write buffer.
824 * You may add any amount of text up to this users sendq value, if you exceed the
825 * sendq value, the user will be removed, and further buffer adds will be dropped.
826 * @param data The data to add to the write buffer
828 void AddWriteBuf(const std::string &data);
830 /** Flushes as much of the user's buffer to the file descriptor as possible.
831 * This function may not always flush the entire buffer, rather instead as much of it
832 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
833 * position is advanced forwards and the rest of the data sent at the next call to
836 void FlushWriteBuf();
838 /** Returns the list of channels this user has been invited to but has not yet joined.
839 * @return A list of channels the user is invited to
841 InvitedList* GetInviteList();
843 /** Creates a wildcard host.
844 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
845 * @return The wildcarded hostname in *!*@host form
847 char* MakeWildHost();
849 /** Creates a usermask with real host.
850 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
851 * @return the usermask in the format user@host
853 const std::string& MakeHost();
855 /** Creates a usermask with real ip.
856 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
857 * @return the usermask in the format user@ip
859 const std::string& MakeHostIP();
861 /** Shuts down and closes the user's socket
862 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
863 * which will call CloseSocket() for you.
867 /** Add the user to WHOWAS system
871 /** Oper up the user using the given opertype.
872 * This will also give the +o usermode.
873 * @param opertype The oper type to oper as
875 void Oper(const std::string &opertype, const std::string &opername);
877 /** Call this method to find the matching <connect> for a user, and to check them against it.
881 /** Use this method to fully connect a user.
882 * This will send the message of the day, check G/K/E lines, etc.
886 /** Change this users hash key to a new string.
887 * You should not call this function directly. It is used by the core
888 * to update the users hash entry on a nickchange.
889 * @param New new user_hash key
890 * @return Pointer to User in hash (usually 'this')
892 User* UpdateNickHash(const char* New);
894 /** Force a nickname change.
895 * If the nickname change fails (for example, because the nick in question
896 * already exists) this function will return false, and you must then either
897 * output an error message, or quit the user for nickname collision.
898 * @param newnick The nickname to change to
899 * @return True if the nickchange was successful.
901 bool ForceNickChange(const char* newnick);
904 * This will clear the +o usermode and unset the user's oper type
908 /** Write text to this user, appending CR/LF.
909 * @param text A std::string to send to the user
911 void Write(std::string text);
913 /** Write text to this user, appending CR/LF.
914 * @param text The format string for text to send to the user
915 * @param ... POD-type format arguments
917 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
919 /** Write text to this user, appending CR/LF and prepending :server.name
920 * @param text A std::string to send to the user
922 void WriteServ(const std::string& text);
924 /** Write text to this user, appending CR/LF and prepending :server.name
925 * @param text The format string for text to send to the user
926 * @param ... POD-type format arguments
928 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
930 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
932 void WriteNumeric(unsigned int numeric, const std::string &text);
934 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
935 * @param user The user to prepend the :nick!user@host of
936 * @param text A std::string to send to the user
938 void WriteFrom(User *user, const std::string &text);
940 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
941 * @param user The user to prepend the :nick!user@host of
942 * @param text The format string for text to send to the user
943 * @param ... POD-type format arguments
945 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
947 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
948 * @param dest The user to route the message to
949 * @param text A std::string to send to the user
951 void WriteTo(User *dest, const std::string &data);
953 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
954 * @param dest The user to route the message to
955 * @param text The format string for text to send to the user
956 * @param ... POD-type format arguments
958 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
960 /** Write to all users that can see this user (including this user in the list), appending CR/LF
961 * @param text A std::string to send to the users
963 void WriteCommon(const std::string &text);
965 /** Write to all users that can see this user (including this user in the list), appending CR/LF
966 * @param text The format string for text to send to the users
967 * @param ... POD-type format arguments
969 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
971 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
972 * @param text The format string for text to send to the users
973 * @param ... POD-type format arguments
975 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
977 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
978 * @param text A std::string to send to the users
980 void WriteCommonExcept(const std::string &text);
982 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
983 * quit message for opers only.
984 * @param normal_text Normal user quit message
985 * @param oper_text Oper only quit message
987 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
989 /** Write a WALLOPS message from this user to all local opers.
990 * If this user is not opered, the function will return without doing anything.
991 * @param text The format string to send in the WALLOPS message
992 * @param ... Format arguments
994 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
996 /** Write a WALLOPS message from this user to all local opers.
997 * If this user is not opered, the function will return without doing anything.
998 * @param text The text to send in the WALLOPS message
1000 void WriteWallOps(const std::string &text);
1002 /** Return true if the user shares at least one channel with another user
1003 * @param other The other user to compare the channel list against
1004 * @return True if the given user shares at least one channel with this user
1006 bool SharesChannelWith(User *other);
1008 /** Change the displayed host of a user.
1009 * ALWAYS use this function, rather than writing User::dhost directly,
1010 * as this triggers module events allowing the change to be syncronized to
1011 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1012 * before setting their host field.
1013 * @param host The new hostname to set
1014 * @return True if the change succeeded, false if it didn't
1016 bool ChangeDisplayedHost(const char* host);
1018 /** Change the ident (username) of a user.
1019 * ALWAYS use this function, rather than writing User::ident directly,
1020 * as this correctly causes the user to seem to quit (where configured)
1021 * before setting their ident field.
1022 * @param host The new ident to set
1023 * @return True if the change succeeded, false if it didn't
1025 bool ChangeIdent(const char* newident);
1027 /** Change a users realname field.
1028 * ALWAYS use this function, rather than writing User::fullname directly,
1029 * as this triggers module events allowing the change to be syncronized to
1031 * @param gecos The user's new realname
1032 * @return True if the change succeeded, false if otherwise
1034 bool ChangeName(const char* gecos);
1036 /** Send a command to all local users from this user
1037 * The command given must be able to send text with the
1038 * first parameter as a servermask (e.g. $*), so basically
1039 * you should use PRIVMSG or NOTICE.
1040 * @param command the command to send
1041 * @param text The text format string to send
1042 * @param ... Format arguments
1044 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
1046 /** Compile a channel list for this user, and send it to the user 'source'
1047 * Used internally by WHOIS
1048 * @param The user to send the channel list to if it is not too long
1049 * @return This user's channel list
1051 std::string ChannelList(User* source);
1053 /** Split the channel list in cl which came from dest, and spool it to this user
1054 * Used internally by WHOIS
1055 * @param dest The user the original channel list came from
1056 * @param cl The channel list as a string obtained from User::ChannelList()
1058 void SplitChanList(User* dest, const std::string &cl);
1060 /** Remove this user from all channels they are on, and delete any that are now empty.
1061 * This is used by QUIT, and will not send part messages!
1063 void PurgeEmptyChannels();
1065 /** Get the connect class which this user belongs to.
1066 * @return A pointer to this user's connect class
1068 ConnectClass *GetClass();
1070 /** Set the connect class to which this user belongs to.
1071 * @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.
1072 * @return A reference to this user's current connect class.
1074 ConnectClass *SetClass(const std::string &explicit_name = "");
1076 /** Show the message of the day to this user
1080 /** Show the server RULES file to this user
1084 /** Set oper-specific quit message shown to opers only when the user quits
1085 * (overrides any sent by QuitUser)
1087 void SetOperQuit(const std::string &oquit);
1089 /** Get oper-specific quit message shown only to opers when the user quits.
1090 * (overrides any sent by QuitUser)
1092 const std::string& GetOperQuit();
1094 /** Increases a user's command penalty by a set amount.
1096 void IncreasePenalty(int increase);
1098 /** Decreases a user's command penalty by a set amount.
1100 void DecreasePenalty(int decrease);
1102 /** Handle socket event.
1103 * From EventHandler class.
1104 * @param et Event type
1105 * @param errornum Error number for EVENT_ERROR events
1107 void HandleEvent(EventType et, int errornum = 0);
1109 /** Default destructor
1114 /** Derived from Resolver, and performs user forward/reverse lookups.
1116 class CoreExport UserResolver : public Resolver
1119 /** User this class is 'attached' to.
1122 /** File descriptor teh lookup is bound to
1125 /** True if the lookup is forward, false if is a reverse lookup
1129 /** Create a resolver.
1130 * @param Instance The creating instance
1131 * @param user The user to begin lookup on
1132 * @param to_resolve The IP or host to resolve
1133 * @param qt The query type
1134 * @param cache Modified by the constructor if the result was cached
1136 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1138 /** Called on successful lookup
1139 * @param result Result string
1140 * @param ttl Time to live for result
1141 * @param cached True if the result was found in the cache
1143 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
1145 /** Called on failed lookup
1146 * @param e Error code
1147 * @param errormessage Error message string
1149 void OnError(ResolverError e, const std::string &errormessage);
1152 /* Configuration callbacks */
1153 //class ServerConfig;