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.
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.
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
405 User(const std::string &uid);
407 /** Check if the user matches a G or K line, and disconnect them if they do.
408 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
409 * Returns true if the user matched a ban, false else.
411 bool CheckLines(bool doZline = false);
413 /** Returns the full displayed host of the user
414 * This member function returns the hostname of the user as seen by other users
415 * on the server, in nick!ident&at;host form.
416 * @return The full masked host of the user
418 virtual const std::string GetFullHost();
420 /** Returns the full real host of the user
421 * This member function returns the hostname of the user as seen by other users
422 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
423 * e.g. through a module, then this method will ignore it and return the true hostname.
424 * @return The full real host of the user
426 virtual const std::string GetFullRealHost();
428 /** This clears any cached results that are used for GetFullRealHost() etc.
429 * The results of these calls are cached as generating them can be generally expensive.
431 void InvalidateCache();
433 /** Create a displayable mode string for this users snomasks
434 * @return The notice mask character sequence
436 const char* FormatNoticeMasks();
438 /** Process a snomask modifier string, e.g. +abc-de
439 * @param sm A sequence of notice mask characters
440 * @return The cleaned mode sequence which can be output,
441 * e.g. in the above example if masks c and e are not
442 * valid, this function will return +ab-d
444 std::string ProcessNoticeMasks(const char *sm);
446 /** Returns true if a notice mask is set
447 * @param sm A notice mask character to check
448 * @return True if the notice mask is set
450 bool IsNoticeMaskSet(unsigned char sm);
452 /** Changed a specific notice mask value
453 * @param sm The server notice mask to change
454 * @param value An on/off value for this mask
456 void SetNoticeMask(unsigned char sm, bool value);
458 /** Create a displayable mode string for this users umodes
459 * @param The mode string
461 const char* FormatModes(bool showparameters = false);
463 /** Returns true if a specific mode is set
464 * @param m The user mode
465 * @return True if the mode is set
467 bool IsModeSet(unsigned char m);
469 /** Set a specific usermode to on or off
470 * @param m The user mode
471 * @param value On or off setting of the mode
473 void SetMode(unsigned char m, bool value);
475 /** Returns true or false for if a user can execute a privilaged oper command.
476 * This is done by looking up their oper type from User::oper, then referencing
477 * this to their oper classes and checking the commands they can execute.
478 * @param command A command (should be all CAPS)
479 * @return True if this user can execute the command
481 virtual bool HasPermission(const std::string &command);
483 /** Returns true if a user has a given permission.
484 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
485 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
487 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
488 * @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.
489 * @return True if this user has the permission in question.
491 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
493 /** Returns true or false if a user can set a privileged user or channel mode.
494 * This is done by looking up their oper type from User::oper, then referencing
495 * this to their oper classes, and checking the modes they can set.
496 * @param mode The mode the check
497 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
498 * @return True if the user can set or unset this mode.
500 virtual bool HasModePermission(unsigned char mode, ModeType type);
502 /** Creates a wildcard host.
503 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
504 * @return The wildcarded hostname in *!*@host form
506 char* MakeWildHost();
508 /** Creates a usermask with real host.
509 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
510 * @return the usermask in the format user@host
512 const std::string& MakeHost();
514 /** Creates a usermask with real ip.
515 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
516 * @return the usermask in the format user@ip
518 const std::string& MakeHostIP();
520 /** Add the user to WHOWAS system
524 /** Oper up the user using the given opertype.
525 * This will also give the +o usermode.
527 void Oper(OperInfo* info);
529 /** Change this users hash key to a new string.
530 * You should not call this function directly. It is used by the core
531 * to update the users hash entry on a nickchange.
532 * @param New new user_hash key
533 * @return Pointer to User in hash (usually 'this')
535 User* UpdateNickHash(const char* New);
537 /** Force a nickname change.
538 * If the nickname change fails (for example, because the nick in question
539 * already exists) this function will return false, and you must then either
540 * output an error message, or quit the user for nickname collision.
541 * @param newnick The nickname to change to
542 * @return True if the nickchange was successful.
544 bool ForceNickChange(const char* newnick);
547 * This will clear the +o usermode and unset the user's oper type
551 /** Write text to this user, appending CR/LF. Works on local users only.
552 * @param text A std::string to send to the user
554 virtual void Write(const std::string &text);
556 /** Write text to this user, appending CR/LF.
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 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
563 /** Write text to this user, appending CR/LF and prepending :server.name
564 * Works on local users only.
565 * @param text A std::string to send to the user
567 void WriteServ(const std::string& text);
569 /** Write text to this user, appending CR/LF and prepending :server.name
570 * Works on local users only.
571 * @param text The format string for text to send to the user
572 * @param ... POD-type format arguments
574 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
576 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
578 void WriteNumeric(unsigned int numeric, const std::string &text);
580 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
581 * @param user The user to prepend the :nick!user@host of
582 * @param text A std::string to send to the user
584 void WriteFrom(User *user, const std::string &text);
586 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
587 * @param user The user to prepend the :nick!user@host of
588 * @param text The format string for text to send to the user
589 * @param ... POD-type format arguments
591 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
593 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
594 * @param dest The user to route the message to
595 * @param text A std::string to send to the user
597 void WriteTo(User *dest, const std::string &data);
599 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
600 * @param dest The user to route the message to
601 * @param text The format string for text to send to the user
602 * @param ... POD-type format arguments
604 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
606 /** Write to all users that can see this user (including this user in the list), appending CR/LF
607 * @param text A std::string to send to the users
609 void WriteCommonRaw(const std::string &line, bool include_self = true);
611 /** Write to all users that can see this user (including this user in the list), appending CR/LF
612 * @param text The format string for text to send to the users
613 * @param ... POD-type format arguments
615 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
617 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
618 * @param text The format string for text to send to the users
619 * @param ... POD-type format arguments
621 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
623 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
624 * quit message for opers only.
625 * @param normal_text Normal user quit message
626 * @param oper_text Oper only quit message
628 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
630 /** Dump text to a user target, splitting it appropriately to fit
631 * @param LinePrefix text to prefix each complete line with
632 * @param TextStream the text to send to the user
634 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
636 /** Write to the user, routing the line if the user is remote.
638 virtual void SendText(const std::string& line) = 0;
640 /** Write to the user, routing the line if the user is remote.
642 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
644 /** Return true if the user shares at least one channel with another user
645 * @param other The other user to compare the channel list against
646 * @return True if the given user shares at least one channel with this user
648 bool SharesChannelWith(User *other);
650 /** Send fake quit/join messages for host or ident cycle.
651 * Run this after the item in question has changed.
652 * You should not need to use this function, call ChangeDisplayedHost instead
654 * @param The entire QUIT line, including the source using the old value
656 void DoHostCycle(const std::string &quitline);
658 /** Change the displayed host of a user.
659 * ALWAYS use this function, rather than writing User::dhost directly,
660 * as this triggers module events allowing the change to be syncronized to
661 * remote servers. This will also emulate a QUIT and rejoin (where configured)
662 * before setting their host field.
663 * @param host The new hostname to set
664 * @return True if the change succeeded, false if it didn't
666 bool ChangeDisplayedHost(const char* host);
668 /** Change the ident (username) of a user.
669 * ALWAYS use this function, rather than writing User::ident directly,
670 * as this correctly causes the user to seem to quit (where configured)
671 * before setting their ident field.
672 * @param host The new ident to set
673 * @return True if the change succeeded, false if it didn't
675 bool ChangeIdent(const char* newident);
677 /** Change a users realname field.
678 * ALWAYS use this function, rather than writing User::fullname directly,
679 * as this triggers module events allowing the change to be syncronized to
681 * @param gecos The user's new realname
682 * @return True if the change succeeded, false if otherwise
684 bool ChangeName(const char* gecos);
686 /** Send a command to all local users from this user
687 * The command given must be able to send text with the
688 * first parameter as a servermask (e.g. $*), so basically
689 * you should use PRIVMSG or NOTICE.
690 * @param command the command to send
691 * @param text The text format string to send
692 * @param ... Format arguments
694 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
696 /** Compile a channel list for this user. Used internally by WHOIS
697 * @param source The user to prepare the channel list for
698 * @param spy Whether to return the spy channel list rather than the normal one
699 * @return This user's channel list
701 std::string ChannelList(User* source, bool spy);
703 /** Split the channel list in cl which came from dest, and spool it to this user
704 * Used internally by WHOIS
705 * @param dest The user the original channel list came from
706 * @param cl The channel list as a string obtained from User::ChannelList()
708 void SplitChanList(User* dest, const std::string &cl);
710 /** Remove this user from all channels they are on, and delete any that are now empty.
711 * This is used by QUIT, and will not send part messages!
713 void PurgeEmptyChannels();
715 /** Get the connect class which this user belongs to. NULL for remote users.
716 * @return A pointer to this user's connect class.
718 virtual ConnectClass* GetClass();
720 /** Show the message of the day to this user
724 /** Show the server RULES file to this user
728 virtual void OnDataReady();
729 virtual void OnError(BufferedSocketError error);
730 /** Default destructor
733 virtual CullResult cull();
736 /** Represents a non-local user.
737 * (in fact, any FD less than -1 does)
739 #define FD_MAGIC_NUMBER -42
740 /** Represents a fake user (i.e. a server)
742 #define FD_FAKEUSER_NUMBER -7
744 class CoreExport LocalUser : public User
746 /** A list of channels the user has a pending invite to.
747 * Upon INVITE channels are added, and upon JOIN, the
748 * channels are removed from this list.
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. Once its over
802 * the penalty threshold then commands are held and processed on-timer.
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 = "");
828 void SendText(const std::string& line);
829 void Write(const std::string& text);
830 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
832 /** Adds to the user's write buffer.
833 * You may add any amount of text up to this users sendq value, if you exceed the
834 * sendq value, the user will be removed, and further buffer adds will be dropped.
835 * @param data The data to add to the write buffer
837 void AddWriteBuf(const std::string &data);
839 /** Returns the list of channels this user has been invited to but has not yet joined.
840 * @return A list of channels the user is invited to
842 InvitedList* GetInviteList();
844 /** Returns true if a user is invited to a channel.
845 * @param channel A channel name to look up
846 * @return True if the user is invited to the given channel
848 bool IsInvited(const irc::string &channel);
850 /** Adds a channel to a users invite list (invites them to a channel)
851 * @param channel A channel name to add
852 * @param timeout When the invite should expire (0 == never)
854 void InviteTo(const irc::string &channel, time_t timeout);
856 /** Removes a channel from a users invite list.
857 * This member function is called on successfully joining an invite only channel
858 * to which the user has previously been invited, to clear the invitation.
859 * @param channel The channel to remove the invite to
861 void RemoveInvite(const irc::string &channel);
863 /** Returns true or false for if a user can execute a privilaged oper command.
864 * This is done by looking up their oper type from User::oper, then referencing
865 * this to their oper classes and checking the commands they can execute.
866 * @param command A command (should be all CAPS)
867 * @return True if this user can execute the command
869 bool HasPermission(const std::string &command);
871 /** Returns true if a user has a given permission.
872 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
873 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
875 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
876 * @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.
877 * @return True if this user has the permission in question.
879 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
881 /** Returns true or false if a user can set a privileged user or channel mode.
882 * This is done by looking up their oper type from User::oper, then referencing
883 * this to their oper classes, and checking the modes they can set.
884 * @param mode The mode the check
885 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
886 * @return True if the user can set or unset this mode.
888 bool HasModePermission(unsigned char mode, ModeType type);
891 class CoreExport RemoteUser : public User
894 RemoteUser(const std::string& uid) : User(uid)
896 SetFd(FD_MAGIC_NUMBER);
898 virtual void SendText(const std::string& line);
901 class CoreExport FakeUser : public User
904 FakeUser(const std::string &uid) : User(uid)
906 SetFd(FD_FAKEUSER_NUMBER);
909 virtual void SendText(const std::string& line);
910 virtual const std::string GetFullHost();
911 virtual const std::string GetFullRealHost();
912 void SetFakeServer(std::string name);
915 /* Faster than dynamic_cast */
916 /** Is a local user */
917 inline LocalUser* IS_LOCAL(User* u)
919 return u->GetFd() > -1 ? static_cast<LocalUser*>(u) : NULL;
921 /** Is a remote user */
922 inline RemoteUser* IS_REMOTE(User* u)
924 return u->GetFd() == FD_MAGIC_NUMBER ? static_cast<RemoteUser*>(u) : NULL;
926 /** Is a server fakeuser */
927 inline FakeUser* IS_SERVER(User* u)
929 return u->GetFd() == FD_FAKEUSER_NUMBER ? static_cast<FakeUser*>(u) : NULL;
932 #define IS_OPER(x) (x->oper)
934 #define IS_AWAY(x) (!x->awaymsg.empty())
936 /** Derived from Resolver, and performs user forward/reverse lookups.
938 class CoreExport UserResolver : public Resolver
941 /** User this class is 'attached' to.
943 LocalUser* bound_user;
944 /** File descriptor teh lookup is bound to
947 /** True if the lookup is forward, false if is a reverse lookup
951 /** Create a resolver.
952 * @param Instance The creating instance
953 * @param user The user to begin lookup on
954 * @param to_resolve The IP or host to resolve
955 * @param qt The query type
956 * @param cache Modified by the constructor if the result was cached
958 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
960 /** Called on successful lookup
961 * @param result Result string
962 * @param ttl Time to live for result
963 * @param cached True if the result was found in the cache
965 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
967 /** Called on failed lookup
968 * @param e Error code
969 * @param errormessage Error message string
971 void OnError(ResolverError e, const std::string &errormessage);