]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Rename User::nping to nextping for consistency with lastping.
[user/henk/code/inspircd.git] / include / users.h
index 9bca1d7a65467b21800dbd33c26918e11a53e9b3..39e7e90f00d08a10da2107176f280bc530ddb515 100644 (file)
@@ -250,6 +250,9 @@ class CoreExport User : public Extensible
        /** The real hostname of this user. */
        std::string realhost;
 
+       /** The real name of this user. */
+       std::string realname;
+
        /** The user's mode list.
         * Much love to the STL for giving us an easy to use bitset, saving us RAM.
         * if (modes[modeid]) is set, then the mode is set.
@@ -308,10 +311,6 @@ class CoreExport User : public Extensible
         */
        std::string ident;
 
-       /** The users full name.
-        */
-       std::string fullname;
-
        /** What snomasks are set on this user.
         * This functions the same as the above modes.
         */
@@ -371,6 +370,9 @@ class CoreExport User : public Extensible
        /** Retrieves this user's real hostname. */
        const std::string& GetRealHost() const;
 
+       /** Retrieves this user's real name. */
+       const std::string& GetRealName() const;
+
        /** Get CIDR mask, using default range, for this user
         */
        irc::sockets::cidr_mask GetCIDRMask();
@@ -378,9 +380,9 @@ class CoreExport User : public Extensible
        /** Sets the client IP for this user
         * @return true if the conversion was successful
         */
-       virtual bool SetClientIP(const std::string& address, bool recheck_eline = true);
+       virtual bool SetClientIP(const std::string& address);
 
-       virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
+       virtual void SetClientIP(const irc::sockets::sockaddrs& sa);
 
        /** Constructor
         * @throw CoreException if the UID allocated to the user already exists
@@ -496,41 +498,10 @@ class CoreExport User : public Extensible
         */
        void UnOper();
 
-       /** Write text to this user, appending CR/LF. Works on local users only.
-        * @param text A std::string to send to the user
-        */
-       virtual void Write(const std::string &text);
-
-       /** Write text to this user, appending CR/LF.
-        * Works on local users only.
-        * @param text The format string for text to send to the user
-        * @param ... POD-type format arguments
-        */
-       virtual void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
-
-       /** Write text to this user, appending CR/LF and prepending :server.name
-        * Works on local users only.
-        * @param text A std::string to send to the user
-        */
-       void WriteServ(const std::string& text);
-
-       /** Write text to this user, appending CR/LF and prepending :server.name
-        * Works on local users only.
-        * @param text The format string for text to send to the user
-        * @param ... POD-type format arguments
-        */
-       void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
-
-       /** Sends a command to this user.
-        * @param command The command to be sent.
-        * @param text The message to send.
-        */
-       void WriteCommand(const char* command, const std::string& text);
-
        /** Sends a server notice to this user.
         * @param text The contents of the message to send.
         */
-       void WriteNotice(const std::string& text) { this->WriteCommand("NOTICE", ":" + text); }
+       void WriteNotice(const std::string& text);
 
        /** Send a NOTICE message from the local server to the user.
         * @param text Text to send
@@ -641,30 +612,11 @@ class CoreExport User : public Extensible
                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
-        * @param text A std::string to send to the user
-        */
-       void WriteFrom(User *user, const std::string &text);
-
-       /** 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
-        * @param text The format string for text to send to the user
-        * @param ... POD-type format arguments
-        */
-       void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
-
        /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
-        * @param line A std::string to send to the users
+        * @param protoev Protocol event to send, may contain any number of messages.
         * @param include_self Should the message be sent back to the author?
         */
-       void WriteCommonRaw(const std::string &line, bool include_self = true);
-
-       /** Write to all users that can see this user (including this user in the list), appending CR/LF
-        * @param text The format string for text to send to the users
-        * @param ... POD-type format arguments
-        */
-       void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
+       void WriteCommonRaw(ClientProtocol::Event& protoev, bool include_self = true);
 
        /** 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.
@@ -704,9 +656,6 @@ class CoreExport User : public Extensible
        bool ChangeIdent(const std::string& newident);
 
        /** Change a users realname field.
-        * ALWAYS use this function, rather than writing User::fullname directly,
-        * as this triggers module events allowing the change to be syncronized to
-        * remote servers.
         * @param real The user's new real name
         * @return True if the change succeeded, false if otherwise
         */
