]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Provide error output on failure to load a core command; to console on startup, and...
[user/henk/code/inspircd.git] / include / users.h
index d9a5168cca3ef92fb5daa5eb343bbcc292ff286e..0443b24d23493a9e6cef827fe5aa278042956ec7 100644 (file)
 #include "hashcomp.h"
 #include "dns.h"
 
+/** Channel status for a user
+ */
 enum ChanStatus {
+       /** Op */
        STATUS_OP     = 4,
+       /** Halfop */
        STATUS_HOP    = 2,
+       /** Voice */
        STATUS_VOICE  = 1,
+       /** None */
        STATUS_NORMAL = 0
 };
 
+/** connect class types
+ */
 enum ClassTypes {
+       /** connect:allow */
        CC_ALLOW = 0,
+       /** connect:deny */
        CC_DENY  = 1
 };
 
 /** RFC1459 channel modes
- *  */
+ */
 enum UserModes {
-       UM_SERVERNOTICE = 's'-65,
-       UM_WALLOPS = 'w'-65,
-       UM_INVISIBLE = 'i'-65,
-       UM_OPERATOR = 'o'-65,
-       UM_SNOMASK = 'n'-65,
+       /** +s: Server notices */
+       UM_SERVERNOTICE = '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
 };
 
+/** Registration state of a user, e.g.
+ * have they sent USER, NICK, PASS yet?
+ */
 enum RegistrationState {
+
+#ifndef WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
        REG_NONE = 0,           /* Has sent nothing */
+#endif
+
        REG_USER = 1,           /* Has sent USER */
        REG_NICK = 2,           /* Has sent NICK */
        REG_NICKUSER = 3,       /* Bitwise combination of REG_NICK and REG_USER */
        REG_ALL = 7             /* REG_NICKUSER plus next bit along */
 };
 
+/* Required forward declaration */
 class InspIRCd;
 
 /** Derived from Resolver, and performs user forward/reverse lookups.
  */
-class UserResolver : public Resolver
+class CoreExport UserResolver : public Resolver
 {
  private:
        /** User this class is 'attached' to.
         */
        userrec* bound_user;
+       /** File descriptor teh lookup is bound to
+        */
        int bound_fd;
+       /** True if the lookup is forward, false if is a reverse lookup
+        */
        bool fwd;
  public:
+       /** Create a resolver.
+        * @param Instance The creating instance
+        * @param user The user to begin lookup on
+        * @param to_resolve The IP or host to resolve
+        * @param qt The query type
+        * @param cache Modified by the constructor if the result was cached
+        */
        UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
 
+       /** Called on successful lookup
+        * @param result Result string
+        * @param ttl Time to live for result
+        * @param cached True if the result was found in the cache
+        */
        void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
+
+       /** Called on failed lookup
+        * @param e Error code
+        * @param errormessage Error message string
+        */
        void OnError(ResolverError e, const std::string &errormessage);
 };
 
 
 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
  */
-class ConnectClass : public classbase
+class CoreExport ConnectClass : public classbase
 {
  private:
        /** Type of line, either CC_ALLOW or CC_DENY
@@ -116,6 +160,9 @@ class ConnectClass : public classbase
        /** Global max when connecting by this connection class
         */
        unsigned long maxglobal;
+       /** Port number this connect class applies to
+        */
+       int port;
 
 public:
 
@@ -138,15 +185,15 @@ public:
         */
        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) :
+                       unsigned long maxl, unsigned long maxg, int p = 0) :
                        type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
-                       threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
+                       threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
 
        /** 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) { }
+                       pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
 
        /** Returns the type, CC_ALLOW or CC_DENY
         */
@@ -176,6 +223,11 @@ public:
                return host;
        }
 
+       int GetPort()
+       {
+               return port;
+       }
+
        /** Returns the ping frequency
         */
        unsigned int GetPingTime()
