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 */
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 /** Connect class name
78 /** Max time to register the connection in seconds
80 unsigned int registration_timeout;
82 /** Host mask for this line
86 /** Number of seconds between pings for this line
88 unsigned int pingtime;
90 /** (Optional) Password for this line
94 /** (Optional) Hash Method for this line
98 /** Maximum size of sendq for users in this class (bytes)
99 * Users cannot send commands if they go over this limit
101 unsigned long softsendqmax;
103 /** Maximum size of sendq for users in this class (bytes)
104 * Users are killed if they go over this limit
106 unsigned long hardsendqmax;
108 /** Maximum size of recvq for users in this class (bytes)
110 unsigned long recvqmax;
112 /** Seconds worth of penalty before penalty system activates
114 unsigned long penaltythreshold;
116 /** Local max when connecting by this connection class
118 unsigned long maxlocal;
120 /** Global max when connecting by this connection class
122 unsigned long maxglobal;
124 /** Max channels for this class
126 unsigned int maxchans;
128 /** Port number this connect class applies to
132 /** How many users may be in this connect class before they are refused?
133 * (0 = no limit = default)
137 /** Create a new connect class with no settings.
139 ConnectClass(ConfigTag* tag, char type, const std::string& mask);
140 /** Create a new connect class with inherited settings.
142 ConnectClass(ConfigTag* tag, char type, const std::string& mask, const ConnectClass& parent);
144 /** Update the settings in this block to match the given block */
145 void Update(const ConnectClass* newSettings);
148 const std::string& GetName() { return name; }
149 const std::string& GetPass() { return pass; }
150 const std::string& GetHost() { return host; }
151 const int GetPort() { return port; }
153 /** Returns the registration timeout
155 time_t GetRegTimeout()
157 return (registration_timeout ? registration_timeout : 90);
160 /** Returns the ping frequency
162 unsigned int GetPingTime()
164 return (pingtime ? pingtime : 120);
167 /** Returns the maximum sendq value (soft limit)
168 * Note that this is in addition to internal OS buffers
170 unsigned long GetSendqSoftMax()
172 return (softsendqmax ? softsendqmax : 4096);
175 /** Returns the maximum sendq value (hard limit)
177 unsigned long GetSendqHardMax()
179 return (hardsendqmax ? hardsendqmax : 0x100000);
182 /** Returns the maximum recvq value
184 unsigned long GetRecvqMax()
186 return (recvqmax ? recvqmax : 4096);
189 /** Returns the penalty threshold value
191 unsigned long GetPenaltyThreshold()
193 return penaltythreshold;
196 /** Returusn the maximum number of local sessions
198 unsigned long GetMaxLocal()
203 /** Returns the maximum number of global sessions
205 unsigned long GetMaxGlobal()
211 /** Holds all information about a user
212 * This class stores all information about a user connected to the irc server. Everything about a
213 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
214 * user's nickname and hostname.
216 class CoreExport User : public StreamSocket
219 /** Cached nick!ident@dhost value using the displayed hostname
221 std::string cached_fullhost;
223 /** Cached ident@ip value using the real IP address
225 std::string cached_hostip;
227 /** Cached ident@realhost value using the real hostname
229 std::string cached_makehost;
231 /** Cached nick!ident@realhost value using the real hostname
233 std::string cached_fullrealhost;
235 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
237 std::string cachedip;
239 /** When we erase the user (in the destructor),
240 * we call this method to subtract one from all
241 * mode characters this user is making use of.
243 void DecrementModes();
246 /** Hostname of connection.
247 * This should be valid as per RFC1035.
251 /** Time that the object was instantiated (used for TS calculation etc)
255 /** Time the connection was created, set in the constructor. This
256 * may be different from the time the user's classbase object was
261 /** Time that the connection last sent a message, used to calculate idle time
265 /** Client address that the user is connected from.
266 * Do not modify this value directly, use SetClientIP() to change it.
267 * Port is not valid for remote users.
269 irc::sockets::sockaddrs client_sa;
271 /** The users nickname.
272 * An invalid nickname indicates an unregistered connection prior to the NICK command.
273 * Use InspIRCd::IsNick() to validate nicknames.
277 /** The user's unique identifier.
278 * This is the unique identifier which the user has across the network.
280 const std::string uuid;
282 /** The users ident reply.
283 * Two characters are added to the user-defined limit to compensate for the tilde etc.
287 /** The host displayed to non-opers (used for cloaking etc).
288 * This usually matches the value of User::host.
292 /** The users full name (GECOS).
294 std::string fullname;
296 /** The user's mode list.
297 * NOT a null terminated string.
299 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
300 * if (modes[modeletter-65]) is set, then the mode is
301 * set, for example, to work out if mode +s is set, we check the field
302 * User::modes['s'-65] != 0.
303 * The following RFC characters o, w, s, i have constants defined via an
304 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
306 std::bitset<64> modes;
308 /** What snomasks are set on this user.
309 * This functions the same as the above modes.
311 std::bitset<64> snomasks;
313 /** Channels this user is on
317 /** The server the user is connected to.
319 const std::string server;
321 /** The user's away message.
322 * If this string is empty, the user is not marked as away.
326 /** Time the user last went away.
327 * This is ONLY RELIABLE if user IS_AWAY()!
331 /** The oper type they logged in as, if they are an oper.
333 reference<OperInfo> oper;
335 /** Used by User to indicate the registration status of the connection
336 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
337 * the connection state.
339 unsigned int registered:3;
341 /** True when DNS lookups are completed.
342 * The UserResolver classes res_forward and res_reverse will
343 * set this value once they complete.
345 unsigned int dns_done:1;
347 /** Whether or not to send an snotice about this user's quitting
349 unsigned int quietquit:1;
351 /** If this is set to true, then all socket operations for the user
352 * are dropped into the bit-bucket.
353 * This value is set by QuitUser, and is not needed seperately from that call.
354 * Please note that setting this value alone will NOT cause the user to quit.
356 unsigned int quitting:1;
358 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
360 unsigned int exempt:1;
362 /** has the user responded to their previous ping?
364 unsigned int lastping:1;
366 /** What type of user is this? */
367 const unsigned int usertype:2;
369 /** Get client IP string from sockaddr, using static internal buffer
370 * @return The IP string
372 const char* GetIPString();
374 /** Get CIDR mask, using default range, for this user
376 irc::sockets::cidr_mask GetCIDRMask();
378 /** Sets the client IP for this user
379 * @return true if the conversion was successful
381 bool SetClientIP(const char* sip);
384 * @throw CoreException if the UID allocated to the user already exists
386 User(const std::string &uid, const std::string& srv, int objtype);
388 /** Check if the user matches a G or K line, and disconnect them if they do.
389 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
390 * Returns true if the user matched a ban, false else.
392 bool CheckLines(bool doZline = false);
394 /** Returns the full displayed host of the user
395 * This member function returns the hostname of the user as seen by other users
396 * on the server, in nick!ident&at;host form.
397 * @return The full masked host of the user
399 virtual const std::string& GetFullHost();
401 /** Returns the full real host of the user
402 * This member function returns the hostname of the user as seen by other users
403 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
404 * e.g. through a module, then this method will ignore it and return the true hostname.
405 * @return The full real host of the user
407 virtual const std::string& GetFullRealHost();
409 /** This clears any cached results that are used for GetFullRealHost() etc.
410 * The results of these calls are cached as generating them can be generally expensive.
412 void InvalidateCache();
414 /** Create a displayable mode string for this users snomasks
415 * @return The notice mask character sequence
417 const char* FormatNoticeMasks();
419 /** Process a snomask modifier string, e.g. +abc-de
420 * @param sm A sequence of notice mask characters
421 * @return The cleaned mode sequence which can be output,
422 * e.g. in the above example if masks c and e are not
423 * valid, this function will return +ab-d
425 std::string ProcessNoticeMasks(const char *sm);
427 /** Returns true if a notice mask is set
428 * @param sm A notice mask character to check
429 * @return True if the notice mask is set
431 bool IsNoticeMaskSet(unsigned char sm);
433 /** Changed a specific notice mask value
434 * @param sm The server notice mask to change
435 * @param value An on/off value for this mask
437 void SetNoticeMask(unsigned char sm, bool value);
439 /** Create a displayable mode string for this users umodes
440 * @param The mode string
442 const char* FormatModes(bool showparameters = false);
444 /** Returns true if a specific mode is set
445 * @param m The user mode
446 * @return True if the mode is set
448 bool IsModeSet(unsigned char m);
450 /** Set a specific usermode to on or off
451 * @param m The user mode
452 * @param value On or off setting of the mode
454 void SetMode(unsigned char m, bool value);
456 /** Returns true or false for if a user can execute a privilaged oper command.
457 * This is done by looking up their oper type from User::oper, then referencing
458 * this to their oper classes and checking the commands they can execute.
459 * @param command A command (should be all CAPS)
460 * @return True if this user can execute the command
462 virtual bool HasPermission(const std::string &command);
464 /** Returns true if a user has a given permission.
465 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
466 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
468 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
469 * @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.
470 * @return True if this user has the permission in question.
472 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
474 /** Returns true or false if a user can set a privileged user or channel mode.
475 * This is done by looking up their oper type from User::oper, then referencing
476 * this to their oper classes, and checking the modes they can set.
477 * @param mode The mode the check
478 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
479 * @return True if the user can set or unset this mode.
481 virtual bool HasModePermission(unsigned char mode, ModeType type);
483 /** Creates a wildcard host.
484 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
485 * @return The wildcarded hostname in *!*@host form
487 char* MakeWildHost();
489 /** Creates a usermask with real host.
490 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
491 * @return the usermask in the format user@host
493 const std::string& MakeHost();
495 /** Creates a usermask with real ip.
496 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
497 * @return the usermask in the format user@ip
499 const std::string& MakeHostIP();
501 /** Add the user to WHOWAS system
505 /** Oper up the user using the given opertype.
506 * This will also give the +o usermode.
508 void Oper(OperInfo* info);
510 /** Change this users hash key to a new string.
511 * You should not call this function directly. It is used by the core
512 * to update the users hash entry on a nickchange.
513 * @param New new user_hash key
514 * @return Pointer to User in hash (usually 'this')
516 User* UpdateNickHash(const char* New);
518 /** Force a nickname change.
519 * If the nickname change fails (for example, because the nick in question
520 * already exists) this function will return false, and you must then either
521 * output an error message, or quit the user for nickname collision.
522 * @param newnick The nickname to change to
523 * @return True if the nickchange was successful.
525 bool ForceNickChange(const char* newnick);
528 * This will clear the +o usermode and unset the user's oper type
532 /** Write text to this user, appending CR/LF. Works on local users only.
533 * @param text A std::string to send to the user
535 virtual void Write(const std::string &text);
537 /** Write text to this user, appending CR/LF.
538 * Works on local users only.
539 * @param text The format string for text to send to the user
540 * @param ... POD-type format arguments
542 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
544 /** Write text to this user, appending CR/LF and prepending :server.name
545 * Works on local users only.
546 * @param text A std::string to send to the user
548 void WriteServ(const std::string& text);
550 /** Write text to this user, appending CR/LF and prepending :server.name
551 * Works on local users only.
552 * @param text The format string for text to send to the user
553 * @param ... POD-type format arguments
555 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
557 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
559 void WriteNumeric(unsigned int numeric, 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 A std::string to send to the user
565 void WriteFrom(User *user, 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 The format string for text to send to the user
570 * @param ... POD-type format arguments
572 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
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 A std::string to send to the user
578 void WriteTo(User *dest, const std::string &data);
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 The format string for text to send to the user
583 * @param ... POD-type format arguments
585 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
587 /** Write to all users that can see this user (including this user in the list), appending CR/LF
588 * @param text A std::string to send to the users
590 void WriteCommonRaw(const std::string &line, bool include_self = true);
592 /** Write to all users that can see this user (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 WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
598 /** Write to all users that can see this user (not 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 WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
604 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
605 * quit message for opers only.
606 * @param normal_text Normal user quit message
607 * @param oper_text Oper only quit message
609 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
611 /** Dump text to a user target, splitting it appropriately to fit
612 * @param LinePrefix text to prefix each complete line with
613 * @param TextStream the text to send to the user
615 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
617 /** Write to the user, routing the line if the user is remote.
619 virtual void SendText(const std::string& line) = 0;
621 /** Write to the user, routing the line if the user is remote.
623 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
625 /** Return true if the user shares at least one channel with another user
626 * @param other The other user to compare the channel list against
627 * @return True if the given user shares at least one channel with this user
629 bool SharesChannelWith(User *other);
631 /** Send fake quit/join messages for host or ident cycle.
632 * Run this after the item in question has changed.
633 * You should not need to use this function, call ChangeDisplayedHost instead
635 * @param The entire QUIT line, including the source using the old value
637 void DoHostCycle(const std::string &quitline);
639 /** Change the displayed host of a user.
640 * ALWAYS use this function, rather than writing User::dhost directly,
641 * as this triggers module events allowing the change to be syncronized to
642 * remote servers. This will also emulate a QUIT and rejoin (where configured)
643 * before setting their host field.
644 * @param host The new hostname to set
645 * @return True if the change succeeded, false if it didn't
647 bool ChangeDisplayedHost(const char* host);
649 /** Change the ident (username) of a user.
650 * ALWAYS use this function, rather than writing User::ident directly,
651 * as this correctly causes the user to seem to quit (where configured)
652 * before setting their ident field.
653 * @param host The new ident to set
654 * @return True if the change succeeded, false if it didn't
656 bool ChangeIdent(const char* newident);
658 /** Change a users realname field.
659 * ALWAYS use this function, rather than writing User::fullname directly,
660 * as this triggers module events allowing the change to be syncronized to
662 * @param gecos The user's new realname
663 * @return True if the change succeeded, false if otherwise
665 bool ChangeName(const char* gecos);
667 /** Send a command to all local users from this user
668 * The command given must be able to send text with the
669 * first parameter as a servermask (e.g. $*), so basically
670 * you should use PRIVMSG or NOTICE.
671 * @param command the command to send
672 * @param text The text format string to send
673 * @param ... Format arguments
675 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
677 /** Compile a channel list for this user. Used internally by WHOIS
678 * @param source The user to prepare the channel list for
679 * @param spy Whether to return the spy channel list rather than the normal one
680 * @return This user's channel list
682 std::string ChannelList(User* source, bool spy);
684 /** Split the channel list in cl which came from dest, and spool it to this user
685 * Used internally by WHOIS
686 * @param dest The user the original channel list came from
687 * @param cl The channel list as a string obtained from User::ChannelList()
689 void SplitChanList(User* dest, const std::string &cl);
691 /** Remove this user from all channels they are on, and delete any that are now empty.
692 * This is used by QUIT, and will not send part messages!
694 void PurgeEmptyChannels();
696 /** Get the connect class which this user belongs to. NULL for remote users.
697 * @return A pointer to this user's connect class.
699 virtual ConnectClass* GetClass();
701 /** Show the message of the day to this user
705 /** Show the server RULES file to this user
709 virtual void OnDataReady();
710 virtual void OnError(BufferedSocketError error);
711 /** Default destructor
714 virtual CullResult cull();
717 class CoreExport LocalUser : public User
719 /** A list of channels the user has a pending invite to.
720 * Upon INVITE channels are added, and upon JOIN, the
721 * channels are removed from this list.
726 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
729 /** Stats counter for bytes inbound
733 /** Stats counter for bytes outbound
737 /** Stats counter for commands inbound
741 /** Stats counter for commands outbound
745 /** Password specified by the user when they registered (if any).
746 * This is stored even if the <connect> block doesnt need a password, so that
747 * modules may check it.
749 std::string password;
751 /** Contains a pointer to the connect class a user is on from
753 reference<ConnectClass> MyClass;
755 ConnectClass* GetClass();
757 /** Call this method to find the matching <connect> for a user, and to check them against it.
761 /** Server address and port that this user is connected to.
763 irc::sockets::sockaddrs server_sa;
766 * @return The port number of this user.
770 /** Used by PING checking code
774 /** This value contains how far into the penalty threshold the user is. Once its over
775 * the penalty threshold then commands are held and processed on-timer.
779 /** Stored reverse lookup from res_forward. Should not be used after resolution.
781 std::string stored_host;
783 /** Starts a DNS lookup of the user's IP.
784 * This will cause two UserResolver classes to be instantiated.
785 * When complete, these objects set User::dns_done to true.
787 void StartDNSLookup();
789 /** Use this method to fully connect a user.
790 * This will send the message of the day, check G/K/E lines, etc.
794 /** Set the connect class to which this user belongs to.
795 * @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.
796 * @return A reference to this user's current connect class.
798 void SetClass(const std::string &explicit_name = "");
801 void SendText(const std::string& line);
802 void Write(const std::string& text);
803 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
805 /** Adds to the user's write buffer.
806 * You may add any amount of text up to this users sendq value, if you exceed the
807 * sendq value, the user will be removed, and further buffer adds will be dropped.
808 * @param data The data to add to the write buffer
810 void AddWriteBuf(const std::string &data);
812 /** Returns the list of channels this user has been invited to but has not yet joined.
813 * @return A list of channels the user is invited to
815 InvitedList* GetInviteList();
817 /** Returns true if a user is invited to a channel.
818 * @param channel A channel name to look up
819 * @return True if the user is invited to the given channel
821 bool IsInvited(const irc::string &channel);
823 /** Adds a channel to a users invite list (invites them to a channel)
824 * @param channel A channel name to add
825 * @param timeout When the invite should expire (0 == never)
827 void InviteTo(const irc::string &channel, time_t timeout);
829 /** Removes a channel from a users invite list.
830 * This member function is called on successfully joining an invite only channel
831 * to which the user has previously been invited, to clear the invitation.
832 * @param channel The channel to remove the invite to
834 void RemoveInvite(const irc::string &channel);
836 /** Returns true or false for if a user can execute a privilaged oper command.
837 * This is done by looking up their oper type from User::oper, then referencing
838 * this to their oper classes and checking the commands they can execute.
839 * @param command A command (should be all CAPS)
840 * @return True if this user can execute the command
842 bool HasPermission(const std::string &command);
844 /** Returns true if a user has a given permission.
845 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
846 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
848 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
849 * @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.
850 * @return True if this user has the permission in question.
852 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
854 /** Returns true or false if a user can set a privileged user or channel mode.
855 * This is done by looking up their oper type from User::oper, then referencing
856 * this to their oper classes, and checking the modes they can set.
857 * @param mode The mode the check
858 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
859 * @return True if the user can set or unset this mode.
861 bool HasModePermission(unsigned char mode, ModeType type);
864 class CoreExport RemoteUser : public User
867 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
870 virtual void SendText(const std::string& line);
873 class CoreExport FakeUser : public User
876 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
881 virtual CullResult cull();
882 virtual void SendText(const std::string& line);
883 virtual const std::string& GetFullHost();
884 virtual const std::string& GetFullRealHost();
887 /* Faster than dynamic_cast */
888 /** Is a local user */
889 inline LocalUser* IS_LOCAL(User* u)
891 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
893 /** Is a remote user */
894 inline RemoteUser* IS_REMOTE(User* u)
896 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
898 /** Is a server fakeuser */
899 inline FakeUser* IS_SERVER(User* u)
901 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
904 #define IS_OPER(x) (x->oper)
906 #define IS_AWAY(x) (!x->awaymsg.empty())
908 /** Derived from Resolver, and performs user forward/reverse lookups.
910 class CoreExport UserResolver : public Resolver
913 /** User this class is 'attached' to.
915 LocalUser* bound_user;
916 /** File descriptor teh lookup is bound to
919 /** True if the lookup is forward, false if is a reverse lookup
923 /** Create a resolver.
924 * @param Instance The creating instance
925 * @param user The user to begin lookup on
926 * @param to_resolve The IP or host to resolve
927 * @param qt The query type
928 * @param cache Modified by the constructor if the result was cached
930 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
932 /** Called on successful lookup
933 * @param result Result string
934 * @param ttl Time to live for result
935 * @param cached True if the result was found in the cache
937 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
939 /** Called on failed lookup
940 * @param e Error code
941 * @param errormessage Error message string
943 void OnError(ResolverError e, const std::string &errormessage);