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 * ---------------------------------------------------
21 /** Channel status for a user
34 /** connect class types
43 /** RFC1459 channel modes
46 /** +s: Server notice mask */
47 UM_SNOMASK = 's' - 65,
49 UM_WALLOPS = 'w' - 65,
51 UM_INVISIBLE = 'i' - 65,
53 UM_OPERATOR = 'o' - 65
56 /** Registration state of a user, e.g.
57 * have they sent USER, NICK, PASS yet?
59 enum RegistrationState {
61 #ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
62 REG_NONE = 0, /* Has sent nothing */
65 REG_USER = 1, /* Has sent USER */
66 REG_NICK = 2, /* Has sent NICK */
67 REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
68 REG_ALL = 7 /* REG_NICKUSER plus next bit along */
71 /* Required forward declaration */
75 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
77 struct CoreExport ConnectClass : public classbase
79 /** Type of line, either CC_ALLOW or CC_DENY
83 /** Connect class name
87 /** Max time to register the connection in seconds
89 unsigned int registration_timeout;
91 /** Host mask for this line
95 /** Number of seconds between pings for this line
97 unsigned int pingtime;
99 /** (Optional) Password for this line
103 /** (Optional) Hash Method for this line
107 /** Maximum size of sendq for users in this class (bytes)
109 unsigned long sendqmax;
111 /** Maximum size of recvq for users in this class (bytes)
113 unsigned long recvqmax;
115 /** Local max when connecting by this connection class
117 unsigned long maxlocal;
119 /** Global max when connecting by this connection class
121 unsigned long maxglobal;
123 /** Max channels for this class
125 unsigned int maxchans;
127 /** Port number this connect class applies to
131 /** How many users may be in this connect class before they are refused?
132 * (0 = no limit = default)
136 /** Reference counter.
137 * This will be 1 if no users are connected, as long as it is a valid connect block
138 * When it reaches 0, the object should be deleted
140 unsigned long RefCount;
142 /** Create a new connect class with no settings.
144 ConnectClass(char type, const std::string& mask);
145 /** Create a new connect class with inherited settings.
147 ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
149 /** Update the settings in this block to match the given block */
150 void Update(const ConnectClass* newSettings);
153 const std::string& GetName() { return name; }
154 const std::string& GetPass() { return pass; }
155 const std::string& GetHost() { return host; }
156 const int GetPort() { return port; }
158 /** Returns the registration timeout
160 time_t GetRegTimeout()
162 return (registration_timeout ? registration_timeout : 90);
165 /** Returns the ping frequency
167 unsigned int GetPingTime()
169 return (pingtime ? pingtime : 120);
172 /** Returns the maximum sendq value
174 unsigned long GetSendqMax()
176 return (sendqmax ? sendqmax : 262114);
179 /** Returns the maximum recvq value
181 unsigned long GetRecvqMax()
183 return (recvqmax ? recvqmax : 4096);
186 /** Returusn the maximum number of local sessions
188 unsigned long GetMaxLocal()
193 /** Returns the maximum number of global sessions
195 unsigned long GetMaxGlobal()
201 /** 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.
203 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
205 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
207 typedef std::vector<ConnectClass*> ClassVector;
209 /** Typedef for the list of user-channel records for a user
211 typedef std::map<Channel*, char> UserChanList;
213 /** Shorthand for an iterator into a UserChanList
215 typedef UserChanList::iterator UCListIter;
217 /* Required forward declaration
221 /** Visibility data for a user.
222 * If a user has a non-null instance of this class in their User,
223 * then it is used to determine if this user is visible to other users
226 class CoreExport VisData
232 /** Destroy a visdata
235 /** Is this user visible to some other user?
236 * @param user The other user to compare to
237 * @return true True if the user is visible to the other user, false if not
239 virtual bool VisibleTo(User* user);
242 /** Holds all information about a user
243 * This class stores all information about a user connected to the irc server. Everything about a
244 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
245 * user's nickname and hostname.
247 class CoreExport User : public EventHandler
250 /** A list of channels the user has a pending invite to.
251 * Upon INVITE channels are added, and upon JOIN, the
252 * channels are removed from this list.
256 /** Cached nick!ident@dhost value using the displayed hostname
258 std::string cached_fullhost;
260 /** Cached ident@ip value using the real IP address
262 std::string cached_hostip;
264 /** Cached ident@realhost value using the real hostname
266 std::string cached_makehost;
268 /** Cached nick!ident@realhost value using the real hostname
270 std::string cached_fullrealhost;
272 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
274 std::string cachedip;
276 /** When we erase the user (in the destructor),
277 * we call this method to subtract one from all
278 * mode characters this user is making use of.
280 void DecrementModes();
282 std::set<std::string> *AllowedOperCommands;
283 std::set<std::string> *AllowedPrivs;
285 /** Allowed user modes from oper classes. */
286 std::bitset<64> AllowedUserModes;
288 /** Allowed channel modes from oper classes. */
289 std::bitset<64> AllowedChanModes;
292 /** Pointer to creator.
293 * This is required to make use of core functions
294 * from within the User class.
296 InspIRCd* ServerInstance;
298 /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
299 * The pointer is guarenteed to *always* be valid. :)
301 ConnectClass *MyClass;
303 /** User visibility state, see definition of VisData.
307 /** Hostname of connection.
308 * This should be valid as per RFC1035.
312 /** Stats counter for bytes inbound
316 /** Stats counter for bytes outbound
320 /** Stats counter for commands inbound
324 /** Stats counter for commands outbound
328 /** True if user has authenticated, false if otherwise
332 /** Used by User to indicate the registration status of the connection
333 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
334 * the connection state.
338 /** Time the connection was last pinged
342 /** Time that the object was instantiated (used for TS calculation etc)
346 /** Time the connection was created, set in the constructor. This
347 * may be different from the time the user's classbase object was
352 /** Time that the connection last sent a message, used to calculate idle time
356 /** Used by PING checking code
360 /** Stored reverse lookup from res_forward. Should not be used after resolution.
362 std::string stored_host;
364 /** Starts a DNS lookup of the user's IP.
365 * This will cause two UserResolver classes to be instantiated.
366 * When complete, these objects set User::dns_done to true.
368 void StartDNSLookup();
370 /** The users nickname.
371 * An invalid nickname indicates an unregistered connection prior to the NICK command.
372 * Use InspIRCd::IsNick() to validate nicknames.
376 /** The user's unique identifier.
377 * This is the unique identifier which the user has across the network.
381 /** The users ident reply.
382 * Two characters are added to the user-defined limit to compensate for the tilde etc.
386 /** The host displayed to non-opers (used for cloaking etc).
387 * This usually matches the value of User::host.
391 /** The users full name (GECOS).
393 std::string fullname;
395 /** The user's mode list.
396 * NOT a null terminated string.
398 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
399 * if (modes[modeletter-65]) is set, then the mode is
400 * set, for example, to work out if mode +s is set, we check the field
401 * User::modes['s'-65] != 0.
402 * The following RFC characters o, w, s, i have constants defined via an
403 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
405 std::bitset<64> modes;
407 /** What snomasks are set on this user.
408 * This functions the same as the above modes.
410 std::bitset<64> snomasks;
412 /** Channels this user is on, and the permissions they have there
416 /** The server the user is connected to.
420 /** The user's away message.
421 * If this string is empty, the user is not marked as away.
425 /** Time the user last went away.
426 * This is ONLY RELIABLE if user IS_AWAY()!
430 /** The oper type they logged in as, if they are an oper.
431 * This is used to check permissions in operclasses, so that
432 * we can say 'yay' or 'nay' to any commands they issue.
433 * The value of this is the value of a valid 'type name=' tag.
437 /** True when DNS lookups are completed.
438 * The UserResolver classes res_forward and res_reverse will
439 * set this value once they complete.
443 /** Password specified by the user when they registered.
444 * This is stored even if the <connect> block doesnt need a password, so that
445 * modules may check it.
447 std::string password;
449 /** User's receive queue.
450 * Lines from the IRCd awaiting processing are stored here.
451 * Upgraded april 2005, old system a bit hairy.
455 /** User's send queue.
456 * Lines waiting to be sent are stored here until their buffer is flushed.
460 /** Message user will quit with. Not to be set externally.
464 /** Quit message shown to opers - not to be set externally.
466 std::string operquitmsg;
468 /** Whether or not to send an snotice about this user's quitting
472 /** If this is set to true, then all socket operations for the user
473 * are dropped into the bit-bucket.
474 * This value is set by QuitUser, and is not needed seperately from that call.
475 * Please note that setting this value alone will NOT cause the user to quit.
479 /** Server address and port that this user is connected to.
480 * If unknown, address family is AF_UNKNOWN
482 irc::sockets::sockaddrs server_sa;
483 /** Client address that the user is connected from.
484 * Port number is only valid if local.
486 * Do not modify this value directly, use SetClientIP() to change it
488 irc::sockets::sockaddrs client_sa;
490 /** Sets the client IP for this user
491 * @return true if the conversion was successful
493 bool SetClientIP(const char* sip);
496 * @return The port number of this user.
500 * @return The server IP address
502 std::string GetServerIP();
504 /** Get client IP string from sockaddr, using static internal buffer
505 * @return The IP string
507 const char* GetIPString();
509 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
510 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
511 * This may be used for CIDR clone detection, etc.
513 * (XXX, brief note: when we do the sockets rewrite, this should move down a
514 * level so it may be used on more derived objects. -- w00t)
516 const char *GetCIDRMask(int range);
518 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
522 /** This value contains how far into the penalty threshold the user is. Once its over
523 * the penalty threshold then commands are held and processed on-timer.
527 /** Default constructor
528 * @throw CoreException if the UID allocated to the user already exists
529 * @param Instance Creator instance
530 * @param uid User UUID, or empty to allocate one automatically
532 User(InspIRCd* Instance, const std::string &uid = "");
534 /** Check if the user matches a G or K line, and disconnect them if they do.
535 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
536 * Returns true if the user matched a ban, false else.
538 bool CheckLines(bool doZline = false);
540 /** Returns the full displayed host of the user
541 * This member function returns the hostname of the user as seen by other users
542 * on the server, in nick!ident&at;host form.
543 * @return The full masked host of the user
545 virtual const std::string GetFullHost();
547 /** Returns the full real host of the user
548 * This member function returns the hostname of the user as seen by other users
549 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
550 * e.g. through a module, then this method will ignore it and return the true hostname.
551 * @return The full real host of the user
553 virtual const std::string GetFullRealHost();
555 /** This clears any cached results that are used for GetFullRealHost() etc.
556 * The results of these calls are cached as generating them can be generally expensive.
558 void InvalidateCache();
560 /** Create a displayable mode string for this users snomasks
561 * @return The notice mask character sequence
563 const char* FormatNoticeMasks();
565 /** Process a snomask modifier string, e.g. +abc-de
566 * @param sm A sequence of notice mask characters
567 * @return The cleaned mode sequence which can be output,
568 * e.g. in the above example if masks c and e are not
569 * valid, this function will return +ab-d
571 std::string ProcessNoticeMasks(const char *sm);
573 /** Returns true if a notice mask is set
574 * @param sm A notice mask character to check
575 * @return True if the notice mask is set
577 bool IsNoticeMaskSet(unsigned char sm);
579 /** Changed a specific notice mask value
580 * @param sm The server notice mask to change
581 * @param value An on/off value for this mask
583 void SetNoticeMask(unsigned char sm, bool value);
585 /** Create a displayable mode string for this users umodes
586 * @param The mode string
588 const char* FormatModes(bool showparameters = false);
590 /** Returns true if a specific mode is set
591 * @param m The user mode
592 * @return True if the mode is set
594 bool IsModeSet(unsigned char m);
596 /** Set a specific usermode to on or off
597 * @param m The user mode
598 * @param value On or off setting of the mode
600 void SetMode(unsigned char m, bool value);
602 /** Returns true if a user is invited to a channel.
603 * @param channel A channel name to look up
604 * @return True if the user is invited to the given channel
606 virtual bool IsInvited(const irc::string &channel);
608 /** Adds a channel to a users invite list (invites them to a channel)
609 * @param channel A channel name to add
610 * @param timeout When the invite should expire (0 == never)
612 virtual void InviteTo(const irc::string &channel, time_t timeout);
614 /** Removes a channel from a users invite list.
615 * This member function is called on successfully joining an invite only channel
616 * to which the user has previously been invited, to clear the invitation.
617 * @param channel The channel to remove the invite to
619 virtual void RemoveInvite(const irc::string &channel);
621 /** Returns true or false for if a user can execute a privilaged oper command.
622 * This is done by looking up their oper type from User::oper, then referencing
623 * this to their oper classes and checking the commands they can execute.
624 * @param command A command (should be all CAPS)
625 * @return True if this user can execute the command
627 bool HasPermission(const std::string &command);
629 /** Returns true if a user has a given permission.
630 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
631 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
633 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
634 * @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.
635 * @return True if this user has the permission in question.
637 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
639 /** Returns true or false if a user can set a privileged user or channel mode.
640 * This is done by looking up their oper type from User::oper, then referencing
641 * this to their oper classes, and checking the modes they can set.
642 * @param mode The mode the check
643 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
644 * @return True if the user can set or unset this mode.
646 bool HasModePermission(unsigned char mode, ModeType type);
648 /** Calls read() to read some data for this user using their fd.
649 * @param buffer The buffer to read into
650 * @param size The size of data to read
651 * @return The number of bytes read, or -1 if an error occured.
653 int ReadData(void* buffer, size_t size);
655 /** This method adds data to the read buffer of the user.
656 * The buffer can grow to any size within limits of the available memory,
657 * managed by the size of a std::string, however if any individual line in
658 * the buffer grows over 600 bytes in length (which is 88 chars over the
659 * RFC-specified limit per line) then the method will return false and the
660 * text will not be inserted.
661 * @param a The string to add to the users read buffer
662 * @return True if the string was successfully added to the read buffer
664 bool AddBuffer(const std::string &a);
666 /** This method returns true if the buffer contains at least one carriage return
667 * character (e.g. one complete line may be read)
668 * @return True if there is at least one complete line in the users buffer
670 bool BufferIsReady();
672 /** This function clears the entire buffer by setting it to an empty string.
676 /** This method returns the first available string at the tail end of the buffer
677 * and advances the tail end of the buffer past the string. This means it is
678 * a one way operation in a similar way to strtok(), and multiple calls return
679 * multiple lines if they are available. The results of this function if there
680 * are no lines to be read are unknown, always use BufferIsReady() to check if
681 * it is ok to read the buffer before calling GetBuffer().
682 * @return The string at the tail end of this users buffer
684 std::string GetBuffer();
686 /** Adds to the user's write buffer.
687 * You may add any amount of text up to this users sendq value, if you exceed the
688 * sendq value, the user will be removed, and further buffer adds will be dropped.
689 * @param data The data to add to the write buffer
691 void AddWriteBuf(const std::string &data);
693 /** Flushes as much of the user's buffer to the file descriptor as possible.
694 * This function may not always flush the entire buffer, rather instead as much of it
695 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
696 * position is advanced forwards and the rest of the data sent at the next call to
699 void FlushWriteBuf();
701 /** Returns the list of channels this user has been invited to but has not yet joined.
702 * @return A list of channels the user is invited to
704 InvitedList* GetInviteList();
706 /** Creates a wildcard host.
707 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
708 * @return The wildcarded hostname in *!*@host form
710 char* MakeWildHost();
712 /** Creates a usermask with real host.
713 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
714 * @return the usermask in the format user@host
716 const std::string& MakeHost();
718 /** Creates a usermask with real ip.
719 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
720 * @return the usermask in the format user@ip
722 const std::string& MakeHostIP();
724 /** Shuts down and closes the user's socket
725 * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
726 * which will call CloseSocket() for you.
730 /** Add the user to WHOWAS system
734 /** Oper up the user using the given opertype.
735 * This will also give the +o usermode.
736 * @param opertype The oper type to oper as
738 void Oper(const std::string &opertype, const std::string &opername);
740 /** Call this method to find the matching <connect> for a user, and to check them against it.
744 /** Use this method to fully connect a user.
745 * This will send the message of the day, check G/K/E lines, etc.
749 /** Change this users hash key to a new string.
750 * You should not call this function directly. It is used by the core
751 * to update the users hash entry on a nickchange.
752 * @param New new user_hash key
753 * @return Pointer to User in hash (usually 'this')
755 User* UpdateNickHash(const char* New);
757 /** Force a nickname change.
758 * If the nickname change fails (for example, because the nick in question
759 * already exists) this function will return false, and you must then either
760 * output an error message, or quit the user for nickname collision.
761 * @param newnick The nickname to change to
762 * @return True if the nickchange was successful.
764 bool ForceNickChange(const char* newnick);
767 * This will clear the +o usermode and unset the user's oper type
771 /** Write text to this user, appending CR/LF.
772 * @param text A std::string to send to the user
774 void Write(const std::string &text);
776 /** Write text to this user, appending CR/LF.
777 * @param text The format string for text to send to the user
778 * @param ... POD-type format arguments
780 void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
782 /** Write text to this user, appending CR/LF and prepending :server.name
783 * @param text A std::string to send to the user
785 void WriteServ(const std::string& text);
787 /** Write text to this user, appending CR/LF and prepending :server.name
788 * @param text The format string for text to send to the user
789 * @param ... POD-type format arguments
791 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
793 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
795 void WriteNumeric(unsigned int numeric, const std::string &text);
797 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
798 * @param user The user to prepend the :nick!user@host of
799 * @param text A std::string to send to the user
801 void WriteFrom(User *user, const std::string &text);
803 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
804 * @param user The user to prepend the :nick!user@host of
805 * @param text The format string for text to send to the user
806 * @param ... POD-type format arguments
808 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
810 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
811 * @param dest The user to route the message to
812 * @param text A std::string to send to the user
814 void WriteTo(User *dest, const std::string &data);
816 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
817 * @param dest The user to route the message to
818 * @param text The format string for text to send to the user
819 * @param ... POD-type format arguments
821 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
823 /** Write to all users that can see this user (including this user in the list), appending CR/LF
824 * @param text A std::string to send to the users
826 void WriteCommon(const std::string &text);
828 /** Write to all users that can see this user (including this user in the list), appending CR/LF
829 * @param text The format string for text to send to the users
830 * @param ... POD-type format arguments
832 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
834 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
835 * @param text The format string for text to send to the users
836 * @param ... POD-type format arguments
838 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
840 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
841 * @param text A std::string to send to the users
843 void WriteCommonExcept(const std::string &text);
845 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
846 * quit message for opers only.
847 * @param normal_text Normal user quit message
848 * @param oper_text Oper only quit message
850 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
852 /** Write a WALLOPS message from this user to all local opers.
853 * If this user is not opered, the function will return without doing anything.
854 * @param text The format string to send in the WALLOPS message
855 * @param ... Format arguments
857 void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
859 /** Write a WALLOPS message from this user to all local opers.
860 * If this user is not opered, the function will return without doing anything.
861 * @param text The text to send in the WALLOPS message
863 void WriteWallOps(const std::string &text);
865 /** Return true if the user shares at least one channel with another user
866 * @param other The other user to compare the channel list against
867 * @return True if the given user shares at least one channel with this user
869 bool SharesChannelWith(User *other);
871 /** Send fake quit/join messages for host or ident cycle.
872 * Run this after the item in question has changed.
873 * You should not need to use this function, call ChangeDisplayedHost instead
875 * @param The entire QUIT line, including the source using the old value
877 void DoHostCycle(const std::string &quitline);
879 /** Change the displayed host of a user.
880 * ALWAYS use this function, rather than writing User::dhost directly,
881 * as this triggers module events allowing the change to be syncronized to
882 * remote servers. This will also emulate a QUIT and rejoin (where configured)
883 * before setting their host field.
884 * @param host The new hostname to set
885 * @return True if the change succeeded, false if it didn't
887 bool ChangeDisplayedHost(const char* host);
889 /** Change the ident (username) of a user.
890 * ALWAYS use this function, rather than writing User::ident directly,
891 * as this correctly causes the user to seem to quit (where configured)
892 * before setting their ident field.
893 * @param host The new ident to set
894 * @return True if the change succeeded, false if it didn't
896 bool ChangeIdent(const char* newident);
898 /** Change a users realname field.
899 * ALWAYS use this function, rather than writing User::fullname directly,
900 * as this triggers module events allowing the change to be syncronized to
902 * @param gecos The user's new realname
903 * @return True if the change succeeded, false if otherwise
905 bool ChangeName(const char* gecos);
907 /** Send a command to all local users from this user
908 * The command given must be able to send text with the
909 * first parameter as a servermask (e.g. $*), so basically
910 * you should use PRIVMSG or NOTICE.
911 * @param command the command to send
912 * @param text The text format string to send
913 * @param ... Format arguments
915 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
917 /** Compile a channel list for this user, and send it to the user 'source'
918 * Used internally by WHOIS
919 * @param The user to send the channel list to if it is not too long
920 * @return This user's channel list
922 std::string ChannelList(User* source);
924 /** Split the channel list in cl which came from dest, and spool it to this user
925 * Used internally by WHOIS
926 * @param dest The user the original channel list came from
927 * @param cl The channel list as a string obtained from User::ChannelList()
929 void SplitChanList(User* dest, const std::string &cl);
931 /** Remove this user from all channels they are on, and delete any that are now empty.
932 * This is used by QUIT, and will not send part messages!
934 void PurgeEmptyChannels();
936 /** Get the connect class which this user belongs to.
937 * @return A pointer to this user's connect class
939 ConnectClass *GetClass();
941 /** Set the connect class to which this user belongs to.
942 * @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.
943 * @return A reference to this user's current connect class.
945 ConnectClass *SetClass(const std::string &explicit_name = "");
947 /** Show the message of the day to this user
951 /** Show the server RULES file to this user
955 /** Set oper-specific quit message shown to opers only when the user quits
956 * (overrides any sent by QuitUser)
958 void SetOperQuit(const std::string &oquit);
960 /** Get oper-specific quit message shown only to opers when the user quits.
961 * (overrides any sent by QuitUser)
963 const std::string& GetOperQuit();
965 /** Increases a user's command penalty by a set amount.
967 void IncreasePenalty(int increase);
969 /** Decreases a user's command penalty by a set amount.
971 void DecreasePenalty(int decrease);
973 /** Handle socket event.
974 * From EventHandler class.
975 * @param et Event type
976 * @param errornum Error number for EVENT_ERROR events
978 void HandleEvent(EventType et, int errornum = 0);
980 /** Default destructor
985 /** Derived from Resolver, and performs user forward/reverse lookups.
987 class CoreExport UserResolver : public Resolver
990 /** User this class is 'attached' to.
993 /** File descriptor teh lookup is bound to
996 /** True if the lookup is forward, false if is a reverse lookup
1000 /** Create a resolver.
1001 * @param Instance The creating instance
1002 * @param user The user to begin lookup on
1003 * @param to_resolve The IP or host to resolve
1004 * @param qt The query type
1005 * @param cache Modified by the constructor if the result was cached
1007 UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
1009 /** Called on successful lookup
1010 * @param result Result string
1011 * @param ttl Time to live for result
1012 * @param cached True if the result was found in the cache
1014 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
1016 /** Called on failed lookup
1017 * @param e Error code
1018 * @param errormessage Error message string
1020 void OnError(ResolverError e, const std::string &errormessage);
1023 /* Configuration callbacks */
1024 //class ServerConfig;