]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Remove const char* versions of InspIRCd::FindNick()/FindNickOnly()/FindUUID()/FindChan()
[user/henk/code/inspircd.git] / include / users.h
index 9b13396113c7bc3544e8782f523d53751e62d2d6..def7a146d9dd5907493cfa2510428fab2e207fd3 100644 (file)
@@ -22,8 +22,7 @@
  */
 
 
-#ifndef USERS_H
-#define USERS_H
+#pragma once
 
 #include "socket.h"
 #include "inspsocket.h"
@@ -267,10 +266,6 @@ class CoreExport User : public Extensible
         */
        time_t signon;
 
-       /** Time that the connection last sent a message, used to calculate idle time
-        */
-       time_t idle_lastmsg;
-
        /** Client address that the user is connected from.
         * Do not modify this value directly, use SetClientIP() to change it.
         * Port is not valid for remote users.
@@ -333,7 +328,7 @@ class CoreExport User : public Extensible
        std::string awaymsg;
 
        /** Time the user last went away.
-        * This is ONLY RELIABLE if user IS_AWAY()!
+        * This is ONLY RELIABLE if user IsAway()!
         */
        time_t awaytime;
 
@@ -347,12 +342,6 @@ class CoreExport User : public Extensible
         */
        unsigned int registered:3;
 
-       /** True when DNS lookups are completed.
-        * The UserResolver classes res_forward and res_reverse will
-        * set this value once they complete.
-        */
-       unsigned int dns_done:1;
-
        /** Whether or not to send an snotice about this user's quitting
         */
        unsigned int quietquit:1;
@@ -364,27 +353,13 @@ class CoreExport User : public Extensible
         */
        unsigned int quitting:1;
 
-       /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
-        * This can't be handled normally because QuitUser itself calls Write on other
-        * users, which could trigger their SendQ to overrun.
-        */
-       unsigned int quitting_sendq:1;
-
-       /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
-        */
-       unsigned int exempt:1;
-
-       /** has the user responded to their previous ping?
-        */
-       unsigned int lastping:1;
-
        /** What type of user is this? */
        const unsigned int usertype:2;
 
        /** Get client IP string from sockaddr, using static internal buffer
         * @return The IP string
         */
-       const char* GetIPString();
+       const std::string& GetIPString();
 
        /** Get CIDR mask, using default range, for this user
         */
@@ -393,21 +368,15 @@ class CoreExport User : public Extensible
        /** Sets the client IP for this user
         * @return true if the conversion was successful
         */
-       virtual bool SetClientIP(const char* sip);
+       virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
 
-       virtual void SetClientIP(const irc::sockets::sockaddrs& sa);
+       virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 
        /** Constructor
         * @throw CoreException if the UID allocated to the user already exists
         */
        User(const std::string &uid, const std::string& srv, int objtype);
 
-       /** Check if the user matches a G or K line, and disconnect them if they do.
-        * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
-        * Returns true if the user matched a ban, false else.
-        */
-       bool CheckLines(bool doZline = false);
-
        /** Returns the full displayed host of the user
         * This member function returns the hostname of the user as seen by other users
         * on the server, in nick!ident\@host form.
@@ -441,6 +410,18 @@ class CoreExport User : public Extensible
         */
        std::string ProcessNoticeMasks(const char *sm);
 
+       /** Returns whether this user is currently away or not. If true,
+        * further information can be found in User::awaymsg and User::awaytime
+        * @return True if the user is away, false otherwise
+        */
+       bool IsAway() const { return (!awaymsg.empty()); }
+
+       /** Returns whether this user is an oper or not. If true,
+        * oper information can be obtained from User::oper
+        * @return True if the user is an oper, false otherwise
+        */
+       bool IsOper() const { return oper; }
+
        /** Returns true if a notice mask is set
         * @param sm A notice mask character to check
         * @return True if the notice mask is set
@@ -515,10 +496,6 @@ class CoreExport User : public Extensible
         */
        const std::string& MakeHostIP();
 
-       /** Add the user to WHOWAS system
-        */
-       void AddToWhoWas();
-
        /** Oper up the user using the given opertype.
         * This will also give the +o usermode.
         */
@@ -691,20 +668,6 @@ class CoreExport User : public Extensible
         */
        void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
