]> 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 f915a6e5f8ebe16cd573158191f49a570eadad59..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 "inspircd_config.h" 
 #include "channels.h"
-#include "connection.h"
 #include "inspstring.h"
+#include "connection.h"
 #include <string>
+#ifdef THREADED_DNS
+#include <pthread.h>
+#endif
  
 #ifndef __USERS_H__ 
 #define __USERS_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
+#include "hashcomp.h"
+#include "cull_list.h"
+
+enum ChanStatus {
+       STATUS_OP     = 4,
+       STATUS_HOP    = 2,
+       STATUS_VOICE  = 1,
+       STATUS_NORMAL = 0
+};
+
+enum ClassTypes {
+       CC_ALLOW = 0,
+       CC_DENY  = 1
+};
 
 /** Holds a channel name to which a user has been invited.
  */
 class Invited : public classbase
 {
  public:
-       char channel[CHANMAX];
+        irc::string channel;
 };
 
 
@@ -47,7 +57,7 @@ class ConnectClass : public classbase
  public:
        /** Type of line, either CC_ALLOW or CC_DENY
         */
-       int type;
+       char type;
        /** Max time to register the connection in seconds
         */
        int registration_timeout;
@@ -56,21 +66,36 @@ class ConnectClass : public classbase
        int flood;
        /** Host mask for this line
         */
-       char host[MAXBUF];
+       std::string host;
        /** Number of seconds between pings for this line
         */
        int pingtime;
        /** (Optional) Password for this line
         */
-       char pass[MAXBUF];
+       std::string pass;
+
+       /** Threshold value for flood disconnect
+        */
+       int threshold;
+
+       /** Maximum size of sendq for users in this class (bytes)
+        */
+       long sendqmax;
+
+       /** 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()
+       ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
        {
-               registration_timeout = 0;
-               flood = 0;
-               pingtime = 0;
-               strlcpy(host,"",MAXBUF);
-               strlcpy(pass,"",MAXBUF);
        }
 };
 
@@ -106,39 +131,45 @@ class userrec : public connection
        char nick[NICKMAX];
        
        /** The users ident reply.
+        * Two characters are added to the user-defined limit to compensate for the tilde etc.
         */
-       char ident[64];
+       char ident[IDENTMAX+2];
 
        /** The host displayed to non-opers (used for cloaking etc).
         * This usually matches the value of userrec::host.
         */
-       char dhost[256];
+       char dhost[64];
        
        /** The users full name.
         */
-       char fullname[128];
+       char fullname[MAXGECOS+1];
        
        /** The user's mode string.
         * This may contain any of the following RFC characters: o, w, s, i
         * Your module may define other mode characters as it sees fit.
+        * it is limited to length 54, as there can only be a maximum of 52
+        * user modes (26 upper, 26 lower case) a null terminating char, and
+        * 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 modes[MAXBUF];
+       char modebits;
        
-       ucrec chans[MAXCHANS];
+       std::vector<ucrec*> chans;
        
        /** The server the user is connected to.
         */
-       char server[256];
+       char* server;
        
        /** The user's away message.
         * If this string is empty, the user is not marked as away.
         */
-       char awaymsg[512];
-       
-       /** Stores the result of the last GetFullHost or GetRealHost call.
-        * You may use this to increase the speed of use of this class.
-        */
-       char result[256];
+       char awaymsg[MAXAWAY+1];
        
        /** Number of lines the user can place into the buffer
         * (up to the global NetBufferSize bytes) before they
@@ -150,7 +181,7 @@ class userrec : public connection
         * If they do not send their details in this time limit they
         * will be disconnected
         */
-       unsigned long timeout;
+       unsigned int timeout;
        
        /** The oper type they logged in as, if they are an oper.
         * This is used to check permissions in operclasses, so that
@@ -165,12 +196,51 @@ class userrec : public connection
 
        /** Number of seconds between PINGs for this user (set from &lt;connect:allow&gt; tag
         */
