]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
304 -> RPL_SYNTAX
[user/henk/code/inspircd.git] / include / users.h
index 07843b7c09a34560b693af905a5fd18e34fc675f..503a1e5680d146ad2965c9bf7b1a350711cd16a7 100644 (file)
@@ -17,7 +17,6 @@
 #include "socket.h"
 #include "connection.h"
 #include "dns.h"
-
 #include "mode.h"
 
 /** Channel status for a user
@@ -143,7 +142,7 @@ public:
                registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
                pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
                recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
-               port(source->port), RefCount(0), disabled(false), limit(0)
+               port(source->port), RefCount(0), disabled(false), limit(source->limit)
        {
        }
 
@@ -191,7 +190,7 @@ public:
                                registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
                                pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
                                recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
-                               port(source->port), RefCount(0), disabled(false), limit(0)
+                               port(source->port), RefCount(0), disabled(false), limit(source->limit)
        {
        }
 
@@ -239,6 +238,12 @@ public:
                this->limit = llimit;
        }
 
+       void Update(const std::string &n, const std::string &hst)
+       {
+               name = n;
+               host = hst;
+       }
+
        /** Reference counter. Contains an int as to how many users are connected to this class. :)
         * This will be 0 if no users are connected. If a <connect> is removed from the config, and there
         * are 0 users on it - it will go away in RAM. :)
@@ -272,7 +277,7 @@ public:
 
        /** Returns the registration timeout
         */
-       unsigned int GetRegTimeout()
+       time_t GetRegTimeout()
        {
                return (registration_timeout ? registration_timeout : 90);
        }
@@ -425,25 +430,25 @@ class CoreExport User : public connection
         */
        InvitedList invites;
 
-       /** Number of channels this user is currently on
-        */
-       unsigned int ChannelCount;
-
        /** Cached nick!ident@host value using the real hostname
         */
-       char* cached_fullhost;
+       std::string cached_fullhost;
 
        /** Cached nick!ident@ip value using the real IP address
         */
-       char* cached_hostip;
+       std::string cached_hostip;
 
        /** Cached nick!ident@host value using the masked hostname
         */
-       char* cached_makehost;
+       std::string cached_makehost;
 
        /** Cached nick!ident@realhost value using the real hostname
         */
-       char* cached_fullrealhost;
+       std::string cached_fullrealhost;
+
+       /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
+        */
+       std::string cachedip;
 
        /** When we erase the user (in the destructor),
         * we call this method to subtract one from all
@@ -464,6 +469,10 @@ class CoreExport User : public connection
        bool* AllowedChanModes;
 
  public:
+       /** Module responsible for raw i/o
+        */
+       Module* io;
+
        /** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
         * The pointer is guarenteed to *always* be valid. :)
         */
@@ -502,42 +511,43 @@ class CoreExport User : public connection
         * An invalid nickname indicates an unregistered connection prior to the NICK command.
         * Use InspIRCd::IsNick() to validate nicknames.
         */
-       char nick[NICKMAX];
-
+       std::string nick;
+       
        /** The user's unique identifier.
         * This is the unique identifier which the user has across the network.
         */
-       char uuid[UUID_LENGTH];
-
+       std::string uuid;
+       
        /** The users ident reply.
         * Two characters are added to the user-defined limit to compensate for the tilde etc.
         */
-       char ident[IDENTMAX+2];
-
+       std::string ident;
+       
        /** The host displayed to non-opers (used for cloaking etc).
         * This usually matches the value of User::host.
         */
-       char dhost[65];
-
+       std::string dhost;
+       
        /** The users full name (GECOS).
         */
-       char fullname[MAXGECOS+1];
-
+       std::string fullname;
+       
        /** The user's mode list.
-        * This is NOT a null terminated string! In the 1.1 version of InspIRCd
-        * this is an array of values in a similar way to channel modes.
-        * A value of 1 in field (modeletter-65) indicates that the mode is
+        * NOT a null terminated string.
+        * Also NOT an array.
+        * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+        * if (modes[modeletter-65]) is set, then the mode is
         * set, for example, to work out if mode +s is set, we  check the field
         * User::modes['s'-65] != 0.
         * The following RFC characters o, w, s, i have constants defined via an
         * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
         */