@@ -732,11 +681,18 @@ class CoreExport User : public Extensible
 
 class CoreExport UserIOHandler : public StreamSocket
 {
+ private:
+        size_t checked_until;
  public:
        LocalUser* const user;
-       UserIOHandler(LocalUser* me) : user(me) {}
+       UserIOHandler(LocalUser* me)
+               : StreamSocket(StreamSocket::SS_USER)
+               , checked_until(0)
+               , user(me)
+       {
+       }
        void OnDataReady() CXX11_OVERRIDE;
-       void OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) CXX11_OVERRIDE;
+       bool OnSetEndPoint(const irc::sockets::sockaddrs& local, const irc::sockets::sockaddrs& remote) CXX11_OVERRIDE;
        void OnError(BufferedSocketError error) CXX11_OVERRIDE;
 
        /** Adds to the user's write buffer.
@@ -751,12 +707,32 @@ typedef unsigned int already_sent_t;
 
 class CoreExport LocalUser : public User, public insp::intrusive_list_node<LocalUser>
 {
+       /** Add a serialized message to the send queue of the user.
+        * @param serialized Bytes to add.
+        */
+       void Write(const ClientProtocol::SerializedMessage& serialized);
+
+       /** Send a protocol event to the user, consisting of one or more messages.
+        * @param protoev Event to send, may contain any number of messages.
+        * @param msglist Message list used temporarily internally to pass to hooks and store messages
+        * before Write().
+        */
+       void Send(ClientProtocol::Event& protoev, ClientProtocol::MessageList& msglist);
+
+       /** Message list, can be passed to the two parameter Send().
+        */
+       static ClientProtocol::MessageList sendmsglist;
+
  public:
        LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
        CullResult cull() CXX11_OVERRIDE;
 
        UserIOHandler eh;
 
+       /** Serializer to use when communicating with the user
+        */
+       ClientProtocol::Serializer* serializer;
+
        /** Stats counter for bytes inbound
         */
        unsigned int bytes_in;
@@ -811,13 +787,12 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
         */
        unsigned int lastping:1;
 
-       /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
+       /** 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;
+       /** The time at which this user should be pinged next. */
+       time_t nextping;
 
        /** Time that the connection last sent a message, used to calculate idle time
         */
@@ -830,14 +805,14 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
 
        already_sent_t already_sent;
 
-       /** 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)
+       /** Check if the user matches a G- or K-line, and disconnect them if they do.
+        * @param doZline True if Z-lines 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.
+        * This will send the message of the day, check G/K/E-lines, etc.
         */
        void FullConnect();
 
@@ -847,12 +822,9 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
         */
        void SetClass(const std::string &explicit_name = "");
 
-       bool SetClientIP(const std::string& address, bool recheck_eline = true) CXX11_OVERRIDE;
-
-       void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true) CXX11_OVERRIDE;
+       bool SetClientIP(const std::string& address) CXX11_OVERRIDE;
 
-       void Write(const std::string& text) CXX11_OVERRIDE;
-       void Write(const char*, ...) CXX11_OVERRIDE CUSTOM_PRINTF(2, 3);
+       void SetClientIP(const irc::sockets::sockaddrs& sa) CXX11_OVERRIDE;
 
        /** 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.
@@ -891,6 +863,17 @@ class CoreExport LocalUser : public User, public insp::intrusive_list_node<Local
         * isn't registered.
         */
        void OverruleNick();
+
+       /** Send a protocol event to the user, consisting of one or more messages.
+        * @param protoev Event to send, may contain any number of messages.
+        */
+       void Send(ClientProtocol::Event& protoev);
+
+       /** Send a single message to the user.
+        * @param protoevprov Protocol event provider.
+        * @param msg Message to send.
+        */
+       void Send(ClientProtocol::EventProvider& protoevprov, ClientProtocol::Message& msg);
 };
 
 class RemoteUser : public User
@@ -939,7 +922,7 @@ inline FakeUser* IS_SERVER(User* u)
 
 inline bool User::IsModeSet(const ModeHandler* mh) const
 {
-       return (modes[mh->GetId()]);
+       return ((mh->GetId() != ModeParser::MODEID_MAX) && (modes[mh->GetId()]));
 }
 
 inline bool User::IsModeSet(UserModeReference& moderef) const
@@ -951,5 +934,6 @@ inline bool User::IsModeSet(UserModeReference& moderef) const
 
 inline void User::SetMode(ModeHandler* mh, bool value)
 {
-       modes[mh->GetId()] = value;
+       if (mh && mh->GetId() != ModeParser::MODEID_MAX)
+               modes[mh->GetId()] = value;
 }