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 "connection.h"
20 #include "inspstring.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
73 registration_timeout = 0;
77 strlcpy(host,"",MAXBUF);
78 strlcpy(pass,"",MAXBUF);
82 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
84 typedef std::vector<Invited> InvitedList;
88 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
90 typedef std::vector<ConnectClass> ClassVector;
92 /** Holds all information about a user
93 * This class stores all information about a user connected to the irc server. Everything about a
94 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
95 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
98 class userrec : public connection
102 /** A list of channels the user has a pending invite to.
107 /** The users nickname.
108 * An invalid nickname indicates an unregistered connection prior to the NICK command.
113 /** The users ident reply.
117 /** The host displayed to non-opers (used for cloaking etc).
118 * This usually matches the value of userrec::host.
122 /** The users full name.
126 /** The user's mode string.
127 * This may contain any of the following RFC characters: o, w, s, i
128 * Your module may define other mode characters as it sees fit.
132 ucrec chans[MAXCHANS];
134 /** The server the user is connected to.
138 /** The user's away message.
139 * If this string is empty, the user is not marked as away.
143 /** Stores the result of the last GetFullHost or GetRealHost call.
144 * You may use this to increase the speed of use of this class.
148 /** Number of lines the user can place into the buffer
149 * (up to the global NetBufferSize bytes) before they
150 * are disconnected for excess flood
154 /** Number of seconds this user is given to send USER/NICK
155 * If they do not send their details in this time limit they
156 * will be disconnected
158 unsigned long timeout;
160 /** The oper type they logged in as, if they are an oper.
161 * This is used to check permissions in operclasses, so that
162 * we can say 'yay' or 'nay' to any commands they issue.
163 * The value of this is the value of a valid 'type name=' tag.
167 /** True when DNS lookups are completed.
171 /** Number of seconds between PINGs for this user (set from <connect:allow> tag
173 unsigned long pingmax;
175 /** Password specified by the user when they registered.
176 * This is stored even if the <connect> block doesnt need a password, so that
177 * modules may check it.
179 char password[MAXBUF];
181 /** User's receive queue.
182 * Lines from the IRCd awaiting processing are stored here.
183 * Upgraded april 2005, old system a bit hairy.
195 virtual ~userrec() { }
197 /** Returns the full displayed host of the user
198 * This member function returns the hostname of the user as seen by other users
199 * on the server, in nick!ident&at;host form.
201 virtual char* GetFullHost();
203 /** Returns the full real host of the user
204 * This member function returns the hostname of the user as seen by other users
205 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
206 * e.g. through a module, then this method will ignore it and return the true hostname.
208 virtual char* GetFullRealHost();
210 /** Returns true if a user is invited to a channel.
212 virtual bool IsInvited(char* channel);
214 /** Adds a channel to a users invite list (invites them to a channel)
216 virtual void InviteTo(char* channel);
218 /** Removes a channel from a users invite list.
219 * This member function is called on successfully joining an invite only channel
220 * to which the user has previously been invited, to clear the invitation.
222 virtual void RemoveInvite(char* channel);
224 /** Returns true or false for if a user can execute a privilaged oper command.
225 * This is done by looking up their oper type from userrec::oper, then referencing
226 * this to their oper classes and checking the commands they can execute.
228 bool HasPermission(char* command);
230 /** This method adds data to the buffer of the user.
231 * The buffer can grow to any size within limits of the available memory,
232 * managed by the size of a std::string, however if any individual line in
233 * the buffer grows over 600 bytes in length (which is 88 chars over the
234 * RFC-specified limit per line) then the method will return false and the
235 * text will not be inserted.
237 bool AddBuffer(std::string a);
239 /** This method returns true if the buffer contains at least one carriage return
240 * character (e.g. one complete line may be read)
242 bool BufferIsReady();
244 /** This function clears the entire buffer by setting it to an empty string.
248 /** This method returns the first available string at the tail end of the buffer
249 * and advances the tail end of the buffer past the string. This means it is
250 * a one way operation in a similar way to strtok(), and multiple calls return
251 * multiple lines if they are available. The results of this function if there
252 * are no lines to be read are unknown, always use BufferIsReady() to check if
253 * it is ok to read the buffer before calling GetBuffer().
255 std::string GetBuffer();