-       char modes[64];
+       std::bitset<64> modes;
 
        /** What snomasks are set on this user.
         * This functions the same as the above modes.
         */
-       char snomasks[64];
+       std::bitset<64> snomasks;
 
        /** Channels this user is on, and the permissions they have there
         */
@@ -550,21 +560,20 @@ class CoreExport User : public connection
        /** The user's away message.
         * If this string is empty, the user is not marked as away.
         */
-       char awaymsg[MAXAWAY+1];
-
-       /** Timestamp of current time + connection class timeout.
-        * This user must send USER/NICK before this timestamp is
-        * reached or they will be disconnected.
+       std::string awaymsg;
+       
+       /** Time the user last went away.
+        * This is ONLY RELIABLE if user IS_AWAY()!
         */
-       time_t timeout;
+       time_t awaytime;
 
        /** The oper type they logged in as, if they are an oper.
         * This is used to check permissions in operclasses, so that
         * we can say 'yay' or 'nay' to any commands they issue.
         * The value of this is the value of a valid 'type name=' tag.
         */
-       char oper[NICKMAX];
-
+       std::string oper;
+       
        /** True when DNS lookups are completed.
         * The UserResolver classes res_forward and res_reverse will
         * set this value once they complete.
@@ -575,8 +584,8 @@ class CoreExport User : public connection
         * This is stored even if the <connect> block doesnt need a password, so that
         * modules may check it.
         */
-       char password[64];
-
+       std::string password;
+       
        /** User's receive queue.
         * Lines from the IRCd awaiting processing are stored here.
         * Upgraded april 2005, old system a bit hairy.
@@ -619,10 +628,6 @@ class CoreExport User : public connection
         * GetIPString/GetPort to obtain its values.
         */
        sockaddr* ip;
-       
-       /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
-        */
-       std::string cachedip;
 
        /** Initialize the clients sockaddr
         * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
@@ -644,11 +649,16 @@ class CoreExport User : public connection
        /** Get IP string from sockaddr, using static internal buffer
         * @return The IP string
         */
-       const char* GetIPString();
+       const char* GetIPString(bool translate4in6 = true);
 
-       /* Write error string
+       /** Get a CIDR mask from the IP of this user, using a static internal buffer.
+        * e.g., GetCIDRMask(16) for 223.254.214.52 returns 223.254.0.0/16
+        * This may be used for CIDR clone detection, etc.
+        *
+        * (XXX, brief note: when we do the sockets rewrite, this should move down a
+        * level so it may be used on more derived objects. -- w00t)
         */
-       std::string WriteError;
+       const char *GetCIDRMask(int range);
 
        /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
         */
@@ -674,12 +684,17 @@ class CoreExport User : public connection
         */
        User(InspIRCd* Instance, const std::string &uid = "");
 
+       /** Check if the user matches a G or K line, and disconnect them if they do.
+        * Returns true if the user matched a ban, false else.
+        */
+       bool CheckLines();
+
        /** 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&at;host form.
         * @return The full masked host of the user
         */
-       virtual char* GetFullHost();
+       virtual const std::string& GetFullHost();
 
        /** Returns the full real host of the user
         * This member function returns the hostname of the user as seen by other users
@@ -687,7 +702,7 @@ class CoreExport User : public connection
         * e.g. through a module, then this method will ignore it and return the true hostname.
         * @return The full real host of the user
         */
-       virtual char* GetFullRealHost();
+       virtual const std::string& GetFullRealHost();
 
        /** This clears any cached results that are used for GetFullRealHost() etc.
         * The results of these calls are cached as generating them can be generally expensive.
@@ -788,7 +803,7 @@ class CoreExport User : public connection
         * @param a The string to add to the users read buffer
         * @return True if the string was successfully added to the read buffer
         */
-       bool AddBuffer(std::string a);
+       bool AddBuffer(const std::string &a);
 
        /** This method returns true if the buffer contains at least one carriage return
         * character (e.g. one complete line may be read)
@@ -810,24 +825,9 @@ class CoreExport User : public connection
         */
        std::string GetBuffer();
 
