1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 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 */
65 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
67 struct CoreExport ConnectClass : public refcountbase
69 reference<ConfigTag> config;
70 /** Type of line, either CC_ALLOW or CC_DENY
74 /** True if this class uses fake lag to manage flood, false if it kills */
77 /** Connect class name
81 /** Max time to register the connection in seconds
83 unsigned int registration_timeout;
85 /** Host mask for this line
89 /** Number of seconds between pings for this line
91 unsigned int pingtime;
93 /** (Optional) Password for this line
97 /** (Optional) Hash Method for this line
101 /** Maximum size of sendq for users in this class (bytes)
102 * Users cannot send commands if they go over this limit
104 unsigned long softsendqmax;
106 /** Maximum size of sendq for users in this class (bytes)
107 * Users are killed if they go over this limit
109 unsigned long hardsendqmax;
111 /** Maximum size of recvq for users in this class (bytes)
113 unsigned long recvqmax;
115 /** Seconds worth of penalty before penalty system activates
117 unsigned int penaltythreshold;
119 /** Maximum rate of commands (units: millicommands per second) */
120 unsigned int commandrate;
122 /** Local max when connecting by this connection class
124 unsigned long maxlocal;
126 /** Global max when connecting by this connection class
128 unsigned long maxglobal;
130 /** Max channels for this class
132 unsigned int maxchans;
134 /** Port number this connect class applies to
138 /** How many users may be in this connect class before they are refused?
139 * (0 = no limit = default)
143 /** Create a new connect class with no settings.
145 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
146 /** Create a new connect class with inherited settings.
148 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
150 /** Update the settings in this block to match the given block */
151 void Update(const ConnectClass* newSettings);
154 const std::string& GetName() { return name; }
155 const std::string& GetPass() { return pass; }
156 const std::string& GetHost() { return host; }
157 const int GetPort() { return port; }
159 /** Returns the registration timeout
161 time_t GetRegTimeout()
163 return (registration_timeout ? registration_timeout : 90);
166 /** Returns the ping frequency
168 unsigned int GetPingTime()
170 return (pingtime ? pingtime : 120);
173 /** Returns the maximum sendq value (soft limit)
174 * Note that this is in addition to internal OS buffers
176 unsigned long GetSendqSoftMax()
178 return (softsendqmax ? softsendqmax : 4096);
181 /** Returns the maximum sendq value (hard limit)
183 unsigned long GetSendqHardMax()
185 return (hardsendqmax ? hardsendqmax : 0x100000);
188 /** Returns the maximum recvq value
190 unsigned long GetRecvqMax()
192 return (recvqmax ? recvqmax : 4096);
195 /** Returns the penalty threshold value
197 unsigned int GetPenaltyThreshold()
199 return (penaltythreshold ? penaltythreshold : 10);
202 unsigned int GetCommandRate()
204 return commandrate ? commandrate : 1000;
207 /** Returusn the maximum number of local sessions
209 unsigned long GetMaxLocal()
214 /** Returns the maximum number of global sessions
216 unsigned long GetMaxGlobal()
222 /** Holds all information about a user
223 * This class stores all information about a user connected to the irc server. Everything about a
224 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
225 * user's nickname and hostname.
227 class CoreExport User : public Extensible
230 /** Cached nick!ident@dhost value using the displayed hostname
232 std::string cached_fullhost;
234 /** Cached ident@ip value using the real IP address
236 std::string cached_hostip;
238 /** Cached ident@realhost value using the real hostname
240 std::string cached_makehost;
242 /** Cached nick!ident@realhost value using the real hostname
244 std::string cached_fullrealhost;
246 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
248 std::string cachedip;
252 /** Hostname of connection.
253 * This should be valid as per RFC1035.
257 /** Time that the object was instantiated (used for TS calculation etc)
261 /** Time the connection was created, set in the constructor. This
262 * may be different from the time the user's classbase object was
267 /** Time that the connection last sent a message, used to calculate idle time
271 /** Client address that the user is connected from.
272 * Do not modify this value directly, use SetClientIP() to change it.
273 * Port is not valid for remote users.
275 irc::sockets::sockaddrs client_sa;
277 /** The users nickname.
278 * An invalid nickname indicates an unregistered connection prior to the NICK command.
279 * Use InspIRCd::IsNick() to validate nicknames.
283 /** The user's unique identifier.
284 * This is the unique identifier which the user has across the network.
286 const std::string uuid;
288 /** The users ident reply.
289 * Two characters are added to the user-defined limit to compensate for the tilde etc.
293 /** The host displayed to non-opers (used for cloaking etc).
294 * This usually matches the value of User::host.
298 /** The users full name (GECOS).
300 std::string fullname;
302 /** The user's mode list.
303 * NOT a null terminated string.
305 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
306 * if (modes[modeletter-65]) is set, then the mode is
307 * set, for example, to work out if mode +s is set, we check the field
308 * User::modes['s'-65] != 0.
309 * The following RFC characters o, w, s, i have constants defined via an
310 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
312 std::bitset<64> modes;
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.
325 const std::string server;
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 IS_AWAY()!
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 /** True when DNS lookups are completed.
348 * The UserResolver classes res_forward and res_reverse will
349 * set this value once they complete.
351 unsigned int dns_done:1;
353 /** Whether or not to send an snotice about this user's quitting
355 unsigned int quietquit:1;
357 /** If this is set to true, then all socket operations for the user
358 * are dropped into the bit-bucket.
359 * This value is set by QuitUser, and is not needed seperately from that call.
360 * Please note that setting this value alone will NOT cause the user to quit.
362 unsigned int quitting:1;
364 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
366 unsigned int exempt:1;
368 /** has the user responded to their previous ping?
370 unsigned int lastping:1;
372 /** What type of user is this? */
373 const unsigned int usertype:2;
375 /** Get client IP string from sockaddr, using static internal buffer
376 * @return The IP string
378 const char* GetIPString();
380 /** Get CIDR mask, using default range, for this user
382 irc::sockets::cidr_mask GetCIDRMask();
384 /** Sets the client IP for this user
385 * @return true if the conversion was successful
387 bool SetClientIP(const char* sip);
390 * @throw CoreException if the UID allocated to the user already exists
392 User(const std::string &uid, const std::string& srv, int objtype);
394 /** Check if the user matches a G or K line, and disconnect them if they do.
395 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
396 * Returns true if the user matched a ban, false else.
398 bool CheckLines(bool doZline = false);
400 /** Returns the full displayed host of the user
401 * This member function returns the hostname of the user as seen by other users
402 * on the server, in nick!ident&at;host form.
403 * @return The full masked host of the user
405 virtual const std::string& GetFullHost();
407 /** Returns the full real host of the user
408 * This member function returns the hostname of the user as seen by other users
409 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
410 * e.g. through a module, then this method will ignore it and return the true hostname.
411 * @return The full real host of the user
413 virtual const std::string& GetFullRealHost();
415 /** This clears any cached results that are used for GetFullRealHost() etc.
416 * The results of these calls are cached as generating them can be generally expensive.
418 void InvalidateCache();
420 /** Create a displayable mode string for this users snomasks
421 * @return The notice mask character sequence
423 const char* FormatNoticeMasks();
425 /** Process a snomask modifier string, e.g. +abc-de
426 * @param sm A sequence of notice mask characters
427 * @return The cleaned mode sequence which can be output,
428 * e.g. in the above example if masks c and e are not
429 * valid, this function will return +ab-d
431 std::string ProcessNoticeMasks(const char *sm);
433 /** Returns true if a notice mask is set
434 * @param sm A notice mask character to check
435 * @return True if the notice mask is set
437 bool IsNoticeMaskSet(unsigned char sm);
439 /** Changed a specific notice mask value
440 * @param sm The server notice mask to change
441 * @param value An on/off value for this mask
443 void SetNoticeMask(unsigned char sm, bool value);
445 /** Create a displayable mode string for this users umodes
446 * @param The mode string
448 const char* FormatModes(bool showparameters = false);
450 /** Returns true if a specific mode is set
451 * @param m The user mode
452 * @return True if the mode is set
454 bool IsModeSet(unsigned char m);
456 /** Set a specific usermode to on or off
457 * @param m The user mode
458 * @param value On or off setting of the mode
460 void SetMode(unsigned char m, bool value);
462 /** Returns true or false for if a user can execute a privilaged oper command.
463 * This is done by looking up their oper type from User::oper, then referencing
464 * this to their oper classes and checking the commands they can execute.
465 * @param command A command (should be all CAPS)
466 * @return True if this user can execute the command
468 virtual bool HasPermission(const std::string &command);
470 /** Returns true if a user has a given permission.
471 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
472 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
474 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
475 * @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.
476 * @return True if this user has the permission in question.
478 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
480 /** Returns true or false if a user can set a privileged user or channel mode.
481 * This is done by looking up their oper type from User::oper, then referencing
482 * this to their oper classes, and checking the modes they can set.
483 * @param mode The mode the check
484 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
485 * @return True if the user can set or unset this mode.
487 virtual bool HasModePermission(unsigned char mode, ModeType type);
489 /** Creates a wildcard host.
490 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
491 * @return The wildcarded hostname in *!*@host form
493 char* MakeWildHost();
495 /** Creates a usermask with real host.
496 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
497 * @return the usermask in the format user@host
499 const std::string& MakeHost();
501 /** Creates a usermask with real ip.
502 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
503 * @return the usermask in the format user@ip
505 const std::string& MakeHostIP();
507 /** Add the user to WHOWAS system
511 /** Oper up the user using the given opertype.
512 * This will also give the +o usermode.
514 void Oper(OperInfo* info);
516 /** Change this users hash key to a new string.
517 * You should not call this function directly. It is used by the core
518 * to update the users hash entry on a nickchange.
519 * @param New new user_hash key
520 * @return Pointer to User in hash (usually 'this')
522 User* UpdateNickHash(const char* New);
524 /** Force a nickname change.
525 * If the nickname change fails (for example, because the nick in question
526 * already exists) this function will return false, and you must then either
527 * output an error message, or quit the user for nickname collision.
528 * @param newnick The nickname to change to
529 * @return True if the nickchange was successful.
531 bool ForceNickChange(const char* newnick);
534 * This will clear the +o usermode and unset the user's oper type
538 /** Write text to this user, appending CR/LF. Works on local users only.
539 * @param text A std::string to send to the user
541 virtual void Write(const std::string &text);
543 /** Write text to this user, appending CR/LF.
544 * Works on local users only.
545 * @param text The format string for text to send to the user
546 * @param ... POD-type format arguments
548 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
550 /** Write text to this user, appending CR/LF and prepending :server.name
551 * Works on local users only.
552 * @param text A std::string to send to the user
554 void WriteServ(const std::string& text);
556 /** Write text to this user, appending CR/LF and prepending :server.name
557 * Works on local users only.
558 * @param text The format string for text to send to the user
559 * @param ... POD-type format arguments
561 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
563 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
565 void WriteNumeric(unsigned int numeric, const std::string &text);
567 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
568 * @param user The user to prepend the :nick!user@host of
569 * @param text A std::string to send to the user
571 void WriteFrom(User *user, const std::string &text);
573 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
574 * @param user The user to prepend the :nick!user@host of
575 * @param text The format string for text to send to the user
576 * @param ... POD-type format arguments
578 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
580 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
581 * @param dest The user to route the message to
582 * @param text A std::string to send to the user
584 void WriteTo(User *dest, const std::string &data);
586 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
587 * @param dest The user to route the message to
588 * @param text The format string for text to send to the user
589 * @param ... POD-type format arguments
591 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
593 /** Write to all users that can see this user (including this user in the list), appending CR/LF
594 * @param text A std::string to send to the users
596 void WriteCommonRaw(const std::string &line, bool include_self = true);
598 /** Write to all users that can see this user (including this user in the list), appending CR/LF
599 * @param text The format string for text to send to the users
600 * @param ... POD-type format arguments
602 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
604 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
605 * @param text The format string for text to send to the users
606 * @param ... POD-type format arguments
608 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
610 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
611 * quit message for opers only.
612 * @param normal_text Normal user quit message
613 * @param oper_text Oper only quit message
615 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
617 /** Dump text to a user target, splitting it appropriately to fit
618 * @param LinePrefix text to prefix each complete line with
619 * @param TextStream the text to send to the user
621 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
623 /** Write to the user, routing the line if the user is remote.
625 virtual void SendText(const std::string& line) = 0;
627 /** Write to the user, routing the line if the user is remote.
629 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
631 /** Return true if the user shares at least one channel with another user
632 * @param other The other user to compare the channel list against
633 * @return True if the given user shares at least one channel with this user
635 bool SharesChannelWith(User *other);
637 /** Send fake quit/join messages for host or ident cycle.
638 * Run this after the item in question has changed.
639 * You should not need to use this function, call ChangeDisplayedHost instead
641 * @param The entire QUIT line, including the source using the old value
643 void DoHostCycle(const std::string &quitline);
645 /** Change the displayed host of a user.
646 * ALWAYS use this function, rather than writing User::dhost directly,
647 * as this triggers module events allowing the change to be syncronized to
648 * remote servers. This will also emulate a QUIT and rejoin (where configured)
649 * before setting their host field.
650 * @param host The new hostname to set
651 * @return True if the change succeeded, false if it didn't
653 bool ChangeDisplayedHost(const char* host);
655 /** Change the ident (username) of a user.
656 * ALWAYS use this function, rather than writing User::ident directly,
657 * as this correctly causes the user to seem to quit (where configured)
658 * before setting their ident field.
659 * @param host The new ident to set
660 * @return True if the change succeeded, false if it didn't
662 bool ChangeIdent(const char* newident);
664 /** Change a users realname field.
665 * ALWAYS use this function, rather than writing User::fullname directly,
666 * as this triggers module events allowing the change to be syncronized to
668 * @param gecos The user's new realname
669 * @return True if the change succeeded, false if otherwise
671 bool ChangeName(const char* gecos);
673 /** Send a command to all local users from this user
674 * The command given must be able to send text with the
675 * first parameter as a servermask (e.g. $*), so basically
676 * you should use PRIVMSG or NOTICE.
677 * @param command the command to send
678 * @param text The text format string to send
679 * @param ... Format arguments
681 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
683 /** Compile a channel list for this user. Used internally by WHOIS
684 * @param source The user to prepare the channel list for
685 * @param spy Whether to return the spy channel list rather than the normal one
686 * @return This user's channel list
688 std::string ChannelList(User* source, bool spy);
690 /** Split the channel list in cl which came from dest, and spool it to this user
691 * Used internally by WHOIS
692 * @param dest The user the original channel list came from
693 * @param cl The channel list as a string obtained from User::ChannelList()
695 void SplitChanList(User* dest, const std::string &cl);
697 /** Remove this user from all channels they are on, and delete any that are now empty.
698 * This is used by QUIT, and will not send part messages!
700 void PurgeEmptyChannels();
702 /** Get the connect class which this user belongs to. NULL for remote users.
703 * @return A pointer to this user's connect class.
705 virtual ConnectClass* GetClass();
707 /** Default destructor
710 virtual CullResult cull();
713 class CoreExport UserIOHandler : public StreamSocket
716 LocalUser* const user;
717 UserIOHandler(LocalUser* me) : user(me) {}
719 void OnError(BufferedSocketError error);
721 /** Adds to the user's write buffer.
722 * You may add any amount of text up to this users sendq value, if you exceed the
723 * sendq value, the user will be removed, and further buffer adds will be dropped.
724 * @param data The data to add to the write buffer
726 void AddWriteBuf(const std::string &data);
729 class CoreExport LocalUser : public User
731 /** A list of channels the user has a pending invite to.
732 * Upon INVITE channels are added, and upon JOIN, the
733 * channels are removed from this list.
738 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
743 /** Stats counter for bytes inbound
747 /** Stats counter for bytes outbound
751 /** Stats counter for commands inbound
755 /** Stats counter for commands outbound
759 /** Password specified by the user when they registered (if any).
760 * This is stored even if the <connect> block doesnt need a password, so that
761 * modules may check it.
763 std::string password;
765 /** Contains a pointer to the connect class a user is on from
767 reference<ConnectClass> MyClass;
769 ConnectClass* GetClass();
771 /** Call this method to find the matching <connect> for a user, and to check them against it.
775 /** Server address and port that this user is connected to.
777 irc::sockets::sockaddrs server_sa;
780 * @return The port number of this user.
784 /** Used by PING checking code
788 /** This value contains how far into the penalty threshold the user is.
789 * This is used either to enable fake lag or for excess flood quits
791 unsigned int CommandFloodPenalty;
793 /** Stored reverse lookup from res_forward. Should not be used after resolution.
795 std::string stored_host;
797 /** Starts a DNS lookup of the user's IP.
798 * This will cause two UserResolver classes to be instantiated.
799 * When complete, these objects set User::dns_done to true.
801 void StartDNSLookup();
803 /** Use this method to fully connect a user.
804 * This will send the message of the day, check G/K/E lines, etc.
808 /** Set the connect class to which this user belongs to.
809 * @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.
810 * @return A reference to this user's current connect class.
812 void SetClass(const std::string &explicit_name = "");
814 void SendText(const std::string& line);
815 void Write(const std::string& text);
816 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
818 /** Returns the list of channels this user has been invited to but has not yet joined.
819 * @return A list of channels the user is invited to
821 InvitedList* GetInviteList();
823 /** Returns true if a user is invited to a channel.
824 * @param channel A channel name to look up
825 * @return True if the user is invited to the given channel
827 bool IsInvited(const irc::string &channel);
829 /** Adds a channel to a users invite list (invites them to a channel)
830 * @param channel A channel name to add
831 * @param timeout When the invite should expire (0 == never)
833 void InviteTo(const irc::string &channel, time_t timeout);
835 /** Removes a channel from a users invite list.
836 * This member function is called on successfully joining an invite only channel
837 * to which the user has previously been invited, to clear the invitation.
838 * @param channel The channel to remove the invite to
840 void RemoveInvite(const irc::string &channel);
842 /** Returns true or false for if a user can execute a privilaged oper command.
843 * This is done by looking up their oper type from User::oper, then referencing
844 * this to their oper classes and checking the commands they can execute.
845 * @param command A command (should be all CAPS)
846 * @return True if this user can execute the command
848 bool HasPermission(const std::string &command);
850 /** Returns true if a user has a given permission.
851 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
852 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
854 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
855 * @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.
856 * @return True if this user has the permission in question.
858 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
860 /** Returns true or false if a user can set a privileged user or channel mode.
861 * This is done by looking up their oper type from User::oper, then referencing
862 * this to their oper classes, and checking the modes they can set.
863 * @param mode The mode the check
864 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
865 * @return True if the user can set or unset this mode.
867 bool HasModePermission(unsigned char mode, ModeType type);
869 inline int GetFd() { return eh.GetFd(); }
872 class CoreExport RemoteUser : public User
875 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
878 virtual void SendText(const std::string& line);
881 class CoreExport FakeUser : public User
884 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
889 virtual CullResult cull();
890 virtual void SendText(const std::string& line);
891 virtual const std::string& GetFullHost();
892 virtual const std::string& GetFullRealHost();
895 /* Faster than dynamic_cast */
896 /** Is a local user */
897 inline LocalUser* IS_LOCAL(User* u)
899 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
901 /** Is a remote user */
902 inline RemoteUser* IS_REMOTE(User* u)
904 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
906 /** Is a server fakeuser */
907 inline FakeUser* IS_SERVER(User* u)
909 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
912 #define IS_OPER(x) (x->oper)
914 #define IS_AWAY(x) (!x->awaymsg.empty())
916 /** Derived from Resolver, and performs user forward/reverse lookups.
918 class CoreExport UserResolver : public Resolver
921 /** User this class is 'attached' to.
923 LocalUser* bound_user;
924 /** File descriptor teh lookup is bound to
927 /** True if the lookup is forward, false if is a reverse lookup
931 /** Create a resolver.
932 * @param Instance The creating instance
933 * @param user The user to begin lookup on
934 * @param to_resolve The IP or host to resolve
935 * @param qt The query type
936 * @param cache Modified by the constructor if the result was cached
938 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
940 /** Called on successful lookup
941 * @param result Result string
942 * @param ttl Time to live for result
943 * @param cached True if the result was found in the cache
945 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
947 /** Called on failed lookup
948 * @param e Error code
949 * @param errormessage Error message string
951 void OnError(ResolverError e, const std::string &errormessage);