* ---------------------------------------------------
*/
-#ifndef __USERS_H__
-#define __USERS_H__
+#ifndef __USERS_H__
+#define __USERS_H__
#include <string>
-#include "inspircd_config.h"
+#include "inspircd_config.h"
#include "socket.h"
#include "channels.h"
#include "inspstring.h"
#include "connection.h"
#include "hashcomp.h"
#include "dns.h"
-#include "cull_list.h"
enum ChanStatus {
STATUS_OP = 4,
};
enum RegistrationState {
+
+#ifndef WIN32 // Burlex: This is already defined in win32, luckily it is still 0.
REG_NONE = 0, /* Has sent nothing */
+#endif
+
REG_USER = 1, /* Has sent USER */
REG_NICK = 2, /* Has sent NICK */
REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
/** Derived from Resolver, and performs user forward/reverse lookups.
*/
-class UserResolver : public Resolver
+class CoreExport UserResolver : public Resolver
{
private:
/** User this class is 'attached' to.
int bound_fd;
bool fwd;
public:
- UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt);
+ UserResolver(InspIRCd* Instance, userrec* user, std::string to_resolve, QueryType qt, bool &cache);
- void OnLookupComplete(const std::string &result, unsigned int ttl);
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached);
void OnError(ResolverError e, const std::string &errormessage);
};
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class ConnectClass : public classbase
+class CoreExport ConnectClass : public classbase
{
private:
/** Type of line, either CC_ALLOW or CC_DENY
/** Global max when connecting by this connection class
*/
unsigned long maxglobal;
+ /** Port number this connect class applies to
+ */
+ int port;
public:
+ /** Create a new connect class with no settings.
+ */
ConnectClass() : type(CC_DENY), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+ /** Create a new connect class to ALLOW connections.
+ * @param timeout The registration timeout
+ * @param fld The flood value
+ * @param hst The IP mask to allow
+ * @param ping The ping frequency
+ * @param pas The password to be used
+ * @param thres The flooding threshold
+ * @param sendq The maximum sendq value
+ * @param recvq The maximum recvq value
+ * @param maxl The maximum local sessions
+ * @param maxg The maximum global sessions
+ */
ConnectClass(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
- unsigned long maxl, unsigned long maxg) :
+ unsigned long maxl, unsigned long maxg, int p = 0) :
type(CC_ALLOW), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
- threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg) { }
+ threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), port(p) { }
+ /** Create a new connect class to DENY connections
+ * @param hst The IP mask to deny
+ */
ConnectClass(const std::string &hst) : type(CC_DENY), registration_timeout(0), flood(0), host(hst), pingtime(0),
- pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0) { }
+ pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), port(0) { }
+ /** Returns the type, CC_ALLOW or CC_DENY
+ */
char GetType()
{
return (type == CC_ALLOW ? CC_ALLOW : CC_DENY);
}
+ /** Returns the registration timeout
+ */
unsigned int GetRegTimeout()
{
return (registration_timeout ? registration_timeout : 90);
}
+ /** Returns the flood limit
+ */
unsigned int GetFlood()
{
return (threshold ? flood : 999);
}
+ /** Returns the allowed or denied IP mask
+ */
const std::string& GetHost()
{
return host;
}
+ int GetPort()
+ {
+ return port;
+ }
+
+ /** Returns the ping frequency
+ */
unsigned int GetPingTime()
{
return (pingtime ? pingtime : 120);
}
+ /** Returns the password or an empty string
+ */
const std::string& GetPass()
{
return pass;
}
+ /** Returns the flood threshold value
+ */
unsigned int GetThreshold()
{
return (threshold ? threshold : 1);
}
+ /** Returns the maximum sendq value
+ */
unsigned long GetSendqMax()
{
return (sendqmax ? sendqmax : 262114);
}
+ /** Returns the maximum recvq value
+ */
unsigned long GetRecvqMax()
{
return (recvqmax ? recvqmax : 4096);
}
+ /** Returusn the maximum number of local sessions
+ */
unsigned long GetMaxLocal()
{
- return (maxlocal ? maxlocal : 1);
+ return maxlocal;
}
+ /** Returns the maximum number of global sessions
+ */
unsigned long GetMaxGlobal()
{
- return (maxglobal ? maxglobal : 1);
+ return maxglobal;
}
};
typedef std::map<chanrec*, char> UserChanList;
typedef UserChanList::iterator UCListIter;
+class userrec;
+
+class CoreExport VisData
+{
+ public:
+ VisData();
+ virtual ~VisData();
+ virtual bool VisibleTo(userrec* user);
+};
+
/** Holds all information about a user
* This class stores all information about a user connected to the irc server. Everything about a
* connection is stored here primarily, from the user's socket ID (file descriptor) through to the
* by nickname, or the FindDescriptor method of the InspIRCd class to find a specific user by their
* file descriptor value.
*/
-class userrec : public connection
+class CoreExport userrec : public connection
{
private:
/** Pointer to creator.
*/
unsigned int ChannelCount;
+ /** Cached nick!ident@host value using the real hostname
+ */
char* cached_fullhost;
+
+ /** Cached nick!ident@ip value using the real IP address
+ */
char* cached_hostip;
+
+ /** Cached nick!ident@host value using the masked hostname
+ */
char* cached_makehost;
char* cached_fullrealhost;
* mode characters this user is making use of.
*/
void DecrementModes();
+
+ char* operquit;
+
public:
/** Resolvers for looking up this users IP address
* This will occur if and when res_reverse completes.
*/
UserResolver* res_reverse;
+ VisData* Visibility;
+
/** Stored reverse lookup from res_forward
*/
std::string stored_host;
* When complete, these objects set userrec::dns_done to true.
*/
void StartDNSLookup();
-
+
/** The users nickname.
* An invalid nickname indicates an unregistered connection prior to the NICK command.
* Use InspIRCd::IsNick() to validate nicknames.
*/
char nick[NICKMAX];
-
+
/** The users ident reply.
* Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
* This usually matches the value of userrec::host.
*/
char dhost[65];
-
+
/** The users full name (GECOS).
*/
char fullname[MAXGECOS+1];
-
+
/** The user's mode list.
* This is NOT a null terminated string! In the 1.1 version of InspIRCd
* this is an array of values in a similar way to channel modes.
/** Channels this user is on, and the permissions they have there
*/
UserChanList chans;
-
+
/** The server the user is connected to.
*/
const char* server;
-
+
/** The user's away message.
* If this string is empty, the user is not marked as away.
*/
char awaymsg[MAXAWAY+1];
-
+
/** Number of lines the user can place into the buffer
* (up to the global NetBufferSize bytes) before they
* are disconnected for excess flood
*/
int flood;
-
+
/** Timestamp of current time + connection class timeout.
* This user must send USER/NICK before this timestamp is
* reached or they will be disconnected.
*/
time_t timeout;
-
+
/** The oper type they logged in as, if they are an oper.
* This is used to check permissions in operclasses, so that
* we can say 'yay' or 'nay' to any commands they issue.
*/
long threshold;
- /** IPV4 or IPV6 ip address
+ /** If this is set to true, then all read operations for the user
+ * are dropped into the bit-bucket.
+ * This is used by the global CullList, but please note that setting this value
+ * alone will NOT cause the user to quit. This means it can be used seperately,
+ * for example by shun modules etc.
+ */
+ bool muted;
+
+ /** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
+ * GetIPString/GetPort to obtain its values.
*/
sockaddr* ip;
*/
std::string WriteError;
- /** Maximum size this user's sendq can become
+ /** Maximum size this user's sendq can become.
+ * Copied from the connect class on connect.
*/
long sendqmax;
- /** Maximum size this user's recvq can become
+ /** Maximum size this user's recvq can become.
+ * Copied from the connect class on connect.
*/
long recvqmax;
* @throw Nothing at present
*/
userrec(InspIRCd* Instance);
-
+
/** Returns the full displayed host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form.
* @return The full masked host of the user
*/
virtual char* GetFullHost();
-
+
/** Returns the full real host of the user
* This member function returns the hostname of the user as seen by other users
* on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
* @param value On or off setting of the mode
*/
void SetMode(unsigned char m, bool value);
-
+
/** Returns true if a user is invited to a channel.
* @param channel A channel name to look up
* @return True if the user is invited to the given channel
*/
virtual bool IsInvited(const irc::string &channel);
-
+
/** Adds a channel to a users invite list (invites them to a channel)
* @param channel A channel name to add
*/
virtual void InviteTo(const irc::string &channel);
-
+
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
* to which the user has previously been invited, to clear the invitation.
* @param channel The channel to remove the invite to
*/
virtual void RemoveInvite(const irc::string &channel);
-
+
/** Returns true or false for if a user can execute a privilaged oper command.
* This is done by looking up their oper type from userrec::oper, then referencing
* this to their oper classes and checking the commands they can execute.
/** Disconnect a user gracefully
* @param user The user to remove
- * @param r The quit reason
+ * @param r The quit reason to show to normal users
+ * @param oreason The quit reason to show to opers
* @return Although this function has no return type, on exit the user provided will no longer exist.
*/
- static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r);
+ static void QuitUser(InspIRCd* Instance, userrec *user, const std::string &r, const char* oreason = "");
/** Add the user to WHOWAS system
*/
*/
void Oper(const std::string &opertype);
+ /** Call this method to find the matching <connect> for a user, and to check them against it.
+ */
+ void CheckClass();
+
/** Use this method to fully connect a user.
* This will send the message of the day, check G/K/E lines, etc.
- * @param Goners If the user is disconnected by this method call, the
- * value of 'this' will be pushed onto this CullList. This is used by
- * the core to connect many users in rapid succession without invalidating
- * iterators.
- * @param Goners a CullList to use for failed connections
*/
- void FullConnect(CullList* Goners);
+ void FullConnect();
/** Change this users hash key to a new string.
* You should not call this function directly. It is used by the core
* @param ip The IP address of the user
* @return This function has no return value, but a call to AddClient may remove the user.
*/
- static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, insp_inaddr ip);
+ static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
/** Oper down.
* This will clear the +o usermode and unset the user's oper type
*/
void WriteCommonExcept(const std::string &text);
+ void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
+
/** Write a WALLOPS message from this user to all local opers.
* If this user is not opered, the function will return without doing anything.
* @param text The format string to send in the WALLOPS message
*/
bool ChangeName(const char* gecos);
- /** Send a notice to all local users from this user
+ /** Send a command to all local users from this user
+ * The command given must be able to send text with the
+ * first parameter as a servermask (e.g. $*), so basically
+ * you should use PRIVMSG or NOTICE.
+ * @param command the command to send
* @param text The text format string to send
* @param ... Format arguments
*/
- void NoticeAll(char* text, ...);
+ void SendAll(const char* command, char* text, ...);
/** Compile a channel list for this user, and send it to the user 'source'
* Used internally by WHOIS
*/
void ShowRULES();
+ /** Set oper-specific quit message shown to opers only when the user quits
+ * (overrides any sent by QuitUser)
+ */
+ void SetOperQuit(const std::string &oquit);
+
+ const char* GetOperQuit();
+
/** Handle socket event.
* From EventHandler class.
+ * @param et Event type
+ * @param errornum Error number for EVENT_ERROR events
*/
void HandleEvent(EventType et, int errornum = 0);
projects / user / henk / code / inspircd.git / blobdiff