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
42 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
44 typedef std::vector<Invited> InvitedList;
48 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
50 typedef std::vector<ConnectClass> ClassVector;
52 /** Holds all information about a user
53 * This class stores all information about a user connected to the irc server. Everything about a
54 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
55 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
58 class userrec : public connection
62 /** A list of channels the user has a pending invite to.
67 /** The users nickname.
68 * An invalid nickname indicates an unregistered connection prior to the NICK command.
73 /** The users ident reply.
77 /** The host displayed to non-opers (used for cloaking etc).
78 * This usually matches the value of userrec::host.
82 /** The users full name.
86 /** The user's mode string.
87 * This may contain any of the following RFC characters: o, w, s, i
88 * Your module may define other mode characters as it sees fit.
92 ucrec chans[MAXCHANS];
94 /** The server the user is connected to.
98 /** The user's away message.
99 * If this string is empty, the user is not marked as away.
103 /** Stores the result of the last GetFullHost or GetRealHost call.
104 * You may use this to increase the speed of use of this class.
110 virtual ~userrec() { }
112 /** Returns the full displayed host of the user
113 * This member function returns the hostname of the user as seen by other users
114 * on the server, in nick!ident&at;host form.
116 virtual char* GetFullHost();
118 /** Returns the full real host of the user
119 * This member function returns the hostname of the user as seen by other users
120 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
121 * e.g. through a module, then this method will ignore it and return the true hostname.
123 virtual char* GetFullRealHost();
125 /** Returns true if a user is invited to a channel.
127 virtual bool IsInvited(char* channel);
129 /** Adds a channel to a users invite list (invites them to a channel)
131 virtual void InviteTo(char* channel);
133 /** Removes a channel from a users invite list.
134 * This member function is called on successfully joining an invite only channel
135 * to which the user has previously been invited, to clear the invitation.
137 virtual void RemoveInvite(char* channel);