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"
38 /** RFC1459 channel modes
41 UM_SERVERNOTICE = 's'-65,
43 UM_INVISIBLE = 'i'-65,
48 enum RegistrationState {
49 REG_NONE = 0, /* Has sent nothing */
50 REG_USER = 1, /* Has sent USER */
51 REG_NICK = 2, /* Has sent NICK */
52 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
53 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
58 /** Derived from Resolver, and performs user forward/reverse lookups.
60 class UserResolver : public Resolver
63 /** User this class is 'attached' to.
69 UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
71 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
72 void OnError(ResolverError e, const std::string &errormessage);
76 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
78 class ConnectClass : public classbase
81 /** Type of line, either CC_ALLOW or CC_DENY
84 /** Max time to register the connection in seconds
86 unsigned int registration_timeout;
87 /** Number of lines in buffer before excess flood is triggered
90 /** Host mask for this line
93 /** Number of seconds between pings for this line
95 unsigned int pingtime;
96 /** (Optional) Password for this line
100 /** Threshold value for flood disconnect
102 unsigned int threshold;
104 /** Maximum size of sendq for users in this class (bytes)
106 unsigned long sendqmax;
108 /** Maximum size of recvq for users in this class (bytes)
110 unsigned long recvqmax;
112 /** Local max when connecting by this connection class
114 unsigned long maxlocal;
116 /** Global max when connecting by this connection class
118 unsigned long maxglobal;
122 /** Create a new connect class with no settings.
124 ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
125 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
127 /** Create a new connect class to ALLOW connections.
128 * @param timeout The registration timeout
129 * @param fld The flood value
130 * @param hst The IP mask to allow
131 * @param ping The ping frequency
132 * @param pas The password to be used
133 * @param thres The flooding threshold
134 * @param sendq The maximum sendq value
135 * @param recvq The maximum recvq value
136 * @param maxl The maximum local sessions
137 * @param maxg The maximum global sessions
139 ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
140 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
141 unsigned long maxl, unsigned long maxg) :
142 type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
143 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
145 /** Create a new connect class to DENY connections
146 * @param hst The IP mask to deny
148 ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
149 pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
151 /** Returns the type, CC_ALLOW or CC_DENY
155 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
158 /** Returns the registration timeout
160 unsigned int GetRegTimeout()
162 return (registration_timeout ? registration_timeout : 90);
165 /** Returns the flood limit
167 unsigned int GetFlood()
169 return (threshold ? flood : 999);
172 /** Returns the allowed or denied IP mask
174 const std::string& GetHost()
179 /** Returns the ping frequency
181 unsigned int GetPingTime()
183 return (pingtime ? pingtime : 120);
186 /** Returns the password or an empty string
188 const std::string& GetPass()
193 /** Returns the flood threshold value
195 unsigned int GetThreshold()
197 return (threshold ? threshold : 1);
200 /** Returns the maximum sendq value
202 unsigned long GetSendqMax()
204 return (sendqmax ? sendqmax : 262114);
207 /** Returns the maximum recvq value
209 unsigned long GetRecvqMax()
211 return (recvqmax ? recvqmax : 4096);
214 /** Returusn the maximum number of local sessions
216 unsigned long GetMaxLocal()
218 return (maxlocal ? maxlocal : 1);
221 /** Returns the maximum number of global sessions
223 unsigned long GetMaxGlobal()
225 return (maxglobal ? maxglobal : 1);
229 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
231 typedef std::vector<irc::string> InvitedList;
233 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
235 typedef std::vector<ConnectClass> ClassVector;
237 /** Typedef for the list of user-channel records for a user
239 typedef std::map<chanrec*, char> UserChanList;
240 typedef UserChanList::iterator UCListIter;
242 /** Holds all information about a user
243 * This class stores all information about a user connected to the irc server. Everything about a
244 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
245 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
246 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
247 * file descriptor value.
249 class userrec : public connection
252 /** Pointer to creator.
253 * This is required to make use of core functions
254 * from within the userrec class.
256 InspIRCd* ServerInstance;
258 /** A list of channels the user has a pending invite to.
259 * Upon INVITE channels are added, and upon JOIN, the
260 * channels are removed from this list.
264 /** Number of channels this user is currently on
266 unsigned int ChannelCount;
268 /** Cached nick!ident@host value using the real hostname
270 char* cached_fullhost;
272 /** Cached nick!ident@ip value using the real IP address
276 /** Cached nick!ident@host value using the masked hostname
278 char* cached_makehost;
279 char* cached_fullrealhost;
281 /** When we erase the user (in the destructor),
282 * we call this method to subtract one from all
283 * mode characters this user is making use of.
285 void DecrementModes();
287 /** Resolvers for looking up this users IP address
288 * This will occur if and when res_reverse completes.
289 * When this class completes its lookup, userrec::dns_done
290 * will be set from false to true.
292 UserResolver* res_forward;
294 /** Resolvers for looking up this users hostname
295 * This is instantiated by userrec::StartDNSLookup(),
296 * and on success, instantiates userrec::res_reverse.
298 UserResolver* res_reverse;
300 /** Stored reverse lookup from res_forward
302 std::string stored_host;
304 /** Starts a DNS lookup of the user's IP.
305 * This will cause two UserResolver classes to be instantiated.
306 * When complete, these objects set userrec::dns_done to true.
308 void StartDNSLookup();
310 /** The users nickname.
311 * An invalid nickname indicates an unregistered connection prior to the NICK command.
312 * Use InspIRCd::IsNick() to validate nicknames.
316 /** The users ident reply.
317 * Two characters are added to the user-defined limit to compensate for the tilde etc.
319 char ident[IDENTMAX+2];
321 /** The host displayed to non-opers (used for cloaking etc).
322 * This usually matches the value of userrec::host.
326 /** The users full name (GECOS).
328 char fullname[MAXGECOS+1];
330 /** The user's mode list.
331 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
332 * this is an array of values in a similar way to channel modes.
333 * A value of 1 in field (modeletter-65) indicates that the mode is
334 * set, for example, to work out if mode +s is set, we check the field
335 * userrec::modes['s'-65] != 0.
336 * The following RFC characters o, w, s, i have constants defined via an
337 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
341 /** What snomasks are set on this user.
342 * This functions the same as the above modes.
346 /** Channels this user is on, and the permissions they have there
350 /** The server the user is connected to.
354 /** The user's away message.
355 * If this string is empty, the user is not marked as away.
357 char awaymsg[MAXAWAY+1];
359 /** Number of lines the user can place into the buffer
360 * (up to the global NetBufferSize bytes) before they
361 * are disconnected for excess flood
365 /** Timestamp of current time + connection class timeout.
366 * This user must send USER/NICK before this timestamp is
367 * reached or they will be disconnected.
371 /** The oper type they logged in as, if they are an oper.
372 * This is used to check permissions in operclasses, so that
373 * we can say 'yay' or 'nay' to any commands they issue.
374 * The value of this is the value of a valid 'type name=' tag.
378 /** True when DNS lookups are completed.
379 * The UserResolver classes res_forward and res_reverse will
380 * set this value once they complete.
384 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
386 unsigned int pingmax;
388 /** Password specified by the user when they registered.
389 * This is stored even if the <connect> block doesnt need a password, so that
390 * modules may check it.
394 /** User's receive queue.
395 * Lines from the IRCd awaiting processing are stored here.
396 * Upgraded april 2005, old system a bit hairy.
400 /** User's send queue.
401 * Lines waiting to be sent are stored here until their buffer is flushed.
405 /** Flood counters - lines received
409 /** Flood counters - time lines_in is due to be reset
413 /** Flood counters - Highest value lines_in may reach before the user gets disconnected
417 /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
418 * GetIPString/GetPort to obtain its values.
422 /** Initialize the clients sockaddr
423 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
424 * @param ip A human-readable IP address for this user matching the protcol_family
425 * @param port The port number of this user or zero for a remote user
427 void SetSockAddr(int protocol_family, const char* ip, int port);
429 /** Get port number from sockaddr
430 * @return The port number of this user.
434 /** Get protocol family from sockaddr
435 * @return The protocol family of this user, either AF_INET or AF_INET6
437 int GetProtocolFamily();
439 /** Get IP string from sockaddr, using static internal buffer
440 * @return The IP string
442 const char* GetIPString();
444 /** Get IP string from sockaddr, using caller-specified buffer
445 * @param buf A buffer to use
446 * @return The IP string
448 const char* GetIPString(char* buf);
450 /* Write error string
452 std::string WriteError;
454 /** Maximum size this user's sendq can become.
455 * Copied from the connect class on connect.
459 /** Maximum size this user's recvq can become.
460 * Copied from the connect class on connect.
464 /** This is true if the user matched an exception when they connected to the ircd.
465 * It isnt valid after this point, and you should not attempt to do anything with it
466 * after this point, because the eline might be removed at a later time, and/or no
467 * longer be applicable to this user. It is only used to save doing the eline lookup
468 * twice (instead we do it once and set this value).
472 /** Default constructor
473 * @throw Nothing at present
475 userrec(InspIRCd* Instance);
477 /** Returns the full displayed host of the user
478 * This member function returns the hostname of the user as seen by other users
479 * on the server, in nick!ident&at;host form.
480 * @return The full masked host of the user
482 virtual char* GetFullHost();
484 /** Returns the full real host of the user
485 * This member function returns the hostname of the user as seen by other users
486 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
487 * e.g. through a module, then this method will ignore it and return the true hostname.
488 * @return The full real host of the user
490 virtual char* GetFullRealHost();
492 /** This clears any cached results that are used for GetFullRealHost() etc.
493 * The results of these calls are cached as generating them can be generally expensive.
495 void InvalidateCache();
497 /** Create a displayable mode string for this users snomasks
498 * @return The notice mask character sequence
500 const char* FormatNoticeMasks();
502 /** Process a snomask modifier string, e.g. +abc-de
503 * @param sm A sequence of notice mask characters
504 * @return The cleaned mode sequence which can be output,
505 * e.g. in the above example if masks c and e are not
506 * valid, this function will return +ab-d
508 std::string ProcessNoticeMasks(const char *sm);
510 /** Returns true if a notice mask is set
511 * @param sm A notice mask character to check
512 * @return True if the notice mask is set
514 bool IsNoticeMaskSet(unsigned char sm);
516 /** Changed a specific notice mask value
517 * @param sm The server notice mask to change
518 * @param value An on/off value for this mask
520 void SetNoticeMask(unsigned char sm, bool value);
522 /** Create a displayable mode string for this users umodes
523 * @param The mode string
525 const char* FormatModes();
527 /** Returns true if a specific mode is set
528 * @param m The user mode
529 * @return True if the mode is set
531 bool IsModeSet(unsigned char m);
533 /** Set a specific usermode to on or off
534 * @param m The user mode
535 * @param value On or off setting of the mode
537 void SetMode(unsigned char m, bool value);
539 /** Returns true if a user is invited to a channel.
540 * @param channel A channel name to look up
541 * @return True if the user is invited to the given channel
543 virtual bool IsInvited(const irc::string &channel);
545 /** Adds a channel to a users invite list (invites them to a channel)
546 * @param channel A channel name to add
548 virtual void InviteTo(const irc::string &channel);
550 /** Removes a channel from a users invite list.
551 * This member function is called on successfully joining an invite only channel
552 * to which the user has previously been invited, to clear the invitation.
553 * @param channel The channel to remove the invite to
555 virtual void RemoveInvite(const irc::string &channel);
557 /** Returns true or false for if a user can execute a privilaged oper command.
558 * This is done by looking up their oper type from userrec::oper, then referencing
559 * this to their oper classes and checking the commands they can execute.
560 * @param command A command (should be all CAPS)
561 * @return True if this user can execute the command
563 bool HasPermission(const std::string &command);
565 /** Calls read() to read some data for this user using their fd.
566 * @param buffer The buffer to read into
567 * @param size The size of data to read
568 * @return The number of bytes read, or -1 if an error occured.
570 int ReadData(void* buffer, size_t size);
572 /** This method adds data to the read buffer of the user.
573 * The buffer can grow to any size within limits of the available memory,
574 * managed by the size of a std::string, however if any individual line in
575 * the buffer grows over 600 bytes in length (which is 88 chars over the
576 * RFC-specified limit per line) then the method will return false and the
577 * text will not be inserted.
578 * @param a The string to add to the users read buffer
579 * @return True if the string was successfully added to the read buffer
581 bool AddBuffer(std::string a);
583 /** This method returns true if the buffer contains at least one carriage return
584 * character (e.g. one complete line may be read)
585 * @return True if there is at least one complete line in the users buffer
587 bool BufferIsReady();
589 /** This function clears the entire buffer by setting it to an empty string.
593 /** This method returns the first available string at the tail end of the buffer
594 * and advances the tail end of the buffer past the string. This means it is
595 * a one way operation in a similar way to strtok(), and multiple calls return
596 * multiple lines if they are available. The results of this function if there
597 * are no lines to be read are unknown, always use BufferIsReady() to check if
598 * it is ok to read the buffer before calling GetBuffer().
599 * @return The string at the tail end of this users buffer
601 std::string GetBuffer();
603 /** Sets the write error for a connection. This is done because the actual disconnect
604 * of a client may occur at an inopportune time such as half way through /LIST output.
605 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
606 * errored clients purged.
607 * @param error The error string to set.
609 void SetWriteError(const std::string &error);
611 /** Returns the write error which last occured on this connection or an empty string
613 * @return The error string which has occured for this user
615 const char* GetWriteError();
617 /** Adds to the user's write buffer.
618 * You may add any amount of text up to this users sendq value, if you exceed the
619 * sendq value, SetWriteError() will be called to set the users error string to
620 * "SendQ exceeded", and further buffer adds will be dropped.
621 * @param data The data to add to the write buffer
623 void AddWriteBuf(const std::string &data);
625 /** Flushes as much of the user's buffer to the file descriptor as possible.
626 * This function may not always flush the entire buffer, rather instead as much of it
627 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
628 * position is advanced forwards and the rest of the data sent at the next call to
631 void FlushWriteBuf();
633 /** Returns the list of channels this user has been invited to but has not yet joined.
634 * @return A list of channels the user is invited to
636 InvitedList* GetInviteList();
638 /** Creates a wildcard host.
639 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
640 * @return The wildcarded hostname in *!*@host form
642 char* MakeWildHost();
644 /** Creates a usermask with real host.
645 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
646 * @return the usermask in the format user@host
650 /** Creates a usermask with real ip.
651 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
652 * @return the usermask in the format user@ip
656 /** Shuts down and closes the user's socket
657 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
658 * which will call CloseSocket() for you.
662 /** Disconnect a user gracefully
663 * @param user The user to remove
664 * @param r The quit reason
665 * @return Although this function has no return type, on exit the user provided will no longer exist.
667 static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r);
669 /** Add the user to WHOWAS system
673 /** Oper up the user using the given opertype.
674 * This will also give the +o usermode.
675 * @param opertype The oper type to oper as
677 void Oper(const std::string &opertype);
679 /** Use this method to fully connect a user.
680 * This will send the message of the day, check G/K/E lines, etc.
684 /** Change this users hash key to a new string.
685 * You should not call this function directly. It is used by the core
686 * to update the users hash entry on a nickchange.
687 * @param New new user_hash key
688 * @return Pointer to userrec in hash (usually 'this')
690 userrec* UpdateNickHash(const char* New);
692 /** Force a nickname change.
693 * If the nickname change fails (for example, because the nick in question
694 * already exists) this function will return false, and you must then either
695 * output an error message, or quit the user for nickname collision.
696 * @param newnick The nickname to change to
697 * @return True if the nickchange was successful.
699 bool ForceNickChange(const char* newnick);
701 /** Add a client to the system.
702 * This will create a new userrec, insert it into the user_hash,
703 * initialize it as not yet registered, and add it to the socket engine.
704 * @param Instance a pointer to the server instance
705 * @param socket The socket id (file descriptor) this user is on
706 * @param port The port number this user connected on
707 * @param iscached This variable is reserved for future use
708 * @param ip The IP address of the user
709 * @return This function has no return value, but a call to AddClient may remove the user.
711 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
714 * This will clear the +o usermode and unset the user's oper type
718 /** Return the number of global clones of this user
719 * @return The global clone count of this user
721 unsigned long GlobalCloneCount();
723 /** Return the number of local clones of this user
724 * @return The local clone count of this user
726 unsigned long LocalCloneCount();
728 /** Write text to this user, appending CR/LF.
729 * @param text A std::string to send to the user
731 void Write(std::string text);
733 /** Write text to this user, appending CR/LF.
734 * @param text The format string for text to send to the user
735 * @param ... POD-type format arguments
737 void Write(const char *text, ...);
739 /** Write text to this user, appending CR/LF and prepending :server.name
740 * @param text A std::string to send to the user
742 void WriteServ(const std::string& text);
744 /** Write text to this user, appending CR/LF and prepending :server.name
745 * @param text The format string for text to send to the user
746 * @param ... POD-type format arguments
748 void WriteServ(const char* text, ...);
750 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
751 * @param user The user to prepend the :nick!user@host of
752 * @param text A std::string to send to the user
754 void WriteFrom(userrec *user, const std::string &text);
756 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
757 * @param user The user to prepend the :nick!user@host of
758 * @param text The format string for text to send to the user
759 * @param ... POD-type format arguments
761 void WriteFrom(userrec *user, const char* text, ...);
763 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
764 * @param dest The user to route the message to
765 * @param text A std::string to send to the user
767 void WriteTo(userrec *dest, const std::string &data);
769 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
770 * @param dest The user to route the message to
771 * @param text The format string for text to send to the user
772 * @param ... POD-type format arguments
774 void WriteTo(userrec *dest, const char *data, ...);
776 /** Write to all users that can see this user (including this user in the list), appending CR/LF
777 * @param text A std::string to send to the users
779 void WriteCommon(const std::string &text);
781 /** Write to all users that can see this user (including this user in the list), appending CR/LF
782 * @param text The format string for text to send to the users
783 * @param ... POD-type format arguments
785 void WriteCommon(const char* text, ...);
787 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
788 * @param text The format string for text to send to the users
789 * @param ... POD-type format arguments
791 void WriteCommonExcept(const char* text, ...);
793 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
794 * @param text A std::string to send to the users
796 void WriteCommonExcept(const std::string &text);
798 /** Write a WALLOPS message from this user to all local opers.
799 * If this user is not opered, the function will return without doing anything.
800 * @param text The format string to send in the WALLOPS message
801 * @param ... Format arguments
803 void WriteWallOps(const char* text, ...);
805 /** Write a WALLOPS message from this user to all local opers.
806 * If this user is not opered, the function will return without doing anything.
807 * @param text The text to send in the WALLOPS message
809 void WriteWallOps(const std::string &text);
811 /** Return true if the user shares at least one channel with another user
812 * @param other The other user to compare the channel list against
813 * @return True if the given user shares at least one channel with this user
815 bool SharesChannelWith(userrec *other);
817 /** Change the displayed host of a user.
818 * ALWAYS use this function, rather than writing userrec::dhost directly,
819 * as this triggers module events allowing the change to be syncronized to
820 * remote servers. This will also emulate a QUIT and rejoin (where configured)
821 * before setting their host field.
822 * @param host The new hostname to set
823 * @return True if the change succeeded, false if it didn't
825 bool ChangeDisplayedHost(const char* host);
827 /** Change the ident (username) of a user.
828 * ALWAYS use this function, rather than writing userrec::ident directly,
829 * as this correctly causes the user to seem to quit (where configured)
830 * before setting their ident field.
831 * @param host The new ident to set
832 * @return True if the change succeeded, false if it didn't
834 bool ChangeIdent(const char* newident);
836 /** Change a users realname field.
837 * ALWAYS use this function, rather than writing userrec::fullname directly,
838 * as this triggers module events allowing the change to be syncronized to
840 * @param gecos The user's new realname
841 * @return True if the change succeeded, false if otherwise
843 bool ChangeName(const char* gecos);
845 /** Send a notice to all local users from this user
846 * @param text The text format string to send
847 * @param ... Format arguments
849 void NoticeAll(char* text, ...);
851 /** Compile a channel list for this user, and send it to the user 'source'
852 * Used internally by WHOIS
853 * @param The user to send the channel list to if it is not too long
854 * @return This user's channel list
856 std::string ChannelList(userrec* source);
858 /** Split the channel list in cl which came from dest, and spool it to this user
859 * Used internally by WHOIS
860 * @param dest The user the original channel list came from
861 * @param cl The channel list as a string obtained from userrec::ChannelList()
863 void SplitChanList(userrec* dest, const std::string &cl);
865 /** Remove this user from all channels they are on, and delete any that are now empty.
866 * This is used by QUIT, and will not send part messages!
868 void PurgeEmptyChannels();
870 /** Get the connect class which matches this user's host or IP address
871 * @return A reference to this user's connect class
873 ConnectClass* GetClass();
875 /** Show the message of the day to this user
879 /** Show the server RULES file to this user
883 /** Handle socket event.
884 * From EventHandler class.
885 * @param et Event type
886 * @param errornum Error number for EVENT_ERROR events
888 void HandleEvent(EventType et, int errornum = 0);
890 /** Default destructor
895 /* Configuration callbacks */