1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #include "inspircd_config.h"
19 #include "inspstring.h"
27 #define STATUS_VOICE 1
28 #define STATUS_NORMAL 0
33 /** Holds a channel name to which a user has been invited.
35 class Invited : public classbase
38 char channel[CHANMAX];
42 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
44 class ConnectClass : public classbase
47 /** Type of line, either CC_ALLOW or CC_DENY
50 /** Max time to register the connection in seconds
52 int registration_timeout;
53 /** Number of lines in buffer before excess flood is triggered
56 /** Host mask for this line
59 /** Number of seconds between pings for this line
62 /** (Optional) Password for this line
66 /** Threshold value for flood disconnect
70 /** Maximum size of sendq for users in this class (bytes)
74 /** Maximum size of recvq for users in this class (bytes)
80 registration_timeout = 0;
86 strlcpy(host,"",MAXBUF);
87 strlcpy(pass,"",MAXBUF);
91 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
93 typedef std::vector<Invited> InvitedList;
97 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
99 typedef std::vector<ConnectClass> ClassVector;
101 /** Holds all information about a user
102 * This class stores all information about a user connected to the irc server. Everything about a
103 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
104 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
107 class userrec : public connection
111 /** A list of channels the user has a pending invite to.
116 /** The users nickname.
117 * An invalid nickname indicates an unregistered connection prior to the NICK command.
122 /** The users ident reply.
123 * Two characters are added to the user-defined limit to compensate for the tilde etc.
125 char ident[IDENTMAX+2];
127 /** The host displayed to non-opers (used for cloaking etc).
128 * This usually matches the value of userrec::host.
132 /** The users full name.
134 char fullname[MAXGECOS+1];
136 /** The user's mode string.
137 * This may contain any of the following RFC characters: o, w, s, i
138 * Your module may define other mode characters as it sees fit.
139 * it is limited to length 54, as there can only be a maximum of 52
140 * user modes (26 upper, 26 lower case) a null terminating char, and
141 * an optional + character.
145 ucrec chans[MAXCHANS];
147 /** The server the user is connected to.
151 /** The user's away message.
152 * If this string is empty, the user is not marked as away.
154 char awaymsg[MAXAWAY+1];
156 /** Number of lines the user can place into the buffer
157 * (up to the global NetBufferSize bytes) before they
158 * are disconnected for excess flood
162 /** Number of seconds this user is given to send USER/NICK
163 * If they do not send their details in this time limit they
164 * will be disconnected
166 unsigned int timeout;
168 /** The oper type they logged in as, if they are an oper.
169 * This is used to check permissions in operclasses, so that
170 * we can say 'yay' or 'nay' to any commands they issue.
171 * The value of this is the value of a valid 'type name=' tag.
175 /** True when DNS lookups are completed.
179 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
181 unsigned int pingmax;
183 /** Password specified by the user when they registered.
184 * This is stored even if the <connect> block doesnt need a password, so that
185 * modules may check it.
187 char password[MAXBUF];
189 /** User's receive queue.
190 * Lines from the IRCd awaiting processing are stored here.
191 * Upgraded april 2005, old system a bit hairy.
195 /** User's send queue.
196 * Lines waiting to be sent are stored here until their buffer is flushed.
206 /* Write error string
208 std::string WriteError;
210 /** Maximum size this user's sendq can become
214 /** Maximum size this user's recvq can become
220 virtual ~userrec() { }
222 /** Returns the full displayed host of the user
223 * This member function returns the hostname of the user as seen by other users
224 * on the server, in nick!ident&at;host form.
226 virtual char* GetFullHost();
228 /** Returns the full real host of the user
229 * This member function returns the hostname of the user as seen by other users
230 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
231 * e.g. through a module, then this method will ignore it and return the true hostname.
233 virtual char* GetFullRealHost();
235 /** Returns true if a user is invited to a channel.
237 virtual bool IsInvited(char* channel);
239 /** Adds a channel to a users invite list (invites them to a channel)
241 virtual void InviteTo(char* channel);
243 /** Removes a channel from a users invite list.
244 * This member function is called on successfully joining an invite only channel
245 * to which the user has previously been invited, to clear the invitation.
247 virtual void RemoveInvite(char* channel);
249 /** Returns true or false for if a user can execute a privilaged oper command.
250 * This is done by looking up their oper type from userrec::oper, then referencing
251 * this to their oper classes and checking the commands they can execute.
253 bool HasPermission(char* command);
255 /** Calls read() to read some data for this user using their fd.
257 int ReadData(void* buffer, size_t size);
259 /** This method adds data to the buffer of the user.
260 * The buffer can grow to any size within limits of the available memory,
261 * managed by the size of a std::string, however if any individual line in
262 * the buffer grows over 600 bytes in length (which is 88 chars over the
263 * RFC-specified limit per line) then the method will return false and the
264 * text will not be inserted.
266 bool AddBuffer(std::string a);
268 /** This method returns true if the buffer contains at least one carriage return
269 * character (e.g. one complete line may be read)
271 bool BufferIsReady();
273 /** This function clears the entire buffer by setting it to an empty string.
277 /** This method returns the first available string at the tail end of the buffer
278 * and advances the tail end of the buffer past the string. This means it is
279 * a one way operation in a similar way to strtok(), and multiple calls return
280 * multiple lines if they are available. The results of this function if there
281 * are no lines to be read are unknown, always use BufferIsReady() to check if
282 * it is ok to read the buffer before calling GetBuffer().
284 std::string GetBuffer();
286 /** Sets the write error for a connection. This is done because the actual disconnect
287 * of a client may occur at an inopportune time such as half way through /LIST output.
288 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
289 * errored clients purged.
291 void SetWriteError(std::string error);
293 /** Returns the write error which last occured on this connection or an empty string
296 std::string GetWriteError();
298 /** Adds to the user's write buffer.
299 * You may add any amount of text up to this users sendq value, if you exceed the
300 * sendq value, SetWriteError() will be called to set the users error string to
301 * "SendQ exceeded", and further buffer adds will be dropped.
303 void AddWriteBuf(std::string data);
305 /** Flushes as much of the user's buffer to the file descriptor as possible.
306 * This function may not always flush the entire buffer, rather instead as much of it
307 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
308 * position is advanced forwards and the rest of the data sent at the next call to
311 void FlushWriteBuf();
313 /** Returns the list of channels this user has been invited to but has not yet joined.
315 InvitedList* GetInviteList();
317 /** Shuts down and closes the user's socket
322 /** A lightweight userrec used by WHOWAS
328 char ident[IDENTMAX+1];
331 char fullname[MAXGECOS+1];