]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Remove unneeded Extensible inheritance and remove "age" field from classbase
[user/henk/code/inspircd.git] / include / users.h
index 4871ca411c9d36acf79316d9b4874132b6d56ae6..19d78ec23c37314d2b24f0cddbc98edb7c93c396 100644 (file)
@@ -74,9 +74,8 @@ class UserResolver;
 
 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
  */
-class CoreExport ConnectClass : public classbase
+struct CoreExport ConnectClass : public classbase
 {
- private:
        /** Type of line, either CC_ALLOW or CC_DENY
         */
        char type;
@@ -129,141 +128,33 @@ class CoreExport ConnectClass : public classbase
         */
        int port;
 
-public:
-
-       /** Create a new connect class based on an existing connect class. This is required for std::vector (at least under windows).
+       /** How many users may be in this connect class before they are refused?
+        * (0 = no limit = default)
         */
-       ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
-               registration_timeout(source->registration_timeout), host(source->host),
-               pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
-               recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
-               port(source->port), RefCount(0), disabled(false), limit(source->limit)
-       {
-       }
-
-       /** Create a new connect class with no settings.
-        */
-       ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), host(""), pingtime(0), pass(""), hash(""),
-                       sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
-       {
-       }
-
-       /** Create a new connect class to ALLOW connections.
-        * @param thename Name of the connect class
-        * @param timeout The registration timeout
-        * @param hst The IP mask to allow
-        * @param ping The ping frequency
-        * @param pas The password to be used
-        * @param hsh The hash to be used
-        * @param sendq The maximum sendq value
-        * @param recvq The maximum recvq value
-        * @param maxl The maximum local sessions
-        * @param maxg The maximum global sessions
-        */
-       ConnectClass(const std::string &thename, unsigned int timeout,const std::string &hst, unsigned int ping,
-                       const std::string &pas, const std::string &hsh, unsigned long sendq, unsigned long recvq,
-                       unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
-                       type(CC_ALLOW), name(thename), registration_timeout(timeout), host(hst), pingtime(ping), pass(pas), hash(hsh),
-                       sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
-
-       /** Create a new connect class to DENY connections
-        * @param thename Name of the connect class
-        * @param hst The IP mask to deny
-        */
-       ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
-                       host(hst), pingtime(0), pass(""), hash(""), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
-       {
-       }
-
-       /* Create a new connect class based on another class
-        * @param thename The name of the connect class
-        * @param source Another connect class to inherit all but the name from
-        */
-       ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
-                               registration_timeout(source->registration_timeout), host(source->host),
-                               pingtime(source->pingtime), pass(source->pass), hash(source->hash), sendqmax(source->sendqmax),
-                               recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
-                               port(source->port), RefCount(0), disabled(false), limit(source->limit)
-       {
-       }
-
-       void SetDisabled(bool t)
-       {
-               this->disabled = t;
-       }
-
-       bool GetDisabled()
-       {
-               return this->disabled;
-       }
-
-       /* Update an existing entry with new values
-        */
-       void Update(unsigned int timeout, const std::string &hst, unsigned int ping,
-                               const std::string &pas, unsigned long sendq, unsigned long recvq,
-                               unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
-       {
-               if (timeout)
-                       registration_timeout = timeout;
-               if (!hst.empty())
-                       host = hst;
-               if (ping)
-                       pingtime = ping;
-               if (!pas.empty())
-                       pass = pas;
-               if (sendq)
-                       sendqmax = sendq;
-               if (recvq)
-                       recvqmax = recvq;
-               if (maxl)
-                       maxlocal = maxl;
-               if (maxg)
-                       maxglobal = maxg;
-               if (maxc)
-                       maxchans = maxc;
-               if (p)
-                       port = p;
-
-               this->limit = llimit;
-       }
-
-       void Update(const std::string &n, const std::string &hst)
-       {
-               name = n;
-               host = hst;
-       }
+       unsigned long limit;
 
-       /** 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. :)
+       /** Reference counter.
+        * This will be 1 if no users are connected, as long as it is a valid connect block
+        * When it reaches 0, the object should be deleted
         */
        unsigned long RefCount;
 
-       /** If this is true, any attempt to set a user to this class will fail. Default false. This is really private, it's only in the public section thanks to the way this class is written
+       /** Create a new connect class with no settings.
         */
-       bool disabled;
-
-       /** How many users may be in this connect class before they are refused? (0 = disabled = default)
+       ConnectClass(char type, const std::string& mask);
+       /** Create a new connect class with inherited settings.
         */
-       unsigned long limit;
-
-       size_t GetMaxChans()
-       {
-               return maxchans;
-       }
+       ConnectClass(char type, const std::string& mask, const ConnectClass& parent);
+       
+       /** Update the settings in this block to match the given block */
+       void Update(const ConnectClass* newSettings);
 
-       /** Returns the type, CC_ALLOW or CC_DENY
-        */
-       char GetType()
-       {
-               return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
-       }
-
-       std::string& GetName()
-       {
-               return name;
-       }
 
+       const std::string& GetName() { return name; }
+       const std::string& GetPass() { return pass; }
+       const std::string& GetHost() { return host; }
+       const int GetPort() { return port; }
+       
        /** Returns the registration timeout
         */
        time_t GetRegTimeout()
@@ -271,27 +162,6 @@ public:
                return (registration_timeout ? registration_timeout : 90);
        }
 
-       /** Returns the allowed or denied IP mask
-        */
-       const std::string& GetHost()
-       {
-               return host;
-       }
-
-       /** Get port number
-        */
-       int GetPort()
-       {
-               return port;
-       }
-
-       /** Set port number
-        */
-       void SetPort(int p)
-       {
-               port = p;
-       }
-
        /** Returns the ping frequency
         */
        unsigned int GetPingTime()
@@ -299,20 +169,6 @@ public:
                return (pingtime ? pingtime : 120);
        }
 