-       unsigned long pingmax;
+       unsigned int pingmax;
+
+       /** Password specified by the user when they registered.
+        * This is stored even if the <connect> block doesnt need a password, so that
+        * modules may check it.
+        */
+       char password[64];
+
+       /** User's receive queue.
+        * Lines from the IRCd awaiting processing are stored here.
+        * Upgraded april 2005, old system a bit hairy.
+        */
+       std::string recvq;
+
+       /** User's send queue.
+        * Lines waiting to be sent are stored here until their buffer is flushed.
+        */
+       std::string sendq;
+
+       /** Flood counters
+        */
+       int lines_in;
+       time_t reset_due;
+       long threshold;
 
+       /** IPV4 ip address
+        */
+       in_addr ip4;
+
+       /* Write error string
+        */
+       std::string WriteError;
+
+       /** Maximum size this user's sendq can become
+        */
+       long sendqmax;
+
+       /** Maximum size this user's recvq can become
+        */
+       long recvqmax;
+
+       /** Default constructor
+        */
        userrec();
        
-       virtual ~userrec() {  }
-       
        /** Returns the full displayed host of the user
         * This member function returns the hostname of the user as seen by other users
         * on the server, in nick!ident&at;host form.
@@ -186,25 +256,146 @@ class userrec : public connection
        
        /** Returns true if a user is invited to a channel.
         */
-       virtual bool IsInvited(char* channel);
+       virtual bool IsInvited(irc::string &channel);
        
        /** Adds a channel to a users invite list (invites them to a channel)
         */
-       virtual void InviteTo(char* channel);
+       virtual void InviteTo(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.
         */
-       virtual void RemoveInvite(char* channel);
+       virtual void RemoveInvite(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
         * this to their oper classes and checking the commands they can execute.
         */
-       bool HasPermission(char* command);
-       
+       bool HasPermission(const std::string &command);
+
+       /** Calls read() to read some data for this user using their fd.
+        */
+       int ReadData(void* buffer, size_t size);
+
+       /** This method adds data to the buffer of the user.
+        * The buffer can grow to any size within limits of the available memory,
+        * managed by the size of a std::string, however if any individual line in
+        * the buffer grows over 600 bytes in length (which is 88 chars over the
+        * RFC-specified limit per line) then the method will return false and the
+        * text will not be inserted.
+        */
+       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)
+        */
+       bool BufferIsReady();
+
+       /** This function clears the entire buffer by setting it to an empty string.
+        */
+       void ClearBuffer();
+
+       /** This method returns the first available string at the tail end of the buffer
+        * and advances the tail end of the buffer past the string. This means it is
+        * a one way operation in a similar way to strtok(), and multiple calls return
+        * multiple lines if they are available. The results of this function if there
+        * are no lines to be read are unknown, always use BufferIsReady() to check if
+        * it is ok to read the buffer before calling GetBuffer().
+        */
+       std::string GetBuffer();
+
+       /** Sets the write error for a connection. This is done because the actual disconnect
+        * of a client may occur at an inopportune time such as half way through /LIST output.
+        * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
+        * errored clients purged.
+        */
+       void SetWriteError(const std::string &error);
+
+       /** Returns the write error which last occured on this connection or an empty string
+        * if none occured.
+        */
+       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(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
+        * as it possibly can. If the send() call fails to send the entire buffer, the buffer
+        * position is advanced forwards and the rest of the data sent at the next call to
+        * this method.
+        */
+       void FlushWriteBuf();
+
+       /** Returns the list of channels this user has been invited to but has not yet joined.
+        */
+       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
+};
+
+/** Used to hold WHOWAS information
+ */
+class WhoWasGroup
+{
+ public:
+       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 MaintainWhoWas(time_t TIME);
+void AddClient(int socket, int port, bool iscached, in_addr ip4);
+void FullConnectUser(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