1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 "inspircd_config.h"
21 #include "inspstring.h"
22 #include "connection.h"
26 /** Channel status for a user
39 /** connect class types
48 /** RFC1459 channel modes
51 /** +s: Server notices */
52 UM_SERVERNOTICE = 's' - 65,
54 UM_WALLOPS = 'w' - 65,
56 UM_INVISIBLE = 'i' - 65,
58 UM_OPERATOR = 'o' - 65,
59 /** +n: Server notice mask */
63 /** Registration state of a user, e.g.
64 * have they sent USER, NICK, PASS yet?
66 enum RegistrationState {
68 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
69 REG_NONE = 0, /* Has sent nothing */
72 REG_USER = 1, /* Has sent USER */
73 REG_NICK = 2, /* Has sent NICK */
74 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
75 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
78 /* Required forward declaration */
81 /** Derived from Resolver, and performs user forward/reverse lookups.
83 class CoreExport UserResolver : public Resolver
86 /** User this class is 'attached' to.
89 /** File descriptor teh lookup is bound to
92 /** True if the lookup is forward, false if is a reverse lookup
96 /** Create a resolver.
97 * @param Instance The creating instance
98 * @param user The user to begin lookup on
99 * @param to_resolve The IP or host to resolve
100 * @param qt The query type
101 * @param cache Modified by the constructor if the result was cached
103 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
105 /** Called on successful lookup
106 * @param result Result string
107 * @param ttl Time to live for result
108 * @param cached True if the result was found in the cache
109 * @param resultnum Result number, we are only interested in result 0
111 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
113 /** Called on failed lookup
114 * @param e Error code
115 * @param errormessage Error message string
117 void OnError(ResolverError e, const std::string &errormessage);
121 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
123 class CoreExport ConnectClass : public classbase
126 /** Type of line, either CC_ALLOW or CC_DENY
129 /** Connect class name
132 /** Max time to register the connection in seconds
134 unsigned int registration_timeout;
135 /** Number of lines in buffer before excess flood is triggered
138 /** Host mask for this line
141 /** Number of seconds between pings for this line
143 unsigned int pingtime;
144 /** (Optional) Password for this line
148 /** Threshold value for flood disconnect
150 unsigned int threshold;
152 /** Maximum size of sendq for users in this class (bytes)
154 unsigned long sendqmax;
156 /** Maximum size of recvq for users in this class (bytes)
158 unsigned long recvqmax;
160 /** Local max when connecting by this connection class
162 unsigned long maxlocal;
164 /** Global max when connecting by this connection class
166 unsigned long maxglobal;
168 /** Max channels for this class
170 unsigned int maxchans;
172 /** Port number this connect class applies to
178 /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
180 ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
181 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
182 pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
183 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
184 port(source->port), RefCount(0), disabled(false), limit(0)
188 /** Create a new connect class with no settings.
190 ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
191 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
195 /** Create a new connect class to ALLOW connections.
196 * @param thename Name of the connect class
197 * @param timeout The registration timeout
198 * @param fld The flood value
199 * @param hst The IP mask to allow
200 * @param ping The ping frequency
201 * @param pas The password to be used
202 * @param thres The flooding threshold
203 * @param sendq The maximum sendq value
204 * @param recvq The maximum recvq value
205 * @param maxl The maximum local sessions
206 * @param maxg The maximum global sessions
208 ConnectClass(const std::string &thename, 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 = 0) :
211 type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
212 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
214 /** Create a new connect class to DENY connections
215 * @param thename Name of the connect class
216 * @param hst The IP mask to deny
218 ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
219 flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
223 /* Create a new connect class based on another class
224 * @param thename The name of the connect class
225 * @param source Another connect class to inherit all but the name from
227 ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
228 registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
229 pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
230 recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
231 port(source->port), RefCount(0), disabled(false), limit(0)
235 void SetDisabled(bool t)
242 return this->disabled;
245 /* Update an existing entry with new values
247 void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
248 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
249 unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
252 registration_timeout = timeout;
279 /** Reference counter. Contains an int as to how many users are connected to this class. :)
280 * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
281 * are 0 users on it - it will go away in RAM. :)
283 unsigned long RefCount;
285 /** 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
289 /** How many users may be in this connect class before they are refused? (0 = disabled = default)
298 /** Returns the type, CC_ALLOW or CC_DENY
302 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
305 std::string& GetName()
310 /** Returns the registration timeout
312 unsigned int GetRegTimeout()
314 return (registration_timeout ? registration_timeout : 90);
317 /** Returns the flood limit
319 unsigned int GetFlood()
321 return (threshold ? flood : 999);
324 /** Returns the allowed or denied IP mask
326 const std::string& GetHost()
345 /** Returns the ping frequency
347 unsigned int GetPingTime()
349 return (pingtime ? pingtime : 120);
352 /** Returns the password or an empty string
354 const std::string& GetPass()
359 /** Returns the flood threshold value
361 unsigned int GetThreshold()
363 return (threshold ? threshold : 1);
366 /** Returns the maximum sendq value
368 unsigned long GetSendqMax()
370 return (sendqmax ? sendqmax : 262114);
373 /** Returns the maximum recvq value
375 unsigned long GetRecvqMax()
377 return (recvqmax ? recvqmax : 4096);
380 /** Returusn the maximum number of local sessions
382 unsigned long GetMaxLocal()
387 /** Returns the maximum number of global sessions
389 unsigned long GetMaxGlobal()
395 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
397 typedef std::vector<irc::string> InvitedList;
399 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
401 typedef std::vector<ConnectClass*> ClassVector;
403 /** Typedef for the list of user-channel records for a user
405 typedef std::map<Channel*, char> UserChanList;
407 /** Shorthand for an iterator into a UserChanList
409 typedef UserChanList::iterator UCListIter;
411 /* Required forward declaration
415 /** Visibility data for a user.
416 * If a user has a non-null instance of this class in their User,
417 * then it is used to determine if this user is visible to other users
420 class CoreExport VisData
426 /** Destroy a visdata
429 /** Is this user visible to some other user?
430 * @param user The other user to compare to
431 * @return true True if the user is visible to the other user, false if not
433 virtual bool VisibleTo(User* user);
436 /** Holds all information about a user
437 * This class stores all information about a user connected to the irc server. Everything about a
438 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
439 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
440 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
441 * file descriptor value.
443 class CoreExport User : public connection
446 /** Pointer to creator.
447 * This is required to make use of core functions
448 * from within the User class.
450 InspIRCd* ServerInstance;
452 /** A list of channels the user has a pending invite to.
453 * Upon INVITE channels are added, and upon JOIN, the
454 * channels are removed from this list.
458 /** Number of channels this user is currently on
460 unsigned int ChannelCount;
462 /** Cached nick!ident@host value using the real hostname
464 char* cached_fullhost;
466 /** Cached nick!ident@ip value using the real IP address
470 /** Cached nick!ident@host value using the masked hostname
472 char* cached_makehost;
474 /** Cached nick!ident@realhost value using the real hostname
476 char* cached_fullrealhost;
478 /** When we erase the user (in the destructor),
479 * we call this method to subtract one from all
480 * mode characters this user is making use of.
482 void DecrementModes();
484 /** Oper-only quit message for this user if non-null
488 /** Max channels for this user
490 unsigned int MaxChans;
492 std::map<std::string, bool>* AllowedOperCommands;
495 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
496 * The pointer is guarenteed to *always* be valid. :)
498 ConnectClass *MyClass;
500 /** Resolvers for looking up this users IP address
501 * This will occur if and when res_reverse completes.
502 * When this class completes its lookup, User::dns_done
503 * will be set from false to true.
505 UserResolver* res_forward;
507 /** Resolvers for looking up this users hostname
508 * This is instantiated by User::StartDNSLookup(),
509 * and on success, instantiates User::res_reverse.
511 UserResolver* res_reverse;
513 /** User visibility state, see definition of VisData.
517 /** Stored reverse lookup from res_forward
519 std::string stored_host;
521 /** Starts a DNS lookup of the user's IP.
522 * This will cause two UserResolver classes to be instantiated.
523 * When complete, these objects set User::dns_done to true.
525 void StartDNSLookup();
527 unsigned int GetMaxChans();
529 /** The users nickname.
530 * An invalid nickname indicates an unregistered connection prior to the NICK command.
531 * Use InspIRCd::IsNick() to validate nicknames.
535 /** The user's unique identifier.
536 * This is the unique identifier which the user has across the network.
538 char uuid[UUID_LENGTH];
540 /** The users ident reply.
541 * Two characters are added to the user-defined limit to compensate for the tilde etc.
543 char ident[IDENTMAX+2];
545 /** The host displayed to non-opers (used for cloaking etc).
546 * This usually matches the value of User::host.
550 /** The users full name (GECOS).
552 char fullname[MAXGECOS+1];
554 /** The user's mode list.
555 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
556 * this is an array of values in a similar way to channel modes.
557 * A value of 1 in field (modeletter-65) indicates that the mode is
558 * set, for example, to work out if mode +s is set, we check the field
559 * User::modes['s'-65] != 0.
560 * The following RFC characters o, w, s, i have constants defined via an
561 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
565 /** What snomasks are set on this user.
566 * This functions the same as the above modes.
570 /** Channels this user is on, and the permissions they have there
574 /** The server the user is connected to.
578 /** The user's away message.
579 * If this string is empty, the user is not marked as away.
581 char awaymsg[MAXAWAY+1];
583 /** Timestamp of current time + connection class timeout.
584 * This user must send USER/NICK before this timestamp is
585 * reached or they will be disconnected.
589 /** The oper type they logged in as, if they are an oper.
590 * This is used to check permissions in operclasses, so that
591 * we can say 'yay' or 'nay' to any commands they issue.
592 * The value of this is the value of a valid 'type name=' tag.
596 /** True when DNS lookups are completed.
597 * The UserResolver classes res_forward and res_reverse will
598 * set this value once they complete.
602 /** Password specified by the user when they registered.
603 * This is stored even if the <connect> block doesnt need a password, so that
604 * modules may check it.
608 /** User's receive queue.
609 * Lines from the IRCd awaiting processing are stored here.
610 * Upgraded april 2005, old system a bit hairy.
614 /** User's send queue.
615 * Lines waiting to be sent are stored here until their buffer is flushed.
619 /** Flood counters - lines received
621 unsigned int lines_in;
623 /** Flood counters - time lines_in is due to be reset
627 /** If this is set to true, then all read operations for the user
628 * are dropped into the bit-bucket.
629 * This is used by the global CullList, but please note that setting this value
630 * alone will NOT cause the user to quit. This means it can be used seperately,
631 * for example by shun modules etc.
635 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
636 * GetIPString/GetPort to obtain its values.
640 /** Initialize the clients sockaddr
641 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
642 * @param ip A human-readable IP address for this user matching the protcol_family
643 * @param port The port number of this user or zero for a remote user
645 void SetSockAddr(int protocol_family, const char* ip, int port);
647 /** Get port number from sockaddr
648 * @return The port number of this user.
652 /** Get protocol family from sockaddr
653 * @return The protocol family of this user, either AF_INET or AF_INET6
655 int GetProtocolFamily();
657 /** Get IP string from sockaddr, using static internal buffer
658 * @return The IP string
660 const char* GetIPString();
662 /* Write error string
664 std::string WriteError;
666 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
670 /** This value contains how far into the penalty threshold the user is. Once its over
671 * the penalty threshold then commands are held and processed on-timer.
675 /** True if we are flushing penalty lines
679 /** If this bool is set then penalty rules do not apply to this user
681 bool ExemptFromPenalty;
683 /** Default constructor
684 * @throw CoreException if the UID allocated to the user already exists
685 * @param Instance Creator instance
686 * @param uid User UUID, or empty to allocate one automatically
688 User(InspIRCd* Instance, const std::string &uid = "");
690 /** Returns the full displayed host of the user
691 * This member function returns the hostname of the user as seen by other users
692 * on the server, in nick!ident&at;host form.
693 * @return The full masked host of the user
695 virtual char* GetFullHost();
697 /** Returns the full real host of the user
698 * This member function returns the hostname of the user as seen by other users
699 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
700 * e.g. through a module, then this method will ignore it and return the true hostname.
701 * @return The full real host of the user
703 virtual char* GetFullRealHost();
705 /** This clears any cached results that are used for GetFullRealHost() etc.
706 * The results of these calls are cached as generating them can be generally expensive.
708 void InvalidateCache();
710 /** Create a displayable mode string for this users snomasks
711 * @return The notice mask character sequence
713 const char* FormatNoticeMasks();
715 /** Process a snomask modifier string, e.g. +abc-de
716 * @param sm A sequence of notice mask characters
717 * @return The cleaned mode sequence which can be output,
718 * e.g. in the above example if masks c and e are not
719 * valid, this function will return +ab-d
721 std::string ProcessNoticeMasks(const char *sm);
723 /** Returns true if a notice mask is set
724 * @param sm A notice mask character to check
725 * @return True if the notice mask is set
727 bool IsNoticeMaskSet(unsigned char sm);
729 /** Changed a specific notice mask value
730 * @param sm The server notice mask to change
731 * @param value An on/off value for this mask
733 void SetNoticeMask(unsigned char sm, bool value);
735 /** Create a displayable mode string for this users umodes
736 * @param The mode string
738 const char* FormatModes();
740 /** Returns true if a specific mode is set
741 * @param m The user mode
742 * @return True if the mode is set
744 bool IsModeSet(unsigned char m);
746 /** Set a specific usermode to on or off
747 * @param m The user mode
748 * @param value On or off setting of the mode
750 void SetMode(unsigned char m, bool value);
752 /** Returns true if a user is invited to a channel.
753 * @param channel A channel name to look up
754 * @return True if the user is invited to the given channel
756 virtual bool IsInvited(const irc::string &channel);
758 /** Adds a channel to a users invite list (invites them to a channel)
759 * @param channel A channel name to add
761 virtual void InviteTo(const irc::string &channel);
763 /** Removes a channel from a users invite list.
764 * This member function is called on successfully joining an invite only channel
765 * to which the user has previously been invited, to clear the invitation.
766 * @param channel The channel to remove the invite to
768 virtual void RemoveInvite(const irc::string &channel);
770 /** Returns true or false for if a user can execute a privilaged oper command.
771 * This is done by looking up their oper type from User::oper, then referencing
772 * this to their oper classes and checking the commands they can execute.
773 * @param command A command (should be all CAPS)
774 * @return True if this user can execute the command
776 bool HasPermission(const std::string &command);
778 /** Calls read() to read some data for this user using their fd.
779 * @param buffer The buffer to read into
780 * @param size The size of data to read
781 * @return The number of bytes read, or -1 if an error occured.
783 int ReadData(void* buffer, size_t size);
785 /** This method adds data to the read buffer of the user.
786 * The buffer can grow to any size within limits of the available memory,
787 * managed by the size of a std::string, however if any individual line in
788 * the buffer grows over 600 bytes in length (which is 88 chars over the
789 * RFC-specified limit per line) then the method will return false and the
790 * text will not be inserted.
791 * @param a The string to add to the users read buffer
792 * @return True if the string was successfully added to the read buffer
794 bool AddBuffer(std::string a);
796 /** This method returns true if the buffer contains at least one carriage return
797 * character (e.g. one complete line may be read)
798 * @return True if there is at least one complete line in the users buffer
800 bool BufferIsReady();
802 /** This function clears the entire buffer by setting it to an empty string.
806 /** This method returns the first available string at the tail end of the buffer
807 * and advances the tail end of the buffer past the string. This means it is
808 * a one way operation in a similar way to strtok(), and multiple calls return
809 * multiple lines if they are available. The results of this function if there
810 * are no lines to be read are unknown, always use BufferIsReady() to check if
811 * it is ok to read the buffer before calling GetBuffer().
812 * @return The string at the tail end of this users buffer
814 std::string GetBuffer();
816 /** Sets the write error for a connection. This is done because the actual disconnect
817 * of a client may occur at an inopportune time such as half way through /LIST output.
818 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
819 * errored clients purged.
820 * @param error The error string to set.
822 void SetWriteError(const std::string &error);
824 /** Returns the write error which last occured on this connection or an empty string
826 * @return The error string which has occured for this user
828 const char* GetWriteError();
830 /** Adds to the user's write buffer.
831 * You may add any amount of text up to this users sendq value, if you exceed the
832 * sendq value, SetWriteError() will be called to set the users error string to
833 * "SendQ exceeded", and further buffer adds will be dropped.
834 * @param data The data to add to the write buffer
836 void AddWriteBuf(const std::string &data);
838 /** Flushes as much of the user's buffer to the file descriptor as possible.
839 * This function may not always flush the entire buffer, rather instead as much of it
840 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
841 * position is advanced forwards and the rest of the data sent at the next call to
844 void FlushWriteBuf();
846 /** Returns the list of channels this user has been invited to but has not yet joined.
847 * @return A list of channels the user is invited to
849 InvitedList* GetInviteList();
851 /** Creates a wildcard host.
852 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
853 * @return The wildcarded hostname in *!*@host form
855 char* MakeWildHost();
857 /** Creates a usermask with real host.
858 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
859 * @return the usermask in the format user@host
863 /** Creates a usermask with real ip.
864 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
865 * @return the usermask in the format user@ip
869 /** Shuts down and closes the user's socket
870 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
871 * which will call CloseSocket() for you.
875 /** Disconnect a user gracefully
876 * @param user The user to remove
877 * @param r The quit reason to show to normal users
878 * @param oreason The quit reason to show to opers
879 * @return Although this function has no return type, on exit the user provided will no longer exist.
881 static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
883 /** Add the user to WHOWAS system
887 /** Oper up the user using the given opertype.
888 * This will also give the +o usermode.
889 * @param opertype The oper type to oper as
891 void Oper(const std::string &opertype, const std::string &opername);
893 /** Call this method to find the matching <connect> for a user, and to check them against it.
897 /** Use this method to fully connect a user.
898 * This will send the message of the day, check G/K/E lines, etc.
902 /** Change this users hash key to a new string.
903 * You should not call this function directly. It is used by the core
904 * to update the users hash entry on a nickchange.
905 * @param New new user_hash key
906 * @return Pointer to User in hash (usually 'this')
908 User* UpdateNickHash(const char* New);
910 /** Force a nickname change.
911 * If the nickname change fails (for example, because the nick in question
912 * already exists) this function will return false, and you must then either
913 * output an error message, or quit the user for nickname collision.
914 * @param newnick The nickname to change to
915 * @return True if the nickchange was successful.
917 bool ForceNickChange(const char* newnick);
919 /** Add a client to the system.
920 * This will create a new User, insert it into the user_hash,
921 * initialize it as not yet registered, and add it to the socket engine.
922 * @param Instance a pointer to the server instance
923 * @param socket The socket id (file descriptor) this user is on
924 * @param port The port number this user connected on
925 * @param iscached This variable is reserved for future use
926 * @param ip The IP address of the user
927 * @return This function has no return value, but a call to AddClient may remove the user.
929 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
932 * This will clear the +o usermode and unset the user's oper type
936 /** Return the number of global clones of this user
937 * @return The global clone count of this user
939 unsigned long GlobalCloneCount();
941 /** Return the number of local clones of this user
942 * @return The local clone count of this user
944 unsigned long LocalCloneCount();
946 /** Remove all clone counts from the user, you should
947 * use this if you change the user's IP address in
948 * User::ip after they have registered.
950 void RemoveCloneCounts();
952 /** Write text to this user, appending CR/LF.
953 * @param text A std::string to send to the user
955 void Write(std::string text);
957 /** Write text to this user, appending CR/LF.
958 * @param text The format string for text to send to the user
959 * @param ... POD-type format arguments
961 void Write(const char *text, ...);
963 /** Write text to this user, appending CR/LF and prepending :server.name
964 * @param text A std::string to send to the user
966 void WriteServ(const std::string& text);
968 /** Write text to this user, appending CR/LF and prepending :server.name
969 * @param text The format string for text to send to the user
970 * @param ... POD-type format arguments
972 void WriteServ(const char* text, ...);
974 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
975 * @param user The user to prepend the :nick!user@host of
976 * @param text A std::string to send to the user
978 void WriteFrom(User *user, const std::string &text);
980 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
981 * @param user The user to prepend the :nick!user@host of
982 * @param text The format string for text to send to the user
983 * @param ... POD-type format arguments
985 void WriteFrom(User *user, const char* text, ...);
987 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
988 * @param dest The user to route the message to
989 * @param text A std::string to send to the user
991 void WriteTo(User *dest, const std::string &data);
993 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
994 * @param dest The user to route the message to
995 * @param text The format string for text to send to the user
996 * @param ... POD-type format arguments
998 void WriteTo(User *dest, const char *data, ...);
1000 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1001 * @param text A std::string to send to the users
1003 void WriteCommon(const std::string &text);
1005 /** Write to all users that can see this user (including this user in the list), appending CR/LF
1006 * @param text The format string for text to send to the users
1007 * @param ... POD-type format arguments
1009 void WriteCommon(const char* text, ...);
1011 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1012 * @param text The format string for text to send to the users
1013 * @param ... POD-type format arguments
1015 void WriteCommonExcept(const char* text, ...);
1017 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
1018 * @param text A std::string to send to the users
1020 void WriteCommonExcept(const std::string &text);
1022 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
1023 * quit message for opers only.
1024 * @param normal_text Normal user quit message
1025 * @param oper_text Oper only quit message
1027 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
1029 /** Write a WALLOPS message from this user to all local opers.
1030 * If this user is not opered, the function will return without doing anything.
1031 * @param text The format string to send in the WALLOPS message
1032 * @param ... Format arguments
1034 void WriteWallOps(const char* text, ...);
1036 /** Write a WALLOPS message from this user to all local opers.
1037 * If this user is not opered, the function will return without doing anything.
1038 * @param text The text to send in the WALLOPS message
1040 void WriteWallOps(const std::string &text);
1042 /** Return true if the user shares at least one channel with another user
1043 * @param other The other user to compare the channel list against
1044 * @return True if the given user shares at least one channel with this user
1046 bool SharesChannelWith(User *other);
1048 /** Change the displayed host of a user.
1049 * ALWAYS use this function, rather than writing User::dhost directly,
1050 * as this triggers module events allowing the change to be syncronized to
1051 * remote servers. This will also emulate a QUIT and rejoin (where configured)
1052 * before setting their host field.
1053 * @param host The new hostname to set
1054 * @return True if the change succeeded, false if it didn't
1056 bool ChangeDisplayedHost(const char* host);
1058 /** Change the ident (username) of a user.
1059 * ALWAYS use this function, rather than writing User::ident directly,
1060 * as this correctly causes the user to seem to quit (where configured)
1061 * before setting their ident field.
1062 * @param host The new ident to set
1063 * @return True if the change succeeded, false if it didn't
1065 bool ChangeIdent(const char* newident);
1067 /** Change a users realname field.
1068 * ALWAYS use this function, rather than writing User::fullname directly,
1069 * as this triggers module events allowing the change to be syncronized to
1071 * @param gecos The user's new realname
1072 * @return True if the change succeeded, false if otherwise
1074 bool ChangeName(const char* gecos);
1076 /** Send a command to all local users from this user
1077 * The command given must be able to send text with the
1078 * first parameter as a servermask (e.g. $*), so basically
1079 * you should use PRIVMSG or NOTICE.
1080 * @param command the command to send
1081 * @param text The text format string to send
1082 * @param ... Format arguments
1084 void SendAll(const char* command, char* text, ...);
1086 /** Compile a channel list for this user, and send it to the user 'source'
1087 * Used internally by WHOIS
1088 * @param The user to send the channel list to if it is not too long
1089 * @return This user's channel list
1091 std::string ChannelList(User* source);
1093 /** Split the channel list in cl which came from dest, and spool it to this user
1094 * Used internally by WHOIS
1095 * @param dest The user the original channel list came from
1096 * @param cl The channel list as a string obtained from User::ChannelList()
1098 void SplitChanList(User* dest, const std::string &cl);
1100 /** Remove this user from all channels they are on, and delete any that are now empty.
1101 * This is used by QUIT, and will not send part messages!
1103 void PurgeEmptyChannels();
1105 /** Get the connect class which this user belongs to.
1106 * @return A pointer to this user's connect class
1108 ConnectClass *GetClass();
1110 /** Set the connect class to which this user belongs to.
1111 * @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.
1112 * @return A reference to this user's current connect class.
1114 ConnectClass *SetClass(const std::string &explicit_name = "");
1116 /** Show the message of the day to this user
1120 /** Show the server RULES file to this user
1124 /** Set oper-specific quit message shown to opers only when the user quits
1125 * (overrides any sent by QuitUser)
1127 void SetOperQuit(const std::string &oquit);
1129 /** Get oper-specific quit message shown only to opers when the user quits.
1130 * (overrides any sent by QuitUser)
1132 const char* GetOperQuit();
1134 /** Increases a user's command penalty by a set amount.
1136 void IncreasePenalty(int increase);
1138 /** Decreases a user's command penalty by a set amount.
1140 void DecreasePenalty(int decrease);
1142 /** Handle socket event.
1143 * From EventHandler class.
1144 * @param et Event type
1145 * @param errornum Error number for EVENT_ERROR events
1147 void HandleEvent(EventType et, int errornum = 0);
1149 /** Default destructor
1154 /* Configuration callbacks */