]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Documentation change to indicate errno is valid on return from the constructor -...
[user/henk/code/inspircd.git] / include / users.h
index 1dc0aa43e60e3bb87b093679a8566b22c4e4b508..bfe21f116500e7ddbee7ae6a70bdbc773915d90f 100644 (file)
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -57,14 +54,6 @@ enum RegistrationState {
        REG_ALL = 7             /* REG_NICKUSER plus next bit along */
 };
 
-/** Holds a channel name to which a user has been invited.
- */
-class Invited : public classbase
-{
- public:
-        irc::string channel;
-};
-
 class InspIRCd;
 
 /** Derived from Resolver, and performs user forward/reverse lookups.
@@ -78,9 +67,9 @@ class UserResolver : public Resolver
        int bound_fd;
        bool fwd;
  public:
-       UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, bool forward);
+       UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
 
-       void OnLookupComplete(const std::string &result);
+       void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
        void OnError(ResolverError e, const std::string &errormessage);
 };
 
@@ -89,56 +78,158 @@ class UserResolver : public Resolver
  */
 class ConnectClass : public classbase
 {
- public:
+ private:
        /** Type of line, either CC_ALLOW or CC_DENY
         */
        char type;
        /** Max time to register the connection in seconds
         */
-       int registration_timeout;
+       unsigned int registration_timeout;
        /** Number of lines in buffer before excess flood is triggered
         */
-       int flood;
+       unsigned int flood;
        /** Host mask for this line
         */
        std::string host;
        /** Number of seconds between pings for this line
         */
-       int pingtime;
+       unsigned int pingtime;
        /** (Optional) Password for this line
         */
        std::string pass;
 
        /** Threshold value for flood disconnect
         */
-       int threshold;
+       unsigned int threshold;
 
        /** Maximum size of sendq for users in this class (bytes)
         */
-       long sendqmax;
+       unsigned long sendqmax;
 
        /** Maximum size of recvq for users in this class (bytes)
         */
-       long recvqmax;
+       unsigned long recvqmax;
 
        /** Local max when connecting by this connection class
         */
-       long maxlocal;
+       unsigned long maxlocal;
 
        /** Global max when connecting by this connection class
         */
-       long maxglobal;
-       
-       ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
+       unsigned long maxglobal;
+
+public:
+
+       /** Create a new connect class with no settings.
+        */
+       ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
+                       threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+
+       /** Create a new connect class to ALLOW connections.
+        * @param timeout The registration timeout
+        * @param fld The flood value
+        * @param hst The IP mask to allow
+        * @param ping The ping frequency
+        * @param pas The password to be used
+        * @param thres The flooding threshold
+        * @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(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) :
+                       type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
+                       threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
+
+       /** Create a new connect class to DENY  connections
+        * @param hst The IP mask to deny
+        */
+       ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
+                       pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+
+       /** Returns the type, CC_ALLOW or CC_DENY
+        */
+       char GetType()
+       {
+               return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
+       }
+
+       /** Returns the registration timeout
+        */
+       unsigned int GetRegTimeout()
+       {
+               return (registration_timeout ? registration_timeout : 90);
+       }
+
+       /** Returns the flood limit
+        */
+       unsigned int GetFlood()
+       {
+               return (threshold ? flood : 999);
+       }
+
+       /** Returns the allowed or denied IP mask
+        */
+       const std::string& GetHost()
+       {
+               return host;
+       }
+
+       /** Returns the ping frequency
+        */
+       unsigned int GetPingTime()
+       {
+               return (pingtime ? pingtime : 120);
+       }
+
+       /** Returns the password or an empty string
+        */
+       const std::string& GetPass()
+       {
+               return pass;
+       }
+
+       /** Returns the flood threshold value
+        */
+       unsigned int GetThreshold()
        {
+               return (threshold ? threshold : 1);
+       }
+
+       /** Returns the maximum sendq value
+        */
+       unsigned long GetSendqMax()
+       {
+               return (sendqmax ? sendqmax : 262114);
+       }
+
+       /** Returns the maximum recvq value
+        */
+       unsigned long GetRecvqMax()
+       {
+               return (recvqmax ? recvqmax : 4096);
+       }
+
+       /** Returusn the maximum number of local sessions
+        */
+       unsigned long GetMaxLocal()
+       {
+               return (maxlocal ? maxlocal : 1);
+       }
+
+       /** Returns the maximum number of global sessions
+        */
+       unsigned long GetMaxGlobal()
+       {
+               return (maxglobal ? maxglobal : 1);
        }
 };
 
 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
  */
