]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Applied patch by psychon to make AddExtBanChar correctly take a single char
[user/henk/code/inspircd.git] / include / users.h
index 1fca831ef632013759b1843d3a4b05c7746546d9..2934652540815374f54dd8e865a4a33d3bebfc8a 100644 (file)
@@ -18,6 +18,8 @@
 #include "connection.h"
 #include "dns.h"
 
+#include "mode.h"
+
 /** Channel status for a user
  */
 enum ChanStatus {
@@ -141,7 +143,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)
        {
        }
 
@@ -189,7 +191,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)
        {
        }
 
@@ -207,7 +209,7 @@ public:
         */
        void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
                                const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
-                               unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
+                               unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
        {
                if (timeout)
                        registration_timeout = timeout;
@@ -234,7 +236,13 @@ public:
                if (p)
                        port = p;
 
-               this->limit = limit;
+               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. :)
@@ -360,9 +368,9 @@ public:
        }
 };
 
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
+/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
  */
-typedef std::vector<irc::string> InvitedList;
+typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
 
 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  */
@@ -429,19 +437,19 @@ class CoreExport User : public connection
 
        /** 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;
 
        /** When we erase the user (in the destructor),
         * we call this method to subtract one from all
@@ -455,7 +463,17 @@ class CoreExport User : public connection
 
        std::map<std::string, bool>* AllowedOperCommands;
 
+       /** Allowed user modes from oper classes. */
+       bool* AllowedUserModes;
+
+       /** Allowed channel modes from oper classes. */
+       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. :)
         */
@@ -494,27 +512,27 @@ 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.
@@ -524,12 +542,12 @@ class CoreExport User : public connection
         * The following RFC characters o, w, s, i have constants defined via an
         * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
         */
-       char modes[64];
+       unsigned char modes[64];
 
        /** What snomasks are set on this user.
         * This functions the same as the above modes.
         */
-       char snomasks[64];
+       unsigned char snomasks[64];
 
        /** Channels this user is on, and the permissions they have there
         */
@@ -542,7 +560,12 @@ 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];
+       std::string awaymsg;
+       
+       /** Time the user last went away.
+        * This is ONLY RELIABLE if user IS_AWAY()!
+        */
+       time_t awaytime;
 
        /** Timestamp of current time + connection class timeout.
         * This user must send USER/NICK before this timestamp is
@@ -555,8 +578,8 @@ class CoreExport User : public connection
         * 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.
@@ -567,8 +590,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.
@@ -636,7 +659,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);
+
+       /** 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)
+        */
+       const char *GetCIDRMask(int range);
 
        /* Write error string
         */
@@ -666,12 +698,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
@@ -679,7 +716,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.
@@ -736,8 +773,9 @@ class CoreExport User : public connection
 
        /** 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)
         */
-       virtual void InviteTo(const irc::string &channel);
+       virtual void InviteTo(const irc::string &channel, time_t timeout);
 
        /** Removes a channel from a users invite list.
         * This member function is called on successfully joining an invite only channel
@@ -754,6 +792,15 @@ class CoreExport User : public connection
         */
        bool HasPermission(const std::string &command);
 
+       /** 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).
+        * @return True if the user can set or unset this mode.
+        */
+       bool HasModePermission(unsigned char mode, ModeType type);
+
        /** Calls read() to read some data for this user using their fd.
         * @param buffer The buffer to read into
         * @param size The size of data to read
@@ -770,7 +817,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)
@@ -837,13 +884,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,
@@ -851,14 +898,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();
@@ -909,7 +948,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
@@ -920,7 +959,11 @@ 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, ...) CUSTOM_PRINTF(3, 4);
+
+       void WriteNumeric(unsigned int numeric, 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
@@ -933,7 +976,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
@@ -946,7 +989,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
@@ -957,13 +1000,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
@@ -982,7 +1025,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.
@@ -1032,7 +1075,7 @@ class CoreExport User : public connection
         * @param text The text format string to send
         * @param ... Format arguments
         */
-       void SendAll(const char* command, 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
@@ -1080,7 +1123,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.
         */