-       /** Returns the password or an empty string
-        */
-       const std::string& GetPass()
-       {
-               return pass;
-       }
-
-       /** Returns the hash or an empty string
-        */
-       const std::string& GetHash()
-       {
-               return hash;
-       }
-
        /** Returns the maximum sendq value
         */
        unsigned long GetSendqMax()
@@ -391,12 +247,6 @@ class CoreExport VisData
 class CoreExport User : public EventHandler
 {
  private:
-       /** Pointer to creator.
-        * This is required to make use of core functions
-        * from within the User class.
-        */
-       InspIRCd* ServerInstance;
-
        /** A list of channels the user has a pending invite to.
         * Upon INVITE channels are added, and upon JOIN, the
         * channels are removed from this list.
@@ -439,6 +289,12 @@ class CoreExport User : public EventHandler
        std::bitset<64> AllowedChanModes;
 
  public:
+       /** Pointer to creator.
+        * This is required to make use of core functions
+        * from within the User class.
+        */
+       InspIRCd* ServerInstance;
+
        /** 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. :)
         */
@@ -483,6 +339,10 @@ class CoreExport User : public EventHandler
         */
        time_t lastping;
 
+       /** Time that the object was instantiated (used for TS calculation etc)
+       */
+       time_t age;
+
        /** Time the connection was created, set in the constructor. This
         * may be different from the time the user's classbase object was
         * created.
@@ -616,29 +476,32 @@ class CoreExport User : public EventHandler
         */
        bool quitting;
 
-       /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
-        * GetIPString/GetPort to obtain its values.
+       /** Server address and port that this user is connected to.
+        * If unknown, address family is AF_UNKNOWN
+        */
+       irc::sockets::sockaddrs server_sa;
+       /** Client address that the user is connected from.
+        * Port number is only valid if local.
+        *
+        * Do not modify this value directly, use SetClientIP() to change it
         */
-       sockaddr* ip;
+       irc::sockets::sockaddrs client_sa;
 
-       /** Initialize the clients sockaddr
-        * @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
-        * @param ip A human-readable IP address for this user matching the protcol_family
-        * @param port The port number of this user or zero for a remote user
+       /** Sets the client IP for this user
+        * @return true if the conversion was successful
         */
-       void SetSockAddr(int protocol_family, const char* ip, int port);
+       bool SetClientIP(const char* sip);
 
-       /** Get port number from sockaddr
+       /**
         * @return The port number of this user.
         */
-       int GetPort();
-
-       /** Get protocol family from sockaddr
-        * @return The protocol family of this user, either AF_INET or AF_INET6
+       int GetServerPort();
+       /**
+        * @return The server IP address
         */
-       int GetProtocolFamily();
+       std::string GetServerIP();
 
-       /** Get IP string from sockaddr, using static internal buffer
+       /** Get client IP string from sockaddr, using static internal buffer
         * @return The IP string
         */
        const char* GetIPString();
@@ -679,7 +542,7 @@ class CoreExport User : public EventHandler
         * on the server, in nick!ident&at;host form.
         * @return The full masked host of the user
         */
-       virtual const std::string& 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 +550,7 @@ class CoreExport User : public EventHandler
         * 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 const std::string& 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.
@@ -908,7 +771,7 @@ class CoreExport User : public EventHandler
        /** Write text to this user, appending CR/LF.
         * @param text A std::string to send to the user
         */
-       void Write(std::string text);
+       void Write(const std::string &text);
 
        /** Write text to this user, appending CR/LF.
         * @param text The format string for text to send to the user
@@ -1005,6 +868,14 @@ class CoreExport User : public EventHandler
         */
        bool SharesChannelWith(User *other);
 
+       /** Send fake quit/join messages for host or ident cycle.
+        * Run this after the item in question has changed.
+        * You should not need to use this function, call ChangeDisplayedHost instead
+        *
+        * @param The entire QUIT line, including the source using the old value
+        */
+       void DoHostCycle(const std::string &quitline);
+
        /** Change the displayed host of a user.
         * ALWAYS use this function, rather than writing User::dhost directly,
         * as this triggers module events allowing the change to be syncronized to
@@ -1139,9 +1010,8 @@ class CoreExport UserResolver : public Resolver
         * @param result Result string
         * @param ttl Time to live for result
         * @param cached True if the result was found in the cache
-        * @param resultnum Result number, we are only interested in result 0
         */
-       void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
+       void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
 
        /** Called on failed lookup
         * @param e Error code