-typedef std::vector<Invited> InvitedList;
-
-
+typedef std::vector<irc::string> InvitedList;
 
 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
  */
@@ -146,7 +237,8 @@ typedef std::vector<ConnectClass> ClassVector;
 
 /** Typedef for the list of user-channel records for a user
  */
-typedef std::vector<ucrec*> UserChanList;
+typedef std::map<chanrec*, char> UserChanList;
+typedef UserChanList::iterator UCListIter;
 
 /** Holds all information about a user
  * This class stores all information about a user connected to the irc server. Everything about a
@@ -173,6 +265,25 @@ class userrec : public connection
        /** Number of channels this user is currently on
         */
        unsigned int ChannelCount;
+
+       /** Cached nick!ident@host value using the real hostname
+        */
+       char* cached_fullhost;
+
+       /** Cached nick!ident@ip value using the real IP address
+        */
+       char* cached_hostip;
+
+       /** Cached nick!ident@host value using the masked hostname
+        */
+       char* cached_makehost;
+       char* cached_fullrealhost;
+
+       /** When we erase the user (in the destructor),
+        * we call this method to subtract one from all
+        * mode characters this user is making use of.
+        */
+       void DecrementModes();
  public:
        /** Resolvers for looking up this users IP address
         * This will occur if and when res_reverse completes.
@@ -252,11 +363,11 @@ class userrec : public connection
         */
        int flood;
        
-       /** Number of seconds this user is given to send USER/NICK
-        * If they do not send their details in this time limit they
-        * will be disconnected
+       /** Timestamp of current time + connection class timeout.
+        * This user must send USER/NICK before this timestamp is
+        * reached or they will be disconnected.
         */
-       unsigned int timeout;
+       time_t timeout;
        
        /** The oper type they logged in as, if they are an oper.
         * This is used to check permissions in operclasses, so that
@@ -304,7 +415,8 @@ class userrec : public connection
         */
        long threshold;
 
-       /** IPV4 or IPV6 ip address
+       /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
+        * GetIPString/GetPort to obtain its values.
         */
        sockaddr* ip;
 
@@ -340,14 +452,24 @@ class userrec : public connection
         */
        std::string WriteError;
 
-       /** Maximum size this user's sendq can become
+       /** Maximum size this user's sendq can become.
+        * Copied from the connect class on connect.
         */
        long sendqmax;
 
-       /** Maximum size this user's recvq can become
+       /** Maximum size this user's recvq can become.
+        * Copied from the connect class on connect.
         */
        long recvqmax;
 
+       /** This is true if the user matched an exception when they connected to the ircd.
+        * It isnt valid after this point, and you should not attempt to do anything with it
+        * after this point, because the eline might be removed at a later time, and/or no
+        * longer be applicable to this user. It is only used to save doing the eline lookup
+        * twice (instead we do it once and set this value).
+        */
+       bool exempt;
+
        /** Default constructor
         * @throw Nothing at present
         */
@@ -368,6 +490,11 @@ class userrec : public connection
         */
        virtual char* 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.
+        */
+       void InvalidateCache();
+
        /** Create a displayable mode string for this users snomasks
         * @return The notice mask character sequence
         */
@@ -414,19 +541,19 @@ class userrec : public connection
         * @param channel A channel name to look up
         * @return True if the user is invited to the given channel
         */
-       virtual bool IsInvited(irc::string &channel);
+       virtual bool IsInvited(const irc::string &channel);
        
        /** Adds a channel to a users invite list (invites them to a channel)
         * @param channel A channel name to add
         */
