]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Commented a lot of stuff that hasnt been commented since 1.0.2
[user/henk/code/inspircd.git] / include / users.h
index 43150d16968dace908088ab0590ea5b84f51163e..a5cba44b62f791c9152d8ff3478edd874abd654a 100644 (file)
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
  *                       E-mail:
  *                <brain@chatspike.net>
  *               <Craig@chatspike.net>
 
 #include "hashcomp.h"
 #include "cull_list.h"
-#define STATUS_OP      4
-#define STATUS_HOP     2
-#define STATUS_VOICE   1
-#define STATUS_NORMAL  0
 
-#define CC_ALLOW       0
-#define CC_DENY                1
+enum ChanStatus {
+       STATUS_OP     = 4,
+       STATUS_HOP    = 2,
+       STATUS_VOICE  = 1,
+       STATUS_NORMAL = 0
+};
 
-template<typename T> inline string ConvToStr(const T &in);
+enum ClassTypes {
+       CC_ALLOW = 0,
+       CC_DENY  = 1
+};
 
 /** Holds a channel name to which a user has been invited.
  */
@@ -83,6 +85,14 @@ class ConnectClass : public classbase
        /** Maximum size of recvq for users in this class (bytes)
         */
        long recvqmax;
+
+       /** Local max when connecting by this connection class
+        */
+       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)
        {
@@ -128,7 +138,7 @@ class userrec : public connection
        /** The host displayed to non-opers (used for cloaking etc).
         * This usually matches the value of userrec::host.
         */
-       char dhost[160];
+       char dhost[64];
        
        /** The users full name.
         */
@@ -142,8 +152,15 @@ class userrec : public connection
         * an optional + character.
         */
        char modes[54];
+
+       /** This contains a bitmask of the RFC modes +swi,
+        * which can be used for fast lookup when iterating all the users.
+        * It is maintained by the mode parser and matches the character
+        * modes stored in 'modes'.
+        */
+       char modebits;
        
-       std::vector<ucrec> chans;
+       std::vector<ucrec*> chans;
        
        /** The server the user is connected to.
         */
@@ -185,7 +202,7 @@ class userrec : public connection
         * This is stored even if the <connect> block doesnt need a password, so that
         * modules may check it.
         */
-       char password[MAXBUF];
+       char password[64];
 
        /** User's receive queue.
         * Lines from the IRCd awaiting processing are stored here.
@@ -204,6 +221,10 @@ class userrec : public connection
        time_t reset_due;
        long threshold;
 
+       /** IPV4 ip address
+        */
+       in_addr ip4;
+
        /* Write error string
         */
        std::string WriteError;
@@ -216,6 +237,8 @@ class userrec : public connection
         */
        long recvqmax;
 
+       /** Default constructor
+        */
        userrec();
        
        /** Returns the full displayed host of the user
@@ -249,7 +272,7 @@ class userrec : public connection
         * This is done by looking up their oper type from userrec::oper, then referencing
         * this to their oper classes and checking the commands they can execute.
         */
-       bool HasPermission(std::string &command);
+       bool HasPermission(const std::string &command);
 
        /** Calls read() to read some data for this user using their fd.
         */
@@ -262,7 +285,7 @@ class userrec : public connection
         * RFC-specified limit per line) then the method will return false and the
         * text will not be inserted.
         */
-       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)
@@ -287,19 +310,19 @@ class userrec : public connection
         * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
         * errored clients purged.
         */
-       void SetWriteError(std::string error);
+       void SetWriteError(const std::string &error);
 
        /** Returns the write error which last occured on this connection or an empty string
         * if none occured.
         */
-       std::string GetWriteError();
+       const char* GetWriteError();
 
        /** Adds to the user's write buffer.
         * You may add any amount of text up to this users sendq value, if you exceed the
         * sendq value, SetWriteError() will be called to set the users error string to
         * "SendQ exceeded", and further buffer adds will be dropped.
         */
-       void AddWriteBuf(std::string data);
+       void AddWriteBuf(const std::string &data);
 
        /** Flushes as much of the user's buffer to the file descriptor as possible.
         * This function may not always flush the entire buffer, rather instead as much of it
@@ -313,40 +336,66 @@ class userrec : public connection
         */
        InvitedList* GetInviteList();
 
+       /** Creates a wildcard host.
+        * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
+        */
+       char* MakeWildHost();
+
+       /** Creates a host.
+        * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
+        */
+       void MakeHost(char* nhost);
+
        /** Shuts down and closes the user's socket
         */
        void CloseSocket();
 
+       /** Default destructor
+        */
        virtual ~userrec();
 
 #ifdef THREADED_DNS
+       /** Thread used for threaded lookups
+        */
        pthread_t dnsthread;
 #endif
 };
 
-/** A lightweight userrec used by WHOWAS
+/** Used to hold WHOWAS information
  */
-class WhoWasUser
+class WhoWasGroup
 {
  public:
-       char nick[NICKMAX];
-       char ident[IDENTMAX+1];
-       char dhost[160];
-       char host[160];
-       char fullname[MAXGECOS+1];
-       char server[256];
+       char* host;
+       char* dhost;
+       char* ident;
+       char* server;
+       char* gecos;
        time_t signon;
+
+       WhoWasGroup(userrec* user);
+       ~WhoWasGroup();
 };
 
+typedef std::deque<WhoWasGroup*> whowas_set;
+typedef std::map<irc::string,whowas_set*> whowas_users;
+
 void AddOper(userrec* user);
 void DeleteOper(userrec* user);
 void kill_link(userrec *user,const char* r);
 void kill_link_silent(userrec *user,const char* r);
 void AddWhoWas(userrec* u);
-void AddClient(int socket, char* host, int port, bool iscached, char* ip);
+void MaintainWhoWas(time_t TIME);
+void AddClient(int socket, int port, bool iscached, in_addr ip4);
 void FullConnectUser(userrec* user, CullList* Goners);
-//void ConnectUser(userrec *user, CullList* Goners);
 userrec* ReHashNick(char* Old, char* New);
 void force_nickchange(userrec* user,const char* newnick);
 
+/* Configuration callbacks */
+bool InitTypes(const char* tag);
+bool InitClasses(const char* tag);
+bool DoType(const char* tag, char** entries, void** values, int* types);
+bool DoClass(const char* tag, char** entries, void** values, int* types);
+bool DoneClassesAndTypes(const char* tag);
+
 #endif