]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Default 'noisy' to false. Until i hear from w00t i cant see how this can be of use...
[user/henk/code/inspircd.git] / include / users.h
index 39abc63095ad426e9735243ba766094d8a82f9fc..48026d473dfa552279e69e09322bde1b6fc2fb59 100644 (file)
@@ -15,9 +15,7 @@
 #define __USERS_H__
 
 #include "socket.h"
-#include "connection.h"
 #include "dns.h"
-
 #include "mode.h"
 
 /** Channel status for a user
@@ -45,16 +43,14 @@ enum ClassTypes {
 /** RFC1459 channel modes
  */
 enum UserModes {
-       /** +s: Server notices */
-       UM_SERVERNOTICE = 's' - 65,
+       /** +s: Server notice mask */
+       UM_SNOMASK = 's' - 65,
        /** +w: WALLOPS */
        UM_WALLOPS = 'w' - 65,
        /** +i: Invisible */
        UM_INVISIBLE = 'i' - 65,
        /** +o: Operator */
-       UM_OPERATOR = 'o' - 65,
-       /** +n: Server notice mask */
-       UM_SNOMASK = 'n' - 65
+       UM_OPERATOR = 'o' - 65
 };
 
 /** Registration state of a user, e.g.
@@ -143,14 +139,14 @@ 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(source->limit)
+               port(source->port), RefCount(0), limit(source->limit)
        {
        }
 
        /** Create a new connect class with no settings.
         */
        ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
-                       threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
+                       threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), limit(0)
        {
        }
 
@@ -172,14 +168,14 @@ public:
                        const std::string &pas, const std::string &hsh, unsigned int thres, 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), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
-                       threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
+                       threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), 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),
-                       flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
+                       flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), limit(0)
        {
        }
 
@@ -191,18 +187,8 @@ 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(source->limit)
-       {
-       }
-
-       void SetDisabled(bool t)
-       {
-               this->disabled = t;
-       }
-
-       bool GetDisabled()
+                               port(source->port), RefCount(0), limit(source->limit)
        {
-               return this->disabled;
        }
 
        /* Update an existing entry with new values
@@ -251,15 +237,11 @@ public:
         */
        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
-        */
-       bool disabled;
-
        /** How many users may be in this connect class before they are refused? (0 = disabled = default)
         */
        unsigned long limit;
 
-       int GetMaxChans()
+       size_t GetMaxChans()
        {
                return maxchans;
        }
@@ -416,7 +398,7 @@ class CoreExport VisData
  * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
  * file descriptor value.
  */
-class CoreExport User : public connection
+class CoreExport User : public EventHandler
 {
  private:
        /** Pointer to creator.
@@ -431,15 +413,15 @@ class CoreExport User : public connection
         */
        InvitedList invites;
 
-       /** Cached nick!ident@host value using the real hostname
+       /** Cached nick!ident@dhost value using the displayed hostname
         */
        std::string cached_fullhost;
 
-       /** Cached nick!ident@ip value using the real IP address
+       /** Cached ident@ip value using the real IP address
         */
        std::string cached_hostip;
 
-       /** Cached nick!ident@host value using the masked hostname
+       /** Cached ident@realhost value using the real hostname
         */
        std::string cached_makehost;
 
@@ -457,46 +439,75 @@ class CoreExport User : public connection
         */
        void DecrementModes();
 
-       /** Max channels for this user
-        */
-       unsigned int MaxChans;
-
-       std::map<std::string, bool>* AllowedOperCommands;
+       std::set<std::string> *AllowedOperCommands;
+       std::set<std::string> *AllowedPrivs;
 
        /** Allowed user modes from oper classes. */
-       bool* AllowedUserModes;
+       std::bitset<64> AllowedUserModes;
 
        /** Allowed channel modes from oper classes. */
-       bool* AllowedChanModes;
+       std::bitset<64> 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. :)
         */
        ConnectClass *MyClass;
 