-       virtual void InviteTo(irc::string &channel);
+       virtual void InviteTo(const irc::string &channel);
        
        /** Removes a channel from a users invite list.
         * This member function is called on successfully joining an invite only channel
         * to which the user has previously been invited, to clear the invitation.
         * @param channel The channel to remove the invite to
         */
-       virtual void RemoveInvite(irc::string &channel);
+       virtual void RemoveInvite(const irc::string &channel);
        
        /** Returns true or false for if a user can execute a privilaged oper command.
         * This is done by looking up their oper type from userrec::oper, then referencing
@@ -515,11 +642,17 @@ class userrec : public connection
         */
        char* MakeWildHost();
 
-       /** Creates a host.
-        * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
-        * @param Buffer to fill with host information
+       /** Creates a usermask with real host.
+        * 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
         */
-       void MakeHost(char* nhost);
+       char* 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();
 
        /** Shuts down and closes the user's socket
         * This will not cause the user to be deleted. Use InspIRCd::QuitUser for this,
@@ -591,12 +724,12 @@ class userrec : public connection
        /** Return the number of global clones of this user
         * @return The global clone count of this user
         */
-       long GlobalCloneCount();
+       unsigned long GlobalCloneCount();
 
        /** Return the number of local clones of this user
         * @return The local clone count of this user
         */
-       long LocalCloneCount();
+       unsigned long LocalCloneCount();
 
        /** Write text to this user, appending CR/LF.
         * @param text A std::string to send to the user
@@ -715,17 +848,6 @@ class userrec : public connection
         */
        bool ChangeName(const char* gecos);
 
-       /** Return the total number of channels this user is on.
-        * @return The number of channels the user is on
-        */
-       int CountChannels();
-
-       /** Modify the number of channels this user is on (used by CountChannels).
-        * Pass a positive number to increment the counter, or a negative number
-        * to decrement it.
-        */
-       void ModChannelCount(int n);
-
        /** Send a notice to all local users from this user
         * @param text The text format string to send
         * @param ... Format arguments
@@ -754,7 +876,7 @@ class userrec : public connection
        /** Get the connect class which matches this user's host or IP address
         * @return A reference to this user's connect class
         */
-       ConnectClass& GetClass();
+       ConnectClass* GetClass();
 
        /** Show the message of the day to this user
         */
@@ -766,74 +888,17 @@ class userrec : public connection
 
        /** Handle socket event.
         * From EventHandler class.
+        * @param et Event type
+        * @param errornum Error number for EVENT_ERROR events
         */
-       void HandleEvent(EventType et);
+       void HandleEvent(EventType et, int errornum = 0);
 
        /** Default destructor
         */
        virtual ~userrec();
 };
 
-
-namespace irc
-{
-       /** Holds whowas related functions and classes
-        */
-       namespace whowas
-       {
-
-               /** Used to hold WHOWAS information
-                */
-               class WhoWasGroup : public classbase
-               {
-                public:
-                       /** Real host
-                        */
-                       char* host;
-                       /** Displayed host
-                        */
-                       char* dhost;
-                       /** Ident
-                        */
-                       char* ident;
-                       /** Server name
-                        */
-                       const char* server;
-                       /** Fullname (GECOS)
-                        */
-                       char* gecos;
-                       /** Signon time
-                        */
-                       time_t signon;
-       
-                       /** Initialize this WhoQasFroup with a user
-                        */
-                       WhoWasGroup(userrec* user);
-                       /** Destructor
-                        */
-                       ~WhoWasGroup();
-               };
-
-               /** A group of users related by nickname
-                */
-               typedef std::deque<WhoWasGroup*> whowas_set;
-
-               /** Sets of users in the whowas system
-                */
-               typedef std::map<irc::string,whowas_set*> whowas_users;
-
-               /** Called every hour by the core to remove expired entries
-                */
-               void MaintainWhoWas(InspIRCd* ServerInstance, time_t TIME);
-       };
-};
-
 /* Configuration callbacks */
 class ServerConfig;
-bool InitTypes(ServerConfig* conf, const char* tag);
-bool InitClasses(ServerConfig* conf, const char* tag);
-bool DoType(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoClass(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoneClassesAndTypes(ServerConfig* conf, const char* tag);
 
 #endif