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 * ---------------------------------------------------
18 #include "inspsocket.h"
22 /** connect class types
31 /** RFC1459 channel modes
34 /** +s: Server notice mask */
35 UM_SNOMASK = 's' - 65,
37 UM_WALLOPS = 'w' - 65,
39 UM_INVISIBLE = 'i' - 65,
41 UM_OPERATOR = 'o' - 65
44 /** Registration state of a user, e.g.
45 * have they sent USER, NICK, PASS yet?
47 enum RegistrationState {
49 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
50 REG_NONE = 0, /* Has sent nothing */
53 REG_USER = 1, /* Has sent USER */
54 REG_NICK = 2, /* Has sent NICK */
55 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
56 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
59 /* Required forward declaration */
63 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
65 struct CoreExport ConnectClass : public classbase
67 /** Type of line, either CC_ALLOW or CC_DENY
71 /** Connect class name
75 /** Max time to register the connection in seconds
77 unsigned int registration_timeout;
79 /** Host mask for this line
83 /** Number of seconds between pings for this line
85 unsigned int pingtime;
87 /** (Optional) Password for this line
91 /** (Optional) Hash Method for this line
95 /** Maximum size of sendq for users in this class (bytes)
96 * Users cannot send commands if they go over this limit
98 unsigned long softsendqmax;
100 /** Maximum size of sendq for users in this class (bytes)
101 * Users are killed if they go over this limit
103 unsigned long hardsendqmax;
105 /** Maximum size of recvq for users in this class (bytes)
107 unsigned long recvqmax;
109 /** Local max when connecting by this connection class
111 unsigned long maxlocal;
113 /** Global max when connecting by this connection class
115 unsigned long maxglobal;
117 /** Max channels for this class
119 unsigned int maxchans;
121 /** Port number this connect class applies to
125 /** How many users may be in this connect class before they are refused?
126 * (0 = no limit = default)
130 /** Reference counter.
131 * This will be 1 if no users are connected, as long as it is a valid connect block
132 * When it reaches 0, the object should be deleted
134 unsigned long RefCount;
136 /** Create a new connect class with no settings.
138 ConnectClass(char type, const std::string& mask);
139 /** Create a new connect class with inherited settings.
141 ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
143 /** Update the settings in this block to match the given block */
144 void Update(const ConnectClass* newSettings);
147 const std::string& GetName() { return name; }
148 const std::string& GetPass() { return pass; }
149 const std::string& GetHost() { return host; }
150 const int GetPort() { return port; }
152 /** Returns the registration timeout
154 time_t GetRegTimeout()
156 return (registration_timeout ? registration_timeout : 90);
159 /** Returns the ping frequency
161 unsigned int GetPingTime()
163 return (pingtime ? pingtime : 120);
166 /** Returns the maximum sendq value (soft limit)
167 * Note that this is in addition to internal OS buffers
169 unsigned long GetSendqSoftMax()
171 return (softsendqmax ? softsendqmax : 4096);
174 /** Returns the maximum sendq value (hard limit)
176 unsigned long GetSendqHardMax()
178 return (hardsendqmax ? hardsendqmax : 0x100000);
181 /** Returns the maximum recvq value
183 unsigned long GetRecvqMax()
185 return (recvqmax ? recvqmax : 4096);
188 /** Returusn the maximum number of local sessions
190 unsigned long GetMaxLocal()
195 /** Returns the maximum number of global sessions
197 unsigned long GetMaxGlobal()
203 /** 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.
205 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
207 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
209 typedef std::vector<ConnectClass*> ClassVector;
211 /** Typedef for the list of user-channel records for a user
213 typedef std::set<Channel*> UserChanList;
215 /** Shorthand for an iterator into a UserChanList
217 typedef UserChanList::iterator UCListIter;
219 /* Required forward declaration
223 /** Holds all information about a user
224 * This class stores all information about a user connected to the irc server. Everything about a
225 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
226 * user's nickname and hostname.
228 class CoreExport User : public StreamSocket
231 /** A list of channels the user has a pending invite to.
232 * Upon INVITE channels are added, and upon JOIN, the
233 * channels are removed from this list.
237 /** Cached nick!ident@dhost value using the displayed hostname
239 std::string cached_fullhost;
241 /** Cached ident@ip value using the real IP address
243 std::string cached_hostip;
245 /** Cached ident@realhost value using the real hostname
247 std::string cached_makehost;
249 /** Cached nick!ident@realhost value using the real hostname
251 std::string cached_fullrealhost;
253 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
255 std::string cachedip;
257 /** When we erase the user (in the destructor),
258 * we call this method to subtract one from all
259 * mode characters this user is making use of.
261 void DecrementModes();
263 std::set<std::string> *AllowedOperCommands;
264 std::set<std::string> *AllowedPrivs;
266 /** Allowed user modes from oper classes. */
267 std::bitset<64> AllowedUserModes;
269 /** Allowed channel modes from oper classes. */
270 std::bitset<64> AllowedChanModes;
273 static LocalIntExt NICKForced;
274 static LocalStringExt OperQuit;
276 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
277 * The pointer is guarenteed to *always* be valid. :)
279 ConnectClass *MyClass;
281 /** Hostname of connection.
282 * This should be valid as per RFC1035.
286 /** Stats counter for bytes inbound
290 /** Stats counter for bytes outbound
294 /** Stats counter for commands inbound
298 /** Stats counter for commands outbound
302 /** True if user has authenticated, false if otherwise
306 /** Used by User to indicate the registration status of the connection
307 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
308 * the connection state.
312 /** Time the connection was last pinged
316 /** Time that the object was instantiated (used for TS calculation etc)
320 /** Time the connection was created, set in the constructor. This
321 * may be different from the time the user's classbase object was
326 /** Time that the connection last sent a message, used to calculate idle time
330 /** Used by PING checking code
334 /** Stored reverse lookup from res_forward. Should not be used after resolution.
336 std::string stored_host;
338 /** Starts a DNS lookup of the user's IP.
339 * This will cause two UserResolver classes to be instantiated.
340 * When complete, these objects set User::dns_done to true.
342 void StartDNSLookup();
344 /** The users nickname.
345 * An invalid nickname indicates an unregistered connection prior to the NICK command.
346 * Use InspIRCd::IsNick() to validate nicknames.
350 /** The user's unique identifier.
351 * This is the unique identifier which the user has across the network.
355 /** The users ident reply.
356 * Two characters are added to the user-defined limit to compensate for the tilde etc.
360 /** The host displayed to non-opers (used for cloaking etc).
361 * This usually matches the value of User::host.
365 /** The users full name (GECOS).
367 std::string fullname;
369 /** The user's mode list.
370 * NOT a null terminated string.
372 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
373 * if (modes[modeletter-65]) is set, then the mode is
374 * set, for example, to work out if mode +s is set, we check the field
375 * User::modes['s'-65] != 0.
376 * The following RFC characters o, w, s, i have constants defined via an
377 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
379 std::bitset<64> modes;
381 /** What snomasks are set on this user.
382 * This functions the same as the above modes.
384 std::bitset<64> snomasks;
386 /** Channels this user is on, and the permissions they have there
390 /** The server the user is connected to.
394 /** The user's away message.
395 * If this string is empty, the user is not marked as away.
399 /** Time the user last went away.
400 * This is ONLY RELIABLE if user IS_AWAY()!
404 /** The oper type they logged in as, if they are an oper.
405 * This is used to check permissions in operclasses, so that
406 * we can say 'yay' or 'nay' to any commands they issue.
407 * The value of this is the value of a valid 'type name=' tag.
411 /** True when DNS lookups are completed.
412 * The UserResolver classes res_forward and res_reverse will
413 * set this value once they complete.
417 /** Password specified by the user when they registered.
418 * This is stored even if the <connect> block doesnt need a password, so that
419 * modules may check it.
421 std::string password;
423 /** Whether or not to send an snotice about this user's quitting
427 /** If this is set to true, then all socket operations for the user
428 * are dropped into the bit-bucket.
429 * This value is set by QuitUser, and is not needed seperately from that call.
430 * Please note that setting this value alone will NOT cause the user to quit.
434 /** Server address and port that this user is connected to.
435 * If unknown, address family is AF_UNKNOWN
437 irc::sockets::sockaddrs server_sa;
438 /** Client address that the user is connected from.
439 * Port number is only valid if local.
441 * Do not modify this value directly, use SetClientIP() to change it
443 irc::sockets::sockaddrs client_sa;
445 /** Sets the client IP for this user
446 * @return true if the conversion was successful
448 bool SetClientIP(const char* sip);
451 * @return The port number of this user.
455 * @return The server IP address
457 std::string GetServerIP();
459 /** Get client IP string from sockaddr, using static internal buffer
460 * @return The IP string
462 const char* GetIPString();
464 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
465 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
466 * This may be used for CIDR clone detection, etc.
468 * (XXX, brief note: when we do the sockets rewrite, this should move down a
469 * level so it may be used on more derived objects. -- w00t)
471 const char *GetCIDRMask(int range);
473 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
477 /** This value contains how far into the penalty threshold the user is. Once its over
478 * the penalty threshold then commands are held and processed on-timer.
482 /** Default constructor
483 * @throw CoreException if the UID allocated to the user already exists
484 * @param Instance Creator instance
485 * @param uid User UUID, or empty to allocate one automatically
487 User(const std::string &uid = "");
489 /** Check if the user matches a G or K line, and disconnect them if they do.
490 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
491 * Returns true if the user matched a ban, false else.
493 bool CheckLines(bool doZline = false);
495 /** Returns the full displayed host of the user
496 * This member function returns the hostname of the user as seen by other users
497 * on the server, in nick!ident&at;host form.
498 * @return The full masked host of the user
500 virtual const std::string GetFullHost();
502 /** Returns the full real host of the user
503 * This member function returns the hostname of the user as seen by other users
504 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
505 * e.g. through a module, then this method will ignore it and return the true hostname.
506 * @return The full real host of the user
508 virtual const std::string GetFullRealHost();
510 /** This clears any cached results that are used for GetFullRealHost() etc.
511 * The results of these calls are cached as generating them can be generally expensive.
513 void InvalidateCache();
515 /** Create a displayable mode string for this users snomasks
516 * @return The notice mask character sequence
518 const char* FormatNoticeMasks();
520 /** Process a snomask modifier string, e.g. +abc-de
521 * @param sm A sequence of notice mask characters
522 * @return The cleaned mode sequence which can be output,
523 * e.g. in the above example if masks c and e are not
524 * valid, this function will return +ab-d
526 std::string ProcessNoticeMasks(const char *sm);
528 /** Returns true if a notice mask is set
529 * @param sm A notice mask character to check
530 * @return True if the notice mask is set
532 bool IsNoticeMaskSet(unsigned char sm);
534 /** Changed a specific notice mask value
535 * @param sm The server notice mask to change
536 * @param value An on/off value for this mask
538 void SetNoticeMask(unsigned char sm, bool value);
540 /** Create a displayable mode string for this users umodes
541 * @param The mode string
543 const char* FormatModes(bool showparameters = false);
545 /** Returns true if a specific mode is set
546 * @param m The user mode
547 * @return True if the mode is set
549 bool IsModeSet(unsigned char m);
551 /** Set a specific usermode to on or off
552 * @param m The user mode
553 * @param value On or off setting of the mode
555 void SetMode(unsigned char m, bool value);
557 /** Returns true if a user is invited to a channel.
558 * @param channel A channel name to look up
559 * @return True if the user is invited to the given channel
561 virtual bool IsInvited(const irc::string &channel);
563 /** Adds a channel to a users invite list (invites them to a channel)
564 * @param channel A channel name to add
565 * @param timeout When the invite should expire (0 == never)
567 virtual void InviteTo(const irc::string &channel, time_t timeout);
569 /** Removes a channel from a users invite list.
570 * This member function is called on successfully joining an invite only channel
571 * to which the user has previously been invited, to clear the invitation.
572 * @param channel The channel to remove the invite to
574 virtual void RemoveInvite(const irc::string &channel);
576 /** Returns true or false for if a user can execute a privilaged oper command.
577 * This is done by looking up their oper type from User::oper, then referencing
578 * this to their oper classes and checking the commands they can execute.
579 * @param command A command (should be all CAPS)
580 * @return True if this user can execute the command
582 bool HasPermission(const std::string &command);
584 /** Returns true if a user has a given permission.
585 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
586 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
588 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
589 * @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.
590 * @return True if this user has the permission in question.
592 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
594 /** Returns true or false if a user can set a privileged user or channel mode.
595 * This is done by looking up their oper type from User::oper, then referencing
596 * this to their oper classes, and checking the modes they can set.
597 * @param mode The mode the check
598 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
599 * @return True if the user can set or unset this mode.
601 bool HasModePermission(unsigned char mode, ModeType type);
603 /** Adds to the user's write buffer.
604 * You may add any amount of text up to this users sendq value, if you exceed the
605 * sendq value, the user will be removed, and further buffer adds will be dropped.
606 * @param data The data to add to the write buffer
608 void AddWriteBuf(const std::string &data);
610 /** Returns the list of channels this user has been invited to but has not yet joined.
611 * @return A list of channels the user is invited to
613 InvitedList* GetInviteList();
615 /** Creates a wildcard host.
616 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
617 * @return The wildcarded hostname in *!*@host form
619 char* MakeWildHost();
621 /** Creates a usermask with real host.
622 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
623 * @return the usermask in the format user@host
625 const std::string& MakeHost();
627 /** Creates a usermask with real ip.
628 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
629 * @return the usermask in the format user@ip
631 const std::string& MakeHostIP();
633 /** Add the user to WHOWAS system
637 /** Oper up the user using the given opertype.
638 * This will also give the +o usermode.
639 * @param opertype The oper type to oper as
641 void Oper(const std::string &opertype, const std::string &opername);
643 /** Call this method to find the matching <connect> for a user, and to check them against it.
647 /** Use this method to fully connect a user.
648 * This will send the message of the day, check G/K/E lines, etc.
652 /** Change this users hash key to a new string.
653 * You should not call this function directly. It is used by the core
654 * to update the users hash entry on a nickchange.
655 * @param New new user_hash key
656 * @return Pointer to User in hash (usually 'this')
658 User* UpdateNickHash(const char* New);
660 /** Force a nickname change.
661 * If the nickname change fails (for example, because the nick in question
662 * already exists) this function will return false, and you must then either
663 * output an error message, or quit the user for nickname collision.
664 * @param newnick The nickname to change to
665 * @return True if the nickchange was successful.
667 bool ForceNickChange(const char* newnick);
670 * This will clear the +o usermode and unset the user's oper type
674 /** Write text to this user, appending CR/LF.
675 * @param text A std::string to send to the user
677 void Write(const std::string &text);
679 /** Write text to this user, appending CR/LF.
680 * @param text The format string for text to send to the user
681 * @param ... POD-type format arguments
683 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
685 /** Write text to this user, appending CR/LF and prepending :server.name
686 * @param text A std::string to send to the user
688 void WriteServ(const std::string& text);
690 /** Write text to this user, appending CR/LF and prepending :server.name
691 * @param text The format string for text to send to the user
692 * @param ... POD-type format arguments
694 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
696 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
698 void WriteNumeric(unsigned int numeric, const std::string &text);
700 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
701 * @param user The user to prepend the :nick!user@host of
702 * @param text A std::string to send to the user
704 void WriteFrom(User *user, const std::string &text);
706 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
707 * @param user The user to prepend the :nick!user@host of
708 * @param text The format string for text to send to the user
709 * @param ... POD-type format arguments
711 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
713 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
714 * @param dest The user to route the message to
715 * @param text A std::string to send to the user
717 void WriteTo(User *dest, const std::string &data);
719 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
720 * @param dest The user to route the message to
721 * @param text The format string for text to send to the user
722 * @param ... POD-type format arguments
724 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
726 /** Write to all users that can see this user (including this user in the list), appending CR/LF
727 * @param text A std::string to send to the users
729 void WriteCommon(const std::string &text);
731 /** Write to all users that can see this user (including this user in the list), appending CR/LF
732 * @param text The format string for text to send to the users
733 * @param ... POD-type format arguments
735 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
737 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
738 * @param text The format string for text to send to the users
739 * @param ... POD-type format arguments
741 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
743 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
744 * @param text A std::string to send to the users
746 void WriteCommonExcept(const std::string &text);
748 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
749 * quit message for opers only.
750 * @param normal_text Normal user quit message
751 * @param oper_text Oper only quit message
753 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
755 /** Write a WALLOPS message from this user to all local opers.
756 * If this user is not opered, the function will return without doing anything.
757 * @param text The format string to send in the WALLOPS message
758 * @param ... Format arguments
760 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
762 /** Write a WALLOPS message from this user to all local opers.
763 * If this user is not opered, the function will return without doing anything.
764 * @param text The text to send in the WALLOPS message
766 void WriteWallOps(const std::string &text);
768 /** Return true if the user shares at least one channel with another user
769 * @param other The other user to compare the channel list against
770 * @return True if the given user shares at least one channel with this user
772 bool SharesChannelWith(User *other);
774 /** Send fake quit/join messages for host or ident cycle.
775 * Run this after the item in question has changed.
776 * You should not need to use this function, call ChangeDisplayedHost instead
778 * @param The entire QUIT line, including the source using the old value
780 void DoHostCycle(const std::string &quitline);
782 /** Change the displayed host of a user.
783 * ALWAYS use this function, rather than writing User::dhost directly,
784 * as this triggers module events allowing the change to be syncronized to
785 * remote servers. This will also emulate a QUIT and rejoin (where configured)
786 * before setting their host field.
787 * @param host The new hostname to set
788 * @return True if the change succeeded, false if it didn't
790 bool ChangeDisplayedHost(const char* host);
792 /** Change the ident (username) of a user.
793 * ALWAYS use this function, rather than writing User::ident directly,
794 * as this correctly causes the user to seem to quit (where configured)
795 * before setting their ident field.
796 * @param host The new ident to set
797 * @return True if the change succeeded, false if it didn't
799 bool ChangeIdent(const char* newident);
801 /** Change a users realname field.
802 * ALWAYS use this function, rather than writing User::fullname directly,
803 * as this triggers module events allowing the change to be syncronized to
805 * @param gecos The user's new realname
806 * @return True if the change succeeded, false if otherwise
808 bool ChangeName(const char* gecos);
810 /** Send a command to all local users from this user
811 * The command given must be able to send text with the
812 * first parameter as a servermask (e.g. $*), so basically
813 * you should use PRIVMSG or NOTICE.
814 * @param command the command to send
815 * @param text The text format string to send
816 * @param ... Format arguments
818 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
820 /** Compile a channel list for this user. Used internally by WHOIS
821 * @param source The user to prepare the channel list for
822 * @param spy Whether to return the spy channel list rather than the normal one
823 * @return This user's channel list
825 std::string ChannelList(User* source, bool spy);
827 /** Split the channel list in cl which came from dest, and spool it to this user
828 * Used internally by WHOIS
829 * @param dest The user the original channel list came from
830 * @param cl The channel list as a string obtained from User::ChannelList()
832 void SplitChanList(User* dest, const std::string &cl);
834 /** Remove this user from all channels they are on, and delete any that are now empty.
835 * This is used by QUIT, and will not send part messages!
837 void PurgeEmptyChannels();
839 /** Get the connect class which this user belongs to.
840 * @return A pointer to this user's connect class
842 ConnectClass *GetClass();
844 /** Set the connect class to which this user belongs to.
845 * @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.
846 * @return A reference to this user's current connect class.
848 ConnectClass *SetClass(const std::string &explicit_name = "");
850 /** Show the message of the day to this user
854 /** Show the server RULES file to this user
858 /** Increases a user's command penalty by a set amount.
860 void IncreasePenalty(int increase);
862 /** Decreases a user's command penalty by a set amount.
864 void DecreasePenalty(int decrease);
867 void OnError(BufferedSocketError error);
869 /** Default destructor
875 /** Derived from Resolver, and performs user forward/reverse lookups.
877 class CoreExport UserResolver : public Resolver
880 /** User this class is 'attached' to.
883 /** File descriptor teh lookup is bound to
886 /** True if the lookup is forward, false if is a reverse lookup
890 /** Create a resolver.
891 * @param Instance The creating instance
892 * @param user The user to begin lookup on
893 * @param to_resolve The IP or host to resolve
894 * @param qt The query type
895 * @param cache Modified by the constructor if the result was cached
897 UserResolver(User* user, std::string to_resolve, QueryType qt, bool &cache);
899 /** Called on successful lookup
900 * @param result Result string
901 * @param ttl Time to live for result
902 * @param cached True if the result was found in the cache
904 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
906 /** Called on failed lookup
907 * @param e Error code
908 * @param errormessage Error message string
910 void OnError(ResolverError e, const std::string &errormessage);