]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Clean up User::FormatModes(), rename to GetModeLetters()
[user/henk/code/inspircd.git] / include / users.h
index 6f319018fd135a3e16cdf3dfe9831b1f52bff461..4939feb1ea529a8175e23a9fd234ec2e07c7e84b 100644 (file)
@@ -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
@@ -519,9 +525,114 @@ class CoreExport User : public Extensible
         */
        void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
 
-       void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
+       /** Send a NOTICE message from the local server to the user.
+        * @param text Text to send
+        */
+       virtual void WriteRemoteNotice(const std::string& text);
+
+       virtual void WriteRemoteNumeric(const Numeric::Numeric& numeric);
+
+       template <typename T1>
+       void WriteRemoteNumeric(unsigned int numeric, T1 p1)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               WriteRemoteNumeric(n);
+       }
+
+       template <typename T1, typename T2>
+       void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               WriteRemoteNumeric(n);
+       }
+
+       template <typename T1, typename T2, typename T3>
+       void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               WriteRemoteNumeric(n);
+       }
+
+       template <typename T1, typename T2, typename T3, typename T4>
+       void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               n.push(p4);
+               WriteRemoteNumeric(n);
+       }
+
+       template <typename T1, typename T2, typename T3, typename T4, typename T5>
+       void WriteRemoteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               n.push(p4);
+               n.push(p5);
+               WriteRemoteNumeric(n);
+       }
+
+       void WriteNumeric(const Numeric::Numeric& numeric);
+
+       template <typename T1>
+       void WriteNumeric(unsigned int numeric, T1 p1)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               WriteNumeric(n);
+       }
+
+       template <typename T1, typename T2>
+       void WriteNumeric(unsigned int numeric, T1 p1, T2 p2)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               WriteNumeric(n);
+       }
 
-       void WriteNumeric(unsigned int numeric, const std::string &text);
+       template <typename T1, typename T2, typename T3>
+       void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               WriteNumeric(n);
+       }
+
+       template <typename T1, typename T2, typename T3, typename T4>
+       void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               n.push(p4);
+               WriteNumeric(n);
+       }
+
+       template <typename T1, typename T2, typename T3, typename T4, typename T5>
+       void WriteNumeric(unsigned int numeric, T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
+       {
+               Numeric::Numeric n(numeric);
+               n.push(p1);
+               n.push(p2);
+               n.push(p3);
+               n.push(p4);
+               n.push(p5);
+               WriteNumeric(n);
+       }
 
        /** Write text to this user, appending CR/LF and prepending :nick!user\@host of the user provided in the first parameter.
         * @param user The user to prepend the :nick!user\@host of
@@ -548,13 +659,6 @@ class CoreExport User : public Extensible
         */
        void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
-       /** Write a quit message to all common users, as in User::WriteCommonExcept but with a specific
-        * quit message for opers only.
-        * @param normal_text Normal user quit message
-        * @param oper_text Oper only quit message
-        */
-       void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
-
        /** Execute a function once for each local neighbor of this user. By default, the neighbors of a user are the users
         * who have at least one common channel with the user. Modules are allowed to alter the set of neighbors freely.
         * This function is used for example to send something conditionally to neighbors, or to send different messages
@@ -565,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
@@ -648,7 +738,7 @@ class CoreExport UserIOHandler : public StreamSocket
 
 typedef unsigned int already_sent_t;
 
-class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public insp::intrusive_list_node<LocalUser>
+class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
 {
  public:
        LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
@@ -727,7 +817,6 @@ class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public i
         */
        unsigned int CommandFloodPenalty;
 
-       static already_sent_t already_sent_id;
        already_sent_t already_sent;
 
        /** Check if the user matches a G or K line, and disconnect them if they do.
@@ -751,30 +840,14 @@ class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public i
 
        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);
 
-       /** Returns the list of channels this user has been invited to but has not yet joined.
-        * @return A list of channels the user is invited to
-        */
-       InviteList& GetInviteList();
-
-       /** Returns true if a user is invited to a channel.
-        * @param chan A channel to look up
-        * @return True if the user is invited to the given channel
-        */
-       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 chan 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
+       /** Send a NOTICE message from the local server to the user.
+        * The message will be sent even if the user is connected to a remote server.
+        * @param text Text to send
         */
-       bool RemoveInvite(Channel* chan);
-
-       void RemoveExpiredInvites();
+       void WriteRemoteNotice(const std::string& text) CXX11_OVERRIDE;
 
        /** Returns true or false for if a user can execute a privilaged oper command.
         * This is done by looking up their oper type from User::oper, then referencing
@@ -797,20 +870,24 @@ class CoreExport LocalUser : public User, public InviteBase<LocalUser>, public i
        /** 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
@@ -828,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();
 };
@@ -850,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;