-       /** Sets the write error for a connection. This is done because the actual disconnect
-        * of a client may occur at an inopportune time such as half way through /LIST output.
-        * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
-        * errored clients purged.
-        * @param error The error string to set.
-        */
-       void SetWriteError(const std::string &error);
-
-       /** Returns the write error which last occured on this connection or an empty string
-        * if none occured.
-        * @return The error string which has occured for this user
-        */
-       const char* GetWriteError();
-
        /** Adds to the user's write buffer.
         * You may add any amount of text up to this users sendq value, if you exceed the
-        * sendq value, SetWriteError() will be called to set the users error string to
-        * "SendQ exceeded", and further buffer adds will be dropped.
+        * sendq value, the user will be removed, and further buffer adds will be dropped.
         * @param data The data to add to the write buffer
         */
        void AddWriteBuf(const std::string &data);
@@ -855,13 +855,13 @@ class CoreExport User : public connection
         * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
         * @return the usermask in the format user@host
         */
-       char* MakeHost();
+       const std::string& MakeHost();
 
        /** Creates a usermask with real ip.
         * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
         * @return the usermask in the format user@ip
         */
-       char* MakeHostIP();
+       const std::string& MakeHostIP();
 
        /** Shuts down and closes the user's socket
         * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
@@ -869,14 +869,6 @@ class CoreExport User : public connection
         */
        void CloseSocket();
 
-       /** Disconnect a user gracefully
-        * @param user The user to remove
-        * @param r The quit reason to show to normal users
-        * @param oreason The quit reason to show to opers
-        * @return Although this function has no return type, on exit the user provided will no longer exist.
-        */
-       static void QuitUser(InspIRCd* Instance, User *user, const std::string &r, const char* oreason = "");
-
        /** Add the user to WHOWAS system
         */
        void AddToWhoWas();
@@ -927,7 +919,7 @@ class CoreExport User : public connection
         * @param text The format string for text to send to the user
         * @param ... POD-type format arguments
         */
-       void Write(const char *text, ...);
+       void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
 
        /** Write text to this user, appending CR/LF and prepending :server.name
         * @param text A std::string to send to the user
@@ -938,9 +930,9 @@ class CoreExport User : public connection
         * @param text The format string for text to send to the user
         * @param ... POD-type format arguments
         */
-       void WriteServ(const char* text, ...);
+       void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
-       void WriteNumeric(unsigned int numeric, const char* text, ...);
+       void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        void WriteNumeric(unsigned int numeric, const std::string &text);
 
@@ -955,7 +947,7 @@ class CoreExport User : public connection
         * @param text The format string for text to send to the user
         * @param ... POD-type format arguments
         */
-       void WriteFrom(User *user, const char* text, ...);
+       void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
         * @param dest The user to route the message to
@@ -968,7 +960,7 @@ class CoreExport User : public connection
         * @param text The format string for text to send to the user
         * @param ... POD-type format arguments
         */
-       void WriteTo(User *dest, const char *data, ...);
+       void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
 
        /** Write to all users that can see this user (including this user in the list), appending CR/LF
         * @param text A std::string to send to the users
@@ -979,13 +971,13 @@ class CoreExport User : public connection
         * @param text The format string for text to send to the users
         * @param ... POD-type format arguments
         */
-       void WriteCommon(const char* text, ...);
+       void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
        /** Write to all users that can see this user (not 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 WriteCommonExcept(const char* text, ...);
+       void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
        /** Write to all users that can see this user (not including this user in the list), appending CR/LF
         * @param text A std::string to send to the users
@@ -1004,7 +996,7 @@ class CoreExport User : public connection
         * @param text The format string to send in the WALLOPS message
         * @param ... Format arguments
         */
-       void WriteWallOps(const char* text, ...);
+       void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
        /** Write a WALLOPS message from this user to all local opers.
         * If this user is not opered, the function will return without doing anything.
@@ -1054,7 +1046,7 @@ class CoreExport User : public connection
         * @param text The text format string to send
         * @param ... Format arguments
         */
-       void SendAll(const char* command, const char* text, ...);
+       void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        /** Compile a channel list for this user, and send it to the user 'source'
         * Used internally by WHOIS
@@ -1102,7 +1094,7 @@ class CoreExport User : public connection
        /** Get oper-specific quit message shown only to opers when the user quits.
         * (overrides any sent by QuitUser)
         */
-       const char* GetOperQuit();
+       const std::string& GetOperQuit();
 
        /** Increases a user's command penalty by a set amount.
         */