]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Did some renaming so that the methods for modes in chanrec and userrec are identical.
[user/henk/code/inspircd.git] / include / users.h
index 2c3f2ffc0f7219391be90e96e3e69f6e430d7f72..a7d1c92505cbacb08ff57b517fae7916b0312b28 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>
  * ---------------------------------------------------
  */
 
+#ifndef __USERS_H__ 
+#define __USERS_H__ 
+
+#include <string>
+
+#ifdef THREADED_DNS
+#include <pthread.h>
+#endif
+
 #include "inspircd_config.h" 
+#include "socket.h"
 #include "channels.h"
-#include "connection.h"
 #include "inspstring.h"
-#include <string>
-#ifndef __USERS_H__ 
-#define __USERS_H__ 
-#define STATUS_OP      4
-#define STATUS_HOP     2
-#define STATUS_VOICE   1
-#define STATUS_NORMAL  0
+#include "connection.h"
+#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
+};
 
-#define CC_ALLOW       0
-#define CC_DENY                1
+/** RFC1459 channel modes
+ *  */
+enum UserModes {
+       UM_SERVERNOTICE = 's'-65,
+       UM_WALLOPS = 'w'-65,
+       UM_INVISIBLE = 'i'-65,
+       UM_OPERATOR = 'o'-65,
+};
 
 /** Holds a channel name to which a user has been invited.
  */
 class Invited : public classbase
 {
  public:
-       char channel[CHANMAX];
+        irc::string channel;
 };
 
 
@@ -56,13 +77,13 @@ 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
         */
@@ -75,17 +96,17 @@ 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()
+       ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
        {
-               registration_timeout = 0;
-               flood = 0;
-               pingtime = 0;
-               threshold = 0;
-               sendqmax = 0;
-               recvqmax = 0;
-               strlcpy(host,"",MAXBUF);
-               strlcpy(pass,"",MAXBUF);
        }
 };
 
@@ -99,6 +120,10 @@ typedef std::vector<Invited> InvitedList;
  */
 typedef std::vector<ConnectClass> ClassVector;
 
+/** Typedef for the list of user-channel records for a user
+ */
+typedef std::vector<ucrec*> UserChanList;
+
 /** 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
@@ -121,32 +146,35 @@ 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[IDENTMAX+1];
+       char ident[IDENTMAX+2];
 
        /** The host displayed to non-opers (used for cloaking etc).
         * This usually matches the value of userrec::host.
         */
-       char dhost[160];
+       char dhost[65];
        
        /** The users full name.
         */
        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];
-       
-       ucrec chans[MAXCHANS];
+       /** 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
+        * set, for example, to work out if mode +s is set, we  check the field
+        * userrec::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.
+        */
+       char modes[64];
+
+       UserChanList chans;
        
        /** The server the user is connected to.
         */
-       char server[256];
+       const char* server;
        
        /** The user's away message.
         * If this string is empty, the user is not marked as away.
@@ -184,7 +212,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.
@@ -203,6 +231,10 @@ class userrec : public connection
        time_t reset_due;
        long threshold;
 
+       /** IPV4 ip address
+        */
+       in_addr ip4;
+
        /* Write error string
         */
        std::string WriteError;
@@ -215,10 +247,10 @@ class userrec : public connection
         */
        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.
@@ -231,26 +263,35 @@ class userrec : public connection
         * e.g. through a module, then this method will ignore it and return the true hostname.
         */
        virtual char* GetFullRealHost();
+
+       /*
+        * Create a displayable mode string for this users umodes
+        */
+       const char* FormatModes();
+
+       bool IsModeSet(unsigned char m);
+
+       void SetMode(unsigned char m, bool value);
        
        /** 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.
         */
@@ -263,7 +304,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)
@@ -288,19 +329,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
@@ -314,23 +355,69 @@ 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[16];
-       char dhost[160];
-       char host[160];
-       char fullname[128];
-       char server[256];
+       char* host;
+       char* dhost;
+       char* ident;
+       const 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);
+
+long FindMatchingGlobal(userrec* user);
+long FindMatchingLocal(userrec* user);
+
 #endif