6 #include "inspircd_config.h"
8 #include "connection.h"
17 #define STATUS_VOICE 1
18 #define STATUS_NORMAL 0
23 /** Holds a channel name to which a user has been invited.
25 class Invited : public classbase
28 char channel[CHANMAX];
32 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
34 class ConnectClass : public classbase
38 int registration_timeout;
44 registration_timeout = 0;
50 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
52 typedef std::vector<Invited> InvitedList;
56 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
58 typedef std::vector<ConnectClass> ClassVector;
60 /** Holds all information about a user
61 * This class stores all information about a user connected to the irc server. Everything about a
62 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
63 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
66 class userrec : public connection
70 /** A list of channels the user has a pending invite to.
75 /** The users nickname.
76 * An invalid nickname indicates an unregistered connection prior to the NICK command.
81 /** The users ident reply.
85 /** The host displayed to non-opers (used for cloaking etc).
86 * This usually matches the value of userrec::host.
90 /** The users full name.
94 /** The user's mode string.
95 * This may contain any of the following RFC characters: o, w, s, i
96 * Your module may define other mode characters as it sees fit.
100 ucrec chans[MAXCHANS];
102 /** The server the user is connected to.
106 /** The user's away message.
107 * If this string is empty, the user is not marked as away.
111 /** Stores the result of the last GetFullHost or GetRealHost call.
112 * You may use this to increase the speed of use of this class.
118 virtual ~userrec() { }
120 /** Returns the full displayed host of the user
121 * This member function returns the hostname of the user as seen by other users
122 * on the server, in nick!ident&at;host form.
124 virtual char* GetFullHost();
126 /** Returns the full real host of the user
127 * This member function returns the hostname of the user as seen by other users
128 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
129 * e.g. through a module, then this method will ignore it and return the true hostname.
131 virtual char* GetFullRealHost();
133 /** Returns true if a user is invited to a channel.
135 virtual bool IsInvited(char* channel);
137 /** Adds a channel to a users invite list (invites them to a channel)
139 virtual void InviteTo(char* channel);
141 /** Removes a channel from a users invite list.
142 * This member function is called on successfully joining an invite only channel
143 * to which the user has previously been invited, to clear the invitation.
145 virtual void RemoveInvite(char* channel);