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 CoreExport 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 CoreExport typedef std::vector<reference<ConnectClass> > ClassVector;
219 /** Typedef for the list of user-channel records for a user
221 CoreExport typedef std::set<Channel*> UserChanList;
223 /** Shorthand for an iterator into a UserChanList
225 CoreExport 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 /** Sets the client IP for this user
392 * @return true if the conversion was successful
394 bool SetClientIP(const char* sip);
396 /** Get a CIDR mask from the IP of this user, using a static internal buffer.
397 * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
398 * This may be used for CIDR clone detection, etc.
400 * (XXX, brief note: when we do the sockets rewrite, this should move down a
401 * level so it may be used on more derived objects. -- w00t)
403 const char *GetCIDRMask(int range);
405 /** Default constructor
406 * @throw CoreException if the UID allocated to the user already exists
407 * @param Instance Creator instance
408 * @param uid User UUID, or empty to allocate one automatically
410 User(const std::string &uid);
412 /** Check if the user matches a G or K line, and disconnect them if they do.
413 * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
414 * Returns true if the user matched a ban, false else.
416 bool CheckLines(bool doZline = false);
418 /** Returns the full displayed host of the user
419 * This member function returns the hostname of the user as seen by other users
420 * on the server, in nick!ident&at;host form.
421 * @return The full masked host of the user
423 virtual const std::string GetFullHost();
425 /** Returns the full real host of the user
426 * This member function returns the hostname of the user as seen by other users
427 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
428 * e.g. through a module, then this method will ignore it and return the true hostname.
429 * @return The full real host of the user
431 virtual const std::string GetFullRealHost();
433 /** This clears any cached results that are used for GetFullRealHost() etc.
434 * The results of these calls are cached as generating them can be generally expensive.
436 void InvalidateCache();
438 /** Create a displayable mode string for this users snomasks
439 * @return The notice mask character sequence
441 const char* FormatNoticeMasks();
443 /** Process a snomask modifier string, e.g. +abc-de
444 * @param sm A sequence of notice mask characters
445 * @return The cleaned mode sequence which can be output,
446 * e.g. in the above example if masks c and e are not
447 * valid, this function will return +ab-d
449 std::string ProcessNoticeMasks(const char *sm);
451 /** Returns true if a notice mask is set
452 * @param sm A notice mask character to check
453 * @return True if the notice mask is set
455 bool IsNoticeMaskSet(unsigned char sm);
457 /** Changed a specific notice mask value
458 * @param sm The server notice mask to change
459 * @param value An on/off value for this mask
461 void SetNoticeMask(unsigned char sm, bool value);
463 /** Create a displayable mode string for this users umodes
464 * @param The mode string
466 const char* FormatModes(bool showparameters = false);
468 /** Returns true if a specific mode is set
469 * @param m The user mode
470 * @return True if the mode is set
472 bool IsModeSet(unsigned char m);
474 /** Set a specific usermode to on or off
475 * @param m The user mode
476 * @param value On or off setting of the mode
478 void SetMode(unsigned char m, bool value);
480 /** Returns true or false for if a user can execute a privilaged oper command.
481 * This is done by looking up their oper type from User::oper, then referencing
482 * this to their oper classes and checking the commands they can execute.
483 * @param command A command (should be all CAPS)
484 * @return True if this user can execute the command
486 virtual bool HasPermission(const std::string &command);
488 /** Returns true if a user has a given permission.
489 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
490 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
492 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
493 * @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.
494 * @return True if this user has the permission in question.
496 virtual bool HasPrivPermission(const std::string &privstr, bool noisy = false);
498 /** Returns true or false if a user can set a privileged user or channel mode.
499 * This is done by looking up their oper type from User::oper, then referencing
500 * this to their oper classes, and checking the modes they can set.
501 * @param mode The mode the check
502 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
503 * @return True if the user can set or unset this mode.
505 virtual bool HasModePermission(unsigned char mode, ModeType type);
507 /** Creates a wildcard host.
508 * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
509 * @return The wildcarded hostname in *!*@host form
511 char* MakeWildHost();
513 /** Creates a usermask with real host.
514 * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
515 * @return the usermask in the format user@host
517 const std::string& MakeHost();
519 /** Creates a usermask with real ip.
520 * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
521 * @return the usermask in the format user@ip
523 const std::string& MakeHostIP();
525 /** Add the user to WHOWAS system
529 /** Oper up the user using the given opertype.
530 * This will also give the +o usermode.
532 void Oper(OperInfo* info);
534 /** Change this users hash key to a new string.
535 * You should not call this function directly. It is used by the core
536 * to update the users hash entry on a nickchange.
537 * @param New new user_hash key
538 * @return Pointer to User in hash (usually 'this')
540 User* UpdateNickHash(const char* New);
542 /** Force a nickname change.
543 * If the nickname change fails (for example, because the nick in question
544 * already exists) this function will return false, and you must then either
545 * output an error message, or quit the user for nickname collision.
546 * @param newnick The nickname to change to
547 * @return True if the nickchange was successful.
549 bool ForceNickChange(const char* newnick);
552 * This will clear the +o usermode and unset the user's oper type
556 /** Write text to this user, appending CR/LF. Works on local users only.
557 * @param text A std::string to send to the user
559 virtual void Write(const std::string &text);
561 /** Write text to this user, appending CR/LF.
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 virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
568 /** Write text to this user, appending CR/LF and prepending :server.name
569 * Works on local users only.
570 * @param text A std::string to send to the user
572 void WriteServ(const std::string& text);
574 /** Write text to this user, appending CR/LF and prepending :server.name
575 * Works on local users only.
576 * @param text The format string for text to send to the user
577 * @param ... POD-type format arguments
579 void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
581 void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
583 void WriteNumeric(unsigned int numeric, const std::string &text);
585 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
586 * @param user The user to prepend the :nick!user@host of
587 * @param text A std::string to send to the user
589 void WriteFrom(User *user, const std::string &text);
591 /** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
592 * @param user The user to prepend the :nick!user@host of
593 * @param text The format string for text to send to the user
594 * @param ... POD-type format arguments
596 void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
598 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
599 * @param dest The user to route the message to
600 * @param text A std::string to send to the user
602 void WriteTo(User *dest, const std::string &data);
604 /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
605 * @param dest The user to route the message to
606 * @param text The format string for text to send to the user
607 * @param ... POD-type format arguments
609 void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
611 /** Write to all users that can see this user (including this user in the list), appending CR/LF
612 * @param text A std::string to send to the users
614 void WriteCommonRaw(const std::string &line, bool include_self = true);
616 /** Write to all users that can see this user (including this user in the list), appending CR/LF
617 * @param text The format string for text to send to the users
618 * @param ... POD-type format arguments
620 void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
622 /** Write to all users that can see this user (not including this user in the list), appending CR/LF
623 * @param text The format string for text to send to the users
624 * @param ... POD-type format arguments
626 void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
628 /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
629 * quit message for opers only.
630 * @param normal_text Normal user quit message
631 * @param oper_text Oper only quit message
633 void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
635 /** Dump text to a user target, splitting it appropriately to fit
636 * @param LinePrefix text to prefix each complete line with
637 * @param TextStream the text to send to the user
639 void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
641 /** Write to the user, routing the line if the user is remote.
643 virtual void SendText(const std::string& line) = 0;
645 /** Write to the user, routing the line if the user is remote.
647 void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
649 /** Return true if the user shares at least one channel with another user
650 * @param other The other user to compare the channel list against
651 * @return True if the given user shares at least one channel with this user
653 bool SharesChannelWith(User *other);
655 /** Send fake quit/join messages for host or ident cycle.
656 * Run this after the item in question has changed.
657 * You should not need to use this function, call ChangeDisplayedHost instead
659 * @param The entire QUIT line, including the source using the old value
661 void DoHostCycle(const std::string &quitline);
663 /** Change the displayed host of a user.
664 * ALWAYS use this function, rather than writing User::dhost directly,
665 * as this triggers module events allowing the change to be syncronized to
666 * remote servers. This will also emulate a QUIT and rejoin (where configured)
667 * before setting their host field.
668 * @param host The new hostname to set
669 * @return True if the change succeeded, false if it didn't
671 bool ChangeDisplayedHost(const char* host);
673 /** Change the ident (username) of a user.
674 * ALWAYS use this function, rather than writing User::ident directly,
675 * as this correctly causes the user to seem to quit (where configured)
676 * before setting their ident field.
677 * @param host The new ident to set
678 * @return True if the change succeeded, false if it didn't
680 bool ChangeIdent(const char* newident);
682 /** Change a users realname field.
683 * ALWAYS use this function, rather than writing User::fullname directly,
684 * as this triggers module events allowing the change to be syncronized to
686 * @param gecos The user's new realname
687 * @return True if the change succeeded, false if otherwise
689 bool ChangeName(const char* gecos);
691 /** Send a command to all local users from this user
692 * The command given must be able to send text with the
693 * first parameter as a servermask (e.g. $*), so basically
694 * you should use PRIVMSG or NOTICE.
695 * @param command the command to send
696 * @param text The text format string to send
697 * @param ... Format arguments
699 void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
701 /** Compile a channel list for this user. Used internally by WHOIS
702 * @param source The user to prepare the channel list for
703 * @param spy Whether to return the spy channel list rather than the normal one
704 * @return This user's channel list
706 std::string ChannelList(User* source, bool spy);
708 /** Split the channel list in cl which came from dest, and spool it to this user
709 * Used internally by WHOIS
710 * @param dest The user the original channel list came from
711 * @param cl The channel list as a string obtained from User::ChannelList()
713 void SplitChanList(User* dest, const std::string &cl);
715 /** Remove this user from all channels they are on, and delete any that are now empty.
716 * This is used by QUIT, and will not send part messages!
718 void PurgeEmptyChannels();
720 /** Get the connect class which this user belongs to. NULL for remote users.
721 * @return A pointer to this user's connect class.
723 virtual ConnectClass* GetClass();
725 /** Show the message of the day to this user
729 /** Show the server RULES file to this user
733 virtual void OnDataReady();
734 virtual void OnError(BufferedSocketError error);
735 /** Default destructor
738 virtual CullResult cull();
741 /** Represents a non-local user.
742 * (in fact, any FD less than -1 does)
744 #define FD_MAGIC_NUMBER -42
745 /** Represents a fake user (i.e. a server)
747 #define FD_FAKEUSER_NUMBER -7
749 class CoreExport LocalUser : public User
751 /** A list of channels the user has a pending invite to.
752 * Upon INVITE channels are added, and upon JOIN, the
753 * channels are removed from this list.
761 /** Stats counter for bytes inbound
765 /** Stats counter for bytes outbound
769 /** Stats counter for commands inbound
773 /** Stats counter for commands outbound
777 /** Password specified by the user when they registered (if any).
778 * This is stored even if the <connect> block doesnt need a password, so that
779 * modules may check it.
781 std::string password;
783 /** Contains a pointer to the connect class a user is on from
785 reference<ConnectClass> MyClass;
787 ConnectClass* GetClass();
789 /** Call this method to find the matching <connect> for a user, and to check them against it.
793 /** Server address and port that this user is connected to.
795 irc::sockets::sockaddrs server_sa;
798 * @return The port number of this user.
802 /** Used by PING checking code
806 /** This value contains how far into the penalty threshold the user is. Once its over
807 * the penalty threshold then commands are held and processed on-timer.
811 /** Stored reverse lookup from res_forward. Should not be used after resolution.
813 std::string stored_host;
815 /** Starts a DNS lookup of the user's IP.
816 * This will cause two UserResolver classes to be instantiated.
817 * When complete, these objects set User::dns_done to true.
819 void StartDNSLookup();
821 /** Use this method to fully connect a user.
822 * This will send the message of the day, check G/K/E lines, etc.
826 /** Set the connect class to which this user belongs to.
827 * @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.
828 * @return A reference to this user's current connect class.
830 void SetClass(const std::string &explicit_name = "");
833 void SendText(const std::string& line);
834 void Write(const std::string& text);
835 void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
837 /** Adds to the user's write buffer.
838 * You may add any amount of text up to this users sendq value, if you exceed the
839 * sendq value, the user will be removed, and further buffer adds will be dropped.
840 * @param data The data to add to the write buffer
842 void AddWriteBuf(const std::string &data);
844 /** Returns the list of channels this user has been invited to but has not yet joined.
845 * @return A list of channels the user is invited to
847 InvitedList* GetInviteList();
849 /** Returns true if a user is invited to a channel.
850 * @param channel A channel name to look up
851 * @return True if the user is invited to the given channel
853 bool IsInvited(const irc::string &channel);
855 /** Adds a channel to a users invite list (invites them to a channel)
856 * @param channel A channel name to add
857 * @param timeout When the invite should expire (0 == never)
859 void InviteTo(const irc::string &channel, time_t timeout);
861 /** Removes a channel from a users invite list.
862 * This member function is called on successfully joining an invite only channel
863 * to which the user has previously been invited, to clear the invitation.
864 * @param channel The channel to remove the invite to
866 void RemoveInvite(const irc::string &channel);
868 /** Returns true or false for if a user can execute a privilaged oper command.
869 * This is done by looking up their oper type from User::oper, then referencing
870 * this to their oper classes and checking the commands they can execute.
871 * @param command A command (should be all CAPS)
872 * @return True if this user can execute the command
874 bool HasPermission(const std::string &command);
876 /** Returns true if a user has a given permission.
877 * This is used to check whether or not users may perform certain actions which admins may not wish to give to
878 * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
880 * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
881 * @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.
882 * @return True if this user has the permission in question.
884 bool HasPrivPermission(const std::string &privstr, bool noisy = false);
886 /** Returns true or false if a user can set a privileged user or channel mode.
887 * This is done by looking up their oper type from User::oper, then referencing
888 * this to their oper classes, and checking the modes they can set.
889 * @param mode The mode the check
890 * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
891 * @return True if the user can set or unset this mode.
893 bool HasModePermission(unsigned char mode, ModeType type);
896 class CoreExport RemoteUser : public User
899 RemoteUser(const std::string& uid) : User(uid)
901 SetFd(FD_MAGIC_NUMBER);
903 virtual void SendText(const std::string& line);
906 class CoreExport FakeUser : public User
909 FakeUser(const std::string &uid) : User(uid)
911 SetFd(FD_FAKEUSER_NUMBER);
914 virtual void SendText(const std::string& line);
915 virtual const std::string GetFullHost();
916 virtual const std::string GetFullRealHost();
917 void SetFakeServer(std::string name);
920 /* Faster than dynamic_cast */
921 /** Is a local user */
922 inline LocalUser* IS_LOCAL(User* u)
924 return u->GetFd() > -1 ? static_cast<LocalUser*>(u) : NULL;
926 /** Is a remote user */
927 inline RemoteUser* IS_REMOTE(User* u)
929 return u->GetFd() == FD_MAGIC_NUMBER ? static_cast<RemoteUser*>(u) : NULL;
931 /** Is a server fakeuser */
932 inline FakeUser* IS_SERVER(User* u)
934 return u->GetFd() == FD_FAKEUSER_NUMBER ? static_cast<FakeUser*>(u) : NULL;
937 #define IS_OPER(x) (x->oper)
939 #define IS_AWAY(x) (!x->awaymsg.empty())
941 /** Derived from Resolver, and performs user forward/reverse lookups.
943 class CoreExport UserResolver : public Resolver
946 /** User this class is 'attached' to.
948 LocalUser* bound_user;
949 /** File descriptor teh lookup is bound to
952 /** True if the lookup is forward, false if is a reverse lookup
956 /** Create a resolver.
957 * @param Instance The creating instance
958 * @param user The user to begin lookup on
959 * @param to_resolve The IP or host to resolve
960 * @param qt The query type
961 * @param cache Modified by the constructor if the result was cached
963 UserResolver(LocalUser* user, std::string to_resolve, QueryType qt, bool &cache);
965 /** Called on successful lookup
966 * @param result Result string
967 * @param ttl Time to live for result
968 * @param cached True if the result was found in the cache
970 void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
972 /** Called on failed lookup
973 * @param e Error code
974 * @param errormessage Error message string
976 void OnError(ResolverError e, const std::string &errormessage);