]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
irc::tokenstream is a token parser which using std::string and std::vector builds...
[user/henk/code/inspircd.git] / include / users.h
index 7d0864ffa62b9153bbecd39e11a6910e4fb98980..30fa937fb1792dae9b5bdebae1eb0352fee5928f 100644 (file)
  * ---------------------------------------------------
  */
 
-#include "inspircd_config.h" 
-#include "channels.h"
-#include "inspstring.h"
-#include "connection.h"
+#ifndef __USERS_H__ 
+#define __USERS_H__ 
+
 #include <string>
+
 #ifdef THREADED_DNS
 #include <pthread.h>
 #endif
-#ifndef __USERS_H__ 
-#define __USERS_H__ 
 
+#include "inspircd_config.h" 
+#include "socket.h"
+#include "channels.h"
+#include "inspstring.h"
+#include "connection.h"
 #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
+};
+
+enum ClassTypes {
+       CC_ALLOW = 0,
+       CC_DENY  = 1
+};
 
-template<typename T> string ConvToStr(const T &in);
+/** 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.
  */
@@ -107,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
@@ -136,33 +153,33 @@ class userrec : public connection
        /** The host displayed to non-opers (used for cloaking etc).
         * This usually matches the value of userrec::host.
         */
-       char dhost[64];
+       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.
+       /** 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[54];
+       char modes[64];
 
-       /** 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'.
+       /** What snomasks are set on this user.
+        * This functions the same as the above modes.
         */
-       char modebits;
-       
-       std::vector<ucrec*> chans;
+       char snomasks[64];
+
+       UserChanList chans;
        
        /** The server the user is connected to.
         */
-       char* server;
+       const char* server;
        
        /** The user's away message.
         * If this string is empty, the user is not marked as away.
@@ -235,6 +252,8 @@ class userrec : public connection
         */
        long recvqmax;
 
+       /** Default constructor
+        */
        userrec();
        
        /** Returns the full displayed host of the user
@@ -249,6 +268,26 @@ 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* FormatNoticeMasks();
+
+       bool userrec::ProcessNoticeMasks(const char *sm);
+
+       bool IsNoticeMaskSet(unsigned char sm);
+
+       void SetNoticeMask(unsigned char sm, bool value);
+
+       /*
+        * 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.
         */
@@ -332,28 +371,40 @@ class userrec : public connection
         */
        InvitedList* GetInviteList();
 
-       void MakeHost(char* nhost);
-
+       /** 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
 };
 
-class WhoWasGroup
+/** Used to hold WHOWAS information
+ */
+class WhoWasGroup : public classbase
 {
  public:
        char* host;
        char* dhost;
        char* ident;
-       char* server;
+       const char* server;
        char* gecos;
        time_t signon;
 
@@ -364,9 +415,6 @@ class WhoWasGroup
 typedef std::deque<WhoWasGroup*> whowas_set;
 typedef std::map<irc::string,whowas_set*> whowas_users;
 
-/** A lightweight userrec used by WHOWAS
- */
-
 void AddOper(userrec* user);
 void DeleteOper(userrec* user);
 void kill_link(userrec *user,const char* r);
@@ -377,6 +425,15 @@ 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);
-void ReadClassesAndTypes();
+
+/* 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