Clean up User::FormatModes(), rename to GetModeLetters()

[user/henk/code/inspircd.git] / include / users.h

diff --git a/include/users.h b/include/users.h
index 8d53197ba048fb000be29ba883ca77254693e990..4939feb1ea529a8175e23a9fd234ec2e07c7e84b 100644 (file)
--- a/include/users.h
+++ b/include/users.h
@@ -135,6 +135,11 @@ struct CoreExport ConnectClass : public refcountbase
         */
        bool resolvehostnames;
 
+       /**
+        * If non-empty the server ports which this user has to be using
+        */
+       insp::flat_set<int> ports;
+
        /** Create a new connect class with no settings.
         */
        ConnectClass(ConfigTag* tag, char type, const std::string& mask);
@@ -413,19 +418,21 @@ class CoreExport User : public Extensible
         */
        bool IsNoticeMaskSet(unsigned char sm);
 
-       /** Create a displayable mode string for this users umodes
-        * @param showparameters The mode string
+       /** Get the mode letters of modes set on the user as a string.
+        * @param includeparams True to get the parameters of the modes as well. Defaults to false.
+        * @return Mode letters of modes set on the user and optionally the parameters of those modes, if any.
+        * The returned string always begins with a '+' character. If the user has no modes set, "+" is returned.
         */
-       const char* FormatModes(bool showparameters = false);
+       std::string GetModeLetters(bool includeparams = false) const;
 
        /** Returns true if a specific mode is set
         * @param m The user mode
         * @return True if the mode is set
         */
-       bool IsModeSet(unsigned char m);
-       bool IsModeSet(ModeHandler* mh);
-       bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
-       bool IsModeSet(UserModeReference& moderef);
+       bool IsModeSet(unsigned char m) const;
+       bool IsModeSet(const ModeHandler* mh) const;
+       bool IsModeSet(const ModeHandler& mh) const { return IsModeSet(&mh); }
+       bool IsModeSet(UserModeReference& moderef) const;
 
        /** Set a specific usermode to on or off
         * @param m The user mode
@@ -455,11 +462,10 @@ class CoreExport User : public Extensible
        /** Returns true or false if a user can set a privileged user or channel mode.
         * This is done by looking up their oper type from User::oper, then referencing
         * this to their oper classes, and checking the modes they can set.
-        * @param mode The mode the check
-        * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
+        * @param mh Mode to check
         * @return True if the user can set or unset this mode.
         */
-       virtual bool HasModePermission(unsigned char mode, ModeType type);
+       virtual bool HasModePermission(const ModeHandler* mh) const;
 
        /** Creates a usermask with real host.
         * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
@@ -524,7 +530,7 @@ class CoreExport User : public Extensible
         */
        virtual void WriteRemoteNotice(const std::string& text);
 
-       void WriteRemoteNumeric(const Numeric::Numeric& numeric);
+       virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
 
        template <typename T1>
        void WriteRemoteNumeric(unsigned int numeric, T1 p1)
@@ -663,20 +669,6 @@ class CoreExport User : public Extensible
         */
        void ForEachNeighbor(ForEachNeighborHandler& handler, bool include_self = true);
 
-       /** Dump text to a user target, splitting it appropriately to fit
-        * @param linePrefix text to prefix each complete line with
-        * @param textStream the text to send to the user
-        */
-       void SendText(const std::string& linePrefix, std::stringstream& textStream);
-
-       /** Write to the user, routing the line if the user is remote.
-        */
-       virtual void SendText(const std::string& line) = 0;
-
-       /** Write to the user, routing the line if the user is remote.
-        */
-       void SendText(const char* text, ...) CUSTOM_PRINTF(2, 3);
-
        /** Return true if the user shares at least one channel with another user
         * @param other The other user to compare the channel list against
         * @return True if the given user shares at least one channel with this user
@@ -848,7 +840,6 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
 
        void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 
-       void SendText(const std::string& line);
        void Write(const std::string& text);
        void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
 
@@ -879,20 +870,24 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
        /** Returns true or false if a user can set a privileged user or channel mode.
         * This is done by looking up their oper type from User::oper, then referencing
         * this to their oper classes, and checking the modes they can set.
-        * @param mode The mode the check
-        * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
+        * @param mh Mode to check
         * @return True if the user can set or unset this mode.
         */
-       bool HasModePermission(unsigned char mode, ModeType type);
+       bool HasModePermission(const ModeHandler* mh) const;
+
+       /** Change nick to uuid, unset REG_NICK and send a nickname overruled numeric.
+        * This is called when another user (either local or remote) needs the nick of this user and this user
+        * isn't registered.
+        */
+       void OverruleNick();
 };
 
-class CoreExport RemoteUser : public User
+class RemoteUser : public User
 {
  public:
        RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
        {
        }
-       virtual void SendText(const std::string& line);
 };
 
 class CoreExport FakeUser : public User
@@ -910,7 +905,6 @@ class CoreExport FakeUser : public User
        }
 
        virtual CullResult cull();
-       virtual void SendText(const std::string& line);
        virtual const std::string& GetFullHost();
        virtual const std::string& GetFullRealHost();
 };
@@ -932,12 +926,12 @@ inline FakeUser* IS_SERVER(User* u)
        return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
 }
 
-inline bool User::IsModeSet(ModeHandler* mh)
+inline bool User::IsModeSet(const ModeHandler* mh) const
 {
        return (modes[mh->GetId()]);
 }
 
-inline bool User::IsModeSet(UserModeReference& moderef)
+inline bool User::IsModeSet(UserModeReference& moderef) const
 {
        if (!moderef)
                return false;