-       /** Resolvers for looking up this users IP address
-        * This will occur if and when res_reverse completes.
-        * When this class completes its lookup, User::dns_done
-        * will be set from false to true.
+       /** User visibility state, see definition of VisData.
+        */
+       VisData* Visibility;
+
+       /** Hostname of connection.
+        * This should be valid as per RFC1035.
         */
-       UserResolver* res_forward;
+       std::string host;
 
-       /** Resolvers for looking up this users hostname
-        * This is instantiated by User::StartDNSLookup(),
-        * and on success, instantiates User::res_reverse.
+       /** Stats counter for bytes inbound
         */
-       UserResolver* res_reverse;
+       int bytes_in;
 
-       /** User visibility state, see definition of VisData.
+       /** Stats counter for bytes outbound
         */
-       VisData* Visibility;
+       int bytes_out;
 
-       /** Stored reverse lookup from res_forward
+       /** Stats counter for commands inbound
+        */
+       int cmds_in;
+
+       /** Stats counter for commands outbound
+        */
+       int cmds_out;
+
+       /** True if user has authenticated, false if otherwise
+        */
+       bool haspassed;
+
+       /** Used by User to indicate the registration status of the connection
+        * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
+        * the connection state.
+        */
+       char registered;
+
+       /** Time the connection was last pinged
+        */
+       time_t lastping;
+
+       /** Time the connection was created, set in the constructor. This
+        * may be different from the time the user's classbase object was
+        * created.
+        */
+       time_t signon;
+
+       /** Time that the connection last sent a message, used to calculate idle time
+        */
+       time_t idle_lastmsg;
+
+       /** Used by PING checking code
+        */
+       time_t nping;
+
+       /** Stored reverse lookup from res_forward. Should not be used after resolution.
         */
        std::string stored_host;
 
@@ -506,8 +517,6 @@ class CoreExport User : public connection
         */
        void StartDNSLookup();
 
-       unsigned int GetMaxChans();
-
        /** The users nickname.
         * An invalid nickname indicates an unregistered connection prior to the NICK command.
         * Use InspIRCd::IsNick() to validate nicknames.
@@ -534,20 +543,21 @@ class CoreExport User : public connection
        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.
         */
-       unsigned char modes[64];
+       std::bitset<64> modes;
 
        /** What snomasks are set on this user.
         * This functions the same as the above modes.
         */
-       unsigned char snomasks[64];
+       std::bitset<64> snomasks;
 
        /** Channels this user is on, and the permissions they have there
         */
@@ -685,9 +695,10 @@ 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.
+        * @param doZline True if ZLines should be checked (if IP has changed since initial connect)
         * Returns true if the user matched a ban, false else.
         */
-       bool CheckLines();
+       bool CheckLines(bool doZline = false);
 
        /** Returns the full displayed host of the user
         * This member function returns the hostname of the user as seen by other users
@@ -737,7 +748,7 @@ class CoreExport User : public connection
        /** Create a displayable mode string for this users umodes
         * @param The mode string
         */
-       const char* FormatModes();
+       const char* FormatModes(bool showparameters = false);
 
        /** Returns true if a specific mode is set
         * @param m The user mode
@@ -778,6 +789,16 @@ class CoreExport User : public connection
         */
        bool HasPermission(const std::string &command);
 
+       /** Returns true if a user has a given permission.
+        * This is used to check whether or not users may perform certain actions which admins may not wish to give to
+        * all operators, yet are not commands. An example might be oper override, mass messaging (/notice $*), etc.
+        *
+        * @param privstr The priv to chec, e.g. "users/override/topic". These are loaded free-form from the config file.
+        * @param noisy If set to true, the user is notified that they do not have the specified permission where applicable. If false, no notification is sent.
+        * @return True if this user has the permission in question.
+        */
+       bool HasPrivPermission(const std::string &privstr, bool noisy = false);
+
        /** 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.