]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/users.h
Added userrec::modebits - fast way of checking if user has +swi rather than an icky...
[user/henk/code/inspircd.git] / include / users.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
6  *                       E-mail:
7  *                <brain@chatspike.net>
8  *                <Craig@chatspike.net>
9  *     
10  * Written by Craig Edwards, Craig McLure, and others.
11  * This program is free but copyrighted software; see
12  *            the file COPYING for details.
13  *
14  * ---------------------------------------------------
15  */
16
17 #include "inspircd_config.h" 
18 #include "channels.h"
19 #include "inspstring.h"
20 #include "connection.h"
21 #include <string>
22 #ifdef THREADED_DNS
23 #include <pthread.h>
24 #endif
25  
26 #ifndef __USERS_H__ 
27 #define __USERS_H__ 
28
29 #include "hashcomp.h"
30 #include "cull_list.h"
31  
32 #define STATUS_OP       4
33 #define STATUS_HOP      2
34 #define STATUS_VOICE    1
35 #define STATUS_NORMAL   0
36
37 #define CC_ALLOW        0
38 #define CC_DENY         1
39
40 template<typename T> string ConvToStr(const T &in);
41
42 /** Holds a channel name to which a user has been invited.
43  */
44 class Invited : public classbase
45 {
46  public:
47          irc::string channel;
48 };
49
50
51 /** Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
52  */
53 class ConnectClass : public classbase
54 {
55  public:
56         /** Type of line, either CC_ALLOW or CC_DENY
57          */
58         char type;
59         /** Max time to register the connection in seconds
60          */
61         int registration_timeout;
62         /** Number of lines in buffer before excess flood is triggered
63          */
64         int flood;
65         /** Host mask for this line
66          */
67         std::string host;
68         /** Number of seconds between pings for this line
69          */
70         int pingtime;
71         /** (Optional) Password for this line
72          */
73         std::string pass;
74
75         /** Threshold value for flood disconnect
76          */
77         int threshold;
78
79         /** Maximum size of sendq for users in this class (bytes)
80          */
81         long sendqmax;
82
83         /** Maximum size of recvq for users in this class (bytes)
84          */
85         long recvqmax;
86
87         /** Local max when connecting by this connection class
88          */
89         long maxlocal;
90
91         /** Global max when connecting by this connection class
92          */
93         long maxglobal;
94         
95         ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
96         {
97         }
98 };
99
100 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
101  */
102 typedef std::vector<Invited> InvitedList;
103
104
105
106 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
107  */
108 typedef std::vector<ConnectClass> ClassVector;
109
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
114  * by nickname.
115  */
116 class userrec : public connection
117 {
118  private:
119
120         /** A list of channels the user has a pending invite to.
121          */
122         InvitedList invites;
123  public:
124         
125         /** The users nickname.
126          * An invalid nickname indicates an unregistered connection prior to the NICK command.
127          */
128         
129         char nick[NICKMAX];
130         
131         /** The users ident reply.
132          * Two characters are added to the user-defined limit to compensate for the tilde etc.
133          */
134         char ident[IDENTMAX+2];
135
136         /** The host displayed to non-opers (used for cloaking etc).
137          * This usually matches the value of userrec::host.
138          */
139         char dhost[64];
140         
141         /** The users full name.
142          */
143         char fullname[MAXGECOS+1];
144         
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.
151          */
152         char modes[54];
153
154         /** This contains a bitmask of the RFC modes +swi,
155          * which can be used for fast lookup when iterating all the users.
156          * It is maintained by the mode parser and matches the character
157          * modes stored in 'modes'.
158          */
159         char modebits;
160         
161         std::vector<ucrec*> chans;
162         
163         /** The server the user is connected to.
164          */
165         char* server;
166         
167         /** The user's away message.
168          * If this string is empty, the user is not marked as away.
169          */
170         char awaymsg[MAXAWAY+1];
171         
172         /** Number of lines the user can place into the buffer
173          * (up to the global NetBufferSize bytes) before they
174          * are disconnected for excess flood
175          */
176         int flood;
177         
178         /** Number of seconds this user is given to send USER/NICK
179          * If they do not send their details in this time limit they
180          * will be disconnected
181          */
182         unsigned int timeout;
183         
184         /** The oper type they logged in as, if they are an oper.
185          * This is used to check permissions in operclasses, so that
186          * we can say 'yay' or 'nay' to any commands they issue.
187          * The value of this is the value of a valid 'type name=' tag.
188          */
189         char oper[NICKMAX];
190
191         /** True when DNS lookups are completed.
192          */
193         bool dns_done;
194
195         /** Number of seconds between PINGs for this user (set from &lt;connect:allow&gt; tag
196          */
197         unsigned int pingmax;
198
199         /** Password specified by the user when they registered.
200          * This is stored even if the <connect> block doesnt need a password, so that
201          * modules may check it.
202          */
203         char password[64];
204
205         /** User's receive queue.
206          * Lines from the IRCd awaiting processing are stored here.
207          * Upgraded april 2005, old system a bit hairy.
208          */
209         std::string recvq;
210
211         /** User's send queue.
212          * Lines waiting to be sent are stored here until their buffer is flushed.
213          */
214         std::string sendq;
215
216         /** Flood counters
217          */
218         int lines_in;
219         time_t reset_due;
220         long threshold;
221
222         /** IPV4 ip address
223          */
224         in_addr ip4;
225
226         /* Write error string
227          */
228         std::string WriteError;
229
230         /** Maximum size this user's sendq can become
231          */
232         long sendqmax;
233
234         /** Maximum size this user's recvq can become
235          */
236         long recvqmax;
237
238         userrec();
239         
240         /** Returns the full displayed host of the user
241          * This member function returns the hostname of the user as seen by other users
242          * on the server, in nick!ident&at;host form.
243          */
244         virtual char* GetFullHost();
245         
246         /** Returns the full real host of the user
247          * This member function returns the hostname of the user as seen by other users
248          * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
249          * e.g. through a module, then this method will ignore it and return the true hostname.
250          */
251         virtual char* GetFullRealHost();
252         
253         /** Returns true if a user is invited to a channel.
254          */
255         virtual bool IsInvited(irc::string &channel);
256         
257         /** Adds a channel to a users invite list (invites them to a channel)
258          */
259         virtual void InviteTo(irc::string &channel);
260         
261         /** Removes a channel from a users invite list.
262          * This member function is called on successfully joining an invite only channel
263          * to which the user has previously been invited, to clear the invitation.
264          */
265         virtual void RemoveInvite(irc::string &channel);
266         
267         /** Returns true or false for if a user can execute a privilaged oper command.
268          * This is done by looking up their oper type from userrec::oper, then referencing
269          * this to their oper classes and checking the commands they can execute.
270          */
271         bool HasPermission(std::string &command);
272
273         /** Calls read() to read some data for this user using their fd.
274          */
275         int ReadData(void* buffer, size_t size);
276
277         /** This method adds data to the buffer of the user.
278          * The buffer can grow to any size within limits of the available memory,
279          * managed by the size of a std::string, however if any individual line in
280          * the buffer grows over 600 bytes in length (which is 88 chars over the
281          * RFC-specified limit per line) then the method will return false and the
282          * text will not be inserted.
283          */
284         bool AddBuffer(std::string a);
285
286         /** This method returns true if the buffer contains at least one carriage return
287          * character (e.g. one complete line may be read)
288          */
289         bool BufferIsReady();
290
291         /** This function clears the entire buffer by setting it to an empty string.
292          */
293         void ClearBuffer();
294
295         /** This method returns the first available string at the tail end of the buffer
296          * and advances the tail end of the buffer past the string. This means it is
297          * a one way operation in a similar way to strtok(), and multiple calls return
298          * multiple lines if they are available. The results of this function if there
299          * are no lines to be read are unknown, always use BufferIsReady() to check if
300          * it is ok to read the buffer before calling GetBuffer().
301          */
302         std::string GetBuffer();
303
304         /** Sets the write error for a connection. This is done because the actual disconnect
305          * of a client may occur at an inopportune time such as half way through /LIST output.
306          * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
307          * errored clients purged.
308          */
309         void SetWriteError(std::string error);
310
311         /** Returns the write error which last occured on this connection or an empty string
312          * if none occured.
313          */
314         std::string GetWriteError();
315
316         /** Adds to the user's write buffer.
317          * You may add any amount of text up to this users sendq value, if you exceed the
318          * sendq value, SetWriteError() will be called to set the users error string to
319          * "SendQ exceeded", and further buffer adds will be dropped.
320          */
321         void AddWriteBuf(std::string data);
322
323         /** Flushes as much of the user's buffer to the file descriptor as possible.
324          * This function may not always flush the entire buffer, rather instead as much of it
325          * as it possibly can. If the send() call fails to send the entire buffer, the buffer
326          * position is advanced forwards and the rest of the data sent at the next call to
327          * this method.
328          */
329         void FlushWriteBuf();
330
331         /** Returns the list of channels this user has been invited to but has not yet joined.
332          */
333         InvitedList* GetInviteList();
334
335         void MakeHost(char* nhost);
336
337         char* MakeWildHost();
338
339         /** Shuts down and closes the user's socket
340          */
341         void CloseSocket();
342
343         virtual ~userrec();
344
345 #ifdef THREADED_DNS
346         pthread_t dnsthread;
347 #endif
348 };
349
350 class WhoWasGroup
351 {
352  public:
353         char* host;
354         char* dhost;
355         char* ident;
356         char* server;
357         char* gecos;
358         time_t signon;
359
360         WhoWasGroup(userrec* user);
361         ~WhoWasGroup();
362 };
363
364 typedef std::deque<WhoWasGroup*> whowas_set;
365 typedef std::map<irc::string,whowas_set*> whowas_users;
366
367 /** A lightweight userrec used by WHOWAS
368  */
369
370 void AddOper(userrec* user);
371 void DeleteOper(userrec* user);
372 void kill_link(userrec *user,const char* r);
373 void kill_link_silent(userrec *user,const char* r);
374 void AddWhoWas(userrec* u);
375 void MaintainWhoWas(time_t TIME);
376 void AddClient(int socket, int port, bool iscached, in_addr ip4);
377 void FullConnectUser(userrec* user, CullList* Goners);
378 userrec* ReHashNick(char* Old, char* New);
379 void force_nickchange(userrec* user,const char* newnick);
380 void ReadClassesAndTypes();
381
382 #endif