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 /* Required forward declaration */
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 a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
213 typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
215 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
217 typedef std::vector<reference<ConnectClass> > ClassVector;
219 /** Typedef for the list of user-channel records for a user
221 typedef std::set<Channel*> UserChanList;
223 /** Shorthand for an iterator into a UserChanList
225 typedef UserChanList::iterator UCListIter;
227 /* Required forward declaration
231 /** Holds all information about a user
232 * This class stores all information about a user connected to the irc server. Everything about a
233 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
234 * user's nickname and hostname.
236 class CoreExport User : public StreamSocket
239 /** Cached nick!ident@dhost value using the displayed hostname
241 std::string cached_fullhost;
243 /** Cached ident@ip value using the real IP address
245 std::string cached_hostip;
247 /** Cached ident@realhost value using the real hostname
249 std::string cached_makehost;
251 /** Cached nick!ident@realhost value using the real hostname
253 std::string cached_fullrealhost;
255 /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
257 std::string cachedip;
259 /** When we erase the user (in the destructor),
260 * we call this method to subtract one from all
261 * mode characters this user is making use of.
263 void DecrementModes();
266 /** Hostname of connection.
267 * This should be valid as per RFC1035.
271 /** Time that the object was instantiated (used for TS calculation etc)
275 /** Time the connection was created, set in the constructor. This
276 * may be different from the time the user's classbase object was
281 /** Time that the connection last sent a message, used to calculate idle time
285 /** Client address that the user is connected from.
286 * Do not modify this value directly, use SetClientIP() to change it.
287 * Port is not valid for remote users.
289 irc::sockets::sockaddrs client_sa;
291 /** The users nickname.
292 * An invalid nickname indicates an unregistered connection prior to the NICK command.
293 * Use InspIRCd::IsNick() to validate nicknames.
297 /** The user's unique identifier.
298 * This is the unique identifier which the user has across the network.
300 const std::string uuid;
302 /** The users ident reply.
303 * Two characters are added to the user-defined limit to compensate for the tilde etc.
307 /** The host displayed to non-opers (used for cloaking etc).
308 * This usually matches the value of User::host.
312 /** The users full name (GECOS).
314 std::string fullname;
316 /** The user's mode list.
317 * NOT a null terminated string.
319 * Much love to the STL for giving us an easy to use bitset, saving us RAM.
320 * if (modes[modeletter-65]) is set, then the mode is
321 * set, for example, to work out if mode +s is set, we check the field
322 * User::modes['s'-65] != 0.
323 * The following RFC characters o, w, s, i have constants defined via an
324 * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
326 std::bitset<64> modes;
328 /** What snomasks are set on this user.
329 * This functions the same as the above modes.
331 std::bitset<64> snomasks;
333 /** Channels this user is on
337 /** The server the user is connected to.
339 const std::string server;
341 /** The user's away message.
342 * If this string is empty, the user is not marked as away.
346 /** Time the user last went away.
347 * This is ONLY RELIABLE if user IS_AWAY()!
351 /** The oper type they logged in as, if they are an oper.
353 reference<OperInfo> oper;
355 /** Used by User to indicate the registration status of the connection
356 * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
357 * the connection state.
359 unsigned int registered:3;
361 /** True when DNS lookups are completed.
362 * The UserResolver classes res_forward and res_reverse will
363 * set this value once they complete.
365 unsigned int dns_done:1;
367 /** Whether or not to send an snotice about this user's quitting
369 unsigned int quietquit:1;
371 /** If this is set to true, then all socket operations for the user
372 * are dropped into the bit-bucket.
373 * This value is set by QuitUser, and is not needed seperately from that call.
374 * Please note that setting this value alone will NOT cause the user to quit.
376 unsigned int quitting:1;
378 /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
380 unsigned int exempt:1;
382 /** has the user responded to their previous ping?
384 unsigned int lastping:1;
386 /** Get client IP string from sockaddr, using static internal buffer
387 * @return The IP string
389 const char* GetIPString();
391 /** Get CIDR mask, using default range, for this user
393 irc::string GetCIDRMask();
395 /** Sets the client IP for this user
396 * @return true if the conversion was successful
398 bool SetClientIP(const char* sip);
400 /** Default constructor
401 * @throw CoreException if the UID allocated to the user already exists
402 * @param Instance Creator instance
403 * @param uid User UUID, or empty to allocate one automatically
404 * @param srv Server that this user is from
406 User(const std::string &uid, const std::string& srv);
408 /** Check if the user matches a G or K line, and disconnect them if they do.
409 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
410 * Returns true if the user matched a ban, false else.
412 bool CheckLines(bool doZline = false);
414 /** Returns the full displayed host of the user
415 * This member function returns the hostname of the user as seen by other users
416 * on the server, in nick!ident&at;host form.
417 * @return The full masked host of the user
419 virtual const std::string& GetFullHost();
421 /** Returns the full real host of the user
422 * This member function returns the hostname of the user as seen by other users
423 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
424 * e.g. through a module, then this method will ignore it and return the true hostname.
425 * @return The full real host of the user
427 virtual const std::string& GetFullRealHost();
429 /** This clears any cached results that are used for GetFullRealHost() etc.
430 * The results of these calls are cached as generating them can be generally expensive.
432 void InvalidateCache();
434 /** Create a displayable mode string for this users snomasks
435 * @return The notice mask character sequence
437 const char* FormatNoticeMasks();
439 /** Process a snomask modifier string, e.g. +abc-de
440 * @param sm A sequence of notice mask characters
441 * @return The cleaned mode sequence which can be output,
442 * e.g. in the above example if masks c and e are not
443 * valid, this function will return +ab-d
445 std::string ProcessNoticeMasks(const char *sm);
447 /** Returns true if a notice mask is set
448 * @param sm A notice mask character to check
449 * @return True if the notice mask is set
451 bool IsNoticeMaskSet(unsigned char sm);
453 /** Changed a specific notice mask value
454 * @param sm The server notice mask to change
455 * @param value An on/off value for this mask
457 void SetNoticeMask(unsigned char sm, bool value);
459 /** Create a displayable mode string for this users umodes
460 * @param The mode string
462 const char* FormatModes(bool showparameters = false);
464 /** Returns true if a specific mode is set
465 * @param m The user mode
466 * @return True if the mode is set
468 bool IsModeSet(unsigned char m);
470 /** Set a specific usermode to on or off
471 * @param m The user mode
472 * @param value On or off setting of the mode
474 void SetMode(unsigned char m, bool value);
476 /** Returns true or false for if a user can execute a privilaged oper command.
477 * This is done by looking up their oper type from User::oper, then referencing
478 * this to their oper classes and checking the commands they can execute.
479 * @param command A command (should be all CAPS)
480 * @return True if this user can execute the command
482 virtual bool HasPermission(const std::string &command);
484 /** Returns true if a user has a given permission.
485 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
486 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
488 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
489 * @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.
490 * @return True if this user has the permission in question.
492 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
494 /** Returns true or false if a user can set a privileged user or channel mode.
495 * This is done by looking up their oper type from User::oper, then referencing
496 * this to their oper classes, and checking the modes they can set.
497 * @param mode The mode the check
498 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
499 * @return True if the user can set or unset this mode.
501 virtual bool HasModePermission(unsigned char mode, ModeType type);
503 /** Creates a wildcard host.
504 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
505 * @return The wildcarded hostname in *!*@host form
507 char* MakeWildHost();
509 /** Creates a usermask with real host.
510 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
511 * @return the usermask in the format user@host
513 const std::string& MakeHost();
515 /** Creates a usermask with real ip.
516 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
517 * @return the usermask in the format user@ip
519 const std::string& MakeHostIP();
521 /** Add the user to WHOWAS system
525 /** Oper up the user using the given opertype.
526 * This will also give the +o usermode.
528 void Oper(OperInfo* info);
530 /** Change this users hash key to a new string.
531 * You should not call this function directly. It is used by the core
532 * to update the users hash entry on a nickchange.
533 * @param New new user_hash key
534 * @return Pointer to User in hash (usually 'this')
536 User* UpdateNickHash(const char* New);
538 /** Force a nickname change.
539 * If the nickname change fails (for example, because the nick in question
540 * already exists) this function will return false, and you must then either
541 * output an error message, or quit the user for nickname collision.
542 * @param newnick The nickname to change to
543 * @return True if the nickchange was successful.
545 bool ForceNickChange(const char* newnick);
548 * This will clear the +o usermode and unset the user's oper type
552 /** Write text to this user, appending CR/LF. Works on local users only.
553 * @param text A std::string to send to the user
555 virtual void Write(const std::string &text);
557 /** Write text to this user, appending CR/LF.
558 * Works on local users only.
559 * @param text The format string for text to send to the user
560 * @param ... POD-type format arguments
562 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
564 /** Write text to this user, appending CR/LF and prepending :server.name
565 * Works on local users only.
566 * @param text A std::string to send to the user
568 void WriteServ(const std::string& text);
570 /** Write text to this user, appending CR/LF and prepending :server.name
571 * Works on local users only.
572 * @param text The format string for text to send to the user
573 * @param ... POD-type format arguments
575 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
577 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
579 void WriteNumeric(unsigned int numeric, const std::string &text);
581 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
582 * @param user The user to prepend the :nick!user@host of
583 * @param text A std::string to send to the user
585 void WriteFrom(User *user, const std::string &text);
587 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
588 * @param user The user to prepend the :nick!user@host of
589 * @param text The format string for text to send to the user
590 * @param ... POD-type format arguments
592 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
594 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
595 * @param dest The user to route the message to
596 * @param text A std::string to send to the user
598 void WriteTo(User *dest, const std::string &data);
600 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
601 * @param dest The user to route the message to
602 * @param text The format string for text to send to the user
603 * @param ... POD-type format arguments
605 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
607 /** Write to all users that can see this user (including this user in the list), appending CR/LF
608 * @param text A std::string to send to the users
610 void WriteCommonRaw(const std::string &line, bool include_self = true);
612 /** Write to all users that can see this user (including this user in the list), appending CR/LF
613 * @param text The format string for text to send to the users
614 * @param ... POD-type format arguments
616 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
618 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
619 * @param text The format string for text to send to the users
620 * @param ... POD-type format arguments
622 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
624 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
625 * quit message for opers only.
626 * @param normal_text Normal user quit message
627 * @param oper_text Oper only quit message
629 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
631 /** Dump text to a user target, splitting it appropriately to fit
632 * @param LinePrefix text to prefix each complete line with
633 * @param TextStream the text to send to the user
635 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
637 /** Write to the user, routing the line if the user is remote.
639 virtual void SendText(const std::string& line) = 0;
641 /** Write to the user, routing the line if the user is remote.
643 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
645 /** Return true if the user shares at least one channel with another user
646 * @param other The other user to compare the channel list against
647 * @return True if the given user shares at least one channel with this user
649 bool SharesChannelWith(User *other);
651 /** Send fake quit/join messages for host or ident cycle.
652 * Run this after the item in question has changed.
653 * You should not need to use this function, call ChangeDisplayedHost instead
655 * @param The entire QUIT line, including the source using the old value
657 void DoHostCycle(const std::string &quitline);
659 /** Change the displayed host of a user.
660 * ALWAYS use this function, rather than writing User::dhost directly,
661 * as this triggers module events allowing the change to be syncronized to
662 * remote servers. This will also emulate a QUIT and rejoin (where configured)
663 * before setting their host field.
664 * @param host The new hostname to set
665 * @return True if the change succeeded, false if it didn't
667 bool ChangeDisplayedHost(const char* host);
669 /** Change the ident (username) of a user.
670 * ALWAYS use this function, rather than writing User::ident directly,
671 * as this correctly causes the user to seem to quit (where configured)
672 * before setting their ident field.
673 * @param host The new ident to set
674 * @return True if the change succeeded, false if it didn't
676 bool ChangeIdent(const char* newident);
678 /** Change a users realname field.
679 * ALWAYS use this function, rather than writing User::fullname directly,
680 * as this triggers module events allowing the change to be syncronized to
682 * @param gecos The user's new realname
683 * @return True if the change succeeded, false if otherwise
685 bool ChangeName(const char* gecos);
687 /** Send a command to all local users from this user
688 * The command given must be able to send text with the
689 * first parameter as a servermask (e.g. $*), so basically
690 * you should use PRIVMSG or NOTICE.
691 * @param command the command to send
692 * @param text The text format string to send
693 * @param ... Format arguments
695 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
697 /** Compile a channel list for this user. Used internally by WHOIS
698 * @param source The user to prepare the channel list for
699 * @param spy Whether to return the spy channel list rather than the normal one
700 * @return This user's channel list
702 std::string ChannelList(User* source, bool spy);
704 /** Split the channel list in cl which came from dest, and spool it to this user
705 * Used internally by WHOIS
706 * @param dest The user the original channel list came from
707 * @param cl The channel list as a string obtained from User::ChannelList()
709 void SplitChanList(User* dest, const std::string &cl);
711 /** Remove this user from all channels they are on, and delete any that are now empty.
712 * This is used by QUIT, and will not send part messages!
714 void PurgeEmptyChannels();
716 /** Get the connect class which this user belongs to. NULL for remote users.
717 * @return A pointer to this user's connect class.
719 virtual ConnectClass* GetClass();
721 /** Show the message of the day to this user
725 /** Show the server RULES file to this user
729 virtual void OnDataReady();
730 virtual void OnError(BufferedSocketError error);
731 /** Default destructor
734 virtual CullResult cull();
737 /** Represents a non-local user.
738 * (in fact, any FD less than -1 does)
740 #define FD_MAGIC_NUMBER -42
741 /** Represents a fake user (i.e. a server)
743 #define FD_FAKEUSER_NUMBER -7
745 class CoreExport LocalUser : public User
747 /** A list of channels the user has a pending invite to.
748 * Upon INVITE channels are added, and upon JOIN, the
749 * channels are removed from this list.
757 /** Stats counter for bytes inbound
761 /** Stats counter for bytes outbound
765 /** Stats counter for commands inbound
769 /** Stats counter for commands outbound
773 /** Password specified by the user when they registered (if any).
774 * This is stored even if the <connect> block doesnt need a password, so that
775 * modules may check it.
777 std::string password;
779 /** Contains a pointer to the connect class a user is on from
781 reference<ConnectClass> MyClass;
783 ConnectClass* GetClass();
785 /** Call this method to find the matching <connect> for a user, and to check them against it.
789 /** Server address and port that this user is connected to.
791 irc::sockets::sockaddrs server_sa;
794 * @return The port number of this user.
798 /** Used by PING checking code
802 /** This value contains how far into the penalty threshold the user is. Once its over
803 * the penalty threshold then commands are held and processed on-timer.
807 /** Stored reverse lookup from res_forward. Should not be used after resolution.
809 std::string stored_host;
811 /** Starts a DNS lookup of the user's IP.
812 * This will cause two UserResolver classes to be instantiated.
813 * When complete, these objects set User::dns_done to true.
815 void StartDNSLookup();
817 /** Use this method to fully connect a user.
818 * This will send the message of the day, check G/K/E lines, etc.
822 /** Set the connect class to which this user belongs to.
823 * @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.
824 * @return A reference to this user's current connect class.
826 void SetClass(const std::string &explicit_name = "");
829 void SendText(const std::string& line);
830 void Write(const std::string& text);
831 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
833 /** Adds to the user's write buffer.
834 * You may add any amount of text up to this users sendq value, if you exceed the
835 * sendq value, the user will be removed, and further buffer adds will be dropped.
836 * @param data The data to add to the write buffer
838 void AddWriteBuf(const std::string &data);
840 /** Returns the list of channels this user has been invited to but has not yet joined.
841 * @return A list of channels the user is invited to
843 InvitedList* GetInviteList();
845 /** Returns true if a user is invited to a channel.
846 * @param channel A channel name to look up
847 * @return True if the user is invited to the given channel
849 bool IsInvited(const irc::string &channel);
851 /** Adds a channel to a users invite list (invites them to a channel)
852 * @param channel A channel name to add
853 * @param timeout When the invite should expire (0 == never)
855 void InviteTo(const irc::string &channel, time_t timeout);
857 /** Removes a channel from a users invite list.
858 * This member function is called on successfully joining an invite only channel
859 * to which the user has previously been invited, to clear the invitation.
860 * @param channel The channel to remove the invite to
862 void RemoveInvite(const irc::string &channel);
864 /** Returns true or false for if a user can execute a privilaged oper command.
865 * This is done by looking up their oper type from User::oper, then referencing
866 * this to their oper classes and checking the commands they can execute.
867 * @param command A command (should be all CAPS)
868 * @return True if this user can execute the command
870 bool HasPermission(const std::string &command);
872 /** Returns true if a user has a given permission.
873 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
874 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
876 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
877 * @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.
878 * @return True if this user has the permission in question.
880 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
882 /** Returns true or false if a user can set a privileged user or channel mode.
883 * This is done by looking up their oper type from User::oper, then referencing
884 * this to their oper classes, and checking the modes they can set.
885 * @param mode The mode the check
886 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
887 * @return True if the user can set or unset this mode.
889 bool HasModePermission(unsigned char mode, ModeType type);
892 class CoreExport RemoteUser : public User
895 RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv)
897 SetFd(FD_MAGIC_NUMBER);
899 virtual void SendText(const std::string& line);
902 class CoreExport FakeUser : public User
905 FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv)
907 SetFd(FD_FAKEUSER_NUMBER);
911 virtual CullResult cull();
912 virtual void SendText(const std::string& line);
913 virtual const std::string& GetFullHost();
914 virtual const std::string& GetFullRealHost();
917 /* Faster than dynamic_cast */
918 /** Is a local user */
919 inline LocalUser* IS_LOCAL(User* u)
921 return u->GetFd() > -1 ? static_cast<LocalUser*>(u) : NULL;
923 /** Is a remote user */
924 inline RemoteUser* IS_REMOTE(User* u)
926 return u->GetFd() == FD_MAGIC_NUMBER ? static_cast<RemoteUser*>(u) : NULL;
928 /** Is a server fakeuser */
929 inline FakeUser* IS_SERVER(User* u)
931 return u->GetFd() == FD_FAKEUSER_NUMBER ? static_cast<FakeUser*>(u) : NULL;
934 #define IS_OPER(x) (x->oper)
936 #define IS_AWAY(x) (!x->awaymsg.empty())
938 /** Derived from Resolver, and performs user forward/reverse lookups.
940 class CoreExport UserResolver : public Resolver
943 /** User this class is 'attached' to.
945 LocalUser* bound_user;
946 /** File descriptor teh lookup is bound to
949 /** True if the lookup is forward, false if is a reverse lookup
953 /** Create a resolver.
954 * @param Instance The creating instance
955 * @param user The user to begin lookup on
956 * @param to_resolve The IP or host to resolve
957 * @param qt The query type
958 * @param cache Modified by the constructor if the result was cached
960 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
962 /** Called on successful lookup
963 * @param result Result string
964 * @param ttl Time to live for result
965 * @param cached True if the result was found in the cache
967 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
969 /** Called on failed lookup
970 * @param e Error code
971 * @param errormessage Error message string
973 void OnError(ResolverError e, const std::string &errormessage);