-       /** Compile a channel list for this user.  Used internally by WHOIS
-        * @param source The user to prepare the channel list for
-        * @param spy Whether to return the spy channel list rather than the normal one
-        * @return This user's channel list
-        */
-       std::string ChannelList(User* source, bool spy);
-
-       /** Split the channel list in cl which came from dest, and spool it to this user
-        * Used internally by WHOIS
-        * @param dest The user the original channel list came from
-        * @param cl The  channel list as a string obtained from User::ChannelList()
-        */
-       void SplitChanList(User* dest, const std::string &cl);
-
        /** Remove this user from all channels they are on, and delete any that are now empty.
         * This is used by QUIT, and will not send part messages!
         */
@@ -747,21 +710,25 @@ class CoreExport LocalUser : public User, public InviteBase
 
        UserIOHandler eh;
 
+       /** Position in UserManager::local_users
+        */
+       LocalUserList::iterator localuseriter;
+
        /** Stats counter for bytes inbound
         */
-       int bytes_in;
+       unsigned int bytes_in;
 
        /** Stats counter for bytes outbound
         */
-       int bytes_out;
+       unsigned int bytes_out;
 
        /** Stats counter for commands inbound
         */
-       int cmds_in;
+       unsigned int cmds_in;
 
        /** Stats counter for commands outbound
         */
-       int cmds_out;
+       unsigned int cmds_out;
 
        /** Password specified by the user when they registered (if any).
         * This is stored even if the \<connect> block doesnt need a password, so that
@@ -788,10 +755,34 @@ class CoreExport LocalUser : public User, public InviteBase
         */
        int GetServerPort();
 
+       /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
+        * This can't be handled normally because QuitUser itself calls Write on other
+        * users, which could trigger their SendQ to overrun.
+        */
+       unsigned int quitting_sendq:1;
+
+       /** True when DNS lookups are completed.
+        * The UserResolver classes res_forward and res_reverse will
+        * set this value once they complete.
+        */
+       unsigned int dns_done:1;
+
+       /** has the user responded to their previous ping?
+        */
+       unsigned int lastping:1;
+
+       /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
+        */
+       unsigned int exempt:1;
+
        /** Used by PING checking code
         */
        time_t nping;
 
+       /** Time that the connection last sent a message, used to calculate idle time
+        */
+       time_t idle_lastmsg;
+
        /** This value contains how far into the penalty threshold the user is.
         * This is used either to enable fake lag or for excess flood quits
         */
@@ -810,6 +801,12 @@ class CoreExport LocalUser : public User, public InviteBase
         */
        void StartDNSLookup();
 
+       /** Check if the user matches a G or K line, and disconnect them if they do.
+        * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
+        * Returns true if the user matched a ban, false else.
+        */
+       bool CheckLines(bool doZline = false);
+
        /** Use this method to fully connect a user.
         * This will send the message of the day, check G/K/E lines, etc.
         */
@@ -821,9 +818,9 @@ class CoreExport LocalUser : public User, public InviteBase
         */
        void SetClass(const std::string &explicit_name = "");
 
-       bool SetClientIP(const char* sip);
+       bool SetClientIP(const char* sip, bool recheck_eline = true);
 
-       void SetClientIP(const irc::sockets::sockaddrs& sa);
+       void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 
        void SendText(const std::string& line);
        void Write(const std::string& text);
@@ -835,23 +832,18 @@ class CoreExport LocalUser : public User, public InviteBase
        InviteList& GetInviteList();
 
        /** Returns true if a user is invited to a channel.
-        * @param channel A channel name to look up
+        * @param channel A channel to look up
         * @return True if the user is invited to the given channel
         */
-       bool IsInvited(const irc::string &channel);
-
-       /** Adds a channel to a users invite list (invites them to a channel)
-        * @param channel A channel name to add
-        * @param timeout When the invite should expire (0 == never)
-        */
-       void InviteTo(const irc::string &channel, time_t timeout);
+       bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
 
        /** Removes a channel from a users invite list.
         * This member function is called on successfully joining an invite only channel
         * to which the user has previously been invited, to clear the invitation.
         * @param channel The channel to remove the invite to
+        * @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
         */
-       void RemoveInvite(const irc::string &channel);
+       bool RemoveInvite(Channel* chan);
 
        void RemoveExpiredInvites();
 
@@ -922,10 +914,6 @@ inline FakeUser* IS_SERVER(User* u)
 {
        return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
 }
-/** Is an oper */
-#define IS_OPER(x) (x->oper)
-/** Is away */
-#define IS_AWAY(x) (!x->awaymsg.empty())
 
 /** Derived from Resolver, and performs user forward/reverse lookups.
  */
@@ -959,5 +947,3 @@ class CoreExport UserResolver : public Resolver
         */
        void OnError(ResolverError e, const std::string &errormessage);
 };
-
-#endif