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 /** (Optional) Password for this line
66 registration_timeout = 0;
68 strlcpy(host,"",MAXBUF);
69 strlcpy(pass,"",MAXBUF);
73 /** Holds a complete list of all channels to which a user has been invited and has not yet joined.
75 typedef std::vector<Invited> InvitedList;
79 /** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
81 typedef std::vector<ConnectClass> ClassVector;
83 /** Holds all information about a user
84 * This class stores all information about a user connected to the irc server. Everything about a
85 * connection is stored here primarily, from the user's socket ID (file descriptor) through to the
86 * user's nickname and hostname. Use the Find method of the server class to locate a specific user
89 class userrec : public connection
93 /** A list of channels the user has a pending invite to.
98 /** The users nickname.
99 * An invalid nickname indicates an unregistered connection prior to the NICK command.
104 /** The users ident reply.
108 /** The host displayed to non-opers (used for cloaking etc).
109 * This usually matches the value of userrec::host.
113 /** The users full name.
117 /** The user's mode string.
118 * This may contain any of the following RFC characters: o, w, s, i
119 * Your module may define other mode characters as it sees fit.
123 ucrec chans[MAXCHANS];
125 /** The server the user is connected to.
129 /** The user's away message.
130 * If this string is empty, the user is not marked as away.
134 /** Stores the result of the last GetFullHost or GetRealHost call.
135 * You may use this to increase the speed of use of this class.
139 /** Number of lines the user can place into the buffer
140 * (up to the global NetBufferSize bytes) before they
141 * are disconnected for excess flood
145 /** Number of seconds this user is given to send USER/NICK
146 * If they do not send their details in this time limit they
147 * will be disconnected
149 unsigned long timeout;
151 /** The oper type they logged in as, if they are an oper.
152 * This is used to check permissions in operclasses, so that
153 * we can say 'yay' or 'nay' to any commands they issue.
154 * The value of this is the value of a valid 'type name=' tag.
158 /** True when DNS lookups are completed.
164 virtual ~userrec() { }
166 /** Returns the full displayed host of the user
167 * This member function returns the hostname of the user as seen by other users
168 * on the server, in nick!ident&at;host form.
170 virtual char* GetFullHost();
172 /** Returns the full real host of the user
173 * This member function returns the hostname of the user as seen by other users
174 * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
175 * e.g. through a module, then this method will ignore it and return the true hostname.
177 virtual char* GetFullRealHost();
179 /** Returns true if a user is invited to a channel.
181 virtual bool IsInvited(char* channel);
183 /** Adds a channel to a users invite list (invites them to a channel)
185 virtual void InviteTo(char* channel);
187 /** Removes a channel from a users invite list.
188 * This member function is called on successfully joining an invite only channel
189 * to which the user has previously been invited, to clear the invitation.
191 virtual void RemoveInvite(char* channel);
193 /** Returns true or false for if a user can execute a privilaged oper command.
194 * This is done by looking up their oper type from userrec::oper, then referencing
195 * this to their oper classes and checking the commands they can execute.
197 bool HasPermission(char* command);