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"
20 #include "connection.h"
28 #define STATUS_VOICE 1
29 #define STATUS_NORMAL 0
34 /** Holds a channel name to which a user has been invited.
36 class Invited : public classbase
39 char channel[CHANMAX];
43 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
45 class ConnectClass : public classbase
48 /** Type of line, either CC_ALLOW or CC_DENY
51 /** Max time to register the connection in seconds
53 int registration_timeout;
54 /** Number of lines in buffer before excess flood is triggered
57 /** Host mask for this line
60 /** Number of seconds between pings for this line
63 /** (Optional) Password for this line
67 /** Threshold value for flood disconnect
71 /** Maximum size of sendq for users in this class (bytes)
75 /** Maximum size of recvq for users in this class (bytes)
81 registration_timeout = 0;
87 strlcpy(host,"",MAXBUF);
88 strlcpy(pass,"",MAXBUF);
92 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
94 typedef std::vector<Invited> InvitedList;
98 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
100 typedef std::vector<ConnectClass> ClassVector;
102 /** Holds all information about a user
103 * This class stores all information about a user connected to the irc server. Everything about a
104 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
105 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
108 class userrec : public connection
112 /** A list of channels the user has a pending invite to.
117 /** The users nickname.
118 * An invalid nickname indicates an unregistered connection prior to the NICK command.
123 /** The users ident reply.
124 * Two characters are added to the user-defined limit to compensate for the tilde etc.
126 char ident[IDENTMAX+2];
128 /** The host displayed to non-opers (used for cloaking etc).
129 * This usually matches the value of userrec::host.
133 /** The users full name.
135 char fullname[MAXGECOS+1];
137 /** The user's mode string.
138 * This may contain any of the following RFC characters: o, w, s, i
139 * Your module may define other mode characters as it sees fit.
140 * it is limited to length 54, as there can only be a maximum of 52
141 * user modes (26 upper, 26 lower case) a null terminating char, and
142 * an optional + character.
146 ucrec chans[MAXCHANS];
148 /** The server the user is connected to.
152 /** The user's away message.
153 * If this string is empty, the user is not marked as away.
155 char awaymsg[MAXAWAY+1];
157 /** Number of lines the user can place into the buffer
158 * (up to the global NetBufferSize bytes) before they
159 * are disconnected for excess flood
163 /** Number of seconds this user is given to send USER/NICK
164 * If they do not send their details in this time limit they
165 * will be disconnected
167 unsigned int timeout;
169 /** The oper type they logged in as, if they are an oper.
170 * This is used to check permissions in operclasses, so that
171 * we can say 'yay' or 'nay' to any commands they issue.
172 * The value of this is the value of a valid 'type name=' tag.
176 /** True when DNS lookups are completed.
180 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
182 unsigned int pingmax;
184 /** Password specified by the user when they registered.
185 * This is stored even if the <connect> block doesnt need a password, so that
186 * modules may check it.
188 char password[MAXBUF];
190 /** User's receive queue.
191 * Lines from the IRCd awaiting processing are stored here.
192 * Upgraded april 2005, old system a bit hairy.
196 /** User's send queue.
197 * Lines waiting to be sent are stored here until their buffer is flushed.
207 /* Write error string
209 std::string WriteError;
211 /** Maximum size this user's sendq can become
215 /** Maximum size this user's recvq can become
221 virtual ~userrec() { }
223 /** Returns the full displayed host of the user
224 * This member function returns the hostname of the user as seen by other users
225 * on the server, in nick!ident&at;host form.
227 virtual char* GetFullHost();
229 /** Returns the full real host of the user
230 * This member function returns the hostname of the user as seen by other users
231 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
232 * e.g. through a module, then this method will ignore it and return the true hostname.
234 virtual char* GetFullRealHost();
236 /** Returns true if a user is invited to a channel.
238 virtual bool IsInvited(char* channel);
240 /** Adds a channel to a users invite list (invites them to a channel)
242 virtual void InviteTo(char* channel);
244 /** Removes a channel from a users invite list.
245 * This member function is called on successfully joining an invite only channel
246 * to which the user has previously been invited, to clear the invitation.
248 virtual void RemoveInvite(char* channel);
250 /** Returns true or false for if a user can execute a privilaged oper command.
251 * This is done by looking up their oper type from userrec::oper, then referencing
252 * this to their oper classes and checking the commands they can execute.
254 bool HasPermission(char* command);
256 /** Calls read() to read some data for this user using their fd.
258 int ReadData(void* buffer, size_t size);
260 /** This method adds data to the buffer of the user.
261 * The buffer can grow to any size within limits of the available memory,
262 * managed by the size of a std::string, however if any individual line in
263 * the buffer grows over 600 bytes in length (which is 88 chars over the
264 * RFC-specified limit per line) then the method will return false and the
265 * text will not be inserted.
267 bool AddBuffer(std::string a);
269 /** This method returns true if the buffer contains at least one carriage return
270 * character (e.g. one complete line may be read)
272 bool BufferIsReady();
274 /** This function clears the entire buffer by setting it to an empty string.
278 /** This method returns the first available string at the tail end of the buffer
279 * and advances the tail end of the buffer past the string. This means it is
280 * a one way operation in a similar way to strtok(), and multiple calls return
281 * multiple lines if they are available. The results of this function if there
282 * are no lines to be read are unknown, always use BufferIsReady() to check if
283 * it is ok to read the buffer before calling GetBuffer().
285 std::string GetBuffer();
287 /** Sets the write error for a connection. This is done because the actual disconnect
288 * of a client may occur at an inopportune time such as half way through /LIST output.
289 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
290 * errored clients purged.
292 void SetWriteError(std::string error);
294 /** Returns the write error which last occured on this connection or an empty string
297 std::string GetWriteError();
299 /** Adds to the user's write buffer.
300 * You may add any amount of text up to this users sendq value, if you exceed the
301 * sendq value, SetWriteError() will be called to set the users error string to
302 * "SendQ exceeded", and further buffer adds will be dropped.
304 void AddWriteBuf(std::string data);
306 /** Flushes as much of the user's buffer to the file descriptor as possible.
307 * This function may not always flush the entire buffer, rather instead as much of it
308 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
309 * position is advanced forwards and the rest of the data sent at the next call to
312 void FlushWriteBuf();
314 /** Returns the list of channels this user has been invited to but has not yet joined.
316 InvitedList* GetInviteList();
318 /** Shuts down and closes the user's socket
323 /** A lightweight userrec used by WHOWAS
329 char ident[IDENTMAX+1];
332 char fullname[MAXGECOS+1];