2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
7 * Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007 Burlex <???@???>
9 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include "inspsocket.h"
30 #include "membership.h"
32 /** connect class types
39 /** named connect block (for opers, etc) */
43 /** Registration state of a user, e.g.
44 * have they sent USER, NICK, PASS yet?
46 enum RegistrationState {
48 #ifndef _WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
49 REG_NONE = 0, /* Has sent nothing */
52 REG_USER = 1, /* Has sent USER */
53 REG_NICK = 2, /* Has sent NICK */
54 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
55 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
64 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
66 struct CoreExport ConnectClass : public refcountbase
68 reference<ConfigTag> config;
69 /** Type of line, either CC_ALLOW or CC_DENY
73 /** True if this class uses fake lag to manage flood, false if it kills */
76 /** Connect class name
80 /** Max time to register the connection in seconds
82 unsigned int registration_timeout;
84 /** Host mask for this line
88 /** Number of seconds between pings for this line
90 unsigned int pingtime;
92 /** Maximum size of sendq for users in this class (bytes)
93 * Users cannot send commands if they go over this limit
95 unsigned long softsendqmax;
97 /** Maximum size of sendq for users in this class (bytes)
98 * Users are killed if they go over this limit
100 unsigned long hardsendqmax;
102 /** Maximum size of recvq for users in this class (bytes)
104 unsigned long recvqmax;
106 /** Seconds worth of penalty before penalty system activates
108 unsigned int penaltythreshold;
110 /** Maximum rate of commands (units: millicommands per second) */
111 unsigned int commandrate;
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;
121 /** True if max connections for this class is hit and a warning is wanted
125 /** Max channels for this class
127 unsigned int maxchans;
129 /** How many users may be in this connect class before they are refused?
130 * (0 = no limit = default)
134 /** If set to true, no user DNS lookups are to be performed
136 bool resolvehostnames;
138 /** Create a new connect class with no settings.
140 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
141 /** Create a new connect class with inherited settings.
143 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
145 /** Update the settings in this block to match the given block */
146 void Update(const ConnectClass* newSettings);
148 const std::string& GetName() { return name; }
149 const std::string& GetHost() { return host; }
151 /** Returns the registration timeout
153 time_t GetRegTimeout()
155 return (registration_timeout ? registration_timeout : 90);
158 /** Returns the ping frequency
160 unsigned int GetPingTime()
162 return (pingtime ? pingtime : 120);
165 /** Returns the maximum sendq value (soft limit)
166 * Note that this is in addition to internal OS buffers
168 unsigned long GetSendqSoftMax()
170 return (softsendqmax ? softsendqmax : 4096);
173 /** Returns the maximum sendq value (hard limit)
175 unsigned long GetSendqHardMax()
177 return (hardsendqmax ? hardsendqmax : 0x100000);
180 /** Returns the maximum recvq value
182 unsigned long GetRecvqMax()
184 return (recvqmax ? recvqmax : 4096);
187 /** Returns the penalty threshold value
189 unsigned int GetPenaltyThreshold()
191 return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
194 unsigned int GetCommandRate()
196 return commandrate ? commandrate : 1000;
199 /** Return the maximum number of local sessions
201 unsigned long GetMaxLocal()
206 /** Returns the maximum number of global sessions
208 unsigned long GetMaxGlobal()
214 /** Holds all information about a user
215 * This class stores all information about a user connected to the irc server. Everything about a
216 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
217 * user's nickname and hostname.
219 class CoreExport User : public Extensible
222 /** Cached nick!ident@dhost value using the displayed hostname
224 std::string cached_fullhost;
226 /** Cached ident@ip value using the real IP address
228 std::string cached_hostip;
230 /** Cached ident@realhost value using the real hostname
232 std::string cached_makehost;
234 /** Cached nick!ident@realhost value using the real hostname
236 std::string cached_fullrealhost;
238 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
240 std::string cachedip;
242 /** The user's mode list.
243 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
244 * if (modes[modeid]) is set, then the mode is set.
245 * For example, to work out if mode +i is set, we check the field
246 * User::modes[invisiblemode->modeid] == true.
248 std::bitset<ModeParser::MODEID_MAX> modes;
251 /** To execute a function for each local neighbor of a user, inherit from this class and
252 * pass an instance of it to User::ForEachNeighbor().
254 class ForEachNeighborHandler
257 /** Method to execute for each local neighbor of a user.
258 * Derived classes must implement this.
259 * @param user Current neighbor
261 virtual void Execute(LocalUser* user) = 0;
264 /** List of Memberships for this user
266 typedef insp::intrusive_list<Membership> ChanList;
268 /** Hostname of connection.
269 * This should be valid as per RFC1035.
273 /** Time that the object was instantiated (used for TS calculation etc)
277 /** Time the connection was created, set in the constructor. This
278 * may be different from the time the user's classbase object was
283 /** Client address that the user is connected from.
284 * Do not modify this value directly, use SetClientIP() to change it.
285 * Port is not valid for remote users.
287 irc::sockets::sockaddrs client_sa;
289 /** The users nickname.
290 * An invalid nickname indicates an unregistered connection prior to the NICK command.
291 * Use InspIRCd::IsNick() to validate nicknames.
295 /** The user's unique identifier.
296 * This is the unique identifier which the user has across the network.
298 const std::string uuid;
300 /** The users ident reply.
301 * Two characters are added to the user-defined limit to compensate for the tilde etc.
305 /** The host displayed to non-opers (used for cloaking etc).
306 * This usually matches the value of User::host.
310 /** The users full name (GECOS).
312 std::string fullname;
314 /** What snomasks are set on this user.
315 * This functions the same as the above modes.
317 std::bitset<64> snomasks;
319 /** Channels this user is on
323 /** The server the user is connected to.
327 /** The user's away message.
328 * If this string is empty, the user is not marked as away.
332 /** Time the user last went away.
333 * This is ONLY RELIABLE if user IsAway()!
337 /** The oper type they logged in as, if they are an oper.
339 reference<OperInfo> oper;
341 /** Used by User to indicate the registration status of the connection
342 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
343 * the connection state.
345 unsigned int registered:3;
347 /** If this is set to true, then all socket operations for the user
348 * are dropped into the bit-bucket.
349 * This value is set by QuitUser, and is not needed seperately from that call.
350 * Please note that setting this value alone will NOT cause the user to quit.
352 unsigned int quitting:1;
354 /** What type of user is this? */
355 const unsigned int usertype:2;
357 /** Get client IP string from sockaddr, using static internal buffer
358 * @return The IP string
360 const std::string& GetIPString();
362 /** Get CIDR mask, using default range, for this user
364 irc::sockets::cidr_mask GetCIDRMask();
366 /** Sets the client IP for this user
367 * @return true if the conversion was successful
369 virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
371 virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
374 * @throw CoreException if the UID allocated to the user already exists
376 User(const std::string& uid, Server* srv, int objtype);
378 /** Returns the full displayed host of the user
379 * This member function returns the hostname of the user as seen by other users
380 * on the server, in nick!ident\@host form.
381 * @return The full masked host of the user
383 virtual const std::string& GetFullHost();
385 /** Returns the full real host of the user
386 * This member function returns the hostname of the user as seen by other users
387 * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
388 * e.g. through a module, then this method will ignore it and return the true hostname.
389 * @return The full real host of the user
391 virtual const std::string& GetFullRealHost();
393 /** This clears any cached results that are used for GetFullRealHost() etc.
394 * The results of these calls are cached as generating them can be generally expensive.
396 void InvalidateCache();
398 /** Returns whether this user is currently away or not. If true,
399 * further information can be found in User::awaymsg and User::awaytime
400 * @return True if the user is away, false otherwise
402 bool IsAway() const { return (!awaymsg.empty()); }
404 /** Returns whether this user is an oper or not. If true,
405 * oper information can be obtained from User::oper
406 * @return True if the user is an oper, false otherwise
408 bool IsOper() const { return oper; }
410 /** Returns true if a notice mask is set
411 * @param sm A notice mask character to check
412 * @return True if the notice mask is set
414 bool IsNoticeMaskSet(unsigned char sm);
416 /** Create a displayable mode string for this users umodes
417 * @param showparameters The mode string
419 const char* FormatModes(bool showparameters = false);
421 /** Returns true if a specific mode is set
422 * @param m The user mode
423 * @return True if the mode is set
425 bool IsModeSet(unsigned char m);
426 bool IsModeSet(ModeHandler* mh);
427 bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
428 bool IsModeSet(UserModeReference& moderef);
430 /** Set a specific usermode to on or off
431 * @param m The user mode
432 * @param value On or off setting of the mode
434 void SetMode(ModeHandler* mh, bool value);
435 void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
437 /** Returns true or false for if a user can execute a privilaged oper command.
438 * This is done by looking up their oper type from User::oper, then referencing
439 * this to their oper classes and checking the commands they can execute.
440 * @param command A command (should be all CAPS)
441 * @return True if this user can execute the command
443 virtual bool HasPermission(const std::string &command);
445 /** Returns true if a user has a given permission.
446 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
447 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
449 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
450 * @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.
451 * @return True if this user has the permission in question.
453 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
455 /** Returns true or false if a user can set a privileged user or channel mode.
456 * This is done by looking up their oper type from User::oper, then referencing
457 * this to their oper classes, and checking the modes they can set.
458 * @param mode The mode the check
459 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
460 * @return True if the user can set or unset this mode.
462 virtual bool HasModePermission(unsigned char mode, ModeType type);
464 /** Creates a usermask with real host.
465 * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
466 * @return the usermask in the format user\@host
468 const std::string& MakeHost();
470 /** Creates a usermask with real ip.
471 * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
472 * @return the usermask in the format user\@ip
474 const std::string& MakeHostIP();
476 /** Oper up the user using the given opertype.
477 * This will also give the +o usermode.
479 void Oper(OperInfo* info);
482 * This will clear the +o usermode and unset the user's oper type
486 /** Write text to this user, appending CR/LF. Works on local users only.
487 * @param text A std::string to send to the user
489 virtual void Write(const std::string &text);
491 /** Write text to this user, appending CR/LF.
492 * Works on local users only.
493 * @param text The format string for text to send to the user
494 * @param ... POD-type format arguments
496 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
498 /** Write text to this user, appending CR/LF and prepending :server.name
499 * Works on local users only.
500 * @param text A std::string to send to the user
502 void WriteServ(const std::string& text);
504 /** Write text to this user, appending CR/LF and prepending :server.name
505 * Works on local users only.
506 * @param text The format string for text to send to the user
507 * @param ... POD-type format arguments
509 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
511 /** Sends a command to this user.
512 * @param command The command to be sent.
513 * @param text The message to send.
515 void WriteCommand(const char* command, const std::string& text);
517 /** Sends a server notice to this user.
518 * @param text The contents of the message to send.
520 void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
522 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
524 void WriteNumeric(unsigned int numeric, const std::string &text);
526 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
527 * @param user The user to prepend the :nick!user\@host of
528 * @param text A std::string to send to the user
530 void WriteFrom(User *user, const std::string &text);
532 /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
533 * @param user The user to prepend the :nick!user\@host of
534 * @param text The format string for text to send to the user
535 * @param ... POD-type format arguments
537 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
539 /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
540 * @param line A std::string to send to the users
541 * @param include_self Should the message be sent back to the author?
543 void WriteCommonRaw(const std::string &line, bool include_self = true);
545 /** Write to all users that can see this user (including this user in the list), appending CR/LF
546 * @param text The format string for text to send to the users
547 * @param ... POD-type format arguments
549 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
551 /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
552 * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
553 * This function is used for example to send something conditionally to neighbors, or to send different messages
554 * to different users depending on their oper status.
555 * @param handler Function object to call, inherited from ForEachNeighborHandler.
556 * @param include_self True to include this user in the set of neighbors, false otherwise.
557 * Modules may override this. Has no effect if this user is not local.
559 void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
561 /** Dump text to a user target, splitting it appropriately to fit
562 * @param linePrefix text to prefix each complete line with
563 * @param textStream the text to send to the user
565 void SendText(const std::string& linePrefix, std::stringstream& textStream);
567 /** Write to the user, routing the line if the user is remote.
569 virtual void SendText(const std::string& line) = 0;
571 /** Write to the user, routing the line if the user is remote.
573 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
575 /** Return true if the user shares at least one channel with another user
576 * @param other The other user to compare the channel list against
577 * @return True if the given user shares at least one channel with this user
579 bool SharesChannelWith(User *other);
581 /** Change the displayed host of a user.
582 * ALWAYS use this function, rather than writing User::dhost directly,
583 * as this triggers module events allowing the change to be syncronized to
585 * @param host The new hostname to set
586 * @return True if the change succeeded, false if it didn't
587 * (a module vetoed the change).
589 bool ChangeDisplayedHost(const std::string& host);
591 /** Change the ident (username) of a user.
592 * ALWAYS use this function, rather than writing User::ident directly,
593 * as this triggers module events allowing the change to be syncronized to
595 * @param newident The new ident to set
596 * @return True if the change succeeded, false if it didn't
598 bool ChangeIdent(const std::string& newident);
600 /** Change a users realname field.
601 * ALWAYS use this function, rather than writing User::fullname directly,
602 * as this triggers module events allowing the change to be syncronized to
604 * @param gecos The user's new realname
605 * @return True if the change succeeded, false if otherwise
607 bool ChangeName(const std::string& gecos);
609 /** Change a user's nick
610 * @param newnick The new nick. If equal to the users uuid, the nick change always succeeds.
611 * @return True if the change succeeded
613 bool ChangeNick(const std::string& newnick, time_t newts = 0);
615 /** Remove this user from all channels they are on, and delete any that are now empty.
616 * This is used by QUIT, and will not send part messages!
618 void PurgeEmptyChannels();
620 /** Default destructor
623 virtual CullResult cull();
626 class CoreExport UserIOHandler : public StreamSocket
629 LocalUser* const user;
630 UserIOHandler(LocalUser* me) : user(me) {}
632 void OnError(BufferedSocketError error);
634 /** Adds to the user's write buffer.
635 * You may add any amount of text up to this users sendq value, if you exceed the
636 * sendq value, the user will be removed, and further buffer adds will be dropped.
637 * @param data The data to add to the write buffer
639 void AddWriteBuf(const std::string &data);
642 typedef unsigned int already_sent_t;
644 class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public insp::intrusive_list_node<LocalUser>
647 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
652 /** Stats counter for bytes inbound
654 unsigned int bytes_in;
656 /** Stats counter for bytes outbound
658 unsigned int bytes_out;
660 /** Stats counter for commands inbound
662 unsigned int cmds_in;
664 /** Stats counter for commands outbound
666 unsigned int cmds_out;
668 /** Password specified by the user when they registered (if any).
669 * This is stored even if the \<connect> block doesnt need a password, so that
670 * modules may check it.
672 std::string password;
674 /** Contains a pointer to the connect class a user is on from
676 reference<ConnectClass> MyClass;
678 /** Get the connect class which this user belongs to.
679 * @return A pointer to this user's connect class.
681 ConnectClass* GetClass() const { return MyClass; }
683 /** Call this method to find the matching \<connect> for a user, and to check them against it.
685 void CheckClass(bool clone_count = true);
687 /** Server address and port that this user is connected to.
689 irc::sockets::sockaddrs server_sa;
692 * @return The port number of this user.
696 /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
697 * This can't be handled normally because QuitUser itself calls Write on other
698 * users, which could trigger their SendQ to overrun.
700 unsigned int quitting_sendq:1;
702 /** has the user responded to their previous ping?
704 unsigned int lastping:1;
706 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
708 unsigned int exempt:1;
710 /** Used by PING checking code
714 /** Time that the connection last sent a message, used to calculate idle time
718 /** This value contains how far into the penalty threshold the user is.
719 * This is used either to enable fake lag or for excess flood quits
721 unsigned int CommandFloodPenalty;
723 static already_sent_t already_sent_id;
724 already_sent_t already_sent;
726 /** Check if the user matches a G or K line, and disconnect them if they do.
727 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
728 * Returns true if the user matched a ban, false else.
730 bool CheckLines(bool doZline = false);
732 /** Use this method to fully connect a user.
733 * This will send the message of the day, check G/K/E lines, etc.
737 /** Set the connect class to which this user belongs to.
738 * @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.
739 * @return A reference to this user's current connect class.
741 void SetClass(const std::string &explicit_name = "");
743 bool SetClientIP(const char* sip, bool recheck_eline = true);
745 void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
747 void SendText(const std::string& line);
748 void Write(const std::string& text);
749 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
751 /** Returns the list of channels this user has been invited to but has not yet joined.
752 * @return A list of channels the user is invited to
754 InviteList& GetInviteList();
756 /** Returns true if a user is invited to a channel.
757 * @param chan A channel to look up
758 * @return True if the user is invited to the given channel
760 bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
762 /** Removes a channel from a users invite list.
763 * This member function is called on successfully joining an invite only channel
764 * to which the user has previously been invited, to clear the invitation.
765 * @param chan The channel to remove the invite to
766 * @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
768 bool RemoveInvite(Channel* chan);
770 void RemoveExpiredInvites();
772 /** Returns true or false for if a user can execute a privilaged oper command.
773 * This is done by looking up their oper type from User::oper, then referencing
774 * this to their oper classes and checking the commands they can execute.
775 * @param command A command (should be all CAPS)
776 * @return True if this user can execute the command
778 bool HasPermission(const std::string &command);
780 /** Returns true if a user has a given permission.
781 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
782 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
784 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
785 * @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.
786 * @return True if this user has the permission in question.
788 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
790 /** Returns true or false if a user can set a privileged user or channel mode.
791 * This is done by looking up their oper type from User::oper, then referencing
792 * this to their oper classes, and checking the modes they can set.
793 * @param mode The mode the check
794 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
795 * @return True if the user can set or unset this mode.
797 bool HasModePermission(unsigned char mode, ModeType type);
800 class CoreExport RemoteUser : public User
803 RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
806 virtual void SendText(const std::string& line);
809 class CoreExport FakeUser : public User
812 FakeUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_SERVER)
814 nick = srv->GetName();
817 FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
818 : User(uid, new Server(sname, sdesc), USERTYPE_SERVER)
823 virtual CullResult cull();
824 virtual void SendText(const std::string& line);
825 virtual const std::string& GetFullHost();
826 virtual const std::string& GetFullRealHost();
829 /* Faster than dynamic_cast */
830 /** Is a local user */
831 inline LocalUser* IS_LOCAL(User* u)
833 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
835 /** Is a remote user */
836 inline RemoteUser* IS_REMOTE(User* u)
838 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
840 /** Is a server fakeuser */
841 inline FakeUser* IS_SERVER(User* u)
843 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
846 inline bool User::IsModeSet(ModeHandler* mh)
848 return (modes[mh->GetId()]);
851 inline bool User::IsModeSet(UserModeReference& moderef)
855 return IsModeSet(*moderef);
858 inline void User::SetMode(ModeHandler* mh, bool value)
860 modes[mh->GetId()] = value;