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 /** 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;
250 /** When we erase the user (in the destructor),
251 * we call this method to subtract one from all
252 * mode characters this user is making use of.
254 void DecrementModes();
257 /** Hostname of connection.
258 * This should be valid as per RFC1035.
262 /** Time that the object was instantiated (used for TS calculation etc)
266 /** Time the connection was created, set in the constructor. This
267 * may be different from the time the user's classbase object was
272 /** Time that the connection last sent a message, used to calculate idle time
276 /** Client address that the user is connected from.
277 * Do not modify this value directly, use SetClientIP() to change it.
278 * Port is not valid for remote users.
280 irc::sockets::sockaddrs client_sa;
282 /** The users nickname.
283 * An invalid nickname indicates an unregistered connection prior to the NICK command.
284 * Use InspIRCd::IsNick() to validate nicknames.
288 /** The user's unique identifier.
289 * This is the unique identifier which the user has across the network.
291 const std::string uuid;
293 /** The users ident reply.
294 * Two characters are added to the user-defined limit to compensate for the tilde etc.
298 /** The host displayed to non-opers (used for cloaking etc).
299 * This usually matches the value of User::host.
303 /** The users full name (GECOS).
305 std::string fullname;
307 /** The user's mode list.
308 * NOT a null terminated string.
310 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
311 * if (modes[modeletter-65]) is set, then the mode is
312 * set, for example, to work out if mode +s is set, we check the field
313 * User::modes['s'-65] != 0.
314 * The following RFC characters o, w, s, i have constants defined via an
315 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
317 std::bitset<64> modes;
319 /** What snomasks are set on this user.
320 * This functions the same as the above modes.
322 std::bitset<64> snomasks;
324 /** Channels this user is on
328 /** The server the user is connected to.
330 const std::string server;
332 /** The user's away message.
333 * If this string is empty, the user is not marked as away.
337 /** Time the user last went away.
338 * This is ONLY RELIABLE if user IS_AWAY()!
342 /** The oper type they logged in as, if they are an oper.
344 reference<OperInfo> oper;
346 /** Used by User to indicate the registration status of the connection
347 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
348 * the connection state.
350 unsigned int registered:3;
352 /** True when DNS lookups are completed.
353 * The UserResolver classes res_forward and res_reverse will
354 * set this value once they complete.
356 unsigned int dns_done:1;
358 /** Whether or not to send an snotice about this user's quitting
360 unsigned int quietquit:1;
362 /** If this is set to true, then all socket operations for the user
363 * are dropped into the bit-bucket.
364 * This value is set by QuitUser, and is not needed seperately from that call.
365 * Please note that setting this value alone will NOT cause the user to quit.
367 unsigned int quitting:1;
369 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
371 unsigned int exempt:1;
373 /** has the user responded to their previous ping?
375 unsigned int lastping:1;
377 /** What type of user is this? */
378 const unsigned int usertype:2;
380 /** Get client IP string from sockaddr, using static internal buffer
381 * @return The IP string
383 const char* GetIPString();
385 /** Get CIDR mask, using default range, for this user
387 irc::sockets::cidr_mask GetCIDRMask();
389 /** Sets the client IP for this user
390 * @return true if the conversion was successful
392 bool SetClientIP(const char* sip);
395 * @throw CoreException if the UID allocated to the user already exists
397 User(const std::string &uid, const std::string& srv, int objtype);
399 /** Check if the user matches a G or K line, and disconnect them if they do.
400 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
401 * Returns true if the user matched a ban, false else.
403 bool CheckLines(bool doZline = false);
405 /** Returns the full displayed host of the user
406 * This member function returns the hostname of the user as seen by other users
407 * on the server, in nick!ident&at;host form.
408 * @return The full masked host of the user
410 virtual const std::string& GetFullHost();
412 /** Returns the full real host of the user
413 * This member function returns the hostname of the user as seen by other users
414 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
415 * e.g. through a module, then this method will ignore it and return the true hostname.
416 * @return The full real host of the user
418 virtual const std::string& GetFullRealHost();
420 /** This clears any cached results that are used for GetFullRealHost() etc.
421 * The results of these calls are cached as generating them can be generally expensive.
423 void InvalidateCache();
425 /** Create a displayable mode string for this users snomasks
426 * @return The notice mask character sequence
428 const char* FormatNoticeMasks();
430 /** Process a snomask modifier string, e.g. +abc-de
431 * @param sm A sequence of notice mask characters
432 * @return The cleaned mode sequence which can be output,
433 * e.g. in the above example if masks c and e are not
434 * valid, this function will return +ab-d
436 std::string ProcessNoticeMasks(const char *sm);
438 /** Returns true if a notice mask is set
439 * @param sm A notice mask character to check
440 * @return True if the notice mask is set
442 bool IsNoticeMaskSet(unsigned char sm);
444 /** Changed a specific notice mask value
445 * @param sm The server notice mask to change
446 * @param value An on/off value for this mask
448 void SetNoticeMask(unsigned char sm, bool value);
450 /** Create a displayable mode string for this users umodes
451 * @param The mode string
453 const char* FormatModes(bool showparameters = false);
455 /** Returns true if a specific mode is set
456 * @param m The user mode
457 * @return True if the mode is set
459 bool IsModeSet(unsigned char m);
461 /** Set a specific usermode to on or off
462 * @param m The user mode
463 * @param value On or off setting of the mode
465 void SetMode(unsigned char m, bool value);
467 /** Returns true or false for if a user can execute a privilaged oper command.
468 * This is done by looking up their oper type from User::oper, then referencing
469 * this to their oper classes and checking the commands they can execute.
470 * @param command A command (should be all CAPS)
471 * @return True if this user can execute the command
473 virtual bool HasPermission(const std::string &command);
475 /** Returns true if a user has a given permission.
476 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
477 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
479 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
480 * @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.
481 * @return True if this user has the permission in question.
483 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
485 /** Returns true or false if a user can set a privileged user or channel mode.
486 * This is done by looking up their oper type from User::oper, then referencing
487 * this to their oper classes, and checking the modes they can set.
488 * @param mode The mode the check
489 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
490 * @return True if the user can set or unset this mode.
492 virtual bool HasModePermission(unsigned char mode, ModeType type);
494 /** Creates a wildcard host.
495 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
496 * @return The wildcarded hostname in *!*@host form
498 char* MakeWildHost();
500 /** Creates a usermask with real host.
501 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
502 * @return the usermask in the format user@host
504 const std::string& MakeHost();
506 /** Creates a usermask with real ip.
507 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
508 * @return the usermask in the format user@ip
510 const std::string& MakeHostIP();
512 /** Add the user to WHOWAS system
516 /** Oper up the user using the given opertype.
517 * This will also give the +o usermode.
519 void Oper(OperInfo* info);
521 /** Change this users hash key to a new string.
522 * You should not call this function directly. It is used by the core
523 * to update the users hash entry on a nickchange.
524 * @param New new user_hash key
525 * @return Pointer to User in hash (usually 'this')
527 User* UpdateNickHash(const char* New);
529 /** Force a nickname change.
530 * If the nickname change fails (for example, because the nick in question
531 * already exists) this function will return false, and you must then either
532 * output an error message, or quit the user for nickname collision.
533 * @param newnick The nickname to change to
534 * @return True if the nickchange was successful.
536 bool ForceNickChange(const char* newnick);
539 * This will clear the +o usermode and unset the user's oper type
543 /** Write text to this user, appending CR/LF. Works on local users only.
544 * @param text A std::string to send to the user
546 virtual void Write(const std::string &text);
548 /** Write text to this user, appending CR/LF.
549 * Works on local users only.
550 * @param text The format string for text to send to the user
551 * @param ... POD-type format arguments
553 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
555 /** Write text to this user, appending CR/LF and prepending :server.name
556 * Works on local users only.
557 * @param text A std::string to send to the user
559 void WriteServ(const std::string& text);
561 /** Write text to this user, appending CR/LF and prepending :server.name
562 * Works on local users only.
563 * @param text The format string for text to send to the user
564 * @param ... POD-type format arguments
566 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
568 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
570 void WriteNumeric(unsigned int numeric, const std::string &text);
572 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
573 * @param user The user to prepend the :nick!user@host of
574 * @param text A std::string to send to the user
576 void WriteFrom(User *user, const std::string &text);
578 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
579 * @param user The user to prepend the :nick!user@host of
580 * @param text The format string for text to send to the user
581 * @param ... POD-type format arguments
583 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
585 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
586 * @param dest The user to route the message to
587 * @param text A std::string to send to the user
589 void WriteTo(User *dest, const std::string &data);
591 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
592 * @param dest The user to route the message to
593 * @param text The format string for text to send to the user
594 * @param ... POD-type format arguments
596 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
598 /** Write to all users that can see this user (including this user in the list), appending CR/LF
599 * @param text A std::string to send to the users
601 void WriteCommonRaw(const std::string &line, bool include_self = true);
603 /** Write to all users that can see this user (including this user in the list), appending CR/LF
604 * @param text The format string for text to send to the users
605 * @param ... POD-type format arguments
607 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
609 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
610 * @param text The format string for text to send to the users
611 * @param ... POD-type format arguments
613 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
615 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
616 * quit message for opers only.
617 * @param normal_text Normal user quit message
618 * @param oper_text Oper only quit message
620 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
622 /** Dump text to a user target, splitting it appropriately to fit
623 * @param LinePrefix text to prefix each complete line with
624 * @param TextStream the text to send to the user
626 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
628 /** Write to the user, routing the line if the user is remote.
630 virtual void SendText(const std::string& line) = 0;
632 /** Write to the user, routing the line if the user is remote.
634 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
636 /** Return true if the user shares at least one channel with another user
637 * @param other The other user to compare the channel list against
638 * @return True if the given user shares at least one channel with this user
640 bool SharesChannelWith(User *other);
642 /** Send fake quit/join messages for host or ident cycle.
643 * Run this after the item in question has changed.
644 * You should not need to use this function, call ChangeDisplayedHost instead
646 * @param The entire QUIT line, including the source using the old value
648 void DoHostCycle(const std::string &quitline);
650 /** Change the displayed host of a user.
651 * ALWAYS use this function, rather than writing User::dhost directly,
652 * as this triggers module events allowing the change to be syncronized to
653 * remote servers. This will also emulate a QUIT and rejoin (where configured)
654 * before setting their host field.
655 * @param host The new hostname to set
656 * @return True if the change succeeded, false if it didn't
658 bool ChangeDisplayedHost(const char* host);
660 /** Change the ident (username) of a user.
661 * ALWAYS use this function, rather than writing User::ident directly,
662 * as this correctly causes the user to seem to quit (where configured)
663 * before setting their ident field.
664 * @param host The new ident to set
665 * @return True if the change succeeded, false if it didn't
667 bool ChangeIdent(const char* newident);
669 /** Change a users realname field.
670 * ALWAYS use this function, rather than writing User::fullname directly,
671 * as this triggers module events allowing the change to be syncronized to
673 * @param gecos The user's new realname
674 * @return True if the change succeeded, false if otherwise
676 bool ChangeName(const char* gecos);
678 /** Send a command to all local users from this user
679 * The command given must be able to send text with the
680 * first parameter as a servermask (e.g. $*), so basically
681 * you should use PRIVMSG or NOTICE.
682 * @param command the command to send
683 * @param text The text format string to send
684 * @param ... Format arguments
686 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
688 /** Compile a channel list for this user. Used internally by WHOIS
689 * @param source The user to prepare the channel list for
690 * @param spy Whether to return the spy channel list rather than the normal one
691 * @return This user's channel list
693 std::string ChannelList(User* source, bool spy);
695 /** Split the channel list in cl which came from dest, and spool it to this user
696 * Used internally by WHOIS
697 * @param dest The user the original channel list came from
698 * @param cl The channel list as a string obtained from User::ChannelList()
700 void SplitChanList(User* dest, const std::string &cl);
702 /** Remove this user from all channels they are on, and delete any that are now empty.
703 * This is used by QUIT, and will not send part messages!
705 void PurgeEmptyChannels();
707 /** Get the connect class which this user belongs to. NULL for remote users.
708 * @return A pointer to this user's connect class.
710 virtual ConnectClass* GetClass();
712 /** Show the message of the day to this user
716 /** Show the server RULES file to this user
720 /** Default destructor
723 virtual CullResult cull();
726 class CoreExport UserIOHandler : public StreamSocket
729 LocalUser* const user;
730 UserIOHandler(LocalUser* me) : user(me) {}
732 void OnError(BufferedSocketError error);
734 /** Adds to the user's write buffer.
735 * You may add any amount of text up to this users sendq value, if you exceed the
736 * sendq value, the user will be removed, and further buffer adds will be dropped.
737 * @param data The data to add to the write buffer
739 void AddWriteBuf(const std::string &data);
742 class CoreExport LocalUser : public User
744 /** A list of channels the user has a pending invite to.
745 * Upon INVITE channels are added, and upon JOIN, the
746 * channels are removed from this list.
751 LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
756 /** Stats counter for bytes inbound
760 /** Stats counter for bytes outbound
764 /** Stats counter for commands inbound
768 /** Stats counter for commands outbound
772 /** Password specified by the user when they registered (if any).
773 * This is stored even if the <connect> block doesnt need a password, so that
774 * modules may check it.
776 std::string password;
778 /** Contains a pointer to the connect class a user is on from
780 reference<ConnectClass> MyClass;
782 ConnectClass* GetClass();
784 /** Call this method to find the matching <connect> for a user, and to check them against it.
788 /** Server address and port that this user is connected to.
790 irc::sockets::sockaddrs server_sa;
793 * @return The port number of this user.
797 /** Used by PING checking code
801 /** This value contains how far into the penalty threshold the user is.
802 * This is used either to enable fake lag or for excess flood quits
804 unsigned int CommandFloodPenalty;
806 /** Stored reverse lookup from res_forward. Should not be used after resolution.
808 std::string stored_host;
810 /** Starts a DNS lookup of the user's IP.
811 * This will cause two UserResolver classes to be instantiated.
812 * When complete, these objects set User::dns_done to true.
814 void StartDNSLookup();
816 /** Use this method to fully connect a user.
817 * This will send the message of the day, check G/K/E lines, etc.
821 /** Set the connect class to which this user belongs to.
822 * @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.
823 * @return A reference to this user's current connect class.
825 void SetClass(const std::string &explicit_name = "");
827 void SendText(const std::string& line);
828 void Write(const std::string& text);
829 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
831 /** Returns the list of channels this user has been invited to but has not yet joined.
832 * @return A list of channels the user is invited to
834 InvitedList* GetInviteList();
836 /** Returns true if a user is invited to a channel.
837 * @param channel A channel name to look up
838 * @return True if the user is invited to the given channel
840 bool IsInvited(const irc::string &channel);
842 /** Adds a channel to a users invite list (invites them to a channel)
843 * @param channel A channel name to add
844 * @param timeout When the invite should expire (0 == never)
846 void InviteTo(const irc::string &channel, time_t timeout);
848 /** Removes a channel from a users invite list.
849 * This member function is called on successfully joining an invite only channel
850 * to which the user has previously been invited, to clear the invitation.
851 * @param channel The channel to remove the invite to
853 void RemoveInvite(const irc::string &channel);
855 /** Returns true or false for if a user can execute a privilaged oper command.
856 * This is done by looking up their oper type from User::oper, then referencing
857 * this to their oper classes and checking the commands they can execute.
858 * @param command A command (should be all CAPS)
859 * @return True if this user can execute the command
861 bool HasPermission(const std::string &command);
863 /** Returns true if a user has a given permission.
864 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
865 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
867 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
868 * @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.
869 * @return True if this user has the permission in question.
871 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
873 /** Returns true or false if a user can set a privileged user or channel mode.
874 * This is done by looking up their oper type from User::oper, then referencing
875 * this to their oper classes, and checking the modes they can set.
876 * @param mode The mode the check
877 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
878 * @return True if the user can set or unset this mode.
880 bool HasModePermission(unsigned char mode, ModeType type);
882 inline int GetFd() { return eh.GetFd(); }
885 class CoreExport RemoteUser : public User
888 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
891 virtual void SendText(const std::string& line);
894 class CoreExport FakeUser : public User
897 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
902 virtual CullResult cull();
903 virtual void SendText(const std::string& line);
904 virtual const std::string& GetFullHost();
905 virtual const std::string& GetFullRealHost();
908 /* Faster than dynamic_cast */
909 /** Is a local user */
910 inline LocalUser* IS_LOCAL(User* u)
912 return u->usertype == USERTYPE_LOCAL ? static_cast<LocalUser*>(u) : NULL;
914 /** Is a remote user */
915 inline RemoteUser* IS_REMOTE(User* u)
917 return u->usertype == USERTYPE_REMOTE ? static_cast<RemoteUser*>(u) : NULL;
919 /** Is a server fakeuser */
920 inline FakeUser* IS_SERVER(User* u)
922 return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
925 #define IS_OPER(x) (x->oper)
927 #define IS_AWAY(x) (!x->awaymsg.empty())
929 /** Derived from Resolver, and performs user forward/reverse lookups.
931 class CoreExport UserResolver : public Resolver
934 /** User this class is 'attached' to.
936 LocalUser* bound_user;
937 /** File descriptor teh lookup is bound to
940 /** True if the lookup is forward, false if is a reverse lookup
944 /** Create a resolver.
945 * @param Instance The creating instance
946 * @param user The user to begin lookup on
947 * @param to_resolve The IP or host to resolve
948 * @param qt The query type
949 * @param cache Modified by the constructor if the result was cached
951 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
953 /** Called on successful lookup
954 * @param result Result string
955 * @param ttl Time to live for result
956 * @param cached True if the result was found in the cache
958 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
960 /** Called on failed lookup
961 * @param e Error code
962 * @param errormessage Error message string
964 void OnError(ResolverError e, const std::string &errormessage);