@@ -215,14 +267,14 @@ public:
         */
        unsigned long GetMaxLocal()
        {
-               return (maxlocal ? maxlocal : 1);
+               return maxlocal;
        }
 
        /** Returns the maximum number of global sessions
         */
        unsigned long GetMaxGlobal()
        {
-               return (maxglobal ? maxglobal : 1);
+               return maxglobal;
        }
 };
 
@@ -237,8 +289,36 @@ typedef std::vector<ConnectClass> ClassVector;
 /** Typedef for the list of user-channel records for a user
  */
 typedef std::map<chanrec*, char> UserChanList;
+
+/** Shorthand for an iterator into a UserChanList
+ */
 typedef UserChanList::iterator UCListIter;
 
+/* Required forward declaration
+ */
+class userrec;
+
+/** Visibility data for a user.
+ * If a user has a non-null instance of this class in their userrec,
+ * then it is used to determine if this user is visible to other users
+ * or not.
+ */
+class CoreExport VisData
+{
+ public:
+       /** Create a visdata
+        */
+       VisData();
+       /** Destroy a visdata
+        */
+       virtual ~VisData();
+       /** Is this user visible to some other user?
+        * @param user The other user to compare to
+        * @return true True if the user is visible to the other user, false if not
+        */
+       virtual bool VisibleTo(userrec* user);
+};
+
 /** Holds all information about a user
  * This class stores all information about a user connected to the irc server. Everything about a
  * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
@@ -246,7 +326,7 @@ typedef UserChanList::iterator UCListIter;
  * by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
  * file descriptor value.
  */
-class userrec : public connection
+class CoreExport userrec : public connection
 {
  private:
        /** Pointer to creator.
@@ -276,6 +356,9 @@ class userrec : public connection
        /** Cached nick!ident@host value using the masked hostname
         */
        char* cached_makehost;
+
+       /** Cached nick!ident@realhost value using the real hostname
+        */
        char* cached_fullrealhost;
 
        /** When we erase the user (in the destructor),
@@ -284,6 +367,8 @@ class userrec : public connection
         */
        void DecrementModes();
 
+       /** Oper-only quit message for this user if non-null
+        */
        char* operquit;
 
  public:
@@ -300,6 +385,10 @@ class userrec : public connection
         */
        UserResolver* res_reverse;
 
+       /** User visibility state, see definition of VisData.
+        */
+       VisData* Visibility;
+
        /** Stored reverse lookup from res_forward
         */
        std::string stored_host;
@@ -688,6 +777,10 @@ class userrec : public connection
         */
        void Oper(const std::string &opertype);
 
+       /** Call this method to find the matching <connect> for a user, and to check them against it.
+        */
+       void CheckClass();
+
        /** Use this method to fully connect a user.
         * This will send the message of the day, check G/K/E lines, etc.
         */
@@ -737,6 +830,12 @@ class userrec : public connection
         */
        unsigned long LocalCloneCount();
 
+       /** Remove all clone counts from the user, you should
+        * use this if you change the user's IP address in
+        * userrec::ip after they have registered.
+        */
+       void RemoveCloneCounts();
+
        /** Write text to this user, appending CR/LF.
         * @param text A std::string to send to the user
         */
@@ -807,6 +906,11 @@ class userrec : public connection
         */
        void WriteCommonExcept(const std::string &text);
 
+       /** Write a quit message to all common users, as in userrec::WriteCommonExcept but with a specific
+        * quit message for opers only.
+        * @param normal_text Normal user quit message
+        * @param oper_text Oper only quit message
+        */
        void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
 
        /** Write a WALLOPS message from this user to all local opers.
@@ -903,6 +1007,9 @@ class userrec : public connection
         */
        void SetOperQuit(const std::string &oquit);
 
+       /** Get oper-specific quit message shown only to opers when the user quits.
+        * (overrides any sent by QuitUser)
+        */
        const char* GetOperQuit();
 
        /** Handle socket event.
@@ -921,3 +1028,4 @@ class userrec : public connection
 class ServerConfig;
 
 #endif
+