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 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
61 struct CoreExport ConnectClass : public refcountbase
63 reference<ConfigTag> config;
64 /** Type of line, either CC_ALLOW or CC_DENY
68 /** Connect class name
72 /** Max time to register the connection in seconds
74 unsigned int registration_timeout;
76 /** Host mask for this line
80 /** Number of seconds between pings for this line
82 unsigned int pingtime;
84 /** (Optional) Password for this line
88 /** (Optional) Hash Method for this line
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 long penaltythreshold;
110 /** Local max when connecting by this connection class
112 unsigned long maxlocal;
114 /** Global max when connecting by this connection class
116 unsigned long maxglobal;
118 /** Max channels for this class
120 unsigned int maxchans;
122 /** Port number this connect class applies to
126 /** How many users may be in this connect class before they are refused?
127 * (0 = no limit = default)
131 /** Create a new connect class with no settings.
133 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
134 /** Create a new connect class with inherited settings.
136 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
138 /** Update the settings in this block to match the given block */
139 void Update(const ConnectClass* newSettings);
142 const std::string& GetName() { return name; }
143 const std::string& GetPass() { return pass; }
144 const std::string& GetHost() { return host; }
145 const int GetPort() { return port; }
147 /** Returns the registration timeout
149 time_t GetRegTimeout()
151 return (registration_timeout ? registration_timeout : 90);
154 /** Returns the ping frequency
156 unsigned int GetPingTime()
158 return (pingtime ? pingtime : 120);
161 /** Returns the maximum sendq value (soft limit)
162 * Note that this is in addition to internal OS buffers
164 unsigned long GetSendqSoftMax()
166 return (softsendqmax ? softsendqmax : 4096);
169 /** Returns the maximum sendq value (hard limit)
171 unsigned long GetSendqHardMax()
173 return (hardsendqmax ? hardsendqmax : 0x100000);
176 /** Returns the maximum recvq value
178 unsigned long GetRecvqMax()
180 return (recvqmax ? recvqmax : 4096);
183 /** Returns the penalty threshold value
185 unsigned long GetPenaltyThreshold()
187 return penaltythreshold;
190 /** Returusn the maximum number of local sessions
192 unsigned long GetMaxLocal()
197 /** Returns the maximum number of global sessions
199 unsigned long GetMaxGlobal()
205 /** Holds all information about a user
206 * This class stores all information about a user connected to the irc server. Everything about a
207 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
208 * user's nickname and hostname.
210 class CoreExport User : public StreamSocket
213 /** Cached nick!ident@dhost value using the displayed hostname
215 std::string cached_fullhost;
217 /** Cached ident@ip value using the real IP address
219 std::string cached_hostip;
221 /** Cached ident@realhost value using the real hostname
223 std::string cached_makehost;
225 /** Cached nick!ident@realhost value using the real hostname
227 std::string cached_fullrealhost;
229 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
231 std::string cachedip;
233 /** When we erase the user (in the destructor),
234 * we call this method to subtract one from all
235 * mode characters this user is making use of.
237 void DecrementModes();
240 /** Hostname of connection.
241 * This should be valid as per RFC1035.
245 /** Time that the object was instantiated (used for TS calculation etc)
249 /** Time the connection was created, set in the constructor. This
250 * may be different from the time the user's classbase object was
255 /** Time that the connection last sent a message, used to calculate idle time
259 /** Client address that the user is connected from.
260 * Do not modify this value directly, use SetClientIP() to change it.
261 * Port is not valid for remote users.
263 irc::sockets::sockaddrs client_sa;
265 /** The users nickname.
266 * An invalid nickname indicates an unregistered connection prior to the NICK command.
267 * Use InspIRCd::IsNick() to validate nicknames.
271 /** The user's unique identifier.
272 * This is the unique identifier which the user has across the network.
274 const std::string uuid;
276 /** The users ident reply.
277 * Two characters are added to the user-defined limit to compensate for the tilde etc.
281 /** The host displayed to non-opers (used for cloaking etc).
282 * This usually matches the value of User::host.
286 /** The users full name (GECOS).
288 std::string fullname;
290 /** The user's mode list.
291 * NOT a null terminated string.
293 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
294 * if (modes[modeletter-65]) is set, then the mode is
295 * set, for example, to work out if mode +s is set, we check the field
296 * User::modes['s'-65] != 0.
297 * The following RFC characters o, w, s, i have constants defined via an
298 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
300 std::bitset<64> modes;
302 /** What snomasks are set on this user.
303 * This functions the same as the above modes.
305 std::bitset<64> snomasks;
307 /** Channels this user is on
311 /** The server the user is connected to.
313 const std::string server;
315 /** The user's away message.
316 * If this string is empty, the user is not marked as away.
320 /** Time the user last went away.
321 * This is ONLY RELIABLE if user IS_AWAY()!
325 /** The oper type they logged in as, if they are an oper.
327 reference<OperInfo> oper;
329 /** Used by User to indicate the registration status of the connection
330 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
331 * the connection state.
333 unsigned int registered:3;
335 /** True when DNS lookups are completed.
336 * The UserResolver classes res_forward and res_reverse will
337 * set this value once they complete.
339 unsigned int dns_done:1;
341 /** Whether or not to send an snotice about this user's quitting
343 unsigned int quietquit:1;
345 /** If this is set to true, then all socket operations for the user
346 * are dropped into the bit-bucket.
347 * This value is set by QuitUser, and is not needed seperately from that call.
348 * Please note that setting this value alone will NOT cause the user to quit.
350 unsigned int quitting:1;
352 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
354 unsigned int exempt:1;
356 /** has the user responded to their previous ping?
358 unsigned int lastping:1;
360 /** Get client IP string from sockaddr, using static internal buffer
361 * @return The IP string
363 const char* GetIPString();
365 /** Get CIDR mask, using default range, for this user
367 irc::sockets::cidr_mask GetCIDRMask();
369 /** Sets the client IP for this user
370 * @return true if the conversion was successful
372 bool SetClientIP(const char* sip);
374 /** Default constructor
375 * @throw CoreException if the UID allocated to the user already exists
376 * @param Instance Creator instance
377 * @param uid User UUID, or empty to allocate one automatically
378 * @param srv Server that this user is from
380 User(const std::string &uid, const std::string& srv);
382 /** Check if the user matches a G or K line, and disconnect them if they do.
383 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
384 * Returns true if the user matched a ban, false else.
386 bool CheckLines(bool doZline = false);
388 /** Returns the full displayed host of the user
389 * This member function returns the hostname of the user as seen by other users
390 * on the server, in nick!ident&at;host form.
391 * @return The full masked host of the user
393 virtual const std::string& GetFullHost();
395 /** Returns the full real host of the user
396 * This member function returns the hostname of the user as seen by other users
397 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
398 * e.g. through a module, then this method will ignore it and return the true hostname.
399 * @return The full real host of the user
401 virtual const std::string& GetFullRealHost();
403 /** This clears any cached results that are used for GetFullRealHost() etc.
404 * The results of these calls are cached as generating them can be generally expensive.
406 void InvalidateCache();
408 /** Create a displayable mode string for this users snomasks
409 * @return The notice mask character sequence
411 const char* FormatNoticeMasks();
413 /** Process a snomask modifier string, e.g. +abc-de
414 * @param sm A sequence of notice mask characters
415 * @return The cleaned mode sequence which can be output,
416 * e.g. in the above example if masks c and e are not
417 * valid, this function will return +ab-d
419 std::string ProcessNoticeMasks(const char *sm);
421 /** Returns true if a notice mask is set
422 * @param sm A notice mask character to check
423 * @return True if the notice mask is set
425 bool IsNoticeMaskSet(unsigned char sm);
427 /** Changed a specific notice mask value
428 * @param sm The server notice mask to change
429 * @param value An on/off value for this mask
431 void SetNoticeMask(unsigned char sm, bool value);
433 /** Create a displayable mode string for this users umodes
434 * @param The mode string
436 const char* FormatModes(bool showparameters = false);
438 /** Returns true if a specific mode is set
439 * @param m The user mode
440 * @return True if the mode is set
442 bool IsModeSet(unsigned char m);
444 /** Set a specific usermode to on or off
445 * @param m The user mode
446 * @param value On or off setting of the mode
448 void SetMode(unsigned char m, bool value);
450 /** Returns true or false for if a user can execute a privilaged oper command.
451 * This is done by looking up their oper type from User::oper, then referencing
452 * this to their oper classes and checking the commands they can execute.
453 * @param command A command (should be all CAPS)
454 * @return True if this user can execute the command
456 virtual bool HasPermission(const std::string &command);
458 /** Returns true if a user has a given permission.
459 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
460 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
462 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
463 * @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.
464 * @return True if this user has the permission in question.
466 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
468 /** Returns true or false if a user can set a privileged user or channel mode.
469 * This is done by looking up their oper type from User::oper, then referencing
470 * this to their oper classes, and checking the modes they can set.
471 * @param mode The mode the check
472 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
473 * @return True if the user can set or unset this mode.
475 virtual bool HasModePermission(unsigned char mode, ModeType type);
477 /** Creates a wildcard host.
478 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
479 * @return The wildcarded hostname in *!*@host form
481 char* MakeWildHost();
483 /** Creates a usermask with real host.
484 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
485 * @return the usermask in the format user@host
487 const std::string& MakeHost();
489 /** Creates a usermask with real ip.
490 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
491 * @return the usermask in the format user@ip
493 const std::string& MakeHostIP();
495 /** Add the user to WHOWAS system
499 /** Oper up the user using the given opertype.
500 * This will also give the +o usermode.
502 void Oper(OperInfo* info);
504 /** Change this users hash key to a new string.
505 * You should not call this function directly. It is used by the core
506 * to update the users hash entry on a nickchange.
507 * @param New new user_hash key
508 * @return Pointer to User in hash (usually 'this')
510 User* UpdateNickHash(const char* New);
512 /** Force a nickname change.
513 * If the nickname change fails (for example, because the nick in question
514 * already exists) this function will return false, and you must then either
515 * output an error message, or quit the user for nickname collision.
516 * @param newnick The nickname to change to
517 * @return True if the nickchange was successful.
519 bool ForceNickChange(const char* newnick);
522 * This will clear the +o usermode and unset the user's oper type
526 /** Write text to this user, appending CR/LF. Works on local users only.
527 * @param text A std::string to send to the user
529 virtual void Write(const std::string &text);
531 /** Write text to this user, appending CR/LF.
532 * Works on local users only.
533 * @param text The format string for text to send to the user
534 * @param ... POD-type format arguments
536 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
538 /** Write text to this user, appending CR/LF and prepending :server.name
539 * Works on local users only.
540 * @param text A std::string to send to the user
542 void WriteServ(const std::string& text);
544 /** Write text to this user, appending CR/LF and prepending :server.name
545 * Works on local users only.
546 * @param text The format string for text to send to the user
547 * @param ... POD-type format arguments
549 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
551 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
553 void WriteNumeric(unsigned int numeric, const std::string &text);
555 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
556 * @param user The user to prepend the :nick!user@host of
557 * @param text A std::string to send to the user
559 void WriteFrom(User *user, const std::string &text);
561 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
562 * @param user The user to prepend the :nick!user@host of
563 * @param text The format string for text to send to the user
564 * @param ... POD-type format arguments
566 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
568 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
569 * @param dest The user to route the message to
570 * @param text A std::string to send to the user
572 void WriteTo(User *dest, const std::string &data);
574 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
575 * @param dest The user to route the message to
576 * @param text The format string for text to send to the user
577 * @param ... POD-type format arguments
579 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
581 /** Write to all users that can see this user (including this user in the list), appending CR/LF
582 * @param text A std::string to send to the users
584 void WriteCommonRaw(const std::string &line, bool include_self = true);
586 /** Write to all users that can see this user (including this user in the list), appending CR/LF
587 * @param text The format string for text to send to the users
588 * @param ... POD-type format arguments
590 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
592 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
593 * @param text The format string for text to send to the users
594 * @param ... POD-type format arguments
596 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
598 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
599 * quit message for opers only.
600 * @param normal_text Normal user quit message
601 * @param oper_text Oper only quit message
603 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
605 /** Dump text to a user target, splitting it appropriately to fit
606 * @param LinePrefix text to prefix each complete line with
607 * @param TextStream the text to send to the user
609 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
611 /** Write to the user, routing the line if the user is remote.
613 virtual void SendText(const std::string& line) = 0;
615 /** Write to the user, routing the line if the user is remote.
617 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
619 /** Return true if the user shares at least one channel with another user
620 * @param other The other user to compare the channel list against
621 * @return True if the given user shares at least one channel with this user
623 bool SharesChannelWith(User *other);
625 /** Send fake quit/join messages for host or ident cycle.
626 * Run this after the item in question has changed.
627 * You should not need to use this function, call ChangeDisplayedHost instead
629 * @param The entire QUIT line, including the source using the old value
631 void DoHostCycle(const std::string &quitline);
633 /** Change the displayed host of a user.
634 * ALWAYS use this function, rather than writing User::dhost directly,
635 * as this triggers module events allowing the change to be syncronized to
636 * remote servers. This will also emulate a QUIT and rejoin (where configured)
637 * before setting their host field.
638 * @param host The new hostname to set
639 * @return True if the change succeeded, false if it didn't
641 bool ChangeDisplayedHost(const char* host);
643 /** Change the ident (username) of a user.
644 * ALWAYS use this function, rather than writing User::ident directly,
645 * as this correctly causes the user to seem to quit (where configured)
646 * before setting their ident field.
647 * @param host The new ident to set
648 * @return True if the change succeeded, false if it didn't
650 bool ChangeIdent(const char* newident);
652 /** Change a users realname field.
653 * ALWAYS use this function, rather than writing User::fullname directly,
654 * as this triggers module events allowing the change to be syncronized to
656 * @param gecos The user's new realname
657 * @return True if the change succeeded, false if otherwise
659 bool ChangeName(const char* gecos);
661 /** Send a command to all local users from this user
662 * The command given must be able to send text with the
663 * first parameter as a servermask (e.g. $*), so basically
664 * you should use PRIVMSG or NOTICE.
665 * @param command the command to send
666 * @param text The text format string to send
667 * @param ... Format arguments
669 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
671 /** Compile a channel list for this user. Used internally by WHOIS
672 * @param source The user to prepare the channel list for
673 * @param spy Whether to return the spy channel list rather than the normal one
674 * @return This user's channel list
676 std::string ChannelList(User* source, bool spy);
678 /** Split the channel list in cl which came from dest, and spool it to this user
679 * Used internally by WHOIS
680 * @param dest The user the original channel list came from
681 * @param cl The channel list as a string obtained from User::ChannelList()
683 void SplitChanList(User* dest, const std::string &cl);
685 /** Remove this user from all channels they are on, and delete any that are now empty.
686 * This is used by QUIT, and will not send part messages!
688 void PurgeEmptyChannels();
690 /** Get the connect class which this user belongs to. NULL for remote users.
691 * @return A pointer to this user's connect class.
693 virtual ConnectClass* GetClass();
695 /** Show the message of the day to this user
699 /** Show the server RULES file to this user
703 virtual void OnDataReady();
704 virtual void OnError(BufferedSocketError error);
705 /** Default destructor
708 virtual CullResult cull();
711 /** Represents a non-local user.
712 * (in fact, any FD less than -1 does)
714 #define FD_MAGIC_NUMBER -42
715 /** Represents a fake user (i.e. a server)
717 #define FD_FAKEUSER_NUMBER -7
719 class CoreExport LocalUser : public User
721 /** A list of channels the user has a pending invite to.
722 * Upon INVITE channels are added, and upon JOIN, the
723 * channels are removed from this list.
731 /** Stats counter for bytes inbound
735 /** Stats counter for bytes outbound
739 /** Stats counter for commands inbound
743 /** Stats counter for commands outbound
747 /** Password specified by the user when they registered (if any).
748 * This is stored even if the <connect> block doesnt need a password, so that
749 * modules may check it.
751 std::string password;
753 /** Contains a pointer to the connect class a user is on from
755 reference<ConnectClass> MyClass;
757 ConnectClass* GetClass();
759 /** Call this method to find the matching <connect> for a user, and to check them against it.
763 /** Server address and port that this user is connected to.
765 irc::sockets::sockaddrs server_sa;
768 * @return The port number of this user.
772 /** Used by PING checking code
776 /** This value contains how far into the penalty threshold the user is. Once its over
777 * the penalty threshold then commands are held and processed on-timer.
781 /** Stored reverse lookup from res_forward. Should not be used after resolution.
783 std::string stored_host;
785 /** Starts a DNS lookup of the user's IP.
786 * This will cause two UserResolver classes to be instantiated.
787 * When complete, these objects set User::dns_done to true.
789 void StartDNSLookup();
791 /** Use this method to fully connect a user.
792 * This will send the message of the day, check G/K/E lines, etc.
796 /** Set the connect class to which this user belongs to.
797 * @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.
798 * @return A reference to this user's current connect class.
800 void SetClass(const std::string &explicit_name = "");
803 void SendText(const std::string& line);
804 void Write(const std::string& text);
805 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
807 /** Adds to the user's write buffer.
808 * You may add any amount of text up to this users sendq value, if you exceed the
809 * sendq value, the user will be removed, and further buffer adds will be dropped.
810 * @param data The data to add to the write buffer
812 void AddWriteBuf(const std::string &data);
814 /** Returns the list of channels this user has been invited to but has not yet joined.
815 * @return A list of channels the user is invited to
817 InvitedList* GetInviteList();
819 /** Returns true if a user is invited to a channel.
820 * @param channel A channel name to look up
821 * @return True if the user is invited to the given channel
823 bool IsInvited(const irc::string &channel);
825 /** Adds a channel to a users invite list (invites them to a channel)
826 * @param channel A channel name to add
827 * @param timeout When the invite should expire (0 == never)
829 void InviteTo(const irc::string &channel, time_t timeout);
831 /** Removes a channel from a users invite list.
832 * This member function is called on successfully joining an invite only channel
833 * to which the user has previously been invited, to clear the invitation.
834 * @param channel The channel to remove the invite to
836 void RemoveInvite(const irc::string &channel);
838 /** Returns true or false for if a user can execute a privilaged oper command.
839 * This is done by looking up their oper type from User::oper, then referencing
840 * this to their oper classes and checking the commands they can execute.
841 * @param command A command (should be all CAPS)
842 * @return True if this user can execute the command
844 bool HasPermission(const std::string &command);
846 /** Returns true if a user has a given permission.
847 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
848 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
850 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
851 * @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.
852 * @return True if this user has the permission in question.
854 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
856 /** Returns true or false if a user can set a privileged user or channel mode.
857 * This is done by looking up their oper type from User::oper, then referencing
858 * this to their oper classes, and checking the modes they can set.
859 * @param mode The mode the check
860 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
861 * @return True if the user can set or unset this mode.
863 bool HasModePermission(unsigned char mode, ModeType type);
866 class CoreExport RemoteUser : public User
869 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv)
871 SetFd(FD_MAGIC_NUMBER);
873 virtual void SendText(const std::string& line);
876 class CoreExport FakeUser : public User
879 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv)
881 SetFd(FD_FAKEUSER_NUMBER);
885 virtual CullResult cull();
886 virtual void SendText(const std::string& line);
887 virtual const std::string& GetFullHost();
888 virtual const std::string& GetFullRealHost();
891 /* Faster than dynamic_cast */
892 /** Is a local user */
893 inline LocalUser* IS_LOCAL(User* u)
895 return u->GetFd() > -1 ? static_cast<LocalUser*>(u) : NULL;
897 /** Is a remote user */
898 inline RemoteUser* IS_REMOTE(User* u)
900 return u->GetFd() == FD_MAGIC_NUMBER ? static_cast<RemoteUser*>(u) : NULL;
902 /** Is a server fakeuser */
903 inline FakeUser* IS_SERVER(User* u)
905 return u->GetFd() == FD_FAKEUSER_NUMBER ? static_cast<FakeUser*>(u) : NULL;
908 #define IS_OPER(x) (x->oper)
910 #define IS_AWAY(x) (!x->awaymsg.empty())
912 /** Derived from Resolver, and performs user forward/reverse lookups.
914 class CoreExport UserResolver : public Resolver
917 /** User this class is 'attached' to.
919 LocalUser* bound_user;
920 /** File descriptor teh lookup is bound to
923 /** True if the lookup is forward, false if is a reverse lookup
927 /** Create a resolver.
928 * @param Instance The creating instance
929 * @param user The user to begin lookup on
930 * @param to_resolve The IP or host to resolve
931 * @param qt The query type
932 * @param cache Modified by the constructor if the result was cached
934 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
936 /** Called on successful lookup
937 * @param result Result string
938 * @param ttl Time to live for result
939 * @param cached True if the result was found in the cache
941 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
943 /** Called on failed lookup
944 * @param e Error code
945 * @param errormessage Error message string
947 void OnError(ResolverError e, const std::string &errormessage);