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 refcountbase
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 /** Create a new connect class with no settings.
132 ConnectClass(char type, const std::string& mask);
133 /** Create a new connect class with inherited settings.
135 ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
137 /** Update the settings in this block to match the given block */
138 void Update(const ConnectClass* newSettings);
141 const std::string& GetName() { return name; }
142 const std::string& GetPass() { return pass; }
143 const std::string& GetHost() { return host; }
144 const int GetPort() { return port; }
146 /** Returns the registration timeout
148 time_t GetRegTimeout()
150 return (registration_timeout ? registration_timeout : 90);
153 /** Returns the ping frequency
155 unsigned int GetPingTime()
157 return (pingtime ? pingtime : 120);
160 /** Returns the maximum sendq value (soft limit)
161 * Note that this is in addition to internal OS buffers
163 unsigned long GetSendqSoftMax()
165 return (softsendqmax ? softsendqmax : 4096);
168 /** Returns the maximum sendq value (hard limit)
170 unsigned long GetSendqHardMax()
172 return (hardsendqmax ? hardsendqmax : 0x100000);
175 /** Returns the maximum recvq value
177 unsigned long GetRecvqMax()
179 return (recvqmax ? recvqmax : 4096);
182 /** Returusn the maximum number of local sessions
184 unsigned long GetMaxLocal()
189 /** Returns the maximum number of global sessions
191 unsigned long GetMaxGlobal()
197 /** 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.
199 CoreExport typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
201 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
203 CoreExport typedef std::vector<reference<ConnectClass> > ClassVector;
205 /** Typedef for the list of user-channel records for a user
207 CoreExport typedef std::set<Channel*> UserChanList;
209 /** Shorthand for an iterator into a UserChanList
211 CoreExport typedef UserChanList::iterator UCListIter;
213 /* Required forward declaration
217 /** Holds all information about a user
218 * This class stores all information about a user connected to the irc server. Everything about a
219 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
220 * user's nickname and hostname.
222 class CoreExport User : public StreamSocket
225 /** A list of channels the user has a pending invite to.
226 * Upon INVITE channels are added, and upon JOIN, the
227 * channels are removed from this list.
231 /** Cached nick!ident@dhost value using the displayed hostname
233 std::string cached_fullhost;
235 /** Cached ident@ip value using the real IP address
237 std::string cached_hostip;
239 /** Cached ident@realhost value using the real hostname
241 std::string cached_makehost;
243 /** Cached nick!ident@realhost value using the real hostname
245 std::string cached_fullrealhost;
247 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
249 std::string cachedip;
251 /** When we erase the user (in the destructor),
252 * we call this method to subtract one from all
253 * mode characters this user is making use of.
255 void DecrementModes();
257 std::set<std::string> *AllowedOperCommands;
258 std::set<std::string> *AllowedPrivs;
260 /** Allowed user modes from oper classes. */
261 std::bitset<64> AllowedUserModes;
263 /** Allowed channel modes from oper classes. */
264 std::bitset<64> AllowedChanModes;
267 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
269 reference<ConnectClass> MyClass;
271 /** Hostname of connection.
272 * This should be valid as per RFC1035.
276 /** Stats counter for bytes inbound
280 /** Stats counter for bytes outbound
284 /** Stats counter for commands inbound
288 /** Stats counter for commands outbound
292 /** True if user has authenticated, false if otherwise
296 /** Used by User to indicate the registration status of the connection
297 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
298 * the connection state.
302 /** Time the connection was last pinged
306 /** Time that the object was instantiated (used for TS calculation etc)
310 /** Time the connection was created, set in the constructor. This
311 * may be different from the time the user's classbase object was
316 /** Time that the connection last sent a message, used to calculate idle time
320 /** Used by PING checking code
324 /** Stored reverse lookup from res_forward. Should not be used after resolution.
326 std::string stored_host;
328 /** Starts a DNS lookup of the user's IP.
329 * This will cause two UserResolver classes to be instantiated.
330 * When complete, these objects set User::dns_done to true.
332 void StartDNSLookup();
334 /** The users nickname.
335 * An invalid nickname indicates an unregistered connection prior to the NICK command.
336 * Use InspIRCd::IsNick() to validate nicknames.
340 /** The user's unique identifier.
341 * This is the unique identifier which the user has across the network.
345 /** The users ident reply.
346 * Two characters are added to the user-defined limit to compensate for the tilde etc.
350 /** The host displayed to non-opers (used for cloaking etc).
351 * This usually matches the value of User::host.
355 /** The users full name (GECOS).
357 std::string fullname;
359 /** The user's mode list.
360 * NOT a null terminated string.
362 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
363 * if (modes[modeletter-65]) is set, then the mode is
364 * set, for example, to work out if mode +s is set, we check the field
365 * User::modes['s'-65] != 0.
366 * The following RFC characters o, w, s, i have constants defined via an
367 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
369 std::bitset<64> modes;
371 /** What snomasks are set on this user.
372 * This functions the same as the above modes.
374 std::bitset<64> snomasks;
376 /** Channels this user is on, and the permissions they have there
380 /** The server the user is connected to.
384 /** The user's away message.
385 * If this string is empty, the user is not marked as away.
389 /** Time the user last went away.
390 * This is ONLY RELIABLE if user IS_AWAY()!
394 /** The oper type they logged in as, if they are an oper.
395 * This is used to check permissions in operclasses, so that
396 * we can say 'yay' or 'nay' to any commands they issue.
397 * The value of this is the value of a valid 'type name=' tag.
401 /** True when DNS lookups are completed.
402 * The UserResolver classes res_forward and res_reverse will
403 * set this value once they complete.
407 /** Password specified by the user when they registered.
408 * This is stored even if the <connect> block doesnt need a password, so that
409 * modules may check it.
411 std::string password;
413 /** Whether or not to send an snotice about this user's quitting
417 /** If this is set to true, then all socket operations for the user
418 * are dropped into the bit-bucket.
419 * This value is set by QuitUser, and is not needed seperately from that call.
420 * Please note that setting this value alone will NOT cause the user to quit.
424 /** Server address and port that this user is connected to.
425 * If unknown, address family is AF_UNKNOWN
427 irc::sockets::sockaddrs server_sa;
428 /** Client address that the user is connected from.
429 * Port number is only valid if local.
431 * Do not modify this value directly, use SetClientIP() to change it
433 irc::sockets::sockaddrs client_sa;
435 /** Sets the client IP for this user
436 * @return true if the conversion was successful
438 bool SetClientIP(const char* sip);
441 * @return The port number of this user.
445 /** Get client IP string from sockaddr, using static internal buffer
446 * @return The IP string
448 const char* GetIPString();
450 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
451 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
452 * This may be used for CIDR clone detection, etc.
454 * (XXX, brief note: when we do the sockets rewrite, this should move down a
455 * level so it may be used on more derived objects. -- w00t)
457 const char *GetCIDRMask(int range);
459 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
463 /** This value contains how far into the penalty threshold the user is. Once its over
464 * the penalty threshold then commands are held and processed on-timer.
468 /** Default constructor
469 * @throw CoreException if the UID allocated to the user already exists
470 * @param Instance Creator instance
471 * @param uid User UUID, or empty to allocate one automatically
473 User(const std::string &uid = "");
475 /** Check if the user matches a G or K line, and disconnect them if they do.
476 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
477 * Returns true if the user matched a ban, false else.
479 bool CheckLines(bool doZline = false);
481 /** Returns the full displayed host of the user
482 * This member function returns the hostname of the user as seen by other users
483 * on the server, in nick!ident&at;host form.
484 * @return The full masked host of the user
486 virtual const std::string GetFullHost();
488 /** Returns the full real host of the user
489 * This member function returns the hostname of the user as seen by other users
490 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
491 * e.g. through a module, then this method will ignore it and return the true hostname.
492 * @return The full real host of the user
494 virtual const std::string GetFullRealHost();
496 /** This clears any cached results that are used for GetFullRealHost() etc.
497 * The results of these calls are cached as generating them can be generally expensive.
499 void InvalidateCache();
501 /** Create a displayable mode string for this users snomasks
502 * @return The notice mask character sequence
504 const char* FormatNoticeMasks();
506 /** Process a snomask modifier string, e.g. +abc-de
507 * @param sm A sequence of notice mask characters
508 * @return The cleaned mode sequence which can be output,
509 * e.g. in the above example if masks c and e are not
510 * valid, this function will return +ab-d
512 std::string ProcessNoticeMasks(const char *sm);
514 /** Returns true if a notice mask is set
515 * @param sm A notice mask character to check
516 * @return True if the notice mask is set
518 bool IsNoticeMaskSet(unsigned char sm);
520 /** Changed a specific notice mask value
521 * @param sm The server notice mask to change
522 * @param value An on/off value for this mask
524 void SetNoticeMask(unsigned char sm, bool value);
526 /** Create a displayable mode string for this users umodes
527 * @param The mode string
529 const char* FormatModes(bool showparameters = false);
531 /** Returns true if a specific mode is set
532 * @param m The user mode
533 * @return True if the mode is set
535 bool IsModeSet(unsigned char m);
537 /** Set a specific usermode to on or off
538 * @param m The user mode
539 * @param value On or off setting of the mode
541 void SetMode(unsigned char m, bool value);
543 /** Returns true if a user is invited to a channel.
544 * @param channel A channel name to look up
545 * @return True if the user is invited to the given channel
547 virtual bool IsInvited(const irc::string &channel);
549 /** Adds a channel to a users invite list (invites them to a channel)
550 * @param channel A channel name to add
551 * @param timeout When the invite should expire (0 == never)
553 virtual void InviteTo(const irc::string &channel, time_t timeout);
555 /** Removes a channel from a users invite list.
556 * This member function is called on successfully joining an invite only channel
557 * to which the user has previously been invited, to clear the invitation.
558 * @param channel The channel to remove the invite to
560 virtual void RemoveInvite(const irc::string &channel);
562 /** Returns true or false for if a user can execute a privilaged oper command.
563 * This is done by looking up their oper type from User::oper, then referencing
564 * this to their oper classes and checking the commands they can execute.
565 * @param command A command (should be all CAPS)
566 * @return True if this user can execute the command
568 bool HasPermission(const std::string &command);
570 /** Returns true if a user has a given permission.
571 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
572 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
574 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
575 * @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.
576 * @return True if this user has the permission in question.
578 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
580 /** Returns true or false if a user can set a privileged user or channel mode.
581 * This is done by looking up their oper type from User::oper, then referencing
582 * this to their oper classes, and checking the modes they can set.
583 * @param mode The mode the check
584 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
585 * @return True if the user can set or unset this mode.
587 bool HasModePermission(unsigned char mode, ModeType type);
589 /** Adds to the user's write buffer.
590 * You may add any amount of text up to this users sendq value, if you exceed the
591 * sendq value, the user will be removed, and further buffer adds will be dropped.
592 * @param data The data to add to the write buffer
594 void AddWriteBuf(const std::string &data);
596 /** Returns the list of channels this user has been invited to but has not yet joined.
597 * @return A list of channels the user is invited to
599 InvitedList* GetInviteList();
601 /** Creates a wildcard host.
602 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
603 * @return The wildcarded hostname in *!*@host form
605 char* MakeWildHost();
607 /** Creates a usermask with real host.
608 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
609 * @return the usermask in the format user@host
611 const std::string& MakeHost();
613 /** Creates a usermask with real ip.
614 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
615 * @return the usermask in the format user@ip
617 const std::string& MakeHostIP();
619 /** Add the user to WHOWAS system
623 /** Oper up the user using the given opertype.
624 * This will also give the +o usermode.
625 * @param opertype The oper type to oper as
627 void Oper(const std::string &opertype, const std::string &opername);
629 /** Call this method to find the matching <connect> for a user, and to check them against it.
633 /** Use this method to fully connect a user.
634 * This will send the message of the day, check G/K/E lines, etc.
638 /** Change this users hash key to a new string.
639 * You should not call this function directly. It is used by the core
640 * to update the users hash entry on a nickchange.
641 * @param New new user_hash key
642 * @return Pointer to User in hash (usually 'this')
644 User* UpdateNickHash(const char* New);
646 /** Force a nickname change.
647 * If the nickname change fails (for example, because the nick in question
648 * already exists) this function will return false, and you must then either
649 * output an error message, or quit the user for nickname collision.
650 * @param newnick The nickname to change to
651 * @return True if the nickchange was successful.
653 bool ForceNickChange(const char* newnick);
656 * This will clear the +o usermode and unset the user's oper type
660 /** Write text to this user, appending CR/LF.
661 * @param text A std::string to send to the user
663 void Write(const std::string &text);
665 /** Write text to this user, appending CR/LF.
666 * @param text The format string for text to send to the user
667 * @param ... POD-type format arguments
669 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
671 /** Write text to this user, appending CR/LF and prepending :server.name
672 * @param text A std::string to send to the user
674 void WriteServ(const std::string& text);
676 /** Write text to this user, appending CR/LF and prepending :server.name
677 * @param text The format string for text to send to the user
678 * @param ... POD-type format arguments
680 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
682 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
684 void WriteNumeric(unsigned int numeric, const std::string &text);
686 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
687 * @param user The user to prepend the :nick!user@host of
688 * @param text A std::string to send to the user
690 void WriteFrom(User *user, const std::string &text);
692 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
693 * @param user The user to prepend the :nick!user@host of
694 * @param text The format string for text to send to the user
695 * @param ... POD-type format arguments
697 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
699 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
700 * @param dest The user to route the message to
701 * @param text A std::string to send to the user
703 void WriteTo(User *dest, const std::string &data);
705 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
706 * @param dest The user to route the message to
707 * @param text The format string for text to send to the user
708 * @param ... POD-type format arguments
710 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
712 /** Write to all users that can see this user (including this user in the list), appending CR/LF
713 * @param text A std::string to send to the users
715 void WriteCommonRaw(const std::string &line, bool include_self = true);
717 /** Write to all users that can see this user (including this user in the list), appending CR/LF
718 * @param text The format string for text to send to the users
719 * @param ... POD-type format arguments
721 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
723 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
724 * @param text The format string for text to send to the users
725 * @param ... POD-type format arguments
727 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
729 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
730 * quit message for opers only.
731 * @param normal_text Normal user quit message
732 * @param oper_text Oper only quit message
734 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
736 /** Write a WALLOPS message from this user to all local opers.
737 * If this user is not opered, the function will return without doing anything.
738 * @param text The format string to send in the WALLOPS message
739 * @param ... Format arguments
741 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
743 /** Write a WALLOPS message from this user to all local opers.
744 * If this user is not opered, the function will return without doing anything.
745 * @param text The text to send in the WALLOPS message
747 void WriteWallOps(const std::string &text);
749 /** Return true if the user shares at least one channel with another user
750 * @param other The other user to compare the channel list against
751 * @return True if the given user shares at least one channel with this user
753 bool SharesChannelWith(User *other);
755 /** Send fake quit/join messages for host or ident cycle.
756 * Run this after the item in question has changed.
757 * You should not need to use this function, call ChangeDisplayedHost instead
759 * @param The entire QUIT line, including the source using the old value
761 void DoHostCycle(const std::string &quitline);
763 /** Change the displayed host of a user.
764 * ALWAYS use this function, rather than writing User::dhost directly,
765 * as this triggers module events allowing the change to be syncronized to
766 * remote servers. This will also emulate a QUIT and rejoin (where configured)
767 * before setting their host field.
768 * @param host The new hostname to set
769 * @return True if the change succeeded, false if it didn't
771 bool ChangeDisplayedHost(const char* host);
773 /** Change the ident (username) of a user.
774 * ALWAYS use this function, rather than writing User::ident directly,
775 * as this correctly causes the user to seem to quit (where configured)
776 * before setting their ident field.
777 * @param host The new ident to set
778 * @return True if the change succeeded, false if it didn't
780 bool ChangeIdent(const char* newident);
782 /** Change a users realname field.
783 * ALWAYS use this function, rather than writing User::fullname directly,
784 * as this triggers module events allowing the change to be syncronized to
786 * @param gecos The user's new realname
787 * @return True if the change succeeded, false if otherwise
789 bool ChangeName(const char* gecos);
791 /** Send a command to all local users from this user
792 * The command given must be able to send text with the
793 * first parameter as a servermask (e.g. $*), so basically
794 * you should use PRIVMSG or NOTICE.
795 * @param command the command to send
796 * @param text The text format string to send
797 * @param ... Format arguments
799 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
801 /** Compile a channel list for this user. Used internally by WHOIS
802 * @param source The user to prepare the channel list for
803 * @param spy Whether to return the spy channel list rather than the normal one
804 * @return This user's channel list
806 std::string ChannelList(User* source, bool spy);
808 /** Split the channel list in cl which came from dest, and spool it to this user
809 * Used internally by WHOIS
810 * @param dest The user the original channel list came from
811 * @param cl The channel list as a string obtained from User::ChannelList()
813 void SplitChanList(User* dest, const std::string &cl);
815 /** Remove this user from all channels they are on, and delete any that are now empty.
816 * This is used by QUIT, and will not send part messages!
818 void PurgeEmptyChannels();
820 /** Get the connect class which this user belongs to.
821 * @return A pointer to this user's connect class
823 ConnectClass *GetClass();
825 /** Set the connect class to which this user belongs to.
826 * @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.
827 * @return A reference to this user's current connect class.
829 ConnectClass *SetClass(const std::string &explicit_name = "");
831 /** Show the message of the day to this user
835 /** Show the server RULES file to this user
839 /** Increases a user's command penalty by a set amount.
841 void IncreasePenalty(int increase);
843 /** Decreases a user's command penalty by a set amount.
845 void DecreasePenalty(int decrease);
848 void OnError(BufferedSocketError error);
850 /** Default destructor
856 /** Derived from Resolver, and performs user forward/reverse lookups.
858 class CoreExport UserResolver : public Resolver
861 /** User this class is 'attached' to.
864 /** File descriptor teh lookup is bound to
867 /** True if the lookup is forward, false if is a reverse lookup
871 /** Create a resolver.
872 * @param Instance The creating instance
873 * @param user The user to begin lookup on
874 * @param to_resolve The IP or host to resolve
875 * @param qt The query type
876 * @param cache Modified by the constructor if the result was cached
878 UserResolver(User* user, std::string to_resolve, QueryType qt, bool &cache);
880 /** Called on successful lookup
881 * @param result Result string
882 * @param ttl Time to live for result
883 * @param cached True if the result was found in the cache
885 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
887 /** Called on failed lookup
888 * @param e Error code
889 * @param errormessage Error message string
891 void OnError(ResolverError e, const std::string &errormessage);