-/*
-
-$Log$
-Revision 1.1 2003/01/23 19:45:58 brain
-Initial revision
-
-Revision 1.9 2003/01/22 00:44:26 brain
-Added documentation comments
-
-Revision 1.8 2003/01/21 21:11:17 brain
-Added documentation
-
-Revision 1.7 2003/01/17 13:21:38 brain
-Added CONNECT ALLOW and CONNECT DENY config tags
-Added PASS command
-
-Revision 1.6 2003/01/17 10:37:55 brain
-Added /INVITE command and relevent structures
-
-Revision 1.5 2003/01/16 20:11:56 brain
-fixed some ugly pointer bugs (thanks dblack and a|KK|y!)
-
-Revision 1.4 2003/01/15 22:47:44 brain
-Changed user and channel structs to classes (finally)
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
+ * E-mail:
+ * <brain@chatspike.net>
+ * <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
-Revision 1.3 2003/01/14 21:14:30 brain
-added /ISON command (for mIRC etc basic notify)
+#ifndef __USERS_H__
+#define __USERS_H__
+#include <string>
-*/
+#ifdef THREADED_DNS
+#include <pthread.h>
+#endif
#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"
-#include <string>
-
-#ifndef __USERS_H__
-#define __USERS_H__
-
-#define STATUS_OP 4
-#define STATUS_HOP 2
-#define STATUS_VOICE 1
-#define STATUS_NORMAL 0
+enum ChanStatus {
+ STATUS_OP = 4,
+ STATUS_HOP = 2,
+ STATUS_VOICE = 1,
+ STATUS_NORMAL = 0
+};
-#define CC_ALLOW 0
-#define CC_DENY 1
+enum ClassTypes {
+ CC_ALLOW = 0,
+ CC_DENY = 1
+};
+
+/** RFC1459 channel modes
+ * */
+enum UserModes {
+ UM_SERVERNOTICE = 's'-65,
+ UM_WALLOPS = 'w'-65,
+ UM_INVISIBLE = 'i'-65,
+ UM_OPERATOR = 'o'-65,
+};
+
+enum RegistrationState {
+ REG_NONE = 0, /* Has sent nothing */
+ REG_USER = 1, /* Has sent USER */
+ REG_NICK = 2, /* Has sent NICK */
+ REG_NICKUSER = 3, /* Bitwise combination of REG_NICK and REG_USER */
+ REG_ALL = 7 /* REG_NICKUSER plus next bit along */
+};
/** Holds a channel name to which a user has been invited.
*/
-class Invited
+class Invited : public classbase
{
public:
- char channel[CHANMAX];
+ irc::string channel;
+};
+
+class UserResolver : public Resolver
+{
+ private:
+ userrec* bound_user;
+ int bound_fd;
+ public:
+ UserResolver(userrec* user, std::string to_resolve, bool forward) : Resolver(to_resolve, forward), bound_user(user)
+ {
+ this->bound_fd = user->fd;
+ }
+
+ void OnLookupComplete(const std::string &result);
+ void OnError(ResolverError e);
};
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
-class ConnectClass
+class ConnectClass : public classbase
{
public:
- int type;
- char host[MAXBUF];
- char pass[MAXBUF];
+ /** Type of line, either CC_ALLOW or CC_DENY
+ */
+ char type;
+ /** Max time to register the connection in seconds
+ */
+ int registration_timeout;
+ /** Number of lines in buffer before excess flood is triggered
+ */
+ int flood;
+ /** Host mask for this line
+ */
+ std::string host;
+ /** Number of seconds between pings for this line
+ */
+ int pingtime;
+ /** (Optional) Password for this line
+ */
+ std::string pass;
+
+ /** Threshold value for flood disconnect
+ */
+ int threshold;
+
+ /** Maximum size of sendq for users in this class (bytes)
+ */
+ long sendqmax;
+
+ /** Maximum size of recvq for users in this class (bytes)
+ */
+ long recvqmax;
+
+ /** Local max when connecting by this connection class
+ */
+ long maxlocal;
+
+ /** Global max when connecting by this connection class
+ */
+ long maxglobal;
+
+ ConnectClass() : registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0)
+ {
+ }
};
/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
*/
-typedef vector<Invited> InvitedList;
+typedef std::vector<Invited> InvitedList;
/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
*/
-typedef vector<ConnectClass> ClassVector;
+typedef std::vector<ConnectClass> ClassVector;
+
+/** Typedef for the list of user-channel records for a user
+ */
+typedef std::vector<ucrec*> UserChanList;
/** Holds all information about a user
* This class stores all information about a user connected to the irc server. Everything about a
* user's nickname and hostname. Use the Find method of the server class to locate a specific user
* by nickname.
*/
-class userrec
+class userrec : public connection
{
private:
*/
InvitedList invites;
public:
+ /** Resolvers for looking up this users hostname
+ */
+ UserResolver* res_forward;
+ UserResolver* res_reverse;
+ std::string stored_host;
+
+ void StartDNSLookup();
/** The users nickname.
* An invalid nickname indicates an unregistered connection prior to the NICK command.
char nick[NICKMAX];
- /** The users ip address in network order.
- */
- unsigned long ip;
-
/** The users ident reply.
+ * Two characters are added to the user-defined limit to compensate for the tilde etc.
*/
- char ident[64];
+ char ident[IDENTMAX+2];
- /** The users hostname, or ip address in string form.
- */
- char host[256];
-
/** The host displayed to non-opers (used for cloaking etc).
* This usually matches the value of userrec::host.
*/
- char dhost[256];
+ char dhost[65];
/** The users full name.
*/
- char fullname[128];
+ char fullname[MAXGECOS+1];
- /** The users file descriptor.
- * If this is zero, the socket has been closed and the core has not yet
- * realised and removed the record from memory.
+ /** 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.
+ * A value of 1 in field (modeletter-65) indicates that the mode is
+ * set, for example, to work out if mode +s is set, we check the field
+ * userrec::modes['s'-65] != 0.
+ * The following RFC characters o, w, s, i have constants defined via an
+ * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
*/
- int fd;
-
- /** The user's mode string.
- * This may contain any of the following RFC characters: o, w, s, i
- * Your module may define other mode characters as it sees fit.
- */
- char modes[32];
-
- /** The users input buffer.
- * Used by the C recv() function.
- */
- char inbuf[MAXBUF];
-
- /** The last time the user was pinged by the core.
- * When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent
- * to the client. If the user has an outstanding PING request the next time this
- * event occurs after 4 total minutes, they are disconnected.
+ char modes[64];
+
+ /** What snomasks are set on this user.
+ * This functions the same as the above modes.
*/
- time_t lastping;
+ char snomasks[64];
+
+ UserChanList chans;
- /** The users signon time.
+ /** The server the user is connected to.
*/
- time_t signon;
+ const char* server;
- /** The time the user last sent a message.
- * See also userrec::lastping and userrec::signon
+ /** The user's away message.
+ * If this string is empty, the user is not marked as away.
*/
- time_t idle_lastmsg;
+ char awaymsg[MAXAWAY+1];
- /** True if the user replied to their last ping.
- * If this is true, the user can be sent another ping at the specified time, otherwise
- * they will be discnnected. See also userrec::lastping
+ /** Number of lines the user can place into the buffer
+ * (up to the global NetBufferSize bytes) before they
+ * are disconnected for excess flood
*/
- time_t nping;
+ int flood;
- /** Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.
- * If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and
- * makes the value of userrec::registered == 7, showing a fully established client session.
+ /** Number of seconds this user is given to send USER/NICK
+ * If they do not send their details in this time limit they
+ * will be disconnected
*/
- int registered;
+ unsigned int timeout;
- /** A list of the channels the user is currently on.
- * If any of these values are NULL, the record is not in use and may be associated with
- * a channel by the JOIN command. see RFC 1459.
+ /** 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.
+ * The value of this is the value of a valid 'type name=' tag.
*/
- ucrec chans[MAXCHANS];
-
- /** The server the user is connected to.
+ char oper[NICKMAX];
+
+ /** True when DNS lookups are completed.
+ */
+ bool dns_done;
+
+ /** Number of seconds between PINGs for this user (set from <connect:allow> tag
*/
- char server[256];
-
- /** The user's away message.
- * If this string is empty, the user is not marked as away.
+ unsigned int pingmax;
+
+ /** Password specified by the user when they registered.
+ * This is stored even if the <connect> block doesnt need a password, so that
+ * modules may check it.
*/
- char awaymsg[512];
-
- /** The port that the user connected to.
+ char password[64];
+
+ /** User's receive queue.
+ * Lines from the IRCd awaiting processing are stored here.
+ * Upgraded april 2005, old system a bit hairy.
*/
- int port;
-
- /** Stores the number of incoming bytes from the connection.
- * Used by /STATS
+ std::string recvq;
+
+ /** User's send queue.
+ * Lines waiting to be sent are stored here until their buffer is flushed.
*/
- long bytes_in;
-
- /** Stores the number of outgoing bytes to the connection.
- * Used by /STATS
+ std::string sendq;
+
+ /** Flood counters
*/
- long bytes_out;
-
- /** Stores the number of incoming commands from the connection.
- * Used by /STATS
+ int lines_in;
+ time_t reset_due;
+ long threshold;
+
+ /** IPV4 ip address
*/
- long cmds_in;
-
- /** Stores the number of outgoing commands to the connection.
- * Used by /STATS
+ insp_inaddr ip4;
+
+ /* Write error string
*/
- long cmds_out;
-
- /** Stores the result of the last GetFullHost or GetRealHost call.
- * You may use this to increase the speed of use of this class.
+ std::string WriteError;
+
+ /** Maximum size this user's sendq can become
*/
- char result[256];
-
- /** True if a correct password has been given using PASS command.
- * If the user is a member of a connection class that does not require a password,
- * the value stored here is of no use.
+ long sendqmax;
+
+ /** Maximum size this user's recvq can become
*/
- bool haspassed;
+ long recvqmax;
+ /** Default constructor
+ */
userrec();
- virtual ~userrec() { }
-
/** 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.
* e.g. through a module, then this method will ignore it and return the true hostname.
*/
virtual char* GetFullRealHost();
+
+ /*
+ * Create a displayable mode string for this users umodes
+ */
+ const char* FormatNoticeMasks();
+
+ bool userrec::ProcessNoticeMasks(const char *sm);
+
+ bool IsNoticeMaskSet(unsigned char sm);
+
+ void SetNoticeMask(unsigned char sm, bool value);
+
+ /*
+ * Create a displayable mode string for this users umodes
+ */
+ const char* FormatModes();
+
+ bool IsModeSet(unsigned char m);
+
+ void SetMode(unsigned char m, bool value);
/** Returns true if a user is invited to a channel.
*/
- virtual bool IsInvited(char* channel);
+ virtual bool IsInvited(irc::string &channel);
/** Adds a channel to a users invite list (invites them to a channel)
*/
- virtual void InviteTo(char* channel);
+ virtual void InviteTo(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.
*/
- virtual void RemoveInvite(char* channel);
+ virtual void RemoveInvite(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.
+ */
+ bool HasPermission(const std::string &command);
+
+ /** Calls read() to read some data for this user using their fd.
+ */
+ int ReadData(void* buffer, size_t size);
+
+ /** This method adds data to the buffer of the user.
+ * The buffer can grow to any size within limits of the available memory,
+ * managed by the size of a std::string, however if any individual line in
+ * the buffer grows over 600 bytes in length (which is 88 chars over the
+ * RFC-specified limit per line) then the method will return false and the
+ * text will not be inserted.
+ */
+ bool AddBuffer(const std::string &a);
+
+ /** This method returns true if the buffer contains at least one carriage return
+ * character (e.g. one complete line may be read)
+ */
+ bool BufferIsReady();
+
+ /** This function clears the entire buffer by setting it to an empty string.
+ */
+ void ClearBuffer();
+
+ /** This method returns the first available string at the tail end of the buffer
+ * and advances the tail end of the buffer past the string. This means it is
+ * a one way operation in a similar way to strtok(), and multiple calls return
+ * multiple lines if they are available. The results of this function if there
+ * are no lines to be read are unknown, always use BufferIsReady() to check if
+ * it is ok to read the buffer before calling GetBuffer().
+ */
+ std::string GetBuffer();
+
+ /** Sets the write error for a connection. This is done because the actual disconnect
+ * of a client may occur at an inopportune time such as half way through /LIST output.
+ * The WriteErrors of clients are checked at a more ideal time (in the mainloop) and
+ * errored clients purged.
+ */
+ void SetWriteError(const std::string &error);
+
+ /** Returns the write error which last occured on this connection or an empty string
+ * if none occured.
+ */
+ const char* GetWriteError();
+
+ /** Adds to the user's write buffer.
+ * You may add any amount of text up to this users sendq value, if you exceed the
+ * sendq value, SetWriteError() will be called to set the users error string to
+ * "SendQ exceeded", and further buffer adds will be dropped.
+ */
+ void AddWriteBuf(const std::string &data);
+
+ /** Flushes as much of the user's buffer to the file descriptor as possible.
+ * This function may not always flush the entire buffer, rather instead as much of it
+ * as it possibly can. If the send() call fails to send the entire buffer, the buffer
+ * position is advanced forwards and the rest of the data sent at the next call to
+ * this method.
+ */
+ void FlushWriteBuf();
+
+ /** Returns the list of channels this user has been invited to but has not yet joined.
+ */
+ InvitedList* GetInviteList();
+
+ /** Creates a wildcard host.
+ * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
+ */
+ char* MakeWildHost();
+
+ /** Creates a host.
+ * Takes a buffer to use and fills the given buffer with the host in the format nick!user@host
+ */
+ void MakeHost(char* nhost);
+
+ /** Shuts down and closes the user's socket
+ */
+ void CloseSocket();
+
+ /** Default destructor
+ */
+ virtual ~userrec();
+
+#ifdef THREADED_DNS
+ /** Thread used for threaded lookups
+ */
+ pthread_t dnsthread;
+#endif
};
+/** Used to hold WHOWAS information
+ */
+class WhoWasGroup : public classbase
+{
+ public:
+ char* host;
+ char* dhost;
+ char* ident;
+ const char* server;
+ char* gecos;
+ time_t signon;
+
+ WhoWasGroup(userrec* user);
+ ~WhoWasGroup();
+};
+
+typedef std::deque<WhoWasGroup*> whowas_set;
+typedef std::map<irc::string,whowas_set*> whowas_users;
+
+void AddOper(userrec* user);
+void DeleteOper(userrec* user);
+void kill_link(userrec *user,const char* r);
+void kill_link_silent(userrec *user,const char* r);
+void AddWhoWas(userrec* u);
+void MaintainWhoWas(time_t TIME);
+void AddClient(int socket, int port, bool iscached, insp_inaddr ip4);
+void FullConnectUser(userrec* user, CullList* Goners);
+userrec* ReHashNick(const char* Old, const char* New);
+void force_nickchange(userrec* user,const char* newnick);
+
+/* Configuration callbacks */
+bool InitTypes(const char* tag);
+bool InitClasses(const char* tag);
+bool DoType(const char* tag, char** entries, void** values, int* types);
+bool DoClass(const char* tag, char** entries, void** values, int* types);
+bool DoneClassesAndTypes(const char* tag);
+
+long FindMatchingGlobal(userrec* user);
+long FindMatchingLocal(userrec* user);
#endif
projects / user / henk / code / inspircd.git / blobdiff