1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 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"
30 #include "cull_list.h"
34 #define STATUS_VOICE 1
35 #define STATUS_NORMAL 0
40 template<typename T> inline string ConvToStr(const T &in);
42 /** Holds a channel name to which a user has been invited.
44 class Invited : public classbase
51 /** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
53 class ConnectClass : public classbase
56 /** Type of line, either CC_ALLOW or CC_DENY
59 /** Max time to register the connection in seconds
61 int registration_timeout;
62 /** Number of lines in buffer before excess flood is triggered
65 /** Host mask for this line
68 /** Number of seconds between pings for this line
71 /** (Optional) Password for this line
75 /** Threshold value for flood disconnect
79 /** Maximum size of sendq for users in this class (bytes)
83 /** Maximum size of recvq for users in this class (bytes)
87 /** Local max when connecting by this connection class
91 /** Global max when connecting by this connection class
95 ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
100 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
102 typedef std::vector<Invited> InvitedList;
106 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
108 typedef std::vector<ConnectClass> ClassVector;
110 /** Holds all information about a user
111 * This class stores all information about a user connected to the irc server. Everything about a
112 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
113 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
116 class userrec : public connection
120 /** A list of channels the user has a pending invite to.
125 /** The users nickname.
126 * An invalid nickname indicates an unregistered connection prior to the NICK command.
131 /** The users ident reply.
132 * Two characters are added to the user-defined limit to compensate for the tilde etc.
134 char ident[IDENTMAX+2];
136 /** The host displayed to non-opers (used for cloaking etc).
137 * This usually matches the value of userrec::host.
141 /** The users full name.
143 char fullname[MAXGECOS+1];
145 /** The user's mode string.
146 * This may contain any of the following RFC characters: o, w, s, i
147 * Your module may define other mode characters as it sees fit.
148 * it is limited to length 54, as there can only be a maximum of 52
149 * user modes (26 upper, 26 lower case) a null terminating char, and
150 * an optional + character.
154 std::vector<ucrec> chans;
156 /** The server the user is connected to.
160 /** The user's away message.
161 * If this string is empty, the user is not marked as away.
163 char awaymsg[MAXAWAY+1];
165 /** Number of lines the user can place into the buffer
166 * (up to the global NetBufferSize bytes) before they
167 * are disconnected for excess flood
171 /** Number of seconds this user is given to send USER/NICK
172 * If they do not send their details in this time limit they
173 * will be disconnected
175 unsigned int timeout;
177 /** The oper type they logged in as, if they are an oper.
178 * This is used to check permissions in operclasses, so that
179 * we can say 'yay' or 'nay' to any commands they issue.
180 * The value of this is the value of a valid 'type name=' tag.
184 /** True when DNS lookups are completed.
188 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
190 unsigned int pingmax;
192 /** Password specified by the user when they registered.
193 * This is stored even if the <connect> block doesnt need a password, so that
194 * modules may check it.
198 /** User's receive queue.
199 * Lines from the IRCd awaiting processing are stored here.
200 * Upgraded april 2005, old system a bit hairy.
204 /** User's send queue.
205 * Lines waiting to be sent are stored here until their buffer is flushed.
219 /* Write error string
221 std::string WriteError;
223 /** Maximum size this user's sendq can become
227 /** Maximum size this user's recvq can become
233 /** Returns the full displayed host of the user
234 * This member function returns the hostname of the user as seen by other users
235 * on the server, in nick!ident&at;host form.
237 virtual char* GetFullHost();
239 /** Returns the full real host of the user
240 * This member function returns the hostname of the user as seen by other users
241 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
242 * e.g. through a module, then this method will ignore it and return the true hostname.
244 virtual char* GetFullRealHost();
246 /** Returns true if a user is invited to a channel.
248 virtual bool IsInvited(irc::string &channel);
250 /** Adds a channel to a users invite list (invites them to a channel)
252 virtual void InviteTo(irc::string &channel);
254 /** Removes a channel from a users invite list.
255 * This member function is called on successfully joining an invite only channel
256 * to which the user has previously been invited, to clear the invitation.
258 virtual void RemoveInvite(irc::string &channel);
260 /** Returns true or false for if a user can execute a privilaged oper command.
261 * This is done by looking up their oper type from userrec::oper, then referencing
262 * this to their oper classes and checking the commands they can execute.
264 bool HasPermission(std::string &command);
266 /** Calls read() to read some data for this user using their fd.
268 int ReadData(void* buffer, size_t size);
270 /** This method adds data to the buffer of the user.
271 * The buffer can grow to any size within limits of the available memory,
272 * managed by the size of a std::string, however if any individual line in
273 * the buffer grows over 600 bytes in length (which is 88 chars over the
274 * RFC-specified limit per line) then the method will return false and the
275 * text will not be inserted.
277 bool AddBuffer(std::string a);
279 /** This method returns true if the buffer contains at least one carriage return
280 * character (e.g. one complete line may be read)
282 bool BufferIsReady();
284 /** This function clears the entire buffer by setting it to an empty string.
288 /** This method returns the first available string at the tail end of the buffer
289 * and advances the tail end of the buffer past the string. This means it is
290 * a one way operation in a similar way to strtok(), and multiple calls return
291 * multiple lines if they are available. The results of this function if there
292 * are no lines to be read are unknown, always use BufferIsReady() to check if
293 * it is ok to read the buffer before calling GetBuffer().
295 std::string GetBuffer();
297 /** Sets the write error for a connection. This is done because the actual disconnect
298 * of a client may occur at an inopportune time such as half way through /LIST output.
299 * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
300 * errored clients purged.
302 void SetWriteError(std::string error);
304 /** Returns the write error which last occured on this connection or an empty string
307 std::string GetWriteError();
309 /** Adds to the user's write buffer.
310 * You may add any amount of text up to this users sendq value, if you exceed the
311 * sendq value, SetWriteError() will be called to set the users error string to
312 * "SendQ exceeded", and further buffer adds will be dropped.
314 void AddWriteBuf(std::string data);
316 /** Flushes as much of the user's buffer to the file descriptor as possible.
317 * This function may not always flush the entire buffer, rather instead as much of it
318 * as it possibly can. If the send() call fails to send the entire buffer, the buffer
319 * position is advanced forwards and the rest of the data sent at the next call to
322 void FlushWriteBuf();
324 /** Returns the list of channels this user has been invited to but has not yet joined.
326 InvitedList* GetInviteList();
328 void MakeHost(char* nhost);
330 char* MakeWildHost();
332 /** Shuts down and closes the user's socket
343 /** A lightweight userrec used by WHOWAS
349 char ident[IDENTMAX+1];
352 char fullname[MAXGECOS+1];
357 void AddOper(userrec* user);
358 void DeleteOper(userrec* user);
359 void kill_link(userrec *user,const char* r);
360 void kill_link_silent(userrec *user,const char* r);
361 void AddWhoWas(userrec* u);
362 void AddClient(int socket, int port, bool iscached, in_addr ip4);
363 void FullConnectUser(userrec* user, CullList* Goners);
364 userrec* ReHashNick(char* Old, char* New);
365 void force_nickchange(userrec* user,const char* newnick);