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"
25 #include "cull_list.h"
39 /** RFC1459 channel modes
42 UM_SERVERNOTICE = 's'-65,
44 UM_INVISIBLE = 'i'-65,
49 enum RegistrationState {
50 REG_NONE = 0, /* Has sent nothing */
51 REG_USER = 1, /* Has sent USER */
52 REG_NICK = 2, /* Has sent NICK */
53 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
54 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
59 /** Derived from Resolver, and performs user forward/reverse lookups.
61 class UserResolver : public Resolver
64 /** User this class is 'attached' to.
70 UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt);
72 void OnLookupComplete(const std::string &result);
73 void OnError(ResolverError e, const std::string &errormessage);
77 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
79 class ConnectClass : public classbase
82 /** Type of line, either CC_ALLOW or CC_DENY
85 /** Max time to register the connection in seconds
87 unsigned int registration_timeout;
88 /** Number of lines in buffer before excess flood is triggered
91 /** Host mask for this line
94 /** Number of seconds between pings for this line
96 unsigned int pingtime;
97 /** (Optional) Password for this line
101 /** Threshold value for flood disconnect
103 unsigned int threshold;
105 /** Maximum size of sendq for users in this class (bytes)
107 unsigned long sendqmax;
109 /** Maximum size of recvq for users in this class (bytes)
111 unsigned long recvqmax;
113 /** Local max when connecting by this connection class
115 unsigned long maxlocal;
117 /** Global max when connecting by this connection class
119 unsigned long maxglobal;
123 ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
124 threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
126 ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
127 const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
128 unsigned long maxl, unsigned long maxg) :
129 type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
130 threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
132 ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
133 pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
137 return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
140 unsigned int GetRegTimeout()
142 return (registration_timeout ? registration_timeout : 90);
145 unsigned int GetFlood()
147 return (threshold ? flood : 999);
150 const std::string& GetHost()
155 unsigned int GetPingTime()
157 return (pingtime ? pingtime : 120);
160 const std::string& GetPass()
165 unsigned int GetThreshold()
167 return (threshold ? threshold : 1);
170 unsigned long GetSendqMax()
172 return (sendqmax ? sendqmax : 262114);
175 unsigned long GetRecvqMax()
177 return (recvqmax ? recvqmax : 4096);
180 unsigned long GetMaxLocal()
182 return (maxlocal ? maxlocal : 1);
185 unsigned long GetMaxGlobal()
187 return (maxglobal ? maxglobal : 1);
191 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
193 typedef std::vector<irc::string> InvitedList;
195 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
197 typedef std::vector<ConnectClass> ClassVector;
199 /** Typedef for the list of user-channel records for a user
201 typedef std::map<chanrec*, char> UserChanList;
202 typedef UserChanList::iterator UCListIter;
204 /** Holds all information about a user
205 * This class stores all information about a user connected to the irc server. Everything about a
206 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
207 * user's nickname and hostname. Use the FindNick method of the InspIRCd class to locate a specific user
208 * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
209 * file descriptor value.
211 class userrec : public connection
214 /** Pointer to creator.
215 * This is required to make use of core functions
216 * from within the userrec class.
218 InspIRCd* ServerInstance;
220 /** A list of channels the user has a pending invite to.
221 * Upon INVITE channels are added, and upon JOIN, the
222 * channels are removed from this list.
226 /** Number of channels this user is currently on
228 unsigned int ChannelCount;
230 /** Resolvers for looking up this users IP address
231 * This will occur if and when res_reverse completes.
232 * When this class completes its lookup, userrec::dns_done
233 * will be set from false to true.
235 UserResolver* res_forward;
237 /** Resolvers for looking up this users hostname
238 * This is instantiated by userrec::StartDNSLookup(),
239 * and on success, instantiates userrec::res_reverse.
241 UserResolver* res_reverse;
243 /** Stored reverse lookup from res_forward
245 std::string stored_host;
247 /** Starts a DNS lookup of the user's IP.
248 * This will cause two UserResolver classes to be instantiated.
249 * When complete, these objects set userrec::dns_done to true.
251 void StartDNSLookup();
253 /** The users nickname.
254 * An invalid nickname indicates an unregistered connection prior to the NICK command.
255 * Use InspIRCd::IsNick() to validate nicknames.
259 /** The users ident reply.
260 * Two characters are added to the user-defined limit to compensate for the tilde etc.
262 char ident[IDENTMAX+2];
264 /** The host displayed to non-opers (used for cloaking etc).
265 * This usually matches the value of userrec::host.
269 /** The users full name (GECOS).
271 char fullname[MAXGECOS+1];
273 /** The user's mode list.
274 * This is NOT a null terminated string! In the 1.1 version of InspIRCd
275 * this is an array of values in a similar way to channel modes.
276 * A value of 1 in field (modeletter-65) indicates that the mode is
277 * set, for example, to work out if mode +s is set, we check the field
278 * userrec::modes['s'-65] != 0.
279 * The following RFC characters o, w, s, i have constants defined via an
280 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
284 /** What snomasks are set on this user.
285 * This functions the same as the above modes.
289 /** Channels this user is on, and the permissions they have there
293 /** The server the user is connected to.
297 /** The user's away message.
298 * If this string is empty, the user is not marked as away.
300 char awaymsg[MAXAWAY+1];
302 /** Number of lines the user can place into the buffer
303 * (up to the global NetBufferSize bytes) before they
304 * are disconnected for excess flood
308 /** Timestamp of current time + connection class timeout.
309 * This user must send USER/NICK before this timestamp is
310 * reached or they will be disconnected.
314 /** The oper type they logged in as, if they are an oper.
315 * This is used to check permissions in operclasses, so that
316 * we can say 'yay' or 'nay' to any commands they issue.
317 * The value of this is the value of a valid 'type name=' tag.
321 /** True when DNS lookups are completed.
322 * The UserResolver classes res_forward and res_reverse will
323 * set this value once they complete.
327 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
329 unsigned int pingmax;
331 /** Password specified by the user when they registered.
332 * This is stored even if the <connect> block doesnt need a password, so that
333 * modules may check it.
337 /** User's receive queue.
338 * Lines from the IRCd awaiting processing are stored here.
339 * Upgraded april 2005, old system a bit hairy.
343 /** User's send queue.
344 * Lines waiting to be sent are stored here until their buffer is flushed.
348 /** Flood counters - lines received
352 /** Flood counters - time lines_in is due to be reset
356 /** Flood counters - Highest value lines_in may reach before the user gets disconnected
360 /** IPV4 or IPV6 ip address
364 /** Initialize the clients sockaddr
365 * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
366 * @param ip A human-readable IP address for this user matching the protcol_family
367 * @param port The port number of this user or zero for a remote user
369 void SetSockAddr(int protocol_family, const char* ip, int port);
371 /** Get port number from sockaddr
372 * @return The port number of this user.
376 /** Get protocol family from sockaddr
377 * @return The protocol family of this user, either AF_INET or AF_INET6
379 int GetProtocolFamily();
381 /** Get IP string from sockaddr, using static internal buffer
382 * @return The IP string
384 const char* GetIPString();
386 /** Get IP string from sockaddr, using caller-specified buffer
387 * @param buf A buffer to use
388 * @return The IP string
390 const char* GetIPString(char* buf);
392 /* Write error string
394 std::string WriteError;
396 /** Maximum size this user's sendq can become
400 /** Maximum size this user's recvq can become
404 /** This is true if the user matched an exception when they connected to the ircd.
405 * It isnt valid after this point, and you should not attempt to do anything with it
406 * after this point, because the eline might be removed at a later time, and/or no
407 * longer be applicable to this user. It is only used to save doing the eline lookup
408 * twice (instead we do it once and set this value).
412 /** Default constructor
413 * @throw Nothing at present
415 userrec(InspIRCd* Instance);
417 /** Returns the full displayed host of the user
418 * This member function returns the hostname of the user as seen by other users
419 * on the server, in nick!ident&at;host form.
420 * @return The full masked host of the user
422 virtual char* GetFullHost();
424 /** Returns the full real host of the user
425 * This member function returns the hostname of the user as seen by other users
426 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
427 * e.g. through a module, then this method will ignore it and return the true hostname.
428 * @return The full real host of the user
430 virtual char* GetFullRealHost();
432 /** Create a displayable mode string for this users snomasks
433 * @return The notice mask character sequence
435 const char* FormatNoticeMasks();
437 /** Process a snomask modifier string, e.g. +abc-de
438 * @param sm A sequence of notice mask characters
439 * @return The cleaned mode sequence which can be output,
440 * e.g. in the above example if masks c and e are not
441 * valid, this function will return +ab-d
443 std::string ProcessNoticeMasks(const char *sm);
445 /** Returns true if a notice mask is set
446 * @param sm A notice mask character to check
447 * @return True if the notice mask is set
449 bool IsNoticeMaskSet(unsigned char sm);
451 /** Changed a specific notice mask value
452 * @param sm The server notice mask to change
453 * @param value An on/off value for this mask
455 void SetNoticeMask(unsigned char sm, bool value);
457 /** Create a displayable mode string for this users umodes
458 * @param The mode string
460 const char* FormatModes();
462 /** Returns true if a specific mode is set
463 * @param m The user mode
464 * @return True if the mode is set
466 bool IsModeSet(unsigned char m);
468 /** Set a specific usermode to on or off
469 * @param m The user mode
470 * @param value On or off setting of the mode
472 void SetMode(unsigned char m, bool value);
474 /** Returns true if a user is invited to a channel.
475 * @param channel A channel name to look up
476 * @return True if the user is invited to the given channel
478 virtual bool IsInvited(const irc::string &channel);
480 /** Adds a channel to a users invite list (invites them to a channel)
481 * @param channel A channel name to add
483 virtual void InviteTo(const irc::string &channel);
485 /** Removes a channel from a users invite list.
486 * This member function is called on successfully joining an invite only channel
487 * to which the user has previously been invited, to clear the invitation.
488 * @param channel The channel to remove the invite to
490 virtual void RemoveInvite(const irc::string &channel);
492 /** Returns true or false for if a user can execute a privilaged oper command.
493 * This is done by looking up their oper type from userrec::oper, then referencing
494 * this to their oper classes and checking the commands they can execute.
495 * @param command A command (should be all CAPS)
496 * @return True if this user can execute the command
498 bool HasPermission(const std::string &command);
500 /** Calls read() to read some data for this user using their fd.
501 * @param buffer The buffer to read into
502 * @param size The size of data to read
503 * @return The number of bytes read, or -1 if an error occured.
505 int ReadData(void* buffer, size_t size);
507 /** This method adds data to the read buffer of the user.
508 * The buffer can grow to any size within limits of the available memory,
509 * managed by the size of a std::string, however if any individual line in
510 * the buffer grows over 600 bytes in length (which is 88 chars over the
511 * RFC-specified limit per line) then the method will return false and the
512 * text will not be inserted.
513 * @param a The string to add to the users read buffer
514 * @return True if the string was successfully added to the read buffer
516 bool AddBuffer(std::string a);
518 /** This method returns true if the buffer contains at least one carriage return
519 * character (e.g. one complete line may be read)
520 * @return True if there is at least one complete line in the users buffer
522 bool BufferIsReady();
524 /** This function clears the entire buffer by setting it to an empty string.
528 /** This method returns the first available string at the tail end of the buffer
529 * and advances the tail end of the buffer past the string. This means it is
530 * a one way operation in a similar way to strtok(), and multiple calls return
531 * multiple lines if they are available. The results of this function if there
532 * are no lines to be read are unknown, always use BufferIsReady() to check if
533 * it is ok to read the buffer before calling GetBuffer().
534 * @return The string at the tail end of this users buffer
536 std::string GetBuffer();
538 /** Sets the write error for a connection. This is done because the actual disconnect
539 * of a client may occur at an inopportune time such as half way through /LIST output.
540 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
541 * errored clients purged.
542 * @param error The error string to set.
544 void SetWriteError(const std::string &error);
546 /** Returns the write error which last occured on this connection or an empty string
548 * @return The error string which has occured for this user
550 const char* GetWriteError();
552 /** Adds to the user's write buffer.
553 * You may add any amount of text up to this users sendq value, if you exceed the
554 * sendq value, SetWriteError() will be called to set the users error string to
555 * "SendQ exceeded", and further buffer adds will be dropped.
556 * @param data The data to add to the write buffer
558 void AddWriteBuf(const std::string &data);
560 /** Flushes as much of the user's buffer to the file descriptor as possible.
561 * This function may not always flush the entire buffer, rather instead as much of it
562 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
563 * position is advanced forwards and the rest of the data sent at the next call to
566 void FlushWriteBuf();
568 /** Returns the list of channels this user has been invited to but has not yet joined.
569 * @return A list of channels the user is invited to
571 InvitedList* GetInviteList();
573 /** Creates a wildcard host.
574 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
575 * @return The wildcarded hostname in *!*@host form
577 char* MakeWildHost();
579 /** Creates a usermask with real host.
580 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
581 * @return the usermask in the format user@host
585 /** Creates a usermask with real ip.
586 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
587 * @return the usermask in the format user@ip
591 /** Shuts down and closes the user's socket
592 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
593 * which will call CloseSocket() for you.
597 /** Disconnect a user gracefully
598 * @param user The user to remove
599 * @param r The quit reason
600 * @return Although this function has no return type, on exit the user provided will no longer exist.
602 static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r);
604 /** Add the user to WHOWAS system
608 /** Oper up the user using the given opertype.
609 * This will also give the +o usermode.
610 * @param opertype The oper type to oper as
612 void Oper(const std::string &opertype);
614 /** Use this method to fully connect a user.
615 * This will send the message of the day, check G/K/E lines, etc.
616 * @param Goners If the user is disconnected by this method call, the
617 * value of 'this' will be pushed onto this CullList. This is used by
618 * the core to connect many users in rapid succession without invalidating
620 * @param Goners a CullList to use for failed connections
622 void FullConnect(CullList* Goners);
624 /** Change this users hash key to a new string.
625 * You should not call this function directly. It is used by the core
626 * to update the users hash entry on a nickchange.
627 * @param New new user_hash key
628 * @return Pointer to userrec in hash (usually 'this')
630 userrec* UpdateNickHash(const char* New);
632 /** Force a nickname change.
633 * If the nickname change fails (for example, because the nick in question
634 * already exists) this function will return false, and you must then either
635 * output an error message, or quit the user for nickname collision.
636 * @param newnick The nickname to change to
637 * @return True if the nickchange was successful.
639 bool ForceNickChange(const char* newnick);
641 /** Add a client to the system.
642 * This will create a new userrec, insert it into the user_hash,
643 * initialize it as not yet registered, and add it to the socket engine.
644 * @param Instance a pointer to the server instance
645 * @param socket The socket id (file descriptor) this user is on
646 * @param port The port number this user connected on
647 * @param iscached This variable is reserved for future use
648 * @param ip The IP address of the user
649 * @return This function has no return value, but a call to AddClient may remove the user.
651 static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, insp_inaddr ip);
654 * This will clear the +o usermode and unset the user's oper type
658 /** Return the number of global clones of this user
659 * @return The global clone count of this user
661 unsigned long GlobalCloneCount();
663 /** Return the number of local clones of this user
664 * @return The local clone count of this user
666 unsigned long LocalCloneCount();
668 /** Write text to this user, appending CR/LF.
669 * @param text A std::string to send to the user
671 void Write(std::string text);
673 /** Write text to this user, appending CR/LF.
674 * @param text The format string for text to send to the user
675 * @param ... POD-type format arguments
677 void Write(const char *text, ...);
679 /** Write text to this user, appending CR/LF and prepending :server.name
680 * @param text A std::string to send to the user
682 void WriteServ(const std::string& text);
684 /** Write text to this user, appending CR/LF and prepending :server.name
685 * @param text The format string for text to send to the user
686 * @param ... POD-type format arguments
688 void WriteServ(const char* text, ...);
690 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
691 * @param user The user to prepend the :nick!user@host of
692 * @param text A std::string to send to the user
694 void WriteFrom(userrec *user, const std::string &text);
696 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
697 * @param user The user to prepend the :nick!user@host of
698 * @param text The format string for text to send to the user
699 * @param ... POD-type format arguments
701 void WriteFrom(userrec *user, const char* text, ...);
703 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
704 * @param dest The user to route the message to
705 * @param text A std::string to send to the user
707 void WriteTo(userrec *dest, const std::string &data);
709 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
710 * @param dest The user to route the message to
711 * @param text The format string for text to send to the user
712 * @param ... POD-type format arguments
714 void WriteTo(userrec *dest, const char *data, ...);
716 /** Write to all users that can see this user (including this user in the list), appending CR/LF
717 * @param text A std::string to send to the users
719 void WriteCommon(const std::string &text);
721 /** Write to all users that can see this user (including this user in the list), appending CR/LF
722 * @param text The format string for text to send to the users
723 * @param ... POD-type format arguments
725 void WriteCommon(const char* text, ...);
727 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
728 * @param text The format string for text to send to the users
729 * @param ... POD-type format arguments
731 void WriteCommonExcept(const char* text, ...);
733 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
734 * @param text A std::string to send to the users
736 void WriteCommonExcept(const std::string &text);
738 /** Write a WALLOPS message from this user to all local opers.
739 * If this user is not opered, the function will return without doing anything.
740 * @param text The format string to send in the WALLOPS message
741 * @param ... Format arguments
743 void WriteWallOps(const char* text, ...);
745 /** Write a WALLOPS message from this user to all local opers.
746 * If this user is not opered, the function will return without doing anything.
747 * @param text The text to send in the WALLOPS message
749 void WriteWallOps(const std::string &text);
751 /** Return true if the user shares at least one channel with another user
752 * @param other The other user to compare the channel list against
753 * @return True if the given user shares at least one channel with this user
755 bool SharesChannelWith(userrec *other);
757 /** Change the displayed host of a user.
758 * ALWAYS use this function, rather than writing userrec::dhost directly,
759 * as this triggers module events allowing the change to be syncronized to
760 * remote servers. This will also emulate a QUIT and rejoin (where configured)
761 * before setting their host field.
762 * @param host The new hostname to set
763 * @return True if the change succeeded, false if it didn't
765 bool ChangeDisplayedHost(const char* host);
767 /** Change the ident (username) of a user.
768 * ALWAYS use this function, rather than writing userrec::ident directly,
769 * as this correctly causes the user to seem to quit (where configured)
770 * before setting their ident field.
771 * @param host The new ident to set
772 * @return True if the change succeeded, false if it didn't
774 bool ChangeIdent(const char* newident);
776 /** Change a users realname field.
777 * ALWAYS use this function, rather than writing userrec::fullname directly,
778 * as this triggers module events allowing the change to be syncronized to
780 * @param gecos The user's new realname
781 * @return True if the change succeeded, false if otherwise
783 bool ChangeName(const char* gecos);
785 /** Send a notice to all local users from this user
786 * @param text The text format string to send
787 * @param ... Format arguments
789 void NoticeAll(char* text, ...);
791 /** Compile a channel list for this user, and send it to the user 'source'
792 * Used internally by WHOIS
793 * @param The user to send the channel list to if it is not too long
794 * @return This user's channel list
796 std::string ChannelList(userrec* source);
798 /** Split the channel list in cl which came from dest, and spool it to this user
799 * Used internally by WHOIS
800 * @param dest The user the original channel list came from
801 * @param cl The channel list as a string obtained from userrec::ChannelList()
803 void SplitChanList(userrec* dest, const std::string &cl);
805 /** Remove this user from all channels they are on, and delete any that are now empty.
806 * This is used by QUIT, and will not send part messages!
808 void PurgeEmptyChannels();
810 /** Get the connect class which matches this user's host or IP address
811 * @return A reference to this user's connect class
813 ConnectClass* GetClass();
815 /** Show the message of the day to this user
819 /** Show the server RULES file to this user
823 /** Handle socket event.
824 * From EventHandler class.
826 void HandleEvent(EventType et, int errornum = 0);
828 /** Default destructor
836 /** Holds whowas related functions and classes
841 /** Used to hold WHOWAS information
843 class WhoWasGroup : public classbase
865 /** Initialize this WhoQasFroup with a user
867 WhoWasGroup(userrec* user);
873 /** A group of users related by nickname
875 typedef std::deque<WhoWasGroup*> whowas_set;
877 /** Sets of users in the whowas system
879 typedef std::map<irc::string,whowas_set*> whowas_users;
881 /** Sets of time and users in whowas list
883 typedef std::map<time_t,irc::string> whowas_users_fifo;
885 /** Called every hour by the core to remove expired entries
887 void MaintainWhoWas(InspIRCd* ServerInstance, time_t TIME);
889 /** Prune for WhoWasGroupSize, WhoWasMaxGroups and
890 * WhoWasMaxKeep on rehash
892 void PruneWhoWas(InspIRCd* ServerInstance, time_t TIME);
896 /* Configuration callbacks */